Add PHPStan (#171)

antonkomarev · web-flow · commit c037dde910be · 2020-06-21T14:18:45.000+03:00
Add PHPStan analysis
diff --git a/.phpstan.neon b/.phpstan.neon
@@ -0,0 +1,5 @@
+parameters:
+    level: 0
+    paths:
+        - src
+        - tests
diff --git a/.travis.yml b/.travis.yml
@@ -17,4 +17,5 @@ before_script:
   - if [[ $setup = 'lowest' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-lowest --prefer-stable; fi
 
 script:
+  - ./vendor/bin/phpstan analyse -c .phpstan.neon
   - ./vendor/bin/phpunit -c phpunit.xml.dist --verbose
diff --git a/composer.json b/composer.json
@@ -54,6 +54,7 @@
         "mockery/mockery": "^1.0",
         "orchestra/database": "~3.7.0|~3.8.0|^4.0|^5.0",
         "orchestra/testbench": "~3.7.0|~3.8.0|^4.0|^5.0",
+        "phpstan/phpstan": "^0.12.29",
         "phpunit/phpunit": "^7.5|^8.0|^9.0"
     },
     "autoload": {
diff --git a/src/Console/Commands/ReactionTypeAdd.php b/src/Console/Commands/ReactionTypeAdd.php
@@ -73,6 +73,9 @@ public function handle(): int
         return 0;
     }
 
+    /**
+     * @return array[]
+     */
     protected function getOptions(): array
     {
         return [
diff --git a/src/Console/Commands/Recount.php b/src/Console/Commands/Recount.php
@@ -47,7 +47,7 @@ final class Recount extends Command
     /**
      * Get the console command options.
      *
-     * @return array
+     * @return array[]
      */
     protected function getOptions(
     ): array {
diff --git a/src/Console/Commands/RegisterReactants.php b/src/Console/Commands/RegisterReactants.php
@@ -35,6 +35,9 @@ final class RegisterReactants extends Command
      */
     protected $description = 'Register Reactable models as Reactants';
 
+    /**
+     * @return array[]
+     */
     protected function getOptions(): array
     {
         return [
diff --git a/src/Console/Commands/RegisterReacters.php b/src/Console/Commands/RegisterReacters.php
@@ -35,6 +35,9 @@ final class RegisterReacters extends Command
      */
     protected $description = 'Register Reacterable models as Reacters';
 
+    /**
+     * @return array[]
+     */
     protected function getOptions(): array
     {
         return [
diff --git a/src/Console/Commands/SetupReactable.php b/src/Console/Commands/SetupReactable.php
@@ -42,10 +42,19 @@ final class SetupReactable extends Command
      */
     protected $description = 'Set up reactable model';
 
+    /**
+     * @var Filesystem
+     */
     private $files;
 
+    /**
+     * @var MigrationCreator
+     */
     private $creator;
 
+    /**
+     * @var Composer
+     */
     private $composer;
 
     public function __construct(Filesystem $files, MigrationCreator $creator, Composer $composer)
@@ -133,6 +142,9 @@ public function handle(): int
         return 0;
     }
 
+    /**
+     * @return array[]
+     */
     protected function getOptions(): array
     {
         return [
diff --git a/src/Console/Commands/SetupReacterable.php b/src/Console/Commands/SetupReacterable.php
@@ -42,10 +42,19 @@ final class SetupReacterable extends Command
      */
     protected $description = 'Set up reacterable model';
 
+    /**
+     * @var Filesystem
+     */
     private $files;
 
+    /**
+     * @var MigrationCreator
+     */
     private $creator;
 
+    /**
+     * @var Composer
+     */
     private $composer;
 
     public function __construct(Filesystem $files, MigrationCreator $creator, Composer $composer)
@@ -133,6 +142,9 @@ public function handle(): int
         return 0;
     }
 
+    /**
+     * @return array[]
+     */
     protected function getOptions(): array
     {
         return [
diff --git a/src/Reactant/Facades/Reactant.php b/src/Reactant/Facades/Reactant.php
@@ -23,18 +23,27 @@
 final class Reactant implements
     ReacterFacadeContract
 {
+    /**
+     * @var ReactantContract
+     */
     private $reactant;
 
     public function __construct(ReactantContract $reactant)
     {
         $this->reactant = $reactant;
     }
 
+    /**
+     * @return iterable|\Cog\Contracts\Love\Reaction\Models\Reaction[]
+     */
     public function getReactions(): iterable
     {
         return $this->reactant->getReactions();
     }
 
+    /**
+     * @return iterable|\Cog\Contracts\Love\Reactant\ReactionCounter\Models\ReactionCounter[]
+     */
     public function getReactionCounters(): iterable
     {
         return $this->reactant->getReactionCounters();
diff --git a/src/Reactant/Jobs/RebuildReactionAggregatesJob.php b/src/Reactant/Jobs/RebuildReactionAggregatesJob.php
@@ -122,7 +122,7 @@ private function resetCountersValues(
     }
 
     /**
-     * @return \Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection
+     * @return \Cog\Laravel\Love\Reaction\Models\Reaction[]|\Illuminate\Database\Eloquent\Collection
      */
     private function collectReactions(
     ): iterable {
diff --git a/src/Reactant/Models/NullReactant.php b/src/Reactant/Models/NullReactant.php
@@ -28,6 +28,9 @@
 final class NullReactant implements
     ReactantContract
 {
+    /**
+     * @var ReactableContract
+     */
     private $reactable;
 
     public function __construct(
diff --git a/src/Reactant/Models/Reactant.php b/src/Reactant/Models/Reactant.php
@@ -38,10 +38,16 @@ final class Reactant extends Model implements
 {
     protected $table = 'love_reactants';
 
+    /**
+     * @var string[]
+     */
     protected $fillable = [
         'type',
     ];
 
+    /**
+     * @var string[]
+     */
     protected $casts = [
         'id' => 'string',
     ];
diff --git a/src/Reactant/ReactionCounter/Models/NullReactionCounter.php b/src/Reactant/ReactionCounter/Models/NullReactionCounter.php
@@ -21,8 +21,14 @@
 final class NullReactionCounter implements
     ReactionCounterContract
 {
+    /**
+     * @var ReactantContract
+     */
     private $reactant;
 
+    /**
+     * @var ReactionTypeContract
+     */
     private $reactionType;
 
     public function __construct(
diff --git a/src/Reactant/ReactionCounter/Models/ReactionCounter.php b/src/Reactant/ReactionCounter/Models/ReactionCounter.php
@@ -30,17 +30,26 @@ final class ReactionCounter extends Model implements
 
     protected $table = 'love_reactant_reaction_counters';
 
+    /**
+     * @var array<int|float>
+     */
     protected $attributes = [
         'count' => self::COUNT_DEFAULT,
         'weight' => self::WEIGHT_DEFAULT,
     ];
 
+    /**
+     * @var string[]
+     */
     protected $fillable = [
         'reaction_type_id',
         'count',
         'weight',
     ];
 
+    /**
+     * @var string[]
+     */
     protected $casts = [
         'count' => 'integer',
         'weight' => 'float',
diff --git a/src/Reactant/ReactionCounter/Services/ReactionCounterService.php b/src/Reactant/ReactionCounter/Services/ReactionCounterService.php
@@ -21,6 +21,9 @@
 
 final class ReactionCounterService
 {
+    /**
+     * @var ReactantContract
+     */
     private $reactant;
 
     public function __construct(
diff --git a/src/Reactant/ReactionTotal/Models/NullReactionTotal.php b/src/Reactant/ReactionTotal/Models/NullReactionTotal.php
@@ -20,6 +20,9 @@
 final class NullReactionTotal implements
     ReactionTotalContract
 {
+    /**
+     * @var ReactantContract
+     */
     private $reactant;
 
     public function __construct(
diff --git a/src/Reactant/ReactionTotal/Models/ReactionTotal.php b/src/Reactant/ReactionTotal/Models/ReactionTotal.php
@@ -28,16 +28,25 @@ final class ReactionTotal extends Model implements
 
     protected $table = 'love_reactant_reaction_totals';
 
+    /**
+     * @var array<int|float>
+     */
     protected $attributes = [
         'count' => self::COUNT_DEFAULT,
         'weight' => self::WEIGHT_DEFAULT,
     ];
 
+    /**
+     * @var string[]
+     */
     protected $fillable = [
         'count',
         'weight',
     ];
 
+    /**
+     * @var string[]
+     */
     protected $casts = [
         'count' => 'integer',
         'weight' => 'float',
diff --git a/src/Reactant/ReactionTotal/Services/ReactionTotalService.php b/src/Reactant/ReactionTotal/Services/ReactionTotalService.php
@@ -20,6 +20,9 @@
 
 final class ReactionTotalService
 {
+    /**
+     * @var ReactionTotalContract
+     */
     private $reactionTotal;
 
     public function __construct(
diff --git a/src/Reacter/Facades/Reacter.php b/src/Reacter/Facades/Reacter.php
@@ -21,13 +21,19 @@
 final class Reacter implements
     ReacterFacadeContract
 {
+    /**
+     * @var ReacterContract
+     */
     private $reacter;
 
     public function __construct(ReacterContract $reacter)
     {
         $this->reacter = $reacter;
     }
 
+    /**
+     * @return iterable|\Cog\Contracts\Love\Reaction\Models\Reaction[]
+     */
     public function getReactions(): iterable
     {
         return $this->reacter->getReactions();
diff --git a/src/Reacter/Models/NullReacter.php b/src/Reacter/Models/NullReacter.php
@@ -24,6 +24,9 @@
 final class NullReacter implements
     ReacterContract
 {
+    /**
+     * @var ReacterableContract
+     */
     private $reacterable;
 
     public function __construct(
diff --git a/src/Reacter/Models/Reacter.php b/src/Reacter/Models/Reacter.php
@@ -32,10 +32,16 @@ final class Reacter extends Model implements
 {
     protected $table = 'love_reacters';
 
+    /**
+     * @var string[]
+     */
     protected $fillable = [
         'type',
     ];
 
+    /**
+     * @var string[]
+     */
     protected $casts = [
         'id' => 'string',
     ];
@@ -176,7 +182,7 @@ private function createReaction(
     /**
      * @param \Cog\Contracts\Love\Reactant\Models\Reactant $reactant
      * @param \Cog\Contracts\Love\ReactionType\Models\ReactionType $reactionType
-     * @return null|\Cog\Contracts\Love\Reaction\Models\Reaction|\Illuminate\Database\Eloquent\Model
+     * @return \Cog\Contracts\Love\Reaction\Models\Reaction|\Illuminate\Database\Eloquent\Model|null
      */
     private function findReaction(
         ReactantContract $reactant,
diff --git a/src/Reaction/Events/ReactionHasBeenAdded.php b/src/Reaction/Events/ReactionHasBeenAdded.php
@@ -17,6 +17,9 @@
 
 final class ReactionHasBeenAdded
 {
+    /**
+     * @var ReactionContract
+     */
     private $reaction;
 
     public function __construct(
diff --git a/src/Reaction/Events/ReactionHasBeenRemoved.php b/src/Reaction/Events/ReactionHasBeenRemoved.php
@@ -17,6 +17,9 @@
 
 final class ReactionHasBeenRemoved
 {
+    /**
+     * @var ReactionContract
+     */
     private $reaction;
 
     public function __construct(
diff --git a/src/Reaction/Models/Reaction.php b/src/Reaction/Models/Reaction.php
@@ -36,16 +36,25 @@ final class Reaction extends Model implements
 
     protected $table = 'love_reactions';
 
+    /**
+     * @var float[]
+     */
     protected $attributes = [
         'rate' => self::RATE_DEFAULT,
     ];
 
+    /**
+     * @var string[]
+     */
     protected $fillable = [
         'reactant_id',
         'reaction_type_id',
         'rate',
     ];
 
+    /**
+     * @var string[]
+     */
     protected $casts = [
         'id' => 'string',
         'rate' => 'float',
diff --git a/src/Reaction/Observers/ReactionObserver.php b/src/Reaction/Observers/ReactionObserver.php
@@ -20,6 +20,9 @@
 
 final class ReactionObserver
 {
+    /**
+     * @var DispatcherContract
+     */
     private $eventDispatcher;
 
     public function __construct(
diff --git a/src/ReactionType/Models/ReactionType.php b/src/ReactionType/Models/ReactionType.php
diff --git a/src/Support/Database/AddForeignColumnStub.php b/src/Support/Database/AddForeignColumnStub.php
diff --git a/src/Support/Database/Eloquent/Model.php b/src/Support/Database/Eloquent/Model.php
diff --git a/src/Support/Database/Migration.php b/src/Support/Database/Migration.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +parameters:
 +    level: 0
 +    paths:
 +        - src
 +        - tests
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,9 @@ public function handle(): int`
`73`	`73`	`return 0;`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ /**`
	`77`	`+ * @return array[]`
	`78`	`+ */`
`76`	`79`	`protected function getOptions(): array`
`77`	`80`	`{`
`78`	`81`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ final class Recount extends Command`
`47`	`47`	`/**`
`48`	`48`	`* Get the console command options.`
`49`	`49`	`*`
`50`		`- * @return array`
	`50`	`+ * @return array[]`
`51`	`51`	`*/`
`52`	`52`	`protected function getOptions(`
`53`	`53`	`): array {`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,9 @@ final class RegisterReactants extends Command`
`35`	`35`	`*/`
`36`	`36`	`protected $description = 'Register Reactable models as Reactants';`
`37`	`37`
	`38`	`+ /**`
	`39`	`+ * @return array[]`
	`40`	`+ */`
`38`	`41`	`protected function getOptions(): array`
`39`	`42`	`{`
`40`	`43`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -23,18 +23,27 @@`
`23`	`23`	`final class Reactant implements`
`24`	`24`	`ReacterFacadeContract`
`25`	`25`	`{`
	`26`	`+ /**`
	`27`	`+ * @var ReactantContract`
	`28`	`+ */`
`26`	`29`	`private $reactant;`
`27`	`30`
`28`	`31`	`public function __construct(ReactantContract $reactant)`
`29`	`32`	`{`
`30`	`33`	`$this->reactant = $reactant;`
`31`	`34`	`}`
`32`	`35`
	`36`	`+ /**`
	`37`	`+ * @return iterable\|\Cog\Contracts\Love\Reaction\Models\Reaction[]`
	`38`	`+ */`
`33`	`39`	`public function getReactions(): iterable`
`34`	`40`	`{`
`35`	`41`	`return $this->reactant->getReactions();`
`36`	`42`	`}`
`37`	`43`
	`44`	`+ /**`
	`45`	`+ * @return iterable\|\Cog\Contracts\Love\Reactant\ReactionCounter\Models\ReactionCounter[]`
	`46`	`+ */`
`38`	`47`	`public function getReactionCounters(): iterable`
`39`	`48`	`{`
`40`	`49`	`return $this->reactant->getReactionCounters();`