@natlibfi/marc-record-merge 6.0.0-beta.4 → 6.0.0-beta.7

package/package.json

@@ -14,7 +14,7 @@
 		"url": "git@github.com:natlibfi/marc-record-merge-js.git"
 	},
 	"license": "MIT",
-	"version": "6.0.0-beta.4",
+	"version": "6.0.0-beta.7",
 	"main": "./dist/index.js",
 	"engines": {
 		"node": ">=14"
@@ -30,17 +30,18 @@
 		"test:dev": "npm run lint:dev && npm run coverage",
 		"coverage": "npm run coverage:unit && npm run coverage:report",
 		"coverage:unit": "nyc --silent npm run test:base",
-		"coverage:report": "nyc report --reporter=text",
+		"coverage:report": "nyc report",
 		"build:transpile": "babel src --copy-files --source-maps --delete-dir-on-start --out-dir=dist",
 		"build": "npm run build:transpile",
-		"dev:test": "cross-env DEBUG=@natlibfi/* NODE_ENV=test nodemon -w src -w test-fixtures --exec 'clear && npm run test:dev'"
+		"dev:test": "cross-env NODE_ENV=test nodemon -w src -w test-fixtures --exec 'clear && npm run test:dev'",
+		"dev:test:debug": "cross-env DEBUG=@natlibfi/* NODE_ENV=test nodemon -w src -w test-fixtures --exec 'clear && npm run test:dev'"
 	},
 	"dependencies": {
-		"@natlibfi/fixugen": "^1.0.2",
+		"@natlibfi/fixugen": "1.1.0",
 		"@natlibfi/fixura": "^2.2.1",
-		"@natlibfi/marc-record": "^7.1.0-alpha.1",
+		"@natlibfi/marc-record": "^7.1.0-alpha.2",
 		"debug": "^4.3.4",
-		"normalize-diacritics": "^2.13.2"
+		"normalize-diacritics": "2.14.0"
 	},
 	"devDependencies": {
 		"@babel/cli": "^7.17.10",
@@ -68,9 +69,7 @@
 			[
 				"@babel/preset-env",
 				{
-					"targets": {
-						"node": "14"
-					}
+					"targets": "maintained node versions"
 				}
 			]
 		],
