Add native type information (#17)

Author: Firehed

.github/workflows/test.yml

@@ -20,9 +20,6 @@ jobs:
           - 'high'
           - 'low'
         php:
-          - '7.2'
-          - '7.3'
-          - '7.4'
           - '8.0'
 
     steps:

CHANGELOG.md

@@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.0] - Unreleased
+### Summary
+This release now requires PHP 8
+
+Breaking changes:
+- Trying to validate or evaluate an InputObject before the value was set will now throw an `Error` instead of a `BadMethodCallException`.
+  If you encounter a property access before initialization error, this is the cause, and it indicates incorrect use of the library.
+
+- `InputObject::validate(mixed $value): bool` now has the native parameter type; subclasses should do the same.
+
 ## [2.2.0] - 2021-07-19
 ### Summary
 This release focuses on supporting newer versions of PHP and minimizing external dependencies.

composer.json

@@ -22,7 +22,7 @@
         "sort-packages": true
     },
     "require": {
-        "php": "^7.2 || ^8.0"
+        "php": "^8.0"
     },
     "require-dev": {
         "phpstan/phpstan": "^0.12.32",

src/Containers/ParsedInput.php

@@ -17,7 +17,7 @@
 class ParsedInput extends RawInput implements ArrayAccess
 {
     /**
-     * @param array<array-key-, mixed> $data
+     * @param array<array-key, mixed> $data
      */
     public function __construct(array $data)
     {

src/Containers/RawInput.php

@@ -8,12 +8,9 @@
 
 class RawInput
 {
-    /** @var mixed */
-    private $data;
-    /** @var bool */
-    private $is_parsed = false;
-    /** @var bool */
-    private $is_validated = false;
+    private mixed $data;
+    private bool $isParsed = false;
+    private bool $isValidated = false;
 
     /**
      * @param mixed $raw
@@ -52,23 +49,23 @@ final protected function setData(array $data): self
     // mocked during unit tests
     public function isParsed(): bool
     {
-        return $this->is_parsed;
+        return $this->isParsed;
     }
 
     public function isValidated(): bool
     {
-        return $this->is_validated;
+        return $this->isValidated;
     }
 
     final protected function setIsParsed(bool $bool): self
     {
-        $this->is_parsed = $bool;
+        $this->isParsed = $bool;
         return $this;
     }
 
     final protected function setIsValidated(bool $bool): self
     {
-        $this->is_validated = $bool;
+        $this->isValidated = $bool;
         return $this;
     }
 }

src/Exceptions/InputException.php

@@ -20,15 +20,17 @@ class InputException extends UnexpectedValueException
     /**
      * @var string[]
      */
-    private $missing = [];
+    private array $missing = [];
+
     /**
      * @var string[]
      */
-    private $invalid = [];
+    private array $invalid = [];
+
     /**
      * @var string[]
      */
-    private $unexpected = [];
+    private array $unexpected = [];
 
     public function __construct(int $code, array $errors = [])
     {

src/Objects/InputObject.php

@@ -24,14 +24,22 @@
  */
 abstract class InputObject
 {
-    /** @var mixed */
-    private $defaultValue;
-    /** @var mixed */
-    private $value;
-    /** @var bool */
-    private $valueWasSet = false; // false-like values can be valid, so explicitly track if the setter has been called
-    /** @var ?bool */
-    private $isValid;
+    private mixed $defaultValue = null;
+
+    /**
+     * isValid tracks both a) if the value has been validated, and b) if it's
+     * actually valid.
+     */
+    private ?bool $isValid = null;
+
+    private mixed $value;
+
+    /**
+     * Extending classes must implement the `validate` method, accepting the
+     * arbitrary value from the input being validated and returning a boolean
+     * indicating if the value is valid.
+     */
+    abstract protected function validate(mixed $value): bool;
 
     public function __construct()
     {
@@ -78,29 +86,16 @@ final protected function getValue()
      * @param mixed $value value to validate
      * @return $this
      */
-    final public function setValue($value): self
+    final public function setValue(mixed $value): self
     {
         $this->isValid = null;
         $this->value = $value;
-        $this->valueWasSet = true;
         return $this;
     }
 
-    /**
-     * @param mixed $value
-     */
-    abstract protected function validate($value): bool;
-
-    /**
-     * @return bool
-     */
     final public function isValid(): bool
     {
         if (null === $this->isValid) {
-            if (!$this->valueWasSet) {
-                throw new \BadMethodCallException("Value has not been set");
-            }
-
             $this->isValid = $this->validate($this->value);
         }
         return $this->isValid;

tests/Objects/InputObjectTest.php

@@ -5,15 +5,15 @@
 namespace Firehed\Input\Objects;
 
 use BadMethodCallException;
+use Error;
 use UnexpectedValueException;
 
 /**
  * @covers Firehed\Input\Objects\InputObject
  */
 class InputObjectTest extends \PHPUnit\Framework\TestCase
 {
-    /** @var InputObject */
-    private $io;
+    private InputObject $io;
 
     public function setUp(): void
     {
@@ -50,7 +50,7 @@ public function testIsValidBad(): void
 
     public function testIsValidNoValueThrows(): void
     {
-        $this->expectException(BadMethodCallException::class);
+        $this->expectException(Error::class);
         $this->io->isValid();
     }
 
@@ -74,7 +74,7 @@ public function testEvaluateInvalidValue(): void
 
     public function testEvaluateNoValue(): void
     {
-        $this->expectException(BadMethodCallException::class);
+        $this->expectException(Error::class);
         $this->io->evaluate();
     }
 

tests/Objects/InputObjectTestFixture.php

@@ -8,7 +8,7 @@ class InputObjectTestFixture extends InputObject
 {
     public const MAGIC_FAIL = '198sjs $ a2/';
 
-    public function validate($value): bool
+    public function validate(mixed $value): bool
     {
         return $value !== self::MAGIC_FAIL;
     }