Merge pull request #9 from codedge/fix-phpcs-workflow

Fix phpcs workflow
nineteen-2 · Mar 9, 2021 · 1f5c37c · 1f5c37c
2 parents 261828f + 7e5c7fe
commit 1f5c37c
Show file tree

Hide file tree

Showing 9 changed files with 168 additions and 30 deletions.
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
@@ -13,7 +13,7 @@ jobs:
       -   name: Fix style
           uses: docker://oskarstark/php-cs-fixer-ga
           with:
-            args: --config=.php_cs --allow-risky=yes
+            args: --config=.php_cs.dist --allow-risky=yes
 
       -   name: Extract branch name
           shell: bash

diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 .idea
+.php_cs.cache
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -0,0 +1,144 @@
+<?php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$rules = [
+    'array_syntax' => ['syntax' => 'short'],
+    'binary_operator_spaces' => [
+        'default' => 'single_space',
+        'operators' => ['=>' => null]
+    ],
+    'blank_line_after_namespace' => true,
+    'blank_line_after_opening_tag' => true,
+    'blank_line_before_statement' => [
+        'statements' => ['return']
+    ],
+    'braces' => true,
+    'cast_spaces' => true,
+    'class_attributes_separation' => [
+        'elements' => ['method']
+    ],
+    'class_definition' => true,
+    'concat_space' => [
+        'spacing' => 'none'
+    ],
+    'declare_equal_normalize' => true,
+    'elseif' => true,
+    'encoding' => true,
+    'full_opening_tag' => true,
+    'fully_qualified_strict_types' => true, // added by Shift
+    'function_declaration' => true,
+    'function_typehint_space' => true,
+    'heredoc_to_nowdoc' => true,
+    'include' => true,
+    'increment_style' => ['style' => 'post'],
+    'indentation_type' => true,
+    'linebreak_after_opening_tag' => true,
+    'line_ending' => true,
+    'lowercase_cast' => true,
+    'lowercase_constants' => true,
+    'lowercase_keywords' => true,
+    'lowercase_static_reference' => true, // added from Symfony
+    'magic_method_casing' => true, // added from Symfony
+    'magic_constant_casing' => true,
+    'method_argument_space' => true,
+    'native_function_casing' => true,
+    'no_alias_functions' => true,
+    'no_extra_blank_lines' => [
+        'tokens' => [
+            'extra',
+            'throw',
+            'use',
+            'use_trait',
+        ]
+    ],
+    'no_blank_lines_after_class_opening' => true,
+    'no_blank_lines_after_phpdoc' => true,
+    'no_closing_tag' => true,
+    'no_empty_phpdoc' => true,
+    'no_empty_statement' => true,
+    'no_leading_import_slash' => true,
+    'no_leading_namespace_whitespace' => true,
+    'no_mixed_echo_print' => [
+        'use' => 'echo'
+    ],
+    'no_multiline_whitespace_around_double_arrow' => true,
+    'multiline_whitespace_before_semicolons' => [
+        'strategy' => 'no_multi_line'
+    ],
+    'no_short_bool_cast' => true,
+    'no_singleline_whitespace_before_semicolons' => true,
+    'no_spaces_after_function_name' => true,
+    'no_spaces_around_offset' => true,
+    'no_spaces_inside_parenthesis' => true,
+    'no_trailing_comma_in_list_call' => true,
+    'no_trailing_comma_in_singleline_array' => true,
+    'no_trailing_whitespace' => true,
+    'no_trailing_whitespace_in_comment' => true,
+    'no_unneeded_control_parentheses' => true,
+    'no_unreachable_default_argument_value' => true,
+    'no_unused_imports' => true,
+    'no_useless_return' => true,
+    'no_whitespace_before_comma_in_array' => true,
+    'no_whitespace_in_blank_line' => true,
+    'normalize_index_brace' => true,
+    'not_operator_with_successor_space' => true,
+    'object_operator_without_whitespace' => true,
+    'ordered_imports' => ['sortAlgorithm' => 'alpha'],
+    'phpdoc_indent' => true,
+    'phpdoc_inline_tag' => true,
+    'phpdoc_no_access' => true,
+    'phpdoc_no_package' => true,
+    'phpdoc_no_useless_inheritdoc' => true,
+    'phpdoc_scalar' => true,
+    'phpdoc_single_line_var_spacing' => true,
+    'phpdoc_summary' => true,
+    'phpdoc_to_comment' => true,
+    'phpdoc_trim' => true,
+    'phpdoc_types' => true,
+    'phpdoc_var_without_name' => true,
+    'psr4' => true,
+    'self_accessor' => true,
+    'short_scalar_cast' => true,
+    'simplified_null_return' => false, // disabled by Shift
+    'single_blank_line_at_eof' => true,
+    'single_blank_line_before_namespace' => true,
+    'single_class_element_per_statement' => true,
+    'single_import_per_statement' => true,
+    'single_line_after_imports' => true,
+    'single_line_comment_style' => [
+        'comment_types' => ['hash']
+    ],
+    'single_quote' => true,
+    'space_after_semicolon' => true,
+    'standardize_not_equals' => true,
+    'switch_case_semicolon_to_colon' => true,
+    'switch_case_space' => true,
+    'ternary_operator_spaces' => true,
+    'trailing_comma_in_multiline_array' => true,
+    'trim_array_spaces' => true,
+    'unary_operator_spaces' => true,
+    'visibility_required' => [
+        'elements' => ['method', 'property']
+    ],
+    'whitespace_after_comma_in_array' => true,
+];
+
+$project_path = __DIR__;
+$finder = Finder::create()
+                ->in([
+                    $project_path . '/src',
+                    $project_path . '/config',
+                    $project_path . '/routes',
+                ])
+                ->name('*.php')
+                ->notName('*.blade.php')
+                ->ignoreDotFiles(true)
+                ->ignoreVCS(true);
+
+return Config::create()
+             ->setFinder($finder)
+             ->setRules($rules)
+             ->setRiskyAllowed(true)
+             ->setUsingCache(true);
diff --git a/config/config.php b/config/config.php
@@ -14,8 +14,7 @@
     'token' => [
         'storage_file' => 'nineteen/instagram/token.json',
 
-        'days_before_expiration' => 30 // Refresh token 30 days before expiration
+        'days_before_expiration' => 30, // Refresh token 30 days before expiration
     ],
 
