アノテーションを PHP 8 Attributes に移行し依存関係を更新

.gitignore

@@ -11,3 +11,6 @@ build
 vendor/
 composer.phar
 composer.lock
+tests/tmp/*
+!tests/tmp/.placefolder
+.phpunit.result.cache

.scrutinizer.yml

@@ -1,19 +1,12 @@
+build:
+    nodes:
+        analysis:
+            tests:
+                override:
+                    - php-scrutinizer-run
+            environment:
+                php:
+                    version: 8.2
+
 filter:
     paths: ["src/*"]
-tools:
-    external_code_coverage: true
-    php_code_coverage:
-        timeout: 1200
-    php_sim: true
-    php_mess_detector: true
-    php_pdepend: true
-    php_analyzer: true
-    php_cpd: true
-    php_mess_detector:
-        enabled: true
-        config:
-            ruleset: ./phpmd.xml
-    php_code_sniffer:
-        enabled: true
-        config:
-            ruleset: ./phpcs.xml

README.JA.md

@@ -95,18 +95,14 @@ class MyController
      */
     protected $contactForm;
 
-    /**
-     * @Inject
-     * @Named("contact_form")
-     */
+     #[Inject]
+     #[Named("contact_form")]
     public function setForm(FormInterface $form)
     {
         $this->contactForm = $form;
     }
 
-    /**
-     * @FormValidation(form="contactForm", onFailure="badRequestAction")
-     */
+     #[FormValidation(form: "contactForm", onFailure: "badRequestAction")]
     public function createAction()
     {
         // validation success
@@ -151,9 +147,7 @@ use Ray\WebFormModule\Annotation\InputValidation;
 
 class Foo
 {
-    /**
-     * @InputValidation(form="form1")
-     */
+     #[InputValidation(form: "form1")]
     public function createAction($name)
     {
       // ...
@@ -190,17 +184,11 @@ echo $e->error;
 //}
 ```
 
-`@VndError`アノテーションで`vnd.error+json`に必要な情報を加えることができます。
+`#[VndError]`属性で`vnd.error+json`に必要な情報を加えることができます。
 
 ```php
-    /**
-     * @FormValidation(form="contactForm")
-     * @VndError(
-     *   message="foo validation failed",
-     *   logref="a1000", path="/path/to/error",
-     *   href={"_self"="/path/to/error", "help"="/path/to/help"}
-     * )
-     */
+    #[FormValidation(form: "contactForm")]
+    #[VndError(message: "foo validation failed", logref: "a1000", path: "/path/to/error", href: ["_self" => "/path/to/error", "help" => "/path/to/help"])]
 ```
 
 このオプションのモジュールはAPIアプリケーションの時に有用です。

README.md

@@ -103,21 +103,18 @@ class MyController
      */
     protected $contactForm;
 
-    /**
-     * @Inject
-     * @Named("contact_form")
-     */
+     #[Inject]
+     #[Named("contact_form")]
     public function setForm(FormInterface $form)
     {
         $this->contactForm = $form;
     }
 
-    /**
-     * @FormValidation(form="contactForm", onFailure="badRequestAction")
-     */
+     #[FormValidation(form: "contactForm", onFailure: "badRequestAction")]
     public function createAction()
     {
         // validation success
+        // More detail for `vnd.error+json` can be added with `#[VndError]`.
     }
 
     public function badRequestAction()
@@ -186,14 +183,8 @@ echo $e->error;
 More detail for `vnd.error+json`can be add with `@VndError` annotation. 
 
 ```php
-    /**
-     * @FormValidation(form="contactForm")
-     * @VndError(
-     *   message="foo validation failed",
-     *   logref="a1000", path="/path/to/error",
-     *   href={"_self"="/path/to/error", "help"="/path/to/help"}
-     * )
-     */
+    #[FormValidation(form: "contactForm")]
+    #[VndError(message: "foo validation failed", logref: "a1000", path: "/path/to/error", href: ["_self" => "/path/to/error", "help" => "/path/to/help"])]
 ```
 
 This optional module is handy for API application. 

composer.json

@@ -6,15 +6,16 @@
         "Ray.Di module"
     ],
     "require": {
-        "php": ">=7.0.0",
-        "ray/di": "^2.7",
+        "php": ">=8.0.0",
+        "ray/di": "^2.16",
+        "ray/aop": "^2.14",
         "aura/input": "^1.2",
         "aura/filter": "^2.3|3.x-dev",
         "aura/html": "^2.5",
         "ray/aura-session-module": "^1.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7.13"
+        "phpunit/phpunit": "^9.5"
     },
     "license": "MIT",
     "autoload":{
@@ -32,5 +33,10 @@
         "coverage": ["php -dzend_extension=xdebug.so ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage"],
         "cs": ["php-cs-fixer fix -v --dry-run", "phpcs --standard=./phpcs.xml src"],
         "cs-fix": ["php-cs-fixer fix -v", "phpcbf src"]
+    },
+    "config": {
+        "allow-plugins": {
+            "aura/installer-default": true
+        }
     }
 }

phpunit.xml.dist

@@ -1,19 +1,21 @@
 <phpunit bootstrap="tests/bootstrap.php">
     <testsuites>
-        <testsuite>
+        <testsuite name="Ray.WebFormModule Test Suite">
             <directory suffix="Test.php">tests</directory>
         </testsuite>
     </testsuites>
 
+    <coverage>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+        <report>
+            <html outputDirectory="build/coverage"/>
+            <clover outputFile="build/logs/clover.xml"/>
+        </report>
+    </coverage>
+
     <logging>
-        <log type="coverage-html" target="build/coverage"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-        <log type="junit" target="build/logs/junit.xml" logIncompleteSkipped="false"/>
+        <junit outputFile="build/logs/junit.xml"/>
     </logging>
-
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
 </phpunit>

src/AbstractForm.php

@@ -1,41 +1,42 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * This file is part of the Ray.WebFormModule package.
  *
  * @license http://opensource.org/licenses/MIT MIT
  */
+
 namespace Ray\WebFormModule;
 
+use ArrayIterator;
 use Aura\Filter\FilterFactory;
 use Aura\Filter\SubjectFilter;
 use Aura\Html\HelperLocator;
 use Aura\Html\HelperLocatorFactory;
 use Aura\Input\AntiCsrfInterface;
 use Aura\Input\BuilderInterface;
 use Aura\Input\Fieldset;
+use Exception;
+use Ray\Di\Di\Inject;
+use Ray\Di\Di\PostConstruct;
 use Ray\WebFormModule\Exception\CsrfViolationException;
 use Ray\WebFormModule\Exception\LogicException;
 
+use function trigger_error;
+
 abstract class AbstractForm extends Fieldset implements FormInterface
 {
-    /**
-     * @var SubjectFilter
-     */
+    /** @var SubjectFilter */
     protected $filter;
 
-    /**
-     * @var null | array
-     */
+    /** @var array|null */
     protected $errorMessages;
 
-    /**
-     * @var HelperLocator
-     */
-    protected $helper;
+    protected HelperLocator $helper;
 
-    /**
-     * @var AntiCsrfInterface
-     */
+    /** @var AntiCsrfInterface */
     protected $antiCsrf;
 
     public function __construct()
@@ -61,58 +62,51 @@ public function __toString()
             }
 
             return $this->toString();
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             trigger_error($e->getMessage() . PHP_EOL . $e->getTraceAsString(), E_USER_ERROR);
-
-            return '';
         }
