Merge pull request #13 from seegno/support/replace-iso-3166-1-data-set

Replace ISO 3166-1 country assert source

Author: ruimarinho

README.md

@@ -11,7 +11,7 @@ A set of extra asserts for [validator.js](https://github.com/guillaumepotier/val
 
 Install the package via `npm`:
 
-```
+```sh
 $ npm install --save validator.js-asserts
 ```
 
@@ -25,6 +25,7 @@ The following set of extra asserts are provided by this package:
 * BigNumberLessThan
 * BigNumberLessThanOrEqualTo
 * Boolean
+* Country
 * Date
 * DateDiffGreaterThan
 * DateDiffLessThan
@@ -99,6 +100,11 @@ Tests if the difference between two dates is less than a given threshold.
 	* `fromDate` - the date where the diff is measured with. If omitted, defaults to `now`.
 	* `unit` - the unit of the difference measurement (`years`, `months`, `weeks`, `days`, `hours`, `minutes` and `seconds`).
 
+### Country
+
+Tests if the value is a valid country by alpha-3 code, alpha-2 code, common name, official name or alternative spelling names.
+The difference from the `Iso3166Country` assert is that it is less rigid in its definitions since it is based on a community-effort rather than a standards body where rules are very strict.
+
 ### Email
 
 Tests if the value is a valid email.
@@ -125,7 +131,8 @@ Tests if the value is a valid ip (v4 or v6).
 
 ### Iso3166Country
 
-Tests if the value is a valid ISO-3166 country by alpha-3 code, alpha-2 code or name.
+Tests if the value is a valid ISO-3166 country by alpha-3 code, alpha-2 code, short name or uppercase name.
+All officially-assigned, transitionally-assigned and user-assigned codes are considered valid.
 
 ### Json
 
@@ -184,7 +191,7 @@ if (true !== violation) {
 
 ## Tests
 
-```
+```sh
 $ npm test
 ```
 

index.js

@@ -3,9 +3,9 @@
  * Module dependencies.
  */
 
+var _ = require('lodash');
 var Assert = require('validator.js').Assert;
 var asserts = require('require-dir')('./lib/asserts');
-var pascal = require('to-pascal-case');
 
 /**
  * Register asserts.
@@ -14,7 +14,7 @@ var pascal = require('to-pascal-case');
 for (var assert in asserts) {
   var func = asserts[assert];
 
-  assert = pascal(assert).replace('Assert', '');
+  assert = _.flowRight(_.capitalize, _.camelCase)(assert).replace('Assert', '');
 
   Assert.prototype[assert] = func;
 }

lib/asserts/country-assert.js

@@ -0,0 +1,66 @@
+
+/**
+ * Module dependencies.
+ */
+
+var _ = require('lodash');
+var Validator = require('validator.js').Validator;
+var Violation = require('validator.js').Violation;
+var countries = require('world-countries').concat(
+  require('world-countries/data/bes.divisions'),
+  require('world-countries/data/shn.divisions')
+);
+
+/**
+ * Export `CountryAssert`.
+ */
+
+module.exports = function() {
+
+  /**
+   * Class name.
+   */
+
+  this.__class__ = 'Country';
+
+  /**
+   * Validation algorithm.
+   */
+
+  this.validate = function(value) {
+    if ('string' !== typeof value) {
+      /* jshint camelcase: false */
+      throw new Violation(this, value, { value: Validator.errorCode.must_be_a_string });
+      /* jshint camelcase: true */
+    }
+
+    // Test by `alpha-3` code.
+    var country = _.find(countries, { cca3: value });
+
+    // Test by `alpha-2` code.
+    if (!country) {
+      country = _.find(countries, { cca2: value });
+    }
+
+    var name = value.toLocaleUpperCase();
+
+    // Test by `name`.
+    if (!country) {
+      country = _.find(countries, function(country) {
+        return country.name.common.toLocaleUpperCase() === name
+          || country.name.official.toLocaleUpperCase() === name
+          || _.find(country.altSpellings, function(altSpelling) {
+              return altSpelling.toLocaleUpperCase() === name;
+          });
+      });
+    }
+
+    if (!country) {
+      throw new Violation(this, value);
+    }
+
+    return true;
+  };
+
+  return this;
+};

lib/asserts/iso-3166-country-assert.js

@@ -6,7 +6,7 @@
 var _ = require('lodash');
 var Validator = require('validator.js').Validator;
 var Violation = require('validator.js').Violation;
-var countries = require('iso-3166-1-data');
+var countries = require('isoc');
 
 /**
  * Export `Iso3166CountryAssert`.
@@ -20,6 +20,12 @@ module.exports = function() {
 
   this.__class__ = 'Iso3166Country';
 
+  /**
+   * Data source.
+   */
+
+  this.countries = countries;
+
   /**
    * Validation algorithm.
    */
@@ -31,22 +37,25 @@ module.exports = function() {
       /* jshint camelcase: true */
     }
 
-    // Test by alpha-3 code.
-    var country = _.find(countries, { alpha3: value });
+    // Test by `alpha-3` code.
+    var country = _.find(this.countries, { alpha3: value });
 
-    // Test by alpha-2 code if a country was not found.
+    // Test by `alpha-2` code.
     if (!country) {
-      country = _.find(countries, { alpha2: value });
+      country = _.find(this.countries, { alpha2: value });
     }
 
-    // Test by full country name if a country was not found.
+    // Test by `name`.
+    var name = value.toLocaleUpperCase();
+
     if (!country) {
       country = _.find(countries, function(country) {
-        return country.name.toLowerCase() === value.toLowerCase();
+        return country.name.short.toLocaleUpperCase() === name
+          || country.name.uppercase.toLocaleUpperCase() === name
       });
     }
 
-    // Country is invalid or not in a ISO 3166-1 compatible format.
+    // Country is invalid or not in a `ISO 3166-1` compatible format.
     if (!country) {
       throw new Violation(this, value);
     }

package.json

@@ -44,20 +44,20 @@
     "node": ">= 0.10"
   },
   "dependencies": {
-    "bignumber.js": "^2.0.0",
-    "iso-3166-1-data": "0.0.2",
-    "lodash": "^2.4.1",
-    "moment": "^2.8.4",
-    "provinces": "^0.2.0",
-    "require-dir": "^0.1.0",
-    "to-pascal-case": "0.0.2",
-    "validator": "^3.22.1",
-    "validator.js": "^1.0.1"
+    "bignumber.js": "^2.0.7",
+    "isoc": "0.0.1",
+    "lodash": "^3.9.1",
+    "moment": "^2.10.3",
+    "provinces": "^1.7.1",
+    "require-dir": "^0.3.0",
+    "validator": "^3.40.0",
+    "validator.js": "^1.1.1",
+    "world-countries": "^1.7.3"
   },
   "devDependencies": {
-    "github-changes": "0.0.16",
-    "mocha": "^2.0.1",
-    "should": "^4.2.1",
-    "sinon": "^1.12.1"
+    "github-changes": "^1.0.0",
+    "mocha": "^2.2.5",
+    "should": "^6.0.3",
+    "sinon": "^1.14.1"
   }
 }