-
 ];
diff --git a/routes/cp.php b/routes/cp.php
@@ -1,7 +1,7 @@
 <?php
 
-Route::prefix('nineteen-ig/')->name('nineteen-ig.')->group(function() {
+Route::prefix('nineteen-ig/')->name('nineteen-ig.')->group(function () {
     Route::get('/', 'InstagramLoginController@index')->name('index');
     Route::get('/logout', 'InstagramLoginController@logout')->name('logout');
     Route::get('/auth', 'InstagramLoginController@callback')->name('callback');
-});
+});
diff --git a/src/Http/Controllers/InstagramLoginController.php b/src/Http/Controllers/InstagramLoginController.php
@@ -1,6 +1,6 @@
 <?php
 
-Namespace NineteenSquared\Instagram\Http\Controllers;
+namespace NineteenSquared\Instagram\Http\Controllers;
 
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Log;
@@ -35,7 +35,6 @@ public function index(InstagramApi $instagram)
             'logoutUrl' => route('statamic.cp.nineteen-ig.logout'),
             'loginUrl' => $instagram->instagram_basic_display->getLoginUrl(),
         ]);
-
     }
 
     /**
@@ -68,7 +67,6 @@ public function callback(InstagramApi $instagram, Request $request)
             // Get the OAuth callback code
             $code = $request->get('code');
             $instagram->saveAccessTokenFromCallbackCode($code);
-
         } catch (\Exception $exception) {
             Log::error($exception);
         }

diff --git a/src/InstagramApi.php b/src/InstagramApi.php
@@ -21,19 +21,19 @@ class InstagramApi
      */
     public function __construct()
     {
-        if($this->getAccessToken()) {
+        if ($this->getAccessToken()) {
             try {
                 $this->instagram_basic_display = new InstagramBasicDisplay($this->getAccessToken());
+
                 return;
             } catch (\Exception $exception) {
-
             }
         }
 
         $this->instagram_basic_display = new InstagramBasicDisplay([
             'appId' => config('statamic.instagram.appId'),
             'appSecret' => config('statamic.instagram.appSecret'),
-            'redirectUri' => route('statamic.cp.nineteen-ig.callback')
+            'redirectUri' => route('statamic.cp.nineteen-ig.callback'),
         ]);
     }
 
@@ -64,12 +64,9 @@ public function getAccessToken() : ?string
      */
     public function getExpireDate() : ? Carbon
     {
-        return $this->getStoredToken('expires_in')? Carbon::parse($this->getStoredToken('expires_in')) : null;
+        return $this->getStoredToken('expires_in') ? Carbon::parse($this->getStoredToken('expires_in')) : null;
     }
 
-    /**
-     *
-     */
     public function refreshToken() : void
     {
         $token = $this->instagram_basic_display->refreshToken($this->getStoredToken('access_token'), false);
@@ -82,11 +79,10 @@ public function refreshToken() : void
     public function getUserProfile() : ? object
     {
         try {
-            if($this->instagram_basic_display) {
+            if ($this->instagram_basic_display) {
                 return $this->instagram_basic_display->getUserProfile();
             }
         } catch (\Exception $exception) {
-
         }
 
         return null;
@@ -100,7 +96,8 @@ public function getUserProfile() : ? object
     public function getUserMedia(int $limit = 12) : ? array
     {
         $media = $this->instagram_basic_display->getUserMedia('me', $limit);
-        return collect($media->data)->map(function($media) {
+
+        return collect($media->data)->map(function ($media) {
             return [
                 'id' => $media->id,
                 'caption' => isset($media->caption) ? $media->caption : null,
@@ -130,7 +127,7 @@ private function getStoredToken($key)
 
                 return $token[$key];
             } catch (\Exception $exception) {
-                Log::alert('Instagram error : ' .$exception->getMessage());
+                Log::alert('Instagram error : '.$exception->getMessage());
             }
         }
 

diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -9,23 +9,23 @@
 class ServiceProvider extends AddonServiceProvider
 {
     protected $routes = [
-        'cp' => __DIR__ . '/../routes/cp.php',
+        'cp' => __DIR__.'/../routes/cp.php',
     ];
 
     protected $tags = [
-        \NineteenSquared\Instagram\Tags\Instagram::class
+        \NineteenSquared\Instagram\Tags\Instagram::class,
     ];
 
     public function boot()
     {
         parent::boot();
 
-        $this->loadViewsFrom(__DIR__ . '/../resources/views/', 'nineteen-ig');
-        $this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'statamic.instagram');
+        $this->loadViewsFrom(__DIR__.'/../resources/views/', 'nineteen-ig');
+        $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'statamic.instagram');
 
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__ . '/../config/config.php' => config_path('statamic/instagram.php'),
+                __DIR__.'/../config/config.php' => config_path('statamic/instagram.php'),
             ], 'instagram-config');
         }
 
@@ -44,5 +44,4 @@ public function boot()
             });
         });
     }
