Merge pull request #7 from hexadog/develop

Develop

Author: gaetan-hexadog

.circleci/config.yml

@@ -0,0 +1,25 @@
+name: Check and fix code styling with php-cs-fixer
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Run php-cs-fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --config=.php_cs.dist --allow-risky=yes
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4.10.0
+        with:
+          commit_message: Automatically applied php-cs-fixer changes

.github/workflows/php-cs-fixer.yml

@@ -0,0 +1,44 @@
+<?php
+
+$finder = Symfony\Component\Finder\Finder::create()
+    ->notPath('vendor/*')
+    ->notPath('resources/*')
+    ->notPath('database/*')
+    ->notPath('storage/*')
+    ->notPath('node_modules/*')
+    ->in([
+        __DIR__ . '/src',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => ['sortAlgorithm' => 'alpha'],
+        'no_unused_imports' => true,
+        'not_operator_with_successor_space' => true,
+        'trailing_comma_in_multiline_array' => true,
+        'phpdoc_scalar' => true,
+        'unary_operator_spaces' => true,
+        'binary_operator_spaces' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+        ],
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_var_without_name' => true,
+        'class_attributes_separation' => [
+            'elements' => [
+                'method',
+            ],
+        ],
+        'method_argument_space' => [
+            'on_multiline' => 'ensure_fully_multiline',
+            'keep_multiple_spaces_after_comma' => true,
+        ],
+        'single_trait_insert_per_statement' => true,
+    ])
+    ->setFinder($finder);

.php_cs.dist

@@ -19,6 +19,7 @@
         "illuminate/view": "^7.0|^8.0"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^2.18",
         "squizlabs/php_codesniffer": "3.*",
         "phpunit/phpunit": "^7.0|^8.0|^9.0",
         "orchestra/testbench": "~5.2"
@@ -45,6 +46,6 @@
         "test": "vendor/bin/phpunit",
         "test:windows": "vendor\\bin\\phpunit",
         "check-style": "vendor/bin/phpcs --extensions=php ./src",
-        "fix-style": "vendor/bin/phpcbf --extensions=php ./src"
+        "fix-style": "vendor/bin/php-cs-fixer fix"
     }
 }

composer.json

@@ -2,9 +2,9 @@
 
 namespace Hexadog\MenusManager\Components;
 
-use Illuminate\View\Component;
-use Illuminate\Support\Collection;
 use Hexadog\MenusManager\Facades\Menus;
