Element // improve return types by using "static" instead of the spec…

…ific class or implemented interface.
Chrico · Jul 11, 2023 · fbc016f · fbc016f
1 parent d52141d
commit fbc016f
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 61 deletions.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,31 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.3/phpunit.xsd"
-	backupGlobals="false"
-	backupStaticAttributes="false"
-	bootstrap="tests/phpunit/bootstrap.php"
-	colors="true"
-	convertErrorsToExceptions="true"
-	convertNoticesToExceptions="true"
-	convertWarningsToExceptions="true"
-	processIsolation="false"
-	stopOnFailure="false">
-	<testsuites>
-		<testsuite name="Unit">
-			<directory suffix="Test.php">tests/phpunit/Unit</directory>
-		</testsuite>
-	</testsuites>
-	<filter>
-		<whitelist processUncoveredFilesFromWhitelist="true">
-			<directory suffix=".php">src</directory>
-			<exclude>
-				<directory>tests</directory>
-				<directory>vendor</directory>
-			</exclude>
-		</whitelist>
-	</filter>
-	<logging>
-		<log type="coverage-html" target="tmp"/>
-	</logging>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" backupStaticAttributes="false" bootstrap="tests/phpunit/bootstrap.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+    <exclude>
+      <directory>tests</directory>
+      <directory>vendor</directory>
+    </exclude>
+    <report>
+      <html outputDirectory="tmp"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="Unit">
+      <directory suffix="Test.php">tests/phpunit/Unit</directory>
+    </testsuite>
+  </testsuites>
+  <logging/>
 </phpunit>
diff --git a/src/Element/ChoiceElement.php b/src/Element/ChoiceElement.php
@@ -17,9 +17,9 @@ class ChoiceElement extends Element implements ChoiceElementInterface
     /**
      * @param ChoiceListInterface $list
      *
-     * @return ChoiceElement
+     * @return static
      */
