Added isValidCPECUI andd formatToCurrency (#27)

Author: JoaoFGuiomar

docs/_sidebar.md

@@ -6,9 +6,11 @@
 * Documentation
   * Formaters
     * [formatDecimalNumber](formaters?id=formatdecimalnumbernumber-stringnumber-options-object)
+    * [formatToCurrency](formaters?id=formattocurrencynumber-number-numdecimals-number)
   * Validators
     * [isValidNIF](validators.md?id=isvalidnifnif-string)
     * [isValidPostalCode](validators.md?id=isvalidpostalcodepostalcode-string)
     * [isValidMobileNumber](validators.md?id=isvalidmobilenumbermobilenumber-string)
     * [isValidCCNumber](validators.md?id=isvalidccnumbercitizencardnumber-string)
     * [isValidLicensePlate](validators.md?id=isvalidlicenseplateplatenumber-string)
+    * [isValidCPECUI](validators.md?id=isvalidcpecui-string)

docs/formaters.md

@@ -61,3 +61,41 @@ formatedNumber = formatDecimalNumber(300.128, {
 console.log(formatedNumber)
 // => '300,128'
 ```
+
+## formatToCurrency(number: number, numDecimals: number)
+
+Formats numbers (integer or floating) portugal's currency
+
+#### Arguments
+
+**number (number)**: The number to be formated
+
+**numDecimals (number)**: Option for number of decimals
+
+> _default: 0_
+
+#### Returns
+
+**_(string)_**: The formated number
+
+#### Example
+
+```js
+import formatToCurrency from 'portuguese-utils/formaters/formatToCurrency'
+
+// Default options
+let formatedNumber = formatToCurrency('3000.134')
+
+console.log(formatedNumber)
+// => '3.00 €'
+
+formatedNumber = formatToCurrency(300.5, 2)
+
+console.log(formatedNumber)
+// => '300.50 €'
+
+formatedNumber = formatToCurrency(1234567.9, 2)
+
+console.log(formatedNumber)
+// => '1.234.567,90 €'
+```

docs/validators.md

@@ -1,16 +1,16 @@
 # Validators
 
 ## isValidNIF(nif: string)
-Validates a portuguese fiscal number
 
+Validates a portuguese fiscal number
 
 #### Arguments
-***nif (string)*** : The fiscal number to be checked as string.
 
+**_nif (string)_** : The fiscal number to be checked as string.
 
 #### Returns
-***(boolean)***: True if valid and False if invalid.
 
+**_(boolean)_**: True if valid and False if invalid.
 
 #### Example
 
@@ -23,16 +23,16 @@ console.log(isNIFValid)
 ```
 
 ## isValidPostalCode(postalCode: string)
-Validates a portuguese postal-code
 
+Validates a portuguese postal-code
 
 #### Arguments
-***postalCode (string)*** : The postal code to be checked as string.
 
+**_postalCode (string)_** : The postal code to be checked as string.
 
 #### Returns
-***(boolean)***: True if valid and False if invalid.
 
+**_(boolean)_**: True if valid and False if invalid.
 
 #### Example
 
@@ -43,17 +43,18 @@ const isCodeValid = isValidPostalCode('3865-134')
 console.log(isCodeValid)
 // => true
 ```
+
 ## isValidMobileNumber(mobileNumber: string)
-Validates a portuguese mobile number
 
+Validates a portuguese mobile number
 
 #### Arguments
-***mobileNumber (string)*** : The mobile number to be checked as string.
 
+**_mobileNumber (string)_** : The mobile number to be checked as string.
 
 #### Returns
-***(boolean)***: True if valid and False if invalid.
 
+**_(boolean)_**: True if valid and False if invalid.
 
 #### Example
 
@@ -66,16 +67,16 @@ console.log(isNumberValid)
 ```
 
 ## isValidCCNumber(citizenCardNumber: string)
-Validates a portuguese citizen card number
 
+Validates a portuguese citizen card number
 
 #### Arguments
-***citizenCardNumber (string)*** : The citizen card number to be checked as string.
 
+**_citizenCardNumber (string)_** : The citizen card number to be checked as string.
 
 #### Returns
-***(boolean)***: True if valid and False if invalid.
 
+**_(boolean)_**: True if valid and False if invalid.
 
 #### Example
 
@@ -88,16 +89,16 @@ console.log(isCCValid)
 ```
 
 ## isValidLicensePlate(plateNumber: string)
-Validates a portuguese license plate number
 
+Validates a portuguese license plate number
 
 #### Arguments
-***plateNumber (string)*** : The license plate number checked as string.
 
+**_plateNumber (string)_** : The license plate number checked as string.
 
 #### Returns
-***(boolean)***: True if valid and False if invalid.
 
+**_(boolean)_**: True if valid and False if invalid.
 
 #### Example
 
@@ -107,4 +108,29 @@ const isLicensePlateValid = isValidLicensePlate('00-AA-00')
 
 console.log(isLicensePlateValid)
 // => true
-```
+```
+
+## isValidCPECUI(cpe: string)
+
+Validates CPE and CUI
+
+* CPE - Código de ponto de entrega
+* CUI - Código universal da instalação
+
+#### Arguments
+
+**_cpe (string)_** : the CPE or CUI.
+
+#### Returns
+
+**_(boolean)_**: True if valid and False if invalid.
+
+#### Example
+
+```js
+import isValidCPECUI from 'portuguese-utils/validators/isValidCPECUI'
+const isValid = isValidCPECUI('PT 0014 483920194837 DW')
+
+console.log(isValid)
+// => true
+```

src/formaters/__tests__/formatToCurrency.test.js

@@ -0,0 +1,18 @@
+import formatToCurrency from 'formaters/formatToCurrency'
+
+test('formatToCurrency throws an error for invalid types', () => {
+  expect(() => formatToCurrency(undefined)).toThrow(TypeError)
+  expect(() => formatToCurrency('12345')).toThrow(TypeError)
+})
+
+test('formatToCurrency should return formatted number as currency string', () => {
+  expect(formatToCurrency(1234)).toBe('1 234 €')
+  expect(formatToCurrency(1, 2)).toBe('1,00 €')
+  expect(formatToCurrency(123)).toBe('123 €')
+  expect(formatToCurrency(1234, 2)).toBe('1 234,00 €')
+  expect(formatToCurrency(1234.5, 1)).toBe('1 234,5 €')
+  expect(formatToCurrency(1234.56, 2)).toBe('1 234,56 €')
+  expect(formatToCurrency(1234.563123)).toBe('1 234 €')
+  expect(formatToCurrency(1234.563123, 6)).toBe('1 234,563123 €')
+  expect(formatToCurrency(1234567.9, 2)).toBe('1 234 567,90 €')
+})

src/formaters/formatToCurrency.js

@@ -0,0 +1,61 @@
+/**
+ *
+ * Formats number (integer or float) to currency
+ * @param {number} number
+ *
+ **/
+
+export default function formatToCurrency(number, numDecimals) {
+  if (typeof number !== 'number') {
+    throw new TypeError('Argument number must be of type number')
+  }
+
+  let integer
+  let decimal
+  let output
+  let string = numDecimals
+    ? number.toFixed(numDecimals)
+    : Math.floor(number).toString()
+
+  if (string.indexOf('.') !== -1) {
+    let split = string.split('.')
+    decimal = split[1]
+    integer = addSeparators(split[0])
+    output = `${integer},${decimal}`
+  } else {
+    integer = addSeparators(string)
+    output = integer
+  }
+
+  output = `${output} €`
+  return output
+}
+
+/**
+  * Helper function
+  * Returns a number with thousands separator
+  + Example: 1000000 => 1.000.000
+  * @param {string} number
+**/
+
+function addSeparators(number) {
+  if (typeof number !== 'string' || isNaN(parseInt(number))) {
+    throw new TypeError('Argument number must be digits of type String')
+  }
+
+  if (number.indexOf('.') !== -1) {
+    throw new TypeError('Argument must be an integer of type String')
+  }
+
+  let count = 0
+
+  return number
+    .split('')
+    .reverse()
+    .reduce((end, digit, index) => {
+      end.push(index && index % 3 === 0 ? `${digit} ` : digit)
+      return end
+    }, [])
+    .reverse()
+    .join('')
+}

src/formaters/index.js

@@ -1,3 +1,4 @@
 import formatDecimalNumber from './formatDecimalNumber'
+import formatToCurrency from './formatToCurrency'
 
-export { formatDecimalNumber }
+export { formatDecimalNumber, formatToCurrency }

src/validators/__tests__/isValidCPECUI.test.js

@@ -0,0 +1,16 @@
+import isValidCPECUI from 'validators/isValidCPECUI'
+
+test('isValidCPECUI returns false for invalid number', () => {
+  expect(isValidCPECUI(undefined)).toBe(false)
+  expect(isValidCPECUI(1234)).toBe(false)
+  expect(isValidCPECUI('PT 0014 483920194837 DA')).toBe(false)
+  expect(isValidCPECUI('pt001448392019483da')).toBe(false)
+  expect(isValidCPECUI('P&0014483920194837DA')).toBe(false)
+})
+
+test('isValidCPECUI returns true if valid number', () => {
+  expect(isValidCPECUI('PT 0014 483920194837 DW')).toBe(true) // CPE
+  expect(isValidCPECUI('pt0014483920194837dw')).toBe(true) // CPE
+  expect(isValidCPECUI('PT 1234 000004614012 QQ')).toBe(true) // CUI
+  expect(isValidCPECUI('pt1234000004614012qq')).toBe(true) // CUI
+})

src/validators/index.js

@@ -3,5 +3,13 @@ import isValidNIF from './isValidNIF'
 import isValidMobileNumber from './isValidMobileNumber'
 import isValidCCNumber from './isValidCCNumber'
 import isValidLicensePlate from './isValidLicensePlate'
+import isValidCPECUI from './isValidCPECUI'
 
-export { isValidPostalCode, isValidNIF, isValidMobileNumber, isValidCCNumber, isValidLicensePlate }
+export {
+  isValidPostalCode,
+  isValidNIF,
+  isValidMobileNumber,
+  isValidCCNumber,
+  isValidLicensePlate,
+  isValidCPECUI
+}

src/validators/isValidCPECUI.js

@@ -0,0 +1,29 @@
+/**
+ * Validates if CPE (Código Ponto de Entrega) is in the valid format
+ * @param {String} cpe
+ */
+
+export default function isValidCPECUI(cpe) {
+  const ABValues = 'TRWAGMYFPDXBNJZSQVHLCKE'
+
+  // Must be a string
+  if (typeof cpe !== 'string') return false
+
+  // Validate with a pattern
+  // Rules: PT(4digits)(12digits)(2Characters)
+  const parsed = cpe.replace(/\s+/g, '').toUpperCase()
+  const pattern = /PT(\d{16})([A-Z]{2})/g
+  if (!pattern.test(parsed)) return false
+
+  // Calculate verification characters
+  // Documentation:
+  // https://bit.ly/2rARRWN
+  const digits = Number(parsed.replace(/[A-Z]/g, ''))
+  const remainder = digits % 529
+  const A = ABValues[Math.floor(remainder / 23)]
+  const B = ABValues[Math.floor(remainder % 23)]
+
+  // A and B must be in the CPE
+  const lastTwoCharacters = parsed.substring(parsed.length, parsed.length - 2)
+  return lastTwoCharacters === `${A}${B}`
+}