Enable PHP-CS-Fixer in Github Action (gnikyt#883)

* Enable PHP-CS-Fixer. * Fix all code violations.
muhammadasfar · Jul 12, 2021 · 7ec27fe · 7ec27fe
1 parent ed99e4d
commit 7ec27fe
Show file tree

Hide file tree

Showing 46 changed files with 268 additions and 173 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -5,7 +5,7 @@
 .editorconfig            export-ignore
 .gitattributes           export-ignore
 .gitignore               export-ignore
-.styleci.yml             export-ignore
+.php-cs-fixer.dist.php   export-ignore
 CODE_OF_CONDUCT.md       export-ignore
 phpunit.xml              export-ignore
 CONTRIBUTING.md          export-ignore

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,16 @@
+name: PHP Lint
+
+on: [ push, pull_request ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v2
+
+      - name: Check for code style violation with PHP-CS-Fixer
+        uses: OskarStark/[email protected]
+        with:
+          args: --diff --dry-run
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@
 /build
 /vendor
 composer.lock
+.php-cs-fixer.cache
 .phpunit.result.cache
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,63 @@
+<?php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$rules = [
+    '@PSR2' => true,
+    '@PSR12' => true,
+    'array_syntax' => [
+        'syntax' => 'short',
+    ],
+    'binary_operator_spaces' => true,
+    'blank_line_after_namespace' => true,
+    'blank_line_before_statement' => true,
+    'cast_spaces' => true,
+    'concat_space' => [
+        'spacing' => 'none',
+    ],
+    'ereg_to_preg' => true,
+    'is_null' => true,
+    'line_ending' => true,
+    'modernize_types_casting' => true,
+    'no_blank_lines_after_phpdoc' => true,
+    'no_short_bool_cast' => true,
+    'no_unneeded_control_parentheses' => true,
+    'no_unused_imports' => true,
+    'no_whitespace_in_blank_line' => true,
+    'ordered_imports' => true,
+    'phpdoc_align' => false,
+    'phpdoc_indent' => true,
+    'phpdoc_inline_tag_normalizer' => true,
+    'phpdoc_no_access' => true,
+    'phpdoc_no_package' => true,
+    'phpdoc_order' => true,
+    'phpdoc_scalar' => true,
+    'phpdoc_separation' => true,
+    'phpdoc_to_comment' => true,
+    'phpdoc_trim' => true,
+    'phpdoc_types' => true,
+    'phpdoc_var_without_name' => true,
+    'self_accessor' => true,
+    'single_quote' => true,
+    'space_after_semicolon' => true,
+    'standardize_not_equals' => true,
+    'ternary_operator_spaces' => true,
+    'trailing_comma_in_multiline' => true,
+    'trim_array_spaces' => true,
+    'yoda_style' => [
+        'always_move_variable' => false,
+        'equal' => false,
+        'identical' => false,
+    ],
+];
+
+$finder = Finder::create()->in(__DIR__)
+    ->notPath([
+        'src/ShopifyApp/resources/config/shopify-app.php',
+    ]);
+
+return (new Config())
+    ->setRules($rules)
+    ->setFinder($finder)
+    ->setRiskyAllowed(true);
diff --git a/.styleci.yml b/.styleci.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,7 +20,7 @@ Its best to:
 1. Fork the repository (see adding upstream below)
 2. Create a branch such as `cool-new-feature`
 3. Create your code
-4. Create and run successfull tests (see testing below)
+4. Create and run successful tests (see testing below)
 5. Submit a pull request
 
 ## Found a bug?
@@ -38,7 +38,7 @@ Its best to:
 1. Fork the repository (see adding upstream below)
 2. Create a branch such as `issue-(issuenumber)-fix`
 3. Create your code
-4. Create and run successfull tests (see testing below)
+4. Create and run successful tests (see testing below)
 5. Submit a pull request
 6. Comment on the issue
 
@@ -58,11 +58,17 @@ You can then update by simply running:
 
 #### Locally
 
-We use PHPUnit to run tests. Simply run `composer install` and a symlink `phpunit` should be located in the `bin` directory.
+We use PHPUnit to run tests. Simply run `composer install`.
 
-Next, run `bin/phpunit` and the rest will be taken care of. Upon any pull requests and merges, TravisCI will check the code to ensure all test suites pass.
+Next, run `vendor/bin/phpunit` and the rest will be taken care of. Upon any pull requests and merges.
 
-For quicker tests, be sure to disable coverage with `bin/php --no-coverage`.
+For quicker tests, be sure to disable coverage with `vendor/bin/phpunit --no-coverage`.
+
+### Checking style
+
+We use PHP-CS-Fixer to check for code style violations.
+
+To lint the code, simply run `composer lint`.
 
 #### Actions
 
@@ -75,4 +81,4 @@ We also utilize Github Actions. Currently it will:
 
 -----
 
-Thats it! Enjoy.
+That's it! Enjoy.
diff --git a/composer.json b/composer.json
@@ -32,6 +32,7 @@
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.8",
+        "friendsofphp/php-cs-fixer": "^3.0",
         "mockery/mockery": "^1.0",
         "orchestra/database": "~3.8 || ~4.0 || ~5.0 || ~6.0",
         "orchestra/testbench": "~3.8 || ~4.0 || ~5.0 || ~6.0",
@@ -61,6 +62,7 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "scripts": {
+        "lint": "vendor/bin/php-cs-fixer fix",
         "test": "vendor/bin/phpunit",
         "test-html-cov": "vendor/bin/phpunit --coverage-html ./build/html/",
         "test-no-cov": "vendor/bin/phpunit --no-coverage"

diff --git a/src/ShopifyApp/Actions/InstallShop.php b/src/ShopifyApp/Actions/InstallShop.php
@@ -73,8 +73,8 @@ public function __invoke(ShopDomain $shopDomain, ?string $code): array
         if (empty($code)) {
             return [
                 'completed' => false,
-                'url'       => $apiHelper->buildAuthUrl($grantMode, Util::getShopifyConfig('api_scopes', $shop)),
-                'shop_id'   => $shop->getId(),
+                'url' => $apiHelper->buildAuthUrl($grantMode, Util::getShopifyConfig('api_scopes', $shop)),
+                'shop_id' => $shop->getId(),
             ];
         }
 
@@ -90,15 +90,15 @@ public function __invoke(ShopDomain $shopDomain, ?string $code): array
 
             return [
                 'completed' => true,
-                'url'       => null,
-                'shop_id'   => $shop->getId(),
+                'url' => null,
+                'shop_id' => $shop->getId(),
             ];
         } catch (Exception $e) {
             // Just return the default setting
             return [
                 'completed' => false,
-                'url'       => null,
-                'shop_id'   => null,
+                'url' => null,
+                'shop_id' => null,
             ];
         }
     }

diff --git a/src/ShopifyApp/Contracts/Commands/Shop.php b/src/ShopifyApp/Contracts/Commands/Shop.php
@@ -17,6 +17,7 @@ interface Shop
      *
      * @param  ShopDomainValue  $domain
      * @param  AccessTokenValue  $token
+     *
      * @return ShopIdValue
      */
     public function make(ShopDomainValue $domain, AccessTokenValue $token): ShopIdValue;

diff --git a/src/ShopifyApp/Http/Middleware/AuthProxy.php b/src/ShopifyApp/Http/Middleware/AuthProxy.php
@@ -69,7 +69,7 @@ public function handle(Request $request, Closure $next)
         // Build a local signature
         $signatureLocal = Util::createHmac(
             [
-                'data'       => $query,
+                'data' => $query,
                 'buildQuery' => true,
             ],
             Util::getShopifyConfig('api_secret', $shop)

diff --git a/src/ShopifyApp/Http/Middleware/AuthWebhook.php b/src/ShopifyApp/Http/Middleware/AuthWebhook.php
@@ -30,8 +30,8 @@ public function handle(Request $request, Closure $next)
         $data = $request->getContent();
         $hmacLocal = Util::createHmac(
             [
-                'data'   => $data,
-                'raw'    => true,
+                'data' => $data,
+                'raw' => true,
                 'encode' => true,
             ],
             Util::getShopifyConfig('api_secret', $shop)

diff --git a/src/ShopifyApp/Http/Middleware/VerifyShopify.php b/src/ShopifyApp/Http/Middleware/VerifyShopify.php
@@ -285,7 +285,7 @@ protected function tokenRedirect(Request $request): RedirectResponse
         return Redirect::route(
             Util::getShopifyConfig('route_names.authenticate.token'),
             [
-                'shop'   => ShopDomain::fromRequest($request)->toNative(),
+                'shop' => ShopDomain::fromRequest($request)->toNative(),
                 'target' => $target,
             ]
         );
@@ -404,8 +404,8 @@ protected function getRequestData(Request $request, string $source): array
                 $timestamp = $request->header('X-Shop-Time');
 
                 $verify = [
-                    'shop'      => $shop,
-                    'hmac'      => $signature,
+                    'shop' => $shop,
+                    'hmac' => $signature,
                     'timestamp' => $timestamp,
                 ];
 

diff --git a/src/ShopifyApp/Http/Requests/StoreUsageCharge.php b/src/ShopifyApp/Http/Requests/StoreUsageCharge.php
@@ -35,9 +35,9 @@ public function withValidator(Validator $validator): void
         $validator->after(function (Validator $validator) {
             // Get the input values needed
             $data = [
-                'price'       => $this->request->get('price'),
+                'price' => $this->request->get('price'),
                 'description' => $this->request->get('description'),
-                'signature'   => $this->request->get('signature'),
+                'signature' => $this->request->get('signature'),
             ];
             if ($this->request->has('redirect')) {
                 $data['redirect'] = $this->request->get('redirect');
@@ -49,7 +49,7 @@ public function withValidator(Validator $validator): void
             // Confirm the charge hasn't been tampered with
             $signatureLocal = Util::createHmac(
                 [
-                    'data'       => $data,
+                    'data' => $data,
                     'buildQuery' => true,
                 ],
                 Util::getShopifyConfig('api_secret')
@@ -69,10 +69,10 @@ public function withValidator(Validator $validator): void
     public function rules(): array
     {
         return [
-            'signature'   => 'required|string',
-            'price'       => 'required|numeric',
+            'signature' => 'required|string',
+            'price' => 'required|numeric',
             'description' => 'required|string',
-            'redirect'    => 'nullable|string',
+            'redirect' => 'nullable|string',
         ];
     }
 }
diff --git a/src/ShopifyApp/Macros/TokenUrl.php b/src/ShopifyApp/Macros/TokenUrl.php
@@ -26,7 +26,7 @@ public function generateParams(string $route, $params = [], bool $absolute = tru
         return [
             Util::getShopifyConfig('route_names.authenticate.token'),
             [
-                'shop'   => ShopDomain::fromRequest(Request::instance())->toNative(),
+                'shop' => ShopDomain::fromRequest(Request::instance())->toNative(),
                 'target' => URL::route($route, $params, $absolute),
             ],
         ];

diff --git a/src/ShopifyApp/Objects/Transfers/AbstractTransfer.php b/src/ShopifyApp/Objects/Transfers/AbstractTransfer.php
@@ -25,6 +25,7 @@ public function __get(string $key): void
     {
         // Does not exist, throw exception
         $className = get_class($this);
+
         throw new Exception("Property {$key} does not exist on transfer class {$className}");
     }
 
@@ -42,6 +43,7 @@ public function __set(string $key, $value): void
     {
         // Not allowed, throw exception
         $className = get_class($this);
+
         throw new Exception("Setting property {$key} for transfer class {$className} is not allowed");
     }
 

diff --git a/src/ShopifyApp/Objects/Transfers/PlanDetails.php b/src/ShopifyApp/Objects/Transfers/PlanDetails.php
@@ -68,13 +68,13 @@ final class PlanDetails extends AbstractTransfer
     public function toArray(): array
     {
         return [
-            'name'          => $this->name,
-            'price'         => $this->price,
-            'interval'      => $this->interval,
-            'test'          => $this->test,
-            'trial_days'    => $this->trialDays,
-            'return_url'    => $this->returnUrl,
-            'terms'         => $this->terms,
+            'name' => $this->name,
+            'price' => $this->price,
+            'interval' => $this->interval,
+            'test' => $this->test,
+            'trial_days' => $this->trialDays,
+            'return_url' => $this->returnUrl,
+            'terms' => $this->terms,
             'capped_amount' => $this->cappedAmount,
         ];
     }

diff --git a/src/ShopifyApp/Objects/Values/SessionContext.php b/src/ShopifyApp/Objects/Values/SessionContext.php
@@ -107,7 +107,7 @@ public static function fromNative($native)
      *
      * @return bool
      */
-    public function isValid(?SessionContext $previousContext = null): bool
+    public function isValid(?self $previousContext = null): bool
     {
         // Confirm access token and session token are good
         $tokenCheck = ! $this->getAccessToken()->isEmpty() && ! $this->getSessionToken()->isNull();