Merge branch 'dev'

Author: dmolsen

src/PatternLab/Builder.php

@@ -16,6 +16,7 @@
 use \PatternLab\Config;
 use \PatternLab\Data;
 use \PatternLab\Dispatcher;
+use \PatternLab\FileUtil;
 use \PatternLab\Parsers\Documentation;
 use \PatternLab\PatternData\Exporters\NavItemsExporter;
 use \PatternLab\PatternData\Exporters\PatternPartialsExporter;
@@ -110,6 +111,12 @@ protected function generateAnnotations() {
 	*/
 	protected function generateIndex() {
 
+		// bomb if missing index.html
+		if (!file_exists(Config::getOption("publicDir")."/index.html")) {
+			$index = Console::getHumanReadablePath(Config::getOption("publicDir")).DIRECTORY_SEPARATOR."index.html";
+			Console::writeError("<path>".$index."</path> is missing. grab a copy from your StyleguideKit...");
+		}
+		
 		// set-up the dispatcher
 		$dispatcherInstance = Dispatcher::getInstance();
 
@@ -121,7 +128,7 @@ protected function generateIndex() {
 
 		// double-check that the data directory exists
 		if (!is_dir($dataDir)) {
-			mkdir($dataDir);
+			FileUtil::makeDir($dataDir);
 		}
 
 		$output = "";
@@ -236,7 +243,7 @@ protected function generatePatterns($options = array()) {
 		$store = PatternData::get();
 		foreach ($store as $patternStoreKey => $patternStoreData) {
 
-			if (($patternStoreData["category"] == "pattern") && (!$patternStoreData["hidden"])) {
+			if (($patternStoreData["category"] == "pattern") && isset($patternStoreData["hidden"]) && (!$patternStoreData["hidden"])) {
 
 				$path          = $patternStoreData["pathDash"];
 				$pathName      = (isset($patternStoreData["pseudo"])) ? $patternStoreData["pathOrig"] : $patternStoreData["pathName"];

src/PatternLab/Config.php

@@ -202,6 +202,7 @@ public static function init($baseDir = "", $verbose = true) {
 
 		// set-up the various dirs
 		self::$options["configDir"]         = self::$userConfigDir;
+		self::$options["configPath"]        = self::$userConfigPath;
 		self::$options["coreDir"]           = is_dir(self::$options["baseDir"]."_core") ? self::$options["baseDir"]."_core" : self::$options["baseDir"]."core";
 		self::$options["exportDir"]         = isset(self::$options["exportDir"])   ? self::$options["baseDir"].self::cleanDir(self::$options["exportDir"])   : self::$options["baseDir"]."exports";
 		self::$options["publicDir"]         = isset(self::$options["publicDir"])   ? self::$options["baseDir"].self::cleanDir(self::$options["publicDir"])   : self::$options["baseDir"]."public";
@@ -218,22 +219,9 @@ public static function init($baseDir = "", $verbose = true) {
 			self::$options["styleguideKitPath"] = self::$options["baseDir"].self::cleanDir(self::getStyleguideKitPath(self::$options["styleguideKitPath"]));
 		}
 
-		// double-check a few directories are real
-		// refactor this at some point. it's verbose
-		if (!isset(self::$options["sourceDir"])) {
-			Console::writeError("please make sure sourceDir is set in <path>./config/config.yml</path> by adding 'sourceDir=some/path'. sorry, stopping pattern lab... :(");
-		} else if (!is_dir(self::$options["sourceDir"])) {
-			Console::writeError("hrm... i can't seem to find the directory with your source files. are you sure they're at <path>".Console::getHumanReadablePath(self::$options["sourceDir"])."</path>? you can fix this in <path>./config/config.yml</path> by editing sourceDir. sorry, stopping pattern lab... :(");
-		}
-		if (!isset(self::$options["publicDir"])) {
-			Console::writeError("please make sure publicDir is set in <path>./config/config.yml</path> by adding 'publicDir=some/path'. sorry, stopping pattern lab... :(");
-		} else if (!is_dir(self::$options["publicDir"])) {
-			Console::writeError("hrm... i can't seem to find the directory where you want to write your styleguide. are you sure it's at <path>".Console::getHumanReadablePath(self::$options["sourceDir"])."</path>? you can fix this in <path>./config/config.yml</path> by editing publicDir. sorry, stopping pattern lab... :(");
-		}
-		if (isset(self::$options["styleguideKitPath"]) && !is_dir(self::$options["styleguideKitPath"])) {
-			Console::writeError("hrm... i can't seem to find the directory where your styleguide files are located. are you sure it's at <path>".Console::getHumanReadablePath(self::$options["styleguideKitPath"])."</path>? you can fix this in <path>./config/config.yml</path> by editing styleguideKitPath. sorry, stopping pattern lab... :(");
-		}
-		
+		// double-check a few directories are real and set-up
+		FileUtil::checkPathFromConfig(self::$options["sourceDir"], self::$userConfigPath, "sourceDir");
+		FileUtil::checkPathFromConfig(self::$options["publicDir"], self::$userConfigPath, "publicDir");
 
 		// make sure styleguideExcludes is set to an array even if it's empty
 		if (is_string(self::$options["styleGuideExcludes"])) {
@@ -341,9 +329,16 @@ public static function updateConfigOption($optionName,$optionValue, $force = fal
 		if (is_string($optionValue) && strpos($optionValue,"<prompt>") !== false) {
 
 			// prompt for input using the supplied query
-			$prompt  = str_replace("</prompt>","",str_replace("<prompt>","",$optionValue));
 			$options = "";
-			$input   = Console::promptInput($prompt,$options,false);
+			$default = "";
+			$prompt  = str_replace("</prompt>","",str_replace("<prompt>","",$optionValue));
+			if (strpos($prompt, "<default>") !== false) {
+				$default = explode("<default>",$prompt);
+				$default = explode("</default>",$default[1]);
+				$default = $default[0];
+			}
+			
+			$input = Console::promptInput($prompt,$options,$default,false);
 
 			self::writeUpdateConfigOption($optionName,$input);
 			Console::writeTag("ok","config option ".$optionName." updated...", false, true);
@@ -364,7 +359,7 @@ public static function updateConfigOption($optionName,$optionValue, $force = fal
 				// prompt for input
 				$prompt  = "update the config option <desc>".$optionName." (".$currentOptionValue.")</desc> with the value <desc>".$newOptionValue."</desc>?";
 				$options = "Y/n";
-				$input   = Console::promptInput($prompt,$options);
+				$input   = Console::promptInput($prompt,$options,"Y");
 
 				if ($input == "y") {
 					self::writeUpdateConfigOption($optionName,$optionValue);

src/PatternLab/Console.php

@@ -367,7 +367,8 @@ public static function writeHelpCommand($command = "") {
 		$lengthLong = 0;
 		foreach ($commandOptions as $option => $attributes) {
 			$optionShort = (!empty($attributes["optionShort"][0]) && (($attributes["optionShort"][0] != "z") || ($attributes["optionShort"] != ""))) ? "|-".$attributes["optionShort"] : "";
-			$optionList .= "[--".$attributes["optionLong"].$optionShort."] ";
+			$optionExtra = (!empty($attributes["optionExtra"])) ? " ".$attributes["optionExtra"] : "";
+			$optionList .= "[--".$attributes["optionLong"].$optionShort.$optionExtra."] ";
 			$lengthLong = ($attributes["optionLongLength"] > $lengthLong) ? $attributes["optionLongLength"] : $lengthLong;
 		}
 
@@ -382,7 +383,7 @@ public static function writeHelpCommand($command = "") {
 		self::writeLine("");
 		self::writeLine("<h1>".$commandLongUC." Command Options</h1>",true,true);
 		self::writeLine("<h2>Usage</h2>:",true,true);
-		self::writeLine("  php ".self::$self." --".$commandLong.$commandShortInc." ".$commandExampleList.$optionList,true,true);
+		self::writeLine("  php ".self::$self." --".$commandLong.$commandShortInc." ".$optionList,true,true);
 
 		// write out the available options
 		if (count($commandOptions) > 0) {
@@ -531,12 +532,13 @@ public static function writeWarning($line,$doubleSpace = false,$doubleBreak = fa
 	* Prompt the user for some input
 	* @param  {String}        the text for the prompt
 	* @param  {String}        the text for the options
+	* @param  {String}        the text for the default option
 	* @param  {Boolean}       if we should lowercase the input before sending it back
 	* @param  {String}        the tag that should be used when drawing the content
 	*
 	* @return {String}        trimmed input given by the user
 	*/
-	public static function promptInput($prompt = "", $options = "", $lowercase = true, $tag = "info") {
+	public static function promptInput($prompt = "", $options = "", $default = "", $lowercase = true, $tag = "info") {
 
 		// check prompt
 		if (empty($prompt)) {
@@ -551,11 +553,20 @@ public static function promptInput($prompt = "", $options = "", $lowercase = tru
 		// make sure no end-of-line is added
 		$prompt .= " <nophpeol>";
 
-		// open the terminal and wait for feedback
-		$stdin = fopen("php://stdin", "r");
-		Console::writeTag($tag,$prompt);
-		$input = trim(fgets($stdin));
-		fclose($stdin);
+		// make sure we're not running in no interaction mode. if so just use the default for the input
+		if (InstallerUtil::$isInteractive) {
+			
+			// open the terminal and wait for feedback
+			$stdin = fopen("php://stdin", "r");
+			Console::writeTag($tag,$prompt);
+			$input = trim(fgets($stdin));
+			fclose($stdin);
+			
+		} else {
+			
+			$input = $default;
+			
+		}
 
 		// check to see if it should be lowercased before sending back
 		return ($lowercase) ? strtolower($input) : $input;

src/PatternLab/Console/Commands/ServerCommand.php

@@ -26,8 +26,9 @@ public function __construct() {
 		Console::setCommand($this->command,"Start the PHP-based server","The server command will start PHP's web server for you.","s");
 		Console::setCommandOption($this->command,"host:","Provide a custom hostname. Default value is <path>localhost</path>.","To use a custom hostname and the default port:","","<host>");
 		Console::setCommandOption($this->command,"port:","Provide a custom port. Default value is <path>8080</path>.","To use a custom port and the default hostname:","","<port>");
+		Console::setCommandOption($this->command,"quiet","Turn on quiet mode for the server.","To turn on quiet mode:");
 		Console::setCommandSample($this->command,"To provide both a custom hostname and port:","--host <host> --port <port>");
-		
+
 	}
 
 	public function run() {
@@ -48,9 +49,20 @@ public function run() {
 			$port = Console::findCommandOptionValue("port");
 			$host = $port ? $host.":".$port : $host.":8080";
 
+			$null = Console::findCommandOption("quiet");
+			$null = $null ? " >& /dev/null" : "";
+			
+			$php  = isset($_SERVER["_"]) ? $_SERVER["_"] : Config::getOption("phpBin");
+			
+			if (!$php) {
+				$configPath = Console::getHumanReadablePath(Config::getOption("configPath"));
+				Console::writeError("please add the option `phpBin` with the path to PHP to <path>".$configPath."</path> before running the server...");
+			}
+			
 			// start-up the server with the router
 			Console::writeInfo("server started on http://".$host." - use ctrl+c to exit...");
-			passthru("cd ".$publicDir." && ".$_SERVER["_"]." -S ".$host." ".$coreDir."/server/router.php");
+			
+			passthru("cd ".$publicDir." && ".$php." -S ".$host." ".$coreDir."/server/router.php".$null);
 
 		}
 

src/PatternLab/Fetch.php

@@ -91,8 +91,8 @@ public function fetchStarterKit($starterkit = "") {
 		Console::writeInfo("finished downloading the starterkit...");
 
 		// make sure the temp dir exists before copying into it
-		if (!is_dir($tempDirSK)) { 
-			mkdir($tempDirSK); 
+		if (!is_dir($tempDirSK)) {
+			mkdir($tempDirSK);
 		}
 
 		// extract, if the zip is supposed to be unpacked do that (e.g. stripdir)
@@ -195,7 +195,7 @@ protected function mirrorDist($sourceDir, $tempDirDist) {
 
 			$prompt    = "a starterkit is already installed. merge the new files with it or replace it?";
 			$options   = "M/r";
-			$input     = Console::promptInput($prompt,$options);
+			$input     = Console::promptInput($prompt,$options,"M");
 			$fsOptions = ($input == "r") ? array("delete" => true, "override" => true) : array("delete" => false, "override" => false);
 
 		}

src/PatternLab/FileUtil.php

@@ -20,10 +20,42 @@
 use \Symfony\Component\Filesystem\Exception\IOExceptionInterface;
 
 class FileUtil {
-
+	
+	/**
+	* Check that a dir from the config exists and try to build it if needed
+	* @param  {String}       directory to be checked/built
+	* @param  {String}       the config path
+	* @param  {String}       the config option that would help them
+	*/
+	public static function checkPathFromConfig($path, $configPath, $configOption = "") {
+		
+		if (!isset($path)) {
+			Console::writeError("please make sure ".$configOption." is set in <path>".Console::getHumanReadablePath($configPath)."</path> by adding '".$configOption."=some/path'. sorry, stopping pattern lab... :(");
+		} else if (!is_dir($path)) {
+			Console::writeWarning("i can't seem to find the directory <path>".Console::getHumanReadablePath($path)."</path>...");
+			self::makeDir($path);
+			Console::writeWarning("i created <path>".Console::getHumanReadablePath($path)."</path> just in case. you can edit this in <path>".Console::getHumanReadablePath($configPath)."</path> by editing ".$configOption."...");
+		}
+		
+	}
+	
+	/**
+	* Make a directory
+	* @param  {String}       directory to be made
+	*/
+	public static function makeDir($dir) {
+		$fs = new Filesystem();
+		try {
+			$fs->mkdir($dir);
+		} catch (IOExceptionInterface $e) {
+			Console::writeError("an error occurred while creating your directory at <path>".$e->getPath()."</path>...");
+		}
+		unset($fs);
+	}
+	
 	/**
 	* Copies a file from the given source path to the given public path.
-	* THIS IS NOT FOR PATTERNS 
+	* THIS IS NOT FOR PATTERNS
 	* @param  {String}       the source file
 	* @param  {String}       the public file
 	*/

src/PatternLab/InstallerUtil.php

@@ -14,13 +14,16 @@
 
 use \PatternLab\Config;
 use \PatternLab\Console;
+use \PatternLab\FileUtil;
 use \PatternLab\Timer;
 use \Symfony\Component\Filesystem\Filesystem;
 use \Symfony\Component\Filesystem\Exception\IOExceptionInterface;
 use \Symfony\Component\Finder\Finder;
 
 class InstallerUtil {
 
+	public static $isInteractive;
+	
 	/**
 	 * Move the component files from the package to their location in the patternlab-components dir
 	 * @param  {String/Array}   the items to create a fileList for
@@ -62,7 +65,13 @@ protected static function init() {
 		// make sure the source dir is set-up
 		$sourceDir = Config::getOption("sourceDir");
 		if (!is_dir($sourceDir)) {
-			mkdir($sourceDir);
+			FileUtil::makeDir($sourceDir);
+		}
+		
+		// make sure the public dir is set-up
+		$publicDir = Config::getOption("publicDir");
+		if (!is_dir($publicDir)) {
+			FileUtil::makeDir($publicDir);
 		}
 
 		Dispatcher::init();
@@ -477,7 +486,7 @@ protected static function pathExists($packageName,$path) {
 				// prompt for input using the supplied query
 				$prompt  = "the path <path>".$humanReadablePath."</path> already exists. merge or replace with the contents of <path>".$packageName."</path> package?";
 				$options = "M/r";
-				$input   = Console::promptInput($prompt,$options);
+				$input   = Console::promptInput($prompt,$options,"M");
 
 				if ($input == "m") {
 					Console::writeTag("ok","contents of <path>".$humanReadablePath."</path> have been merged with the package's content...", false, true);
@@ -504,7 +513,7 @@ protected static function pathExists($packageName,$path) {
 	 */
 	public static function postInstallCmd($installerInfo, $event) {
 
-		self::packagesInstall($installerInfo);
+		self::packagesInstall($installerInfo, $event);
 
 	}
 
@@ -516,7 +525,7 @@ public static function postInstallCmd($installerInfo, $event) {
 	public static function postUpdateCmd($installerInfo, $event) {
 
 		if (!$installerInfo["packagesRemove"]) {
-			self::packagesInstall($installerInfo);
+			self::packagesInstall($installerInfo, $event);
 		}
 
 	}
@@ -541,7 +550,7 @@ protected static function promptStarterKitInstall($starterKitSuggestions) {
 
 		$prompt  = "choose an option or hit return to skip:";
 		$options = "(ex. 1)";
-		$input   = Console::promptInput($prompt,$options);
+		$input   = Console::promptInput($prompt,$options,"1");
 		$result  = (int)$input - 1;
 
 		if (isset($starterKitSuggestions[$result])) {
@@ -574,7 +583,10 @@ protected static function removeDots($path) {
 	 * Handle some Pattern Lab specific tasks based on what's found in the package's composer.json file on install
 	 * @param  {Array}      the info culled from installing various pattern lab-related packages
 	 */
-	protected static function packagesInstall($installerInfo) {
+	protected static function packagesInstall($installerInfo, $event) {
+		
+		// mark if this is an interactive call or not
+		self::$isInteractive = $event->getIO()->isInteractive();
 
 		// initialize a bunch of stuff like config and console
 		self::init();

src/PatternLab/PatternData/Exporters/DataLinkExporter.php

@@ -17,27 +17,29 @@
 use \PatternLab\Timer;
 
 class DataLinkExporter extends \PatternLab\PatternData\Exporter {
-
+	
 	public function __construct($options = array()) {
-
+		
 		parent::__construct($options);
-
+		
 	}
-
+	
 	public function run() {
-
+		
 		$store = PatternData::get();
 		foreach ($store as $patternStoreKey => $patternStoreData) {
-
+			
 			if ($patternStoreData["category"] == "pattern") {
-
-				$value = "../../patterns/".$patternStoreData["pathDash"]."/".$patternStoreData["pathDash"].".html";
-				Data::setOptionLink($patternStoreKey, $value);
-
+				
+				if (isset($patternStoreData["pathDash"])) {
+					$value = "../../patterns/".$patternStoreData["pathDash"]."/".$patternStoreData["pathDash"].".html";
+					Data::setOptionLink($patternStoreKey, $value);
+				}
+				
 			}
-
+			
 		}
-
+		
 	}
-
+	
 }