@natlibfi/marc-record-merge 6.0.0-beta.1 → 6.0.0-beta.11

package/src/reducers/copy.spec.js

@@ -1,52 +1,54 @@
-/**
-*
-* @licstart  The following is the entire license notice for the JavaScript code in this file.
-*
-* Merge MARC records
-*
-* Copyright (C) 2015-2019 University Of Helsinki (The National Library Of Finland)
-*
-* This file is part of marc-record-merge-js
-
-* marc-record-merge-js program is free software: you can redistribute it and/or modify
-* it under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation, either version 3 of the
-* License, or (at your option) any later version.
-*
-* marc-record-merge-js is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-* GNU Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public License
-* along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*
-* @licend  The above is the entire license notice
-* for the JavaScript code in this file.
-*
-*/
-import chai from 'chai';
-import fs from 'fs';
-import path from 'path';
-import {MarcRecord} from '@natlibfi/marc-record';
+import {expect} from 'chai';
+import {READERS} from '@natlibfi/fixura';
 import createReducer from './copy';
-import fixturesFactory, {READERS} from '@natlibfi/fixura';
-
-MarcRecord.setValidationOptions({subfieldValues: false});
+import generateTests from '@natlibfi/fixugen';
 
-describe('reducers/copy', () => {
-  const {expect} = chai;
-  const fixturesPath = path.join(__dirname, '..', '..', 'test-fixtures', 'reducers', 'copy');
+//import createDebugLogger from 'debug'; // <---
+//const debug = createDebugLogger('@natlibfi/marc-record-merge/copy.spec.js'); // <---
 
-  fs.readdirSync(fixturesPath).forEach(subDir => {
-    const {getFixture} = fixturesFactory({root: [fixturesPath, subDir], reader: READERS.JSON});
-    it(subDir, () => {
-      const baseTest = new MarcRecord(getFixture('base.json'));
-      const sourceTest = new MarcRecord(getFixture('source.json'));
-      const patternTest = new RegExp(getFixture({components: ['pattern.txt'], reader: READERS.TEXT}), 'u');
-      const expectedRecord = getFixture('merged.json');
-      const mergedRecord = createReducer(patternTest)(baseTest, sourceTest);
-      expect(mergedRecord.toObject()).to.eql(expectedRecord);
-    });
-  });
+generateTests({
+  callback,
+  path: [__dirname, '..', '..', 'test-fixtures', 'reducers', 'copy'],
+  useMetadataFile: true,
+  recurse: true,
+  fixura: {
+    reader: READERS.JSON,
+    failWhenNotFound: false
+  }
 });
+
+function callback({
+  getFixture,
+  tagPatternRegExp,
+  compareTagsOnly = false,
+  compareWithoutTag = false,
+  compareWithoutIndicators = false,
+  compareWithoutIndicator1 = false,
+  compareWithoutIndicator2 = false,
+  subfieldsMustBeIdentical = false,
+  copyUnless = undefined,
+  excludeSubfields = undefined,
+  dropSubfields = undefined,
+  swapSubfieldCode = [],
+  swapTag = [],
+  doNotCopyIfFieldPresent = false
+}) {
+  const base = getFixture('base.json');
+  const source = getFixture('source.json');
+  const tagPattern = new RegExp(tagPatternRegExp, 'u');
+  const expectedRecord = getFixture('merged.json');
+
+  const merged = createReducer({
+    tagPattern, compareTagsOnly, compareWithoutTag, compareWithoutIndicators, compareWithoutIndicator1, compareWithoutIndicator2,
+    copyUnless, subfieldsMustBeIdentical, excludeSubfields,
+    dropSubfields, swapSubfieldCode, swapTag,
+    doNotCopyIfFieldPresent
+  })(base, source);
+  //debug(`***     mergedRecord: `, mergedRecord); //<--
+  //debug(`***     mergedRecord,Strfy: `, JSON.stringify(mergedRecord)); //<--
+  //debug(`***     expectedRecord: `, expectedRecord); //<--
+  //debug(`***     expectedRecord,Strfy: `, JSON.stringify(expectedRecord)); //<--
+  expect(merged.constructor.name).not.to.eql('MarcRecord');
+  expect(merged.constructor.name).to.eql('Object');
+  expect(merged).to.eql(expectedRecord);
+}

package/src/reducers/copy2.spec.js

@@ -0,0 +1,55 @@
+import {expect} from 'chai';
+import {READERS} from '@natlibfi/fixura';
+import createReducer from './copy';
+import generateTests from '@natlibfi/fixugen';
+
+//import createDebugLogger from 'debug'; // <---
+//const debug = createDebugLogger('@natlibfi/marc-record-merge/copy.spec.js'); // <---
+
+generateTests({
+  callback,
+  path: [__dirname, '..', '..', 'test-fixtures', 'reducers', 'copy'],
+  useMetadataFile: true,
+  recurse: true,
+  fixura: {
+    reader: READERS.JSON,
+    failWhenNotFound: false
+  }
+});
+
+
+function callback({
+  getFixture,
+  tagPatternRegExp,
+  compareTagsOnly = false,
+  compareWithoutTag = false,
+  compareWithoutIndicators = false,
+  compareWithoutIndicator1 = false,
+  compareWithoutIndicator2 = false,
+  subfieldsMustBeIdentical = false,
+  copyUnless = undefined,
+  excludeSubfields = undefined,
+  dropSubfields = undefined,
+  swapSubfieldCode = [],
+  swapTag = [],
+  doNotCopyIfFieldPresent = false
+}) {
+  const base = getFixture('base.json');
+  const source = getFixture('source.json');
+  const tagPattern = new RegExp(tagPatternRegExp, 'u');
+  const expectedRecord = getFixture('merged.json');
+
+  const merged = createReducer({
+    tagPattern, compareTagsOnly, compareWithoutTag, compareWithoutIndicators, compareWithoutIndicator1, compareWithoutIndicator2,
+    copyUnless, subfieldsMustBeIdentical, excludeSubfields,
+    dropSubfields, swapSubfieldCode, swapTag,
+    doNotCopyIfFieldPresent
+  })({base, source});
+  //debug(`***     mergedRecord: `, mergedRecord); //<--
+  //debug(`***     mergedRecord,Strfy: `, JSON.stringify(mergedRecord)); //<--
+  //debug(`***     expectedRecord: `, expectedRecord); //<--
+  //debug(`***     expectedRecord,Strfy: `, JSON.stringify(expectedRecord)); //<--
+  expect(merged.constructor.name).not.to.eql('MarcRecord');
+  expect(merged.constructor.name).to.eql('Object');
+  expect(merged).to.eql(expectedRecord);
+}

package/src/reducers/index.js

@@ -1,31 +1,4 @@
-/**
-*
-* @licstart  The following is the entire license notice for the JavaScript code in this file.
-*
-* Merge MARC records
-*
-* Copyright (C) 2015-2019 University Of Helsinki (The National Library Of Finland)
-*
-* This file is part of marc-record-merge-js
-
-* marc-record-merge-js program is free software: you can redistribute it and/or modify
-* it under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation, either version 3 of the
-* License, or (at your option) any later version.
-*
-* marc-record-merge-js is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-* GNU Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public License
-* along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*
-* @licend  The above is the entire license notice
-* for the JavaScript code in this file.
-*
-*/
-
-export * from './copy';
-export * from './select';
+import copy from './copy';
+import select, {strictEquality, subsetEquality} from './select';
 
+export default {copy, select, strictEquality, subsetEquality};

package/src/reducers/select.js

@@ -1,57 +1,62 @@
-/**
-*
-* @licstart  The following is the entire license notice for the JavaScript code in this file.
-*
-* Merge MARC records
-*
-* Copyright (C) 2015-2019 University Of Helsinki (The National Library Of Finland)
-*
-* This file is part of marc-record-merge-js
-
-* marc-record-merge-js program is free software: you can redistribute it and/or modify
-* it under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation, either version 3 of the
-* License, or (at your option) any later version.
-*
-* marc-record-merge-js is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-* GNU Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public License
-* along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*
-* @licend  The above is the entire license notice
-* for the JavaScript code in this file.
-*
-*/
 import {normalizeSync} from 'normalize-diacritics';
+import createDebugLogger from 'debug';
+import {MarcRecord} from '@natlibfi/marc-record';
 
 export function strictEquality(subfieldA, subfieldB) {
   return subfieldA.code === subfieldB.code &&
-  subfieldA.value === subfieldB.value;
+    subfieldA.value === subfieldB.value;
 }
 
 export function subsetEquality(subfieldA, subfieldB) {
   return subfieldA.code === subfieldB.code &&
-  (subfieldA.value.indexOf(subfieldB.value) !== -1 || subfieldB.value.indexOf(subfieldA.value) !== -1);
+    (subfieldA.value.indexOf(subfieldB.value) !== -1 || subfieldB.value.indexOf(subfieldA.value) !== -1);
 }
+// EqualityFunction can be either strictEquality or subsetEquality
+
+export default ({
+  tagPattern,
+  equalityFunction = strictEquality,
+  baseValidators = {subfieldValues: false},
+  sourceValidators = {subfieldValues: false}
+// eslint-disable-next-line max-statements
+}) => (base, source) => {
+  const debug = createDebugLogger('@natlibfi/marc-record-merge:select');
+
+  const {baseRecord, sourceRecord} = getRecordsFromParameters(base, source, baseValidators, sourceValidators);
+
+  function getRecordsFromParameters(base, source, baseValidators, sourceValidators) {
+    // records if we got an object ({base, source}) as a parameter
+    if (source === undefined && base.base !== undefined && base.source !== undefined) {
+      const baseRecord = new MarcRecord(base.base, baseValidators);
+      const sourceRecord = new MarcRecord(base.source, sourceValidators);
+      return {baseRecord, sourceRecord};
+    }
+    // records if we got an non-object (base, source) as a parameter
+    const baseRecord = new MarcRecord(base, baseValidators);
+    const sourceRecord = new MarcRecord(source, sourceValidators);
+    return {baseRecord, sourceRecord};
+  }
 
-export default ({pattern, equalityFunction = strictEquality}) => (base, source) => {
-  const baseFields = base.get(pattern);
-  const sourceFields = source.get(pattern);
+  const baseFields = baseRecord.get(tagPattern);
+  const sourceFields = sourceRecord.get(tagPattern);
+  const fieldTag = sourceFields.map(field => field.tag);
+  debug(`Comparing field ${fieldTag}`);
 
   checkFieldType(baseFields);
   checkFieldType(sourceFields);
 
   if (baseFields.length > 1 || sourceFields.length > 1) {
-    return base;
+    debug(`Multiple fields in base or source`);
+    debug(`No changes to base`);
+    return baseRecord.toObject();
   }
   const [baseField] = baseFields;
   const [sourceField] = sourceFields;
 
   if (baseField.tag === sourceField.tag === false) {
-    return base;
+    debug(`Base tag ${baseField.tag} is not equal to source tag ${sourceField.tag}`);
+    debug(`No changes to base`);
+    return baseRecord.toObject();
   }
   const baseSubs = baseField.subfields;
   const sourceSubs = sourceField.subfields;
@@ -62,19 +67,26 @@ export default ({pattern, equalityFunction = strictEquality}) => (base, source)
   const sourceSubsNormalized = sourceSubs
     .map(({code, value}) => ({code, value: normalizeSubfieldValue(value)}));
 
+  // Returns the base subfields for which a matching source subfield is found
   const equalSubfieldsBase = baseSubsNormalized
     .filter(baseSubfield => sourceSubsNormalized
       .some(sourceSubfield => equalityFunction(baseSubfield, sourceSubfield)));
+  debug(`equalSubfieldsBase: ${JSON.stringify(equalSubfieldsBase, undefined, 2)}`);
 
+  // Returns the source subfields for which a matching base subfield is found
   const equalSubfieldsSource = sourceSubsNormalized
     .filter(sourceSubfield => baseSubsNormalized
       .some(baseSubfield => equalityFunction(sourceSubfield, baseSubfield)));
+  debug(`equalSubfieldsSource: ${JSON.stringify(equalSubfieldsSource, undefined, 2)}`);
 
   if (baseSubs.length === sourceSubs.length && equalSubfieldsBase.length < baseSubs.length) {
-    return base;
+    debug(`Base and source subfields are not equal`);
+    debug(`No changes to base`);
+    return baseRecord.toObject();
   }
 
   if (baseSubs.length === sourceSubs.length && equalSubfieldsBase.length === equalSubfieldsSource.length) {
+    debug(`Checking subfield equality`);
     const totalSubfieldLengthBase = baseSubsNormalized
       .map(({value}) => value.length)
       .reduce((acc, value) => acc + value);
@@ -83,19 +95,21 @@ export default ({pattern, equalityFunction = strictEquality}) => (base, source)
       .reduce((acc, value) => acc + value);
 
     if (totalSubfieldLengthSource > totalSubfieldLengthBase) {
-      return replaceBasefieldWithSourcefield(base);
+      return replaceBasefieldWithSourcefield(baseRecord.toObject());
     }
   }
 
   if (sourceSubs.length > baseSubs.length && equalSubfieldsBase.length === baseSubs.length) {
-    return replaceBasefieldWithSourcefield(base);
+    return replaceBasefieldWithSourcefield(baseRecord.toObject());
   }
 
-  return base;
+  debug(`No changes to base`);
+  return baseRecord.toObject();
 
   function replaceBasefieldWithSourcefield(base) {
     const index = base.fields.findIndex(field => field === baseField);
     base.fields.splice(index, 1, sourceField); // eslint-disable-line functional/immutable-data
+    debug(`Source field is longer, replacing base with source`);
     return base;
   }
 
@@ -111,7 +125,7 @@ export default ({pattern, equalityFunction = strictEquality}) => (base, source)
 
   function normalizeSubfieldValue(value) {
     // Regexp options: g: global search, u: unicode
-    const punctuation = /[.,\-/#!$%^&*;:{}=_`~()[\]]/gu;
+    const punctuation = /[.,\-/#!?$%^&*;:{}=_`~()[\]]/gu;
     return normalizeSync(value).toLowerCase().replace(punctuation, '', 'u').replace(/\s+/gu, ' ').trim();
   }
 };

package/src/reducers/select.spec.js

@@ -1,64 +1,49 @@
-/**
-*
-* @licstart  The following is the entire license notice for the JavaScript code in this file.
-*
-* Merge MARC records
-*
-* Copyright (C) 2015-2019 University Of Helsinki (The National Library Of Finland)
-*
-* This file is part of marc-record-merge-js
-
-* marc-record-merge-js program is free software: you can redistribute it and/or modify
-* it under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation, either version 3 of the
-* License, or (at your option) any later version.
-*
-* marc-record-merge-js is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-* GNU Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public License
-* along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*
-* @licend  The above is the entire license notice
-* for the JavaScript code in this file.
-*
-*/
-import chai from 'chai';
-import fs from 'fs';
-import path from 'path';
+import {expect} from 'chai';
 import {MarcRecord} from '@natlibfi/marc-record';
 import createReducer, {subsetEquality} from './select';
-import fixturesFactory, {READERS} from '@natlibfi/fixura';
+import {READERS} from '@natlibfi/fixura';
+import generateTests from '@natlibfi/fixugen';
 
 MarcRecord.setValidationOptions({subfieldValues: false});
 
-describe('reducers/select', () => {
-  const {expect} = chai;
-  const fixturesPath = path.join(__dirname, '..', '..', 'test-fixtures', 'reducers', 'select');
+generateTests({
+  callback,
+  path: [__dirname, '..', '..', 'test-fixtures', 'reducers', 'select'],
+  useMetadataFile: true,
+  recurse: false,
+  fixura: {
+    reader: READERS.JSON,
+    failWhenNotFound: false
+  }
+});
 
-  fs.readdirSync(fixturesPath).forEach(subDir => {
-    const {getFixture} = fixturesFactory({root: [fixturesPath, subDir], reader: READERS.JSON, failWhenNotFound: false});
-    it(subDir, () => {
-      const baseTest = new MarcRecord(getFixture('base.json'));
-      const sourceTest = new MarcRecord(getFixture('source.json'));
-      const patternTest = new RegExp(getFixture({components: ['pattern.txt'], reader: READERS.TEXT}), 'u');
-      const expectedRecord = getFixture('merged.json');
-      const expectedError = getFixture({components: ['expected-error.txt'], reader: READERS.TEXT});
-      const equalityFunction = getEqualityFunction();
+function callback({
+  getFixture,
+  disabled = false,
+  tagPatternRegExp = false,
+  expectedError = false,
+  useSubsetEquality = false
+}) {
+  if (disabled) {
+    console.log('TEST DISABLED!'); // eslint-disable-line no-console
+    return;
+  }
+  //  const base = new MarcRecord(getFixture('base.json'), {subfieldValues: false});
+  //  const source = new MarcRecord(getFixture('source.json'), {subfieldValues: false});
 
-      if (expectedError) {
-        expect(() => createReducer.to.throw(Error, 'control field'));
-        return;
-      }
-      const mergedRecord = createReducer({pattern: patternTest, equalityFunction})(baseTest, sourceTest);
-      expect(mergedRecord.toObject()).to.eql(expectedRecord);
+  const base = getFixture('base.json');
+  const source = getFixture('source.json');
 
-      function getEqualityFunction() {
-        const functionName = getFixture({components: ['equalityFunction.txt'], reader: READERS.TEXT});
-        return functionName === 'subsetEquality' ? subsetEquality : undefined;
-      }
-    });
-  });
-});
+  const tagPattern = new RegExp(tagPatternRegExp, 'u');
+  const expectedRecord = getFixture('merged.json');
+  const equalityFunction = useSubsetEquality ? subsetEquality : undefined;
+
+  // Bypass expected error in testing
+  if (expectedError) {
+    expect(() => createReducer.to.throw(Error, 'control field'));
+    return;
+  }
+
+  const mergedRecord = createReducer({tagPattern, equalityFunction})(base, source);
+  expect(mergedRecord).to.eql(expectedRecord);
+}

package/src/reducers/select2.spec.js

@@ -0,0 +1,49 @@
+import {expect} from 'chai';
+import {MarcRecord} from '@natlibfi/marc-record';
+import createReducer, {subsetEquality} from './select';
+import {READERS} from '@natlibfi/fixura';
+import generateTests from '@natlibfi/fixugen';
+
+MarcRecord.setValidationOptions({subfieldValues: false});
+
+generateTests({
+  callback,
+  path: [__dirname, '..', '..', 'test-fixtures', 'reducers', 'select'],
+  useMetadataFile: true,
+  recurse: false,
+  fixura: {
+    reader: READERS.JSON,
+    failWhenNotFound: false
+  }
+});
+
+function callback({
+  getFixture,
+  disabled = false,
+  tagPatternRegExp = false,
+  expectedError = false,
+  useSubsetEquality = false
+}) {
+  if (disabled) {
+    console.log('TEST DISABLED!'); // eslint-disable-line no-console
+    return;
+  }
+  //  const base = new MarcRecord(getFixture('base.json'), {subfieldValues: false});
+  //  const source = new MarcRecord(getFixture('source.json'), {subfieldValues: false});
+
+  const base = getFixture('base.json');
+  const source = getFixture('source.json');
+
+  const tagPattern = new RegExp(tagPatternRegExp, 'u');
+  const expectedRecord = getFixture('merged.json');
+  const equalityFunction = useSubsetEquality ? subsetEquality : undefined;
+
+  // Bypass expected error in testing
+  if (expectedError) {
+    expect(() => createReducer.to.throw(Error, 'control field'));
+    return;
+  }
+
+  const mergedRecord = createReducer({tagPattern, equalityFunction})({base, source});
+  expect(mergedRecord).to.eql(expectedRecord);
+}

package/test-fixtures/index/01/base.json

@@ -0,0 +1,24 @@
+{
+  "leader": "01331cam a22003494i 4500",
+  "fields": [
+    {
+      "tag": "001",
+      "value": "001_base"
+    },
+    {
+      "tag": "010",
+      "ind1": " ",
+      "ind2": " ",
+      "subfields": [
+        {
+          "code": "a",
+          "value": "010a_base"
+        },
+        {
+          "code": "b",
+          "value": "010b_base"
+        }
+      ]
+    }
+  ]
+}

package/test-fixtures/index/01/merged.json

@@ -0,0 +1,24 @@
+{
+  "leader": "01331cam a22003494i 4500",
+  "fields": [
+    {
+      "tag": "001",
+      "value": "001_base"
+    },
+    {
+      "tag": "010",
+      "ind1": " ",
+      "ind2": " ",
+      "subfields": [
+        {
+          "code": "a",
+          "value": "010a_base"
+        },
+        {
+          "code": "b",
+          "value": "010b_base"
+        }
+      ]
+    }
+  ]
+}

package/test-fixtures/index/01/metadata.json

@@ -0,0 +1,8 @@
+{
+  "description":"Reducers should run after each another - two reducers",
+  "reducerConfigs": [
+    {"tagPattern": "/010/u", "compareTagsOnly": true},
+    {"tagPattern": "/33./u"}
+
+  ]
+}

package/test-fixtures/index/01/source.json

@@ -0,0 +1,40 @@
+{
+  "leader": "01331cam a22003494i 4500",
+  "fields": [
+    {
+      "tag": "001",
+      "value": "001_sorsa"
+    },
+    {
+      "tag": "010",
+      "ind1": " ",
+      "ind2": " ",
+      "subfields": [
+        {
+          "code": "a",
+          "value": "010a_sorsa"
+        },
+        {
+          "code": "b",
+          "value": "010b_sorsa"
+        }
+      ]
+    },
+    {
+      "tag": "650",
+      "ind1": " ",
+      "ind2": "7",
+      "subfields": [
+        {
+          "code": "a",
+          "value": "poista mut"
+        },
+        {
+          "code": "2",
+          "value": "ysa"
+        }
+      ]
+    }
+
+  ]
+}

package/test-fixtures/index/02/base.json

@@ -0,0 +1,24 @@
+{
+  "leader": "01331cam a22003494i 4500",
+  "fields": [
+    {
+      "tag": "001",
+      "value": "001_base"
+    },
+    {
+      "tag": "010",
+      "ind1": " ",
+      "ind2": " ",
+      "subfields": [
+        {
+          "code": "a",
+          "value": "010a_base"
+        },
+        {
+          "code": "b",
+          "value": "010b_base"
+        }
+      ]
+    }
+  ]
+}

package/test-fixtures/index/02/merged.json

@@ -0,0 +1,24 @@
+{
+  "leader": "01331cam a22003494i 4500",
+  "fields": [
+    {
+      "tag": "001",
+      "value": "001_base"
+    },
+    {
+      "tag": "010",
+      "ind1": " ",
+      "ind2": " ",
+      "subfields": [
+        {
+          "code": "a",
+          "value": "010a_base"
+        },
+        {
+          "code": "b",
+          "value": "010b_base"
+        }
+      ]
+    }
+  ]
+}

package/test-fixtures/index/02/metadata.json

@@ -0,0 +1,7 @@
+{
+  "description":"Reducers should run after each another - single reducer",
+  "reducerConfigs": [
+    {"tagPattern": "/33./u"}
+  ],
+  "skip": false
+}