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

Author: bradfrost

CHANGELOG

@@ -1,5 +1,27 @@
 THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
+PL-v0.6.0 (in progress)
+ - ADD: a UI list of the current media query widths from the CSS
+ - ADD: a pattern's "lineage" now displays in the UI under code view
+ - ADD: annotations can be added to DOM elements of patterns
+ - ADD: separate annotation views on the list view and pattern details views
+ - ADD: generate() now "cleans" public/ before generating the site by deleting most everything
+ - ADD: added support for the css rule saver library
+ - ADD: can use a flag to generate the specific CSS that is used in a pattern. shows on code view when available.
+ - ADD: mark-up for a pattern is now included in the UI under code view
+ - FIX: can open the "raw" version of a pattern in a new window
+ - FIX: frame resizing bar properly supports decimals
+ - FIX: the checkboxes for the websocket-based features, page follow & auto-reload, now work
+ - FIX: postmessage calls now centralized and refactored
+ - FIX: units appear in the toolbar when using Hay! mode
+ - FIX: patterns shouldn't be cached
+ - THX: thanks to @benedfit for the MQ idea which he originally named "phases"
+ - THX: thanks to @alienlebarge for the "clean public/" idea
+
+PL-v0.3.6
+ - FIX: added a delay to the watcher so the CPU doesn't get maxed
+ - THX: thanks to martin berglund for the heads up
+
 PL-v0.3.5
  - ADD: an explicit MIT license
  - FIX: updated .gitignore so that it's more flexible

builder/builder.php

