Merge branch 'master' into dev

Author: dmolsen

README.md

@@ -76,11 +76,12 @@ Would be used like this in a pattern:
 
 ### Template inheritance
 
-The requirements for using template inheritance with Pattern Lab:
+How to use [Template Inheritance](http://twig.sensiolabs.org/doc/templates.html#template-inheritance) with Pattern Lab:
 
-* Files must go in `source/_layouts`
-* Files must have the extension `.twig`
-* The filename will be used as the reference in the `extends` tag
+* Files must have the extension `.twig`.
+* Files can be extended either by using Pattern Lab's normal shorthand syntax (e.g, `{% extends 'templates-extended-layout'%}`).
+* Files can optionally go in `source/_layouts` in order to hide them from the list of patterns and then you can just use the filename as reference (e.g., `{% extends 'extended-layout'%}`).
+* Files that are in the same directory can also just use the file name without the shorthand syntax (however, it must include the extension). So if `file1.twig` and `file2.twig` were in same directory, you could place this code in `file2.twig`: `{% extends 'file1.twig' %}`. 
 
 An example of a simple layout called `base.twig` in `source/_layouts`:
 
@@ -124,6 +125,8 @@ Would be used like this in a pattern:
 {% endblock %}
 ```
 
+All uses of `extends` above also work with `includes`, `embed` and most likely many other Twig Tags. Let us know if you run into interesting or unexpected use cases!
+
 ## Extending Twig Further
 
 Twig comes with a number of ways to extend the underlying template parser. You can you can add [extra tags](http://twig.sensiolabs.org/doc/advanced.html#tags), [filters](http://twig.sensiolabs.org/doc/advanced.html#filters), [tests](http://twig.sensiolabs.org/doc/advanced.html#tests), and [functions](http://twig.sensiolabs.org/doc/advanced.html#functions). The Twig PatternEngine tries to simplify these extensions by allowing you to create files in specific folders and then auto-load the extensions for you. Learn more about:

src/PatternLab/PatternEngine/Twig/Loaders/PatternLoader.php

@@ -14,7 +14,7 @@
 namespace PatternLab\PatternEngine\Twig\Loaders;
 
 use \PatternLab\Config;
-use \PatternLab\PatternEngine\Twig\IncludeNodeVisitor;
+use \PatternLab\PatternEngine\Twig\PatternDataNodeVisitor;
 use \PatternLab\PatternEngine\Twig\Loaders\Twig\PatternPartialLoader as Twig_Loader_PatternPartialLoader;
 use \PatternLab\PatternEngine\Twig\Loaders\Twig\PatternStringLoader as Twig_Loader_PatternStringLoader;
 use \PatternLab\PatternEngine\Loader;
@@ -85,7 +85,7 @@ public function __construct($options = array()) {
 		$this->instance       = TwigUtil::loadMacros($this->instance);
 
 		// add node visitor
-		$this->instance->addNodeVisitor(new IncludeNodeVisitor());
+		$this->instance->addNodeVisitor(new PatternDataNodeVisitor());
 	}
 
 	/**

src/PatternLab/PatternEngine/Twig/PatternDataEmbedNode.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace PatternLab\PatternEngine\Twig;
+
+class PatternDataEmbedNode extends \Twig_Node_Embed
+{
+    use PatternDataNodeTrait;
+
+    public function __construct(\Twig_Node_Embed $originalNode, $data)
+    {
+        parent::__construct(
+          $originalNode->getAttribute('filename'),
+          $originalNode->getAttribute('index'),
+          $originalNode->getNode('variables'),
+          $originalNode->getAttribute('only'),
+          $originalNode->getAttribute('ignore_missing'),
+          $originalNode->getLine(),
+          $originalNode->getNodeTag()
+        );
+
+        $this->data = $data;
+    }
+}

src/PatternLab/PatternEngine/Twig/PatternDataIncludeNode.php

@@ -4,37 +4,19 @@
 
 class PatternDataIncludeNode extends \Twig_Node_Include
 {
-    protected $data;
+    use PatternDataNodeTrait;
 
     public function __construct(\Twig_Node_Include $originalNode, $data)
     {
-        \Twig_Node::__construct($originalNode->nodes, $originalNode->attributes, $originalNode->lineno, $originalNode->tag);
-        $this->data = $data;
-    }
+        parent::__construct(
+          $originalNode->getNode('expr'),
+          $originalNode->getNode('variables'),
+          $originalNode->getAttribute('only'),
+          $originalNode->getAttribute('ignore_missing'),
+          $originalNode->getLine(),
+          $originalNode->getNodeTag()
+        );
 
-    protected function addTemplateArguments(\Twig_Compiler $compiler)
-    {
-        if (null === $this->getNode('variables')) {
-            if (false === $this->getAttribute('only')) {
-                $compiler
-                    ->raw('array_merge($context, ')
-                    ->repr($this->data)
-                    ->raw(')')
-                ;
-            }
-            else {
-                $compiler->raw('array()');
-            }
-        } elseif (false === $this->getAttribute('only')) {
-            $compiler
-                ->raw('array_merge($context, ')
-                ->repr($this->data)
-                ->raw(', ')
-                ->subcompile($this->getNode('variables'))
-                ->raw(')')
-            ;
-        } else {
-            $compiler->subcompile($this->getNode('variables'));
-        }
+        $this->data = $data;
     }
 }

src/PatternLab/PatternEngine/Twig/PatternDataNodeTrait.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace PatternLab\PatternEngine\Twig;
+
+trait PatternDataNodeTrait
+{
+    protected $data;
+
+    protected function addTemplateArguments(\Twig_Compiler $compiler)
+    {
+        if (null === $this->getNode('variables')) {
+            if (false === $this->getAttribute('only')) {
+                $compiler
+                    ->raw('array_merge($context, ')
+                    ->repr($this->data)
+                    ->raw(')')
+                ;
+            }
+            else {
+                $compiler->raw('array()');
+            }
+        } elseif (false === $this->getAttribute('only')) {
+            $compiler
+                ->raw('array_merge($context, ')
+                ->repr($this->data)
+                ->raw(', ')
+                ->subcompile($this->getNode('variables'))
+                ->raw(')')
+            ;
+        } else {
+            $compiler->subcompile($this->getNode('variables'));
+        }
+    }
+}

src/PatternLab/PatternEngine/Twig/IncludeNodeVisitor.php renamed to src/PatternLab/PatternEngine/Twig/PatternDataNodeVisitor.php

@@ -4,7 +4,7 @@
 
 use PatternLab\Data;
 
-class IncludeNodeVisitor extends \Twig_BaseNodeVisitor
+class PatternDataNodeVisitor extends \Twig_BaseNodeVisitor
 {
     protected function doEnterNode(\Twig_Node $node, \Twig_Environment $env)
     {
@@ -17,7 +17,12 @@ protected function doLeaveNode(\Twig_Node $node, \Twig_Environment $env)
             if ($node->hasNode('expr') && $node->getNode('expr')->hasAttribute('value')) {
                 $patternStoreKey = $node->getNode('expr')->getAttribute('value');
                 $data = Data::getPatternSpecificData($patternStoreKey);
-                $dataNode = new PatternDataIncludeNode($node, $data);
+                if ($node instanceof \Twig_Node_Embed) {
+                    $dataNode = new PatternDataEmbedNode($node, $data);
+                }
+                else {
+                    $dataNode = new PatternDataIncludeNode($node, $data);
+                }
 
                 return $dataNode;
             }