RubyGems - r2-oas - Versions diffs - 0.2.0 → 0.3.4 - Mend

r2-oas 0.2.0 → 0.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (64) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +41 -0
data/GEMSPEC.md +19 -22
data/README.ja.md +61 -0
data/README.md +60 -0
data/lib/r2-oas.rb +2 -4
data/lib/r2-oas/app_configuration.rb +1 -1
data/lib/r2-oas/deploy/client.rb +33 -6
data/lib/r2-oas/lib/core_ext/hash/deep_merge.rb +44 -0
data/lib/r2-oas/lib/core_ext/object/blank.rb +135 -0
data/lib/r2-oas/schema/editor.rb +13 -2
data/lib/r2-oas/schema/ui.rb +0 -1
data/lib/r2-oas/task_logging.rb +0 -4
data/lib/r2-oas/tasks/common.rake +0 -1
data/lib/r2-oas/tasks/tool.rake +9 -2
data/lib/r2-oas/version.rb +1 -1
data/r2-oas.gemspec +12 -13
metadata +61 -78
data/.github/ISSUE_TEMPLATE.md +0 -12
data/.github/PULL_REQUEST_TEMPLATE.md +0 -12
data/.gitignore +0 -12
data/.rspec +0 -3
data/.rubocop.yml +0 -7
data/.rubocop_todo.yml +0 -249
data/.travis.yml +0 -24
data/CODE_OF_CONDUCT.md +0 -74
data/Gemfile +0 -12
data/Gemfile.lock +0 -224
data/Rakefile +0 -8
data/bin/console +0 -12
data/bin/setup +0 -8
data/docs/.nojekyll +0 -0
data/docs/README.md +0 -173
data/docs/_sidebar.md +0 -23
data/docs/attention/if_clash.md +0 -19
data/docs/index.html +0 -29
data/docs/schema/3.0.0.md +0 -155
data/docs/setting/COC.md +0 -14
data/docs/setting/CORS.md +0 -22
data/docs/setting/configure.md +0 -176
data/docs/usage/analyze_docs.md +0 -875
data/docs/usage/clean_docs.md +0 -19
data/docs/usage/deploy_docs.md +0 -839
data/docs/usage/display_paths_list.md +0 -35
data/docs/usage/display_paths_stats.md +0 -54
data/docs/usage/edit_docs.md +0 -218
data/docs/usage/generate_docs.md +0 -412
data/docs/usage/monitor_docs.md +0 -219
data/docs/usage/use_hook_methods.md +0 -236
data/docs/usage/use_hook_to_generate_docs.md +0 -235
data/docs/usage/use_schema_namespace.md +0 -181
data/docs/usage/use_tag_namespace.md +0 -180
data/docs/usage/view_docs.md +0 -262
data/lib/r2-oas/deploy/swagger-ui/dist/favicon-16x16.png +0 -0
data/lib/r2-oas/deploy/swagger-ui/dist/favicon-32x32.png +0 -0
data/lib/r2-oas/deploy/swagger-ui/dist/oauth2-redirect.html +0 -68
data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-bundle.js +0 -134
data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-bundle.js.map +0 -1
data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-standalone-preset.js +0 -22
data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-standalone-preset.js.map +0 -1
data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.css +0 -4
data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.css.map +0 -1
data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.js +0 -9
data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.js.map +0 -1

data/docs/usage/clean_docs.md DELETED

@@ -1,19 +0,0 @@
-# Clean docs
-Delete `components/schemas` and `components/requestBodies` files not in use.
-## Prepare
-Add this line to your application's Gemfile:
-```ruby
-group :development do
-  gem 'r2-oas'
-end
-```
-## Command
-```bash
-$ bundle exec rake routes:oas:clean
-```

data/docs/usage/deploy_docs.md DELETED

