Merge branch 'dev' of https://github.com/pattern-lab/patternlab-php into dev

Author: bradfrost

.gitignore

@@ -1,16 +1,9 @@
 .DS_Store
-public/index.html
-public/styleguide.html
-public/styleguide/html/styleguide.html
-public/css/*
-public/fonts/*
-public/js/*
-public/images/*
-public/patterns/*
+public/*
+!public/listeners/*
+!public/styleguide/*
+!public/patterns/**/*
+!public/data/*.js
 config.ini
 latest-change.txt
-/public/styleguide/js/styleguide-ck.js
-/public/listeners/synclisteners-ck.js
-/public/styleguide/js/data-saver-ck.js
-/public/styleguide/js/url-handler-ck.js
-/public/styleguide/js/annotations-viewer-ck.js
+*-ck.js

CHANGELOG

@@ -1,5 +1,14 @@
 THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
+PL-v0.3.5
+ - ADD: an explicit MIT license
+ - FIX: updated .gitignore so that it's more flexible
+ - THX: thanks to @alienlebarge for the .gitignore fix
+
+PL-v0.3.4
+ - FIX: Generator class renamed because it's a reserved name in PHP 5.5
+ - THX: thanks to @faustgertz for the heads up
+
 PL-v0.3.3
  - FIX: links created with {{ link.pattern }} now have the correct path
  - FIX: links within a pattern now properly update the history

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Brad Frost, http://bradfrostweb.com & Dave Olsen, http://dmolsen.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

builder/builder.php

@@ -1,7 +1,7 @@
 <?php
 
 /*!
- * Pattern Lab Builder CLI - v0.3.3
+ * Pattern Lab Builder CLI - v0.3.5
  *
  * Copyright (c) 2013 Dave Olsen, http://dmolsen.com
  * Licensed under the MIT license
@@ -36,7 +36,7 @@
 		// initiate the g (generate) switch
 
 		// iterate over the source directory and generate the site
-		$g = new Generator();
+		$g = new Generatr();
 		$g->generate();
 		print "your site has been generated...\n";
 
@@ -45,12 +45,12 @@
 		// initiate the w (watch) switch
 
 		// iterate over the source directory and generate the site
-		$g = new Generator();
+		$g = new Generatr();
 		$g->generate();
 		print "your site has been generated...\n";
 
 		// watch the source directory and regenerate any changed files
-		$w = new Watcher();
+		$w = new Watchr();
 		print "watching your site for changes...\n";
 		$w->watch();
 

builder/lib/builder.lib.php

@@ -1,7 +1,7 @@
 <?php
 
 /*!
- * Pattern Lab Builder Class - v0.3.3
+ * Pattern Lab Builder Class - v0.3.5
  *
  * Copyright (c) 2013 Dave Olsen, http://dmolsen.com
  * Licensed under the MIT license
@@ -10,7 +10,7 @@
  *
  */
 
