Skip to content

Commit ef239ba

Browse files
arthurkushmanarthurkushman
committed
#189: Fix camel-case to underscored entities for tables, routes and docs + dbl underscore fix when _A replaced by __a
1 parent af1eb8f commit ef239ba

File tree

6 files changed

+76
-70
lines changed

6 files changed

+76
-70
lines changed

‎src/Blocks/Entities.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ class Entities extends FormRequestModel
2929
private $className;
3030

3131
protected $sourceCode = '';
32-
protected $localCode = '';
3332
protected $isSoftDelete = false;
3433

3534
public function __construct($generator)
@@ -269,7 +268,7 @@ private function setContent()
269268
);
270269
$this->createProperty(
271270
ModelsInterface::PROPERTY_TABLE, PhpInterface::PHP_MODIFIER_PROTECTED,
272-
strtolower($this->generator->objectName), true
271+
MigrationsHelper::getTableName($this->generator->objectName), true
273272
);
274273
$this->createProperty(
275274
ModelsInterface::PROPERTY_TIMESTAMPS, PhpInterface::PHP_MODIFIER_PUBLIC,

‎src/Blocks/RoutesTrait.php

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
use SoliDry\Controllers\BaseCommand;
66
use SoliDry\Extension\JSONApiInterface;
77
use SoliDry\Helpers\Classes;
8+
use SoliDry\Helpers\MigrationsHelper;
89
use SoliDry\Types\DefaultInterface;
910
use SoliDry\Types\DirsInterface;
1011
use SoliDry\Types\ModelsInterface;
@@ -133,7 +134,7 @@ private function composeObjectUri() : string
133134
*/
134135
private function composeBaseUri() : string
135136
{
136-
return PhpInterface::QUOTES . PhpInterface::SLASH . strtolower($this->generator->objectName);
137+
return PhpInterface::QUOTES . PhpInterface::SLASH . MigrationsHelper::getTableName($this->generator->objectName);
137138
}
138139

139140
/**
@@ -142,7 +143,7 @@ private function composeBaseUri() : string
142143
*/
143144
private function composeRelationsBaseUri() : string
144145
{
145-
return PhpInterface::QUOTES . PhpInterface::SLASH . strtolower($this->generator->objectName) .
146+
return PhpInterface::QUOTES . PhpInterface::SLASH . MigrationsHelper::getTableName($this->generator->objectName) .
146147
PhpInterface::SLASH . PhpInterface::OPEN_BRACE
147148
. ApiInterface::RAML_ID . PhpInterface::CLOSE_BRACE;
148149
}

‎src/Documentation/BulksDoc.php

+11-11
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
namespace SoliDry\Documentation;
44

55
use SoliDry\Extension\JSONApiInterface;
6+
use SoliDry\Helpers\Classes;
7+
use SoliDry\Helpers\MigrationsHelper;
68
use SoliDry\Types\DefaultInterface;
79
use SoliDry\Types\DocumentationInterface;
810
use SoliDry\Types\PhpInterface;
911

1012
trait BulksDoc
1113
{
12-
1314
/**
1415
* Sets OAS documentation for a bulk create method
1516
*/
@@ -18,13 +19,12 @@ private function setCreateBulk(): void
1819
$this->openComment();
1920

2021
$this->setStarredComment(DocumentationInterface::OA_POST . PhpInterface::OPEN_PARENTHESES);
21-
2222
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
23-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . 'bulk",', 1, 1);
23+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . 'bulk",', 1, 1);
2424

25-
$this->setStarredComment('summary="Create ' . $this->generator->objectName . ' bulk",', 1, 1);
25+
$this->setStarredComment('summary="Create ' . Classes::getClassName($this->generator->objectName) . ' bulk",', 1, 1);
2626

27-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
27+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
2828
. '"},', 1, 1);
2929

