patterspecific.listitems.json support

bmuenzenmeyer · bmuenzenmeyer · commit 192b87f2e84a · 2015-08-25T23:31:26.000-05:00
unit tests for list_item_hunter.js
CHANGELOG and package for v0.11.0
diff --git a/CHANGELOG b/CHANGELOG
@@ -2,6 +2,7 @@ THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
 PL-node-v0.11.0
  - ADD: Ignore pattern directories that start with an underscore.
+ - ADD: Support for lists with the listItems variable
  - FIX: Resolved issue where pattern parameter data bled into global data object
  - ADD: Support a fluid viewport
 
diff --git a/builder/lineage_hunter.js b/builder/lineage_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/list_item_hunter.js b/builder/list_item_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -31,8 +31,6 @@
 
           //find the boundaries of the block
           var loopNumberString = liMatch.split('.')[1].split('}')[0].trim();
-
-          //find the boundaries of the block
           var end = liMatch.replace('#', '/');
           var patternBlock = pattern.template.substring(pattern.template.indexOf(liMatch) + liMatch.length, pattern.template.indexOf(end)).trim();
 
@@ -43,23 +41,18 @@
             repeatedBlockTemplate.push(patternBlock);
           }
 
+          //check for a local listitems.json file
+          var listData = JSON.parse(JSON.stringify(patternlab.listitems));
+          listData = pattern_assembler.merge_data(listData, pattern.patternSpecificListJson);
+
           //iterate over each copied block, rendering its contents along with pattenlab.listitems[i]
           for(var i = 0; i < repeatedBlockTemplate.length; i++){
 
             var thisBlockTemplate = repeatedBlockTemplate[i];
             var thisBlockHTML = "";
 
-            //check for a local listitems.json file
-            // var patternSpecificListJson = {};
-            // try {
-            //   patternSpecificListJson = abspath.substr(0, abspath.lastIndexOf(".")) + "listitems.json";
-            //   currentPattern.jsonFileData = fs.readJSONSync(jsonFilename);
-            // }
-            // catch(e) {
-            // }
-
             //combine listItem data with pattern data with global data
-            var itemData = patternlab.listitems['' + items.indexOf(loopNumberString)]; //this is a property
+            var itemData = listData['' + items.indexOf(loopNumberString)]; //this is a property like "2"
             var globalData = JSON.parse(JSON.stringify(patternlab.data));
             var localData = JSON.parse(JSON.stringify(pattern.jsonFileData));
 
diff --git a/builder/media_hunter.js b/builder/media_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/object_factory.js b/builder/object_factory.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/parameter_hunter.js b/builder/parameter_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/pattern_assembler.js b/builder/pattern_assembler.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -81,12 +81,22 @@
 
       //look for a json file for this template
       try {
-        var jsonFilename = abspath.substr(0, abspath.lastIndexOf(".")) + ".json";
-        currentPattern.jsonFileData = fs.readJSONSync(jsonFilename);
+        var jsonFilename = patternlab.config.patterns.source + currentPattern.subdir + '/' + currentPattern.fileName  + ".json";
+        currentPattern.jsonFileData = fs.readJSONSync(jsonFilename.substring(2));
+        console.log('found pattern-specific data.json for ' + currentPattern.key);
       }
       catch(e) {
       }
 
+      //look for a listitems.json file for this template
+      try {
+        var listJsonFileName = patternlab.config.patterns.source + currentPattern.subdir + '/' + currentPattern.fileName  + ".listitems.json";
+        currentPattern.patternSpecificListJson = fs.readJSONSync(listJsonFileName.substring(2));
+        console.log('found pattern-specific listitems.json for ' + currentPattern.key);
+      }
+      catch(e) {
+      }      
+
       //add the raw template to memory
       currentPattern.template = fs.readFileSync(abspath, 'utf8');
 
diff --git a/builder/pattern_exporter.js b/builder/pattern_exporter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/patternlab.js b/builder/patternlab.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/patternlab_grunt.js b/builder/patternlab_grunt.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/pseudopattern_hunter.js b/builder/pseudopattern_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.10.1 - 2015 
+ * patternlab-node - v0.11.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "patternlab-node",
   "description": "Pattern Lab is a collection of tools to help you create atomic design systems. This is the node command line interface (CLI).",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "devDependencies": {
     "grunt": "~0.4.0",
     "grunt-contrib-watch": "^0.6.1",
diff --git a/test/list_item_hunter_tests.js b/test/list_item_hunter_tests.js
@@ -100,50 +100,67 @@
       test.done();
     },
 
-    //TODO
-    //'process_list_item_partials overwrites listItem data if local .listitem.json is found' : function(test){
-      // //arrange
-      // //setup current pattern from what we would have during execution
-      // var currentPattern = {
-      //    "template": "{{#listItems.two}}{{ title }}{{/listItems.two}}",
-      //    "extendedTemplate" : "{{#listItems.two}}{{ title }}{{/listItems.two}}",
-      //    "key": "test-patternName",
-      //    "jsonFileData" : {}
-      // };
-
-      // var patternlab = {
-      //   "listitems": {
-      //     "1": [
-      //        {
-      //           "title": "Foo"
-      //        }
-      //     ],
-      //     "2": [
-      //        {
-      //           "title": "Foo"
-      //        },
-      //        {
-      //           "title": "Bar"
-      //        }
-      //     ]
-      //   },
-      //   "data": {
-      //     "link": {},
-      //     "partials": []
-      //   },
-      //   "config": {"debug": true}
-      // };
-
-      // var list_item_hunter = new lih();
-
-      // //act
-      // list_item_hunter.process_list_item_partials(currentPattern, patternlab);
+    'process_list_item_partials overwrites listItem data if local .listitem.json is found' : function(test){
+      //arrange
+      //setup current pattern from what we would have during execution
+      var currentPattern = {
+         "template": "{{#listItems.two}}{{ title }}{{/listItems.two}}",
+         "extendedTemplate" : "{{#listItems.two}}{{> test-simple }}{{/listItems.two}}",
+         "key": "test-patternName",
+         "jsonFileData" : {},
+         "patternSpecificListJson" : {
+            "2": [
+                   {
+                      "title": "One"
+                   },
+                   {
+                      "title": "Two"
+                   },
+                ]
+          }         
+      };
+
+      var patternlab = {
+        "listitems": {
+          "1": [
+             {
+                "title": "Foo"
+             }
+          ],
+          "2": [
+             {
+                "title": "Foo"
+             },
+             {
+                "title": "Bar"
+             }
+          ]
+        },
+        "data": {
+          "link": {},
+          "partials": []
+        },
+        "config": {"debug": false},
+        "patterns": [
+          {
+           "template": "{{ title }}",
+           "extendedTemplate" : "{{ title }}",
+           "key": "test-simple",
+           "jsonFileData" : {}
+          }
+        ]
+      };
+
+      var list_item_hunter = new lih();
+
+      //act
+      list_item_hunter.process_list_item_partials(currentPattern, patternlab);
       
-      // //assert
-      // test.equals(currentPattern.extendedTemplate, "FooBar" );
+      //assert
+      test.equals(currentPattern.extendedTemplate, "OneTwo" );
 
-      // test.done();
-    //},    
+      test.done();
+    }
 
   };
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * patternlab-node - v0.10.1 - 2015`
	`2`	`+ * patternlab-node - v0.11.0 - 2015`
`3`	`3`	`*`
`4`	`4`	`* Brian Muenzenmeyer, and the web community.`
`5`	`5`	`* Licensed under the MIT license.`