add 1.0.0 release, regex as pattern, wrap comparison functions

Author: potapovDim

lib/compare.ts

@@ -1,14 +1,55 @@
 /* eslint-disable sonarjs/cognitive-complexity */
-import { isArray, isObject, isPrimitive, isString, isUndefined, isNumber, getType, isEmptyObject } from './types';
+import {
+  isArray,
+  isObject,
+  isPrimitive,
+  isString,
+  isUndefined,
+  isNumber,
+  getType,
+  isEmptyObject,
+  isRegExp,
+} from './types';
 import { execNumberExpression, toArray, safeHasOwnPropery } from './utils';
+import { getRandomString } from './randomizer';
+
+const { toDataIncludes, checkThatDataIncludes, removeDataIncludesId } = (function () {
+  const checkIncludesId = `${getRandomString(7)}_check_number=`;
+
+  return {
+    toDataIncludes: (item: string) => `${checkIncludesId}${item}`,
+    checkThatDataIncludes: (item: string) => item.indexOf(checkIncludesId) === 0,
+    removeDataIncludesId: (item: string) => item.replace(checkIncludesId, ''),
+  };
+})();
+
+const { toPatternIncludes, checkThatPatternIncludes, removePatternIncludesId } = (function () {
+  const patternIncludesId = `${getRandomString(7)}_pattern_includes=`;
+
+  return {
+    toPatternIncludes: (item: string) => `${patternIncludesId}${item}`,
+    checkThatPatternIncludes: (item: string) => item.indexOf(patternIncludesId) === 0,
+    removePatternIncludesId: (item: string) => item.replace(patternIncludesId, ''),
+  };
+})();
+
+const { toCheckNumber, checkThatCheckNumber, removeCheckNumberId } = (function () {
+  const patternIncludesId = `${getRandomString(7)}_check_number=`;
+
+  return {
+    toCheckNumber: (item: string) => `${patternIncludesId}${item}`,
+    checkThatCheckNumber: (item: string) => item.indexOf(patternIncludesId) === 0,
+    removeCheckNumberId: (item: string) => item.replace(patternIncludesId, ''),
+  };
+})();
 
 function getErrorMessage(data, piece) {
-  if (isNumber(data) && isString(piece) && piece.indexOf('_check_number=') === 0) {
-    return `expected: ${piece.replace('_check_number=', '').trim()}, actual: ${data}`;
-  } else if (isString(data) && isString(piece) && piece.indexOf('_pattern_includes=') === 0) {
-    return `pattern does not include data expected: ${piece.replace('_pattern_includes=', '')} to include ${data}`;
-  } else if (isString(data) && isString(piece) && piece.indexOf('_data_includes=') === 0) {
-    return `data does not include pattern expected: ${piece.replace('_data_includes=', '')} to be part of ${data}`;
+  if (isNumber(data) && isString(piece) && checkThatCheckNumber(piece)) {
+    return `expected: ${removeCheckNumberId(piece).trim()}, actual: ${data}`;
+  } else if (isString(data) && isString(piece) && checkThatPatternIncludes(piece)) {
+    return `pattern does not include data expected: ${removePatternIncludesId(piece)} to include ${data}`;
+  } else if (isString(data) && isString(piece) && checkThatDataIncludes(piece)) {
+    return `data does not include pattern expected: ${removeDataIncludesId(piece)} to be part of ${data}`;
   } else if (getType(data) !== getType(piece)) {
     return `data should match to pattern expected: ${getType(piece)} ${piece}, actual: ${getType(data)} ${data}`;
   }
@@ -34,7 +75,13 @@ type TCompareOpts = {
   ignoreProperties?: string | string[];
 };
 
-function compareToPattern(dataToCheck, pattern, options?: TCompareOpts) {
+type TCompareToPattern = ((data: any, patter: any, options?: TCompareOpts) => { result: boolean; message: string }) & {
+  toDataIncludes: (arg: string) => string;
+  toPatternIncludes: (arg: string) => string;
+  toCheckNumber: (arg: string) => string;
+};
+
+const compareToPattern: TCompareToPattern = function (dataToCheck, pattern, options?: TCompareOpts) {
   const {
     separator = '->',
     ignoreProperties,
@@ -52,14 +99,16 @@ function compareToPattern(dataToCheck, pattern, options?: TCompareOpts) {
 
       if (allowNumberTypecast && ((isNumber(data) && isString(piece)) || (isNumber(piece) && isString(data)))) {
         compareResult = data == piece;
-      } else if (isNumber(data) && isString(piece) && piece.indexOf('_check_number=') === 0) {
-        compareResult = execNumberExpression(piece.replace('_check_number=', '').trim(), data);
-      } else if (isString(data) && isString(piece) && piece.indexOf('_pattern_includes=') === 0) {
-        compareResult = piece.replace('_pattern_includes=', '').includes(data);
-      } else if (isString(data) && isString(piece) && piece.indexOf('_data_includes=') === 0) {
-        compareResult = data.includes(piece.replace('_data_includes=', ''));
+      } else if (isNumber(data) && isString(piece) && checkThatCheckNumber(piece)) {
+        compareResult = execNumberExpression(removeCheckNumberId(piece).trim(), data);
+      } else if (isString(data) && isString(piece) && checkThatPatternIncludes(piece)) {
+        compareResult = removePatternIncludesId(piece).includes(data);
+      } else if (isString(data) && isString(piece) && checkThatDataIncludes(piece)) {
+        compareResult = data.includes(removeDataIncludesId(piece));
       } else if (isString(data) && isString(piece) && stringIncludes) {
         compareResult = data.includes(piece);
+      } else if (isString(data) && isRegExp(piece)) {
+        compareResult = (piece as RegExp).test(data);
       } else {
         compareResult = data === piece;
       }
@@ -175,6 +224,10 @@ function compareToPattern(dataToCheck, pattern, options?: TCompareOpts) {
   }
 
   return { result, message };
-}
+} as any;
+
+compareToPattern.toCheckNumber = toCheckNumber;
+compareToPattern.toDataIncludes = toDataIncludes;
+compareToPattern.toPatternIncludes = toPatternIncludes;
 
 export { compareToPattern };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sat-utils",
-  "version": "0.3.2",
+  "version": "1.0.0",
   "description": "Utils library",
   "main": "built/index.js",
   "scripts": {

readme.md

@@ -363,6 +363,19 @@ const { compareToPattern } = require('sat-utils');
     b: { c: { d: { text: 'second' } } },
   };
 
+  const pattern = {
+    b: { c: { d: { text: /.*/ } } },
+  };
+
+  const { result, message } = compareToPattern(data, pattern);
+  // result is true, message is ''
+}
+{
+  const data = {
+    a: { text: 'first' },
+    b: { c: { d: { text: 'second' } } },
+  };
+
   const pattern = {
     b: { c: { d: { text: 'second' } } },
   };

specs/compare.spec.ts

@@ -84,7 +84,7 @@ describe('SPEC', function () {
   it('[P] compareToPattern _check_number', function () {
     {
       const pattern = {
-        field: '_check_number= > 10',
+        field: compareToPattern.toCheckNumber('> 10'),
       };
       const data = {
         field: 11,
@@ -96,7 +96,7 @@ describe('SPEC', function () {
     }
     {
       const pattern = {
-        field: '_check_number= > 10 and < 12',
+        field: compareToPattern.toCheckNumber('> 10 and < 12'),
       };
       const data = {
         field: 11,
@@ -111,7 +111,7 @@ describe('SPEC', function () {
   it('[N] compareToPattern _check_number', function () {
     {
       const pattern = {
-        field: '_check_number= > 11',
+        field: compareToPattern.toCheckNumber(' > 11'),
       };
       const data = {
         field: 11,
@@ -209,7 +209,7 @@ describe('SPEC', function () {
     const pattern = {
       c: {
         length: 1,
-        a: '_data_includes=different part',
+        a: compareToPattern.toDataIncludes('different part'),
       },
     };
 
@@ -226,7 +226,7 @@ describe('SPEC', function () {
     const pattern = {
       c: {
         length: 1,
-        a: '_pattern_includes=long string with different parts',
+        a: compareToPattern.toPatternIncludes('long string with different parts'),
       },
     };