Skip to content

Commit 195189a

Browse files
fedorenkoalexfedorenkoalex
committed
feat(swagger_refactor): refactoring swagger parsing
feat(swagger_refactor): refactoring data components generation feat(swagger_refactor): removed project editing features (will return in future)
1 parent afffc10 commit 195189a

File tree

168 files changed

+6944
-13532
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

168 files changed

+6944
-13532
lines changed

‎README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,8 @@ The key features of the Onix Project Generator are:
7878
).
7979
* To **configure optional components** to include to the project.
8080
* To **add screen mocks** with screen BLoC, navigation and GetIt declarations included.
81-
* To **configure data layer** from Swagger URL or manually.
81+
* To **configure data layer** from Swagger URL.
8282
* To **configure the application theme** from Figma file.
83-
* To **edit settings** of a **previously created project**.
8483
* To **create Android signing** configuration automatically or manually.
8584
* To **add Sonar configurations and scripts**.
8685
* Generates **starter documentation** for the project.

‎bricks/flutter_clean_base/__brick__/{{project_name.snakeCase()}}/lib/core/arch/data/remote/clients/dio/dio_const.dart

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
class DioConst {
2+
//TODO: Specify Api client Base URL
3+
static const String defaultBaseUrl = 'https://host.todo';
4+
5+
static const String defaultApiClientName = 'DefaultApiClient';
6+
27
//{dio const end}
38
}

‎bricks/flutter_clean_base/__brick__/{{project_name.snakeCase()}}/lib/core/di/remote.dart

