added some more unit tests, and doc comments

Author: schmittjoh

src/CG/Core/DefaultGeneratorStrategy.php

@@ -7,6 +7,14 @@
 use CG\Generator\DefaultVisitor;
 use CG\Generator\DefaultNavigator;
 
+/**
+ * The default generator strategy.
+ *
+ * This strategy allows to change the order in which methods, properties and
+ * constants are sorted.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 class DefaultGeneratorStrategy implements GeneratorStrategyInterface
 {
     private $navigator;

src/CG/Core/DefaultNamingStrategy.php

@@ -2,6 +2,11 @@
 
 namespace CG\Core;
 
+/**
+ * The default naming strategy.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 class DefaultNamingStrategy implements NamingStrategyInterface
 {
     public function getClassName(\ReflectionClass $class)

src/CG/Core/GeneratorStrategyInterface.php

@@ -4,6 +4,14 @@
 
 use CG\Generator\PhpClass;
 
+/**
+ * Generator Strategy Interface.
+ *
+ * Implementing classes are responsible for generating PHP code from the given
+ * PhpClass instance.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 interface GeneratorStrategyInterface
 {
     function generate(PhpClass $class);

src/CG/Core/NamingStrategyInterface.php

@@ -2,9 +2,23 @@
 
 namespace CG\Core;
 
+/**
+ * The naming strategy interface.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 interface NamingStrategyInterface
 {
     const SEPARATOR = '__CG__';
 
+    /**
+     * Returns the class name for the proxy class.
+     *
+     * The generated class name MUST be the original class appended with the
+     * separator, and an optional string that is up to the implementation.
+     *
+     * @param \ReflectionClass $class
+     * @return string the class name for the generated class
+     */
     function getClassName(\ReflectionClass $class);
 }

src/CG/Core/ReflectionUtils.php

@@ -14,7 +14,7 @@ public static function getOverrideableMethods(\ReflectionClass $class, $publicOn
 
         return array_filter(
             $class->getMethods($filter),
-            function($method) { return !$method->isFinal(); }
+            function($method) { return !$method->isFinal() && !$method->isStatic(); }
         );
     }
 

tests/CG/Tests/Core/ClassUtilsTest.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace CG\Tests\Core;
+
+use CG\Core\ClassUtils;
+
+class ClassUtilsTest extends \PHPUnit_Framework_TestCase
+{
+    public function testGetUserClassName()
+    {
+        $this->assertEquals('Foo', ClassUtils::getUserClass('Foo'));
+        $this->assertEquals('Bar', ClassUtils::getUserClass('Bar__CG__FOO'));
+    }
+}

tests/CG/Tests/Core/DefaultGeneratorStrategyTest.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace CG\Tests\Core;
+
+use CG\Core\DefaultGeneratorStrategy;
+
+use CG\Generator\PhpProperty;
+use CG\Generator\PhpMethod;
+use CG\Generator\PhpClass;
+
+class DefaultGeneratorStrategyTest extends \PHPUnit_Framework_TestCase
+{
+    public function testGenerate()
+    {
+        $strategy = new DefaultGeneratorStrategy();
+        $strategy->setConstantSortFunc(function($a, $b) {
+            return strcasecmp($a, $b);
+        });
+        $strategy->setMethodSortFunc($func = function($a, $b) {
+            return strcasecmp($a->getName(), $b->getName());
+        });
+        $strategy->setPropertySortFunc($func);
+
+        $this->assertEquals(
+            $this->getContent('GenerationTestClass_A.php'),
+            $strategy->generate($this->getClass())
+        );
+    }
+
+    public function testGenerateChangedConstantOrder()
+    {
+        $strategy = new DefaultGeneratorStrategy();
+        $strategy->setConstantSortFunc(function($a, $b) {
+            return -1 * strcasecmp($a, $b);
+        });
+        $strategy->setMethodSortFunc($func = function($a, $b) {
+            return strcasecmp($a->getName(), $b->getName());
+        });
+        $strategy->setPropertySortFunc($func);
+
+        $this->assertEquals(
+            $this->getContent('GenerationTestClass_B.php'),
+            $strategy->generate($this->getClass())
+        );
+    }
+
+    private function getContent($file)
+    {
+        return file_get_contents(__DIR__.'/generated/'.$file);
+    }
+
+    private function getClass()
+    {
+        $class = PhpClass::create()
+            ->setName('GenerationTestClass')
+            ->setMethod(PhpMethod::create('a'))
+            ->setMethod(PhpMethod::create('b'))
+            ->setProperty(PhpProperty::create('a'))
+            ->setProperty(PhpProperty::create('b'))
+            ->setConstant('a', 'foo')
+            ->setConstant('b', 'bar')
+        ;
+
+        return $class;
+    }
+}

tests/CG/Tests/Core/ReflectionUtilsTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace CG\Tests\Core;
+
+use CG\Generator\Writer;
+use CG\Core\ReflectionUtils;
+
+class ReflectionUtilsTest extends \PHPUnit_Framework_TestCase
+{
+    public function testGetOverridableMethods()
+    {
+        $ref = new \ReflectionClass('CG\Tests\Core\OverridableReflectionTest');
+        $methods = ReflectionUtils::getOverrideableMethods($ref);
+
+        $this->assertEquals(4, count($methods));
+
+        $methods = array_map(function($v) { return $v->name; }, $methods);
+        sort($methods);
+        $this->assertEquals(array('a', 'd', 'e', 'h'), $methods);
+    }
+
+    public function testGetUnindentedDocComment()
+    {
+        $writer = new Writer();
+        $comment = $writer
+            ->writeln('/**')
+            ->indent()
+            ->writeln(' * Foo.')
+            ->write(' */')
+            ->getContent()
+        ;
+
+        $this->assertEquals("/**\n * Foo.\n */", ReflectionUtils::getUnindentedDocComment($comment));
+    }
+}
+
+abstract class OverridableReflectionTest
+{
+    public function a() { }
+    public final function b() { }
+    public static function c() { }
+    abstract public function d();
+    protected function e() { }
+    protected final function f() {}
+    protected static function g() { }
+    abstract protected function h();
+    private function i() { }
+}

tests/CG/Tests/Core/generated/GenerationTestClass_A.php

@@ -0,0 +1,16 @@
+class GenerationTestClass
+{
+    const a = 'foo';
+    const b = 'bar';
+
+    public $a;
+    public $b;
+
+    public function a()
+    {
+    }
+
+    public function b()
+    {
+    }
+}

tests/CG/Tests/Core/generated/GenerationTestClass_B.php

@@ -0,0 +1,16 @@
+class GenerationTestClass
+{
+    const b = 'bar';
+    const a = 'foo';
+
+    public $a;
+    public $b;
+
+    public function a()
+    {
+    }
+
+    public function b()
+    {
+    }
+}