Add Psalm (#146)

giorgiosironi · Dec 5, 2021 · 59efb45 · 59efb45
1 parent 7feac74
commit 59efb45
Show file tree

Hide file tree

Showing 55 changed files with 373 additions and 216 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,9 +19,11 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-      - name: Remove phpstan from dev dependecies for older php versions
+      - name: Remove dev dependecies for older php versions
         if: ${{ matrix.php < 7.1 }}
-        run: composer remove --dev phpstan/phpstan --ignore-platform-reqs --no-update
+        run: |
+          composer remove --dev phpstan/phpstan --ignore-platform-reqs --no-update
+          composer remove --dev psalm/phar --ignore-platform-reqs --no-update
       - name: Install dependencies
         uses: ramsey/composer-install@v1
         with:
@@ -48,9 +50,11 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-      - name: Remove phpstan from dev dependecies for older php versions
+      - name: Remove dev dependecies for older php versions
         if: ${{ matrix.php < 7.1 }}
-        run: composer remove --dev phpstan/phpstan --ignore-platform-reqs --no-update
+        run: |
+          composer remove --dev phpstan/phpstan --ignore-platform-reqs --no-update
+          composer remove --dev psalm/phar --ignore-platform-reqs --no-update
       - name: Install dependencies
         uses: ramsey/composer-install@v1
       - name: Download phpunit phar

diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -12,7 +12,9 @@ jobs:
           - description: Code style
             script: vendor/bin/php-cs-fixer fix --verbose --diff --dry-run
           - description: PHPStan
-            script: vendor/bin/phpstan analyse -c phpstan.neon
+            script: vendor/bin/phpstan
+          - description: Psalm
+            script: vendor/bin/psalm.phar
     name: ${{ matrix.description }}
     runs-on: ubuntu-latest
     steps:

diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ composer.lock
 docs/_build
 .phpunit.result.cache
 docker-compose.override.yml
+.psalm-cache/
diff --git a/composer.json b/composer.json
@@ -24,7 +24,8 @@
         "sebastian/comparator": ">=1.2.4",
         "friendsofphp/php-cs-fixer": "^2.0",
         "icomefromthenet/reverse-regex": "v0.0.6.3",
-        "phpstan/phpstan": "^1.2"
+        "phpstan/phpstan": "^1.2",
+        "psalm/phar": "^4.13"
     },
     "suggest":
     {
@@ -55,8 +56,9 @@
             "composer update",
             "vendor/bin/phpunit test"
         ],
