r2-oas 0.1.0 → 0.1.2

data/docs/{HOW_TO_USE_HOOK_WHEN_GENERATE_DOC.md → usage/use_hook_to_generate_docs.md}

@@ -1,6 +1,8 @@
-## BasicUsage
+## Use hook to generate docs
 
-`custom_path_item_object.rb`
+## Prepare
+
+prepare a file like `custom_path_item_object.rb`
 
 ```ruby
 class CustomPathItemObject < R2OAS::Schema::V3::PathItemObject
@@ -56,25 +58,14 @@ end
 require_relative 'custom_path_item_object'
 
 R2OAS.configure do |config|
-  config.root_dir_path        = "./oas_docs"
-  config.schema_save_dir_name = "src"
-  config.doc_save_file_name   = "oas_doc.yml"
-  config.force_update_schema  = false
-  config.use_tag_namespace    = true
-  config.use_schema_namespace = false
-  config.server.data = [
-    {
-      url: "http://localhost:3000",
-      description: "localhost"
-    }
-  ]
-  config.interval_to_save_edited_tmp_schema = 15
   config.use_object_classes.merge!({
     path_item_object:  CustomPathItemObject
   })
 end
 ```
 
+## Command
+
 ```bash
 $ bundle exec rake routes:oas:docs
 ```

data/docs/{HOW_TO_USE_SCHEMA_NAMESPACE.md → usage/use_schema_namespace.md}

@@ -1,20 +1,27 @@
-## Use Schema Namespace (default)
+# Use Schema Namespace
+
+## Prepare
+
+Add this line to your application's Gemfile:
 
 ```ruby
+group :development do
+  gem 'r2-oas'
+end
+```
 
+Add the following settings to your rails project's `config/environments/development.rb`.
+
+```ruby
 require 'r2-oas'
 
 R2OAS.configure do |config|
-   # default setting        
-   config.root_dir_path        = "./oas_docs"
-   config.schema_save_dir_name = "src"
-   config.doc_save_file_name   = "oas_doc.yml"
-   # default
-   config.use_tag_namespace    = true
-   config.use_schema_namespace = true # write here
- end
+  config.use_schema_namespace = true
+end
 ```
 
+## Command
+
 ```bash
 $ bundle exec rake routes:oas:docs
 ```

data/docs/{HOW_TO_USE_TAG_NAMESPACE.md → usage/use_tag_namespace.md}

@@ -1,20 +1,27 @@
-## Use Tag Namespace (default)
+# Use Tag Namespace
+
+## Prepare
+
+Add this line to your application's Gemfile:
 
 ```ruby
+group :development do
+  gem 'r2-oas'
+end
+```
+
+Add the following settings to your rails project's `config/environments/development.rb`.
 
+```ruby
 require 'r2-oas'
 
 R2OAS.configure do |config|
-   # default setting        
-   config.root_dir_path        = "./oas_docs"
-   config.schema_save_dir_name = "src"
-   config.doc_save_file_name   = "oas_doc.yml"
-   # default
-   config.use_tag_namespace    = true   # write here
-   config.use_schema_namespace = true
- end
+ config.use_tag_namespace    = true
+end
 ```
 
+## Command
+
 ```bash
 $ bundle exec rake routes:oas:docs
 ```
@@ -121,22 +128,21 @@ oas_docs
 └── oas_doc.yml
 ```
 
-## Do not Use Tag Namespace
+# Do not Use Tag Namespace
+
+## Prepare
 
 ```ruby
 
 require 'r2-oas'
 
 R2OAS.configure do |config|
-   # default setting        
-   config.root_dir_path        = "./oas_docs"
-   config.schema_save_dir_name = "src"
-   config.doc_save_file_name   = "oas_doc.yml"
-   config.use_tag_namespace    = false # write here
-   config.use_schema_namespace = true
+   config.use_tag_namespace = false
 end
 ```
 
+## Command
+
 ```bash
 $ bundle exec rake routes:oas:docs
 ```

data/docs/{HOW_TO_START_SWAGGER_UI.md → usage/view_docs.md}

@@ -1,17 +1,17 @@
-## Basic Usage
+# View docs
 
-```ruby
+## Prepare
 