@@ -1,7 +1,7 @@
 <?php
 
 /*!
- * Pattern Lab Builder CLI - v0.3.5
+ * Pattern Lab Builder CLI - v0.3.6
  *
  * Copyright (c) 2013 Dave Olsen, http://dmolsen.com
  * Licensed under the MIT license
@@ -27,18 +27,24 @@
 require __DIR__."/lib/Mustache/Autoloader.php";
 Mustache_Autoloader::register();
 
+// load css rule saver
+require __DIR__."/lib/css-rule-saver/css-rule-saver.php";
+
 // make sure this script is being accessed from the command line
 if (php_sapi_name() == 'cli') {
 
-	$args = getopt("gw");
+	$args = getopt("gwc");
 
 	if (isset($args["g"])) {
 
 		// initiate the g (generate) switch
 
 		// iterate over the source directory and generate the site
 		$g = new Generatr();
-		$g->generate();
+		
+		// check to see if CSS for patterns should be parsed & outputted
+		(isset($args["c"])) ? $g->generate(true) : $g->generate();
+		
 		print "your site has been generated...\n";
 
 	} else if (isset($args["w"])) {

builder/lib/builder.lib.php

@@ -1,7 +1,7 @@
 <?php
 
 /*!
- * Pattern Lab Builder Class - v0.3.5
+ * Pattern Lab Builder Class - v0.3.6
  *
  * Copyright (c) 2013 Dave Olsen, http://dmolsen.com
  * Licensed under the MIT license
@@ -28,6 +28,9 @@ class Buildr {
 	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
+	protected $enableCSS;         // decide if we'll enable CSS parsing
+	protected $patternCSS;        // an array to hold the CSS generated for patterns
+	protected $cssRuleSaver;      // where css rule saver will be initialized
 
 	/**
 	* When initializing the Builder class or the sub-classes make sure the base properties are configured
@@ -62,9 +65,16 @@ public function __construct() {
 		// generate patternTypes as well as patternPaths
 		$this->gatherPatternPaths();
 
+		// generate patternLineages
+		$this->gatherLineages();
+		
 		// get nav items
 		$this->gatherNavItems();
 
+		// provide the default for enable CSS. performance hog so it should be run infrequently
+		$this->enableCSS  = false;
+		$this->patternCSS = array();
+		
 	}
 
 	/**
@@ -188,6 +198,15 @@ private function generatePatternFile($f) {
 		$pp = $this->getPatternPartial($f);
 		$fr = str_replace("{{ patternPartial }}",$pp,$fr);
 		$fr = str_replace("{{ lineage }}",json_encode($this->patternLineages[$pp]),$fr);
+		$fr = str_replace("{{ patternHTML }}",$rf,$fr);
+		
+		// set-up the mark-up for CSS Rule Saver so it can figure out which rules to save
+		if ($this->enableCSS) {
+			$this->cssRuleSaver->loadHTML($rf,false);
+			$patternCSS = $this->cssRuleSaver->saveRules();
+			$this->patternCSS[$pp] = $patternCSS;
+			$fr = str_replace("{{ patternCSS }}",$patternCSS,$fr);
+		}
 
 		return $hr."\n".$rf."\n".$fr;
 
@@ -343,7 +362,38 @@ protected function gatherData() {
 
 		}
 
-	}	
+	}
+	
+	/**
+	* Finds the Lineages for the patterns
+	*
+	* @return {Array}        an array of patterns with their lineages
+	*/
+	protected function gatherLineages() {
+		$this->patternLineages = array();
+		
+		foreach($this->patternPaths as $patternType => $patterns) {
+			
+			foreach ($patterns as $pattern => $filename) {
+				
+				$patternLineage = array();
+				$foundLineages  = $this->getLineage($filename);
+				
+				if (count($foundLineages) > 0) {
+					foreach ($foundLineages as $lineage) {
+						$patternBits  = explode("-",$lineage,2); // BUG: this is making an assumption
+						$path = str_replace("/","-",$this->patternPaths[$patternBits[0]][$patternBits[1]]);
+						$patternLineage[] = array("lineagePattern" => $lineage, "lineagePath" => "../../patterns/".$path."/".$path.".html");
+					}
+				}
+				
+				$this->patternLineages[$patternType."-".$pattern] = $patternLineage;
+				
+			}
+			
+		}
+		
+	}
 
 	/**
 	* Finds Media Queries in CSS files in the source/css/ dir
@@ -356,7 +406,7 @@ protected function gatherMQs() {
 
 		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);
+			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;
@@ -498,13 +548,13 @@ protected function gatherNavItems() {
 	*
 	* @return {Array}        populates $this->patternPaths
 	* @return {Array}        populates $this->patternTypes
+	* @return {Array}        populates $this->patternLineages
 	*/
 	protected function gatherPatternPaths() {
 
 		// set-up vars
 		$this->patternPaths    = array();
 		$this->patternTypes    = array();
-		$this->patternLineages = array();
 
 		// get the pattern types
 		foreach(glob(__DIR__.$this->sp."/*",GLOB_ONLYDIR) as $patternType) {
@@ -526,7 +576,6 @@ 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);
 				}
 			}
 
@@ -536,7 +585,6 @@ 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);
 				}
 			}
 
@@ -569,12 +617,26 @@ protected function gatherPartials() {
 					if (file_exists(__DIR__."/".$this->sp.$path.".mustache")) {
 
 						// create the pattern name & link, render the partial, and stick it all into the pattern array
-						$patternParts    = explode("/",$path);
-						$patternName     = $this->getPatternName($patternParts[2]);
-						$patternLink     = str_replace("/","-",$path)."/".str_replace("/","-",$path).".html";
-						$patternPartial  = $this->renderPattern($path.".mustache");
-						$p["partials"][] = array("patternName" => ucwords($patternName), "patternLink" => $patternLink, "patternPartialPath" => $patternType."-".$pattern, "patternPartial" => $patternPartial);
+						$patternParts         = explode("/",$path);
+						$patternName          = $this->getPatternName($patternParts[2]);
+						$patternLink          = str_replace("/","-",$path)."/".str_replace("/","-",$path).".html";
+						$patternCode          = $this->renderPattern($path.".mustache");
+						$patternPartial       = $this->getPatternPartial($path);
+						$patternLineageExists = (count($this->patternLineages[$patternPartial]) > 0) ? true : false;
+						$patternLineages      = $this->patternLineages[$patternPartial];
+						$patternCSSExists     = $this->enableCSS;
+						$patternCSS           = ($this->enableCSS) ? $this->patternCSS[$patternPartial] : "";
 
+						$p["partials"][] = array("patternName" => ucwords($patternName), 
+						                         "patternLink" => $patternLink, 
+						                         "patternPartialPath" => $patternType."-".$pattern, 
+						                         "patternPartial" => $patternCode,
+						                         "patternCSS" => $patternCSS,
+						                         "patternLineageExists" => $patternLineageExists,
+						                         "patternLineages" => $patternLineages,
+						                         "patternCSSExists" => $patternCSSExists,
+						                         "patternCSS" => $patternCSS
+						                        );
 					}
 
 				}