-        "phpstan": [
-            "vendor/bin/phpstan analyse -c phpstan.neon"
+        "static": [
+            "vendor/bin/phpstan",
+            "vendor/bin/psalm.phar"
         ],
         "phpstan-baseline": [
             "vendor/bin/phpstan analyse -c phpstan.neon --generate-baseline"

diff --git a/examples/AlwaysFailsTest.php b/examples/AlwaysFailsTest.php
@@ -1,5 +1,6 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
 use Eris\TestTrait;
 
 class AlwaysFailsTest extends \PHPUnit_Framework_TestCase
@@ -9,7 +10,7 @@ class AlwaysFailsTest extends \PHPUnit_Framework_TestCase
     public function testFailsNoMatterWhatIsTheInput()
     {
         $this->forAll(
-            Generator\elements(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j'])
+            Generators::elements(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j'])
         )
             ->then(function ($someChar) {
                 $this->fail("This test fails by design. '$someChar' was passed in");

diff --git a/examples/AssociativeArrayTest.php b/examples/AssociativeArrayTest.php
@@ -1,5 +1,6 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
 
 class AssociativeArrayTest extends PHPUnit_Framework_TestCase
 {
@@ -8,9 +9,9 @@ class AssociativeArrayTest extends PHPUnit_Framework_TestCase
     public function testAssociativeArraysGeneratedOnStandardKeys()
     {
         $this->forAll(
-            Generator\associative([
-                'letter' => Generator\elements("A", "B", "C"),
-                'cipher' => Generator\choose(0, 9),
+            Generators::associative([
+                'letter' => Generators::elements("A", "B", "C"),
+                'cipher' => Generators::choose(0, 9),
             ])
         )
             ->then(function ($array) {

diff --git a/examples/BindTest.php b/examples/BindTest.php
@@ -1,5 +1,6 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
 
 class BindTest extends PHPUnit_Framework_TestCase
 {
@@ -8,12 +9,12 @@ class BindTest extends PHPUnit_Framework_TestCase
     public function testCreatingABrandNewGeneratorFromAGeneratedValueSingle()
     {
         $this->forAll(
-            Generator\bind(
-                Generator\vector(4, Generator\nat()),
+            Generators::bind(
+                Generators::vector(4, Generators::nat()),
                 function ($vector) {
-                    return Generator\tuple(
-                        Generator\elements($vector),
-                        Generator\constant($vector)
+                    return Generators::tuple(
+                        Generators::elements($vector),
+                        Generators::constant($vector)
                     );
                 }
             )

diff --git a/examples/BooleanTest.php b/examples/BooleanTest.php
@@ -1,5 +1,6 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
 use Eris\TestTrait;
 
 class BooleanTest extends PHPUnit_Framework_TestCase
@@ -9,7 +10,7 @@ class BooleanTest extends PHPUnit_Framework_TestCase
     public function testBooleanValueIsTrueOrFalse()
     {
         $this->forAll(
-            Generator\bool()
+            Generators::bool()
         )
             ->then(function ($boolValue) {
                 $this->assertTrue(

diff --git a/examples/CharacterTest.php b/examples/CharacterTest.php
@@ -1,6 +1,7 @@
 <?php
-use Eris\Generator;
-use Eris\Antecedent;
+
+use Eris\Antecedents;
+use Eris\Generators;
 
 class CharacterTest extends PHPUnit_Framework_TestCase
 {
@@ -9,7 +10,7 @@ class CharacterTest extends PHPUnit_Framework_TestCase
     public function testLengthOfAsciiCharactersInPhp()
     {
         $this->forAll(
-            Generator\char(['basic-latin'])
+            Generators::char(['basic-latin'])
         )
             ->then(function ($char) {
                 $this->assertLenghtIs1($char);
@@ -19,9 +20,9 @@ public function testLengthOfAsciiCharactersInPhp()
     public function testLengthOfPrintableAsciiCharacters()
     {
         $this->forAll(
-            Generator\char(['basic-latin'])
+            Generators::char(['basic-latin'])
         )
-            ->when(Antecedent\printableCharacter())
+            ->when(Antecedents::printableCharacter())
             ->then(function ($char) {
                 $this->assertFalse(ord($char) < 32);
             });
@@ -32,10 +33,10 @@ public function testMultiplePrintableCharacters()
         $this
             ->minimumEvaluationRatio(0.1)
             ->forAll(
-                Generator\char(['basic-latin']),
-                Generator\char(['basic-latin'])
+                Generators::char(['basic-latin']),
+                Generators::char(['basic-latin'])
             )
-            ->when(Antecedent\printableCharacters())
+            ->when(Antecedents::printableCharacters())
             ->then(function ($first, $second) {
                 $this->assertFalse(ord($first) < 32);
                 $this->assertFalse(ord($second) < 32);
@@ -49,10 +50,10 @@ public function testMultiplePrintableCharactersFromAnnotation()
     {
         $this
             ->forAll(
-                Generator\char(['basic-latin']),
-                Generator\char(['basic-latin'])
+                Generators::char(['basic-latin']),
+                Generators::char(['basic-latin'])
             )
-            ->when(Antecedent\printableCharacters())
+            ->when(Antecedents::printableCharacters())
             ->then(function ($first, $second) {
                 $this->assertFalse(ord($first) < 32);
                 $this->assertFalse(ord($second) < 32);

diff --git a/examples/ChooseTest.php b/examples/ChooseTest.php
@@ -1,5 +1,6 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
 use Eris\TestTrait;
 
 class ChooseTest extends PHPUnit_Framework_TestCase
@@ -9,8 +10,8 @@ class ChooseTest extends PHPUnit_Framework_TestCase
     public function testSumOfTwoIntegersFromBoundedRangesIsCommutative()
     {
         $this->forAll(
-            Generator\choose(-1000, 430),
-            Generator\choose(230, -30000)
+            Generators::choose(-1000, 430),
+            Generators::choose(230, -30000)
         )
             ->then(function ($first, $second) {
                 $x = $first + $second;

diff --git a/examples/CollectTest.php b/examples/CollectTest.php
@@ -1,7 +1,8 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
+use Eris\Listeners;
 use Eris\TestTrait;
-use Eris\Listener;
 
 class CollectTest extends PHPUnit_Framework_TestCase
 {
@@ -10,8 +11,8 @@ class CollectTest extends PHPUnit_Framework_TestCase
     public function testGeneratedDataCollectionOnScalars()
     {
         $this
-            ->forAll(Generator\neg())
-            ->hook(Listener\collectFrequencies())
+            ->forAll(Generators::neg())
+            ->hook(Listeners::collectFrequencies())
             ->then(function ($x) {
                 $this->assertTrue($x < $x + 1);
             });
@@ -21,10 +22,10 @@ public function testGeneratedDataCollectionOnMoreComplexDataStructures()
     {
         $this
             ->forAll(
-                Generator\vector(2, Generator\int()),
-                Generator\char()
+                Generators::vector(2, Generators::int()),
+                Generators::char()
             )
-            ->hook(Listener\collectFrequencies())
+            ->hook(Listeners::collectFrequencies())
             ->then(function ($vector) {
                 $this->assertEquals(2, count($vector));
             });
@@ -34,10 +35,10 @@ public function testGeneratedDataCollectionWithCustomMapper()
     {
         $this
             ->forAll(
-                Generator\seq(Generator\nat())
+                Generators::seq(Generators::nat())
             )
             ->withMaxSize(10)
-            ->hook(Listener\collectFrequencies(function ($array) {
+            ->hook(Listeners::collectFrequencies(function ($array) {
                 return count($array);
             }))
             ->then(function ($array) {

diff --git a/examples/ConstantTest.php b/examples/ConstantTest.php
@@ -1,6 +1,6 @@
 <?php
 
-use Eris\Generator;
+use Eris\Generators;
 
 class ConstantTest extends \PHPUnit_Framework_TestCase
 {
@@ -10,8 +10,8 @@ public function testUseConstantGeneratorExplicitly()
     {
         $this
             ->forAll(
-                Generator\nat(),
-                Generator\constant(2)
+                Generators::nat(),
+                Generators::constant(2)
             )
             ->then(function ($number, $alwaysTwo) {
                 $this->assertTrue(($number * $alwaysTwo % 2) === 0);
@@ -22,7 +22,7 @@ public function testUseConstantGeneratorImplicitly()
     {
         $this
             ->forAll(
-                Generator\nat(),
+                Generators::nat(),
                 2
             )
             ->then(function ($number, $alwaysTwo) {

diff --git a/examples/DateTest.php b/examples/DateTest.php
@@ -1,5 +1,6 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
 
 class DateTest extends PHPUnit_Framework_TestCase
 {
@@ -8,7 +9,7 @@ class DateTest extends PHPUnit_Framework_TestCase
     public function testYearOfADate()
     {
         $this->forAll(
-            Generator\date("2014-01-01T00:00:00", "2014-12-31T23:59:59")
+            Generators::date("2014-01-01T00:00:00", "2014-12-31T23:59:59")
         )
             ->then(function (DateTime $date) {
                 $this->assertEquals(
@@ -21,7 +22,7 @@ public function testYearOfADate()
     public function testDefaultValuesForTheInterval()
     {
         $this->forAll(
-            Generator\date()
+            Generators::date()
         )
             ->then(function (DateTime $date) {
                 $this->assertGreaterThanOrEqual(
@@ -38,9 +39,9 @@ public function testDefaultValuesForTheInterval()
     public function testFromDayOfYearFactoryMethodRespectsDistanceBetweenDays()
     {
         $this->forAll(
-            Generator\choose(2000, 2020),
-            Generator\choose(0, 364),
-            Generator\choose(0, 364)
+            Generators::choose(2000, 2020),
+            Generators::choose(0, 364),
+            Generators::choose(0, 364)
         )
         ->then(function ($year, $dayOfYear, $anotherDayOfYear) {
             $day = fromZeroBasedDayOfYear($year, $dayOfYear);

diff --git a/examples/DifferentElementsTest.php b/examples/DifferentElementsTest.php
@@ -1,5 +1,6 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
 use Eris\TestTrait;
 
 class Type
@@ -55,12 +56,12 @@ function ($candidate) use ($whatToRemove) {
         };
 
         $this
-            ->forAll(Generator\bind(
+            ->forAll(Generators::bind(
                 call_user_func_array('Eris\Generator\elements', $allTypes),
                 function ($first) use ($allTypes, $remove) {
-                    return Generator\tuple(
-                        Generator\constant($first),
-                        Generator\elements($remove($allTypes, $first))
+                    return Generators::tuple(
+                        Generators::constant($first),
+                        Generators::elements($remove($allTypes, $first))
                     );
                 }
             ))

diff --git a/examples/DisableShrinkingTest.php b/examples/DisableShrinkingTest.php
@@ -1,5 +1,6 @@
 <?php
-use Eris\Generator;
+
+use Eris\Generators;
 use Eris\TestTrait;
 
 class DisableShrinkingTest extends \PHPUnit_Framework_TestCase
@@ -19,7 +20,7 @@ public function testThenIsNotCalledMultipleTime()
         $this->calls = 0;
         $this
             ->forAll(
-                Generator\nat()
+                Generators::nat()
             )
             ->disableShrinking()
             ->then(function ($number) {