chore :clean up development setup (#1559)

.github/workflows/tests.yml

@@ -73,5 +73,5 @@ jobs:
       - name: "Execute unit tests"
         run: "composer run-script test:unit"
 
-      - name: "Run Larastan on Laravel sample applications"
+      - name: "Run Larastan on a sample Laravel application"
         run: "tests/laravel-test.sh ${{ matrix.laravel }}"

CONTRIBUTING.md

@@ -12,16 +12,14 @@ Please review these guidelines before submitting any pull requests.
 
 ## Guidelines
 
-* Please follow the [PSR-2 Coding Style Guide](http://www.php-fig.org/psr/psr-2/), enforced by [StyleCI](https://styleci.io/).
+* Please follow the [PSR-2 Coding Style Guide](http://www.php-fig.org/psr/psr-2), enforced by [StyleCI](https://styleci.io).
 * Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
 * You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
-* Please remember that we follow [SemVer](http://semver.org/).
-
-We have [StyleCI](https://styleci.io/) setup to automatically fix any code style issues.
+* Please remember that we follow [SemVer](http://semver.org).
 
 ## Setup
 
-Clone your fork, then install the dev dependencies:
+Clone your fork, then install all dependencies:
 
     composer update
 
@@ -38,8 +36,3 @@ Code analysis:
 Unit tests:
 
     composer test:unit
-
-Our current testsuite involves running `phpstan` on each individual file in [`tests/Features`](tests/Features)
-with our extension file loaded. The test will fail if PHPStan fails on the given file.
-There is currently no way for us to assert that larastan will fail for a given test suite,
-so it is difficult to test for expected failures in analysis.

composer.json

@@ -25,17 +25,17 @@
     },
     "require-dev": {
         "nikic/php-parser": "^4.15.2",
-        "orchestra/testbench": "^7.19.0|^8.0.0",
+        "orchestra/testbench": "^7.19.0 || ^8.0.0",
         "phpunit/phpunit": "^9.5.27"
     },
     "suggest": {
         "orchestra/testbench": "Using Larastan for analysing a package needs Testbench"
     },
     "autoload-dev": {
         "psr-4": {
-            "App\\": "tests/Application/app/",
-            "Database\\Factories\\": "tests/Application/database/factories/",
-            "Database\\Migrations\\": "tests/Application/database/migrations/"
+            "App\\": "tests/application/app/",
+            "Database\\Factories\\": "tests/application/database/factories/",
+            "Database\\Migrations\\": "tests/application/database/migrations/"
         },
       "classmap": [
         "tests/"

phpunit-bootstrap.php

@@ -4,7 +4,7 @@
 
 $filesystem = new \Illuminate\Filesystem\Filesystem();
 
-$filesystem->copyDirectory(__DIR__.'/tests/Application/database/migrations', __DIR__.'/vendor/orchestra/testbench-core/laravel/database/migrations');
-$filesystem->copyDirectory(__DIR__.'/tests/Application/database/schema', __DIR__.'/vendor/orchestra/testbench-core/laravel/database/schema');
-$filesystem->copyDirectory(__DIR__.'/tests/Application/config', __DIR__.'/vendor/orchestra/testbench-core/laravel/config');
-$filesystem->copyDirectory(__DIR__.'/tests/Application/resources', __DIR__.'/vendor/orchestra/testbench-core/laravel/resources');
+$filesystem->copyDirectory(__DIR__.'/tests/application/database/migrations', __DIR__.'/vendor/orchestra/testbench-core/laravel/database/migrations');
+$filesystem->copyDirectory(__DIR__.'/tests/application/database/schema', __DIR__.'/vendor/orchestra/testbench-core/laravel/database/schema');
+$filesystem->copyDirectory(__DIR__.'/tests/application/config', __DIR__.'/vendor/orchestra/testbench-core/laravel/config');
+$filesystem->copyDirectory(__DIR__.'/tests/application/resources', __DIR__.'/vendor/orchestra/testbench-core/laravel/resources');

tests/IntegrationTest.php → tests/Integration/IntegrationTest.php

@@ -1,5 +1,7 @@
 <?php
 
+namespace Tests\Integration;
+
 use PHPStan\Analyser\Analyser;
 use PHPStan\Analyser\Error;
 use PHPStan\File\FileHelper;
@@ -12,9 +14,9 @@ class IntegrationTest extends PHPStanTestCase
      */
     public function dataIntegrationTests(): iterable
     {
-        yield [__DIR__.'/integration/data/test-case-extension.php'];
-        yield [__DIR__.'/integration/data/model-properties.php'];
-        yield [__DIR__.'/integration/data/blade-view.php'];
+        yield [__DIR__.'/data/test-case-extension.php'];
+        yield [__DIR__.'/data/model-properties.php'];
+        yield [__DIR__.'/data/blade-view.php'];
     }
 
     /**
@@ -59,6 +61,6 @@ private function runAnalyse(string $file, ?array $allAnalysedFiles = null): arra
 
     public static function getAdditionalConfigFiles(): array
     {
-        return [__DIR__.'/phpstan-tests.neon'];
+        return [__DIR__.'/../phpstan-tests.neon'];
     }
 }

tests/integration/data/blade-view.php → tests/Integration/data/blade-view.php

@@ -1,7 +1,5 @@
 <?php
 
-namespace BladeViewString;
-
 class BladeViewType
 {
     public function testBladeView(): void

tests/integration/data/model-properties.php → tests/Integration/data/model-properties.php

@@ -1,7 +1,5 @@
 <?php
 
-namespace ModelPropertiesIntegration;
-
 use App\Group;
 use App\Role;
 use App\Team;

tests/integration/data/test-case-extension.php → tests/Integration/data/test-case-extension.php

@@ -1,7 +1,5 @@
 <?php
 
-namespace TestCase;
-
 use App\User;
 use Illuminate\Foundation\Application;
 

tests/Rules/CheckDispatchArgumentTypesCompatibleWithClassConstructorRuleTest.php

@@ -35,7 +35,7 @@ public function testJobDispatch(): void
     {
         $this->dispatchableClass = Dispatchable::class;
 
-        $this->analyse([__DIR__.'/Data/job-dispatch.php'], [
+        $this->analyse([__DIR__.'/data/job-dispatch.php'], [
             ['Job class Tests\Rules\Data\LaravelJob constructor invoked with 0 parameters in Tests\Rules\Data\LaravelJob::dispatch(), 2 required.', 5],
             ['Job class Tests\Rules\Data\LaravelJob constructor invoked with 0 parameters in Tests\Rules\Data\LaravelJob::dispatchSync(), 2 required.', 6],
             ['Job class Tests\Rules\Data\LaravelJob constructor invoked with 0 parameters in Tests\Rules\Data\LaravelJob::dispatchNow(), 2 required.', 7],
@@ -75,7 +75,7 @@ public function testEventDispatch(): void
     {
         $this->dispatchableClass = EventDispatchable::class;
 
-        $this->analyse([__DIR__.'/Data/event-dispatch.php'], [
+        $this->analyse([__DIR__.'/data/event-dispatch.php'], [
             ['Event class Tests\Rules\Data\LaravelEvent constructor invoked with 0 parameters in Tests\Rules\Data\LaravelEvent::dispatch(), 2 required.', 5],
             ['Event class Tests\Rules\Data\LaravelEvent constructor invoked with 1 parameter in Tests\Rules\Data\LaravelEvent::dispatch(), 2 required.', 7],
             ['Parameter #1 $foo of event class Tests\Rules\Data\LaravelEvent constructor expects string in Tests\Rules\Data\LaravelEvent::dispatch(), int given.', 8],

tests/Rules/DeferrableServiceProviderMissingProvidesRuleTest.php

@@ -15,7 +15,7 @@ public function testNoFalsePositivesDirectExistingMethod(): void
     {
         $this->analyse(
             [
-                __DIR__.'/Data/CorrectDeferrableProvider.php',
+                __DIR__.'/data/CorrectDeferrableProvider.php',
             ],
             []
         );
@@ -25,7 +25,7 @@ public function testNoFalsePositivesIndirectExistingMethod(): void
     {
         $this->analyse(
             [
-                __DIR__.'/Data/CorrectDeferrableProviderIndirect.php',
+                __DIR__.'/data/CorrectDeferrableProviderIndirect.php',
             ],
             []
         );
@@ -35,7 +35,7 @@ public function testIncorrectDeferrableServiceProvider(): void
     {
         $this->analyse(
             [
-                __DIR__.'/Data/IncorrectDeferrableProvider.php',
+                __DIR__.'/data/IncorrectDeferrableProvider.php',
             ],
             [
                 ['ServiceProviders that implement the "DeferrableProvider" interface should implement the "provides" method that returns an array of strings or class-strings', 10],

tests/Rules/ModelPropertyRuleTest.php

@@ -25,7 +25,7 @@ protected function getRule(): Rule
 
     public function testModelPropertyRuleOnBuilder(): void
     {
-        $this->analyse([__DIR__.'/Data/model-property-builder.php'], [
+        $this->analyse([__DIR__.'/data/model-property-builder.php'], [
             [
                 'Property \'foo\' does not exist in App\\User model.',
                 4,
@@ -71,7 +71,7 @@ public function testModelPropertyRuleOnBuilder(): void
 
     public function testModelPropertyRuleOnRelation(): void
     {
-        $this->analyse([__DIR__.'/Data/model-property-relation.php'], [
+        $this->analyse([__DIR__.'/data/model-property-relation.php'], [
             [
                 'Property \'foo\' does not exist in App\\Account model.',
                 4,
@@ -101,7 +101,7 @@ public function testModelPropertyRuleOnRelation(): void
 
     public function testModelPropertyRuleOnModel(): void
     {
-        $this->analyse([__DIR__.'/Data/model-property-model.php'], [
+        $this->analyse([__DIR__.'/data/model-property-model.php'], [
             [
                 'Property \'foo\' does not exist in ModelPropertyModel\ModelPropertyOnModel model.',
                 9,
@@ -119,7 +119,7 @@ public function testModelPropertyRuleOnModel(): void
 
     public function testModelPropertyRuleOnModelFactory(): void
     {
-        $this->analyse([__DIR__.'/Data/model-property-model-factory.php'], [
+        $this->analyse([__DIR__.'/data/model-property-model-factory.php'], [
             [
                 'Property \'foo\' does not exist in App\\User model.',
                 7,
@@ -130,7 +130,7 @@ public function testModelPropertyRuleOnModelFactory(): void
     public static function getAdditionalConfigFiles(): array
     {
         return [
-            __DIR__.'/Data/modelPropertyConfig.neon',
+            __DIR__.'/data/modelPropertyConfig.neon',
         ];
     }
 }

tests/Rules/ModelPropertyStaticCallRuleTest.php

@@ -24,7 +24,7 @@ protected function getRule(): Rule
 
     public function testModelPropertyRuleOnStaticCallsToModel(): void
     {
-        $this->analyse([__DIR__.'/Data/model-property-static-call.php'], [
+        $this->analyse([__DIR__.'/data/model-property-static-call.php'], [
             ['Property \'foo\' does not exist in App\\User model.', 7],
             ['Property \'foo\' does not exist in App\\User model.', 13],
             ['Property \'foo\' does not exist in App\\User model.', 18],
@@ -33,7 +33,7 @@ public function testModelPropertyRuleOnStaticCallsToModel(): void
 
     public function testModelPropertyRuleOnStaticCallsInClass(): void
     {
-        $this->analyse([__DIR__.'/Data/ModelPropertyStaticCallsInClass.php'], [
+        $this->analyse([__DIR__.'/data/ModelPropertyStaticCallsInClass.php'], [
             ['Property \'foo\' does not exist in Tests\\Rules\\Data\\ModelPropertyStaticCallsInClass model.', 16],
             ['Property \'foo\' does not exist in Tests\\Rules\\Data\\ModelPropertyStaticCallsInClass model.', 24],
         ]);
@@ -42,7 +42,7 @@ public function testModelPropertyRuleOnStaticCallsInClass(): void
     public static function getAdditionalConfigFiles(): array
     {
         return [
-            __DIR__.'/Data/modelPropertyConfig.neon',
+            __DIR__.'/data/modelPropertyConfig.neon',
         ];
     }
 }

tests/Rules/NoModelMakeRuleTest.php

@@ -18,12 +18,12 @@ protected function getRule(): Rule
 
     public function testNoFalsePositives(): void
     {
-        $this->analyse([__DIR__.'/Data/CorrectModelInstantiation.php'], []);
+        $this->analyse([__DIR__.'/data/CorrectModelInstantiation.php'], []);
     }
 
     public function testModelMake(): void
     {
-        $this->analyse([__DIR__.'/Data/ModelMake.php'], [
+        $this->analyse([__DIR__.'/data/ModelMake.php'], [
             ["Called 'Model::make()' which performs unnecessary work, use 'new Model()'.", 13],
             ["Called 'Model::make()' which performs unnecessary work, use 'new Model()'.", 20],
         ]);

tests/Rules/NoUnnecessaryCollectionCallRuleTest.php

@@ -19,12 +19,12 @@ protected function getRule(): Rule
 
     public function testNoFalsePositives(): void
     {
-        $this->analyse([__DIR__.'/Data/CorrectCollectionCalls.php'], []);
+        $this->analyse([__DIR__.'/data/CorrectCollectionCalls.php'], []);
     }
 
     public function testNoFalseNegativesEloquent(): void
     {
-        $this->analyse([__DIR__.'/Data/UnnecessaryCollectionCallsEloquent.php'], [
+        $this->analyse([__DIR__.'/data/UnnecessaryCollectionCallsEloquent.php'], [
             ['Called \'pluck\' on Laravel collection, but could have been retrieved as a query.', 18],
             ['Called \'count\' on Laravel collection, but could have been retrieved as a query.', 23],
             ['Called \'pluck\' on Laravel collection, but could have been retrieved as a query.', 29],
@@ -46,7 +46,7 @@ public function testNoFalseNegativesEloquent(): void
 
     public function testNoFalseNegativesQuery(): void
     {
-        $this->analyse([__DIR__.'/Data/UnnecessaryCollectionCallsQuery.php'], [
+        $this->analyse([__DIR__.'/data/UnnecessaryCollectionCallsQuery.php'], [
             ['Called \'max\' on Laravel collection, but could have been retrieved as a query.', 15],
             ['Called \'isNotEmpty\' on Laravel collection, but could have been retrieved as a query.', 20],
             ['Called \'pluck\' on Laravel collection, but could have been retrieved as a query.', 26],

tests/Rules/OctaneCompatibilityRuleTest.php

@@ -20,7 +20,7 @@ protected function getRule(): Rule
 
     public function testNoContainerInjection(): void
     {
-        $this->analyse([__DIR__.'/Data/ContainerInjection.php'], [
+        $this->analyse([__DIR__.'/data/ContainerInjection.php'], [
             ['Consider using bind method instead or pass a closure.', 12, 'See: https://laravel.com/docs/octane#dependency-injection-and-octane'],
             ['Consider using bind method instead or pass a closure.', 16, 'See: https://laravel.com/docs/octane#dependency-injection-and-octane'],
             ['Consider using bind method instead or pass a closure.', 25, 'See: https://laravel.com/docs/octane#dependency-injection-and-octane'],

tests/Rules/RelationExistenceRuleTest.php

@@ -19,7 +19,7 @@ protected function getRule(): Rule
 
     public function testRule(): void
     {
-        $this->analyse([__DIR__.'/Data/relation-existence-rule.php'], [
+        $this->analyse([__DIR__.'/data/relation-existence-rule.php'], [
             [
                 'Relation \'foo\' is not found in App\User model.',
                 5,

tests/Rules/UnusedViewsRuleTest.php

@@ -18,7 +18,7 @@ class UnusedViewsRuleTest extends RuleTestCase
 {
     protected function getRule(): Rule
     {
-        $viewFileHelper = new ViewFileHelper([__DIR__.'/../Application/resources/views'], $this->getFileHelper());
+        $viewFileHelper = new ViewFileHelper([__DIR__.'/../application/resources/views'], $this->getFileHelper());
 
         return new UnusedViewsRule(new UsedViewInAnotherViewCollector(
             $this->getContainer()->getService('currentPhpVersionSimpleDirectParser'),
@@ -47,7 +47,7 @@ protected function setUp(): void
 
     public function testRule(): void
     {
-        $this->analyse([__DIR__.'/Data/FooController.php'], [
+        $this->analyse([__DIR__.'/data/FooController.php'], [
             [
                 'This view is not used in the project.',
                 00,

tests/Rules/UselessConstructs/NoUselessValueFunctionCallsRuleTest.php

@@ -15,7 +15,7 @@ public function testNoFalsePositives(): void
     {
         $this->analyse(
             [
-                __DIR__.'/../Data/UselessConstructs/CorrectValueFunctionCall.php',
+                __DIR__.'/data/CorrectValueFunctionCall.php',
             ],
             []
         );
@@ -25,7 +25,7 @@ public function testUselessWithCalls(): void
     {
         $this->analyse(
             [
-                __DIR__.'/../Data/UselessConstructs/UselessValueFunctionCall.php',
+                __DIR__.'/data/UselessValueFunctionCall.php',
             ],
             [
                 ["Calling the helper function 'value()' without a closure as the first argument simply returns the first argument without doing anything", 11],

tests/Rules/UselessConstructs/NoUselessWithFunctionCallsRuleTest.php

@@ -15,7 +15,7 @@ public function testNoFalsePositives(): void
     {
         $this->analyse(
             [
-                __DIR__.'/../Data/UselessConstructs/CorrectWithFunctionCall.php',
+                __DIR__.'/data/CorrectWithFunctionCall.php',
             ],
             []
         );
@@ -25,7 +25,7 @@ public function testUselessWithCalls(): void
     {
         $this->analyse(
             [
-                __DIR__.'/../Data/UselessConstructs/UselessWithFunctionCall.php',
+                __DIR__.'/data/UselessWithFunctionCall.php',
             ],
             [
                 ["Calling the helper function 'with()' with only one argument simply returns the value itself. If you want to chain methods on a construct, use '(new ClassName())->foo()' instead", 11],

tests/Rules/Data/UselessConstructs/CorrectValueFunctionCall.php → tests/Rules/UselessConstructs/data/CorrectValueFunctionCall.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rules\Data\UselessConstructs;
+namespace Rules\UselessConstructs\data;
 
 class CorrectValueFunctionCall
 {

tests/Rules/Data/UselessConstructs/CorrectWithFunctionCall.php → tests/Rules/UselessConstructs/data/CorrectWithFunctionCall.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rules\Data\UselessConstructs;
+namespace Rules\UselessConstructs\data;
 
 class CorrectWithFunctionCall
 {

tests/Rules/Data/UselessConstructs/UselessValueFunctionCall.php → tests/Rules/UselessConstructs/data/UselessValueFunctionCall.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rules\Data\UselessConstructs;
+namespace Rules\UselessConstructs\data;
 
 class UselessValueFunctionCall
 {

tests/Rules/Data/UselessConstructs/UselessWithFunctionCall.php → tests/Rules/UselessConstructs/data/UselessWithFunctionCall.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rules\Data\UselessConstructs;
+namespace Rules\UselessConstructs\data;
 
 class UselessWithFunctionCall
 {

tests/Type/data/config-with-migrations.neon

@@ -2,4 +2,4 @@ includes:
     - ../../phpstan-tests.neon
 parameters:
     databaseMigrationsPath:
-        - %rootDir%/../../../tests/Application/database/migrations
+        - %rootDir%/../../../tests/application/database/migrations