+
+        return '';
     }
 
     /**
      * @param BuilderInterface     $builder
      * @param FilterFactory        $filterFactory
      * @param HelperLocatorFactory $helperFactory
-     *
-     * @\Ray\Di\Di\Inject
      */
+    #[Inject]
     public function setBaseDependencies(
         BuilderInterface $builder,
         FilterFactory $filterFactory,
         HelperLocatorFactory $helperFactory
-    ) {
+    ): void {
         $this->builder = $builder;
         $this->filter = $filterFactory->newSubjectFilter();
         $this->helper = $helperFactory->newInstance();
     }
 
-    public function setAntiCsrf(AntiCsrfInterface $antiCsrf)
+    public function setAntiCsrf(AntiCsrfInterface $antiCsrf): void
     {
         $this->antiCsrf = $antiCsrf;
     }
 
-    /**
-     * @\Ray\Di\Di\PostConstruct
-     */
-    public function postConstruct()
+    #[PostConstruct]
+    public function postConstruct(): void
     {
         $this->init();
         if ($this->antiCsrf instanceof AntiCsrfInterface) {
             $this->antiCsrf->setField($this);
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    /** {@inheritdoc} */
     public function input($input)
     {
         return $this->helper->input($this->get($input));
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function error($input)
+    /** {@inheritdoc} */
+    public function error(string $input): string
     {
         if (! $this->errorMessages) {
             $failure = $this->filter->getFailures();
@@ -131,12 +125,10 @@ public function error($input)
     /**
      * @param array $attr attributes for the form tag
      *
-     * @throws \Aura\Html\Exception\HelperNotFound
      * @throws \Aura\Input\Exception\NoSuchInput
-     *
-     * @return string
+     * @throws \Aura\Html\Exception\HelperNotFound
      */
-    public function form($attr = [])
+    public function form(array $attr = []): string
     {
         $form = $this->helper->form($attr);
         if (isset($this->inputs['__csrf_token'])) {
@@ -152,14 +144,13 @@ public function form($attr = [])
      * @param array $data
      *
      * @throws CsrfViolationException
-     *
-     * @return bool
      */
-    public function apply(array $data)
+    public function apply(array $data): bool
     {
         if ($this->antiCsrf && ! $this->antiCsrf->isValid($data)) {
             throw new CsrfViolationException;
         }
+
         $this->fill($data);
 
         return $this->filter->apply($data);
@@ -168,20 +159,16 @@ public function apply(array $data)
     /**
      * Returns all failure messages for all fields.
      *
-     * @return array
+     * @return list<string>
      */
-    public function getFailureMessages()
+    public function getFailureMessages(): array
     {
         return $this->filter->getFailures()->getMessages();
     }
 
-    /**
-     * Returns all the fields collection
-     *
-     * @return \ArrayIterator
-     */
-    public function getIterator()
+    /** Returns all the fields collection */
+    public function getIterator(): ArrayIterator
     {
-        return new \ArrayIterator($this->inputs);
+        return new ArrayIterator($this->inputs);
     }
 }