More fine grained control over file overwriting

composer.json

@@ -1,23 +1,30 @@
 {
-    "name": "cedriclombardot/twig-generator",
-    "type": "library",
-    "description": "A generator for PHP code based on Twig template engine",
-    "keywords": ["twig", "generator", "code generation"],
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Cédric Lombardot",
-            "email": "cedric.lombardot@gmail.com"
-        },
-        {
-            "name": "François Zaninotto"
-        }
-    ],
-    "require": {
-        "php": ">=5.3.0",
-        "twig/twig": ">=1.1, <2.0-dev"
-    },
-    "autoload": {
-        "psr-0": { "TwigGenerator": "src/" }
-    }
-}
+	"name" : "cedriclombardot/twig-generator",
+	"type" : "library",
+	"description" : "A generator for PHP code based on Twig template engine",
+	"keywords" : [
+		"twig",
+		"generator",
+		"code generation"
+	],
+	"license" : "MIT",
+	"authors" : [{
+			"name" : "Cédric Lombardot",
+			"email" : "cedric.lombardot@gmail.com"
+		}, {
+			"name" : "François Zaninotto"
+		}
+	],
+	"require" : {
+		"php" : ">=5.3.0",
+		"twig/twig" : ">=1.1, <2.0-dev"
+	},
+	"autoload" : {
+		"psr-0" : {
+			"TwigGenerator" : "src/"
+		}
+	},
+	"require-dev" : {
+		"phpunit/phpunit" : "~3"
+	}
+}

src/TwigGenerator/Builder/BaseBuilder.php

@@ -28,13 +28,18 @@ abstract class BaseBuilder implements BuilderInterface
     /**
      * @var array   A list of template directories.
      */
-    protected $templateDirectories = array();
+    private $templateDirectories = array();
 
+    /**
+     * @var boolean
+     */
+    protected $templateDirectoriesSealed = false;
+
     /**
      * @var string
      */
     protected $templateName;
-
+    
     /**
      * @var string
      */
@@ -43,7 +48,12 @@ abstract class BaseBuilder implements BuilderInterface
     /**
      * @var Boolean
      */
-    protected $mustOverwriteIfExists = false;
+    private $mustOverwriteIfExists = false;
+
+    /**
+     * @var Boolean
+     */
+    protected $mustOverwriteIfExistsSealed = false;
 
     /**
      * @var array
@@ -97,15 +107,19 @@ public function getGenerator()
      */
     public function addTemplateDir($templateDir)
     {
-        $this->templateDirectories[$templateDir] = $templateDir;
+    	if (!$this->templateDirectoriesSealed) {
+            $this->templateDirectories[$templateDir] = $templateDir;
+    	}
     }
 
     /**
      * {@inheritDoc}
      */
     public function setTemplateDirs(array $templateDirs)
     {
-        $this->templateDirectories = $templateDirs;
+    	if (!$this->templateDirectoriesSealed) {
+            $this->templateDirectories = $templateDirs;
+    	}
     }
 
     /**
@@ -115,6 +129,31 @@ public function getTemplateDirs()
     {
         return $this->templateDirectories;
     }
+
+    /**
+     * Seal templateDirs property, so it is protected from overwriting
+     */
+    public function sealTemplateDirs()
+    {
+    	$this->templateDirectoriesSealed = true;
+    }
+
+    /**
+     * Unseal the templateDirs property, so it can be overwritten again
+     */
+    public function unsealTemplateDirs()
+    {
+    	$this->templateDirectoriesSealed = false;
+    }
+
+    /**
+     * Returns whether the templateDirs property is sealed
+     * @return boolean
+     */
+    public function isTemplateDirsSealed()
+    {
+    	return $this->templateDirectoriesSealed;
+    }
 
     /**
      * {@inheritDoc}
@@ -192,7 +231,35 @@ public function mustOverwriteIfExists()
      */
     public function setMustOverwriteIfExists($status = true)
     {
-        $this->mustOverwriteIfExists = $status;
+    	if (!$this->mustOverwriteIfExistsSealed) {
+            $this->mustOverwriteIfExists = $status;
+    	}
+    }
+
+    /**
+     * Seal the mustOverwriteIfExists property, so it is protected from overwriting
+     */
+    public function sealMustOverwriteIfExists()
+    {
+    	$this->mustOverwriteIfExistsSealed = true;	
+    }
+
+    /**
+     * Unseal the mustOverwriteIfExists property, so it can be overwritten again
+     */
+    public function unsealMustOverwriteIfExists()
+    {
+    	$this->mustOverwriteIfExistsSealed = false;
+    }
+
+    /**
+     * Returns whether the mustOverwriteIfExists property is sealed
+     * 
+     * @return boolean
+     */
+    public function isMustOverwriteIfExistsSealed()
+    {
+    	return $this->mustOverwriteIfExistsSealed;
     }
 
     /**

tests/TwigGenerator/Tests/Builder/BaseBuilderTest.php

@@ -91,6 +91,49 @@ public function testWriteOnDisk()
         $builder->writeOnDisk(sys_get_temp_dir());
         $this->assertEquals('Hello cedric !', file_get_contents(sys_get_temp_dir() . '/test.php'), 'If i change variables on a non existant files code is generated');
     }
+
+    public function testSeal()
+    {
+        $builder = new DemoBuilder();
+
+        // mustOverwriteIfExists
+        $builder->setMustOverwriteIfExists(true);
+
+        $this->assertEquals(true, $builder->mustOverwriteIfExists());
+
+        $builder->sealMustOverwriteIfExists();
+        $builder->setMustOverwriteIfExists(false);
+
+        $this->assertEquals(true, $builder->mustOverwriteIfExists());
+
+        $builder->unsealMustOverwriteIfExists();
+
+        $builder->setMustOverwriteIfExists(false);
+        $this->assertEquals(false, $builder->mustOverwriteIfExists());
+
+        // templateDirs
+        $builder->setTemplateDirs(array('abc'));
+
+        $this->assertEquals(array('abc'), $builder->getTemplateDirs());
+
+        $builder->sealTemplateDirs();
+        $builder->setTemplateDirs(array('xyz'));
+
+        $this->assertEquals(array('abc'), $builder->getTemplateDirs());
+
+        $builder->addTemplateDir('def');
+
+        $this->assertEquals(array('abc'), $builder->getTemplateDirs());
+
+        $builder->unsealTemplateDirs();
+        $builder->setTemplateDirs(array('xyz'));
+
+        $this->assertEquals(array('xyz'), $builder->getTemplateDirs());
+
+        $builder->addTemplateDir('def');
+
+        $this->assertEquals(array('xyz', 'def' => 'def'), $builder->getTemplateDirs());
+    }
 
     protected function initBuilder()
     {

tests/bootstrap.php

@@ -1,6 +1,6 @@
 <?php
 
-if ((!$loader = @include __DIR__.'/../vendor/.composer/autoload.php')) {
+if ((!$loader = @include __DIR__.'/../vendor/autoload.php')) {
     die('You must set up the project dependencies, run the following commands:'.PHP_EOL.
         'curl -s http://getcomposer.org/installer | php'.PHP_EOL.
         'php composer.phar install'.PHP_EOL);