Add Canada zip code assert

Author: Megamind51

README.md

@@ -30,6 +30,7 @@ The following set of extra asserts are provided by this package:
 - [BigNumberLessThanOrEqualTo](#bignumberlessthanorequalto) (requires `bignumber.js`)
 - [Boolean](#boolean)
 - [Callback](#callback) (requires `callback`)
+- [CaZipCode](#cazipcode)
 - [CpfNumber](#cpfnumber) (requires `cpf`)
 - [CreditCard](#creditcard) (requires `creditcard`)
 - [CurpNumber](#curpnumber) (requires `curp`)
@@ -110,6 +111,10 @@ Allows you to add custom rules by giving a callback function and a custom class.
 - `callback` (required) - the callback function.
 - `customClass` (required) - the name of the class.
 
+### CaZipCode
+Tests if the value is valid Canada zip code.
+We only allow initial characters from the list on the [site](https://www.canadapost-postescanada.ca/cpc/en/support/articles/addressing-guidelines/postal-codes.page).
+
 ### CpfNumber
 Tests if the value is valid CPF number.
 

src/asserts/ca-zip-code-assert.js

@@ -0,0 +1,43 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const { Validator, Violation } = require('validator.js');
+
+/**
+ * Canada zip code regular expression.
+ */
+
+const regexp = new RegExp(/^[AaBbCcEeGgHhJjKkLlMmNnPpRrSsTtVvXxYy]\d[A-Za-z][ -]?\d[A-Za-z]\d$/);
+
+/**
+ * Export `CaZipCodeAssert`.
+ */
+
+module.exports = function caZipCodeAssert() {
+  /**
+   * Class name.
+   */
+
+  this.__class__ = 'CaZipCode';
+
+  /**
+   * Validation algorithm.
+   */
+
+  this.validate = function (value) {
+    if (typeof value !== 'string') {
+      throw new Violation(this, value, { value: Validator.errorCode.must_be_a_string });
+    }
+
+    if (!regexp.test(value)) {
+      throw new Violation(this, value);
+    }
+
+    return true;
+  };
+
+  return this;
+};

src/index.js

@@ -14,6 +14,7 @@ const BigNumberLessThan = require('./asserts/big-number-less-than-assert.js');
 const BigNumberLessThanOrEqualTo = require('./asserts/big-number-less-than-or-equal-to-assert.js');
 const Boolean = require('./asserts/boolean-assert.js');
 const Callback = require('./asserts/callback-assert');
+const CaZipCode = require('./asserts/ca-zip-code-assert.js');
 const CpfNumber = require('./asserts/cpf-number-assert');
 const CreditCard = require('./asserts/credit-card-assert.js');
 const CurpNumber = require('./asserts/curp-number-assert.js');
@@ -59,6 +60,7 @@ module.exports = {
   BigNumberLessThan,
   BigNumberLessThanOrEqualTo,
   Boolean,
+  CaZipCode,
   Callback,
   CpfNumber,
   CreditCard,

test/asserts/ca-zip-code-assert.test.js

@@ -0,0 +1,58 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const { Assert: BaseAssert, Validator, Violation } = require('validator.js');
+const CaZipCodeAssert = require('../../src/asserts/ca-zip-code-assert');
+
+/**
+ * Extend `Assert` with `CaZipCodeAssert`.
+ */
+
+const Assert = BaseAssert.extend({
+  CaZipCode: CaZipCodeAssert
+});
+
+/**
+ * Test `CaZipCodeAssert`.
+ */
+
+describe('CaZipCodeAssert', () => {
+  it('should throw an error if the input value is not a string', () => {
+    const choices = [[], {}, 123];
+
+    choices.forEach(choice => {
+      try {
+        Assert.caZipCode().validate(choice);
+
+        fail();
+      } catch (e) {
+        expect(e).toBeInstanceOf(Violation);
+        expect(e.violation.value).toBe(Validator.errorCode.must_be_a_string);
+      }
+    });
+  });
+
+  it('should throw an error if `value` is invalid', () => {
+    const choices = ['#', '1A1A9B', 'A1AA1A', 'D1A9B9'];
+
+    choices.forEach(choice => {
+      try {
+        Assert.caZipCode().validate(choice);
+
+        fail();
+      } catch (e) {
+        expect(e).toBeInstanceOf(Violation);
+        expect(e.show().assert).toBe('CaZipCode');
+      }
+    });
+  });
+
+  it('should accept a valid zip code', () => {
+    ['A1A1A1', 'A1A9B9', 'A1A9b9', 'A1a9B9', 'C9A2M6', 'C9A 2M6', 'T7A-2D3', 'a1A9B9'].forEach(choice => {
+      Assert.caZipCode().validate(choice);
+    });
+  });
+});

test/index.test.js

@@ -14,7 +14,7 @@ describe('validator.js-asserts', () => {
   it('should export all asserts', () => {
     const assertNames = Object.keys(asserts);
 
-    expect(assertNames).toHaveLength(40);
+    expect(assertNames).toHaveLength(41);
     expect(assertNames).toEqual(
       expect.arrayContaining([
         'AbaRoutingNumber',
@@ -26,6 +26,7 @@ describe('validator.js-asserts', () => {
         'BigNumberLessThan',
         'BigNumberLessThanOrEqualTo',
         'Boolean',
+        'CaZipCode',
         'Callback',
         'CpfNumber',
         'CreditCard',