Fix PHPStan warnings.

drupol · drupol · commit f0c58fc06fc2 · 2020-05-11T09:26:50.000+02:00
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -1,44 +1,57 @@
 # https://help.github.com/en/categories/automating-your-workflow-with-github-actions
 
 on:
-  - pull_request
-  - push
+    - pull_request
+    - push
 
 name: "Continuous Integration"
 
 jobs:
-  grumphp:
-    name: "Grumphp"
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        php-binary:
-          - php7.1
-          - php7.2
-          - php7.3
-
-    steps:
-      - name: "Checkout"
-        uses: actions/checkout@master
-        with:
-            fetch-depth: 1
-
-      - name: "Composer install"
-        run: ${{ matrix.php-binary }} $(which composer) install --no-interaction --no-progress --no-suggest
-
-      - name: "Composer install lowest dependencies"
-        if: matrix.dependencies == 'lowest'
-        run: ${{ matrix.php-binary }} $(which composer) update --no-interaction --no-progress --no-suggest --prefer-lowest
-
-      - name: "Install Graphviz"
-        run: sudo apt-get install graphviz
-
-      - name: "Run Grumphp"
-        run: ${{ matrix.php-binary }} vendor/bin/grumphp run
-        env:
-            STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
-
-      - name: "Scrutinizer"
-        run: wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml
+    run:
+        name: "Grumphp"
+        runs-on: ${{ matrix.operating-system }}
+        strategy:
+            fail-fast: false
+            matrix:
+                operating-system: [ubuntu-latest, windows-latest, macOS-latest]
+                php-versions: ['7.1', '7.2', '7.3', '7.4']
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@master
+              with:
+                  fetch-depth: 1
+
+            - name: Install PHP
+              uses: shivammathur/setup-php@master
+              with:
+                  php-version: ${{ matrix.php-versions }}
+                  extensions: mbstring,xdebug
+            - name: Get Composer Cache Directory
+              id: composer-cache
+              run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+            - name: Cache dependencies
+              uses: actions/cache@v1
+              with:
+                  path: ${{ steps.composer-cache.outputs.dir }}
+                  key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+                  restore-keys: ${{ runner.os }}-composer-
+
+            - name: Install dependencies
+              run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
+
+            - name: Run Grumphp
+              run: vendor/bin/grumphp run --no-ansi -n
+              env:
+                  STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
+
+            - name: Send PSALM data
+              run: vendor/bin/psalm --shepherd --stats
+              continue-on-error: true
+
+            - name: Scrutinizer
+              run: |
+                  wget https://scrutinizer-ci.com/ocular.phar
+                  php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml
+              continue-on-error: true
diff --git a/composer.json b/composer.json
@@ -13,7 +13,7 @@
         "product"
     ],
     "homepage": "https://github.com/drupol/phpermutations",