@@ -614,10 +676,25 @@ protected function gatherPartialsByMatch($patternType, $patternSubType) {
 			if ($patternParts[2][0] != "_") {
 
 				// create the pattern name & link, render the partial, and stick it all into the pattern array
-				$patternName     = $this->getPatternName($patternParts[2]);
-				$patternLink     = str_replace("/","-",$path)."/".str_replace("/","-",$path).".html";
-				$patternPartial  = $this->renderPattern($path.".mustache");
-				$p["partials"][] = array("patternName" => ucwords($patternName), "patternLink" => $patternLink, "patternPartialPath" => str_replace(" ","-",$patternTypeClean)."-".str_replace(" ","-",$patternName), "patternPartial" => $patternPartial);
+				$patternName          = $this->getPatternName($patternParts[2]);
+				$patternLink          = str_replace("/","-",$path)."/".str_replace("/","-",$path).".html";
+				$patternCode          = $this->renderPattern($path.".mustache");
+				$patternPartial       = $this->getPatternPartial($path);
+				$patternLineages      = $this->patternLineages[$patternPartial];
+				$patternLineageExists = (count($patternLineages) > 0) ? true : false;
+				$patternCSSExists     = $this->enableCSS;
+				$patternCSS           = ($this->enableCSS) ? $this->patternCSS[$patternPartial] : "";
+				
+				$p["partials"][] = array("patternName" => ucwords($patternName), 
+				                         "patternLink" => $patternLink, 
+				                         "patternPartialPath" => str_replace(" ","-",$patternTypeClean)."-".str_replace(" ","-",$patternName), 
+				                         "patternPartial" => $patternCode,
+				                         "patternCSS" => $patternCSS,
+				                         "patternLineageExists" => $patternLineageExists,
+				                         "patternLineages" => $patternLineages,
+				                         "patternCSSExists" => $patternCSSExists,
+				                         "patternCSS" => $patternCSS
+				                        );
 
 			}
 
@@ -634,10 +711,11 @@ protected function gatherPartialsByMatch($patternType, $patternSubType) {
 	* @return {Array}        a list of patterns
 	*/
 	protected function getLineage($filename) {
-		$data = file_get_contents($filename);
+		$data = file_get_contents(__DIR__.$this->sp.$filename.".mustache");
 		if (preg_match_all('/{{>([ ]+)?([A-Za-z0-9-]+)([ ]+)?}}/',$data,$matches)) {
 			return $matches[2];
 		}
+		return array();
 	}
 
 	/**
@@ -842,6 +920,19 @@ protected function ignoreDir($fileName) {
 		return false;
 	}
 
+	/**
+	* Loads the CSS from source/css/ into CSS Rule Saver to be used for code view
+	*/
+	protected function initializeCSSRuleSaver() {
+		
+		$this->cssRuleSaver = new cssRuleSaver;
+		
+		foreach(glob(__DIR__."/../../source/css/*.css") as $filename) {
+			$this->cssRuleSaver->loadCSS($filename);
+		}
+		
+	}
+	
 	/**
 	* Print out the data var. For debugging purposes
 	*

builder/lib/css-rule-saver/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 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.