Improve readme + Adopt psalm + Update dev dependencies (#95)

vjik · web-flow · commit f149e6b3501d · 2021-01-15T14:06:25.000+03:00
diff --git a/README.md b/README.md
@@ -27,6 +27,18 @@ The package provides data validation capabilities.
 - Could pass context to validation rule.
 - Common rules bundled.
 
+## Requirements
+
+- PHP 7.4 or higher.
+
+## Installation
+
+The package could be installed with composer:
+
+```shell
+composer require yiisoft/validator --prefer-dist
+```
+
 ## General usage
 
 Library could be used in two ways: validating a single value and validating a set of data.
@@ -238,6 +250,8 @@ foreach ($results as $attribute => $result) {
 }
 ```
 
+## Testing
+
 ### Unit testing
 
 The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
@@ -248,10 +262,11 @@ The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
 
 ### Mutation testing
 
-The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
+The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
+[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
 
 ```shell
-./vendor/bin/infection
+./vendor/bin/roave-infection-static-analysis-plugin
 ```
 
 ### Static analysis
@@ -262,22 +277,21 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
 ./vendor/bin/psalm
 ```
 
-### Support the project
+## License
+
+The Yii Validator is free software. It is released under the terms of the BSD License.
+Please see [`LICENSE`](./LICENSE.md) for more information.
+
+Maintained by [Yii Software](https://www.yiiframework.com/).
+
+## Support the project
 
 [![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)
 
-### Follow updates
+## Follow updates
 
 [![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
 [![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)
 [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
 [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
 [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
-
-## License
-
-The Yii Validator is free software. It is released under the terms of the BSD License.
-Please see [`LICENSE`](./LICENSE.md) for more information.
-
-Maintained by [Yii Software](https://www.yiiframework.com/).
-
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "yiisoft/validator",
     "type": "library",
-    "description": "Yii validator",
+    "description": "Yii Validator",
     "keywords": [
         "validation",
         "validator"
@@ -34,10 +34,10 @@
         "yiisoft/translator": "dev-master"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.4",
-        "roave/infection-static-analysis-plugin": "^1.5",
+        "phpunit/phpunit": "^9.5",
+        "roave/infection-static-analysis-plugin": "^1.7",
         "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.2"
+        "vimeo/psalm": "^4.3"
     },
     "autoload": {
         "psr-4": {
diff --git a/src/ResultSet.php b/src/ResultSet.php
@@ -4,11 +4,15 @@
 
 namespace Yiisoft\Validator;
 
+use ArrayIterator;
+use InvalidArgumentException;
+use IteratorAggregate;
+
 /**
  * ResultSet stores validation result of each attribute from {@link DataSetInterface}.
  * It is typically obtained by validating data set with {@link Validator}.
  */
-final class ResultSet implements \IteratorAggregate
+final class ResultSet implements IteratorAggregate
 {
     /**
      * @var Result[]
@@ -34,17 +38,14 @@ public function addResult(
     public function getResult(string $attribute): Result
     {
         if (!isset($this->results[$attribute])) {
-            throw new \InvalidArgumentException("There is no result for attribute \"$attribute\"");
+            throw new InvalidArgumentException("There is no result for attribute \"$attribute\"");
         }
 
         return $this->results[$attribute];
     }
 
-    /**
-     * @return \ArrayIterator|Result[]|\Traversable
-     */
-    public function getIterator()
+    public function getIterator(): ArrayIterator
     {
-        return new \ArrayIterator($this->results);
+        return new ArrayIterator($this->results);
     }
 }
diff --git a/src/Rule/Email.php b/src/Rule/Email.php
@@ -69,6 +69,7 @@ protected function validateValue($value, DataSetInterface $dataSet = null): Resu
         )) {
             $valid = false;
         } else {
+            /** @psalm-var array{name:string,local:string,open:string,domain:string,close:string} $matches */
             if ($this->enableIDN) {
                 $matches['local'] = $this->idnToAscii($matches['local']);
                 $matches['domain'] = $this->idnToAscii($matches['domain']);

Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,15 @@`
`4`	`4`
`5`	`5`	`namespace Yiisoft\Validator;`
`6`	`6`
	`7`	`+use ArrayIterator;`
	`8`	`+use InvalidArgumentException;`
	`9`	`+use IteratorAggregate;`
	`10`	`+`
`7`	`11`	`/**`
`8`	`12`	`* ResultSet stores validation result of each attribute from {@link DataSetInterface}.`
`9`	`13`	`* It is typically obtained by validating data set with {@link Validator}.`
`10`	`14`	`*/`
`11`		`-final class ResultSet implements \IteratorAggregate`
	`15`	`+final class ResultSet implements IteratorAggregate`
`12`	`16`	`{`
`13`	`17`	`/**`
`14`	`18`	`* @var Result[]`
`@@ -34,17 +38,14 @@ public function addResult(`
`34`	`38`	`public function getResult(string $attribute): Result`
`35`	`39`	`{`
`36`	`40`	`if (!isset($this->results[$attribute])) {`
`37`		`- throw new \InvalidArgumentException("There is no result for attribute \"$attribute\"");`
	`41`	`+ throw new InvalidArgumentException("There is no result for attribute \"$attribute\"");`
`38`	`42`	`}`
`39`	`43`
`40`	`44`	`return $this->results[$attribute];`
`41`	`45`	`}`
`42`	`46`
`43`		`- /**`
`44`		`- * @return \ArrayIterator\|Result[]\|\Traversable`
`45`		`- */`
`46`		`- public function getIterator()`
	`47`	`+ public function getIterator(): ArrayIterator`
`47`	`48`	`{`
`48`		`- return new \ArrayIterator($this->results);`
	`49`	`+ return new ArrayIterator($this->results);`
`49`	`50`	`}`
`50`	`51`	`}`