@@ -89,8 +88,7 @@
 			"*/**/*.spec.js"
 		],
 		"reporter": [
-			"lcov",
-			"html"
+			"text"
 		],
 		"require": [
 			"@babel/register"

package/src/reducers/copy.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-statements */
 /* eslint-disable no-unused-vars */
 
 import {MarcRecord} from '@natlibfi/marc-record';
@@ -12,7 +13,10 @@ export default ({
   dropSubfields = [],
   copyUnless = [],
   baseValidators = {subfieldValues: false},
-  sourceValidators = {subfieldValues: false}
+  sourceValidators = {subfieldValues: false},
+  swapTag = [],
+  swapSubfieldCode = [],
+  doNotCopyIfFieldPresent = false
 }) => (base, source) => {
   const baseRecord = new MarcRecord(base, baseValidators);
   const sourceRecord = new MarcRecord(source, sourceValidators);
@@ -30,74 +34,89 @@ export default ({
 
   const baseFields = baseRecord.get(tagPattern);
   const sourceFields = sourceRecord.get(tagPattern);
+  const doNotCopy = doNotCopyIfFieldPresent ? baseRecord.get(doNotCopyIfFieldPresent).length > 0 : false;
+
+  if (doNotCopy) {
+    return baseRecord.toObject();
+  }
 
   debug(`Base fields: `, baseFields);
   debug(`Source fields: `, sourceFields);
 
-  const compareResultFields = compareFields(sourceFields, baseFields);
+  const baseCompareFields = baseFields.map(baseField => createCompareField(baseField));
+  const compareResultFields = compareFields(sourceFields, baseCompareFields);
   const droppedUnwantedSubfield = checkDropSubfields(compareResultFields);
   const droppedUnwantedFields = checkCopyUnlessFields(droppedUnwantedSubfield);
+  const swappedSubfields = checkSwapSubfieldCodes(droppedUnwantedFields);
+  const swappedTags = checkSwapTag(swappedSubfields);
   debug('Fields to be copied');
-  debug(JSON.stringify(droppedUnwantedFields));
+  debug(JSON.stringify(swappedTags));
 
   // Add fields to base;
-  droppedUnwantedFields.forEach(field => baseRecord.insertField(field));
+  swappedTags.forEach(field => baseRecord.insertField(field));
   return baseRecord.toObject();
   //return copyFields(baseFields, sourceFields);
 
-  function compareFields(sourceFields, baseFields, uniqFields = []) {
+  function compareFields(sourceFields, baseCompareFields, uniqFields = []) {
     const [sourceField, ...rest] = sourceFields;
     if (sourceField === undefined) {
       return uniqFields;
     }
 
-    if (baseFields.length === 0) {
-      return compareFields(rest, baseFields, [...uniqFields, sourceField]);
+    if (baseCompareFields.length === 0) {
+      return compareFields(rest, baseCompareFields, [...uniqFields, sourceField]);
     }
 
     // Source and base are also compared for identicalness
     // Non-identical fields are copied from source to base as duplicates
-    const sourceComapareField = createCompareField(sourceField);
-    const baseCompareFields = baseFields.map(baseField => createCompareField(baseField));
-
-    const unique = checkCompareFields(baseCompareFields, sourceComapareField);
+    const sourceCompareField = createCompareField(sourceField);
+    const unique = checkCompareFields(baseCompareFields, sourceCompareField);
 
     debugCompare(`${JSON.stringify(sourceField)} ${unique ? 'is UNIQUE' : 'not UNIQUE'}`);
 
     if (unique) {
-      return compareFields(rest, baseFields, [...uniqFields, sourceField]);
+      return compareFields(rest, baseCompareFields, [...uniqFields, sourceField]);
     }
 
-    return compareFields(rest, baseFields, uniqFields);
+    return compareFields(rest, baseCompareFields, uniqFields);
 
-    function checkCompareFields(baseCompareFields, sourceComapareField) {
-      const [baseCompareField, ...rest] = baseCompareFields;
-      if (baseCompareField === undefined) {
-        return true;
-      }
+    function checkCompareFields(baseCompareFields, sourceCompareField) {
+      let unique = true; // eslint-disable-line functional/no-let
 
-      if (sourceComapareField.value !== baseCompareField.value) {
-        debugCompare(`Value is different ${sourceComapareField.value} !== ${baseCompareField.value}`);
-        return true;
-      }
+      baseCompareFields.forEach(baseCompareField => {
+        debugCompare(`Comparing ${JSON.stringify(sourceCompareField)} to ${JSON.stringify(baseCompareField)}}`);
 
-      if (sourceComapareField.ind1 !== baseCompareField.ind1) {
-        debugCompare(`Ind1 is different ${sourceComapareField.ind1} !== ${baseCompareField.ind1}`);
-        return true;
-      }
+        if (sourceCompareField.value !== baseCompareField.value) {
+          debugCompare(`Value is different ${sourceCompareField.value} !== ${baseCompareField.value}`);
+          return;
+        }
 
-      if (sourceComapareField.ind2 !== baseCompareField.ind2) {
-        debugCompare(`Ind2 is different ${sourceComapareField.ind2} !== ${baseCompareField.ind2}`);
-        return true;
-      }
+        if (sourceCompareField.ind1 !== baseCompareField.ind1) {
+          debugCompare(`Ind1 is different ${sourceCompareField.ind1} !== ${baseCompareField.ind1}`);
+          return;
+        }
 
-      if ('subfields' in sourceComapareField) {
-        const allFound = checkSubfields(sourceComapareField.subfields, baseCompareField.subfields);
-        debugCompare(`Subfields are different ${!allFound}`);
-        return allFound ? false : checkCompareFields(rest, sourceComapareField);
-      }
+        if (sourceCompareField.ind2 !== baseCompareField.ind2) {
+          debugCompare(`Ind2 is different ${sourceCompareField.ind2} !== ${baseCompareField.ind2}`);
+          return;
+        }
 
-      return false;
+        if ('subfields' in sourceCompareField) {
+          const allFound = checkSubfields(sourceCompareField.subfields, baseCompareField.subfields);
+          debugCompare(`Subfields are different ${!allFound}`);
+          if (!allFound) {
+            return;
+          }
+
+          unique = false;
+          return;
+        }
+
+        unique = false;
+        return;
+      });
+
+      return unique;
     }
 
     function checkSubfields(sourceSubfields, baseSubfields) {
@@ -143,6 +162,44 @@ export default ({
     }
   }
 
+  function checkSwapTag(fields) {
+    if (swapTag.length > 0) {
+      return fields.map(field => ({...field, tag: swapTagsFunc(field.tag)}));
+    }
+
+    return fields;
+
+    function swapTagsFunc(tag) {
+      const [foundRule] = swapTag.filter(rule => new RegExp(rule.from, 'u').test(tag));
+
+      if (foundRule === undefined) {
+        return tag;
+      }
+
+      return foundRule.to;
+    }
+  }
+
+  function checkSwapSubfieldCodes(fields) {
+    if (swapSubfieldCode.length > 0) {
+      return fields.map(field => ({...field, subfields: swapSubfieldCodesFunc(field.subfields)}));
+    }
+
+    return fields;
+
+    function swapSubfieldCodesFunc(subfields) {
+      return subfields.map(sub => {
+        const [foundRule] = swapSubfieldCode.filter(rule => rule.from === sub.code);
+
+        if (foundRule === undefined) {
+          return sub;
+        }
+
+        return {code: foundRule.to, value: sub.value};
+      });
+    }
+  }
+
   function checkDropSubfields(fields) {
     if (dropSubfields.length > 0) {
       return fields.map(field => ({...field, subfields: dropSubfieldsFunc(field.subfields)}))

package/src/reducers/copy.spec.js

@@ -1,11 +1,11 @@
 import {expect} from 'chai';
 import {READERS} from '@natlibfi/fixura';
-import {MarcRecord} from '@natlibfi/marc-record';
+//import {MarcRecord} from '@natlibfi/marc-record';
 import createReducer from './copy';
 import generateTests from '@natlibfi/fixugen';
 
-// import createDebugLogger from 'debug'; // <---
-// const debug = createDebugLogger('@natlibfi/marc-record-merge/copy.spec.js'); // <---
+//import createDebugLogger from 'debug'; // <---
+//const debug = createDebugLogger('@natlibfi/marc-record-merge/copy.spec.js'); // <---
 
 generateTests({
   callback,
@@ -27,22 +27,30 @@ function callback({
   copyUnless = undefined,
   excludeSubfields = undefined,
   dropSubfields = undefined,
-  disabled = false
+  swapSubfieldCode = [],
+  swapTag = [],
+  doNotCopyIfFieldPresent = 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 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 mergedRecord = createReducer({tagPattern, compareTagsOnly, compareWithoutIndicators, copyUnless, subfieldsMustBeIdentical, excludeSubfields, dropSubfields})(base, source);
+  const merged = createReducer({
+    tagPattern, compareTagsOnly, compareWithoutIndicators,
+    copyUnless, subfieldsMustBeIdentical, excludeSubfields,
+    dropSubfields, swapSubfieldCode, swapTag,
+    doNotCopyIfFieldPresent
+  })(base, source);
   //debug(`***     mergedRecord: `, mergedRecord); //<--
-  //debug(`***     mergedRecord,Strfy: `, JSON.stringify(mergedRecord.toObject())); //<--
+  //debug(`***     mergedRecord,Strfy: `, JSON.stringify(mergedRecord)); //<--
   //debug(`***     expectedRecord: `, expectedRecord); //<--
   //debug(`***     expectedRecord,Strfy: `, JSON.stringify(expectedRecord)); //<--
-  expect(mergedRecord).to.eql(expectedRecord);
+  expect(merged.constructor.name).not.to.eql('MarcRecord');
+  expect(merged.constructor.name).to.eql('Object');
+  expect(merged).to.eql(expectedRecord);
 }

package/src/reducers/select.js

@@ -1,20 +1,23 @@
 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:select');
-  const baseFields = base.get(tagPattern);
-  const sourceFields = source.get(tagPattern);
+  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

@@ -28,8 +28,12 @@ function callback({
     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 = 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;
@@ -41,5 +45,5 @@ function callback({
   }
 
   const mergedRecord = createReducer({tagPattern, equalityFunction})(base, source);
-  expect(mergedRecord.toObject()).to.eql(expectedRecord);
+  expect(mergedRecord).to.eql(expectedRecord);
 }

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

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

package/test-fixtures/reducers/copy/{basic copy → 01 - copy}/02/metadata.json

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

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

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

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

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

package/test-fixtures/reducers/copy/{basic copy → 01 - copy}/05/metadata.json

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

package/test-fixtures/reducers/copy/{basic copy → 01 - copy}/06/metadata.json

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

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"
+                }
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,28 @@
+{
+    "leader": "01331cam a22003494i 4500",
+    "fields": [
+        {
+            "tag": "001",
+            "value": "007346734"
+        },
+        {
+            "tag": "007",
+            "value": "ou"
+        },
+        {
+            "tag": "007",
+            "value": "vf^cbaho|"
+        },
+        {
+            "tag": "010",
+            "ind1": " ",
+            "ind2": " ",
+            "subfields": [
+                {
+                    "code": "a",
+                    "value": "##2002021346"
+                }
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,28 @@
+{
+    "leader": "01331cam a22003494i 4500",
+    "fields": [
+        {
+            "tag": "001",
+            "value": "007346734"
+        },
+        {
+            "tag": "007",
+            "value": "ou"
+        },
+        {
+            "tag": "007",
+            "value": "vf^cbaho|"
+        },
+        {
+            "tag": "010",
+            "ind1": " ",
+            "ind2": " ",
+            "subfields": [
+                {
+                "code": "a",
+                "value": "##2002021346"
+                }
+            ]
+        }
+    ]
+}

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

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

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

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