+12-2
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,22 @@ import 'package:{{project_name}}/core/arch/data/remote/clients/dio/dio_request_p
88
import 'package:{{project_name}}/core/arch/data/remote/clients/graph_ql/request_processor/graph_ql_request_processor.dart';
99
import 'package:{{project_name}}/core/arch/data/remote/clients/graph_ql/request_processor/graph_ql_request_processor_impl.dart';{{/graphql}}
1010
{{#firebase_auth}}import 'package:firebase_auth/firebase_auth.dart';{{/firebase_auth}}
11+
import 'package:{{project_name}}/core/arch/data/remote/clients/dio/api_client.dart';
12+
import 'package:{{project_name}}/core/arch/data/remote/clients/dio/dio_client_module.dart';
13+
import 'package:{{project_name}}/core/arch/data/remote/clients/dio/dio_const.dart';
14+
import 'package:{{project_name}}/core/arch/data/remote/clients/dio/dio_request_processor/dio_request_processor.dart';
1115
void registerRemote(GetIt getIt) {
1216
final dioClientModule = _DioClientModule();
1317

14-
getIt.registerLazySingleton<DioRequestProcessor>(
18+
getIt
19+
..registerLazySingleton<DioRequestProcessor>(
1520
dioClientModule.makeDioErrorHandler,
16-
);{{#firebase_auth}}
21+
)
22+
..registerLazySingleton<ApiClient>(
23+
() => dioClientModule.makeApiClient(DioConst.defaultBaseUrl),
24+
instanceName: DioConst.defaultApiClientName,
25+
);
26+
{{#firebase_auth}}
1727
getIt.registerLazySingleton<FirebaseAuth>(
1828
() => FirebaseAuth.instance,
1929
);{{/firebase_auth}}

‎docs/flows/FLOWS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This section **describing common processes in Onix Project Generator** applicati
1616
* **[Mason build steps](docs/MASON.md)**.
1717
* **[Mason pre-generation steps](docs/PRE_GEN.md)**.
1818
* **[Mason post-generation steps](docs/POST_GEN.md)**.
19-
* **[File generation](docs/FILE_GEN.md)**.
19+
* **[Swagger data components generation](docs/SWAGGER_GEN.md)**.
2020
* **[Documentation generation](docs/DOCS.md)**.
2121

2222

‎docs/flows/docs/FILE_GEN.md

-109
This file was deleted.

‎docs/flows/docs/SWAGGER_GEN.md

+170
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
<div align="center">
2+
<a href="https://onix-systems.com/">
3+
<img alt="refine logo" src="../../../images/banner_top.jpg">
4+
</a>
5+
6+
<br/>
7+
<br/>
8+
</div>
9+
10+
# Swagger data components generation
11+
12+
Swagger data components generation designed to create a data layer in the Generated project based on the Swagger JSON.
13+
14+
The data layer consist of data models, entities, mappers, sources and repositories.
15+
16+
The data components generation splited into two steps: parsing and generation.
17+
18+
## Parsing
19+
20+
When user enter Swagger URL in the UI and press the Continue button, components will be parsed.
21+
22+
Once Swagger JSON has fetched parsing starts in `swagger_remote_source.dart`. Components will be parsed depending on the Swagger version.
23+
24+
Each data model have corresponding to version parser function. (`fromJsonV2` and `fromJsonV3`).
25+
26+
General parsing flow looks like:
27+
28+
```mermaid
29+
flowchart TD
30+
A[Get Swagger JSON] --> B[Parse Swagger version];
31+
B --> C{Has tags in JSON?}
32+
C -->|Yes| D[Parse Swagger Tags]
33+
C -->|No| ERR[Return Empty Result]
34+
D --> E{Has Paths in JSON?}
35+
E -->|Yes| F{Check version}
36+
E -->|No| ERR[Return Empty Result]
37+
F -->|V2| G[Parse Paths with V2 parser]
38+
F -->|V3+| H[Parse Paths with V3 parser]
39+
F -->|Other version| ERR
40+
G ----> J{Check version}
41+
H ----> J
42+
J -->|V2| K{Has defintions in JSON?}
43+
J -->|V3| L{Has components in JSON?}
44+
K -->|Yes| M[Parse definitions with V2 parser]
45+
K -->|No| ERR
46+
L -->|Yes| N[Parse coomponents with V3 parser]
47+
L -->|No| ERR
48+
M ----> O[Return parsed result]
49+
N ----> O[Return parsed result]
50+
```
51+
52+
Once components are parsed they will be stored in `SwaggerRepository`.
53+
54+
## Generation
55+
56+
Generation step starts if components were parsed sucessfully and stored in `SwaggerRepository `.
57+
58+
Generation process begins in `ComponentGeneratorService` and consist wth 4 main generation steps:
59+
60+
* Create enums
61+
* Create data objects
62+
* Create entities
63+
* Create sources and repositories
64+
65+
```mermaid
66+
flowchart TD
67+
A[Begin] --> B[Create enums]
68+
B ----> C[Get components source item]
69+
C ----> L[Find data objects used in sources]
70+
L -----> D[Create data objects]
71+
D -----> E[Create entities for all created data objects]
72+
E -----> F[Create source and repo]
73+
F ----> G{Has next component source?}
74+
G -->|Yes| C
75+
G -->|No| J[End]
76+
```
77+
78+
### Create enums
79+
80+
81+
```mermaid
82+
flowchart TD
83+
A[Search for Enums in every component variable] --> B[Add to Enums to generate list];
84+
B ----> C[Get Enum item from list]
85+
C ----> D[Get Enum file path]
86+
D ----> E[Get Enum file body]
87+
E --> G{Enum file already exist?}
88+
G -->|Yes| J{Has next enum item?}
89+
G -->|No| F[Create Enum file]
90+
F ----> J
91+
J -->|Yes| C
92+
J -->|No| H[End]
93+
```
94+
95+
### Create data objects
96+
97+
```mermaid
98+
flowchart TD
99+
A[Start with input references] --> CYCLE[Get component reference item]
100+
CYCLE --> A1[Find reference data object]
101+
A1 ----> DO{Is data object not null?}
102+
DO -->|Yes| A2[Get object file path]
103+
DO -->|No| CYCLEEND
104+
A2 ----> A3[Create folders]
105+
A3 ----> A4[Get object file body]
106+
A4 ----> CF{Is fie exist?}
107+
CF -->|Yes| A5[Create object file]
108+
A5 ----> A6[Get Data object inner references]
109+
A6 ----> A7{Has inner references?}
110+
A7 -->|Yes| A
111+
A7 -->|No| CYCLEEND{Has next reference?}
112+
CF -->|No| CYCLEEND
113+
CYCLEEND -->|Yes| CYCLE
114+
CYCLEEND -->|No| END[End]
115+
```
116+
117+
### Create entities
118+
119+
```mermaid
120+
flowchart TD
121+
A[Start with created data objects] --> CYCLE[Get created object]
122+
CYCLE --> A1[Get entity folder]
123+
A1 ----> A2[Create entity folder]
124+
A2 ----> A3[Get entity file path]
125+
A3 ----> CF{Entity file exist?}
126+
CF -->|Yes| A5
127+
CF -->|No| A4[Create entity file]
128+
A4 --> A5[Get entity mapper folder]
129+
A5 ----> A6[Create entity mapper folder]
130+
A6 ----> A7[Get entity mapper file path]
131+
A7 ----> RR{Need mapper for Request or Response?}
132+
RR -->|Yes| CF2{Entity mapper file exist?}
133+
CF2 -->|Yes| CYCLEEND{Has next object?}
134+
CF2 -->|No| A8[Create entity mapper file]
135+
A8 ----> CYCLEEND
136+
CYCLEEND -->|Yes| CYCLE
137+
CYCLEEND -->|No| END[End]
138+
```
139+
140+
### Create sources and repositories
141+
142+
```mermaid
143+
flowchart TD
144+
A[Begin] --> A1[Get source folder path]
145+
A1 ----> A2[Create source folder]
146+
A2 ----> A3[Get source declaration file path]
147+
A3 ----> CF1{Source declaration file exist?}
148+
CF1 -->|Yes| A5
149+
CF1 -->|No| A4[Create source declaration file]
150+
A4 ----> A5[Get source impl file path]
151+
A5 ----> CF2{Source impl file exist?}
152+
CF2 -->|Yes| A7[Inject sources SL declarations]
153+
CF2 -->|No| A6[Create source impl file]
154+
A6 ----> A7
155+
A7 ----> A8[Get repo declaration folder]
156+
A8 ----> A9[Create repo declaration folder]
157+
A9 ----> A10[Get repo declaration file path]
158+
A10 ----> CF3{Repo declaration file exist?}
159+
CF3 -->|Yes| A12[Get repo impl folder]
160+
CF3 -->|No| A11[Create repo declaration file]
161+
A11 ----> A12
162+
A12 ----> A13[Create repo impl folder]
163+
A13 ----> A14[Get repo impl file path]
164+
A14 ----> CF4{Repo impl file exist?}
165+
CF4 -->|Yes| A16[Inject repos SL declarations]
166+
CF4 -->|No| A15[Create repo impl file]
167+
A15 ----> A16
168+
A16 ----> A17[End]
169+
```
170+

‎lib/app/swagger_const.dart

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
class SwaggerConst {
2+
static const swaggerSuccessCodes = [
3+
'200',
4+
];
5+
6+
static const swaggerTypeKey = 'type';
7+
static const swaggerTypeTitleKey = 'Type';
8+
static const swaggerResponseKey = 'response';
9+
static const swaggerRequestKey = 'request';
10+
static const swaggerResponseTitleKey = 'Response';
11+
static const swaggerRequestTitleKey = 'Request';
12+
static const swaggerPrimitives = ['string', 'integer', 'boolean', 'number'];
13+
static const swaggerSourceSLDeclarationKey = '//{sources end}';
14+
static const swaggerSLImportsKey = '//{imports end}';
15+
static const swaggerRepoSLDeclarationKey = '//{repositories end}';
16+
}

‎lib/app/util/enum/data_file_type.dart

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
enum DataFileType {
2+
request,
3+
response,
4+
entity,
5+
none,
6+
}

‎lib/app/util/enum/mapper_type.dart

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
enum MapperType {
2+
mapResponseToEntity,
3+
mapEntityToRequest
4+
5+
}

‎lib/app/util/enum/swagger_path_input_type.dart

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
enum SwaggerPathInputType {
2+
path,
3+
query,
4+
formData,
5+
body,
6+
header;
7+
8+
static SwaggerPathInputType fromString(String input) =>
9+
SwaggerPathInputType.values.firstWhere(
10+
(e) => e.name == input,
11+
);
12+
}

‎lib/app/util/enum/swagger_path_request_type.dart

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
enum SwaggerPathRequestType {
2+
get,
3+
post,
4+
put,
5+
delete,
6+
update;
7+
8+
static SwaggerPathRequestType fromString(String input) =>
9+
SwaggerPathRequestType.values.firstWhere(
10+
(e) => e.name == input,
11+
);
12+
}

0 commit comments

Comments
 (0)