Merge pull request #1199 from pattern-lab/feature/pseudo-pattern-config

Add possibility for variants merge strategy change

Author: sghoweri

packages/cli/test/fixtures/patternlab-config.json

@@ -72,6 +72,7 @@
 	"patternStateCascade": ["inprogress", "inreview", "complete"],
 	"patternExportDirectory": "./pattern_exports/",
 	"patternExportPatternPartials": [],
+	"patternMergeVariantArrays": true,
 	"serverOptions": {
 		"wait": 1000
 	},

packages/core/patternlab-config.json

@@ -75,6 +75,7 @@
   "patternExportPatternPartials": [],
   "patternExportPreserveDirectoryStructure": true,
   "patternExportRaw": false,
+  "patternMergeVariantArrays": true,
   "serverOptions": {
     "wait": 1000
   },

packages/core/src/lib/pseudopattern_hunter.js

@@ -60,10 +60,24 @@ pseudopattern_hunter.prototype.find_pseudopatterns = function(
       }
 
       //extend any existing data with variant data
-      variantFileData = _.merge(
+      variantFileData = _.mergeWith(
         {},
         currentPattern.jsonFileData,
-        variantFileData
+        variantFileData,
+        (objValue, srcValue) => {
+          if (
+            _.isArray(objValue) &&
+            // If the parameter is not available after updating pattern lab but
+            // not the patternlab-config it should not override arrays.
+            patternlab.config.hasOwnProperty('patternMergeVariantArrays') &&
+            !patternlab.config.patternMergeVariantArrays
+          ) {
+            return srcValue;
+          }
+          // Lodash will only check for "undefined" and eslint needs a consistent
+          // return so do not remove
+          return undefined;
+        }
       );
 
       const variantName = pseudoPatterns[i]

packages/core/test/files/_patterns/00-test/475-variant-test.json

@@ -0,0 +1,9 @@
+{
+    "a": 1,
+    "b": [2, 3],
+    "c": {
+        "d": [4, 5],
+        "e": 8,
+        "f": {"a": ["a"], "b": ["b"], "c": ["c"]}
+    }
+}

packages/core/test/files/_patterns/00-test/475-variant-test.mustache

@@ -0,0 +1 @@
+{{a}}

packages/core/test/files/_patterns/00-test/475-variant-test~merge.json

@@ -0,0 +1,8 @@
+{
+    "a": 2,
+    "b": [8],
+    "c": {
+        "d": [6, 7],
+        "f": {"b": ["x"]}
+    }
+}

packages/core/test/pseudopattern_hunter_tests.js

@@ -133,3 +133,68 @@ tap.test(
     });
   }
 );
+
+tap.test('pseudo pattern variant data should merge arrays', function(test) {
+  const pl = stubPatternlab();
+  pl.config.patternMergeVariantArrays = true;
+
+  const pattern = loadPattern('00-test/475-variant-test.mustache', pl);
+
+  addPattern(pattern, pl);
+
+  return pph.find_pseudopatterns(pattern, pl).then(() => {
+    test.equals(pl.patterns[1].patternPartial, 'test-variant-test-merge');
+    test.equals(
+      JSON.stringify(pl.patterns[1].jsonFileData),
+      JSON.stringify({
+        a: 2,
+        b: [8, 3],
+        c: { d: [6, 7], e: 8, f: { a: ['a'], b: ['x'], c: ['c'] } },
+      })
+    );
+  });
+});
+
+tap.test(
+  'pseudo pattern variant data should merge arrays if config "patternMergeVariantArrays" is not available as default behavior',
+  function(test) {
+    const pl = stubPatternlab();
+
+    const pattern = loadPattern('00-test/475-variant-test.mustache', pl);
+
+    addPattern(pattern, pl);
+
+    return pph.find_pseudopatterns(pattern, pl).then(() => {
+      test.equals(pl.patterns[1].patternPartial, 'test-variant-test-merge');
+      test.equals(
+        JSON.stringify(pl.patterns[1].jsonFileData),
+        JSON.stringify({
+          a: 2,
+          b: [8, 3],
+          c: { d: [6, 7], e: 8, f: { a: ['a'], b: ['x'], c: ['c'] } },
+        })
+      );
+    });
+  }
+);
+
+tap.test('pseudo pattern variant data should override arrays', function(test) {
+  const pl = stubPatternlab();
+  pl.config.patternMergeVariantArrays = false;
+
+  const pattern = loadPattern('00-test/475-variant-test.mustache', pl);
+
+  addPattern(pattern, pl);
+
+  return pph.find_pseudopatterns(pattern, pl).then(() => {
+    test.equals(pl.patterns[1].patternPartial, 'test-variant-test-merge');
+    test.equals(
+      JSON.stringify(pl.patterns[1].jsonFileData),
+      JSON.stringify({
+        a: 2,
+        b: [8],
+        c: { d: [6, 7], e: 8, f: { a: ['a'], b: ['x'], c: ['c'] } },
+      })
+    );
+  });
+});

packages/core/test/util/patternlab-config.json

@@ -57,6 +57,7 @@
   "patternExportPatternPartials": [],
   "patternExportDirectory": "./pattern_exports/",
   "patternExtension": "mustache",
+  "patternMergeVariantArrays": true,
   "cacheBust": true,
   "outputFileSuffixes": {
     "rendered": ".rendered",

packages/development-edition-engine-handlebars/patternlab-config.json

@@ -70,6 +70,7 @@
   "patternExportPatternPartials": [],
   "patternExportPreserveDirectoryStructure": true,
   "patternExportRaw": false,
+  "patternMergeVariantArrays": true,
   "serverOptions": {
     "wait": 1000
   },

packages/development-edition-engine-react/patternlab-config.json

@@ -25,16 +25,7 @@
     "m": [500, 800],
     "l": [800, 2600]
   },
-<<<<<<< HEAD:packages/development-edition-engine-react/patternlab-config.json
   "logLevel": "info",
-=======
-  "patternExportAll": false,
-  "patternExportPreserveDirectoryStructure": false,
-  "patternExportRaw": false,
-  "patternExportPatternPartials": [],
-  "patternExportDirectory": "./pattern_exports/",
-  "cacheBust": true,
->>>>>>> 436dd99e50d808cd14691593b927209f1ecb663e:patternlab-config.json
   "outputFileSuffixes": {
     "rendered": ".rendered",
     "rawTemplate": "",
@@ -79,8 +70,12 @@
   },
   "patternExtension": "mustache",
   "patternStateCascade": ["inprogress", "inreview", "complete"],
+  "patternExportAll": false,
+  "patternExportPreserveDirectoryStructure": false,
+  "patternExportRaw": false,
   "patternExportDirectory": "./pattern_exports/",
   "patternExportPatternPartials": [],
+  "patternMergeVariantArrays": true,
   "serverOptions": {
     "wait": 1000
   },