Bugfixes and Readme

Author: gossi

README.md

@@ -1,13 +1,100 @@
-# PHP Code Formatter
+# PHP Code Generator
 
 [![Build Status](https://travis-ci.org/gossi/php-code-generator.svg?branch=master)](https://travis-ci.org/gossi/php-code-generator)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/gossi/php-code-generator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/gossi/php-code-generator/?branch=master)
 [![Code Coverage](https://scrutinizer-ci.com/g/gossi/php-code-generator/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/gossi/php-code-generator/?branch=master)
 
-A library for generating php code.
+This library provides some tools that you commonly need for generating PHP code.
 
-Overview
---------
+## Installation
 
-This library provides some tools that you commonly need for generating PHP code.
+Install via Composer:
+
+```json
+{
+	"require": {
+		"gossi/php-code-generator": "~1"
+	}
+}
+
+## Usage
+
+There are two things you need to generate code.
+
+1. A generator
+	* CodeGenerator
+	* CodeFileGenerator
+2. A model to generate
+	* PhpClass
+	* PhpInterface
+	* PhpTrait
+	* PhpFunction
+	
+You can create these models and push all the data using a fluent API or read from existing code through reflection.
+
+### Generate Code
+
+a) Simple:
+
+```php
+use gossi\codegen\generator\CodeGenerator;
+use gossi\codegen\model\PhpClass;
+use gossi\codegen\model\PhpMethod;
+use gossi\codegen\model\PhpParameter;
+
+$class = new PhpClass();
+$class->setName('my\cool\Tool');
+	->setMethod(PhpMethod::create('__construct')
+		->addParameter(PhpParameter::create('target')
+			->setType('string')
+			->setDescription('Creates my Tool')
+		)
+	);	
+
+$generator = new CodeGenerator();
+$code = $generator->generate($class);
+```
+
+b) From Reflection:
+
+```php
+use gossi\codegen\generator\CodeGenerator;
+use gossi\codegen\model\PhpClass;
+
+$class = PhpClass::fromReflection(new \ReflectionClass('MyClass'));
+
+$generator = new CodeGenerator();
+$code = $generator->generate($class);
+```
+
+### Code Generators
+
+**CodeGenerator**
+
+Creates code for a given model
+
+| Key | Type | Default Value | Description |
+| --- | ---- | ------------- | ----------- |
+| generateDocblock | boolean | true | enables docblock generation prior to code generation |
+| generateEmptyDocblock | boolean | true | when docblock generation is enabled, even empty docblocks will be generated |
+
+**CodeFileGenerator**
+
+Creates a complete php file with the given model inside.
+
+Same options as `CodeGenerator` plus:
+
+| Key | Type | Default Value | Description |
+| --- | ---- | ------------- | ----------- |
+| headerComment | string | empty | A comment, that will be put after the <?php statement |
+| headerDocblock | string\|Docblock | empty | A docblock that will be positioned after the possible header comment |
+| blankLineAtEnd | boolean | true | Places an empty line at the end of the generated file |
+
+## Contributing
+
+Feel free to fork and submit a pull request (don't forget the tests) and I am happy to merge.
+
+
+## References
 
+- This project is a spin-off of the older [schmittjoh/cg-library](https://github.com/schmittjoh/cg-library) library.

src/model/AbstractPhpMember.php

@@ -20,6 +20,7 @@
 use gossi\codegen\model\parts\NameTrait;
 use gossi\codegen\model\parts\LongDescriptionTrait;
 use gossi\codegen\model\parts\TypeTrait;
+use gossi\docblock\Docblock;
 
 /**
  * Abstract PHP member class.
@@ -47,6 +48,7 @@ abstract class AbstractPhpMember extends AbstractModel implements DocblockInterf
 
 	public function __construct($name) {
 		$this->setName($name);
+		$this->docblock = new Docblock();
 	}
 
 	/**

src/model/AbstractPhpStruct.php

@@ -16,10 +16,11 @@
  */
 namespace gossi\codegen\model;
 
-use gossi\docblock\DocBlock;
+use gossi\docblock\Docblock;
 use gossi\codegen\model\parts\QualifiedNameTrait;
 use gossi\codegen\model\parts\DocblockTrait;
 use gossi\codegen\model\parts\LongDescriptionTrait;
+use Doctrine\Common\Annotations\PhpParser;
 
 /**
  * Represents an abstract php struct.
@@ -63,9 +64,17 @@ protected static function createMethod(\ReflectionMethod $method) {
 	protected static function createProperty(\ReflectionProperty $property) {
 		return PhpProperty::fromReflection($property);
 	}
+	
+	protected static function getUseStatementsFromReflection(\ReflectionClass $ref) {
+		if (null === self::$phpParser) {
+			self::$phpParser = new PhpParser();
+		}
+		return self::$phpParser->parseClass($ref);
+	}
 
 	public function __construct($name = null) {
 		$this->setQualifiedName($name);
+		$this->docblock = new Docblock();
 	}
 
 	public function setRequiredFiles(array $files) {
@@ -86,7 +95,7 @@ public function addRequiredFile($file) {
 
 	public function setUseStatements(array $useStatements) {
 		$this->useStatements = $useStatements;
-		
+
 		return $this;
 	}
 
@@ -121,28 +130,28 @@ public function hasUseStatement($qualifiedName) {
 		return isset($flipped[$qualifiedName]);
 	}
 
-	public function declareUses()
-	{
-		foreach (func_get_args() as $name) {
-			$this->declareUse($name);
-		}
-	}
+// 	public function declareUses()
+// 	{
+// 		foreach (func_get_args() as $name) {
+// 			$this->declareUse($name);
+// 		}
+// 	}
 
-	/**
-	 * @param string      $fullClassName
-	 * @param null|string $alias
-	 *
-	 * @return string
-	 */
-	public function declareUse($fullClassName, $alias = null)
-	{
-		$fullClassName = trim($fullClassName, '\\');
-		if (!$this->hasUseStatement($fullClassName)) {
-			$this->addUseStatement($fullClassName, $alias);
-		}
+// 	/**
+// 	 * @param string      $fullClassName
+// 	 * @param null|string $alias
+// 	 *
+// 	 * @return string
+// 	 */
+// 	public function declareUse($fullClassName, $alias = null)
+// 	{
+// 		$fullClassName = trim($fullClassName, '\\');
+// 		if (!$this->hasUseStatement($fullClassName)) {
+// 			$this->addUseStatement($fullClassName, $alias);
+// 		}
 
-		return $this->getUseAlias($fullClassName);
-	}
+// 		return $this->getUseAlias($fullClassName);
+// 	}
 
 	/**
 	 * @param string $qualifiedName

src/model/PhpClass.php

@@ -26,12 +26,8 @@ public static function fromReflection(\ReflectionClass $ref) {
 		$class->setQualifiedName($ref->name)
 			->setAbstract($ref->isAbstract())
 			->setFinal($ref->isFinal())
-			->setConstants($ref->getConstants());
-
-		if (null === self::$phpParser) {
-			self::$phpParser = new PhpParser();
-		}
-		$class->setUseStatements(self::$phpParser->parseClass($ref));
+			->setConstants($ref->getConstants())
+			->setUseStatements(static::getUseStatementsFromReflection($ref));
 
 		if ($ref->getDocComment()) {
 			$docblock = new Docblock($ref);
@@ -54,6 +50,9 @@ public static function fromReflection(\ReflectionClass $ref) {
 		foreach ($ref->getTraits() as $trait) {
 			$class->addTrait(PhpTrait::fromReflection($trait));
 		}
+		
+		// constants
+		$class->setConstants($ref->getConstants());
 
 		return $class;
 	}
@@ -78,7 +77,6 @@ public function setParentClassName($name) {
 
 	public function generateDocblock() {
 		parent::generateDocblock();
-// 		$docblock = $this->getDocblock();
 
 		foreach ($this->constants as $constant) {
 			$constant->generateDocblock();
@@ -87,10 +85,6 @@ public function generateDocblock() {
 		foreach ($this->properties as $prop) {
 			$prop->generateDocblock();
 		}
-		
-// 		$this->setDocblock($docblock);
-		
-// 		return $docblock;
 	}
 
 }

src/model/PhpConstant.php

@@ -24,20 +24,10 @@ public static function create($name = null, $value = null) {
 		return $constant;
 	}
 
-	public static function fromReflection(\Reflection $ref) {
-		$constant = new static($ref->name);
-		$constant->setStatic($ref->isStatic())->setVisibility($ref->isPublic() ? self::VISIBILITY_PUBLIC : ($ref->isProtected() ? self::VISIBILITY_PROTECTED : self::VISIBILITY_PRIVATE));
-		
-		$docblock = new Docblock($ref);
-		$constant->setDocblock($docblock);
-		$constant->setDescription($docblock->getShortDescription());
-		
-		return $constant;
-	}
-
 	public function __construct($name = null, $value = null) {
 		$this->setName($name);
 		$this->setValue($value);
+		$this->docblock = new Docblock();
 	}
 
 	public function setValue($value) {

src/model/PhpFunction.php

@@ -69,6 +69,7 @@ public static function create($name = null) {
 
 	public function __construct($name = null) {
 		$this->setQualifiedName($name);
+		$this->docblock = new Docblock();
 	}
 
 	public function generateDocblock() {

src/model/PhpInterface.php

@@ -13,19 +13,18 @@ class PhpInterface extends AbstractPhpStruct implements GenerateableInterface, C
 	public static function fromReflection(\ReflectionClass $ref) {
 		$interface = new static();
 		$interface->setQualifiedName($ref->name)
-			->setConstants($ref->getConstants());
+			->setConstants($ref->getConstants())
+			->setUseStatements(static::getUseStatementsFromReflection($ref));
 
-		$interface->setUseStatements(self::$phpParser->parseClass($ref));
-		
-		if ($ref->getDocComment()) {
-			$docblock = new Docblock($ref);
-			$interface->setDocblock($docblock);
-			$interface->setDescription($docblock->getShortDescription());
-			$interface->setLongDescription($docblock->getLongDescription());
-		}
+		$docblock = new Docblock($ref);
+		$interface->setDocblock($docblock);
+		$interface->setDescription($docblock->getShortDescription());
+		$interface->setLongDescription($docblock->getLongDescription());
 
 		foreach ($ref->getMethods() as $method) {
-			$interface->setMethod(static::createMethod($method));
+			$method = static::createMethod($method);
+			$method->setAbstract(false);
+			$interface->setMethod($method);
 		}
 
 		return $interface;
@@ -41,9 +40,5 @@ public function generateDocblock() {
 		foreach ($this->constants as $constant) {
 			$constant->generateDocblock();
 		}
-		
-// 		$this->setDocblock($docblock);
-		
-// 		return $docblock;
 	}
 }

src/model/PhpMethod.php

@@ -49,14 +49,21 @@ public static function create($name) {
 
 	public static function fromReflection(\ReflectionMethod $ref) {
 		$method = new static($ref->name);
-		$method->setFinal($ref->isFinal())->setAbstract($ref->isAbstract())->setStatic($ref->isStatic())->setVisibility($ref->isPublic() ? self::VISIBILITY_PUBLIC : ($ref->isProtected() ? self::VISIBILITY_PROTECTED : self::VISIBILITY_PRIVATE))->setReferenceReturned($ref->returnsReference())->setBody(ReflectionUtils::getFunctionBody($ref));
-		
-		if ($ref->getDocComment()) {
-			$docblock = new Docblock($ref);
-			$method->setDocblock($docblock);
-			$method->setDescription($docblock->getShortDescription());
-			$method->setLongDescription($docblock->getLongDescription());
-		}
+		$method->setFinal($ref->isFinal())
+			->setAbstract($ref->isAbstract())
+			->setStatic($ref->isStatic())
+			->setVisibility($ref->isPublic() 
+				? self::VISIBILITY_PUBLIC 
+				: ($ref->isProtected() 
+					? self::VISIBILITY_PROTECTED 
+					: self::VISIBILITY_PRIVATE))
+			->setReferenceReturned($ref->returnsReference())
+			->setBody(ReflectionUtils::getFunctionBody($ref));
+
+		$docblock = new Docblock($ref);
+		$method->setDocblock($docblock);
+		$method->setDescription($docblock->getShortDescription());
+		$method->setLongDescription($docblock->getLongDescription());
 
 		foreach ($ref->getParameters() as $param) {
 			$method->addParameter(static::createParameter($param));
@@ -85,9 +92,5 @@ public function generateDocblock() {
 		foreach ($this->parameters as $param) {
 			$docblock->appendTag($param->getDocblockTag());
 		}
-		
-// 		$this->setDocblock($docblock);
-		
-// 		return $docblock;
 	}
 }

src/model/PhpProperty.php

@@ -39,13 +39,12 @@ public static function create($name) {
 
 	public static function fromReflection(\ReflectionProperty $ref) {
 		$property = new static($ref->name);
-		$property->setStatic($ref->isStatic())->setVisibility($ref->isPublic() ? self::VISIBILITY_PUBLIC : ($ref->isProtected() ? self::VISIBILITY_PROTECTED : self::VISIBILITY_PRIVATE));
-		
-		if ($ref->getDocComment()) {
-			$docblock = new Docblock($ref);
-			$property->setDocblock($docblock);
-			$property->setDescription($docblock->getShortDescription());
-		}
+		$property->setStatic($ref->isStatic())
+			->setVisibility($ref->isPublic() ? self::VISIBILITY_PUBLIC : ($ref->isProtected() ? self::VISIBILITY_PROTECTED : self::VISIBILITY_PRIVATE));
+
+		$docblock = new Docblock($ref);
+		$property->setDocblock($docblock);
+		$property->setDescription($docblock->getShortDescription());
 
 		$defaultProperties = $ref->getDeclaringClass()->getDefaultProperties();
 		if (isset($defaultProperties[$ref->name])) {