Skip to content

Commit 7425ef2

Browse files
lindyhopchrislindyhopchris
committed
[Feature] Add generator console commands
1 parent faf86eb commit 7425ef2

31 files changed

+2654
-3
lines changed

‎config/jsonapi.php

+14
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
return [
44

5+
/*
6+
|--------------------------------------------------------------------------
7+
| Root Namespace
8+
|--------------------------------------------------------------------------
9+
|
10+
| The root JSON:API namespace, within your application's namespace.
11+
| This is used when generating any class that does not sit *within*
12+
| a server's namespace. For example, new servers and filters.
13+
|
14+
| By default this is set to `JsonApi` which means the root namespace
15+
| will be `\App\JsonApi`, if your application's namespace is `App`.
16+
*/
17+
'namespace' => 'JsonApi',
18+
519
/*
620
|--------------------------------------------------------------------------
721
| Servers

‎src/Console/Concerns/ResolvesStub.php

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<?php
2+
/*
3+
* Copyright 2020 Cloud Creativity Limited
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
declare(strict_types=1);
19+
20+
namespace LaravelJsonApi\Laravel\Console\Concerns;
21+
22+
use function file_exists;
23+
24+
trait ResolvesStub
25+
{
26+
27+
/**
28+
* Resolve the fully-qualified path to the stub.
29+
*
30+
* @param string $stub
31+
* @return string
32+
*/
33+
protected function resolveStubPath(string $stub): string
34+
{
35+
$customPath = $this->laravel->basePath("stubs/jsonapi/{$stub}");
36+
37+
return file_exists($customPath) ? $customPath : __DIR__ . '/../../../stubs/' . $stub;
38+
}
39+
}

‎src/Console/GeneratorCommand.php

+151
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
<?php
2+
/*
3+
* Copyright 2020 Cloud Creativity Limited
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
declare(strict_types=1);
19+
20+
namespace LaravelJsonApi\Laravel\Console;
21+
22+
use Illuminate\Console\GeneratorCommand as BaseGeneratorCommand;
23+
use LaravelJsonApi\Core\Support\Str;
24+
use Symfony\Component\Console\Input\InputArgument;
25+
use function config;
26+
use function is_string;
27+
28+
abstract class GeneratorCommand extends BaseGeneratorCommand
29+
{
30+
31+
use Concerns\ResolvesStub;
32+
33+
/**
34+
* @var string
35+
*/
36+
protected $classType;
37+
38+
/**
39+
* @inheritDoc
40+
*/
41+
public function handle()
42+
{
43+
if (!$server = $this->getServerInput()) {
44+
$this->error('You must use the server option when you have more than one API.');
45+
return 1;
46+
}
47+
48+
if (is_null($this->getServerNamespace($server))) {
49+
$this->error("Server {$server} does not exist in your jsonapi.servers configuration.");
50+
return 1;
51+
}
52+
53+
if (false === parent::handle()) {
54+
return 1;
55+
}
56+
57+
return 0;
58+
}
59+
60+
/**
61+
* @inheritDoc
62+
*/
63+
protected function getNameInput()
64+
{
65+
$name = parent::getNameInput();
66+
67+
return Str::classify(Str::singular($name)) . $this->getClassType();
68+
}
69+
70+
/**
71+
* @inheritDoc
72+
*/
73+
protected function getDefaultNamespace($rootNamespace)
74+
{
75+
$name = parent::getNameInput();
76+
77+
$namespace = Str::classify(Str::plural($name));
78+
79+
return $this->getServerNamespace($this->getServerInput()) . '/' . $namespace;
80+
}
81+
82+
/**
83+
* Get the server input.
84+
*
85+
* The developer can provide a server name using the `--server`
86+
* option. If they do not provide it, we expect them to have a
87+
* single server in their `jsonapi` config.
88+
*
89+
* @return string|null
90+
*/
91+
protected function getServerInput(): ?string
92+
{
93+
if ($server = $this->option('server')) {
94+
return $server;
95+
}
96+
97+
$servers = config('jsonapi.servers') ?: [];
98+
99+
if (1 === count($servers)) {
100+
return array_key_first($servers);
101+
}
102+
103+
return null;
104+
}
105+
106+
/**
107+
* @param string $server
108+
* @return string|null
109+
*/
110+
protected function getServerNamespace(string $server): ?string
111+
{
112+
$classname = config("jsonapi.servers.{$server}");
113+
114+
if (is_string($classname)) {
115+
return $this->getNamespace($classname);
116+
}
117+
118+
return null;
119+
}
120+
121+
/**
122+
* @return string
123+
*/
124+
protected function guessModel(): string
125+
{
126+
$name = parent::getNameInput();
127+
128+
return Str::classify(Str::singular($name));
129+
}
130+
131+
/**
132+
* @return string
133+
*/
134+
protected function getClassType(): string
135+
{
136+
return $this->classType;
137+
}
138+
139+
/**
140+
* Get the console command arguments.
141+
*
142+
* @return array
143+
*/
144+
protected function getArguments()
145+
{
146+
return [
147+
['name', InputArgument::REQUIRED, 'The name of the JSON:API resource type.'],
148+
];
149+
}
150+
151+
}

