FIX Overriding of theme templates in project folder

Fixes issue of templates not being found when a Page's main/Layout templates are split between the project and theme folders. Adds more expansive testing for template loading.

core/manifest/TemplateLoader.php

@@ -80,7 +80,6 @@ class SS_TemplateLoader {
 							'main' => $found[$type]
 						);
 					}
-
 					$result = array_merge($found, $result);
 				}
 			}

core/manifest/TemplateManifest.php

@@ -110,16 +110,22 @@ class SS_TemplateManifest {
 	 * @return array
 	 */
 	public function getCandidateTemplate($name, $theme = null) {
+		$found = array();
 		$candidates = $this->getTemplate($name);
 		
-		if ($this->project && isset($candidates[$this->project])) {
+		// theme overrides modules
-			$found = $candidates[$this->project];
+		if ($theme && isset($candidates['themes'][$theme])) {
-		} else if ($theme && isset($candidates['themes'][$theme])) {
 			$found = array_merge($candidates, $candidates['themes'][$theme]);
-		} else {
-			$found = $candidates;
 		}
-		if(isset($found['themes'])) unset($found['themes']);
+		// project overrides theme
+		if ($this->project && isset($candidates[$this->project])) {
+			$found = array_merge($found, $candidates[$this->project]);
+		}
+		
+		$found = ($found) ? $found : $candidates;
+		
+		if (isset($found['themes'])) unset($found['themes']);
+		if (isset($found[$this->project])) unset($found[$this->project]);
 		
 		return $found;
 	}

tests/core/manifest/TemplateLoaderTest.php

@@ -7,63 +7,183 @@
  */
 class TemplateLoaderTest extends SapphireTest {
 	
-	public function testFindTemplates() {
+	private $base;
-		$base     = dirname(__FILE__) . '/fixtures/templatemanifest';
+	private $manifest;
-		$manifest = new SS_TemplateManifest($base, 'myproject', false, true);
+	private $loader;
-		$loader   = new SS_TemplateLoader();
 	
-		$manifest->regenerate(false);
+	/**
-		$loader->pushManifest($manifest);
+	 * Set up manifest before each test
-
+	 */
-		$expectPage = array(
+	public function setUp() {
-			'main'   => "$base/module/templates/Page.ss",
+		parent::setUp();
-			'Layout' => "$base/module/templates/Layout/Page.ss"
+		$this->base = dirname(__FILE__) . '/fixtures/templatemanifest';
-		);
+		$this->manifest = new SS_TemplateManifest($this->base, 'myproject', false, true);
-		$expectPageThemed = array(
+		$this->loader = new SS_TemplateLoader();
-			'main'   => "$base/themes/theme/templates/Page.ss",
+		$this->refreshLoader();
-			'Layout' => "$base/themes/theme/templates/Layout/Page.ss"
-		);
-
-		$this->assertEquals($expectPage, $loader->findTemplates('Page'));
-		$this->assertEquals($expectPage, $loader->findTemplates(array('Foo', 'Page')));
-		$this->assertEquals($expectPage, $loader->findTemplates('PAGE'));
-		$this->assertEquals($expectPageThemed, $loader->findTemplates('Page', 'theme'));
-
-		$expectPageLayout       = array('main' => "$base/module/templates/Layout/Page.ss");
-		$expectPageLayoutThemed = array('main' => "$base/themes/theme/templates/Layout/Page.ss");
-
-		$this->assertEquals($expectPageLayout, $loader->findTemplates('Layout/Page'));
-		$this->assertEquals($expectPageLayout, $loader->findTemplates('Layout/PAGE'));
-		$this->assertEquals($expectPageLayoutThemed, $loader->findTemplates('Layout/Page', 'theme'));
-
-		$expectCustomPage = array(
-			'main'   => "$base/module/templates/Page.ss",
-			'Layout' => "$base/module/templates/Layout/CustomPage.ss"
-		);
-
-		$this->assertEquals($expectCustomPage, $loader->findTemplates(array('CustomPage', 'Page')));
-
-		// 'main' template only exists in theme, and 'Layout' template only exists in module
-		$expectCustomThemePage = array(
-			'main'   => "$base/themes/theme/templates/CustomThemePage.ss",
-			'Layout' => "$base/module/templates/Layout/CustomThemePage.ss"
-		);
-		$this->assertEquals($expectCustomThemePage, $loader->findTemplates(array('CustomThemePage', 'Page'), 'theme'));
 	}
 	
-	public function testFindTemplatesApplicationOverridesModule() {
+	/**
-		$base     = dirname(__FILE__) . '/fixtures/templatemanifest';
+	 * Test that 'main' and 'Layout' templates are loaded from module
-		$manifest = new SS_TemplateManifest($base, 'myproject', false, true);
+	 */
-		$loader   = new SS_TemplateLoader();
+	public function testFindTemplatesInModule() {
-
+		$expect = array(
-		$manifest->regenerate(false);
+			'main'   => "$this->base/module/templates/Page.ss",
-		$loader->pushManifest($manifest);
+			'Layout' => "$this->base/module/templates/Layout/Page.ss"
-
-		$expectPage = array(
-			'main'   => "$base/myproject/templates/CustomTemplate.ss"
 		);
+		$this->assertEquals($expect, $this->loader->findTemplates('Page'));
+		$this->assertEquals($expect, $this->loader->findTemplates('PAGE'));
+		$this->assertEquals($expect, $this->loader->findTemplates(array('Foo', 'Page')));
+	}
 	
-		$this->assertEquals($expectPage, $loader->findTemplates('CustomTemplate'));
+	/**
+	 * Test that 'main' and 'Layout' templates are loaded from set theme
+	 */
+	public function testFindTemplatesInTheme() {
+		$expect = array(
+			'main'   => "$this->base/themes/theme/templates/Page.ss",
+			'Layout' => "$this->base/themes/theme/templates/Layout/Page.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates('Page', 'theme'));
+		$this->assertEquals($expect, $this->loader->findTemplates('PAGE', 'theme'));
+		$this->assertEquals($expect, $this->loader->findTemplates(array('Foo', 'Page'), 'theme'));
+	}
+	
+	/**
+	 * Test that 'main' and 'Layout' templates are loaded from project without a set theme
+	 */
+	public function testFindTemplatesInApplication() {
+		$templates = array(
+			$this->base . '/myproject/templates/Page.ss',
+			$this->base . '/myproject/templates/Layout/Page.ss'
+		);
+		$this->createTestTemplates($templates);
+		$this->refreshLoader();
+		
+		$expect = array(
+			'main'   => "$this->base/myproject/templates/Page.ss",
+			'Layout' => "$this->base/myproject/templates/Layout/Page.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates('Page'));
+		$this->assertEquals($expect, $this->loader->findTemplates('PAGE'));
+		$this->assertEquals($expect, $this->loader->findTemplates(array('Foo', 'Page')));
+		
+		$this->removeTestTemplates($templates);
+	}
+	
+	/**
+	 * Test that 'Layout' template is loaded from module
+	 */
+	public function testFindTemplatesInModuleLayout() {
+		$expect = array(
+			'main' => "$this->base/module/templates/Layout/Page.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates('Layout/Page'));
+	}
+	
+	/**
+	 * Test that 'Layout' template is loaded from theme
+	 */
+	public function testFindTemplatesInThemeLayout() {
+		$expect = array(
+			'main' => "$this->base/themes/theme/templates/Layout/Page.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates('Layout/Page', 'theme'));
+	}
+	
+	/**
+	 * Test that 'main' template is found in theme and 'Layout' is found in module
+	 */
+	public function testFindTemplatesMainThemeLayoutModule() {
+		$expect = array(
+			'main'   => "$this->base/themes/theme/templates/CustomThemePage.ss",
+			'Layout' => "$this->base/module/templates/Layout/CustomThemePage.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates(array('CustomThemePage', 'Page'), 'theme'));
+	}
+	
+	/**
+	 * Test that project template overrides module template of same name
+	 */
+	public function testFindTemplatesApplicationOverridesModule() {
+		$expect = array(
+			'main'   => "$this->base/myproject/templates/CustomTemplate.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates('CustomTemplate'));
+	}
+	
+	/**
+	 * Test that project templates overrides theme templates
+	 */
+	public function testFindTemplatesApplicationOverridesTheme() {
+		$templates = array(
+			$this->base . '/myproject/templates/Page.ss',
+			$this->base . '/myproject/templates/Layout/Page.ss'
+		);
+		$this->createTestTemplates($templates);
+		$this->refreshLoader();
+		
+		$expect = array(
+			'main'   => "$this->base/myproject/templates/Page.ss",
+			'Layout' => "$this->base/myproject/templates/Layout/Page.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates('Page'), 'theme');
+		
+		$this->removeTestTemplates($templates);
+	}
+	
+	/**
+	 * Test that project 'Layout' template overrides theme 'Layout' template
+	 */
+	public function testFindTemplatesApplicationLayoutOverridesThemeLayout() {
+		$templates = array(
+			$this->base . '/myproject/templates/Layout/Page.ss'
+		);
+		$this->createTestTemplates($templates);
+		$this->refreshLoader();
+		
+		$expect = array(
+			'main' => "$this->base/themes/theme/templates/Page.ss",
+			'Layout' => "$this->base/myproject/templates/Layout/Page.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates('Page', 'theme'));
+		
+		$this->removeTestTemplates($templates);
+	}
+	
+	/**
+	 * Test that project 'main' template overrides theme 'main' template
+	 */
+	public function testFindTemplatesApplicationMainOverridesThemeMain() {
+		$templates = array(
+			$this->base . '/myproject/templates/Page.ss'
+		);
+		$this->createTestTemplates($templates);
+		$this->refreshLoader();
+		
+		$expect = array(
+			'main' => "$this->base/myproject/templates/Page.ss",
+			'Layout' => "$this->base/themes/theme/templates/Layout/Page.ss"
+		);
+		$this->assertEquals($expect, $this->loader->findTemplates('Page', 'theme'));
+		
+		$this->removeTestTemplates($templates);
+	}
+	
+	protected function refreshLoader() {
+		$this->manifest->regenerate(false);
+		$this->loader->pushManifest($this->manifest);
+	}
+	
+	protected function createTestTemplates($templates) {
+		foreach ($templates as $template) {
+			file_put_contents($template, '');
+		}
+	}
+	
+	protected function removeTestTemplates($templates) {
+		foreach ($templates as $template) {
+			unlink($template);
+		}
 	}
 
 }