PermissionServiceProvider::migrationAlreadyPublished() - Code Metrics - Inspection of "Avoid re-publishing migration if already present" - spatie/laravel-permission - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#962)

by Chris

created 2018-11-30 17:21 UTC

migrationAlreadyPublished() A

↳ Parent: PermissionServiceProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php

namespace Spatie\Permission;

use Illuminate\Routing\Route;
use Illuminate\Support\Collection;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\ServiceProvider;
use Illuminate\View\Compilers\BladeCompiler;
use Spatie\Permission\Contracts\Role as RoleContract;
use Spatie\Permission\Contracts\Permission as PermissionContract;

class PermissionServiceProvider extends ServiceProvider
{
    public function boot(PermissionRegistrar $permissionLoader, Filesystem $filesystem)
    {
        if (isNotLumen()) {
            $this->publishes([
                __DIR__.'/../config/permission.php' => config_path('permission.php'),
            ], 'config');

            if (! class_exists('CreatePermissionTables') && ! $this->migrationAlreadyPublished($filesystem)) {
                $timestamp = date('Y_m_d_His', time());

                $this->publishes([
                    __DIR__.'/../database/migrations/create_permission_tables.php.stub' => $this->app->databasePath()."/migrations/{$timestamp}_create_permission_tables.php",
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                ], 'migrations');
            }

            if (app()->version() >= '5.5') {
                $this->registerMacroHelpers();
            }
        }

        if ($this->app->runningInConsole()) {
            $this->commands([
                Commands\CacheReset::class,
                Commands\CreateRole::class,
                Commands\CreatePermission::class,
            ]);
        }

        $this->registerModelBindings();

        $permissionLoader->registerPermissions();

        $this->app->singleton(PermissionRegistrar::class, function ($app) use ($permissionLoader) {

            return $permissionLoader;
        });
    }

    public function register()
    {
        if (isNotLumen()) {
            $this->mergeConfigFrom(
                __DIR__.'/../config/permission.php',
                'permission'
            );
        }

        $this->registerBladeExtensions();
    }

    protected function registerModelBindings()
    {
        $config = $this->app->config['permission.models'];
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        $this->app->bind(PermissionContract::class, $config['permission']);
        $this->app->bind(RoleContract::class, $config['role']);
    }

    protected function registerBladeExtensions()
    {
        $this->app->afterResolving('blade.compiler', function (BladeCompiler $bladeCompiler) {
            $bladeCompiler->directive('role', function ($arguments) {

                list($role, $guard) = explode(',', $arguments.',');

                return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
            });
            $bladeCompiler->directive('elserole', function ($arguments) {

                list($role, $guard) = explode(',', $arguments.',');

                return "<?php elseif(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
            });
            $bladeCompiler->directive('endrole', function () {
                return '<?php endif; ?>';
            });

            $bladeCompiler->directive('hasrole', function ($arguments) {

                list($role, $guard) = explode(',', $arguments.',');

                return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
            });
            $bladeCompiler->directive('endhasrole', function () {
                return '<?php endif; ?>';
            });

            $bladeCompiler->directive('hasanyrole', function ($arguments) {

                list($roles, $guard) = explode(',', $arguments.',');

                return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasAnyRole({$roles})): ?>";
            });
            $bladeCompiler->directive('endhasanyrole', function () {
                return '<?php endif; ?>';
            });

            $bladeCompiler->directive('hasallroles', function ($arguments) {

                list($roles, $guard) = explode(',', $arguments.',');

                return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasAllRoles({$roles})): ?>";
            });
            $bladeCompiler->directive('endhasallroles', function () {
                return '<?php endif; ?>';
            });

            $bladeCompiler->directive('unlessrole', function ($arguments) {

                list($role, $guard) = explode(',', $arguments.',');

                return "<?php if(!auth({$guard})->check() || ! auth({$guard})->user()->hasRole({$role})): ?>";
            });
            $bladeCompiler->directive('endunlessrole', function () {
                return '<?php endif; ?>';
            });
        });
    }

    protected function registerMacroHelpers()
    {
        Route::macro('role', function ($roles = []) {

            if (! is_array($roles)) {
                $roles = [$roles];
            }

            $roles = implode('|', $roles);

            $this->middleware("role:$roles");


            return $this;
        });

        Route::macro('permission', function ($permissions = []) {

            if (! is_array($permissions)) {
                $permissions = [$permissions];
            }

            $permissions = implode('|', $permissions);

            $this->middleware("permission:$permissions");


            return $this;
        });
    }

    /**
     * @param Filesystem $filesystem
     * @return bool
     */
    protected function migrationAlreadyPublished(Filesystem $filesystem): bool
    {
        return Collection::make($this->app->databasePath().DIRECTORY_SEPARATOR.'migrations'.DIRECTORY_SEPARATOR)
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                ->flatMap(function ($path) use ($filesystem) {
                    return $filesystem->glob($path.'*_create_permission_tables.php');
                })
                ->count() > 0;
    }
}