‎src/Console/MakeController.php

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<?php
2+
/*
3+
* Copyright 2020 Cloud Creativity Limited
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
declare(strict_types=1);
19+
20+
namespace LaravelJsonApi\Laravel\Console;
21+
22+
use Illuminate\Console\GeneratorCommand as BaseGeneratorCommand;
23+
use Symfony\Component\Console\Input\InputOption;
24+
25+
class MakeController extends BaseGeneratorCommand
26+
{
27+
28+
use Concerns\ResolvesStub;
29+
30+
/**
31+
* @var string
32+
*/
33+
protected $name = 'jsonapi:controller';
34+
35+
/**
36+
* @var string
37+
*/
38+
protected $description = 'Create a new JSON:API controller.';
39+
40+
/**
41+
* @var string
42+
*/
43+
protected $type = 'JSON:API controller';
44+
45+
/**
46+
* @inheritDoc
47+
*/
48+
protected function getStub()
49+
{
50+
return $this->resolveStubPath('controller.stub');
51+
}
52+
53+
/**
54+
* @inheritDoc
55+
*/
56+
protected function getDefaultNamespace($rootNamespace)
57+
{
58+
return $rootNamespace.'\Http\Controllers';
59+
}
60+
61+
/**
62+
* Get the console command options.
63+
*
64+
* @return array
65+
*/
66+
protected function getOptions()
67+
{
68+
return [
69+
['force', null, InputOption::VALUE_NONE, 'Create the class even if the controller already exists'],
70+
];
71+
}
72+
}

‎src/Console/MakeFilter.php

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?php
2+
/*
3+
* Copyright 2020 Cloud Creativity Limited
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
declare(strict_types=1);
19+
20+
namespace LaravelJsonApi\Laravel\Console;
21+
22+
use Illuminate\Console\GeneratorCommand as BaseGeneratorCommand;
23+
use Symfony\Component\Console\Input\InputOption;
24+
25+
class MakeFilter extends BaseGeneratorCommand
26+
{
27+
28+
use Concerns\ResolvesStub;
29+
30+
/**
31+
* @var string
32+
*/
33+
protected $name = 'jsonapi:filter';
34+
35+
/**
36+
* @var string
37+
*/
38+
protected $description = 'Create a new JSON:API filter.';
39+
40+
/**
41+
* @var string
42+
*/
43+
protected $type = 'JSON:API filter';
44+
45+
/**
46+
* @inheritDoc
47+
*/
48+
protected function getStub()
49+
{
50+
return $this->resolveStubPath('filter.stub');
51+
}
52+
53+
/**
54+
* @inheritDoc
55+
*/
56+
protected function getDefaultNamespace($rootNamespace)
57+
{
58+
$jsonApi = trim(config('jsonapi.namespace') ?: 'JsonApi', '\\');
59+
60+
return $rootNamespace . '\\' . $jsonApi . '\\' . 'Filters';
61+
}
62+
63+
/**
64+
* Get the console command options.
65+
*
66+
* @return array
67+
*/
68+
protected function getOptions()
69+
{
70+
return [
71+
['force', null, InputOption::VALUE_NONE, 'Create the class even if the filter already exists'],
72+
];
73+
}
74+
75+
}

0 commit comments

Comments
 (0)