3030
$this->setResponse([
@@ -48,11 +48,11 @@ private function setUpdateBulk(): void
4848
$this->setStarredComment(DocumentationInterface::OA_PATCH . PhpInterface::OPEN_PARENTHESES);
4949

5050
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
51-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . 'bulk",', 1, 1);
51+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . 'bulk",', 1, 1);
5252

53-
$this->setStarredComment('summary="Update ' . $this->generator->objectName . ' bulk",', 1, 1);
53+
$this->setStarredComment('summary="Update ' . Classes::getClassName($this->generator->objectName) . ' bulk",', 1, 1);
5454

55-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
55+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
5656
. '"},', 1, 1);
5757

5858
$this->setResponse([
@@ -76,11 +76,11 @@ private function setDeleteBulk(): void
7676
$this->setStarredComment(DocumentationInterface::OA_DELETE . PhpInterface::OPEN_PARENTHESES);
7777

7878
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
79-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . 'bulk",', 1, 1);
79+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . 'bulk",', 1, 1);
8080

81-
$this->setStarredComment('summary="Delete ' . $this->generator->objectName . ' bulk",', 1, 1);
81+
$this->setStarredComment('summary="Delete ' . Classes::getClassName($this->generator->objectName) . ' bulk",', 1, 1);
8282

83-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
83+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
8484
. '"},', 1, 1);
8585

8686
$this->setResponse([

‎src/Documentation/Documentation.php

+39-39
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use SoliDry\Controllers\BaseCommand;
88
use SoliDry\Extension\JSONApiInterface;
99
use SoliDry\Helpers\Classes;
10+
use SoliDry\Helpers\MigrationsHelper;
1011
use SoliDry\Types\ApiInterface;
1112
use SoliDry\Types\DefaultInterface;
1213
use SoliDry\Types\DocumentationInterface;
@@ -21,7 +22,6 @@
2122
*/
2223
abstract class Documentation
2324
{
24-
2525
use ContentManager, RelationsDoc, BulksDoc;
2626

2727
public const SUCCESSFUL_OPERATION = 'successful operation';
@@ -179,58 +179,58 @@ private function setIndex(): void
179179
$this->setStarredComment(DocumentationInterface::OA_GET . PhpInterface::OPEN_PARENTHESES);
180180

181181
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
182-
. strtolower($this->generator->objectName) . '",', 1, 1);
182+
. MigrationsHelper::getTableName($this->generator->objectName) . '",', 1, 1);
183183

184-
$this->setStarredComment('summary="Get ' . $this->generator->objectName . 's ",', 1, 1);
184+
$this->setStarredComment('summary="Get ' . Classes::getClassName($this->generator->objectName) . 's ",', 1, 1);
185185

186-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
186+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
187187
. '"},', 1, 1);
188188

189189
// define params
190190
$this->setParameter([
191-
'in' => '"query"',
192-
'name' => '"include"',
191+
'in' => '"query"',
192+
'name' => '"include"',
193193
'required' => 'false',
194194
]);
195195

196196
$this->setParameter([
197-
'in' => '"query"',
198-
'name' => '"page"',
197+
'in' => '"query"',
198+
'name' => '"page"',
199199
'required' => 'false',
200200
], 'integer');
201201

202202
$this->setParameter([
203-
'in' => '"query"',
204-
'name' => '"limit"',
203+
'in' => '"query"',
204+
'name' => '"limit"',
205205
'required' => 'false',
206206
], 'integer');
207207

208208
$this->setParameter([
209-
'in' => '"query"',
210-
'name' => '"sort"',
209+
'in' => '"query"',
210+
'name' => '"sort"',
211211
'required' => 'false',
212212
]);
213213

214214
$this->setParameter([
215-
'in' => '"query"',
216-
'name' => '"data"',
215+
'in' => '"query"',
216+
'name' => '"data"',
217217
'required' => 'false',
218218
]);
219219

220220
$this->setParameter([
221-
'in' => '"query"',
222-
'name' => '"filter"',
221+
'in' => '"query"',
222+
'name' => '"filter"',
223223
'required' => 'false',
224224
]);
225225

