Controller::buildClass() - Code Metrics - Inspection of "Refactoring for PHP 7.4 types and PHP 8.x migratio..." - coolsam726/jetstream-inertia-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 250f6a...af675f )

by Sam

created 2021-05-01 12:36 UTC

Controller::buildClass() B

↳ Parent: Project

Complexity

Conditions	10
Paths	1

Size

Total Lines

Duplication

Lines	3
Ratio	7.32 %

Importance

Changes

Metric	Value
dl	3
loc	41
rs	7.6666
c	0
b	0
f	0
cc	10
nc	1
nop	0

How to fix Complexity

<?php namespace Savannabits\JetstreamInertiaGenerator\Generators;

use Doctrine\DBAL\Schema\ForeignKeyConstraint;
use Savannabits\JetstreamInertiaGenerator\Generators\Traits\FileManipulations;
use Illuminate\Support\Str;
use Illuminate\Support\Arr;
use Symfony\Component\Console\Input\InputOption;

class Controller extends ClassGenerator {

    use FileManipulations;

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $name = 'jig:generate:controller';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Generate a web controller class';

    /**
     * Path for view
     *
     * @var string
     */
    protected string $view = 'controller';


    /**
     * Controller has also export method
     *
     * @return mixed
     */
    protected bool $export = false;

    /**
     * Controller has also bulk options method
     *
     * @return mixed
     */
    protected bool $withoutBulk = false;
    protected string $modelTitle;

    public function handle()
    {
        $force = $this->option('force');

        if($this->option('with-export')){
            $this->export = true;
        }

        if($this->option('without-bulk')){
            $this->withoutBulk = true;
        }
        // TODO test the case, if someone passes a class_name outside Laravel's default App\Http\Controllers folder, if it's going to work

        //TODO check if exists
        //TODO make global for all generator
        //TODO also with prefix
        if(!empty($template = $this->option('template'))) {
            $this->view = 'templates.'.$template.'.controller';
        }

        if(!empty($belongsToMany = $this->option('belongs-to-many'))) {
            $this->setBelongToManyRelation($belongsToMany);
        }

        if ($this->generateClass($force)){

            $this->info('Generating '.$this->classFullName.' finished');

            $icon = "far fa-clone";
            $path = resource_path("js/Layouts/Jig/Menu.json");
            if (file_exists($path)) {
                $menu = collect(json_decode(file_get_contents($path)));
            } else {
                $menu = collect([]);
            }
            if (!$menu->has($this->modelRouteAndViewName)) {
                $item = [
                   "route" => "admin.$this->modelRouteAndViewName.index",
                    "title" => $this->titlePlural,
                    "routePattern" => "admin.$this->modelRouteAndViewName.*",
                    "faIcon" => $icon,
                    "isTitle" => false,
                    "isParent" => false,
                    "children" => []
                ];
                $menu[$this->modelRouteAndViewName] = $item;
                if (file_put_contents($path,json_encode($menu->toArray(), JSON_PRETTY_PRINT))) {
                    $this->info("Updating Sidebar Menu");
                };
            }
        }

    }

    protected function buildClass() : string {

        //Set belongsTo Relations
        $this->setBelongsToRelations();
        return view('jig::'.$this->view, [
            'controllerBaseName' => $this->classBaseName,
            'controllerNamespace' => $this->classNamespace,
            'repoBaseName' => $this->getRepositoryBaseName(),
            "repoFullName" => $this->getRepoNamespace($this->rootNamespace()).'\\'.$this->getRepositoryBaseName(),
            'modelBaseName' => $this->modelBaseName,
            'modelFullName' => $this->modelFullName,
            'modelPlural' => $this->modelPlural,
            'modelTitle' => $this->titleSingular,
            'modelVariableName' => $this->modelVariableName,
            'modelRouteAndViewName' => $this->modelRouteAndViewName,
            'modelViewsDirectory' => $this->modelViewsDirectory,
            'modelDotNotation' => $this->modelDotNotation,
            'modelWithNamespaceFromDefault' => $this->modelWithNamespaceFromDefault,
            'export' => $this->export,
            'withoutBulk' => $this->withoutBulk,
            'exportBaseName' => $this->exportBaseName,
            'resource' => $this->resource,
            'containsPublishedAtColumn' => in_array("published_at", array_column($this->readColumnsFromTable($this->tableName)->toArray(), 'name')),
            // index
            'columnsToQuery' => $this->readColumnsFromTable($this->tableName)->filter(function($column) {
                return !($column['type'] == 'text' || $column['name'] == "password" || $column['name'] == "remember_token" || $column['name'] == "deleted_at"||Str::contains($column['name'],"_id"));
            })->pluck('name')->toArray(),
            'columnsToSearchIn' => $this->readColumnsFromTable($this->tableName)->filter(function($column) {
                return ($column['type'] == 'json' || $column['type'] == 'text' || $column['type'] == 'string' || $column['name'] == "id") && !($column['name'] == "password" || $column['name'] == "remember_token");
            })->pluck('name')->toArray(),
            //            'filters' => $this->readColumnsFromTable($tableName)->filter(function($column) {
            //                return $column['type'] == 'boolean' || $column['type'] == 'date';
            //            }),
            // validation in store/update
            'columns' => $this->getVisibleColumns($this->tableName, $this->modelVariableName),
            'relations' => $this->relations,
            'hasSoftDelete' => $this->readColumnsFromTable($this->tableName)->filter(function($column) {
                    return $column['name'] == "deleted_at";
            })->count() > 0,
        ])->render();
    }