test/asserts/boolean-assert_test.js

@@ -26,6 +26,8 @@ describe('BooleanAssert', function() {
     choices.forEach(function(choice) {
       try {
         new Assert().Boolean().validate(choice);
+
+        should.fail();
       } catch (e) {
         e.should.be.instanceOf(Violation);
         /* jshint camelcase: false */

test/asserts/country-assert_test.js

@@ -0,0 +1,86 @@
+
+/**
+ * Module dependencies.
+ */
+
+var Assert = require('validator.js').Assert;
+var Validator = require('validator.js').Validator;
+var Violation = require('validator.js').Violation;
+var assert = require('../../lib/asserts/country-assert');
+var should = require('should');
+
+/**
+ * Test `CountryAssert`.
+ */
+
+describe('CountryAssert', function() {
+  before(function() {
+    Assert.prototype.Country = assert;
+  });
+
+  it('should throw an error if the input value is not a string', function() {
+    var choices = [[], {}, 123];
+
+    choices.forEach(function(choice) {
+      try {
+        new Assert().Country().validate(choice);
+
+        should.fail();
+      } catch (e) {
+        e.should.be.instanceOf(Violation);
+        /* jshint camelcase: false */
+        e.violation.value.should.equal(Validator.errorCode.must_be_a_string);
+        /* jshint camelcase: true */
+      }
+    });
+  });
+
+  it('should throw an error if country is invalid', function() {
+    try {
+      new Assert().Country().validate('FOO');
+
+      should.fail();
+    } catch (e) {
+      e.should.be.instanceOf(Violation);
+      e.value.should.equal('FOO');
+    }
+  });
+
+  it('should expose `assert` equal to `Country`', function() {
+    try {
+      new Assert().Country().validate([]);
+
+      should.fail();
+    } catch(e) {
+      e.show().assert.should.equal('Country');
+    }
+  });
+
+  it('should accept an `alpha-3` code', function() {
+    new Assert().Country().validate('PRT');
+  });
+
+  it('should accept an `alpha-3` code belonging to a division', function() {
+    new Assert().Country().validate('SHN');
+  });
+
+  it('should accept an `alpha-2` code', function() {
+    new Assert().Country().validate('PT');
+  });
+
+  it('should accept an `alpha-2` code belonging to a division', function() {
+    new Assert().Country().validate('BQ');
+  });
+
+  it('should accept a country `official` name', function() {
+    new Assert().Country().validate('Portuguese Republic');
+  });
+
+  it('should accept a country `common` name', function() {
+    new Assert().Country().validate('Portugal');
+  });
+
+  it('should accept a country `altSpelling` name', function() {
+    new Assert().Country().validate('República Portuguesa');
+  });
+});

test/asserts/ip-assert_test.js

@@ -24,6 +24,8 @@ describe('IpAssert', function() {
     choices.forEach(function(choice) {
       try {
         new Assert().Ip().validate(choice);
+
+        should.fail();
       } catch (e) {
         e.should.be.instanceOf(Violation);
         /* jshint camelcase: false */

test/asserts/iso-3166-country-assert_test.js

@@ -24,6 +24,8 @@ describe('Iso3166CountryAssert', function() {
     choices.forEach(function(choice) {
       try {
         new Assert().Iso3166Country().validate(choice);
+
+        should.fail();
       } catch (e) {
         e.should.be.instanceOf(Violation);
         /* jshint camelcase: false */
@@ -62,7 +64,11 @@ describe('Iso3166CountryAssert', function() {
     new Assert().Iso3166Country().validate('PT');
   });
 
-  it('should accept an ISO 3166-1 country name', function() {
+  it('should accept an ISO 3166-1 country name in short format', function() {
     new Assert().Iso3166Country().validate('Portugal');
   });
+
+  it('should accept an ISO 3166-1 country name in uppercase format', function() {
+    new Assert().Iso3166Country().validate('PORTUGAL');
+  });
 });