226226
$this->setParameter([
227-
'in' => '"query"',
228-
'name' => '"order_by"',
227+
'in' => '"query"',
228+
'name' => '"order_by"',
229229
'required' => 'false',
230230
]);
231231

232232
$this->setResponse([
233-
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
233+
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
234234
'description' => '"' . self::SUCCESSFUL_OPERATION . '"',
235235
]);
236236

@@ -250,27 +250,27 @@ private function setView(): void
250250
$this->setStarredComment(DocumentationInterface::OA_GET . PhpInterface::OPEN_PARENTHESES);
251251

252252
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
253-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . '{id}",', 1, 1);
253+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}",', 1, 1);
254254

255-
$this->setStarredComment('summary="Get ' . $this->generator->objectName . '",', 1, 1);
255+
$this->setStarredComment('summary="Get ' . Classes::getClassName($this->generator->objectName) . '",', 1, 1);
256256

257-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
257+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
258258
. '"},', 1, 1);
259259

260260
$this->setParameter([
261-
'in' => '"query"',
262-
'name' => '"include"',
261+
'in' => '"query"',
262+
'name' => '"include"',
263263
'required' => 'false',
264264
]);
265265

266266
$this->setParameter([
267-
'in' => '"query"',
268-
'name' => '"data"',
267+
'in' => '"query"',
268+
'name' => '"data"',
269269
'required' => 'false',
270270
]);
271271

272272
$this->setResponse([
273-
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
273+
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
274274
'description' => '"' . self::SUCCESSFUL_OPERATION . '"',
275275
]);
276276

@@ -290,15 +290,15 @@ private function setCreate(): void
290290
$this->setStarredComment(DocumentationInterface::OA_POST . PhpInterface::OPEN_PARENTHESES);
291291

292292
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
293-
. strtolower($this->generator->objectName) . '",', 1, 1);
293+
. MigrationsHelper::getTableName($this->generator->objectName) . '",', 1, 1);
294294

295-
$this->setStarredComment('summary="Create ' . $this->generator->objectName . '",', 1, 1);
295+
$this->setStarredComment('summary="Create ' . Classes::getClassName($this->generator->objectName) . '",', 1, 1);
296296

297-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
297+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
298298
. '"},', 1, 1);
299299

300300
$this->setResponse([
301-
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_CREATED . '"',
301+
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_CREATED . '"',
302302
'description' => '"' . self::SUCCESSFUL_OPERATION . '"',
303303
]);
304304

@@ -318,15 +318,15 @@ private function setUpdate(): void
318318
$this->setStarredComment(DocumentationInterface::OA_PATCH . PhpInterface::OPEN_PARENTHESES);
319319

320320
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
321-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . '{id}",', 1, 1);
321+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}",', 1, 1);
322322

323-
$this->setStarredComment('summary="Update ' . $this->generator->objectName . '",', 1, 1);
323+
$this->setStarredComment('summary="Update ' . Classes::getClassName($this->generator->objectName) . '",', 1, 1);
324324

325-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
325+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
326326
. '"},', 1, 1);
327327

328328
$this->setResponse([
329-
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
329+
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
330330
'description' => '"' . self::SUCCESSFUL_OPERATION . '"',
331331
]);
332332

@@ -346,15 +346,15 @@ private function setDelete(): void
346346
$this->setStarredComment(DocumentationInterface::OA_DELETE . PhpInterface::OPEN_PARENTHESES);
347347

348348
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
349-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . '{id}",', 1, 1);
349+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}",', 1, 1);
350350

351-
$this->setStarredComment('summary="Delete ' . $this->generator->objectName . '",', 1, 1);
351+
$this->setStarredComment('summary="Delete ' . Classes::getClassName($this->generator->objectName) . '",', 1, 1);
352352

353-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
353+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
354354
. '"},', 1, 1);
355355

