Level-2 / Transphporm

src/Builder.php

Doc Comments +4 added lines

@@ -74,6 +74,10 @@
 
 
 	//Add a postprocessing hook. This cleans up anything transphporm has added to the markup which needs to be removed
+
+	/**
+	 * @param Template $template
+	 */
 	private function doPostProcessing($template) {
 		$template->addHook('//*[@transphporm]', new Hook\PostProcess());
 		return $template;

Indentation +8 added lines, -8 removed lines

@@ -41,9 +41,9 @@ 
 	}
 
 	public function setLocale($locale) {
-                $format = new \Transphporm\Module\Format($locale);
-                $this->modules[get_class($format)] = $format;
-        }
+				$format = new \Transphporm\Module\Format($locale);
+				$this->modules[get_class($format)] = $format;
+		}
 
 	public function addPath($dir) {
 		$this->filePath->addPath($dir);
@@ -82,15 +82,15 @@ 
 
 	//Load a template, firstly check if it's a file or a valid string
 	private function loadTemplate() {
-        $result = ['body' => $this->template, 'headers' => []];
+		$result = ['body' => $this->template, 'headers' => []];
 		if (strpos($this->template, "\n") === false && is_file($this->template)) $result = $this->loadTemplateFromFile($this->template);
 		return $result;
 	}
 
-    private function loadTemplateFromFile($file) {
-        $xml = $this->cache->load($this->template, filemtime($this->template));
-        return $xml ? $xml : ['body' => file_get_contents($this->template) ?: "", 'headers' => []];
-    }
+	private function loadTemplateFromFile($file) {
+		$xml = $this->cache->load($this->template, filemtime($this->template));
+		return $xml ? $xml : ['body' => file_get_contents($this->template) ?: "", 'headers' => []];
+	}
 
 	public function setCache(\ArrayAccess $cache) {
 		$this->cache = new Cache($cache);

Spacing +2 added lines, -2 removed lines

@@ -57,8 +57,8 @@
 
 		$cachedOutput = $this->loadTemplate();
 		//To be a valid XML document it must have a root element, automatically wrap it in <template> to ensure it does
-		$template = new Template($this->isValidDoc($cachedOutput['body']) ? str_ireplace('<!doctype', '<!DOCTYPE', $cachedOutput['body']) : '<template>' . $cachedOutput['body'] . '</template>' );
-		$tssCache = new SheetLoader($this->cache,  $this->filePath, $this->tss, $template->getPrefix(), $this->time);
+		$template = new Template($this->isValidDoc($cachedOutput['body']) ? str_ireplace('<!doctype', '<!DOCTYPE', $cachedOutput['body']) : '<template>'.$cachedOutput['body'].'</template>');
+		$tssCache = new SheetLoader($this->cache, $this->filePath, $this->tss, $template->getPrefix(), $this->time);
 		$valueParser = new Parser\Value($functionSet);
 		$this->config = new Config($functionSet, $valueParser, $elementData, new Hook\Formatter(), new Parser\CssToXpath($functionSet, $template->getPrefix(), md5($this->tss)), $this->filePath, $headers);
 

Braces +12 added lines, -4 removed lines

@@ -27,7 +27,9 @@ 
 		$this->cache = new Cache(new \ArrayObject());
 		$this->filePath = new FilePath();
 		$modules = is_array($modules) ? $modules : $this->defaultModules;
-		foreach ($modules as $module) $this->loadModule(new $module);
+		foreach ($modules as $module) {
+			$this->loadModule(new $module);
+		}
 	}
 
 	//Allow setting the time used by Transphporm for caching. This is for testing purposes
@@ -62,7 +64,9 @@ 
 		$valueParser = new Parser\Value($functionSet);
 		$this->config = new Config($functionSet, $valueParser, $elementData, new Hook\Formatter(), new Parser\CssToXpath($functionSet, $template->getPrefix(), md5($this->tss)), $this->filePath, $headers);
 
-		foreach ($this->modules as $module) $module->load($this->config);
+		foreach ($this->modules as $module) {
+			$module->load($this->config);
+		}
 
 		$tssCache->processRules($template, $this->config);
 
@@ -83,7 +87,9 @@ 
 	//Load a template, firstly check if it's a file or a valid string
 	private function loadTemplate() {
         $result = ['body' => $this->template, 'headers' => []];
-		if (strpos($this->template, "\n") === false && is_file($this->template)) $result = $this->loadTemplateFromFile($this->template);
+		if (strpos($this->template, "\n") === false && is_file($this->template)) {
+			$result = $this->loadTemplateFromFile($this->template);
+		}
 		return $result;
 	}
 
@@ -102,6 +108,8 @@ 
 
 	public function __destruct() {
 		//Required hack as DomXPath can only register static functions clear the statically stored instance to avoid memory leaks
-		if (isset($this->config)) $this->config->getCssToXpath()->cleanup();
+		if (isset($this->config)) {
+			$this->config->getCssToXpath()->cleanup();
+		}
 	}
 }

