Add CPF taxpayer identification number assert

Author: acostalima

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`)
+- [CpfNumber](#cpfnumber) (requires `cpf`)
 - [CreditCard](#creditcard) (requires `creditcard`)
 - [Date](#date) (requires `moment` for format validation only)
 - [DateDiffGreaterThan](#datediffgreaterthan) (requires `moment`)
@@ -106,6 +107,9 @@ 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.
 
+### CpfNumber
+Tests if the value is valid CPF number.
+
 ### CreditCard
 Tests if the value is a valid credit card number using the Luhn10 algorithm.
 

package.json

@@ -63,6 +63,7 @@
   "optionalPeerDependencies": {
     "abavalidator": ">=2 <3",
     "bignumber.js": ">=7 <=9.0.0",
+    "cpf": "^2.0.1",
     "creditcard": ">=0.0.1 <1.0.0",
     "google-libphonenumber": ">=1 <4",
     "iban": ">=0.0.6 <1.0.0",

src/asserts/cpf-number-assert.js

@@ -0,0 +1,53 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const _ = require('lodash');
+const { Validator, Violation } = require('validator.js');
+let cpf;
+
+/**
+ * Optional peer dependencies.
+ */
+
+try {
+  cpf = require('cpf');
+} catch (e) {
+  // eslint-disable-next-line no-empty
+}
+
+/**
+ * Export `CpfNumber`.
+ */
+
+module.exports = function cpfNumberAssert() {
+  if (!cpf) {
+    throw new Error('cpf is not installed');
+  }
+
+  /**
+   * Class name.
+   */
+
+  this.__class__ = 'CpfNumber';
+
+  /**
+   * Validation algorithm.
+   */
+
+  this.validate = function (value) {
+    if (!_.isString(value)) {
+      throw new Violation(this, value, { value: Validator.errorCode.must_be_a_string });
+    }
+
+    if (!cpf.isValid(value)) {
+      throw new Violation(this, value, { value: 'must_be_a_valid_cpf_number' });
+    }
+
+    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 CpfNumber = require('./asserts/cpf-number-assert');
 const CreditCard = require('./asserts/credit-card-assert.js');
 const Date = require('./asserts/date-assert.js');
 const DateDiffGreaterThan = require('./asserts/date-diff-greater-than-assert.js');
@@ -56,6 +57,7 @@ module.exports = {
   BigNumberLessThanOrEqualTo,
   Boolean,
   Callback,
+  CpfNumber,
   CreditCard,
   Date,
   DateDiffGreaterThan,

test/asserts/cpf-number-assert.test.js

@@ -0,0 +1,67 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const { Assert: BaseAssert, Violation } = require('validator.js');
+const CpfNumberAssert = require('../../src/asserts/cpf-number-assert');
+
+/**
+ * Extend `Assert` with `CpfNumberAssert`.
+ */
+
+const Assert = BaseAssert.extend({
+  CpfNumber: CpfNumberAssert
+});
+
+/**
+ * Test `CpfNumberAssert`.
+ */
+
+describe('CpfNumberAssert', () => {
+  it('should throw an error if the input value is not a string', () => {
+    try {
+      Assert.cpfNumber().validate();
+
+      fail();
+    } catch (e) {
+      expect(e).toBeInstanceOf(Violation);
+      expect(e.show().assert).toBe('CpfNumber');
+      expect(e.value).toBeUndefined();
+      expect(e.violation.value).toBe('must_be_a_string');
+    }
+  });
+
+  it('should throw an error if `cpf` is invalid', () => {
+    try {
+      Assert.cpfNumber().validate('123');
+
+      fail();
+    } catch (e) {
+      expect(e).toBeInstanceOf(Violation);
+      expect(e.value).toBe('123');
+      expect(e.violation.value).toBe('must_be_a_valid_cpf_number');
+    }
+  });
+
+  it('should throw an error if `cpf` is invalid but correctly formatted', () => {
+    try {
+      Assert.cpfNumber().validate('564.232.751-31');
+
+      fail();
+    } catch (e) {
+      expect(e).toBeInstanceOf(Violation);
+      expect(e.value).toBe('564.232.751-31');
+      expect(e.violation.value).toBe('must_be_a_valid_cpf_number');
+    }
+  });
+
+  it('should accept a valid `cpf` not formatted', () => {
+    Assert.cpfNumber().validate('43228987264');
+  });
+
+  it('should accept a valid `cpf` correctly formatted', () => {
+    Assert.cpfNumber().validate('432.289.872-64');
+  });
+});

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(36);
+    expect(assertNames).toHaveLength(37);
     expect(assertNames).toEqual(
       expect.arrayContaining([
         'AbaRoutingNumber',
@@ -27,6 +27,7 @@ describe('validator.js-asserts', () => {
         'BigNumberLessThanOrEqualTo',
         'Boolean',
         'Callback',
+        'CpfNumber',
         'CreditCard',
         'Date',
         'DateDiffGreaterThan',

yarn.lock

@@ -1096,6 +1096,11 @@ core-util-is@~1.0.0:
   resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85"
   integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==
 
+cpf@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/cpf/-/cpf-2.0.1.tgz#7979eb33f0a14e8217292944311faaba82cb7f02"
+  integrity sha512-YpRbrpjQCDkZgMUOLxLfme8wE8X56fHXOGMGDsYA48f7UrjaCHU0TP8d+CKmxvNVjBDVtHiCUiBw8vfstdslbw==
+
 creditcard@^0.1.2:
   version "0.1.2"
   resolved "https://registry.npmjs.org/creditcard/-/creditcard-0.1.2.tgz"