Merge pull request #118 from funkjedi/feature-whitespace-control

Implement whitespace control for variables

Author: sanmai

src/Liquid/AbstractBlock.php

@@ -26,6 +26,11 @@ class AbstractBlock extends AbstractTag
 	 */
 	protected $nodelist = array();
 
+	/**
+	 * @var bool
+	 */
+	protected static $trimWhitespace = false;
+
 	/**
 	 * @return array
 	 */
@@ -45,7 +50,7 @@ public function getNodelist()
 	public function parse(array &$tokens)
 	{
 		$startRegexp = new Regexp('/^' . Liquid::get('TAG_START') . '/');
-		$tagRegexp = new Regexp('/^' . Liquid::get('TAG_START') . '\s*(\w+)\s*(.*?)' . Liquid::get('TAG_END') . '$/');
+		$tagRegexp = new Regexp('/^' . Liquid::get('TAG_START') . Liquid::get('WHITESPACE_CONTROL') . '?\s*(\w+)\s*(.*?)' . Liquid::get('WHITESPACE_CONTROL') . '?' . Liquid::get('TAG_END') . '$/');
 		$variableStartRegexp = new Regexp('/^' . Liquid::get('VARIABLE_START') . '/');
 
 		$this->nodelist = array();
@@ -56,6 +61,7 @@ public function parse(array &$tokens)
 			$token = array_shift($tokens);
 
 			if ($startRegexp->match($token)) {
+				$this->whitespaceHandler($token);
 				if ($tagRegexp->match($token)) {
 					// If we found the proper block delimitor just end parsing here and let the outer block proceed
 					if ($tagRegexp->matches[1] == $this->blockDelimiter()) {
@@ -83,15 +89,38 @@ public function parse(array &$tokens)
 					throw new ParseException("Tag $token was not properly terminated (won't match $tagRegexp)");
 				}
 			} elseif ($variableStartRegexp->match($token)) {
+				$this->whitespaceHandler($token);
 				$this->nodelist[] = $this->createVariable($token);
-			} elseif ($token != '') {
+			} else {
+				if (self::$trimWhitespace) {
+					$token = ltrim($token);
+				}
+
+				self::$trimWhitespace = false;
 				$this->nodelist[] = $token;
 			}
 		}
 
 		$this->assertMissingDelimitation();
 	}
 
+	/**
+	 * Handle the whitespace.
+	 *
+	 * @param string $token
+	 */
+	protected function whitespaceHandler(&$token)
+	{
+		if (mb_substr($token, 2, 1) === Liquid::get('WHITESPACE_CONTROL')) {
+			$previousToken = end($this->nodelist);
+			if (is_string($previousToken)) {
+				$this->nodelist[key($this->nodelist)] = rtrim($previousToken);
+			}
+		}
+
+		self::$trimWhitespace = (mb_substr($token, -3, 1) === Liquid::get('WHITESPACE_CONTROL'));
+	}
+
 	/**
 	 * Render the block.
 	 *
@@ -214,7 +243,7 @@ private function blockName()
 	 */
 	private function createVariable($token)
 	{
-		$variableRegexp = new Regexp('/^' . Liquid::get('VARIABLE_START') . '(.*)' . Liquid::get('VARIABLE_END') . '$/');
+		$variableRegexp = new Regexp('/^' . Liquid::get('VARIABLE_START') . Liquid::get('WHITESPACE_CONTROL') . '?(.*?)' . Liquid::get('WHITESPACE_CONTROL') . '?' . Liquid::get('VARIABLE_END') . '$/');
 		if ($variableRegexp->match($token)) {
 			return new Variable($variableRegexp->matches[1]);
 		}

src/Liquid/Liquid.php

@@ -52,11 +52,14 @@ class Liquid
 		// Prefix for include files.
 		'INCLUDE_PREFIX' => '_',
 
+		// Whitespace control.
+		'WHITESPACE_CONTROL' => '-',
+
 		// Tag start.
-		'TAG_START' => '(?:{%|\s*{%-)',
+		'TAG_START' => '{%',
 
 		// Tag end.
-		'TAG_END' => '(?:%}|-%}\s*)',
+		'TAG_END' => '%}',
 
 		// Variable start.
 		'VARIABLE_START' => '{{',

tests/Liquid/fixtures/whitespace-control.html

@@ -1,6 +1,7 @@
 --
 
 
-  Wow, John G. Chalmers-Smith, you have a long name!
+  Wow,
+  	John G. Chalmers-Smith, you have a long name!
 
---Wow, John G. Chalmers-Smith, you have a long name!--
+--Wow,John G. Chalmers-Smith, you have a long name!--

tests/Liquid/fixtures/whitespace-control.liquid

@@ -1,14 +1,16 @@
 --
 {% assign username = "John G. Chalmers-Smith" %}
 {% if username and username.size > 10 %}
-  Wow, {{ username }}, you have a long name!
+  Wow,
+  	{{ username }}, you have a long name!
 {% else %}
   Hello there!
 {% endif %}
 --
 {%- assign username = "John G. Chalmers-Smith" -%}
 {%- if username and username.size > 10 -%}
-  Wow, {{ username }}, you have a long name!
+  Wow,
+  	{{- username -}}, you have a long name!
 {%- else -%}
   Hello there!
 {%- endif -%}