-require 'r2-oas'
+Add this line to your application's Gemfile:
 
-R2OAS.configure do |config|
-   # default setting        
-   config.root_dir_path        = "./oas_docs"
-   config.schema_save_dir_name = "src"
-   config.doc_save_file_name   = "oas_doc.yml"
+```ruby
+group :development do
+  gem 'r2-oas'
 end
 ```
 
+## Command
+
 ```bash
 $ bundle exec rake routes:oas:ui
 ```
@@ -185,10 +185,10 @@ When you press `Ctrl + C` , the ui closes and the following message appears.
 I, [2019-04-29T12:54:14.333082 #10516]  INFO -- : [R2-OAS] end
 ```
 
-## Advanced Usage
+## Use PATHS_FILE environment
 
 If you want to generate docs by squeezing unit paths (For example, `api/v1/task.yml`), 
-you set PATHS_FILE environment like this:
+you set `PATHS_FILE` environment like this:
 
 ```bash
 $ PATHS_FILE="../oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor

data/lib/r2-oas/app_configuration.rb

@@ -40,11 +40,12 @@ module R2OAS
       }
     }
     DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY = %w[post patch put]
+    DEFAULT_IGNORED_HTTP_STATUSES_WHEN_GENERATE_COMPONENT_SCHEMA = %w[204 404]
     # rubocop:enable Style/MutableConstant
     DEFAULT_TOOL = Tool.new
     # :dot or :underbar
     DEFAULT_NAMESPACE_TYPE = :underbar
