Initial template namespace implementation

- Tests and assets created for each template type.
- Plates ran out of the box.
- Twig updated to use namespacing notation.
- zend-view still in progress

Author: weierophinney

src/Template/Twig.php

@@ -20,6 +20,11 @@ class Twig implements TemplateInterface
 {
     use ArrayParametersTrait;
 
+    /**
+     * @var string
+     */
+    private $suffix;
+
     /**
      * @var TwigFilesystem
      */
@@ -35,7 +40,7 @@ class Twig implements TemplateInterface
      *
      * @param TwigEnvironment $template
      */
-    public function __construct(TwigEnvironment $template = null)
+    public function __construct(TwigEnvironment $template = null, $suffix = 'html')
     {
         if (null === $template) {
             $template = $this->createTemplate($this->getDefaultLoader());
@@ -50,6 +55,7 @@ public function __construct(TwigEnvironment $template = null)
 
         $this->template   = $template;
         $this->twigLoader = $loader;
+        $this->suffix     = is_string($suffix) ? $suffix : 'html';
     }
 
     /**
@@ -82,6 +88,7 @@ private function getDefaultLoader()
      */
     public function render($name, $params = [])
     {
+        $name   = $this->normalizeTemplate($name);
         $params = $this->normalizeParams($params);
         return $this->template->render($name, $params);
     }
@@ -115,4 +122,23 @@ public function getPaths()
         }
         return $paths;
     }
+
+    /**
+     * Normalize namespaced template.
+     *
+     * Normalizes templates in the format "namespace::template" to
+     * "@namespace/template".
+     *
+     * @param string $template
+     * @return string
+     */
+    public function normalizeTemplate($template)
+    {
+        $template = preg_replace('#^([^:]+)::(.*)$#', '@$1/$2', $template);
+        if (! preg_match('#\.[a-z]+$#i', $template)) {
+            return sprintf('%s.%s', $template, $this->suffix);
+        }
+
+        return $template;
+    }
 }

test/Template/PlatesTest.php

@@ -160,4 +160,18 @@ public function testCanRenderWithParameterObjects($params, $search)
         $content = str_replace('<?=$this->e($name)?>', $search, $content);
         $this->assertEquals($content, $result);
     }
+
+    /**
+     * @group namespacing
+     */
+    public function testProperlyResolvesNamespacedTemplate()
+    {
+        $template = new PlatesTemplate();
+        $template->addPath(__DIR__ . '/TestAsset/test', 'test');
+
+        $expected = file_get_contents(__DIR__ . '/TestAsset/test/test.php');
+        $test     = $template->render('test::test');
+
+        $this->assertSame($expected, $test);
+    }
 }

test/Template/TestAsset/test/test.html

@@ -0,0 +1,3 @@
+<h1>Twig Test Namespace</h1>
+
+<p>This template is from the test namespace.</p>

test/Template/TestAsset/test/test.js

@@ -0,0 +1,3 @@
+{
+  "test": "twig"
+}

test/Template/TestAsset/test/test.php

@@ -0,0 +1,3 @@
+<h1>Plates Test Namespace</h1>
+
+<p>This template is from the test namespace.</p>

test/Template/TestAsset/test/test.phtml

@@ -0,0 +1,3 @@
+<h1>zend-view Test Namespace</h1>
+
+<p>This template is from the test namespace.</p>

test/Template/TwigTest.php

@@ -143,4 +143,32 @@ public function testCanRenderWithParameterObjects($params, $search)
         $content = str_replace('{{ name }}', $search, $content);
         $this->assertEquals($content, $result);
     }
+
+    /**
+     * @group namespacing
+     */
+    public function testProperlyResolvesNamespacedTemplate()
+    {
+        $template = new TwigTemplate();
+        $template->addPath(__DIR__ . '/TestAsset/test', 'test');
+
+        $expected = file_get_contents(__DIR__ . '/TestAsset/test/test.html');
+        $test     = $template->render('test::test');
+
+        $this->assertSame($expected, $test);
+    }
+
+    /**
+     * @group namespacing
+     */
+    public function testResolvesNamespacedTemplateWithSuffix()
+    {
+        $template = new TwigTemplate();
+        $template->addPath(__DIR__ . '/TestAsset/test', 'test');
+
+        $expected = file_get_contents(__DIR__ . '/TestAsset/test/test.js');
+        $test     = $template->render('test::test.js');
+
+        $this->assertSame($expected, $test);
+    }
 }

test/Template/ZendViewTest.php

@@ -224,4 +224,18 @@ public function testCanPassViewModelForLayoutParameterWhenRendering()
         $this->assertContains($content, $result);
         $this->assertContains('<title>ALTERNATE LAYOUT PAGE</title>', $result);
     }
+
+    /**
+     * @group namespacing
+     */
+    public function testProperlyResolvesNamespacedTemplate()
+    {
+        $template = new ZendView();
+        $template->addPath(__DIR__ . '/TestAsset/test', 'test');
+
+        $expected = file_get_contents(__DIR__ . '/TestAsset/test/test.phtml');
+        $test     = $template->render('test::test');
+
+        $this->assertSame($expected, $test);
+    }
 }