@natlibfi/marc-record-merge 6.0.0-beta.2 → 6.0.0-beta.6

package/src/reducers/copy.spec.js

@@ -1,72 +1,50 @@
-/**
-*
-* @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 {READERS} from '@natlibfi/fixura';
 import {MarcRecord} from '@natlibfi/marc-record';
 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, failWhenNotFound: false});
-    it(subDir, () => {
-      const base = new MarcRecord(getFixture('base.json'));
-      const source = new MarcRecord(getFixture('source.json'));
-      const tagPattern = new RegExp(getFixture({components: ['tagPattern.txt'], reader: READERS.TEXT}), 'u');
-      const compareTagsOnly = getCompareTagsOnly();
-      const excludeSubfields = getExcludeSubfields();
-      const dropSubfields = getDropSubfields();
-      const expectedRecord = getFixture('merged.json');
-      const mergedRecord = createReducer({tagPattern, compareTagsOnly, excludeSubfields, dropSubfields})(base, source);
-      expect(mergedRecord.toObject()).to.eql(expectedRecord);
+generateTests({
+  callback,
+  path: [__dirname, '..', '..', 'test-fixtures', 'reducers', 'copy'],
+  useMetadataFile: true,
+  recurse: true,
+  fixura: {
+    reader: READERS.JSON,
+    failWhenNotFound: false
+  }
+});
 
-      // Non-repeatable MARC fields are copied from source only if they are missing from base
-      function getCompareTagsOnly() {
-        const functionName = getFixture({components: ['compareTagsOnly.txt'], reader: READERS.TEXT});
-        return functionName === 'true' ? 'true' : undefined;
-      }
-      // Check whether excludeSubfields.json exists and if it does, return its contents. If not, do nothing.
-      function getExcludeSubfields() {
-        const subfieldsToExclude = getFixture({components: ['excludeSubfields.json'], reader: READERS.JSON});
-        return subfieldsToExclude ? subfieldsToExclude : undefined;
-      }
+function callback({
+  getFixture,
+  tagPatternRegExp,
+  compareTagsOnly = false,
+  compareWithoutIndicators = false,
+  subfieldsMustBeIdentical = false,
+  copyUnless = undefined,
+  excludeSubfields = undefined,
+  dropSubfields = undefined,
+  swapSubfieldCode = [],
+  swapTag = [],
+  doNotCopyIfFieldPresent = false
+}) {
+  const base = new MarcRecord(getFixture('base.json'), {subfieldValues: false});
+  const source = new MarcRecord(getFixture('source.json'), {subfieldValues: false});
+  const tagPattern = new RegExp(tagPatternRegExp, 'u');
+  const expectedRecord = getFixture('merged.json');
 
-      // Check whether dropSubfields.json exists and if it does, return its contents. If not, do nothing.
-      function getDropSubfields() {
-        const subfieldsToDrop = getFixture({components: ['dropSubfields.json'], reader: READERS.JSON});
-        return subfieldsToDrop ? subfieldsToDrop : undefined;
-      }
-    });
-  });
-});
+  const mergedRecord = createReducer({
+    tagPattern, compareTagsOnly, compareWithoutIndicators,
+    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(mergedRecord).to.eql(expectedRecord);
+}

package/src/reducers/index.js

@@ -1,30 +1,3 @@
-/**
-*
-* @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 copy from './copy';
 import select, {strictEquality, subsetEquality} from './select';
 

package/src/reducers/select.js

@@ -1,66 +1,23 @@
-/**
-*
-* @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.
-*
-*/
-/**
- * Test 01: The field is a control field (contains 'value') --> error message
- * Test 02: If there are multiple fields, return base
- * Test 03: Base and source tags are equal for one field --> return base
- * Test 04: Base and source tags are not equal --> return base
- *  Note: to test for this, tagPattern has to allow two tags,
- *  otherwise the unequal tag does not even pass source.get(tagPattern)
- * Test 05: Normalize subfield values (base and source are equal) --> return base
- * Test 06: Two subfields, both equal --> return base
- * Test 07: Two subfields, same codes, values of source are subsets of values of base --> replaceBasefieldWithSourcefield
- * Test 08: Two subfields, one is a subset, one has a different code --> return base
- * Test 09: Two subfields, same codes, values are not subsets --> return base
- * Test 10: sourceField is a proper superset of baseField (subfields a and b are equal, c is new) --> replaceBasefieldWithSourcefield
- * Test 11: sourceField is not a proper superset of baseField (different values in a and b, also new subfield c) --> return base
- * Test 12: sourceField is a proper superset of baseField (base values a and b are subsets of source values a and b, c is new in source) --> replaceBasefieldWithSourcefield
- * Test 13: Opposite of test 12, baseField is a proper superset of sourceField --> return base
- * Test 14: Normalization test with Cyrillic characters
- */
-
 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}) => (base, source) => {
-  const debug = createDebugLogger('@natlibfi/marc-record-merge');
-  const baseFields = base.get(tagPattern);
-  const sourceFields = source.get(tagPattern);
+  const debug = createDebugLogger('@natlibfi/marc-record-merge:select');
+  const baseRecord = new MarcRecord(base, {subfieldValues: false});
+  const sourceRecord = new MarcRecord(source, {subfieldValues: false});
+  const baseFields = baseRecord.get(tagPattern);
+  const sourceFields = sourceRecord.get(tagPattern);
   const fieldTag = sourceFields.map(field => field.tag);
   debug(`Comparing field ${fieldTag}`);
 

package/src/reducers/select.spec.js

@@ -1,66 +1,45 @@
-/**
-*
-* @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 base = new MarcRecord(getFixture('base.json'));
-      const source = new MarcRecord(getFixture('source.json'));
-      const tagPattern = 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});
+  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.toObject()).to.eql(expectedRecord);
+  // Bypass expected error in testing
+  if (expectedError) {
+    expect(() => createReducer.to.throw(Error, 'control field'));
+    return;
+  }
 
-      // Choose which equality function to use
-      function getEqualityFunction() {
-        const functionName = getFixture({components: ['equalityFunction.txt'], reader: READERS.TEXT});
-        return functionName === 'subsetEquality' ? subsetEquality : undefined;
-      }
-    });
-  });
-});
+  const mergedRecord = createReducer({tagPattern, equalityFunction})(base, source);
+  expect(mergedRecord.toObject()).to.eql(expectedRecord);
+}

package/test-fixtures/reducers/copy/{01/base.json → 01 - copy/01/base.json }

@@ -4,6 +4,6 @@
         {
             "tag": "001",
             "value": "007346734"
-        }       
+        }
     ]
 }

package/test-fixtures/reducers/copy/01 - copy/01/metadata.json

@@ -0,0 +1,4 @@
+{
+    "description": "If base does not contain the field at all, it is copied from source to base",
+    "tagPatternRegExp": "^010$"
+}

package/test-fixtures/reducers/copy/01 - copy/02/metadata.json

@@ -0,0 +1,4 @@
+{
+    "description": "Identical control fields are not copied",
+    "tagPatternRegExp": "^001$"
+}

package/test-fixtures/reducers/copy/{02/base.json → 01 - copy/02/source.json }

@@ -15,6 +15,6 @@
                     "value": "##2002021346"
                 }
             ]
-        }       
+        }
     ]
 }

package/test-fixtures/reducers/copy/{03/base.json → 01 - copy/03/base.json }

@@ -15,6 +15,6 @@
                     "value": "##2002021346"
                 }
             ]
-        }       
+        }
     ]
 }

package/test-fixtures/reducers/copy/01 - copy/03/metadata.json

@@ -0,0 +1,4 @@
+{
+    "description": "Add missing control field to base",
+    "tagPatternRegExp": "^001$"
+}

package/test-fixtures/reducers/copy/{05/base.json → 01 - copy/04/base.json }

@@ -34,6 +34,6 @@
                     "value": "##2002021357"
                 }
             ]
-        }       
+        }
     ]
 }

package/test-fixtures/reducers/copy/{04/merged.json → 01 - copy/04/merged.json }

@@ -34,6 +34,6 @@
                     "value": "##2002021357"
                 }
             ]
-        }       
+        }
     ]
 }

package/test-fixtures/reducers/copy/01 - copy/04/metadata.json

@@ -0,0 +1,4 @@
+{
+    "description": "Identical data fields in base and source, not copied",
+    "tagPatternRegExp": "^010$"
+}

package/test-fixtures/reducers/copy/{04/source.json → 01 - copy/04/source.json }

@@ -34,6 +34,6 @@
                     "value": "##2002021357"
                 }
             ]
-        }       
+        }
     ]
 }

package/test-fixtures/reducers/copy/{04/base.json → 01 - copy/05/base.json }

@@ -34,6 +34,6 @@
                     "value": "##2002021357"
                 }
             ]
-        }       
+        }
     ]
 }

package/test-fixtures/reducers/copy/01 - copy/05/metadata.json

@@ -0,0 +1,4 @@
+{
+    "description": "Different data fields are copied from source to base (multiple fields)",
+    "tagPatternRegExp": "^010$"
+}

package/test-fixtures/reducers/copy/01 - copy/06/base.json

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

package/test-fixtures/reducers/copy/01 - copy/06/merged.json

@@ -0,0 +1,39 @@
+{
+    "leader": "01331cam a22003494i 4500",
+    "fields": [
+        {
+            "tag": "001",
+            "value": "007346734"
+        },
+        {
+            "tag": "010",
+            "ind1": " ",
+            "ind2": " ",
+            "subfields": [
+                {
+                    "code": "a",
+                    "value": "##2002021346"
+                },
+                {
+                    "code": "b",
+                    "value": "##2002021356"
+                }
+            ]
+        },
+        {
+            "tag": "010",
+            "ind1": " ",
+            "ind2": "1",
+            "subfields": [
+                {
+                    "code": "a",
+                    "value": "##2002021346"
+                },
+                {
+                    "code": "b",
+                    "value": "##2002021356"
+                }
+            ]
+        }
+    ]
+}

package/test-fixtures/reducers/copy/01 - copy/06/metadata.json

@@ -0,0 +1,4 @@
+{
+    "description": "Different data fields are copied from source to base (Ind2 diff)",
+    "tagPatternRegExp": "^010$"
+}

package/test-fixtures/reducers/copy/01 - copy/06/source.json

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

package/test-fixtures/reducers/copy/01 - copy/07/base.json

@@ -0,0 +1,39 @@
+{
+    "leader": "01331cam a22003494i 4500",
+    "fields": [
+        {
+            "tag": "001",
+            "value": "007346734"
+        },
+        {
+            "tag": "010",
+            "ind1": " ",
+            "ind2": " ",
+            "subfields": [
+                {
+                    "code": "a",
+                    "value": "##2002021346"
+                },
+                {
+                    "code": "b",
+                    "value": "##2002021356"
+                }
+            ]
+        },
+        {
+            "tag": "010",
+            "ind1": " ",
+            "ind2": "1",
+            "subfields": [
+                {
+                    "code": "a",
+                    "value": "##2002021346"
+                },
+                {
+                    "code": "b",
+                    "value": "##2002021356"
+                }
+            ]
+        }
+    ]
+}

package/test-fixtures/reducers/copy/01 - copy/07/merged.json

@@ -0,0 +1,39 @@
+{
+    "leader": "01331cam a22003494i 4500",
+    "fields": [
+        {
+            "tag": "001",
+            "value": "007346734"
+        },
+        {
+            "tag": "010",
+            "ind1": " ",
+            "ind2": " ",
+            "subfields": [
+                {
+                    "code": "a",
+                    "value": "##2002021346"
+                },
+                {
+                    "code": "b",
+                    "value": "##2002021356"
+                }
+            ]
+        },
+        {
+            "tag": "010",
+            "ind1": " ",
+            "ind2": "1",
+            "subfields": [
+                {
+                    "code": "a",
+                    "value": "##2002021346"
+                },
+                {
+                    "code": "b",
+                    "value": "##2002021356"
+                }
+            ]
+        }
+    ]
+}

package/test-fixtures/reducers/copy/01 - copy/07/metadata.json

@@ -0,0 +1,5 @@
+{
+    "description": "Different data fields are copied from source to base (Ind2 diff, multiple fields in base)",
+    "tagPatternRegExp": "^010$",
+    "only": false
+}

package/test-fixtures/reducers/copy/01 - copy/07/source.json

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