refactored to better utilize the pattern object constructor. less locals in patternlab.js

closes #81

Author: bmuenzenmeyer

builder/object_factory.js

@@ -11,19 +11,19 @@
 (function () {
 	"use strict";
 
-	var oPattern = function(name, subdir, filename, data){
-		this.name = name; //this is the unique name with the subDir
+	var oPattern = function(subdir, filename, data){
+		this.fileName = filename.substring(0, filename.indexOf('.'));
 		this.subdir = subdir;
-		this.filename = filename;
-		this.data =  data;
-		this.template = '';
-		this.patternPartial = '';
-		this.patternName = ''; //this is the display name for the ui
-		this.patternLink = name + '/' + name + '.html';
-		this.patternGroup = name.substring(name.indexOf('-') + 1, name.indexOf('-', 4) + 1 - name.indexOf('-') + 1);
+		this.name = (subdir.replace(/[\/\\]/g, '-') + '-' + this.fileName).replace(/\\/g, '-'); //this is the unique name with the subDir
+		this.data =  data || null;
+		this.patternName = this.fileName.substring(this.fileName.indexOf('-') + 1); //this is the display name for the ui
+		this.patternLink = this.name + '/' + this.name + '.html';
+		this.patternGroup = this.name.substring(this.name.indexOf('-') + 1, this.name.indexOf('-', 4) + 1 - this.name.indexOf('-') + 1);
 		this.patternSubGroup = subdir.substring(subdir.indexOf('/') + 4);
 		this.flatPatternPath = subdir.replace(/\//g, '-');
-		this.key = '';
+		this.key = this.patternGroup + '-' + this.patternName;
+		this.template = '';
+		this.patternPartial = '';
 		this.lineage = [];
 		this.lineageIndex = [];
 		this.lineageR = [];

builder/patternlab.js

@@ -58,7 +58,6 @@ var patternlab_engine = function(){
 		patternlab.header = fs.readFileSync('./source/_patternlab-files/pattern-header-footer/header.html', 'utf8');
 		patternlab.footer = fs.readFileSync('./source/_patternlab-files/pattern-header-footer/footer.html', 'utf8');
 		patternlab.patterns = [];
-		patternlab.patternIndex = [];
 		patternlab.partials = {};
 		patternlab.data.link = {};
 
@@ -75,25 +74,15 @@ var patternlab_engine = function(){
 			var subdir = path.dirname(path.relative('./source/_patterns', file));
 			var filename = path.basename(file);
 
-			//check if the pattern already exists.  
-			var patternName = filename.substring(0, filename.indexOf('.')),
-				patternIndex = patternlab.patternIndex.indexOf(subdir + '-' +  patternName),
-				currentPattern,
-				flatPatternPath;
-
-			//ignore _underscored patterns, json, and dotfiles
+			//ignore _underscored patterns, json (for now), and dotfiles
 			if(filename.charAt(0) === '_' || path.extname(filename) === '.json' || filename.charAt(0) === '.'){
 				return;
 			}
 
+			//check for pattern parameters before we do much else. need to remove them into a data object so the rest of the filename parsing works
+
 			//make a new Pattern Object
-			var flatPatternName = subdir.replace(/[\/\\]/g, '-') + '-' + patternName;
-			
-			flatPatternName = flatPatternName.replace(/\\/g, '-');
-			currentPattern = new of.oPattern(flatPatternName, subdir, filename, {});
-			currentPattern.patternName = patternName.substring(patternName.indexOf('-') + 1);
-			currentPattern.data = null;
-			currentPattern.key = currentPattern.patternGroup + '-' + currentPattern.patternName;
+			currentPattern = new of.oPattern(subdir, filename, {});
 
 			//see if this file has a state
 			if(patternlab.config.patternStates[currentPattern.patternName]){
@@ -111,6 +100,8 @@ var patternlab_engine = function(){
 
 			}
 			currentPattern.template = fs.readFileSync(abspath, 'utf8');
+
+			//look for a pseudo pattern by checking if there is a file containing same name, with ~ in it, ending in .json
 
 			//find pattern lineage
 			var lineage_hunter = new lh();
@@ -125,14 +116,13 @@ var patternlab_engine = function(){
 			//look for the full path on nested patters, else expect it to be flat
 			var partialname = '';
 			if(cleanSub !== ''){
-				partialname = cleanSub + '-' + patternName.substring(patternName.indexOf('-') + 1);
+				partialname = cleanSub + '-' + currentPattern.patternName;
 			} else{
-				partialname = currentPattern.patternGroup + '-' + patternName.substring(patternName.indexOf('-') + 1);
+				partialname = currentPattern.patternGroup + '-' + currentPattern.patternName;
 			}
 			patternlab.partials[partialname] = currentPattern.template;
 
 			//add to patternlab object so we can look these up later.
-			patternlab.patternIndex.push(currentPattern.name);
 			patternlab.data.link[currentPattern.patternGroup + '-' + currentPattern.patternName] = '/patterns/' + currentPattern.patternLink;
 			patternlab.patterns.push(currentPattern);
 		});
@@ -145,7 +135,7 @@ var patternlab_engine = function(){
 			//render the pattern. pass partials and data
 			if(pattern.data) { // Pass found pattern-specific JSON as data
 
-				//extend patternIndex into link for pattern link shortcuts to work. we do this locally and globally
+				//extend pattern data links into link for pattern link shortcuts to work. we do this locally and globally
 				pattern.data.link = extend({}, patternlab.data.link);
 
 				pattern.patternPartial = renderPattern(pattern.template, pattern.data, patternlab.partials);
@@ -356,7 +346,7 @@ var patternlab_engine = function(){
 
 	function addToPatternPaths(bucketName, pattern){
 		//this is messy, could use a refactor.
-		patternlab.patternPaths[bucketName][pattern.patternName] = pattern.subdir.replace(/\\/g, '/') + "/" + pattern.filename.substring(0, pattern.filename.indexOf('.'));
+		patternlab.patternPaths[bucketName][pattern.patternName] = pattern.subdir.replace(/\\/g, '/') + "/" + pattern.fileName;
 	}
 
 	return {

test/object_factory_tests.js

@@ -5,18 +5,23 @@
 
 	exports['oPattern initialization'] = {
 		'test oPattern initializes correctly' : function(test){
-			var p = new of.oPattern('00-atoms-00-global-00-colors', '00-atoms/00-global', 'file.txt', { d: 123});
+			var p = new of.oPattern('00-atoms/00-global', '00-colors.mustache', { d: 123});
 			test.equals(p.name, '00-atoms-00-global-00-colors');
 			test.equals(p.subdir, '00-atoms/00-global');
-			test.equals(p.filename, 'file.txt');
+			test.equals(p.fileName, '00-colors');
 			test.equals(p.data.d, 123);
-			test.equals(p.template, '');
-			test.equals(p.patternPartial, '');
-			test.equals(p.patternName, '');
+			test.equals(p.patternName, 'colors');
 			test.equals(p.patternLink, '00-atoms-00-global-00-colors/00-atoms-00-global-00-colors.html');
 			test.equals(p.patternGroup, 'atoms');
 			test.equals(p.patternSubGroup, 'global');
 			test.equals(p.flatPatternPath, '00-atoms-00-global');
+			test.equals(p.key, 'atoms-colors');
+			test.equals(p.template, '');
+			test.equals(p.patternPartial, '');
+			test.equals(p.lineage.length, 0);
+			test.equals(p.lineageIndex.length, 0);
+			test.equals(p.lineageR.length, 0);
+			test.equals(p.lineageRIndex.length, 0);
 			test.done();
 		}
 	};