Merge pull request #28 from derjumpy/master

Add support to use traits in PhpClass

Author: vearutop

src/PhpClass.php

@@ -34,6 +34,9 @@ public function getProperties()
     /** @var PhpConstant[] */
     private $constants = array();
 
+    /** @var PhpTrait[] */
+    private $traits = array();
+
     private function renderImplements()
     {
         if ($this->implements) {
@@ -52,8 +55,8 @@ private function renderImplements()
 
     protected function toString()
     {
-        $content = $this->renderConstants() . $this->renderProperties()
-            . $this->renderMethods();
+        $content = $this->renderTraits() . $this->renderConstants()
+            . $this->renderProperties() . $this->renderMethods();
 
         $content = $this->indentLines(trim($content));
 
@@ -130,6 +133,33 @@ public function addConstant(PhpConstant $constant)
         return $this;
     }
 
+    /**
+     * Adds a new trait to the list of traits
+     *
+     * @param PhpTrait $trait
+     * @throws Exception if a trait already exists with same name
+     * @return self
+     */
+    public function addTrait(PhpTrait $trait)
+    {
+        if (!array_key_exists($trait->getName(), $this->traits)) {
+            $this->traits[$trait->getName()] = $trait;
+        } else {
+            throw new Exception('Duplicate trait');
+        }
+
+        return $this;
+    }
+
+    private function renderTraits()
+    {
+        $result = '';
+        foreach ($this->traits as $trait) {
+            $result .= $trait->render();
+        }
+        return $result;
+    }
+
     private function renderIsAbstract()
     {
         if ($this->isAbstract) {

src/PhpTrait.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Swaggest\PhpCodeBuilder;
+
+use Swaggest\PhpCodeBuilder\Traits\Description;
+
+class PhpTrait extends PhpTemplate
+{
+    use Description;
+
+    /** @var string  */
+    protected $name;
+
+    /**
+     * PhpTrait constructor.
+     * @param string $name
+     */
+    public function __construct($name)
+    {
+        $this->name = $name;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    protected function toString()
+    {
+        return <<<PHP
+{$this->renderDescriptionAsPhpDoc()}use {$this->name};
+
+
+PHP;
+    }
+}

tests/src/PHPUnit/ClassTest.php

@@ -8,6 +8,7 @@
 use Swaggest\PhpCodeBuilder\PhpFunction;
 use Swaggest\PhpCodeBuilder\PhpNamedVar;
 use Swaggest\PhpCodeBuilder\PhpStdType;
+use Swaggest\PhpCodeBuilder\PhpTrait;
 
 class ClassTest extends \PHPUnit_Framework_TestCase
 {
@@ -37,9 +38,20 @@ public function testBasic()
                 ->setDescription('A sample method')
         );
 
+        $class->addTrait(
+            (new PhpTrait(
+                '\Foo\Bar'
+            ))->setDescription('A sample trait usage')
+        );
+
         $expected = <<<'PHP'
 class Uno
 {
+    /**
+     * A sample trait usage
+     */
+    use \Foo\Bar;
+
     /** @var string */
     private $some;
 
@@ -58,4 +70,43 @@ private function process(My\Test\Uno $hello)
 PHP;
         $this->assertSame($expected, (string)$class);
     }
+
+    public function testInitTrait()
+    {
+        $trait = new PhpTrait('\Foo\Bar');
+
+        $this->assertInstanceOf(PhpTrait::class, $trait, 'Initiatet correct Class');
+        $this->assertSame($trait->getName(), '\Foo\Bar', 'Saved the correct name of the trait');
+    }
+
+    public function testTraitOutput()
+    {
+        $trait = new PhpTrait('\Foo\Bar');
+        $this->assertSame($trait->__toString(), <<<'PHP'
+use \Foo\Bar;
+
+
+PHP
+        );
+
+        $trait->setDescription('A sample trait.');
+        $this->assertSame($trait->__toString(), <<<'PHP'
+/**
+ * A sample trait.
+ */
+use \Foo\Bar;
+
+
+PHP
+        );
+    }
+
+    public function testThrowExceptionOnDuplicateTrait()
+    {
+        $this->expectException(\Swaggest\PhpCodeBuilder\Exception::class);
+
+        $class = new PhpClass();
+        $class->addTrait(new PhpTrait('\Foo\Bar'));
+        $class->addTrait(new PhpTrait('\Foo\Bar'));
+    }
 }