Pattern States Should Always Inherit to Consuming Patterns, Not Just When The Consuming Pattern Has a State

clsoes #313

Author: bmuenzenmeyer

core/lib/lineage_hunter.js

@@ -1,10 +1,10 @@
-/* 
- * patternlab-node - v1.2.2 - 2016 
- * 
+/*
+ * patternlab-node - v1.2.2 - 2016
+ *
  * Brian Muenzenmeyer, and the web community.
- * Licensed under the MIT license. 
- * 
- * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice. 
+ * Licensed under the MIT license.
+ *
+ * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice.
  *
  */
 
@@ -123,12 +123,13 @@ var lineage_hunter = function () {
             var lineageRPattern = pattern_assembler.get_pattern_by_key(pattern.lineageRIndex[j], patternlab);
 
             //only set patternState if pattern.patternState "is less than" the lineageRPattern.patternstate
+            //or if lineageRPattern.patternstate (the consuming pattern) does not have a state
             //this makes patternlab apply the lowest common ancestor denominator
-            if (patternlab.config.patternStateCascade.indexOf(pattern.patternState)
-              < patternlab.config.patternStateCascade.indexOf(lineageRPattern.patternState)) {
+            if (lineageRPattern.patternState === '' || (patternlab.config.patternStateCascade.indexOf(pattern.patternState)
+              < patternlab.config.patternStateCascade.indexOf(lineageRPattern.patternState))) {
 
               if (patternlab.config.debug) {
-                console.log('Found a lower common denominator pattern state: ' + pattern.patternState + ' on ' + pattern.key + '. Setting reverse lineage pattern ' + lineageRPattern.key + ' from ' + lineageRPattern.patternState);
+                console.log('Found a lower common denominator pattern state: ' + pattern.patternState + ' on ' + pattern.key + '. Setting reverse lineage pattern ' + lineageRPattern.key + ' from ' + (lineageRPattern.patternState === '' ? '<<blank>>' : lineageRPattern.patternState));
               }
 
               lineageRPattern.patternState = pattern.patternState;

patternlab-config.json

@@ -51,9 +51,7 @@
   },
   "patternStateCascade": ["inprogress", "inreview", "complete"],
   "patternStates": {
-    "molecules-single-comment" : "complete",
-    "organisms-sticky-comment" : "inreview",
-    "templates-article" : "complete"
+    "molecules-block-hero" : "inreview"
   },
   "patternExportKeys": [],
   "patternExportDirectory": "./pattern_exports/",

test/lineage_hunter_tests.js

@@ -543,7 +543,7 @@
       test.done();
     },
 
-    'cascade_pattern_states does not promote lower pattern state when consumer does not display its own state' : function(test){
+    'cascade_pattern_states promotes lower pattern state when consumer does not have its own state' : function(test){
       //arrange
       var pl = createBasePatternLabObject();
       pl.config.patternStates = {
@@ -572,7 +572,7 @@
       var consumerPatternReturned = pattern_assembler.get_pattern_by_key('test-foo', pl);
       test.equals(consumerPatternReturned.lineage.length, 1);
       test.equals(consumerPatternReturned.lineage[0].lineageState, 'inreview');
-      test.equals(consumerPatternReturned.patternState, '');
+      test.equals(consumerPatternReturned.patternState, 'inreview');
       test.done();
     }