+use Illuminate\Support\Collection;
+use Illuminate\View\Component;
 
 class Menu extends Component
 {

src/Components/Menu.php

@@ -2,8 +2,8 @@
 
 namespace Hexadog\MenusManager\Facades;
 
-use Illuminate\Support\Facades\Facade;
 use Hexadog\MenusManager\MenusManager as Manager;
+use Illuminate\Support\Facades\Facade;
 
 class MenusManager extends Facade
 {

src/Facades/MenusManager.php

@@ -2,10 +2,10 @@
 
 namespace Hexadog\MenusManager;
 
-use Illuminate\Support\Arr;
-use Illuminate\Support\Collection;
 use Hexadog\MenusManager\Traits\HasItems;
 use Illuminate\Contracts\Support\Arrayable;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Request;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Facades\URL;
@@ -28,13 +28,13 @@ class Item implements Arrayable
      * @var array
      */
     protected $properties = [
-        'attributes'    => [],
-        'icon'          => null,
-        'order'         => 9000,
-        'route'         => null,
-        'title'         => '',
-        'type'          => 'link', // link | divider | header
-        'url'           => null,
+        'attributes' => [],
+        'icon' => null,
+        'order' => 9000,
+        'route' => null,
+        'title' => '',
+        'type' => 'link', // link | divider | header
+        'url' => null,
     ];
 
     /**
@@ -101,7 +101,7 @@ public function __set($key, $value)
     public function asHeader(): Item
     {
         return $this->fill([
-            'type' => 'header'
+            'type' => 'header',
         ]);
     }
 
@@ -113,7 +113,7 @@ public function asHeader(): Item
     public function asDivider(): Item
     {
         return $this->fill([
-            'type' => 'divider'
+            'type' => 'divider',
         ]);
     }
 
@@ -194,11 +194,11 @@ public function hasChildren(): bool
     /**
      * Check if icon is set for the current item
      *
-     * @return boolean
+     * @return bool
      */
     public function hasIcon(): bool
     {
-        return !is_null($this->icon);
+        return ! is_null($this->icon);
     }
 
     /**
@@ -251,7 +251,7 @@ public function isHeader(): bool
      */
     public function isHidden(): bool
     {
-        return !$this->isVisible();
+        return ! $this->isVisible();
     }
 
     /**
@@ -289,7 +289,7 @@ public function icon(string $icon): Item
      */
     public function if($callback): Item
     {
-        if (!is_callable($callback)) {
+        if (! is_callable($callback)) {
             $callback = function () use ($callback) {
                 return $callback;
             };
@@ -303,7 +303,7 @@ public function if($callback): Item
     /**
      * Set the current item order
      *
-     * @param integer $order
+     * @param int $order
      *
      * @return Item
      */
@@ -367,6 +367,7 @@ private function htmlAttributes($attributes)
             if (is_bool($attributes[$key])) {
                 return $attributes[$key] ? $key : '';
             }
+
             return $key . '="' . $attributes[$key] . '"';
         }, array_keys($attributes))));
     }
@@ -386,7 +387,7 @@ public function toArray()
             'order' => $this->order,
             'title' => $this->title,
             'type' => $this->type,
-            'url' => $this->getUrl()
+            'url' => $this->getUrl(),
         ];
     }
 }

src/Item.php

@@ -55,7 +55,7 @@ public function toArray()
     {
         return [
             'name' => $this->name,
-            'items' => $this->items->toArray()
+            'items' => $this->items->toArray(),
         ];
     }
 }

src/Menu.php

@@ -41,7 +41,7 @@ public function all(): array
      */
     public function register($name): Menu
     {
-        if (!$menu = $this->get($name)) {
+        if (! $menu = $this->get($name)) {
             $menu = new Menu($name);
 
             $this->menus->put($name, $menu);
@@ -60,8 +60,8 @@ public function register($name): Menu
      */
     public function __call($method_name, $args)
     {
-        if (!method_exists($this, $method_name)) {
-            return call_user_func_array(array($this->menus, $method_name), $args);
+        if (! method_exists($this, $method_name)) {
+            return call_user_func_array([$this->menus, $method_name], $args);
         }
     }
 }

src/MenusManager.php

@@ -2,15 +2,15 @@
 
 namespace Hexadog\MenusManager\Providers;
 
-use ReflectionClass;
-use Illuminate\Support\Str;
-use Illuminate\Routing\Router;
 use Hexadog\MenusManager\Components;
+use Hexadog\MenusManager\Facades\Menus as MenusFacade;
+use Hexadog\MenusManager\Facades\MenusManager as MenusManagerFacade;
 use Hexadog\MenusManager\MenusManager;
 use Illuminate\Foundation\AliasLoader;
+use Illuminate\Routing\Router;
 use Illuminate\Support\ServiceProvider;
-use Hexadog\MenusManager\Facades\Menus as MenusFacade;
-use Hexadog\MenusManager\Facades\MenusManager as MenusManagerFacade;
+use Illuminate\Support\Str;
+use ReflectionClass;
 
 class PackageServiceProvider extends ServiceProvider
 {
@@ -69,7 +69,7 @@ public function boot(Router $router)
             Components\Header::class,
             Components\Icon::class,
             Components\Item::class,
-            Components\Menu::class
+            Components\Menu::class,
         ]);
     }