-    DEFAULT_DEPLOY_DIR_PATH = "./deploy_docs"
+    DEFAULT_DEPLOY_DIR_PATH = './deploy_docs'
 
     PUBLIC_VALID_OPTIONS_KEYS = %i[
       version
@@ -59,6 +60,7 @@ module R2OAS
       swagger
       http_statuses_when_http_method
       http_methods_when_generate_request_body
+      ignored_http_statuses_when_generate_component_schema
       tool
       namespace_type
       deploy_dir_path
@@ -82,21 +84,22 @@ module R2OAS
     private
 
     module_function def set_default(target)
-      target.version                                 = DEFAULT_VERSION
-      target.root_dir_path                           = DEFAULT_ROOT_DIR_PATH
-      target.schema_save_dir_name                    = DEFAULT_SCHEMA_SAVE_DIR_NAME
-      target.doc_save_file_name                      = DEFAULT_DOC_SAVE_FILE_NAME
-      target.force_update_schema                     = DEFAULT_FORCE_UPDATE_SCHEMA
-      target.use_tag_namespace                       = DEFAULT_USE_TAG_NAMESPACE
-      target.use_schema_namespace                    = DEFAULT_USE_SCHEMA_NAMESPACE
-      target.server                                  = DEFAULT_SERVER
-      target.interval_to_save_edited_tmp_schema      = DEFAULT_INTERVAL_TO_SAVE_EDITED_TMP_SCHEMA
-      target.swagger                                 = DEFAULT_SWAGGER
-      target.http_statuses_when_http_method          = DEFAULT_HTTP_STATUSES_WHEN_HTTP_METHOD
-      target.tool                                    = DEFAULT_TOOL
-      target.http_methods_when_generate_request_body = DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY
-      target.namespace_type                          = DEFAULT_NAMESPACE_TYPE
-      target.deploy_dir_path                         = DEFAULT_DEPLOY_DIR_PATH
+      target.version                                              = DEFAULT_VERSION
+      target.root_dir_path                                        = DEFAULT_ROOT_DIR_PATH
+      target.schema_save_dir_name                                 = DEFAULT_SCHEMA_SAVE_DIR_NAME
+      target.doc_save_file_name                                   = DEFAULT_DOC_SAVE_FILE_NAME
+      target.force_update_schema                                  = DEFAULT_FORCE_UPDATE_SCHEMA
+      target.use_tag_namespace                                    = DEFAULT_USE_TAG_NAMESPACE
+      target.use_schema_namespace                                 = DEFAULT_USE_SCHEMA_NAMESPACE
+      target.server                                               = DEFAULT_SERVER
+      target.interval_to_save_edited_tmp_schema                   = DEFAULT_INTERVAL_TO_SAVE_EDITED_TMP_SCHEMA
+      target.swagger                                              = DEFAULT_SWAGGER
+      target.http_statuses_when_http_method                       = DEFAULT_HTTP_STATUSES_WHEN_HTTP_METHOD
+      target.tool                                                 = DEFAULT_TOOL
+      target.http_methods_when_generate_request_body              = DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY
+      target.ignored_http_statuses_when_generate_component_schema = DEFAULT_IGNORED_HTTP_STATUSES_WHEN_GENERATE_COMPONENT_SCHEMA
+      target.namespace_type                                       = DEFAULT_NAMESPACE_TYPE
+      target.deploy_dir_path                                      = DEFAULT_DEPLOY_DIR_PATH
     end
   end
 end

data/lib/r2-oas/deploy/client.rb

@@ -25,7 +25,7 @@ module R2OAS
       end
 
       def copy_swagger_ui_index
-        index_path = File.expand_path(Rails.root.join(deploy_dir_path, "index.html"), __FILE__)
+        index_path = File.expand_path(Rails.root.join(deploy_dir_path, 'index.html'), __FILE__)
         @schema_file_path = doc_save_file_name
         template_path = File.expand_path('swagger-ui/index.html.erb', __dir__)
         template = File.read(template_path)

data/lib/r2-oas/schema/v3/object/path_item_object.rb

@@ -64,18 +64,26 @@ module R2OAS
 
         def responses_when_http_status
           http_statuses.each_with_object({}) do |http_status, result|
-            result.deep_merge!(
-              http_status => {
-                'description' => "#{@tag_name} description",
-                'content' => {
-                  'application/json' => {
-                    'schema' => {
-                      '$ref' => "#/components/schemas/#{_components_schema_name(http_status)}"
+            if ignored_http_statuses_when_generate_component_schema.include?(http_status)
+              result.deep_merge!(
+                http_status => {
+                  'description' => "#{@tag_name} description"
+                }
+              )
+            else
+              result.deep_merge!(
+                http_status => {
+                  'description' => "#{@tag_name} description",
+                  'content' => {
+                    'application/json' => {
+                      'schema' => {
+                        '$ref' => "#/components/schemas/#{_components_schema_name(http_status)}"
+                      }
                     }
                   }
                 }
-              }
-            )
+              )
+            end
           end
         end
 

data/lib/r2-oas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module R2OAS
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

data/r2-oas.gemspec

@@ -10,24 +10,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ['yukihirop']
   spec.email         = ['te108186@gmail.com']
 
-  spec.summary       = 'Generate api docment(OpenAPI) side only from rails routing.'
-  spec.description   = <<~EOF
-    Generate api docment(OpenAPI) side only from `rails` routing.
-    Provides a rake command to help `generate` , `view` , and `edit` OpenAPI documents.
+  spec.summary       = 'Provide rake tasks to management API Docment (OpenAPI)'
+  spec.description   = "Let's intuitively write API documentation with Swagger Editor in your Rails Project! 😊"
 
-    ```
-    bundle exec rake routes:oas:docs    # generate
-    bundle exec rake routes:oas:ui      # view
-    bundle exec rake routes:oas:editor  # edit
-    bundle exec rake routes:oas:monitor # monitor
-    bundle exec rake routes:oas:dist    # distribute
-    bundle exec rake routes:oas:clean   # clean
-    bundle exec rake routes:oas:analyze # analyze
-    bundle exec rake routes:oas:deploy  # deploy
-    ```
-  EOF
-
-  spec.homepage      = 'https://github.com/yukihirop/r2-oas'
+  spec.homepage      = 'https://yukihirop.github.io/r2-oas'
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
@@ -48,9 +34,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'terminal-table', '~> 1.6.0'
   spec.add_runtime_dependency 'watir', '~> 6.0'
   spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'coveralls'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r2-oas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - yukihirop
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,49 +137,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,20 +192,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  Generate api docment(OpenAPI) side only from `rails` routing.
-  Provides a rake command to help `generate` , `view` , and `edit` OpenAPI documents.
-
-  ```
-  bundle exec rake routes:oas:docs    # generate
-  bundle exec rake routes:oas:ui      # view
-  bundle exec rake routes:oas:editor  # edit
-  bundle exec rake routes:oas:monitor # monitor
-  bundle exec rake routes:oas:dist    # distribute
-  bundle exec rake routes:oas:clean   # clean
-  bundle exec rake routes:oas:analyze # analyze
-  bundle exec rake routes:oas:deploy  # deploy
-  ```
+description: "Let's intuitively write API documentation with Swagger Editor in your
+  Rails Project! \U0001F60A"
 email:
 - te108186@gmail.com
 executables: []
@@ -229,19 +217,27 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/HOW_TO_ANALYZE_DOCS.md
-- docs/HOW_TO_CLEAN_DOCS.md
-- docs/HOW_TO_DEPLOY_SWAGGER_DOC.md
-- docs/HOW_TO_DISPLAY_PATHS_LIST.md
-- docs/HOW_TO_DISPLAY_PATHS_STATS.md
-- docs/HOW_TO_GENERATE_DOCS.md
-- docs/HOW_TO_MONITOR_SWAGGER_DOC.md
-- docs/HOW_TO_START_SWAGGER_EDITOR.md
-- docs/HOW_TO_START_SWAGGER_UI.md
-- docs/HOW_TO_USE_HOOK_WHEN_GENERATE_DOC.md
-- docs/HOW_TO_USE_SCHEMA_NAMESPACE.md
-- docs/HOW_TO_USE_TAG_NAMESPACE.md
-- docs/versions/v3.md
+- docs/.nojekyll
+- docs/README.md
+- docs/_sidebar.md
+- docs/index.html
+- docs/schema/3.0.0.md
+- docs/setting/COC.md
+- docs/setting/CORS.md
+- docs/setting/configure.md
+- docs/usage/analyze_docs.md
+- docs/usage/clean_docs.md
+- docs/usage/deploy_docs.md
+- docs/usage/display_paths_list.md
+- docs/usage/display_paths_stats.md
+- docs/usage/edit_docs.md
+- docs/usage/generate_docs.md
+- docs/usage/monitor_docs.md
+- docs/usage/use_hook_methods.md
+- docs/usage/use_hook_to_generate_docs.md
+- docs/usage/use_schema_namespace.md
+- docs/usage/use_tag_namespace.md
+- docs/usage/view_docs.md
 - lib/r2-oas.rb
 - lib/r2-oas/app_configuration.rb
 - lib/r2-oas/app_configuration/server.rb
@@ -346,7 +342,7 @@ files:
 - lib/r2-oas/tool/paths/stats.rb
 - lib/r2-oas/version.rb
 - r2-oas.gemspec
-homepage: https://github.com/yukihirop/r2-oas
+homepage: https://yukihirop.github.io/r2-oas
 licenses:
 - MIT
 metadata: {}
@@ -369,5 +365,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Generate api docment(OpenAPI) side only from rails routing.
+summary: Provide rake tasks to management API Docment (OpenAPI)
 test_files: []