@legalplace/tagextractor 2.1.0 → 2.3.0

package/jest.config.ts

@@ -0,0 +1,205 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+const jestConfig = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/cc/yjms5nz10198m80g1mz2zy980000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  collectCoverageFrom: [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "!**/node_modules/**",
+    "!src/**/*.d.ts",
+  ],
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "./coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: ['/node_modules/', '/dist/'],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  coverageReporters: ["html", "text", "text-summary", "cobertura"],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: {
+  //   global: {
+  //     branches: 77,
+  //     functions: 100,
+  //     lines: 84,
+  //     statements: 84,
+  //   },
+  // },
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  moduleNameMapper: {
+    "\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$":
+      "<rootDir>__mocks__/fileMock.js",
+    "\\.(css|less|sass|scss)$": "identity-obj-proxy",
+  },
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  roots: ["src/"],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  setupFiles: ["./setupJest.ts"],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "jsdom",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    "^.+\\.tsx?$": "@swc-node/jest",
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default jestConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@legalplace/tagextractor",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "TagExtractor",
   "main": "dist/index.js",
   "repository": "https://git.legalplace.eu/legalplace/tagextractor",
@@ -10,34 +10,37 @@
     "format": "prettier --single-quote --no-semi --trailing-comma none --write \"src/**/*.{js,ts,tsx}\"",
     "lint": "tsc && eslint ./src/ --ext ts,js",
     "lint:fix": "tsc && eslint 'src/**/*.{js,jsx,ts,tsx}' --fix",
-    "test": "jest",
-    "build": "tsc"
+    "build": "tsc",
+    "test": "jest --watchAll",
+    "test:ci": "jest --config ./jest.config.ts --collectCoverage --coverageDirectory=\"./coverage\" --ci --reporters=default --reporters=jest-junit --watchAll=false",
+    "test:coverage": "jest test --coverage  --watchAll=false "
   },
   "dependencies": {
     "@legalplace/conditions-runner": "1.1.1",
     "@legalplace/lplogic": "2.1.6",
     "@legalplace/models-v3-types": "3.4.47",
     "@legalplace/ovc-converter": "1.1.0",
-    "@legalplace/referencesparser": "1.6.3",
-    "typescript": "3.9.3"
+    "@legalplace/referencesparser": "1.6.3"
   },
   "devDependencies": {
-    "@babel/core": "^7.7.2",
-    "@babel/preset-typescript": "^7.7.2",
+    "@legalplace/eslint-config": "^2.1.3",
+    "@legalplace/prettier-config": "^2.1.3",
     "@legalplace/types": "1.1.0",
-    "@types/jest": "^24.0.15",
-    "@types/node": "^12.12.6",
-    "@typescript-eslint/eslint-plugin": "^2.6.1",
-    "@typescript-eslint/parser": "^2.6.1",
-    "airbnb-standard": "^1.0.0",
-    "eslint": "^6.6.0",
-    "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-config-prettier": "^6.5.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-prettier": "^3.1.1",
-    "jest": "^24.8.0",
-    "prettier": "1.19.1",
-    "redux-mock-store": "^1.5.3",
-    "ts-jest": "^24.0.2"
-  }
+    "@swc-node/jest": "^1.4.3",
+    "@types/jest": "27.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.8.0",
+    "eslint": "^8.5.0",
+    "eslint-config-airbnb": "^19.0.2",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-react-app": "^7.0.0",
+    "jest": "27.4.7",
+    "jest-fetch-mock": "^3.0.3",
+    "jest-junit": "^13.0.0",
+    "prettier": "^2.5.1",
+    "ts-jest": "27.1.2",
+    "ts-node": "^10.4.0",
+    "typescript": "4.5.2"
+  },
+  "prettier": "@legalplace/prettier-config",
+  "gitHead": "b78de6625e6f2651aeb2bdb470ae4dfc6e4a8487"
 }

package/setupJest.ts

@@ -0,0 +1,8 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import { GlobalWithFetchMock } from "jest-fetch-mock";
+
+const customGlobal: GlobalWithFetchMock =
+  global as unknown as GlobalWithFetchMock;
+customGlobal.fetch = require("jest-fetch-mock");
+
+customGlobal.fetchMock = customGlobal.fetch;