    protected function getOptions() {
        return [
            ['model-name', 'm', InputOption::VALUE_OPTIONAL, 'Generates a code for the given model'],
            ['template', 't', InputOption::VALUE_OPTIONAL, 'Specify custom template'],
            ['belongs-to-many', 'btm', InputOption::VALUE_OPTIONAL, 'Specify belongs to many relations'],
            ['force', 'f', InputOption::VALUE_NONE, 'Force will delete files before regenerating controller'],
            ['model-with-full-namespace', 'fnm', InputOption::VALUE_OPTIONAL, 'Specify model with full namespace'],
            ['with-export', 'e', InputOption::VALUE_NONE, 'Generate an option to Export as Excel'],
            ['without-bulk', 'wb', InputOption::VALUE_NONE, 'Generate without bulk options'],
        ];
    }

    public function generateClassNameFromTable($tableName): string
    {
        return Str::studly(Str::singular($tableName)).'Controller';
    }

    /**
     * Get the default namespace for the class.
     *
     * @param string $rootNamespace
     * @return string
     */
    protected function getDefaultNamespace(string $rootNamespace) :string
    {
        return $rootNamespace.'\Http\Controllers\Admin';
    }
    protected function getRepoNamespace($rootNamespace): string
    {
        return $rootNamespace.'Repositories';
    }
    protected function getRepositoryBaseName(): string
    {
        return Str::studly(Str::plural($this->tableName));
    }
}