-    public function withChoices(ChoiceListInterface $list): ChoiceElement
+    public function withChoices(ChoiceListInterface $list): static
     {
         $this->list = $list;
 

diff --git a/src/Element/CollectionElement.php b/src/Element/CollectionElement.php
@@ -33,9 +33,9 @@ class CollectionElement extends Element implements CollectionElementInterface
     /**
      * @param ElementInterface[] $elements
      *
-     * @return CollectionElement
+     * @return static
      */
-    public function withElement(ElementInterface ...$elements): CollectionElement
+    public function withElement(ElementInterface ...$elements): static
     {
         array_walk(
             $elements,
@@ -81,9 +81,9 @@ public function elementExists(string $name): bool
      * @param string $key
      * @param bool|int|string $value
      *
-     * @return CollectionElement
+     * @return static
      */
-    public function withAttribute(string $key, $value): ElementInterface
+    public function withAttribute(string $key, $value): static
     {
         if ($key === 'value' && is_array($value)) {
             foreach ($this->elements as $name => $element) {
@@ -130,9 +130,9 @@ public function elements(): array
      *
      * @param array $errors
      *
-     * @return CollectionElement
+     * @return static
      */
-    public function withErrors(array $errors = []): CollectionElement
+    public function withErrors(array $errors = []): static
     {
         $this->allErrors = $errors;
 

diff --git a/src/Element/DescriptionAwareTrait.php b/src/Element/DescriptionAwareTrait.php
@@ -21,9 +21,9 @@ public function description(): string
     /**
      * @param string $description
      *
-     * @return self
+     * @return static
      */
-    public function withDescription(string $description)
+    public function withDescription(string $description): static
     {
         $this->description = $description;
 

diff --git a/src/Element/Element.php b/src/Element/Element.php
@@ -44,9 +44,9 @@ public function __construct(string $name)
      * @param string $key
      * @param bool|int|string $value
      *
-     * @return Element
+     * @return static
      */
-    public function withAttribute(string $key, $value): ElementInterface
+    public function withAttribute(string $key, $value): static
     {
         $this->attributes[$key] = $value;
 
@@ -114,9 +114,9 @@ public function value()
     /**
      * @param string $value
      *
-     * @return Element
+     * @return static
      */
-    public function withValue($value): Element
+    public function withValue($value): static
     {
         $this->withAttribute('value', $value);
 
@@ -134,9 +134,9 @@ public function attributes(): array
     /**
      * @param array $attributes
      *
-     * @return Element
+     * @return static
      */
-    public function withAttributes(array $attributes = []): Element
+    public function withAttributes(array $attributes = []): static
     {
         $this->attributes = array_merge(
             $this->attributes,
@@ -157,9 +157,9 @@ public function options(): array
     /**
      * @param array $options
      *
-     * @return Element
+     * @return static
      */
-    public function withOptions(array $options = []): Element
+    public function withOptions(array $options = []): static
     {
         $this->options = array_merge(
             $this->options,
@@ -173,9 +173,9 @@ public function withOptions(array $options = []): Element
      * @param string $key
      * @param int|string $value
      *
-     * @return Element
+     * @return static
      */
-    public function withOption(string $key, $value): Element
+    public function withOption(string $key, $value): static
     {
         $this->options[$key] = $value;
 
@@ -199,9 +199,9 @@ public function option(string $key)
     /**
      * @param callable $callable
      *
-     * @return $this
+     * @return static
      */
-    public function withFilter(callable $callable): Element
+    public function withFilter(callable $callable): static
     {
         $this->filter = $callable;
 
@@ -220,9 +220,9 @@ public function filter($value)
     /**
      * @param callable $callable
      *
-     * @return $this
+     * @return static
      */
-    public function withValidator(callable $callable): Element
+    public function withValidator(callable $callable): static
     {
         $this->validator = $callable;
 

diff --git a/src/Element/ErrorAwareTrait.php b/src/Element/ErrorAwareTrait.php
@@ -26,9 +26,9 @@ public function errors(): array
     /**
      * @param array $errors
      *
-     * @return self
+     * @return static
      */
-    public function withErrors(array $errors = [])
+    public function withErrors(array $errors = []): static
     {
         $this->errors = array_merge($this->errors, $errors);
 

diff --git a/src/Element/Form.php b/src/Element/Form.php
@@ -34,11 +34,11 @@ class Form extends CollectionElement implements FormInterface
      * @param string $key
      * @param string|array $value
      *
-     * @return ElementInterface
+     * @return static
      * @throws LogicException
      *
      */
-    public function withAttribute(string $key, $value): ElementInterface
+    public function withAttribute(string $key, $value): static
     {
         if ($key === 'value' && is_array($value)) {
             $this->withData($value);
@@ -52,11 +52,11 @@ public function withAttribute(string $key, $value): ElementInterface
     /**
      * @param array $data
      *
-     * @return FormInterface
+     * @return static
      * @throws LogicException
      *
      */
-    public function withData(array $data = []): FormInterface
+    public function withData(array $data = []): static
     {
         if ($this->isSubmitted) {
             throw new LogicException('You cannot change data of a submitted form.');

diff --git a/src/Element/LabelAwareInterface.php b/src/Element/LabelAwareInterface.php
@@ -22,8 +22,6 @@ public function labelAttributes(): array;
 
     /**
      * @param array $labelAttributes
-     *
-     * @return self
      */
     public function withLabelAttributes(array $labelAttributes = []);
 }
diff --git a/tests/phpunit/Unit/View/FormTest.php b/tests/phpunit/Unit/View/FormTest.php
@@ -48,6 +48,8 @@ public function testRender(): void
         $expected_name = 'foo';
 
         $element_stub = Mockery::mock(ElementInterface::class);
+        $element_stub->allows('id')
+            ->andReturn($expected_name);
         $element_stub->allows('name')
             ->andReturn($expected_name);
         $element_stub->allows('type')