-
 }
diff --git a/src/Tags/Instagram.php b/src/Tags/Instagram.php
@@ -15,15 +15,15 @@ class Instagram extends Tags
      *
      * @return string|array
      */
-
     public function index()
     {
         $cache_key = config('statamic.instagram.cache.key_prefix').'_'.$this->params->get('limit');
 
         try {
-            if (!config('statamic.instagram.cache.duration')) {
+            if (! config('statamic.instagram.cache.duration')) {
                 return $this->getMedia($this->params->get('limit') ?: config('statamic.instagram.limit'));
             }
+
             return Cache::remember(
                 $cache_key,
                 now()->addSeconds(config('statamic.instagram.cache.duration')),
@@ -32,7 +32,8 @@ function () {
                 }
             );
         } catch (\Exception $exception) {
-            Log::alert('Instagram error : ' .$exception->getMessage());
+            Log::alert('Instagram error : '.$exception->getMessage());
+
             return [];
         }
     }
@@ -42,8 +43,7 @@ private function getMedia(int $limit)
         $instagram = new InstagramApi();
 
         if ($instagram->getExpireDate() &&
-            $instagram->getExpireDate()->diffInDays(Carbon::now()) < config('statamic.instagram.token.days_before_expiration'))
-        {
+            $instagram->getExpireDate()->diffInDays(Carbon::now()) < config('statamic.instagram.token.days_before_expiration')) {
             $instagram->refreshToken();
         }