Tweak CS rules around global imports and enforce (#1305)

zircote · Sep 2, 2022 · 22cd00a · 22cd00a
1 parent 1d08b7a
commit 22cd00a
Show file tree

Hide file tree

Showing 95 changed files with 267 additions and 33 deletions.
diff --git a/.github/workflows/security-checks.yml b/.github/workflows/security-checks.yml
@@ -41,4 +41,4 @@ jobs:
           path: ~/.symfony/cache
           key: security-checker-db
 
-      - uses: symfonycorp/security-checker-action@v2
+      - uses: symfonycorp/security-checker-action@v3
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -1,20 +1,28 @@
-<?php
+<?php declare(strict_types=1);
 
 use OpenApi\Tools\CSFixer\ScopedLicenseFixer;
 use OpenApi\Tools\CSFixer\ScopedDeclareStrictTypesFixer;
 
 $finder = PhpCsFixer\Finder::create()
     ->path('src')->name('*.php')
     ->path('tests')->name('*.php')
+        // ContextTest::testFullyQualifiedName relies on the 'use Exception' statement...
+        ->filter(function (\SplFileInfo $file) {
+            return !strpos($file->getPathname(), 'tests/Fixtures/Customer.php');
+        })
     ->path('Examples')->name('*.php')
+        ->filter(function (\SplFileInfo $file) {
+            return !strpos($file->getPathname(), 'Examples/petstore-3.0/Petstore.php')
+                && !strpos($file->getPathname(), 'Examples/misc/OpenApiSpec.php');
+        })
     ->path('tools')->name('*.php')
     ->in(__DIR__)
 ;
 
 return (new PhpCsFixer\Config())
     ->registerCustomFixers([
-        (new ScopedLicenseFixer())->scope(['/src/']),
-        (new ScopedDeclareStrictTypesFixer())->scope(['/src/']),
+        (new ScopedLicenseFixer())->scope(['/src/', '/tests/']), //, '/Examples/']),
+        (new ScopedDeclareStrictTypesFixer())->scope(['/src/', '/tests/']),
     ])
     ->setRules([
         '@PSR2' => true,
@@ -52,6 +60,8 @@
         'trim_array_spaces' => true,
         'single_space_after_construct' => true,
         'single_line_comment_spacing' => true,
+        'fully_qualified_strict_types' => true,
+        'global_namespace_import' => ['import_classes' => false, 'import_constants' => null, 'import_functions' => null],
 
         'no_empty_phpdoc' => true,
         // 7.3 only 'no_superfluous_phpdoc_tags' => true,

diff --git a/Examples/misc/OpenApiSpec.php b/Examples/misc/OpenApiSpec.php
@@ -1,23 +1,27 @@
 <?php
 
+/**
+ * @license Apache 2.0
+ */
+
 namespace OpenApi\Examples\Misc;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\OpenApi(
  *     security={{"bearerAuth": {}}},
  *     @OA\Tag(
  *         name="endpoints"
  *     )
  * )
- *
  * @OA\Info(
  *     title="Testing annotations from bugreports",
  *     version="1.0.0",
  *     description="NOTE:
 This sentence is on a new line",
  *     @OA\Contact(name="Swagger API Team")
  * )
- *
  * @OA\Components(
  *     @OA\SecurityScheme(
  *         securityScheme="bearerAuth",
@@ -26,7 +30,6 @@
  *     ),
  *     @OA\Attachable
  * )
- *
  * @OA\Server(
  *     url="{schema}://host.dev",
  *     description="OpenApi parameters",

diff --git a/Examples/nesting/ActualModel.php b/Examples/nesting/ActualModel.php
@@ -1,7 +1,13 @@
 <?php declare(strict_types=1);
 
+/**
+ * @license Apache 2.0
+ */
+
 namespace OpenApi\Examples\Nesting;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\Schema
  */

diff --git a/Examples/nesting/AlmostModel.php b/Examples/nesting/AlmostModel.php
@@ -1,7 +1,13 @@
 <?php declare(strict_types=1);
 
+/**
+ * @license Apache 2.0
+ */
+
 namespace OpenApi\Examples\Nesting;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\Schema
  */

diff --git a/Examples/nesting/ApiController.php b/Examples/nesting/ApiController.php
@@ -1,7 +1,13 @@
 <?php declare(strict_types=1);
 
+/**
+ * @license Apache 2.0
+ */
+
 namespace OpenApi\Examples\Nesting;
 
+use OpenApi\Annotations as OA;
+
 /**
  * An entity controller class.
  *

diff --git a/Examples/nesting/BaseModel.php b/Examples/nesting/BaseModel.php
@@ -1,7 +1,13 @@
 <?php declare(strict_types=1);
 
+/**
+ * @license Apache 2.0
+ */
+
 namespace OpenApi\Examples\Nesting;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\Schema
  */

diff --git a/Examples/nesting/IntermediateModel.php b/Examples/nesting/IntermediateModel.php
@@ -1,7 +1,13 @@
 <?php declare(strict_types=1);
 
+/**
+ * @license Apache 2.0
+ */
+
 namespace OpenApi\Examples\Nesting;
 
+use OpenApi\Annotations as OA;
+
 /**
  * No schema!
  */

diff --git a/Examples/nesting/SoCloseModel.php b/Examples/nesting/SoCloseModel.php
@@ -1,7 +1,13 @@
 <?php declare(strict_types=1);
 
+/**
+ * @license Apache 2.0
+ */
+
 namespace OpenApi\Examples\Nesting;
 
+use OpenApi\Annotations as OA;
+
 /**
  * No schema!
  */

diff --git a/Examples/petstore-3.0/Controllers/Pet.php b/Examples/petstore-3.0/Controllers/Pet.php
@@ -6,6 +6,8 @@
 
 namespace OpenApi\Examples\Petstore30\Controllers;
 
+use OpenApi\Annotations as OA;
+
 /**
  * Class Pet.
  *

diff --git a/Examples/petstore-3.0/Controllers/Store.php b/Examples/petstore-3.0/Controllers/Store.php
@@ -6,6 +6,8 @@
 
 namespace OpenApi\Examples\Petstore30\Controllers;
 
+use OpenApi\Annotations as OA;
+
 /**
  * Class Store.
  *

diff --git a/Examples/petstore-3.0/Controllers/User.php b/Examples/petstore-3.0/Controllers/User.php
@@ -6,6 +6,8 @@
 
 namespace OpenApi\Examples\Petstore30\Controllers;
 
+use OpenApi\Annotations as OA;
+
 /**
  * Class User.
  *

diff --git a/Examples/petstore-3.0/Models/ApiResponse.php b/Examples/petstore-3.0/Models/ApiResponse.php
@@ -6,6 +6,8 @@
 
 namespace OpenApi\Examples\Petstore30\Models;
 
+use OpenApi\Annotations as OA;
+
 /**
  * Class ApiResponse.
  *

diff --git a/Examples/petstore-3.0/Petstore.php b/Examples/petstore-3.0/Petstore.php
@@ -6,6 +6,8 @@
 
 namespace OpenApi\Examples\Petstore30;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\Info(
  *     description="This is a sample Petstore server.  You can find

diff --git a/Examples/petstore-3.0/Security.php b/Examples/petstore-3.0/Security.php
@@ -6,6 +6,8 @@
 
 namespace OpenApi\Examples\Petstore30;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\SecurityScheme(
  *     type="oauth2",

diff --git a/Examples/petstore.swagger.io/Controllers/PetController.php b/Examples/petstore.swagger.io/Controllers/PetController.php
@@ -2,6 +2,8 @@
 
 namespace OpenApi\Examples\PetstoreSwaggerIo\Controllers;
 
+use OpenApi\Annotations as OA;
+
 final class PetController
 {
     /**

diff --git a/Examples/petstore.swagger.io/Controllers/StoreController.php b/Examples/petstore.swagger.io/Controllers/StoreController.php
@@ -2,6 +2,8 @@
 
 namespace OpenApi\Examples\PetstoreSwaggerIo\Controllers;
 
+use OpenApi\Annotations as OA;
+
 abstract class StoreController
 {
     /**

diff --git a/Examples/petstore.swagger.io/Controllers/UserController.php b/Examples/petstore.swagger.io/Controllers/UserController.php
@@ -2,6 +2,8 @@
 
 namespace OpenApi\Examples\PetstoreSwaggerIo\Controllers;
 
+use OpenApi\Annotations as OA;
+
 class UserController
 {
     /**

diff --git a/Examples/petstore.swagger.io/Models/Order.php b/Examples/petstore.swagger.io/Models/Order.php
@@ -39,6 +39,7 @@ class Order
 
     /**
      * @var \DateTime
+     *
      * @OA\Property
      */
     public $shipDate;
@@ -47,6 +48,7 @@ class Order
      * Order Status.
      *
      * @var string
+     *
      * @OA\Property(enum={"placed", "approved", "delivered"})
      */
     public $status;

diff --git a/Examples/petstore.swagger.io/Models/Pet.php b/Examples/petstore.swagger.io/Models/Pet.php
@@ -25,18 +25,21 @@ class Pet
 
     /**
      * @var Category
+     *
      * @OA\Property
      */
     public $category;
 
     /**
      * @var string[]
+     *
      * @OA\Property(@OA\Xml(name="photoUrl", wrapped=true))
      */
     public $photoUrls;
 
     /**
      * @var Tag[]
+     *
      * @OA\Property(@OA\Xml(name="tag", wrapped=true))
      */
     public $tags;
@@ -45,6 +48,7 @@ class Pet
      * pet status in the store.
      *
      * @var string
+     *
      * @OA\Property(enum={"available", "pending", "sold"})
      */
     public $status;

diff --git a/Examples/petstore.swagger.io/Models/User.php b/Examples/petstore.swagger.io/Models/User.php
@@ -39,18 +39,21 @@ class User
 
     /**
      * @var string
+     *
      * @OA\Property
      */
     public $email;
 
     /**
      * @var string
+     *
      * @OA\Property
      */
     public $password;
 
     /**
      * @var string
+     *
      * @OA\Property
      */
     public $phone;
@@ -59,6 +62,7 @@ class User
      * User Status.
      *
      * @var int
+     *
      * @OA\Property(format="int32")
      */
     public $userStatus;

diff --git a/Examples/petstore.swagger.io/OpenApiSpec.php b/Examples/petstore.swagger.io/OpenApiSpec.php
@@ -2,6 +2,8 @@
 
 namespace OpenApi\Examples\PetstoreSwaggerIo;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\OpenApi(
  *     @OA\Info(

diff --git a/Examples/petstore.swagger.io/OpenApiTags.php b/Examples/petstore.swagger.io/OpenApiTags.php
@@ -2,6 +2,8 @@
 
 namespace OpenApi\Examples\PetstoreSwaggerIo;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\Tag(
  *     name="pet",

diff --git a/Examples/petstore.swagger.io/PetstoreAuth.php b/Examples/petstore.swagger.io/PetstoreAuth.php
@@ -2,6 +2,8 @@
 
 namespace OpenApi\Examples\PetstoreSwaggerIo;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\SecurityScheme(
  *     securityScheme="api_key",

diff --git a/Examples/processors/schema-query-parameter/app/Product.php b/Examples/processors/schema-query-parameter/app/Product.php
@@ -16,12 +16,14 @@ class Product
      * The unique identifier of a product in our catalog.
      *
      * @var int
+     *
      * @OA\Property(format="int64", example=1)
      */
     public $id;
 
     /**
      * @var string
+     *
      * @OA\Property(format="int64", example=1)
      */
     public $name;

diff --git a/Examples/swagger-spec/petstore-simple/OpenApiSpec.php b/Examples/swagger-spec/petstore-simple/OpenApiSpec.php
@@ -2,6 +2,8 @@
 
 namespace OpenApi\Examples\SwaggerSpec\PetstoreSimple;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\OpenApi(
  *     @OA\Server(

diff --git a/Examples/swagger-spec/petstore-simple/SimplePet.php b/Examples/swagger-spec/petstore-simple/SimplePet.php
@@ -2,6 +2,8 @@
 
 namespace OpenApi\Examples\SwaggerSpec\PetstoreSimple;
 
+use OpenApi\Annotations as OA;
+
 /**
  * @OA\Schema(schema="NewPet", required={"name"})
  */
@@ -18,6 +20,7 @@ class SimplePet
 
     /**
      * @var string
+     *
      * @OA\Property
      */
     public $tag;
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,8 @@ @@
     namespace OpenApi\Examples\Petstore30\Controllers;
+    use OpenApi\Annotations as OA;
     /**
      * Class Pet.
      *
@@ Expand Down @@