-class Builder {
+class Buildr {
 
 	// i was lazy when i started this project & kept (mainly) to two letter vars. sorry.
 	protected $mpl;               // mustache pattern loader instance
@@ -24,6 +24,7 @@ class Builder {
 	protected $navSyncPort;       // for populating the websockets template partial
 	protected $patternTypes;      // a list of pattern types that match the directory structure
 	protected $patternPaths;      // the paths to patterns for use with mustache partials
+	protected $patternLineages;   // the list of patterns that make up a particular pattern
 	protected $patternTypesRegex; // the simple regex for the pattern types. used in getPath()
 	protected $navItems;          // the items for the nav. includes view all links
 	protected $viewAllPaths;      // the paths to the view all pages
@@ -51,7 +52,7 @@ public function __construct() {
 			// if the variables are array-like make sure the properties are validated/trimmed/lowercased before saving
 			if (($key == "ie") || ($key == "id")) {
 				$values = explode(",",$value);
-				array_walk($values,'Builder::trim');
+				array_walk($values,'Buildr::trim');
 				$this->$key = $values;
 			} else {
 				$this->$key = $value;
@@ -122,12 +123,13 @@ protected function generateMainPages() {
 		$this->navItems['navsyncport']     = $this->navSyncPort;
 		$this->navItems['patternpaths']    = json_encode($this->patternPaths);
 		$this->navItems['viewallpaths']    = json_encode($this->viewAllPaths);
+		$this->navItems['mqs']             = $this->gatherMQs();
 
 		// grab the partials into a data object for the style guide
 		$sd = $this->gatherPartials();
 
 		// sort partials by patternLink
-		usort($sd['partials'], "Builder::sortPartials");
+		usort($sd['partials'], "Buildr::sortPartials");
 
 		// render the "view all" pages
 		$this->generateViewAllPages();
@@ -177,11 +179,18 @@ protected function generatePatterns() {
 	* @return {String}       the final rendered pattern including the standard header and footer for a pattern
 	*/
 	private function generatePatternFile($f) {
+		
 		$hr = file_get_contents(__DIR__.$this->sp."../_patternlab-files/pattern-header-footer/header.html");
 		$rf = $this->renderPattern($f);
 		$fr = file_get_contents(__DIR__.$this->sp."../_patternlab-files/pattern-header-footer/footer.html");
-		$fr = str_replace("{{ patternPartial }}",$this->getPatternPartial($f),$fr);
+		
+		// the footer isn't rendered as mustache but we have some variables there any way. find & replace.
+		$pp = $this->getPatternPartial($f);
+		$fr = str_replace("{{ patternPartial }}",$pp,$fr);
+		$fr = str_replace("{{ lineage }}",json_encode($this->patternLineages[$pp]),$fr);
+		
 		return $hr."\n".$rf."\n".$fr;
+		
 	}
 
 	/**
@@ -246,7 +255,7 @@ protected function generateViewAllPages() {
 	}
 
 	/**
-	* Gather data from source/_data/data.json, source/_data/listitems.json, and pattern-specific json files
+	* Gather data from source/_data/_data.json, source/_data/_listitems.json, and pattern-specific json files
 	*
 	* Reserved attributes: 
 	*    - $this->d->listItems : listItems from listitems.json, duplicated into separate arrays for $this->d->listItems->one, $this->d->listItems->two, $this->d->listItems->three... etc.
@@ -258,14 +267,14 @@ protected function generateViewAllPages() {
 	protected function gatherData() {
 
 		// gather the data from the main source data.json
-		if (file_exists(__DIR__."/../../source/_data/data.json")) {
-			$this->d = (object) array_merge(array(), (array) json_decode(file_get_contents(__DIR__."/../../source/_data/data.json")));
+		if (file_exists(__DIR__."/../../source/_data/_data.json")) {
+			$this->d = (object) array_merge(array(), (array) json_decode(file_get_contents(__DIR__."/../../source/_data/_data.json")));
 		}
 
 		// add list item data, makes 'listItems' a reserved word
-		if (file_exists(__DIR__."/../../source/_data/listitems.json")) {
+		if (file_exists(__DIR__."/../../source/_data/_listitems.json")) {
 
-			$listItems = (array) json_decode(file_get_contents(__DIR__."/../../source/_data/listitems.json"));
+			$listItems = (array) json_decode(file_get_contents(__DIR__."/../../source/_data/_listitems.json"));
 			$numbers   = array("one","two","three","four","five","six","seven","eight","nine","ten","eleven","twelve");
 
 			$i = 0;
@@ -336,6 +345,30 @@ protected function gatherData() {
 
 	}	
 
+	/**
+	* Finds Media Queries in CSS files in the source/css/ dir
+	*
+	* @return {Array}        an array of the appropriate MQs
+	*/
+	protected function gatherMQs() {
+		
+		$mqs = array();
+		
+		foreach(glob(__DIR__."/../../source/css/*.css") as $filename) {
+			$data    = file_get_contents($filename);
+			preg_match_all("/(min|max)-width:( |)(([0-9]{1,5})(\.[0-9]{1,20}|)(px|em))/",$data,$matches);
+			foreach ($matches[3] as $match) {
+				if (!in_array($match,$mqs)) {
+					$mqs[] = $match;
+				}
+			}	
+		}
+		
+		sort($mqs);
+		return $mqs;
+		
+	}
+	
 	/**
 	* Gathers the partials for the nav drop down in Pattern Lab
 	*
@@ -469,8 +502,9 @@ protected function gatherNavItems() {
 	protected function gatherPatternPaths() {
 
 		// set-up vars
-		$this->patternPaths = array();
-		$this->patternTypes = array();
+		$this->patternPaths    = array();
+		$this->patternTypes    = array();
+		$this->patternLineages = array();
 
 		// get the pattern types
 		foreach(glob(__DIR__.$this->sp."/*",GLOB_ONLYDIR) as $patternType) {
@@ -482,14 +516,17 @@ protected function gatherPatternPaths() {
 
 		// find the patterns for the types
 		foreach($this->patternTypes as $patternType) {
+			
 			$patternTypePaths = array();
+			$patternTypeClean = $this->getPatternName($patternType, false);
 
 			// find pattern paths for pattern subtypes
 			foreach(glob(__DIR__.$this->sp.$patternType."/*/*.mustache") as $filename) {
 				preg_match('/\/([A-z0-9-_]{1,})\.mustache$/',$filename,$matches);
 				$pattern = $this->getPatternName($matches[1], false);
 				if (($pattern[0] != "_") && (!isset($patternTypePaths[$pattern]))) {
 					$patternTypePaths[$pattern] = $this->getPath($filename);
+					$this->patternLineages[$patternTypeClean."-".$pattern] = $this->getLineage($filename);
 				}
 			}
 
@@ -499,10 +536,10 @@ protected function gatherPatternPaths() {
 				$pattern = $this->getPatternName($matches[1], false);
 				if (($pattern[0] != "_") && (!isset($patternTypePaths[$pattern]))) {
 					$patternTypePaths[$pattern] = $this->getPath($filename);
+					$this->patternLineages[$patternTypeClean."-".$pattern] = $this->getLineage($filename);
 				}
 			}
 
-			$patternTypeClean = $this->getPatternName($patternType, false);
 			$this->patternPaths[$patternTypeClean] = $patternTypePaths;
 
 		}
@@ -590,6 +627,19 @@ protected function gatherPartialsByMatch($patternType, $patternSubType) {
 
 	}
 
+	/**
+	* Get the lineage for a given pattern by parsing it and matching mustache partials
+	* @param  {String}       the filename for the pattern to be parsed
+	*
+	* @return {Array}        a list of patterns
+	*/
+	protected function getLineage($filename) {
+		$data = file_get_contents($filename);
+		if (preg_match_all('/{{>([ ]+)?([A-Za-z0-9-]+)([ ]+)?}}/',$data,$matches)) {
+			return $matches[2];
+		}
+	}
+	
 	/**
 	* Get the directory path for a given pattern or json file by parsing the file path
 	* @param  {String}       the filepath for a directory that contained the match
@@ -693,9 +743,11 @@ protected function moveFile($s,$p) {
 	* Moves static files that aren't directly related to Pattern Lab
 	* @param  {String}       file name to be moved
 	* @param  {String}       copy for the message to be printed out
+	* @param  {String}       part of the file name to be found for replacement
+	* @param  {String}       the replacement
 	*/
-	protected function moveStaticFile($fileName,$copy = "") {
-		$this->moveFile($fileName,$fileName);
+	protected function moveStaticFile($fileName,$copy = "", $find = "", $replace = "") {
+		$this->moveFile($fileName,str_replace($find, $replace, $fileName));
 		$this->updateChangeTime();
 		if ($copy != "") {
 			print $fileName." ".$copy."...\n";

builder/lib/generator.lib.php

@@ -1,7 +1,7 @@
 <?php
 
 /*!
- * Pattern Lab Generator Class - v0.3.3
+ * Pattern Lab Generator Class - v0.3.5
  *
  * Copyright (c) 2013 Dave Olsen, http://dmolsen.com
  * Licensed under the MIT license
@@ -11,7 +11,7 @@
  *
  */
 
-class Generator extends Builder {
+class Generatr extends Buildr {
 
 	/**
 	* Use the Builder __construct to gather the config variables
@@ -37,6 +37,21 @@ public function generate() {
 		// render out the index and style guide
 		$this->generateMainPages();
 
+		// iterate over the data files and regenerate the entire site if they've changed
+		$objects = new RecursiveIteratorIterator(new RecursiveDirectoryIterator(__DIR__."/../../source/_data/"), RecursiveIteratorIterator::SELF_FIRST);
+		
+		// make sure dots are skipped
+		$objects->setFlags(FilesystemIterator::SKIP_DOTS);
+		
+		foreach($objects as $name => $object) {
+			
+			$fileName = str_replace(__DIR__."/../../source/_data".DIRECTORY_SEPARATOR,"",$name);
+			if (($fileName[0] != "_") && $object->isFile()) {
+				$this->moveStaticFile("_data/".$fileName,"","_data","data");
+			}
+			
+		}
+		
 		// iterate over all of the other files in the source directory and move them if their modified time has changed
 		$objects = new RecursiveIteratorIterator(new RecursiveDirectoryIterator(__DIR__."/../../source/"), RecursiveIteratorIterator::SELF_FIRST);