r2-oas 0.1.3 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop_todo.yml +21 -0
  3. data/.travis.yml +3 -1
  4. data/CHANGELOG.md +15 -0
  5. data/GEMSPEC.md +23 -0
  6. data/Gemfile.lock +3 -1
  7. data/README.ja.md +2 -2
  8. data/README.md +2 -2
  9. data/docs/README.md +2 -2
  10. data/docs/index.html +1 -0
  11. data/docs/setting/configure.md +13 -0
  12. data/docs/usage/analyze_docs.md +14 -14
  13. data/docs/usage/deploy_docs.md +4 -4
  14. data/docs/usage/edit_docs.md +12 -12
  15. data/docs/usage/generate_docs.md +367 -211
  16. data/docs/usage/monitor_docs.md +16 -16
  17. data/docs/usage/use_hook_to_generate_docs.md +8 -8
  18. data/docs/usage/use_schema_namespace.md +30 -32
  19. data/docs/usage/use_tag_namespace.md +24 -26
  20. data/docs/usage/view_docs.md +16 -16
  21. data/lib/r2-oas.rb +1 -0
  22. data/lib/r2-oas/errors.rb +1 -0
  23. data/lib/r2-oas/lib/three-way-merge/twm.rb +83 -0
  24. data/lib/r2-oas/schema/builder.rb +23 -0
  25. data/lib/r2-oas/schema/generator.rb +1 -1
  26. data/lib/r2-oas/schema/manager/file_manager.rb +26 -0
  27. data/lib/r2-oas/schema/v3/analyzer/base_analyzer.rb +1 -6
  28. data/lib/r2-oas/schema/v3/builder.rb +28 -0
  29. data/lib/r2-oas/schema/v3/builder/base_builder.rb +60 -0
  30. data/lib/r2-oas/schema/v3/builder/doc_builder.rb +43 -0
  31. data/lib/r2-oas/schema/v3/generator.rb +1 -5
  32. data/lib/r2-oas/schema/v3/generator/base_generator.rb +30 -1
  33. data/lib/r2-oas/schema/v3/generator/components/object_generator.rb +6 -25
  34. data/lib/r2-oas/schema/v3/generator/components/request_body_generator.rb +6 -6
  35. data/lib/r2-oas/schema/v3/generator/doc_generator.rb +84 -19
  36. data/lib/r2-oas/schema/v3/generator/path_generator.rb +7 -19
  37. data/lib/r2-oas/schema/v3/generator/schema_generator.rb +5 -25
  38. data/lib/r2-oas/schema/v3/manager/file/base_file_manager.rb +3 -4
  39. data/lib/r2-oas/schema/v3/manager/pathname_manager.rb +6 -1
  40. data/lib/r2-oas/store.rb +118 -0
  41. data/lib/r2-oas/task_logging.rb +6 -0
  42. data/lib/r2-oas/tasks/main.rake +66 -73
  43. data/lib/r2-oas/tasks/tool.rake +25 -28
  44. data/lib/r2-oas/version.rb +1 -1
  45. data/r2-oas.gemspec +9 -2
  46. metadata +40 -6