1		<?php
2
3		namespace Spatie\Permission;
4
5		use Illuminate\Routing\Route;
6		use Illuminate\Support\Collection;
7		use Illuminate\Filesystem\Filesystem;
8		use Illuminate\Support\ServiceProvider;
9		use Illuminate\View\Compilers\BladeCompiler;
10		use Spatie\Permission\Contracts\Role as RoleContract;
11		use Spatie\Permission\Contracts\Permission as PermissionContract;
12
13		class PermissionServiceProvider extends ServiceProvider
14		{
15		public function boot(PermissionRegistrar $permissionLoader, Filesystem $filesystem)
16		{
17		if (isNotLumen()) {
18		$this->publishes([
19		__DIR__.'/../config/permission.php' => config_path('permission.php'),
20		], 'config');
21
22		if (! class_exists('CreatePermissionTables') && ! $this->migrationAlreadyPublished($filesystem)) {
23		$timestamp = date('Y_m_d_His', time());
24
25		$this->publishes([
26		__DIR__.'/../database/migrations/create_permission_tables.php.stub' => $this->app->databasePath()."/migrations/{$timestamp}_create_permission_tables.php",
		0 ignored issues – show Bug introduced 2018-11-05 06:18 UTC by Report Bug Copy Issue Report The method `databasePath` does only exist in `Illuminate\Foundation\Application`, but not in `Illuminate\Contracts\Foundation\Application`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
27		], 'migrations');
28		}
29
30		if (app()->version() >= '5.5') {
31		$this->registerMacroHelpers();
32		}
33		}
34
35		if ($this->app->runningInConsole()) {
36		$this->commands([
37		Commands\CacheReset::class,
38		Commands\CreateRole::class,
39		Commands\CreatePermission::class,
40		]);
41		}
42
43		$this->registerModelBindings();
44
45		$permissionLoader->registerPermissions();
46
47		$this->app->singleton(PermissionRegistrar::class, function ($app) use ($permissionLoader) {
		0 ignored issues – show Unused Code introduced 2018-11-08 11:43 UTC by Report Bug Copy Issue Report The parameter `$app` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
48		return $permissionLoader;
49		});
50		}
51
52		public function register()
53		{
54		if (isNotLumen()) {
55		$this->mergeConfigFrom(
56		__DIR__.'/../config/permission.php',
57		'permission'
58		);
59		}
60
61		$this->registerBladeExtensions();
62		}
63
64		protected function registerModelBindings()
65		{
66		$config = $this->app->config['permission.models'];
		0 ignored issues – show Bug introduced 2017-06-11 00:59 UTC by Report Bug Copy Issue Report Accessing `config` on the interface `Illuminate\Contracts\Foundation\Application` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
67
68		$this->app->bind(PermissionContract::class, $config['permission']);
69		$this->app->bind(RoleContract::class, $config['role']);
70		}
71
72		protected function registerBladeExtensions()
73		{
74		$this->app->afterResolving('blade.compiler', function (BladeCompiler $bladeCompiler) {
75	View Code Duplication	$bladeCompiler->directive('role', function ($arguments) {
		0 ignored issues – show Duplication introduced 2017-04-10 14:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
76		list($role, $guard) = explode(',', $arguments.',');
77
78		return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
79		});
80	View Code Duplication	$bladeCompiler->directive('elserole', function ($arguments) {
		0 ignored issues – show Duplication introduced 2018-09-29 02:54 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
81		list($role, $guard) = explode(',', $arguments.',');
82
83		return "<?php elseif(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
84		});
85		$bladeCompiler->directive('endrole', function () {
86		return '<?php endif; ?>';
87		});
88
89	View Code Duplication	$bladeCompiler->directive('hasrole', function ($arguments) {
		0 ignored issues – show Duplication introduced 2017-04-10 14:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
90		list($role, $guard) = explode(',', $arguments.',');
91
92		return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
93		});
94		$bladeCompiler->directive('endhasrole', function () {
95		return '<?php endif; ?>';
96		});
97
98	View Code Duplication	$bladeCompiler->directive('hasanyrole', function ($arguments) {
		0 ignored issues – show Duplication introduced 2017-04-10 14:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
99		list($roles, $guard) = explode(',', $arguments.',');
100
101		return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasAnyRole({$roles})): ?>";
102		});
103		$bladeCompiler->directive('endhasanyrole', function () {
104		return '<?php endif; ?>';
105		});
106
107	View Code Duplication	$bladeCompiler->directive('hasallroles', function ($arguments) {
		0 ignored issues – show Duplication introduced 2018-09-29 02:54 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
108		list($roles, $guard) = explode(',', $arguments.',');
109
110		return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasAllRoles({$roles})): ?>";
111		});
112		$bladeCompiler->directive('endhasallroles', function () {
113		return '<?php endif; ?>';
114		});
115
116	View Code Duplication	$bladeCompiler->directive('unlessrole', function ($arguments) {
		0 ignored issues – show Duplication introduced 2017-04-10 14:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117		list($role, $guard) = explode(',', $arguments.',');
118
119		return "<?php if(!auth({$guard})->check() \|\| ! auth({$guard})->user()->hasRole({$role})): ?>";
120		});
121		$bladeCompiler->directive('endunlessrole', function () {
122		return '<?php endif; ?>';
123		});
124		});
125		}
126
127		protected function registerMacroHelpers()
128		{
129	View Code Duplication	Route::macro('role', function ($roles = []) {
		0 ignored issues – show Duplication introduced 2018-10-10 18:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
130		if (! is_array($roles)) {
131		$roles = [$roles];
132		}
133
134		$roles = implode('\|', $roles);
135
136		$this->middleware("role:$roles");
		0 ignored issues – show Bug introduced 2018-10-10 18:56 UTC by Report Bug Copy Issue Report The method `middleware()` does not seem to exist on `object<Spatie\Permission...missionServiceProvider>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
137
138		return $this;
139		});
140
141	View Code Duplication	Route::macro('permission', function ($permissions = []) {
		0 ignored issues – show Duplication introduced 2018-10-10 18:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
142		if (! is_array($permissions)) {
143		$permissions = [$permissions];
144		}
145
146		$permissions = implode('\|', $permissions);
147
148		$this->middleware("permission:$permissions");
		0 ignored issues – show Bug introduced 2018-10-10 18:56 UTC by Report Bug Copy Issue Report The method `middleware()` does not seem to exist on `object<Spatie\Permission...missionServiceProvider>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
149
150		return $this;
151		});
152		}
153
154		/**
155		* @param Filesystem $filesystem
156		* @return bool
157		*/
158		protected function migrationAlreadyPublished(Filesystem $filesystem): bool
159		{
160		return Collection::make($this->app->databasePath().DIRECTORY_SEPARATOR.'migrations'.DIRECTORY_SEPARATOR)
		0 ignored issues – show Bug introduced 2018-11-30 17:23 UTC by Report Bug Copy Issue Report The method `databasePath` does only exist in `Illuminate\Foundation\Application`, but not in `Illuminate\Contracts\Foundation\Application`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
161		->flatMap(function ($path) use ($filesystem) {
162		return $filesystem->glob($path.'*_create_permission_tables.php');
163		})
164		->count() > 0;
165		}
166		}
167

spatie / laravel-permission

Pull Request — master (#962)

migrationAlreadyPublished() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like