356356
$this->setResponse([
357-
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_NO_CONTENT . '"',
357+
'response' => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_NO_CONTENT . '"',
358358
'description' => '"' . self::SUCCESSFUL_OPERATION . '"',
359359
]);
360360

‎src/Documentation/RelationsDoc.php

+17-15
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
namespace SoliDry\Documentation;
44

55
use SoliDry\Extension\JSONApiInterface;
6+
use SoliDry\Helpers\Classes;
7+
use SoliDry\Helpers\MigrationsHelper;
68
use SoliDry\Types\DefaultInterface;
79
use SoliDry\Types\DocumentationInterface;
810
use SoliDry\Types\PhpInterface;
@@ -19,11 +21,11 @@ private function setRelated(): void
1921
$this->setStarredComment(DocumentationInterface::OA_GET . PhpInterface::OPEN_PARENTHESES);
2022

2123
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
22-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . '{id}/{related}",', 1, 1);
24+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/{related}",', 1, 1);
2325

24-
$this->setStarredComment('summary="Get ' . $this->generator->objectName . ' related objects",', 1, 1);
26+
$this->setStarredComment('summary="Get ' . Classes::getClassName($this->generator->objectName) . ' related objects",', 1, 1);
2527

26-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
28+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
2729
. '"},', 1, 1);
2830

2931
$this->setParameter([
@@ -65,11 +67,11 @@ private function setRelations(): void
6567
$this->setStarredComment(DocumentationInterface::OA_GET . PhpInterface::OPEN_PARENTHESES);
6668

6769
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
68-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);
70+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);
6971

70-
$this->setStarredComment('summary="Get ' . $this->generator->objectName . ' relations objects",', 1, 1);
72+
$this->setStarredComment('summary="Get ' . Classes::getClassName($this->generator->objectName) . ' relations objects",', 1, 1);
7173

72-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
74+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
7375
. '"},', 1, 1);
7476

7577
$this->setParameter([
@@ -111,11 +113,11 @@ private function setCreateRelation(): void
111113
$this->setStarredComment(DocumentationInterface::OA_POST . PhpInterface::OPEN_PARENTHESES);
112114

113115
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
114-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);
116+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);
115117

116-
$this->setStarredComment('summary="Create ' . $this->generator->objectName . ' relation object",', 1, 1);
118+
$this->setStarredComment('summary="Create ' . Classes::getClassName($this->generator->objectName) . ' relation object",', 1, 1);
117119

118-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
120+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
119121
. '"},', 1, 1);
120122

121123
$this->setParameter([
@@ -151,11 +153,11 @@ private function setUpdateRelation(): void
151153
$this->setStarredComment(DocumentationInterface::OA_PATCH . PhpInterface::OPEN_PARENTHESES);
152154

153155
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
154-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);
156+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);
155157

156-
$this->setStarredComment('summary="Update ' . $this->generator->objectName . ' relation object",', 1, 1);
158+
$this->setStarredComment('summary="Update ' . Classes::getClassName($this->generator->objectName) . ' relation object",', 1, 1);
157159

158-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
160+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
159161
. '"},', 1, 1);
160162

161163
$this->setParameter([
@@ -191,11 +193,11 @@ private function setDeleteRelation(): void
191193
$this->setStarredComment(DocumentationInterface::OA_DELETE . PhpInterface::OPEN_PARENTHESES);
192194

193195
$this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
194-
. strtolower($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);
196+
. MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);
195197

196-
$this->setStarredComment('summary="Delete ' . $this->generator->objectName . ' relation object",', 1, 1);
198+
$this->setStarredComment('summary="Delete ' . Classes::getClassName($this->generator->objectName) . ' relation object",', 1, 1);
197199

198-
$this->setStarredComment('tags={"' . $this->generator->objectName . DefaultInterface::CONTROLLER_POSTFIX
200+
$this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
199201
. '"},', 1, 1);
200202

201203
$this->setParameter([

0 commit comments

Comments
 (0)