package/src/index.ts

@@ -1,6 +1,6 @@
-import TagExtractor from './libs/Extractor'
+import TagExtractor from "./libs/Extractor";
 
-import TagsType, { OptionTagType, VariableTagType } from './types/tags.type'
+import TagsType, { OptionTagType, VariableTagType } from "./types/tags.type";
 
-export { TagsType, OptionTagType, VariableTagType }
-export default TagExtractor
+export type { TagsType, OptionTagType, VariableTagType };
+export default TagExtractor;

package/src/libs/Extractor.test.ts

@@ -0,0 +1,360 @@
+import { ReferencesType } from "@legalplace/referencesparser/dist/libs/References.type";
+import InputsType from "@legalplace/types/dist/inputs";
+import OvcType from "@legalplace/types/dist/ovc";
+import { ModelV3 } from "@legalplace/models-v3-types";
+import TagExtractor from "./Extractor";
+import ovcJson from "./fixtures/ovc.json";
+import inputsJson from "./fixtures/inputs.json";
+import referencesJson from "./fixtures/references.json";
+import modelJson from "./fixtures/model.json";
+
+const simpleReferences = referencesJson as unknown as ReferencesType;
+const simpleModel = modelJson as unknown as ModelV3;
+const simpleOvc = ovcJson as unknown as OvcType;
+const simpleInputs = inputsJson as unknown as InputsType;
+
+describe("TagsExtractor", () => {
+  const tagExtractor = new TagExtractor(simpleReferences, simpleInputs);
+
+  afterEach(() => {
+    jest.clearAllMocks();
+    jest.restoreAllMocks();
+  });
+
+  describe("IsVariableDisplayed", () => {
+    it("should return false when variable condition is false", () => {
+      const getVariableCondition = jest.spyOn(
+        TagExtractor.prototype as any,
+        "getVariableCondition"
+      );
+      getVariableCondition.mockImplementation(() => false);
+
+      expect(tagExtractor.isVariableDisplayed(1, 0)).toBeFalsy();
+      expect(getVariableCondition).toHaveBeenCalledWith(1, 0);
+    });
+    it("should return false when parent Option is not displayed", () => {
+      const isOptionDisplayed = jest.spyOn(
+        TagExtractor.prototype as any,
+        "isOptionDisplayed"
+      );
+      isOptionDisplayed.mockImplementation(() => false);
+
+      expect(tagExtractor.isVariableDisplayed(1, 0)).toBeFalsy();
+      expect(isOptionDisplayed).toHaveBeenCalledWith(6, 0);
+    });
+    it("should return false when parent Option is not truthful", () => {
+      const inputsWithParentsFalse = {
+        ...simpleInputs,
+        options: { ...simpleInputs.options, "6": [false] },
+      };
+      const customTagExtractor = new TagExtractor(
+        simpleReferences,
+        inputsWithParentsFalse
+      );
+      expect(customTagExtractor.isVariableDisplayed(1, 0)).toBeFalsy();
+    });
+    it("should return true when all checks are okay", () => {
+      const inputsWithAllChecks = {
+        ...simpleInputs,
+        options: { ...simpleInputs.options, "8": [true] },
+      };
+      const customTagExtractor = new TagExtractor(
+        simpleReferences,
+        inputsWithAllChecks
+      );
+
+      expect(customTagExtractor.isVariableDisplayed(1, 0)).toBeTruthy();
+    });
+  });
+  describe("IsOptionDisplayed", () => {
+    it("should return false when option condition is false", () => {
+      const getOptionCondition = jest.spyOn(
+        TagExtractor.prototype as any,
+        "getOptionCondition"
+      );
+      getOptionCondition.mockImplementation(
+        (id, index) => !(id === 24 && index === 0)
+      );
+
+      expect(tagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+      expect(getOptionCondition).toHaveBeenCalledWith(24, 0);
+    });
+    it("should return false when parentSectionCondition is false", () => {
+      const getSectionCondition = jest.spyOn(
+        TagExtractor.prototype as any,
+        "getSectionCondition"
+      );
+      getSectionCondition.mockImplementation(() => false);
+
+      expect(tagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+      expect(getSectionCondition).toHaveBeenCalledWith(1);
+    });
+    it("should return false when parentCondition contains false value", () => {
+      const getOptionCondition = jest.spyOn(
+        TagExtractor.prototype as any,
+        "getOptionCondition"
+      );
+      getOptionCondition.mockImplementation(
+        (id, index) => !(id === 6 && index === 0)
+      );
+
+      expect(tagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+      expect(getOptionCondition).toHaveBeenCalledWith(24, 0);
+    });
+    it("should return false when parentsInputs list contains false value", () => {
+      const inputsWithParentsInputsFalse = {
+        ...simpleInputs,
+        options: { ...simpleInputs.options, "6": [false] },
+      };
+      const customTagExtractor = new TagExtractor(
+        simpleReferences,
+        inputsWithParentsInputsFalse
+      );
+
+      expect(customTagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+    });
+    it("should not return errors when parentsInputs is undefined", () => {
+      const inputsWithParentsInputsUndefined = {
+        ...simpleInputs,
+        options: { ...simpleInputs.options },
+      };
+      delete inputsWithParentsInputsUndefined.options["6"];
+      const customTagExtractor = new TagExtractor(
+        simpleReferences,
+        inputsWithParentsInputsUndefined
+      );
+
+      expect(customTagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+    });
+    it("should return true when all checks are okay", () => {
+      expect(tagExtractor.isOptionDisplayed(24, 0)).toBeTruthy();
+    });
+  });
+  describe("convertToOptionVariables", () => {
+    it("should tag extraction match when instanciating TagExtractor with ovc or inputs", () => {
+      const customTagExtractor = new TagExtractor(simpleReferences, simpleOvc);
+      const expectedTags = new TagExtractor(simpleReferences, simpleInputs)
+        .getTags;
+
+      expect(customTagExtractor.getTags).toMatchObject(expectedTags);
+    });
+  });
+  describe("ReferenceParser", () => {
+    it("should tag extraction match when instanciating TagExtractor with model or references", () => {
+      const customTagExtractor = new TagExtractor(simpleModel, simpleInputs);
+      const expectedTags = new TagExtractor(simpleReferences, simpleInputs)
+        .getTags;
+
+      expect(customTagExtractor.getTags).toMatchObject(expectedTags);
+    });
+  });
+  describe("extractFromOptions", () => {
+    it("should return empty tag object when tags are undefined", () => {
+      const referencesWithoutOptionTagArray = {
+        ...simpleReferences,
+        options: {
+          ...simpleReferences.options,
+          "7": {
+            ...simpleReferences.options["7"],
+            meta: { ...simpleReferences.options["7"].meta, tags: undefined },
+          },
+        },
+      };
+      const customTagExtractor = new TagExtractor(
+        referencesWithoutOptionTagArray,
+        simpleInputs
+      );
+
+      expect(customTagExtractor.getTags.options).toMatchObject({});
+    });
+    it("should return empty tag object when options tags are empty", () => {
+      const referencesWithoutOptionTags = {
+        ...simpleReferences,
+        options: {
+          ...simpleReferences.options,
+          "7": {
+            ...simpleReferences.options["7"],
+            meta: { ...simpleReferences.options["7"].meta, tags: [] },
+          },
+        },
+      };
+      const customTagExtractor = new TagExtractor(
+        referencesWithoutOptionTags,
+        simpleInputs
+      );
+
+      expect(customTagExtractor.getTags.options).toMatchObject({});
+    });
+    it("should return empty tags when input's option is undefined", () => {
+      const inputsWithoutOptionTaggedAnswer = {
+        ...simpleInputs,
+        options: { ...simpleInputs.options },
+      };
+      delete inputsWithoutOptionTaggedAnswer.options["7"];
+      const customTagExtractor = new TagExtractor(
+        simpleReferences,
+        inputsWithoutOptionTaggedAnswer
+      );
+
+      expect(customTagExtractor.getTags.options).toMatchObject({});
+    });
+    it("should return option tag when champ multiples", () => {
+      const inputWithChampMultiple = {
+        ...simpleInputs,
+        options: { ...simpleInputs.options, "7": [true, false] },
+      };
+      const customTagExtractor = new TagExtractor(
+        simpleReferences,
+        inputWithChampMultiple
+      );
+      const expectedOptionTags = {
+        LP_fan: [
+          {
+            id: 7,
+            index: 0,
+            label: "Connaissiez-vous déjà LegalPlace ?",
+            condition: true,
+            visible: true,
+            value: true,
+          },
+          {
+            id: 7,
+            index: 1,
+            label: "Connaissiez-vous déjà LegalPlace ?",
+            condition: true,
+            visible: true,
+            value: false,
+          },
+        ],
+      };
+      expect(customTagExtractor.getTags.options).toMatchObject(
+        expectedOptionTags
+      );
+    });
+    it("should return option tags", () => {
+      const expectedOptionTags = {
+        LP_fan: [
+          {
+            id: 7,
+            index: 0,
+            label: "Connaissiez-vous déjà LegalPlace ?",
+            condition: true,
+            visible: true,
+            value: true,
+          },
+        ],
+      };
+      expect(tagExtractor.getTags.options).toMatchObject(expectedOptionTags);
+    });
+  });
+  describe("extractFromVariables", () => {
+    it("should return empty tag object when tags are undefined", () => {
+      const referenceWithoutVariableTagArray = {
+        ...simpleReferences,
+        variables: {
+          ...simpleReferences.variables,
+          "1": { ...simpleReferences.variables["1"], tags: undefined },
+        },
+      };
+      const customTagExtractor = new TagExtractor(
+        referenceWithoutVariableTagArray,
+        simpleInputs
+      );
+
+      expect(customTagExtractor.getTags.variables).toMatchObject({});
+    });
+    it("should return empty tag object when variables tags are empty", () => {
+      const referenceWithoutTags = {
+        ...simpleReferences,
+        variables: {
+          ...simpleReferences.variables,
+          "1": { ...simpleReferences.variables["1"], tags: [] },
+        },
+      };
+      const customTagExtractor = new TagExtractor(
+        referenceWithoutTags,
+        simpleInputs
+      );
+
+      expect(customTagExtractor.getTags.variables).toMatchObject({});
+    });
+    it("should return empty tags when input's variable is undefined", () => {
+      const inputsWithoutVariableTaggedAnswer = {
+        ...simpleInputs,
+        variables: { ...simpleInputs.variables },
+      };
+      delete inputsWithoutVariableTaggedAnswer.variables[1];
+      const customTagExtractor = new TagExtractor(
+        simpleReferences,
+        inputsWithoutVariableTaggedAnswer
+      );
+
+      expect(customTagExtractor.getTags.variables).toMatchObject({});
+    });
+    it("should not throw error when input's variable does not match any references variable", () => {
+      const referenceWithoutMatchingVariable = {
+        ...simpleReferences,
+        variables: { ...simpleReferences.variables },
+      };
+      delete referenceWithoutMatchingVariable.variables["2"];
+
+      const customTagExtractor = new TagExtractor(
+        referenceWithoutMatchingVariable,
+        simpleInputs
+      );
+      const expectedVariableTags = {
+        Company_name: [
+          {
+            id: 1,
+            index: 0,
+            label: "Nom de l'entreprise",
+            condition: false,
+            visible: false,
+            value: "Company",
+          },
+        ],
+      };
+
+      expect(customTagExtractor.getTags.variables).toMatchObject(
+        expectedVariableTags
+      );
+    });
+    it("should return variable tag when champ multiples", () => {
+      const inputVariableWithChampMultiple = {
+        ...simpleInputs,
+        variables: {
+          ...simpleInputs.variables,
+          "1": ["Nom de la companie", "Testing Company"],
+        },
+      };
+      const customTagExtractor = new TagExtractor(
+        simpleReferences,
+        inputVariableWithChampMultiple
+      );
+      const expectedVariableTags = {
+        Company_name: [
+          {
+            id: 1,
+            index: 0,
+            label: "Nom de l'entreprise",
+            condition: false,
+            visible: false,
+            value: "Nom de la companie",
+          },
+          {
+            id: 1,
+            index: 1,
+            label: "Nom de l'entreprise",
+            condition: false,
+            visible: false,
+            value: "Testing Company",
+          },
+        ],
+      };
+
+      expect(customTagExtractor.getTags.variables).toMatchObject(
+        expectedVariableTags
+      );
+    });
+  });
+});