Fix #31: Add support for eqls

Also add note in README about equality being synonym of deep equality.

README.md

@@ -69,6 +69,10 @@ properly work against `.equal()`. See
 [this issue](https://github.com/astorije/chai-immutable/issues/24) for
 more information.
 
+Also, note that `deep.equal` and `eql` are synonyms of `equal` when
+tested against immutable data structures, therefore they are aliases to
+`equal`.
+
 ### .include(value)
 
 - **@param** *{ Mixed }* val

chai-immutable.js

@@ -80,10 +80,15 @@
      * [this issue](https://github.com/astorije/chai-immutable/issues/24) for
      * more information.
      *
+     * Also, note that `deep.equal` and `eql` are synonyms of `equal` when
+     * tested against immutable data structures, therefore they are aliases to
+     * `equal`.
+     *
      * @name equal
      * @alias equals
      * @alias eq
      * @alias eql
+     * @alias eqls
      * @alias deep.equal
      * @param {Collection} value
      * @api public
@@ -109,6 +114,7 @@
     Assertion.overwriteMethod('equals', assertCollectionEqual);
     Assertion.overwriteMethod('eq', assertCollectionEqual);
     Assertion.overwriteMethod('eql', assertCollectionEqual);
+    Assertion.overwriteMethod('eqls', assertCollectionEqual);
 
     /**
      * ### .include(value)

test/test.js

@@ -86,7 +86,9 @@ describe('chai-immutable (' + typeEnv + ')', function () {
         expect(list3).to.eq(List.of(1, 2, 3));
         expect(list3).to.not.eq(new List());
         expect(list3).to.eql(List.of(1, 2, 3));
+        expect(list3).to.eqls(List.of(1, 2, 3));
         expect(list3).to.not.eql(new List());
+        expect(list3).to.not.eqls(new List());
         expect(list3).to.deep.equal(List.of(1, 2, 3));
         expect(list3).to.not.deep.equal(new List());
       });
@@ -104,6 +106,7 @@ describe('chai-immutable (' + typeEnv + ')', function () {
         expect(deepMap).to.equals(sameDeepMap);
         expect(deepMap).to.eq(sameDeepMap);
         expect(deepMap).to.eql(sameDeepMap);
+        expect(deepMap).to.eqls(sameDeepMap);
         expect(deepMap).to.deep.equal(sameDeepMap);
       });
 
@@ -112,6 +115,7 @@ describe('chai-immutable (' + typeEnv + ')', function () {
         expect(deepMap).to.not.equals(differentDeepMap);
         expect(deepMap).to.not.eq(differentDeepMap);
         expect(deepMap).to.not.eql(differentDeepMap);
+        expect(deepMap).to.not.eqls(differentDeepMap);
         expect(deepMap).to.not.deep.equal(differentDeepMap);
       });
 
@@ -136,6 +140,7 @@ describe('chai-immutable (' + typeEnv + ')', function () {
         fail(function () { expect(deepMap).to.equals(differentDeepMap); });
         fail(function () { expect(deepMap).to.eq(differentDeepMap); });
         fail(function () { expect(deepMap).to.eql(differentDeepMap); });
+        fail(function () { expect(deepMap).to.eqls(differentDeepMap); });
         fail(function () { expect(deepMap).to.deep.equal(differentDeepMap); });
       });
 
@@ -144,6 +149,7 @@ describe('chai-immutable (' + typeEnv + ')', function () {
         fail(function () { expect(deepMap).to.not.equals(sameDeepMap); });
         fail(function () { expect(deepMap).to.not.eq(sameDeepMap); });
         fail(function () { expect(deepMap).to.not.eql(sameDeepMap); });
+        fail(function () { expect(deepMap).to.not.eqls(sameDeepMap); });
         fail(function () { expect(deepMap).to.not.deep.equal(sameDeepMap); });
       });
     });