data/docs/usage/monitor_docs.md CHANGED
@@ -145,9 +145,9 @@ If you use [Swagger Viewer](https://marketplace.visualstudio.com/items?itemName=
145
145
 
146
146
  ```
147
147
  I, [2019-06-29T00:52:29.568306 #16277] INFO -- : [R2-OAS] start
148
- I, [2019-06-29T00:52:29.857556 #16277] INFO -- : [Generate Swagger schema files] start
149
- I, [2019-06-29T00:52:29.857599 #16277] INFO -- : [Generate Swagger schema files] end
150
- I, [2019-06-29T00:52:29.857609 #16277] INFO -- : [Generate Swagger docs from schema files] start
148
+ I, [2019-06-29T00:52:29.857556 #16277] INFO -- : [Build OAS schema files] start
149
+ I, [2019-06-29T00:52:29.857599 #16277] INFO -- : [Build OAS schema files] end
150
+ I, [2019-06-29T00:52:29.857609 #16277] INFO -- : [Build OAS docs from schema files] start
151
151
  I, [2019-06-29T00:52:29.858201 #16277] INFO -- : Use schema file: oas_docs/src/openapi.yml
152
152
  I, [2019-06-29T00:52:29.859837 #16277] INFO -- : Use schema file: oas_docs/src/paths/user.yml
153
153
  I, [2019-06-29T00:52:29.861592 #16277] INFO -- : Use schema file: oas_docs/src/paths/api/v1/account_user_role.yml
@@ -173,7 +173,7 @@ I, [2019-06-29T00:52:29.879621 #16277] INFO -- : Use schema file: oas_docs/sr
173
173
  I, [2019-06-29T00:52:29.879767 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/post.yml
174
174
  I, [2019-06-29T00:52:29.879960 #16277] INFO -- : Use schema file: oas_docs/src/info.yml
175
175
  I, [2019-06-29T00:52:29.880072 #16277] INFO -- : Use schema file: oas_docs/src/servers.yml
176
- I, [2019-06-29T00:52:29.926654 #16277] INFO -- : [Generate Swagger docs from schema files] end
176
+ I, [2019-06-29T00:52:29.926654 #16277] INFO -- : [Build OAS docs from schema files] end
177
177
 
178
178
  wait for single trap ...
179
179
  ```
@@ -182,8 +182,8 @@ When you press `Ctrl + C` after edit schema ,
182
182
 
183
183
  ```
184
184
  ^C
185
- ^CI, [2019-06-29T00:55:38.492337 #16277] INFO -- : [Analyze Swagger file] start
186
- I, [2019-06-29T00:55:38.494113 #16277] INFO -- : [Analyze Swagger file (paths)] start
185
+ ^CI, [2019-06-29T00:55:38.492337 #16277] INFO -- : [Analyze OAS file] start
186
+ I, [2019-06-29T00:55:38.494113 #16277] INFO -- : [Analyze OAS file (paths)] start
187
187
  I, [2019-06-29T00:55:38.503677 #16277] INFO -- : Write schema file: oas_docs/src/paths/rails_admin/main.yml
188
188
  I, [2019-06-29T00:55:38.504894 #16277] INFO -- : Write schema file: oas_docs/src/paths/rails_admin/engine.yml
189
189
  I, [2019-06-29T00:55:38.509686 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v1/account_user_role.yml
@@ -195,12 +195,12 @@ I, [2019-06-29T00:55:38.548333 #16277] INFO -- : Write schema file: oas_docs
195
195
  I, [2019-06-29T00:55:38.552802 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v2/post.yml
196
196
  I, [2019-06-29T00:55:38.560056 #16277] INFO -- : Write schema file: oas_docs/src/paths/task.yml
197
197
  I, [2019-06-29T00:55:38.566850 #16277] INFO -- : Write schema file: oas_docs/src/paths/user.yml
198
- I, [2019-06-29T00:55:38.566886 #16277] INFO -- : [Analyze Swagger file (paths)] end
199
- I, [2019-06-29T00:55:38.567852 #16277] INFO -- : [Analyze Swagger file (tags)] start
198
+ I, [2019-06-29T00:55:38.566886 #16277] INFO -- : [Analyze OAS file (paths)] end
199
+ I, [2019-06-29T00:55:38.567852 #16277] INFO -- : [Analyze OAS file (tags)] start
200
200
  I, [2019-06-29T00:55:38.569655 #16277] INFO -- : Write schema file: oas_docs/src/tags.yml
201
- I, [2019-06-29T00:55:38.569691 #16277] INFO -- : [Analyze Swagger file (tags)] end
202
- I, [2019-06-29T00:55:38.569708 #16277] INFO -- : [Analyze Swagger file (components)] start
203
- I, [2019-06-29T00:55:38.569724 #16277] INFO -- : [Analyze Swagger file (components/schemas)] start
201
+ I, [2019-06-29T00:55:38.569691 #16277] INFO -- : [Analyze OAS file (tags)] end
202
+ I, [2019-06-29T00:55:38.569708 #16277] INFO -- : [Analyze OAS file (components)] start
203
+ I, [2019-06-29T00:55:38.569724 #16277] INFO -- : [Analyze OAS file (components/schemas)] start
204
204
  I, [2019-06-29T00:55:38.570894 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/account.yml
205
205
  I, [2019-06-29T00:55:38.571540 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/account_user_role.yml
206
206
  I, [2019-06-29T00:55:38.572217 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/custom_post.yml
@@ -210,10 +210,10 @@ I, [2019-06-29T00:55:38.574328 #16277] INFO -- : Write schema file: oas_docs
210
210
  I, [2019-06-29T00:55:38.575088 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/task.yml
211
211
  I, [2019-06-29T00:55:38.575687 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/user.yml
212
212
  I, [2019-06-29T00:55:38.576485 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/user/new/200/get.yml
213
- I, [2019-06-29T00:55:38.576518 #16277] INFO -- : [Analyze Swagger file (components/schemas)] end
214
- I, [2019-06-29T00:55:38.576535 #16277] INFO -- : [Analyze Swagger file (components/requestBodies)] start
215
- I, [2019-06-29T00:55:38.576852 #16277] INFO -- : [Analyze Swagger file (components/requestBodies)] end
216
- I, [2019-06-29T00:55:38.576867 #16277] INFO -- : [Analyze Swagger file (components)] end
217
- I, [2019-06-29T00:55:38.580873 #16277] INFO -- : [Analyze Swagger file] end
213
+ I, [2019-06-29T00:55:38.576518 #16277] INFO -- : [Analyze OAS file (components/schemas)] end
214
+ I, [2019-06-29T00:55:38.576535 #16277] INFO -- : [Analyze OAS file (components/requestBodies)] start
215
+ I, [2019-06-29T00:55:38.576852 #16277] INFO -- : [Analyze OAS file (components/requestBodies)] end
216
+ I, [2019-06-29T00:55:38.576867 #16277] INFO -- : [Analyze OAS file (components)] end
217
+ I, [2019-06-29T00:55:38.580873 #16277] INFO -- : [Analyze OAS file] end
218
218
  I, [2019-06-29T00:55:38.587586 #16277] INFO -- : [R2-OAS] end
219
219
  ```
data/docs/usage/use_hook_to_generate_docs.md CHANGED
@@ -137,13 +137,13 @@ show_in_app GET /:model_name/:id/show_in_app(.:format) rails_admin/main#
137
137
  ```
138
138
  $ bundle exec rake routes:oas:docs
139
139
  I, [2019-06-02T22:12:41.530676 #61323] INFO -- : [R2-OAS] start
140
- I, [2019-06-02T22:12:41.609492 #61323] INFO -- : [Generate Swagger schema files] start
140
+ I, [2019-06-02T22:12:41.609492 #61323] INFO -- : [Generate OAS schema files] start
141
141
  I, [2019-06-02T22:12:41.609574 #61323] INFO -- : <From routes data>
142
142
  I, [2019-06-02T22:12:41.609591 #61323] INFO -- : <Update schema files>
143
143
  I, [2019-06-02T22:12:41.611183 #61323] INFO -- : Write schema file: oas_docs/src/openapi.yml
144
144
  I, [2019-06-02T22:12:41.611676 #61323] INFO -- : Write schema file: oas_docs/src/info.yml
145
145
  I, [2019-06-02T22:12:41.612596 #61323] INFO -- : Write schema file: oas_docs/src/tags.yml
146
- I, [2019-06-02T22:12:41.612619 #61323] INFO -- : [Generate Swagger schema files (paths)] start
146
+ I, [2019-06-02T22:12:41.612619 #61323] INFO -- : [Generate OAS schema files (paths)] start
147
147
  I, [2019-06-02T22:12:41.612765 #61323] INFO -- : <From routes data>
148
148
  I, [2019-06-02T22:12:41.612782 #61323] INFO -- : <Update schema files (paths)>
149
149
  I, [2019-06-02T22:12:41.614701 #61323] INFO -- : Write schema file: oas_docs/src/paths/rails_admin/engine.yml
@@ -153,10 +153,10 @@ I, [2019-06-02T22:12:41.630184 #61323] INFO -- : Write schema file: oas_docs
153
153
  I, [2019-06-02T22:12:41.633369 #61323] INFO -- : Write schema file: oas_docs/src/paths/task.yml
154
154
  I, [2019-06-02T22:12:41.636323 #61323] INFO -- : Write schema file: oas_docs/src/paths/user.yml
155
155
  I, [2019-06-02T22:12:41.642353 #61323] INFO -- : Write schema file: oas_docs/src/paths/rails_admin/main.yml
156
- I, [2019-06-02T22:12:41.642381 #61323] INFO -- : [Generate Swagger schema files (paths)] end
156
+ I, [2019-06-02T22:12:41.642381 #61323] INFO -- : [Generate OAS schema files (paths)] end
157
157
  I, [2019-06-02T22:12:41.642664 #61323] INFO -- : Write schema file: oas_docs/src/externalDocs.yml
158
158
  I, [2019-06-02T22:12:41.642993 #61323] INFO -- : Write schema file: oas_docs/src/servers.yml
159
- I, [2019-06-02T22:12:41.643015 #61323] INFO -- : [Generate Swagger schema files (components)] start
159
+ I, [2019-06-02T22:12:41.643015 #61323] INFO -- : [Generate OAS schema files (components)] start
160
160
  I, [2019-06-02T22:12:41.643335 #61323] INFO -- : <From routes data>
161
161
  I, [2019-06-02T22:12:41.643421 #61323] INFO -- : <Update Components schema files (components/schemas)>
162
162
  I, [2019-06-02T22:12:41.645158 #61323] INFO -- : Write schema file: oas_docs/src/components/schemas/engine.yml
@@ -164,9 +164,9 @@ I, [2019-06-02T22:12:41.645613 #61323] INFO -- : Write schema file: oas_docs
164
164
  I, [2019-06-02T22:12:41.645987 #61323] INFO -- : Write schema file: oas_docs/src/components/schemas/task.yml
165
165
  I, [2019-06-02T22:12:41.646443 #61323] INFO -- : Write schema file: oas_docs/src/components/schemas/user.yml
166
166
  I, [2019-06-02T22:12:41.646833 #61323] INFO -- : Write schema file: oas_docs/src/components/schemas/main.yml
167
- I, [2019-06-02T22:12:41.646853 #61323] INFO -- : [Generate Swagger schema files (components)] end
168
- I, [2019-06-02T22:12:41.646865 #61323] INFO -- : [Generate Swagger schema files] end
169
- I, [2019-06-02T22:12:41.646874 #61323] INFO -- : [Generate Swagger docs from schema files] start
167
+ I, [2019-06-02T22:12:41.646853 #61323] INFO -- : [Generate OAS schema files (components)] end
168
+ I, [2019-06-02T22:12:41.646865 #61323] INFO -- : [Generate OAS schema files] end
169
+ I, [2019-06-02T22:12:41.646874 #61323] INFO -- : [Generate OAS docs from schema files] start
170
170
  I, [2019-06-02T22:12:41.647400 #61323] INFO -- : Use schema file: oas_docs/src/openapi.yml
171
171
  I, [2019-06-02T22:12:41.648404 #61323] INFO -- : Use schema file: oas_docs/src/paths/user.yml
172
172
  I, [2019-06-02T22:12:41.649983 #61323] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
@@ -184,7 +184,7 @@ I, [2019-06-02T22:12:41.660788 #61323] INFO -- : Use schema file: oas_docs/sr
184
184
  I, [2019-06-02T22:12:41.661004 #61323] INFO -- : Use schema file: oas_docs/src/components/schemas/post.yml
185
185
  I, [2019-06-02T22:12:41.661261 #61323] INFO -- : Use schema file: oas_docs/src/info.yml
186
186
  I, [2019-06-02T22:12:41.661520 #61323] INFO -- : Use schema file: oas_docs/src/servers.yml
187
- I, [2019-06-02T22:12:41.686435 #61323] INFO -- : [Generate Swagger docs from schema files] end
187
+ I, [2019-06-02T22:12:41.686435 #61323] INFO -- : [Generate OAS docs from schema files] end
188
188
  I, [2019-06-02T22:12:41.686477 #61323] INFO -- : [R2-OAS] end
189
189
  ```
190
190
 
data/docs/usage/use_schema_namespace.md CHANGED
@@ -95,37 +95,36 @@ Generate like this:
95
95
  ```
96
96
  oas_docs
97
97
  ├── schema
98
- │   ├── components
99
- │   │   └── schemas
100
- │   │   ├── api
101
- │   │   │   ├── v1
102
- │   │   │   │   ├── post.yml
103
- │   │   │   │   └── task.yml
104
- │   │   │   └── v2
105
- │   │   │   └── post.yml
106
- │   │   ├── rails_admin
107
- │   │   │   ├── engine.yml
108
- │   │   │   └── main.yml
109
- │   │   ├── task.yml
110
- │   │   └── user.yml
111
- │   ├── externalDocs.yml
112
- │   ├── info.yml
113
- │   ├── openapi.yml
114
- │   ├── paths
115
- │   │   ├── api
116
- │   │   │   ├── v1
117
- │   │   │   │   ├── post.yml
118
- │   │   │   │   └── task.yml
119
- │   │   │   └── v2
120
- │   │   │   └── post.yml
121
- │   │   ├── rails_admin
122
- │   │   │   ├── engine.yml
123
- │   │   │   └── main.yml
124
- │   │   ├── task.yml
125
- │   │   └── user.yml
126
- │   ├── servers.yml
127
- │   └── tags.yml
128
- └── oas_doc.yml
98
+    ├── components
99
+    │   └── schemas
100
+    │   ├── api
101
+    │   │   ├── v1
102
+    │   │   │   ├── post.yml
103
+    │   │   │   └── task.yml
104
+    │   │   └── v2
105
+    │   │   └── post.yml
106
+    │   ├── rails_admin
107
+    │   │   ├── engine.yml
108
+    │   │   └── main.yml
109
+    │   ├── task.yml
110
+    │   └── user.yml
111
+    ├── externalDocs.yml
112
+    ├── info.yml
113
+    ├── openapi.yml
114
+    ├── paths
115
+    │   ├── api
116
+    │   │   ├── v1
117
+    │   │   │   ├── post.yml
118
+    │   │   │   └── task.yml
119
+    │   │   └── v2
120
+    │   │   └── post.yml
121
+    │   ├── rails_admin
122
+    │   │   ├── engine.yml
123
+    │   │   └── main.yml
124
+    │   ├── task.yml
125
+    │   └── user.yml
126
+    ├── servers.yml
127
+    └── tags.yml
129
128
  ```
130
129
 
131
130
  ## Do not Use Tag Namespace
@@ -179,5 +178,4 @@ oas_docs
179
178
  │   │   └── user.yml
180
179
  │   ├── servers.yml
181
180
  │   └── tags.yml
182
- └── oas_doc.yml
183
181
  ```
data/docs/usage/use_tag_namespace.md CHANGED
@@ -125,7 +125,6 @@ oas_docs
125
125
  │   │   └── user.yml
126
126
  │   ├── servers.yml
127
127
  │   └── tags.yml
128
- └── oas_doc.yml
129
128
  ```
130
129
 
131
130
  # Do not Use Tag Namespace
@@ -154,29 +153,28 @@ Generate like this:
154
153
  ```
155
154
  oas_docs
156
155
  ├── schema
157
- │   ├── components
158
- │   │   └── schemas
159
- │   │   ├── api
160
- │   │   │   ├── v1
161
- │   │   │   │   ├── post.yml
162
- │   │   │   │   └── task.yml
163
- │   │   │   └── v2
164
- │   │   │   └── post.yml
165
- │   │   ├── rails_admin
166
- │   │   │   ├── engine.yml
167
- │   │   │   └── main.yml
168
- │   │   ├── task.yml
169
- │   │   └── user.yml
170
- │   ├── externalDocs.yml
171
- │   ├── info.yml
172
- │   ├── openapi.yml
173
- │   ├── paths
174
- │   │   ├── engine.yml
175
- │   │   ├── main.yml
176
- │   │   ├── post.yml
177
- │   │   ├── task.yml
178
- │   │   └── user.yml
179
- │   ├── servers.yml
180
- │   └── tags.yml
181
- └── oas_doc.yml
156
+    ├── components
157
+    │   └── schemas
158
+    │   ├── api
159
+    │   │   ├── v1
160
+    │   │   │   ├── post.yml
161
+    │   │   │   └── task.yml
162
+    │   │   └── v2
163
+    │   │   └── post.yml
164
+    │   ├── rails_admin
165
+    │   │   ├── engine.yml
166
+    │   │   └── main.yml
167
+    │   ├── task.yml
168
+    │   └── user.yml
169
+    ├── externalDocs.yml
170
+    ├── info.yml
171
+    ├── openapi.yml
172
+    ├── paths
173
+    │   ├── engine.yml
174
+    │   ├── main.yml
175
+    │   ├── post.yml
176
+    │   ├── task.yml
177
+    │   └── user.yml
178
+    ├── servers.yml
179
+    └── tags.yml
182
180
  ```
data/docs/usage/view_docs.md CHANGED
@@ -87,7 +87,7 @@ The ui starts up with the schema set.
87
87
  ```
88
88
  I, [2019-04-29T12:53:03.010443 #10516] INFO -- : [R2-OAS] start
89
89
  I, [2019-04-29T12:53:03.010557 #10516] INFO -- : [R2-OAS] start
90
- I, [2019-04-29T12:53:03.133380 #10516] INFO -- : [Generate Swagger schema files] start
90
+ I, [2019-04-29T12:53:03.133380 #10516] INFO -- : [Build OAS schema files] start
91
91
  I, [2019-04-29T12:53:03.133776 #10516] INFO -- : <From schema files>
92
92
  I, [2019-04-29T12:53:03.135212 #10516] INFO -- : Fetch schema file: oas_docs/src/openapi.yml
93
93
  I, [2019-04-29T12:53:03.136340 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/user.yml
@@ -112,7 +112,7 @@ I, [2019-04-29T12:53:03.145597 #10516] INFO -- : <Update schema files>
112
112
  I, [2019-04-29T12:53:03.146179 #10516] INFO -- : Merge schema file: oas_docs/src/openapi.yml
113
113
  I, [2019-04-29T12:53:03.146613 #10516] INFO -- : Merge schema file: oas_docs/src/info.yml
114
114
  I, [2019-04-29T12:53:03.147470 #10516] INFO -- : Merge schema file: oas_docs/src/tags.yml
115
- I, [2019-04-29T12:53:03.147492 #10516] INFO -- : [Generate Swagger schema files (paths)] start
115
+ I, [2019-04-29T12:53:03.147492 #10516] INFO -- : [Build OAS schema files (paths)] start
116
116
  I, [2019-04-29T12:53:03.183824 #10516] INFO -- : <From schema files>
117
117
  I, [2019-04-29T12:53:03.184629 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/user.yml
118
118
  I, [2019-04-29T12:53:03.185143 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
@@ -129,10 +129,10 @@ I, [2019-04-29T12:53:03.193803 #10516] INFO -- : Merge schema file: oas_docs
129
129
  I, [2019-04-29T12:53:03.195408 #10516] INFO -- : Merge schema file: oas_docs/src/paths/task.yml
130
130
  I, [2019-04-29T12:53:03.196820 #10516] INFO -- : Merge schema file: oas_docs/src/paths/user.yml
131
131
  I, [2019-04-29T12:53:03.199474 #10516] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/main.yml
132
- I, [2019-04-29T12:53:03.199496 #10516] INFO -- : [Generate Swagger schema files (paths)] end
132
+ I, [2019-04-29T12:53:03.199496 #10516] INFO -- : [Build OAS schema files (paths)] end
133
133
  I, [2019-04-29T12:53:03.199768 #10516] INFO -- : Merge schema file: oas_docs/src/externalDocs.yml
134
134
  I, [2019-04-29T12:53:03.200231 #10516] INFO -- : Merge schema file: oas_docs/src/servers.yml
135
- I, [2019-04-29T12:53:03.200257 #10516] INFO -- : [Generate Swagger schema files (components)] start
135
+ I, [2019-04-29T12:53:03.200257 #10516] INFO -- : [Build OAS schema files (components)] start
136
136
  I, [2019-04-29T12:53:03.268381 #10516] INFO -- : <From schema files>
137
137
  I, [2019-04-29T12:53:03.268772 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/user.yml
138
138
  I, [2019-04-29T12:53:03.268969 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/api/v1/task.yml
@@ -149,9 +149,9 @@ I, [2019-04-29T12:53:03.272166 #10516] INFO -- : Merge schema file: oas_docs
149
149
  I, [2019-04-29T12:53:03.272620 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/task.yml
150
150
  I, [2019-04-29T12:53:03.273053 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/user.yml
151
151
  I, [2019-04-29T12:53:03.273541 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/rails_admin/main.yml
152
- I, [2019-04-29T12:53:03.273562 #10516] INFO -- : [Generate Swagger schema files (components)] end
153
- I, [2019-04-29T12:53:03.273574 #10516] INFO -- : [Generate Swagger schema files] end
154
- I, [2019-04-29T12:53:03.273584 #10516] INFO -- : [Generate Swagger docs from schema files] start
152
+ I, [2019-04-29T12:53:03.273562 #10516] INFO -- : [Build OAS schema files (components)] end
153
+ I, [2019-04-29T12:53:03.273574 #10516] INFO -- : [Build OAS schema files] end
154
+ I, [2019-04-29T12:53:03.273584 #10516] INFO -- : [Build OAS docs from schema files] start
155
155
  I, [2019-04-29T12:53:03.274133 #10516] INFO -- : Use schema file: oas_docs/src/openapi.yml
156
156
  I, [2019-04-29T12:53:03.274566 #10516] INFO -- : Use schema file: oas_docs/src/paths/user.yml
157
157
  I, [2019-04-29T12:53:03.275000 #10516] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
@@ -171,7 +171,7 @@ I, [2019-04-29T12:53:03.279759 #10516] INFO -- : Use schema file: oas_docs/sr
171
171
  I, [2019-04-29T12:53:03.279935 #10516] INFO -- : Use schema file: oas_docs/src/components/schemas/rails_admin/main.yml
172
172
  I, [2019-04-29T12:53:03.280107 #10516] INFO -- : Use schema file: oas_docs/src/info.yml
173
173
  I, [2019-04-29T12:53:03.280223 #10516] INFO -- : Use schema file: oas_docs/src/servers.yml
174
- I, [2019-04-29T12:53:03.301656 #10516] INFO -- : [Generate Swagger docs from schema files] end
174
+ I, [2019-04-29T12:53:03.301656 #10516] INFO -- : [Build OAS docs from schema files] end
175
175
  I, [2019-04-29T12:53:03.301698 #10516] INFO -- : [R2-OAS] end
176
176
 
177
177
  wait for single trap ...
@@ -199,7 +199,7 @@ $ PATHS_FILE="../oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:
199
199
  ```
200
200
  I, [2019-04-29T12:55:15.434226 #10698] INFO -- : [R2-OAS] start
201
201
  I, [2019-04-29T12:55:15.434334 #10698] INFO -- : [R2-OAS] start
202
- I, [2019-04-29T12:55:15.550674 #10698] INFO -- : [Generate Swagger schema files] start
202
+ I, [2019-04-29T12:55:15.550674 #10698] INFO -- : [Build OAS schema files] start
203
203
  I, [2019-04-29T12:55:15.551016 #10698] INFO -- : <From schema files>
204
204
  I, [2019-04-29T12:55:15.551724 #10698] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
205
205
  I, [2019-04-29T12:55:15.551870 #10698] INFO -- : Fetch schema file: oas_docs/src/components/schemas/api/v1/task.yml
@@ -212,7 +212,7 @@ I, [2019-04-29T12:55:15.553144 #10698] INFO -- : <Update schema files>
212
212
  I, [2019-04-29T12:55:15.553650 #10698] INFO -- : Merge schema file: oas_docs/src/openapi.yml
213
213
  I, [2019-04-29T12:55:15.554101 #10698] INFO -- : Merge schema file: oas_docs/src/info.yml
214
214
  I, [2019-04-29T12:55:15.555634 #10698] INFO -- : Merge schema file: oas_docs/src/tags.yml
215
- I, [2019-04-29T12:55:15.555714 #10698] INFO -- : [Generate Swagger schema files (paths)] start
215
+ I, [2019-04-29T12:55:15.555714 #10698] INFO -- : [Build OAS schema files (paths)] start
216
216
  I, [2019-04-29T12:55:15.589466 #10698] INFO -- : <From schema files>
217
217
  I, [2019-04-29T12:55:15.590112 #10698] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
218
218
  I, [2019-04-29T12:55:15.590216 #10698] INFO -- : <Update schema files (paths)>
@@ -223,10 +223,10 @@ I, [2019-04-29T12:55:15.596491 #10698] INFO -- : Merge schema file: oas_docs
223
223
  I, [2019-04-29T12:55:15.598158 #10698] INFO -- : Merge schema file: oas_docs/src/paths/task.yml
224
224
  I, [2019-04-29T12:55:15.599531 #10698] INFO -- : Merge schema file: oas_docs/src/paths/user.yml
225
225
  I, [2019-04-29T12:55:15.602490 #10698] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/main.yml
226
- I, [2019-04-29T12:55:15.602516 #10698] INFO -- : [Generate Swagger schema files (paths)] end
226
+ I, [2019-04-29T12:55:15.602516 #10698] INFO -- : [Build OAS schema files (paths)] end
227
227
  I, [2019-04-29T12:55:15.602822 #10698] INFO -- : Merge schema file: oas_docs/src/externalDocs.yml
228
228
  I, [2019-04-29T12:55:15.603159 #10698] INFO -- : Merge schema file: oas_docs/src/servers.yml
229
- I, [2019-04-29T12:55:15.603181 #10698] INFO -- : [Generate Swagger schema files (components)] start
229
+ I, [2019-04-29T12:55:15.603181 #10698] INFO -- : [Build OAS schema files (components)] start
230
230
  I, [2019-04-29T12:55:15.669796 #10698] INFO -- : <From schema files>
231
231
  I, [2019-04-29T12:55:15.670091 #10698] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/api/v1/task.yml
232
232
  I, [2019-04-29T12:55:15.670122 #10698] INFO -- : <Update Components schema files (components/schemas)>
@@ -237,9 +237,9 @@ I, [2019-04-29T12:55:15.672328 #10698] INFO -- : Merge schema file: oas_docs
237
237
  I, [2019-04-29T12:55:15.672745 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/task.yml
238
238
  I, [2019-04-29T12:55:15.673160 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/user.yml
239
239
  I, [2019-04-29T12:55:15.673729 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/rails_admin/main.yml
240
- I, [2019-04-29T12:55:15.673771 #10698] INFO -- : [Generate Swagger schema files (components)] end
241
- I, [2019-04-29T12:55:15.673785 #10698] INFO -- : [Generate Swagger schema files] end
242
- I, [2019-04-29T12:55:15.673830 #10698] INFO -- : [Generate Swagger docs from schema files] start
240
+ I, [2019-04-29T12:55:15.673771 #10698] INFO -- : [Build OAS schema files (components)] end
241
+ I, [2019-04-29T12:55:15.673785 #10698] INFO -- : [Build OAS schema files] end
242
+ I, [2019-04-29T12:55:15.673830 #10698] INFO -- : [Build OAS docs from schema files] start
243
243
  I, [2019-04-29T12:55:15.674608 #10698] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
244
244
  I, [2019-04-29T12:55:15.674796 #10698] INFO -- : Use schema file: oas_docs/src/components/schemas/api/v1/task.yml
245
245
  I, [2019-04-29T12:55:15.675010 #10698] INFO -- : Use schema file: oas_docs/src/openapi.yml
@@ -247,7 +247,7 @@ I, [2019-04-29T12:55:15.675144 #10698] INFO -- : Use schema file: oas_docs/sr
247
247
  I, [2019-04-29T12:55:15.675523 #10698] INFO -- : Use schema file: oas_docs/src/tags.yml
248
248
  I, [2019-04-29T12:55:15.675700 #10698] INFO -- : Use schema file: oas_docs/src/info.yml
249
249
  I, [2019-04-29T12:55:15.675817 #10698] INFO -- : Use schema file: oas_docs/src/servers.yml
250
- I, [2019-04-29T12:55:15.679925 #10698] INFO -- : [Generate Swagger docs from schema files] end
250
+ I, [2019-04-29T12:55:15.679925 #10698] INFO -- : [Build OAS docs from schema files] end
251
251
  I, [2019-04-29T12:55:15.679950 #10698] INFO -- : [R2-OAS] end
252
252
 
253
253
  wait for single trap ...
data/lib/r2-oas.rb CHANGED
@@ -26,6 +26,7 @@ module R2OAS
26
26
 
27
27
  autoload :Base, 'r2-oas/schema/base'
28
28
  autoload :Generator, 'r2-oas/schema/generator'
29
+ autoload :Builder, 'r2-oas/schema/builder'
29
30
  autoload :Analyzer, 'r2-oas/schema/analyzer'
30
31
  autoload :Squeezer, 'r2-oas/schema/squeezer'
31
32
  autoload :Cleaner, 'r2-oas/schema/cleaner'
data/lib/r2-oas/errors.rb CHANGED
@@ -4,4 +4,5 @@ module R2OAS
4
4
  class NoImplementError < StandardError; end
5
5
  class NoFileExistsError < StandardError; end
6
6
  class NoSupportError < StandardError; end
7
+ class ChecksumError < StandardError; end
7
8
  end
data/lib/r2-oas/lib/three-way-merge/twm.rb ADDED
@@ -0,0 +1,83 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'key_flatten'
4
+
5
+ # rubocop:disable all
6
+ module Twm
7
+ class << self
8
+ #
9
+ # orig: local docs
10
+ # left: generate docs
11
+ # right: local src files
12
+ #
13
+ # condition: merge right into left
14
+ def yaml_merge(left, orig, right)
15
+ flat_orig = KeyFlatten.key_flatten(orig || {}).to_h
16
+ flat_left = KeyFlatten.key_flatten(left || {}).to_h
17
+ flat_right = KeyFlatten.key_flatten(right || {}).to_h
18
+
19
+ all_keys = (flat_left.keys + flat_orig.keys + flat_right.keys).uniq
20
+
21
+ twm = all_keys.each_with_object({}) do |key, result|
22
+ r = three_equal?(flat_left[key], flat_orig[key], flat_right[key])
23
+
24
+ if r[:left_orig] && r[:orig_right] && r[:left_right]
25
+ # no change
26
+ result[key] = flat_orig[key]
27
+ elsif r[:left_orig] && !r[:orig_right] && !r[:left_right]
28
+ # edited
29
+ result[key] = flat_right[key]
30
+ elsif !r[:left_orig] && r[:orig_right] && !r[:left_right]
31
+ # generate
32
+ result[key] = flat_left[key]
33
+ elsif !r[:left_orig] && !r[:orig_right] && r[:left_right]
34
+ # edited
35
+ result[key] = flat_right[key]
36
+ elsif !r[:left_orig] && !r[:orig_right] && !r[:left_right]
37
+ # conflict => prioritize edited
38
+ result[key] = flat_right[key]
39
+ end
40
+ end
41
+
42
+ twm = twm.delete_if { |_k, v| v.nil? }
43
+ KeyFlatten.key_unflatten(twm)
44
+ end
45
+
46
+ private
47
+
48
+ def three_equal?(left, orig, right)
49
+ if left == orig && orig == right
50
+ {
51
+ left_orig: true,
52
+ orig_right: true,
53
+ left_right: true
54
+ }
55
+ elsif left == orig && orig != right
56
+ {
57
+ left_orig: true,
58
+ orig_right: false,
59
+ left_right: false
60
+ }
61
+ elsif left != orig && orig == right
62
+ {
63
+ left_orig: false,
64
+ orig_right: true,
65
+ left_right: false
66
+ }
67
+ elsif left != orig && orig != right && left == right
68
+ {
69
+ left_orig: false,
70
+ orig_right: false,
71
+ left_right: true
72
+ }
73
+ elsif left != orig && orig != right && left != right
74
+ {
75
+ left_orig: false,
76
+ orig_right: false,
77
+ left_right: false
78
+ }
79
+ end
80
+ end
81
+ end
82
+ end
83
+ # rubocop:enable all