Merge branch 'release/4.1.1'

mikaelcom · mikaelcom · commit 8dfdc4746590 · 2022-03-24T22:22:21.000+01:00
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -5,7 +5,7 @@
     ->exclude('tests/resources')
     ->in(__DIR__);
 
-return PhpCsFixer\Config::create()
+return (new PhpCsFixer\Config())
     ->setUsingCache(false)
     ->setRules(array(
         '@PhpCsFixer' => true,
diff --git a/.travis.yml b/.travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 4.1.1 - 2022/03/24
+- Update PHP CS Fixer and corresponding setting file
+- Add PHPStan
+- Update badges
+
 ## 4.1.0 - 2021/02/05
 - issue #12 - Use array short notation
 
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
 # PhpGenerator, a Real PHP source code generator
 
-> PhpGenerator helps generating PHP source code
+> PhpGenerator helps to generate PHP source code
 
 [![License](https://poser.pugx.org/wsdltophp/phpgenerator/license)](https://packagist.org/packages/wsdltophp/phpgenerator)
 [![Latest Stable Version](https://poser.pugx.org/wsdltophp/phpgenerator/version.png)](https://packagist.org/packages/wsdltophp/phpgenerator)
-[![Build Status](https://travis-ci.com/WsdlToPhp/PhpGenerator.svg)](https://travis-ci.com/github/WsdlToPhp/PhpGenerator)
+[![TeamCity build status](https://teamcity.mikael-delsol.fr/app/rest/builds/buildType:id:PhpGenerator_Build/statusIcon.svg)](https://github.com/WsdlToPhp/PhpGenerator)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/WsdlToPhp/PhpGenerator/badges/quality-score.png)](https://scrutinizer-ci.com/g/WsdlToPhp/PhpGenerator/)
 [![Code Coverage](https://scrutinizer-ci.com/g/WsdlToPhp/PhpGenerator/badges/coverage.png)](https://scrutinizer-ci.com/g/WsdlToPhp/PhpGenerator/)
 [![Total Downloads](https://poser.pugx.org/wsdltophp/phpgenerator/downloads)](https://packagist.org/packages/wsdltophp/phpgenerator)
 [![StyleCI](https://styleci.io/repos/36832375/shield)](https://styleci.io/repos/36832375)
-[![SensioLabsInsight](https://insight.sensiolabs.com/projects/e55e9115-5a3f-4d37-bfd5-b01c8de579f9/mini.png)](https://insight.sensiolabs.com/projects/e55e9115-5a3f-4d37-bfd5-b01c8de579f9)
+[![SymfonyInsight](https://insight.symfony.com/projects/a384481c-01ba-4c20-a8c6-a4d852ee7985/mini.svg)](https://insight.symfony.com/projects/a384481c-01ba-4c20-a8c6-a4d852ee7985)
 
 Even if this project is yet another PHP source code generator, its main goal is to provide a consistent PHP source code generator for the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator) project. Nevertheless, it also aims to be used for any PHP source code generation process as it generates standard PHP code.
 
diff --git a/composer.json b/composer.json
@@ -17,13 +17,15 @@
     ],
     "scripts": {
         "test": "vendor/bin/phpunit",
-        "lint": "vendor/bin/php-cs-fixer fix --ansi --diff --verbose"
+        "lint": "vendor/bin/php-cs-fixer fix --ansi --diff --verbose",
+        "phpstan": "vendor/bin/phpstan analyze src --level=3"
     },
     "require" : {
-        "php" : ">=7.4"
+        "php": ">=7.4",
+        "phpstan/phpstan": "^1.5"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.0",
+        "friendsofphp/php-cs-fixer": "^3.0",
         "phpunit/phpunit": "^9"
     },
     "autoload" : {
diff --git a/src/Component/GenerateableInterface.php b/src/Component/GenerateableInterface.php
@@ -6,7 +6,7 @@
 
 interface GenerateableInterface
 {
-    const BREAK_LINE_CHAR = "\n";
+    public const BREAK_LINE_CHAR = "\n";
 
     public function __toString(): string;
 
diff --git a/src/Component/PhpInterface.php b/src/Component/PhpInterface.php
@@ -21,7 +21,9 @@ public function addMethodElement(PhpMethodElement $method): self
             $method->setHasBody(false);
         }
 
-        return parent::addMethodElement($method);
+        parent::addMethodElement($method);
+
+        return $this;
     }
 
     public function addMethod(string $name, array $parameters = [], ?string $returnType = null, string $access = PhpMethodElement::ACCESS_PUBLIC, bool $abstract = false, bool $static = false, bool $final = false, bool $hasBody = true): self
diff --git a/src/Element/AbstractElement.php b/src/Element/AbstractElement.php
@@ -76,7 +76,7 @@ public function toString(?int $indentation = null): string
         }
         $lines[] = $this->getToStringAfterChildren($indentation);
 
-        return implode(self::BREAK_LINE_CHAR, static::cleanArrayToString($lines));
+        return implode(self::BREAK_LINE_CHAR, self::cleanArrayToString($lines));
     }
 
     public function getPhpName(): string
diff --git a/src/Element/AccessRestrictedElementInterface.php b/src/Element/AccessRestrictedElementInterface.php
@@ -6,13 +6,13 @@
 
 interface AccessRestrictedElementInterface
 {
-    const ACCESS_PRIVATE = 'private';
+    public const ACCESS_PRIVATE = 'private';
 
-    const ACCESS_PROTECTED = 'protected';
+    public const ACCESS_PROTECTED = 'protected';
 
-    const ACCESS_PUBLIC = 'public';
+    public const ACCESS_PUBLIC = 'public';
 
-    const ACCESSES = [
+    public const ACCESSES = [
         self::ACCESS_PRIVATE,
         self::ACCESS_PROTECTED,
         self::ACCESS_PUBLIC,
diff --git a/src/Element/AssignedValueElementInterface.php b/src/Element/AssignedValueElementInterface.php
@@ -9,7 +9,7 @@ interface AssignedValueElementInterface
     /**
      * Use this constant as value to ensure element has not assigned value.
      */
-    const NO_VALUE = '##NO_VALUE##';
+    public const NO_VALUE = '##NO_VALUE##';
 
     public function setValue($value): AbstractElement;
 
diff --git a/src/Element/GenerateableInterface.php b/src/Element/GenerateableInterface.php
@@ -6,29 +6,29 @@
 
 interface GenerateableInterface
 {
-    const INDENTATION_CHAR = '    ';
+    public const INDENTATION_CHAR = '    ';
 
-    const BREAK_LINE_CHAR = "\n";
+    public const BREAK_LINE_CHAR = "\n";
 
     /**
      * opening a function/class.
      */
-    const OPEN_BRACKET = '{';
+    public const OPEN_BRACKET = '{';
 
     /**
      * closing a function/class.
      */
-    const CLOSE_BRACKET = '}';
+    public const CLOSE_BRACKET = '}';
 
     /**
      * opening an annotation.
      */
-    const OPEN_ANNOTATION = '/**';
+    public const OPEN_ANNOTATION = '/**';
 
     /**
      * closing an annotation.
      */
-    const CLOSE_ANNOTATION = ' */';
+    public const CLOSE_ANNOTATION = ' */';
 
     public function __toString(): string;
 
@@ -39,20 +39,16 @@ public function toString(?int $indentation = null): string;
 
     /**
      * stores current indentation.
-     *
-     * @param int
      */
     public function setIndentation(int $indentation);
 
     /**
-     * returns current identation.
+     * Returns current indentation.
      */
     public function getIndentation(): int;
 
     /**
      * returns current indentation string to be used.
-     *
-     * @param int $indentation
      */
     public function getIndentationString(?int $indentation = null): string;
 }
diff --git a/src/Element/PhpAnnotation.php b/src/Element/PhpAnnotation.php
@@ -6,9 +6,9 @@
 
 class PhpAnnotation extends AbstractElement
 {
-    const NO_NAME = '__NO_NAME__';
+    public const NO_NAME = '__NO_NAME__';
 
-    const MAX_LENGTH = 80;
+    public const MAX_LENGTH = 80;
 
     protected string $content;
 
diff --git a/src/Element/PhpAnnotationBlock.php b/src/Element/PhpAnnotationBlock.php
@@ -22,7 +22,9 @@ public function __construct(array $annotations = [])
     public function addChild($child): self
     {
         if (!$this->childIsValid($child)) {
-            return parent::addChild($child);
+            parent::addChild($child);
+
+            return $this;
         }
         $this->children[] = $this->transformAnnotation($child);
 
diff --git a/src/Element/PhpClass.php b/src/Element/PhpClass.php
@@ -8,13 +8,13 @@
 
 class PhpClass extends AbstractElement
 {
-    const PHP_DECLARATION = 'class';
+    public const PHP_DECLARATION = 'class';
 
-    const PHP_ABSTRACT_KEYWORD = 'abstract';
+    public const PHP_ABSTRACT_KEYWORD = 'abstract';
 
-    const PHP_IMPLEMENTS_KEYWORD = 'implements';
+    public const PHP_IMPLEMENTS_KEYWORD = 'implements';
 
-    const PHP_EXTENDS_KEYWORD = 'extends';
+    public const PHP_EXTENDS_KEYWORD = 'extends';
 
     protected bool $abstract;
 
@@ -74,7 +74,7 @@ public static function extendsIsValid($extends): bool
     }
 
     /**
-     * @return PhpClass|string
+     * @return null|PhpClass|string
      */
     public function getExtends()
     {
diff --git a/src/Element/PhpConstant.php b/src/Element/PhpConstant.php
@@ -14,10 +14,8 @@ class PhpConstant extends AbstractElement implements AccessRestrictedElementInte
     public function __construct(string $name, $value = null, ?PhpClass $class = null)
     {
         parent::__construct($name);
-        $this
-            ->setValue($value)
-            ->setClass($class)
-        ;
+        $this->setValue($value);
+        $this->setClass($class);
     }
 
     public function getPhpName(): string
@@ -85,8 +83,10 @@ public function getChildrenTypes(): array
 
     /**
      * Always return null to avoid having a literal string instead of quoted string.
+     *
+     * @param mixed $value
      */
-    protected function getScalarValue()
+    protected function getScalarValue($value)
     {
         return null;
     }
diff --git a/src/Element/PhpDeclare.php b/src/Element/PhpDeclare.php
@@ -8,15 +8,15 @@
 
 class PhpDeclare extends AbstractElement
 {
-    const STATEMENT = 'declare(%s);';
+    public const STATEMENT = 'declare(%s);';
 
-    const DIRECTIVE_ENCODING = 'encoding';
+    public const DIRECTIVE_ENCODING = 'encoding';
 
-    const DIRECTIVE_STRICT_TYPES = 'strict_types';
+    public const DIRECTIVE_STRICT_TYPES = 'strict_types';
 
-    const DIRECTIVE_TICKS = 'ticks';
+    public const DIRECTIVE_TICKS = 'ticks';
 
-    const ALLOWED_DIRECTIVES = [
+    public const ALLOWED_DIRECTIVES = [
         self::DIRECTIVE_ENCODING,
         self::DIRECTIVE_STRICT_TYPES,
         self::DIRECTIVE_TICKS,
@@ -65,6 +65,7 @@ public function getPhpDeclaration(): string
         $directives = array_merge([$this], $this->getChildren());
 
         $strings = [];
+
         /** @var PhpDeclare $directive */
         foreach ($directives as $directive) {
             if (is_null($directive->getValue())) {
@@ -74,7 +75,7 @@ public function getPhpDeclaration(): string
             $strings[] = sprintf('%s=%s', $directive->getName(), var_export($directive->getValue(), true));
         }
 
-        return empty($strings) ? '' : sprintf(self::STATEMENT, implode(', ', $strings));
+        return 0 === count($strings) ? '' : sprintf(self::STATEMENT, implode(', ', $strings));
     }
 
     public function addChild($child): AbstractElement
@@ -97,7 +98,7 @@ public function getChildrenTypes(): array
     /**
      * Children are handled before in getPhpDeclaration in order to have one line per declare directive.
      *
-     * @param $child
+     * @param mixed $child
      */
     protected function getChildContent($child, int $indentation = null): string
     {
diff --git a/src/Element/PhpFile.php b/src/Element/PhpFile.php
@@ -6,7 +6,7 @@
 
 class PhpFile extends AbstractElement
 {
-    const START_FILE = '<?php';
+    public const START_FILE = '<?php';
 
     public function getPhpDeclaration(): string
     {
diff --git a/src/Element/PhpInterface.php b/src/Element/PhpInterface.php
@@ -6,9 +6,9 @@
 
 class PhpInterface extends PhpClass
 {
-    const PHP_DECLARATION = 'interface';
+    public const PHP_DECLARATION = 'interface';
 
-    const PHP_IMPLEMENTS_KEYWORD = 'extends';
+    public const PHP_IMPLEMENTS_KEYWORD = 'extends';
 
     public function getAbstract(): bool
     {
diff --git a/src/Element/PhpProperty.php b/src/Element/PhpProperty.php
@@ -12,10 +12,8 @@ class PhpProperty extends PhpVariable implements AccessRestrictedElementInterfac
     public function __construct(string $name, $value = null, string $access = self::ACCESS_PUBLIC, $type = null)
     {
         parent::__construct($name, $value);
-        $this
-            ->setAccess($access)
-            ->setType($type)
-        ;
+        $this->setType($type);
+        $this->setAccess($access);
     }
 
     public function getPhpDeclaration(): string
diff --git a/src/Element/TypeHintedElementInterface.php b/src/Element/TypeHintedElementInterface.php
@@ -6,16 +6,16 @@
 
 interface TypeHintedElementInterface
 {
-    const TYPE_ARRAY = 'array';
-    const TYPE_CALLABLE = 'callable';
-    const TYPE_BOOL = 'bool';
-    const TYPE_INT = 'int';
-    const TYPE_ITERABLE = 'iterable';
-    const TYPE_FLOAT = 'float';
-    const TYPE_OBJECT = 'object';
-    const TYPE_STRING = 'string';
+    public const TYPE_ARRAY = 'array';
+    public const TYPE_CALLABLE = 'callable';
+    public const TYPE_BOOL = 'bool';
+    public const TYPE_INT = 'int';
+    public const TYPE_ITERABLE = 'iterable';
+    public const TYPE_FLOAT = 'float';
+    public const TYPE_OBJECT = 'object';
+    public const TYPE_STRING = 'string';
 
-    const TYPES = [
+    public const TYPES = [
         self::TYPE_ARRAY,
         self::TYPE_CALLABLE,
         self::TYPE_BOOL,
diff --git a/tests/Element/PhpVariableTest.php b/tests/Element/PhpVariableTest.php
@@ -54,7 +54,7 @@ public function testGetPhpDeclarationEmptyArrayValue()
     {
         $variable = new PhpVariable('foo', []);
 
-        $this->assertSame("\$foo = [];", $variable->getPhpDeclaration());
+        $this->assertSame('$foo = [];', $variable->getPhpDeclaration());
     }
 
     public function testGetPhpDeclarationArray()

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`interface GenerateableInterface`
`8`	`8`	`{`
`9`		`- const BREAK_LINE_CHAR = "\n";`
	`9`	`+ public const BREAK_LINE_CHAR = "\n";`
`10`	`10`
`11`	`11`	`public function __toString(): string;`
`12`	`12`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,9 @@ public function addMethodElement(PhpMethodElement $method): self`
`21`	`21`	`$method->setHasBody(false);`
`22`	`22`	`}`
`23`	`23`
`24`		`- return parent::addMethodElement($method);`
	`24`	`+ parent::addMethodElement($method);`
	`25`	`+`
	`26`	`+ return $this;`
`25`	`27`	`}`
`26`	`28`
`27`	`29`	`public function addMethod(string $name, array $parameters = [], ?string $returnType = null, string $access = PhpMethodElement::ACCESS_PUBLIC, bool $abstract = false, bool $static = false, bool $final = false, bool $hasBody = true): self`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public function toString(?int $indentation = null): string`
`76`	`76`	`}`
`77`	`77`	`$lines[] = $this->getToStringAfterChildren($indentation);`
`78`	`78`
`79`		`- return implode(self::BREAK_LINE_CHAR, static::cleanArrayToString($lines));`
	`79`	`+ return implode(self::BREAK_LINE_CHAR, self::cleanArrayToString($lines));`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`public function getPhpName(): string`