1			<?php namespace Savannabits\JetstreamInertiaGenerator\Generators;
2
3			use Doctrine\DBAL\Schema\ForeignKeyConstraint;
4			use Savannabits\JetstreamInertiaGenerator\Generators\Traits\FileManipulations;
5			use Illuminate\Support\Str;
6			use Illuminate\Support\Arr;
7			use Symfony\Component\Console\Input\InputOption;
8
9			class Controller extends ClassGenerator {
10
11			use FileManipulations;
12
13			/**
14			* The name and signature of the console command.
15			*
16			* @var string
17			*/
18			protected $name = 'jig:generate:controller';
19
20			/**
21			* The console command description.
22			*
23			* @var string
24			*/
25			protected $description = 'Generate a web controller class';
26
27			/**
28			* Path for view
29			*
30			* @var string
31			*/
32			protected string $view = 'controller';
			0 ignored issues – show Bug introduced 2021-05-01 12:43 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected T_STRING, expecting T_FUNCTION or T_CONST Loading history...
33
34			/**
35			* Controller has also export method
36			*
37			* @return mixed
38			*/
39			protected bool $export = false;
40
41			/**
42			* Controller has also bulk options method
43			*
44			* @return mixed
45			*/
46			protected bool $withoutBulk = false;
47			protected string $modelTitle;
48
49			public function handle()
50			{
51			$force = $this->option('force');
52
53			if($this->option('with-export')){
54			$this->export = true;
55			}
56
57			if($this->option('without-bulk')){
58			$this->withoutBulk = true;
59			}
60			// TODO test the case, if someone passes a class_name outside Laravel's default App\Http\Controllers folder, if it's going to work
61
62			//TODO check if exists
63			//TODO make global for all generator
64			//TODO also with prefix
65			if(!empty($template = $this->option('template'))) {
66			$this->view = 'templates.'.$template.'.controller';
67			}
68
69			if(!empty($belongsToMany = $this->option('belongs-to-many'))) {
70			$this->setBelongToManyRelation($belongsToMany);
71			}
72
73			if ($this->generateClass($force)){
74
75			$this->info('Generating '.$this->classFullName.' finished');
76
77			$icon = "far fa-clone";
78			$path = resource_path("js/Layouts/Jig/Menu.json");
79			if (file_exists($path)) {
80			$menu = collect(json_decode(file_get_contents($path)));
81			} else {
82			$menu = collect([]);
83			}
84			if (!$menu->has($this->modelRouteAndViewName)) {
85			$item = [
86			"route" => "admin.$this->modelRouteAndViewName.index",
87			"title" => $this->titlePlural,
88			"routePattern" => "admin.$this->modelRouteAndViewName.*",
89			"faIcon" => $icon,
90			"isTitle" => false,
91			"isParent" => false,
92			"children" => []
93			];
94			$menu[$this->modelRouteAndViewName] = $item;
95			if (file_put_contents($path,json_encode($menu->toArray(), JSON_PRETTY_PRINT))) {
96			$this->info("Updating Sidebar Menu");
97			};
98			}
99			}
100
101			}
102
103			protected function buildClass() : string {
104
105			//Set belongsTo Relations
106			$this->setBelongsToRelations();
107			return view('jig::'.$this->view, [
108			'controllerBaseName' => $this->classBaseName,
109			'controllerNamespace' => $this->classNamespace,
110			'repoBaseName' => $this->getRepositoryBaseName(),
111			"repoFullName" => $this->getRepoNamespace($this->rootNamespace()).'\\'.$this->getRepositoryBaseName(),
112			'modelBaseName' => $this->modelBaseName,
113			'modelFullName' => $this->modelFullName,
114			'modelPlural' => $this->modelPlural,
115			'modelTitle' => $this->titleSingular,
116			'modelVariableName' => $this->modelVariableName,
117			'modelRouteAndViewName' => $this->modelRouteAndViewName,
118			'modelViewsDirectory' => $this->modelViewsDirectory,
119			'modelDotNotation' => $this->modelDotNotation,
120			'modelWithNamespaceFromDefault' => $this->modelWithNamespaceFromDefault,
121			'export' => $this->export,
122			'withoutBulk' => $this->withoutBulk,
123			'exportBaseName' => $this->exportBaseName,
124			'resource' => $this->resource,
125			'containsPublishedAtColumn' => in_array("published_at", array_column($this->readColumnsFromTable($this->tableName)->toArray(), 'name')),
126			// index
127			'columnsToQuery' => $this->readColumnsFromTable($this->tableName)->filter(function($column) {
128			return !($column['type'] == 'text' \|\| $column['name'] == "password" \|\| $column['name'] == "remember_token" \|\| $column['name'] == "deleted_at"\|\|Str::contains($column['name'],"_id"));
129			})->pluck('name')->toArray(),
130			'columnsToSearchIn' => $this->readColumnsFromTable($this->tableName)->filter(function($column) {
131			return ($column['type'] == 'json' \|\| $column['type'] == 'text' \|\| $column['type'] == 'string' \|\| $column['name'] == "id") && !($column['name'] == "password" \|\| $column['name'] == "remember_token");
132			})->pluck('name')->toArray(),
133			// 'filters' => $this->readColumnsFromTable($tableName)->filter(function($column) {
134			// return $column['type'] == 'boolean' \|\| $column['type'] == 'date';
135			// }),
136			// validation in store/update
137			'columns' => $this->getVisibleColumns($this->tableName, $this->modelVariableName),
138			'relations' => $this->relations,
139			'hasSoftDelete' => $this->readColumnsFromTable($this->tableName)->filter(function($column) {
140			return $column['name'] == "deleted_at";
141			})->count() > 0,
142			])->render();
143			}
144
145			protected function getOptions() {
146			return [
147			['model-name', 'm', InputOption::VALUE_OPTIONAL, 'Generates a code for the given model'],
148			['template', 't', InputOption::VALUE_OPTIONAL, 'Specify custom template'],
149			['belongs-to-many', 'btm', InputOption::VALUE_OPTIONAL, 'Specify belongs to many relations'],
150			['force', 'f', InputOption::VALUE_NONE, 'Force will delete files before regenerating controller'],
151			['model-with-full-namespace', 'fnm', InputOption::VALUE_OPTIONAL, 'Specify model with full namespace'],
152			['with-export', 'e', InputOption::VALUE_NONE, 'Generate an option to Export as Excel'],
153			['without-bulk', 'wb', InputOption::VALUE_NONE, 'Generate without bulk options'],
154			];
155			}
156
157			public function generateClassNameFromTable($tableName): string
158			{
159			return Str::studly(Str::singular($tableName)).'Controller';
160			}
161
162			/**
163			* Get the default namespace for the class.
164			*
165			* @param string $rootNamespace
166			* @return string
167			*/
168			protected function getDefaultNamespace(string $rootNamespace) :string
169			{
170			return $rootNamespace.'\Http\Controllers\Admin';
171			}
172			protected function getRepoNamespace($rootNamespace): string
173			{
174			return $rootNamespace.'Repositories';
175			}
176			protected function getRepositoryBaseName(): string
177			{
178			return Str::studly(Str::plural($this->tableName));
179			}
180			}
181

coolsam726 / jetstream-inertia-generator

Push — master ( 250f6a...af675f )

Controller::buildClass() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like