@@ -1,839 +0,0 @@
-# Deploy docs
-## Prepare
-Add this line to your application's Gemfile:
-```ruby
-group :development do
-  gem 'r2-oas'
-end
-```
-## Command
-```bash
-$ bundle exec rake routes:oas:deploy
-```
-## Example
-if there is `oas_doc.yml` like this:
-<details>
-```yaml
----
-openapi: 3.0.0
-paths:
-  "/users":
-    post:
-      tags:
-      - user
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: user description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/User"
-      deprecated: false
-  "/users/new":
-    get:
-      tags:
-      - user
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: user description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/User"
-      deprecated: false
-  "/users/:id/edit":
-    get:
-      tags:
-      - user
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: user description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/User"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/users/:id":
-    delete:
-      tags:
-      - user
-      summary: delete summary
-      description: delete description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: user description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/User"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/api/v1/tasks":
-    post:
-      tags:
-      - api/v1/task
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: api/v1/task description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Task"
-      deprecated: false
-  "/api/v1/tasks/new":
-    get:
-      tags:
-      - api/v1/task
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: api/v1/task description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Task"
-      deprecated: false
-  "/api/v1/tasks/:id/edit":
-    get:
-      tags:
-      - api/v1/task
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: api/v1/task description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Task"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/api/v1/tasks/:id":
-    delete:
-      tags:
-      - api/v1/task
-      summary: delete summary
-      description: delete description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: api/v1/task description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Task"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/api/v1/posts":
-    post:
-      tags:
-      - api/v1/post
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: api/v1/post description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Post"
-      deprecated: false
-  "/api/v1/posts/new":
-    get:
-      tags:
-      - api/v1/post
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: api/v1/post description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Post"
-      deprecated: false
-  "/api/v1/posts/:id/edit":
-    get:
-      tags:
-      - api/v1/post
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: api/v1/post description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Post"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/api/v1/posts/:id":
-    delete:
-      tags:
-      - api/v1/post
-      summary: delete summary
-      description: delete description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: api/v1/post description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Post"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/api/v2/posts":
-    post:
-      tags:
-      - api/v2/post
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: responses description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Post"
-      deprecated: false
-  "/api/v2/posts/new":
-    get:
-      tags:
-      - api/v2/post
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: responses description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Post"
-      deprecated: false
-  "/api/v2/posts/:id/edit":
-    get:
-      tags:
-      - api/v2/post
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: responses description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Post"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/api/v2/posts/:id":
-    delete:
-      tags:
-      - api/v2/post
-      summary: delete summary
-      description: delete description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: responses description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Post"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/tasks":
-    post:
-      tags:
-      - task
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: task description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Task"
-      deprecated: false
-  "/tasks/new":
-    get:
-      tags:
-      - task
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: task description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Task"
-      deprecated: false
-  "/tasks/:id/edit":
-    get:
-      tags:
-      - task
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: task description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Task"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/tasks/:id":
-    delete:
-      tags:
-      - task
-      summary: delete summary
-      description: delete description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: task description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Task"
-      deprecated: false
-      parameters:
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/subadmin":
-    get:
-      tags:
-      - rails_admin/engine
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/engine description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Engine"
-      deprecated: false
-  "/admin":
-    get:
-      tags:
-      - rails_admin/engine
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/engine description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Engine"
-      deprecated: false
-  "/":
-    get:
-      tags:
-      - rails_admin/main
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-  "/:model_name":
-    post:
-      tags:
-      - rails_admin/main
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-  "/:model_name/new":
-    post:
-      tags:
-      - rails_admin/main
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-  "/:model_name/export":
-    post:
-      tags:
-      - rails_admin/main
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-  "/:model_name/bulk_delete":
-    delete:
-      tags:
-      - rails_admin/main
-      summary: delete summary
-      description: delete description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-  "/:model_name/bulk_action":
-    post:
-      tags:
-      - rails_admin/main
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-  "/:model_name/:id":
-    get:
-      tags:
-      - rails_admin/main
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/:model_name/:id/edit":
-    put:
-      tags:
-      - rails_admin/main
-      summary: put summary
-      description: put description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/:model_name/:id/delete":
-    delete:
-      tags:
-      - rails_admin/main
-      summary: delete summary
-      description: delete description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-  "/:model_name/:id/show_in_app":
-    get:
-      tags:
-      - rails_admin/main
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-externalDocs:
-  description: ''
-  url: ''
-tags:
-- name: rails_admin/engine
-  description: rails_admin/engine description
-  externalDocs:
-    description: description
-    url: url
-- name: api/v2/post
-  description: api/v2/post description
-  externalDocs:
-    description: description
-    url: url
-- name: api/v1/post
-  description: api/v1/post description
-  externalDocs:
-    description: description
-    url: url
-- name: api/v1/task
-  description: api/v1/task description
-  externalDocs:
-    description: description
-    url: url
-- name: task
-  description: task description
-  externalDocs:
-    description: description
-    url: url
-- name: user
-  description: user description
-  externalDocs:
-    description: description
-    url: url
-- name: rails_admin/main
-  description: rails_admin/main description
-  externalDocs:
-    description: description
-    url: url
-components:
-  schemas:
-    User:
-      type: object
-      properties:
-        id:
-          type: integer
-          format: int64
-    Task:
-      type: object
-      properties:
-        id:
-          type: integer
-          format: int64
-    Engine:
-      type: object
-      properties:
-        id:
-          type: integer
-          format: int64
-    Main:
-      type: object
-      properties:
-        id:
-          type: integer
-          format: int64
-    Post:
-      type: object
-      properties:
-        id:
-          type: integer
-          format: int64
-info:
-  title: Swagger API Document Title
-  description: |-
-    This is a sample server Petstore server.  You can find out more about
-                Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net,
-                #swagger](http://swagger.io/irc/).  For this sample, you can use the api key
-                `special-key` to test the authorization filters.
-  termsOfService: http://swagger.io/terms/
-  contact:
-    name: ''
-    url: ''
-  license:
-    name: ''
-    url: ''
-  version: 1.0.0
-servers:
-- url: http://localhost:3000
-  description: localhost
-```
-</details>
-```
-$ be rake routes:oas:deploy
-I, [2019-05-06T19:32:52.014417 #22431]  INFO -- : [R2-OAS] start
-I, [2019-05-06T19:32:52.075691 #22431]  INFO -- : [Build OAS schema files] start
-I, [2019-05-06T19:32:52.075731 #22431]  INFO -- : [Build OAS schema files] end
-I, [2019-05-06T19:32:52.075743 #22431]  INFO -- : [Build OAS docs from schema files] start
-I, [2019-05-06T19:32:52.079267 #22431]  INFO -- :  Use schema file: 	oas_docs/src/openapi.yml
-I, [2019-05-06T19:32:52.080334 #22431]  INFO -- :  Use schema file: 	oas_docs/src/paths/user.yml
-I, [2019-05-06T19:32:52.081189 #22431]  INFO -- :  Use schema file: 	oas_docs/src/paths/api/v1/task.yml
-I, [2019-05-06T19:32:52.081944 #22431]  INFO -- :  Use schema file: 	oas_docs/src/paths/api/v1/post.yml
-I, [2019-05-06T19:32:52.082838 #22431]  INFO -- :  Use schema file: 	oas_docs/src/paths/api/v2/post.yml
-I, [2019-05-06T19:32:52.083719 #22431]  INFO -- :  Use schema file: 	oas_docs/src/paths/task.yml
-I, [2019-05-06T19:32:52.084185 #22431]  INFO -- :  Use schema file: 	oas_docs/src/paths/rails_admin/engine.yml
-I, [2019-05-06T19:32:52.085796 #22431]  INFO -- :  Use schema file: 	oas_docs/src/paths/rails_admin/main.yml
-I, [2019-05-06T19:32:52.086063 #22431]  INFO -- :  Use schema file: 	oas_docs/src/externalDocs.yml
-I, [2019-05-06T19:32:52.086555 #22431]  INFO -- :  Use schema file: 	oas_docs/src/tags.yml
-I, [2019-05-06T19:32:52.087145 #22431]  INFO -- :  Use schema file: 	oas_docs/src/components/schemas/user.yml
-I, [2019-05-06T19:32:52.087667 #22431]  INFO -- :  Use schema file: 	oas_docs/src/components/schemas/task.yml
-I, [2019-05-06T19:32:52.087955 #22431]  INFO -- :  Use schema file: 	oas_docs/src/components/schemas/engine.yml
-I, [2019-05-06T19:32:52.088281 #22431]  INFO -- :  Use schema file: 	oas_docs/src/components/schemas/main.yml
-I, [2019-05-06T19:32:52.088567 #22431]  INFO -- :  Use schema file: 	oas_docs/src/components/schemas/post.yml
-I, [2019-05-06T19:32:52.088867 #22431]  INFO -- :  Use schema file: 	oas_docs/src/info.yml
-I, [2019-05-06T19:32:52.089136 #22431]  INFO -- :  Use schema file: 	oas_docs/src/servers.yml
-I, [2019-05-06T19:32:52.100673 #22431]  INFO -- : [Build OAS docs from schema files] end
-I, [2019-05-06T19:32:52.133732 #22431]  INFO -- : [R2-OAS] end
-```
-Generate docs like this:
-```
-$ tree docs
-docs
-├── dist
-│   ├── favicon-16x16.png
-│   ├── favicon-32x32.png
-│   ├── oauth2-redirect.html
-│   ├── swagger-ui-bundle.js
-│   ├── swagger-ui-bundle.js.map
-│   ├── swagger-ui-standalone-preset.js
-│   ├── swagger-ui-standalone-preset.js.map
-│   ├── swagger-ui.css
-│   ├── swagger-ui.css.map
-│   ├── swagger-ui.js
-│   └── swagger-ui.js.map
-├── index.html
-└── oas_doc.yml
-1 directory, 13 files
-```