add execution validations for builders

src/Builder/BuilderAbstract.php

@@ -3,20 +3,29 @@
 namespace ABC\Builder;
 
 use \ABC\Builder\BuilderAction;
+use \Exception;
 
 abstract class BuilderAbstract
 {
     /** @var array(\ABC\Builder\BuilderAction) */
     public $builderActions = array();
 
+    /** @var bool */
+    public $executed       = false;
+
+    /** @var array(callable) */
+    public $validations    = array();
+
     /**
      * @return null
      */
-    public function executeActions()
+    public function execute()
     {
         foreach ($this->builderActions as $action) {
             call_user_func_array($action->action, $action->arguments);
         }
+        $this->validate();
+        $this->executed = true;
         return $this;
     }
 
@@ -28,4 +37,60 @@ public function addAction($action)
         $this->builderActions[] = $action;
         return $this;
     }
+
+    /**
+     * @throws \Exception
+     */
+    public function checkStatus()
+    {
+        if (!$this->executed) {
+            throw new Exception('Builder actions not executed');
+        }
+    }
+
+    /**
+     * @throws \Exception
+     */
+    protected function validate()
+    {
+        $actions = $this->compileActionCounts();
+        foreach ($this->validations as $validation) {
+            $result = call_user_func_array($validation['callback'], array($actions));
+            if (!$result) {
+                $class = $validation['exceptionType'];
+                throw new $class($validation['exceptionMessage']);
+            }
+        }
+    }
+
+    /**
+     * @return array
+     */
+    protected function compileActionCounts()
+    {
+        $counts = array();
+
+        foreach ($this->builderActions as $action) {
+            $counts[$action->name] = isset($counts[$action->name]) ? $counts[$action->name]+1 : 1;
+        }
+
+        return $counts;
+    }
+
+    /**
+     * @param callable $callback
+     * @param string   $exceptionType
+     * @param string   $exceptionMessage
+     *
+     * @return \ABC\Builder\BuilderAbstract
+     */
+    protected function addValidation($callback, $exceptionType, $exceptionMessage = '')
+    {
+        $this->validations[] = array(
+            'callback' => $callback,
+            'exceptionType' => $exceptionType,
+            'exceptionMessage' => $exceptionMessage,
+        );
+        return $this;
+    }
 }

src/Builder/CompanyBuilder.php

@@ -10,17 +10,20 @@
 
 class CompanyBuilder extends BuilderAbstract
 {
+    /** @var \ABC\Builder\Company */
     public $company      = null;
 
-    public function __construct($company = null)
+    public function __construct()
     {
-        if ($company != null) {
-            $this->company = $company;
-        } else {
-            $this->company = new Company();
-        }
+        $this->company = new Company();
+        $this->setUpValidations();
     }
 
+    /**
+     * @param \ABC\Builder\Address $address
+     *
+     * @return \ABC\Builder\Company
+     */
     public function withAddress(Address $address)
     {
         $action = new CompanyBuilderAction('withAddress', array($this->company, 'appendAddress'));
@@ -29,6 +32,11 @@ public function withAddress(Address $address)
         return $this;
     }
 
+    /**
+     * @param \ABC\Builder\Person $person
+     *
+     * @return \ABC\Builder\Company
+     */
     public function withPerson(Person $person)
     {
         $action = new CompanyBuilderAction('withPerson', array($this->company, 'appendPerson'));
@@ -37,13 +45,34 @@ public function withPerson(Person $person)
         return $this;
     }
 
+    /**
+     * Returns executed object as JSON.
+     * Throws an exception when builder actions
+     * have not been executed.
+     *
+     * @throws \Exception
+     *
+     * @return string
+     */
     public function asJson()
     {
+        $this->checkStatus();
         return json_encode($this->company);
     }
 
+    /**
+     * Returns executed object as XML.
+     * Throws an exception when builder actions
+     * have not been executed.
+     *
+     * @throws \Exception
+     *
+     * @return string
+     */
     public function asXml()
     {
+        $this->checkStatus();
+
         $xml = new DOMDocument('1.0', 'utf-8');
         $company = $xml->createElement('Company');
 
@@ -75,4 +104,40 @@ public function asXml()
 
         return $xml->saveXml();
     }
+
+    /**
+     * Ensures there is at least one address.
+     *
+     * @param arraay $actionCounts
+     *
+     * @return bool
+     */
+    public function atLeastOneAddress($actionCounts)
+    {
+        return isset($actionCounts['withAddress']) && $actionCounts['withAddress'] > 0;
+    }
+
+    /**
+     * Ensures there is at least one person.
+     *
+     * @param arraay $actionCounts
+     *
+     * @return bool
+     */
+    public function atLeastOnePerson($actionCounts)
+    {
+        return isset($actionCounts['withPerson']) && $actionCounts['withPerson'] > 0;
+    }
+
+    /**
+     * Setups up validations for building Company objects.
+     *
+     * @return null
+     */
+    private function setUpValidations()
+    {
+        $this
+            ->addValidation(array($this, 'atLeastOneAddress'), 'Exception', 'Company needs at least one address')
+            ->addValidation(array($this, 'atLeastOnePerson'), 'Exception', 'Company needs at least one person');
+    }
 }

tests/Builder/AddressBuilderTest.php

@@ -14,7 +14,7 @@ public function testBuilderWithInitialValueNoActions()
 
         $this->assertEquals($this->expectedAddress(), $builder->address);
 
-        $builder = $builder->executeActions();
+        $builder = $builder->execute();
 
         $this->assertEquals($this->expectedAddress(), $builder->address);
     }
@@ -23,7 +23,7 @@ public function testBuilderWithoutInitialValueNoActions()
     {
         $builder = new AddressBuilder();
 
-        $builder = $builder->executeActions();
+        $builder = $builder->execute();
 
         $this->assertEquals(new Address(), $builder->address);
     }