src/Parser/Sheet.php

Doc Comments +10 added lines

@@ -30,6 +30,9 @@ 
 		return $rules;
 	}
 
+	/**
+	 * @param integer $indexStart
+	 */
 	private function parseTokens($indexStart) {
 		$this->rules = [];
 		foreach (new TokenFilterIterator($this->tss, [Tokenizer::WHITESPACE]) as $token) {
@@ -55,6 +58,10 @@ 
 		if (empty($rules) && count($this->tss) > 0) throw new \Exception('No TSS rules parsed');
 	}
 
+	/**
+	 * @param Tokens $selector
+	 * @param integer $index
+	 */
 	private function CssToRules($selector, $index, $properties, $line) {
 		$parts = $selector->trim()->splitOnToken(Tokenizer::ARG);
 		$rules = [];
@@ -78,6 +85,9 @@ 
 		return $rules;
 	}
 
+	/**
+	 * @param integer $indexStart
+	 */
 	private function processingInstructions($token, $indexStart) {
 		if ($token['type'] !== Tokenizer::AT_SIGN) return false;
 		$tokens = $this->tss->from(Tokenizer::AT_SIGN, false)->to(Tokenizer::SEMI_COLON, false);

Braces +14 added lines, -5 removed lines

@@ -24,7 +24,9 @@ 
 	}
 
 	public function parse($indexStart = 0) {
-		if (!empty($this->rules)) return $this->rules['rules'];
+		if (!empty($this->rules)) {
+			return $this->rules['rules'];
+		}
 		$rules = $this->parseTokens($indexStart);
 		$this->checkError($rules);
 		return $rules;
@@ -35,8 +37,9 @@ 
 		foreach (new TokenFilterIterator($this->tss, [Tokenizer::WHITESPACE]) as $token) {
 			if ($processing = $this->processingInstructions($token, count($this->rules)+$indexStart)) {
 				$this->rules = array_merge($this->rules, $processing);
+			} else if ($token['type'] !== Tokenizer::NEW_LINE) {
+				$this->addRules($token, $indexStart++);
 			}
-			else if ($token['type'] !== Tokenizer::NEW_LINE) $this->addRules($token, $indexStart++);
 		}
 
 		return $this->rules;
@@ -46,13 +49,17 @@ 
 		$selector = $this->tss->from($token['type'], true)->to(Tokenizer::OPEN_BRACE);
 
 		$this->tss->skip(count($selector));
-		if (count($selector) === 0) return;
+		if (count($selector) === 0) {
+			return;
+		}
 		$newRules = $this->cssToRules($selector, count($this->rules)+$indexStart, $this->getProperties($this->tss->current()['value']), $token['line']);
 		$this->rules = $this->writeRule($this->rules, $newRules);
 	}
 
 	private function checkError($rules) {
-		if (empty($rules) && count($this->tss) > 0) throw new \Exception('No TSS rules parsed');
+		if (empty($rules) && count($this->tss) > 0) {
+			throw new \Exception('No TSS rules parsed');
+		}
 	}
 
 	private function CssToRules($selector, $index, $properties, $line) {
@@ -79,7 +86,9 @@ 
 	}
 
 	private function processingInstructions($token, $indexStart) {
-		if ($token['type'] !== Tokenizer::AT_SIGN) return false;
+		if ($token['type'] !== Tokenizer::AT_SIGN) {
+			return false;
+		}
 		$tokens = $this->tss->from(Tokenizer::AT_SIGN, false)->to(Tokenizer::SEMI_COLON, false);
 		$funcName = $tokens->from(Tokenizer::NAME, true)->read();
 		$args = $this->valueParser->parseTokens($tokens->from(Tokenizer::NAME));

src/SheetLoader.php

Doc Comments +16 added lines

@@ -13,6 +13,10 @@ 
     private $time;
     private $import = [];
 
+    /**
+     * @param string $tss
+     * @param string $prefix
+     */
     public function __construct(Cache $cache, FilePath $filePath, $tss, $prefix, $time) {
         $this->cache = $cache;
         $this->filePath = $filePath;
@@ -54,6 +58,9 @@ 
 		return $rules;
     }
 
+	/**
+	 * @param Template $template
+	 */
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($this->tss, $config->getCssToXpath(), $config->getValueParser());
 
@@ -67,6 +74,11 @@ 
 	}
 
 	//Load the TSS
+
+	/**
+	 * @param Parser\CssToXpath $cssToXpath
+	 * @param Parser\Value $valueParser
+	 */
 	public function getRules($tss, $cssToXpath, $valueParser) {
 		if (is_file($tss)) {
     		//$rules = $this->cache->load($tss);
@@ -79,6 +91,10 @@ 
 	}
 
 	//Process a TSS rule e.g. `ul li {content: "foo"; format: bar}
+
+	/**
+	 * @param Config $config
+	 */
 	private function executeTssRule($rule, $template, $config) {
 		$rule->touch();
 

Indentation +18 added lines, -18 removed lines

@@ -7,19 +7,19 @@ 
 namespace Transphporm;
 //Separates out TSS file loading/caching from parsing
 class SheetLoader {
-    private $cache;
-    private $prefix;
-    private $sheet;
-    private $time;
-    private $import = [];
-
-    public function __construct(Cache $cache, FilePath $filePath, $tss, $prefix, $time) {
-        $this->cache = $cache;
-        $this->filePath = $filePath;
-        $this->prefix = $prefix;
-        $this->tss = $tss;
-        $this->time = $time;
-    }
+	private $cache;
+	private $prefix;
+	private $sheet;
+	private $time;
+	private $import = [];
+
+	public function __construct(Cache $cache, FilePath $filePath, $tss, $prefix, $time) {
+		$this->cache = $cache;
+		$this->filePath = $filePath;
+		$this->prefix = $prefix;
+		$this->tss = $tss;
+		$this->time = $time;
+	}
 
 	private function getRulesFromCache($file) {
 		//The cache for the key: the filename and template prefix
@@ -44,7 +44,7 @@ 
 		return $file . $this->prefix . dirname(realpath($file)) . DIRECTORY_SEPARATOR;
 	}
 	//write the sheet to cache
-    public function write($file, $rules, $imports = []) {
+	public function write($file, $rules, $imports = []) {
 		if (is_file($file)) {
 			$key = $this->getCacheKey($file);
 			$existing = $this->cache->load($key, filemtime($file));
@@ -52,7 +52,7 @@ 
 			$this->cache->write($key, ['rules' => $rules, 'import' => $imports]);
 		}
 		return $rules;
-    }
+	}
 
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($this->tss, $config->getCssToXpath(), $config->getValueParser());
@@ -69,12 +69,12 @@ 
 	//Load the TSS
 	public function getRules($tss, $cssToXpath, $valueParser) {
 		if (is_file($tss)) {
-    		//$rules = $this->cache->load($tss);
-    		$rules = $this->getRulesFromCache($tss)['rules'];
+			//$rules = $this->cache->load($tss);
+			$rules = $this->getRulesFromCache($tss)['rules'];
 			$this->filePath->addPath(dirname(realpath($tss)));
 			if (empty($rules)) $tss = file_get_contents($tss);
 			else return $rules;
-    	}
+		}
 		return (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse();
 	}
 

Spacing +2 added lines, -2 removed lines

@@ -41,7 +41,7 @@ 
 	}
 
 	private function getCacheKey($file) {
-		return $file . $this->prefix . dirname(realpath($file)) . DIRECTORY_SEPARATOR;
+		return $file.$this->prefix.dirname(realpath($file)).DIRECTORY_SEPARATOR;
 	}
 	//write the sheet to cache
     public function write($file, $rules, $imports = []) {
@@ -101,6 +101,6 @@ 
 
 
 	private function sortPseudo($a, $b) {
-		return count($a->pseudo) < count($b->pseudo)  ? -1  :1;
+		return count($a->pseudo) < count($b->pseudo) ? -1 : 1;
 	}
 }

Braces +25 added lines, -9 removed lines

@@ -30,7 +30,9 @@ 
 		$rules = $this->cache->load($key, filemtime($file));
 		if ($rules) {
 			foreach ($rules['import'] as $file) {
-				if (!$this->cache->load($this->getCacheKey($file), filemtime($file))) return false;
+				if (!$this->cache->load($this->getCacheKey($file), filemtime($file))) {
+					return false;
+				}
 			}
 		}
 		return $rules;
@@ -48,7 +50,9 @@ 
 		if (is_file($file)) {
 			$key = $this->getCacheKey($file);
 			$existing = $this->cache->load($key, filemtime($file));
-			if (isset($existing['import']) && empty($imports)) $imports = $existing['import'];
+			if (isset($existing['import']) && empty($imports)) {
+				$imports = $existing['import'];
+			}
 			$this->cache->write($key, ['rules' => $rules, 'import' => $imports]);
 		}
 		return $rules;
@@ -60,10 +64,14 @@ 
 		usort($rules, [$this, 'sortRules']);
 
 		foreach ($rules as $rule) {
-			if ($rule->shouldRun($this->time)) $this->executeTssRule($rule, $template, $config);
+			if ($rule->shouldRun($this->time)) {
+				$this->executeTssRule($rule, $template, $config);
+			}
 		}
 
-		if (is_file($this->tss)) $this->write($this->tss, $rules, $this->import);
+		if (is_file($this->tss)) {
+			$this->write($this->tss, $rules, $this->import);
+		}
 	}
 
 	//Load the TSS
@@ -72,8 +80,11 @@ 
     		//$rules = $this->cache->load($tss);
     		$rules = $this->getRulesFromCache($tss)['rules'];
 			$this->filePath->addPath(dirname(realpath($tss)));
-			if (empty($rules)) $tss = file_get_contents($tss);
-			else return $rules;
+			if (empty($rules)) {
+				$tss = file_get_contents($tss);
+			} else {
+				return $rules;
+			}
     	}
 		return (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse();
 	}
@@ -91,10 +102,15 @@ 
 
 	private function sortRules($a, $b) {
 		//If they have the same depth, compare on index
-		if ($a->query === $b->query) return $this->sortPseudo($a, $b);
+		if ($a->query === $b->query) {
+			return $this->sortPseudo($a, $b);
+		}
 
-		if ($a->depth === $b->depth) $property = 'index';
-		else $property = 'depth';
+		if ($a->depth === $b->depth) {
+			$property = 'index';
+		} else {
+			$property = 'depth';
+		}
 
 		return ($a->$property < $b->$property) ? -1 : 1;
 	}