Level-2 / Transphporm

src/SheetLoader.php

Doc Comments +15 added lines

@@ -15,6 +15,9 @@ 
     private $rules;
     private $cacheName;
 
+    /**
+     * @param string $tss
+     */
     public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
     	$this->cache = $cache;
         $this->filePath = $filePath;
@@ -99,6 +102,9 @@ 
 		return $rules;
     }
 
+	/**
+	 * @param Template $template
+	 */
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($this->tss, $config->getCssToXpath(), $config->getValueParser());
 
@@ -113,6 +119,11 @@ 
 	}
 
 	//Load the TSS
+
+	/**
+	 * @param Parser\CssToXpath $cssToXpath
+	 * @param Parser\Value $valueParser
+	 */
 	public function getRules($tss, $cssToXpath, $valueParser, $indexStart = 0) {
 		if (is_file($tss)) {
     		//$rules = $this->cache->load($tss);
@@ -124,6 +135,10 @@ 
 		return $tss == null ? [] : (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse($indexStart);
 	}
 	//Process a TSS rule e.g. `ul li {content: "foo"; format: bar}
+
+	/**
+	 * @param Config $config
+	 */
 	private function executeTssRule($rule, $template, $config) {
 		$rule->touch();
 

Indentation +20 added lines, -20 removed lines

@@ -7,21 +7,21 @@ 
 namespace Transphporm;
 //Separates out TSS file loading/caching from parsing
 class SheetLoader {
-    private $cache;
-    private $sheet;
-    private $time;
-    private $import = [];
-    private $cacheKey;
-    private $rules;
-    private $cacheName;
-
-    public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
-    	$this->cache = $cache;
-        $this->filePath = $filePath;
-        $this->tss = $tss;
-        $this->time = $time ?? time();
-        $this->cacheName = $tss;
-    }
+	private $cache;
+	private $sheet;
+	private $time;
+	private $import = [];
+	private $cacheKey;
+	private $rules;
+	private $cacheName;
+
+	public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
+		$this->cache = $cache;
+		$this->filePath = $filePath;
+		$this->tss = $tss;
+		$this->time = $time ?? time();
+		$this->cacheName = $tss;
+	}
 
 	private function getRulesFromCache($file) {
 		//Try to load the cached rules, if not set in the cache (or expired) parse the supplied sheet
@@ -90,14 +90,14 @@ 
 	}
 
 	//write the sheet to cache
-    public function write($file, $rules, $imports = []) {
+	public function write($file, $rules, $imports = []) {
 		if (is_file($file)) {
 			$existing = $this->cache->load($file, filemtime($file));
 			if (isset($existing['import']) && empty($imports)) $imports = $existing['import'];
 			$this->cache->write($this->cacheName, ['rules' => $rules, 'import' => $imports, 'minFreq' => $this->getMinUpdateFreq($rules), 'ctime' => $this->time, 'cacheKey' => $this->cacheKey]);
 		}
 		return $rules;
-    }
+	}
 
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($this->tss, $config->getCssToXpath(), $config->getValueParser());
@@ -115,12 +115,12 @@ 
 	//Load the TSS
 	public function getRules($tss, $cssToXpath, $valueParser, $indexStart = 0) {
 		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 $tss == null ? [] : (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse($indexStart);
 	}
 	//Process a TSS rule e.g. `ul li {content: "foo"; format: bar}

Spacing +4 added lines, -4 removed lines

@@ -46,7 +46,7 @@ 
 	public function updateRequired($data) {
 		if (!is_file($this->tss)) return true;
 
-		$this->cacheName = $this->getCacheKey($data) . $this->tss;
+		$this->cacheName = $this->getCacheKey($data).$this->tss;
 
 		$rules = $this->getRulesFromCache($this->tss, $data);
 		//Nothing was cached or the TSS file has changed, update is required
@@ -82,8 +82,8 @@ 
 		if (is_file($this->tss)) $this->getRulesFromCache($this->tss);
 		if ($this->cacheKey) {
 			$parser = new Parser\Value($data);
-			$x= $parser->parseTokens($this->cacheKey)[0];
-			$this->cacheName = $x . $this->tss;
+			$x = $parser->parseTokens($this->cacheKey)[0];
+			$this->cacheName = $x.$this->tss;
 			return $x;
 		}
 		else return '';
@@ -146,6 +146,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 +42 added lines, -15 removed lines

@@ -32,7 +32,9 @@ 
 		if ($rules) {
 			foreach ($rules['import'] as $file) {
 				//Check that the import file hasn't been changed since the cache was written
-				if (filemtime($file) > $rules['ctime']) return false;
+				if (filemtime($file) > $rules['ctime']) {
+					return false;
+				}
 			}
 		}
 
@@ -44,16 +46,22 @@ 
 	//   2. If the data hasn't changed since the last run
 	//If this function returns false, the rendered template is sent straight from the cache skipping 99% of transphporm's code
 	public function updateRequired($data) {
-		if (!is_file($this->tss)) return true;
+		if (!is_file($this->tss)) {
+			return true;
+		}
 
 		$this->cacheName = $this->getCacheKey($data) . $this->tss;
 
 		$rules = $this->getRulesFromCache($this->tss, $data);
 		//Nothing was cached or the TSS file has changed, update is required
-		if (empty($rules)) return true;
+		if (empty($rules)) {
+			return true;
+		}
 
 		//Find the sheet's minimum update-frequency, if it hasn't passed then no updates are required
-		if ($rules['ctime']+$rules['minFreq'] <= $this->time) return true;
+		if ($rules['ctime']+$rules['minFreq'] <= $this->time) {
+			return true;
+		}
 
 		return false;
 	}
@@ -64,7 +72,9 @@ 
 
 		foreach ($rules as $rule) {
 			$ruleFreq = $rule->getUpdateFrequency();
-			if ($ruleFreq < $min) $min = $ruleFreq;
+			if ($ruleFreq < $min) {
+				$min = $ruleFreq;
+			}
 		}
 
 		return $min;
@@ -79,21 +89,26 @@ 
 	}
 
 	public function getCacheKey($data) {
-		if (is_file($this->tss)) $this->getRulesFromCache($this->tss);
+		if (is_file($this->tss)) {
+			$this->getRulesFromCache($this->tss);
+		}
 		if ($this->cacheKey) {
 			$parser = new Parser\Value($data);
 			$x= $parser->parseTokens($this->cacheKey)[0];
 			$this->cacheName = $x . $this->tss;
 			return $x;
+		} else {
+			return '';
 		}
-		else return '';
 	}
 
 	//write the sheet to cache
     public function write($file, $rules, $imports = []) {
 		if (is_file($file)) {
 			$existing = $this->cache->load($file, filemtime($file));
-			if (isset($existing['import']) && empty($imports)) $imports = $existing['import'];
+			if (isset($existing['import']) && empty($imports)) {
+				$imports = $existing['import'];
+			}
 			$this->cache->write($this->cacheName, ['rules' => $rules, 'import' => $imports, 'minFreq' => $this->getMinUpdateFreq($rules), 'ctime' => $this->time, 'cacheKey' => $this->cacheKey]);
 		}
 		return $rules;
@@ -106,10 +121,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
@@ -118,8 +137,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 $tss == null ? [] : (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse($indexStart);
 	}
@@ -136,10 +158,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;
 	}