-    "license": "GPL-3.0-only",
+    "license": "MIT",
     "authors": [
         {
             "name": "Pol Dellaiera",
@@ -24,10 +24,9 @@
         "php": ">= 7.1.3"
     },
     "require-dev": {
-        "drupol/php-conventions": "^1.6.8",
+        "drupol/php-conventions": "^1.7.1",
         "phpunit/php-code-coverage": "^4 || ^5",
-        "phpunit/phpunit": "^6 || ^7",
-        "symfony/process": "^4.4.1"
+        "phpunit/phpunit": "^6 || ^7"
     },
     "config": {
         "sort-packages": true
diff --git a/src/Combinatorics.php b/src/Combinatorics.php
@@ -6,9 +6,6 @@
 
 use function count;
 
-/**
- * Class Combinatorics.
- */
 abstract class Combinatorics
 {
     /**
diff --git a/src/Generators/Fibonacci.php b/src/Generators/Fibonacci.php
@@ -8,9 +8,6 @@
 use drupol\phpermutations\Iterators\Fibonacci as FibonacciIterator;
 use Generator;
 
-/**
- * Class Fibonacci.
- */
 class Fibonacci extends FibonacciIterator implements GeneratorInterface
 {
     /**
diff --git a/src/Generators/NGrams.php b/src/Generators/NGrams.php
@@ -8,9 +8,6 @@
 use drupol\phpermutations\Iterators\NGrams as NGramsIterator;
 use Generator;
 
-/**
- * Class NGrams.
- */
 class NGrams extends NGramsIterator implements GeneratorInterface
 {
     /**
diff --git a/src/Generators/Perfect.php b/src/Generators/Perfect.php
@@ -7,9 +7,6 @@
 use drupol\phpermutations\GeneratorInterface;
 use drupol\phpermutations\Iterators\Perfect as PerfectIterator;
 
-/**
- * Class Perfect.
- */
 class Perfect extends PerfectIterator implements GeneratorInterface
 {
     /**
diff --git a/src/Generators/Permutations.php b/src/Generators/Permutations.php
@@ -10,9 +10,6 @@
 
 use function count;
 
-/**
- * Class Permutations.
- */
 class Permutations extends Combinatorics implements GeneratorInterface
 {
     /**
diff --git a/src/Generators/Prime.php b/src/Generators/Prime.php
@@ -7,9 +7,6 @@
 use drupol\phpermutations\GeneratorInterface;
 use drupol\phpermutations\Iterators\Prime as PrimeIterator;
 
-/**
- * Class Prime.
- */
 class Prime extends PrimeIterator implements GeneratorInterface
 {
     /**
diff --git a/src/Generators/PrimeFactors.php b/src/Generators/PrimeFactors.php
@@ -7,9 +7,6 @@
 use drupol\phpermutations\GeneratorInterface;
 use drupol\phpermutations\Iterators\PrimeFactors as PrimeFactorsIterator;
 
-/**
- * Class PrimeFactors.
- */
 class PrimeFactors extends PrimeFactorsIterator implements GeneratorInterface
 {
     /**
diff --git a/src/Generators/Product.php b/src/Generators/Product.php
@@ -10,9 +10,6 @@
 
 use function count;
 
-/**
- * Class Product.
- */
 class Product extends ProductIterator implements GeneratorInterface
 {
     /**
diff --git a/src/Generators/Shift.php b/src/Generators/Shift.php
@@ -7,9 +7,6 @@
 use drupol\phpermutations\GeneratorInterface;
 use drupol\phpermutations\Iterators\Shift as ShiftIterator;
 
-/**
- * Class Shift.
- */
 class Shift extends ShiftIterator implements GeneratorInterface
 {
     /**
diff --git a/src/Iterators.php b/src/Iterators.php
@@ -6,9 +6,6 @@
 
 use Countable;
 
-/**
- * Class Iterators.
- */
 abstract class Iterators extends Combinatorics implements Countable, IteratorInterface
 {
     /**
@@ -41,6 +38,8 @@ public function key()
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function rewind()
     {
diff --git a/src/Iterators/Combinations.php b/src/Iterators/Combinations.php
@@ -6,9 +6,6 @@
 
 use drupol\phpermutations\Iterators;
 
-/**
- * Class Combinations.
- */
 class Combinations extends Iterators
 {
     /**
@@ -62,6 +59,8 @@ public function current()
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function next()
     {
@@ -83,6 +82,8 @@ public function rewind()
 
     /**
      * {@inheritdoc}
+     *
+     * @return bool
      */
     public function valid()
     {
diff --git a/src/Iterators/Cycle.php b/src/Iterators/Cycle.php
@@ -8,9 +8,6 @@
 
 use function count;
 
-/**
- * Class Cycle.
- */
 class Cycle extends Iterators
 {
     /**
@@ -31,6 +28,8 @@ public function current()
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function next()
     {
@@ -47,6 +46,8 @@ public function rewind()
 
     /**
      * {@inheritdoc}
+     *
+     * @return bool
      */
     public function valid()
     {
diff --git a/src/Iterators/Fibonacci.php b/src/Iterators/Fibonacci.php
@@ -8,9 +8,6 @@
 
 use const PHP_INT_MAX;
 
-/**
- * Class Fibonacci.
- */
 class Fibonacci extends Iterators
 {
     /**
@@ -54,6 +51,8 @@ public function getMaxLimit()
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function next()
     {
@@ -76,6 +75,8 @@ public function rewind()
      *
      * @param int $max
      *                 The limit
+     *
+     * @return void
      */
     public function setMaxLimit($max)
     {
@@ -84,6 +85,8 @@ public function setMaxLimit($max)
 
     /**
      * {@inheritdoc}
+     *
+     * @return bool
      */
     public function valid()
     {
diff --git a/src/Iterators/FiniteGroup.php b/src/Iterators/FiniteGroup.php
@@ -61,6 +61,8 @@ public function getSize()
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function next()
     {
@@ -94,6 +96,8 @@ public function order($generator)
      *
      * @param int $size
      *                  The size
+     *
+     * @return void
      */
     public function setSize($size)
     {
@@ -103,6 +107,8 @@ public function setSize($size)
 
     /**
      * {@inheritdoc}
+     *
+     * @return bool
      */
     public function valid()
     {
@@ -111,6 +117,8 @@ public function valid()
 
     /**
      * Clean out the group from unwanted values.
+     *
+     * @return void
      */
     private function computeGroup()
     {
diff --git a/src/Iterators/NGrams.php b/src/Iterators/NGrams.php
@@ -6,9 +6,6 @@
 
 use function array_slice;
 
-/**
- * Class NGrams.
- */
 class NGrams extends Shift
 {
     /**
@@ -45,6 +42,8 @@ public function current()
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function next()
     {
@@ -54,6 +53,8 @@ public function next()
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function rewind()
     {
diff --git a/src/Iterators/Perfect.php b/src/Iterators/Perfect.php
diff --git a/src/Iterators/Prime.php b/src/Iterators/Prime.php
diff --git a/src/Iterators/PrimeFactors.php b/src/Iterators/PrimeFactors.php
diff --git a/src/Iterators/Product.php b/src/Iterators/Product.php
diff --git a/src/Iterators/Rotation.php b/src/Iterators/Rotation.php
diff --git a/src/Iterators/Shift.php b/src/Iterators/Shift.php

Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,6 @@`
`6`	`6`
`7`	`7`	`use function count;`
`8`	`8`
`9`		`-/**`
`10`		`- * Class Combinatorics.`
`11`		`- */`
`12`	`9`	`abstract class Combinatorics`
`13`	`10`	`{`
`14`	`11`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,6 @@`
`8`	`8`	`use drupol\phpermutations\Iterators\Fibonacci as FibonacciIterator;`
`9`	`9`	`use Generator;`
`10`	`10`
`11`		`-/**`
`12`		`- * Class Fibonacci.`
`13`		`- */`
`14`	`11`	`class Fibonacci extends FibonacciIterator implements GeneratorInterface`
`15`	`12`	`{`
`16`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,6 @@`
`8`	`8`	`use drupol\phpermutations\Iterators\NGrams as NGramsIterator;`
`9`	`9`	`use Generator;`
`10`	`10`
`11`		`-/**`
`12`		`- * Class NGrams.`
`13`		`- */`
`14`	`11`	`class NGrams extends NGramsIterator implements GeneratorInterface`
`15`	`12`	`{`
`16`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,6 @@`
`7`	`7`	`use drupol\phpermutations\GeneratorInterface;`
`8`	`8`	`use drupol\phpermutations\Iterators\Perfect as PerfectIterator;`
`9`	`9`
`10`		`-/**`
`11`		`- * Class Perfect.`
`12`		`- */`
`13`	`10`	`class Perfect extends PerfectIterator implements GeneratorInterface`
`14`	`11`	`{`
`15`	`12`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,6 @@`
`10`	`10`
`11`	`11`	`use function count;`
`12`	`12`
`13`		`-/**`
`14`		`- * Class Permutations.`
`15`		`- */`
`16`	`13`	`class Permutations extends Combinatorics implements GeneratorInterface`
`17`	`14`	`{`
`18`	`15`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,6 @@`
`7`	`7`	`use drupol\phpermutations\GeneratorInterface;`
`8`	`8`	`use drupol\phpermutations\Iterators\Prime as PrimeIterator;`
`9`	`9`
`10`		`-/**`
`11`		`- * Class Prime.`
`12`		`- */`
`13`	`10`	`class Prime extends PrimeIterator implements GeneratorInterface`
`14`	`11`	`{`
`15`	`12`	`/**`