r2-oas 0.1.0 → 0.1.2

data/docs/{HOW_TO_ANALYZE_DOCS.md → usage/analyze_docs.md}

@@ -1,17 +1,17 @@
-## Basic Usage
+# Analyze 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
 $ OAS_FILE="~/Desktop/swagger_file.yml" bundle exec rake routes:oas:analyze
 ```

data/docs/usage/clean_docs.md

@@ -0,0 +1,19 @@
+# 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/{HOW_TO_DEPLOY_SWAGGER_DOC.md → usage/deploy_docs.md}

@@ -1,17 +1,17 @@
-## Basic Usage
+# Deploy 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:deploy
 ```

data/docs/{HOW_TO_DISPLAY_PATHS_LIST.md → usage/display_paths_list.md}

@@ -1,17 +1,24 @@
-## Basic Usage
 
-```ruby
+# Display paths list
+
+## 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
 ```
 
+## Comamnd
+
+```
+$ bundle exec rake routes:oas:paths_ls
+```
+
+## Example
+
 ```bash
 $ bundle exec rake routes:oas:paths_ls
 /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml

data/docs/{HOW_TO_DISPLAY_PATHS_STATS.md → usage/display_paths_stats.md}

@@ -1,24 +1,25 @@
-## Basic Usage
 
-```ruby
+# Display paths stats
 
-require 'r2-oas'
+## Prepare
 
-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"
+Add this line to your application's Gemfile:
 
-   config.tool.paths_stats.configure do |paths_stats|
-    paths_stats.month_to_turn_to_warning_color = 3
-    paths_stats.warning_color                  = :red
-    paths_stats.table_title_color              = :yellow
-    paths_stats.heading_color                  = :yellow
-   end
+```ruby
+group :development do
+  gem 'r2-oas'
 end
 ```
 
+## Command
+
+```bash
+$ bundle exec rake routes:oas:paths_stats
+```
+
+## Example
+
+
 ```bash
 $ bundle exec rake routes:oas:paths_stats
 +----+--------------------------------------------------------+---------------------------+---------------------------+

data/docs/{HOW_TO_START_SWAGGER_EDITOR.md → usage/edit_docs.md}

@@ -1,17 +1,17 @@
-## Basic Usage
+# Edit 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:editor
 ```
@@ -155,10 +155,10 @@ container id: 1a9752d2702045b2fde587dda3ce064233a735165f9b70bc6f86e603abfe3a39 r
 I, [2019-04-07T19:43:53.666565 #33493]  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/docs/{HOW_TO_GENERATE_DOCS.md → usage/generate_docs.md}

@@ -1,17 +1,17 @@
-## Basic Usage
+# Generate 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:docs
 ```
@@ -209,7 +209,7 @@ oas_docs
 ## Advanced Usage
 
 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:docs

data/docs/{HOW_TO_MONITOR_SWAGGER_DOC.md → usage/monitor_docs.md}

@@ -1,17 +1,17 @@
-## Basic Usage
+# Monitor 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:monitor
 ```
@@ -137,7 +137,7 @@ bulk_action POST        /:model_name/bulk_action(.:format)     rails_admin/main#
 show_in_app GET         /:model_name/:id/show_in_app(.:format) rails_admin/main#show_in_app
 ```
 
-#### Usage
+#### VS Code
 
 If you use [Swagger Viewer](https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer)
 

data/docs/usage/use_hook_methods.md

@@ -0,0 +1,236 @@
+# Use hook methods
+
+Supported hook(life cycle methods) is like this:
+
+- `before_create`
+- `after_create`
+
+Supported Hook class is like this:
+
+- `R2OAS::Schema::V3::InfoObject`
+- `R2OAS::Schema::V3::PathsObject`
+- `R2OAS::Schema::V3::PathItemObject`
+- `R2OAS::Schema::V3::ExternalDocumentObject`
+- `R2OAS::Schema::V3::ComponentsObject`
+- `R2OAS::Schema::V3::Components::SchemaObject`
+- `R2OAS::Schema::V3::Components::RequestBodyObject`
+
+By inheriting these classes, you can hook them at the time of document generation by writing like this:
+
+#### case: InfoObject
+
+```ruby
+class CustomInfoObject < R2OAS::Schema::V3::InfoObject
+  before_create do |doc|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something .... 
+    })
+  end
+
+  after_create do |doc, path|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something ....
+    })
+  end
+end
+```
+
+#### case: PathsObject
+
+```ruby
+class CustomPathsObject < R2OAS::Schema::V3::PathsObject
+  before_create do |doc|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something .... 
+    })
+  end
+
+  after_create do |doc|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something ....
+    })
+  end
+end
+```
+
+#### case: PathItemObject
+
+```ruby
+class CustomPathItemObject < R2OAS::Schema::V3::PathItemObject
+  before_create do |doc, path|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something .... 
+    })
+  end
+
+  after_create do |doc, schema_name|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something ....
+    })
+  end
+end
+```
+
+#### case: ExternalDocumentObject
+
+```ruby
+class CustomExternalDocumentObject < R2OAS::Schema::V3::ExternalDocumentObject
+  before_create do |doc|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something .... 
+    })
+  end
+
+  after_create do |doc|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something ....
+    })
+  end
+end
+```
+
+#### case: ComponentsObject
+
+```ruby
+class CustomComponentsObject < R2OAS::Schema::V3::ComponentsObject
+  before_create do |doc|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something .... 
+    })
+  end
+
+  after_create do |doc|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something ....
+    })
+  end
+end
+```
+
+#### case: Components::SchemaObject
+
+```ruby
+class CustomComponentsSchemaObject < R2OAS::Schema::V3::Components::SchemaObject
+  before_create do |doc, schema_name|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something .... 
+    })
+  end
+
+  after_create do |doc, schema_name|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something ....
+    })
+  end
+end
+```
+
+If you want to determine the component schema name at runtime, like this:
+
+```ruby
+class CustomComponentsSchemaObject < R2OAS::Schema::V3::Components::SchemaObject
+  def components_schema_name(doc, path_component, tag_name, verb, http_status, schema_name)
+    # [Important] Please return string.
+    # default
+    schema_name
+  end
+end
+```
+
+`path_component` is `R2OAS::Routing::PathComponent` instance.
+
+```ruby
+module R2OAS
+  module Routing
+    class PathComponent < BaseComponent
+      def initialize(path)
+      def to_s
+      def symbol_to_brace
+      def path_parameters_data
+      def path_excluded_path_parameters
+      def exist_path_parameters?
+      def path_parameters
+      private
+      def without_format
+```
+
+#### case: Components::RequestBodyObject
+
+```ruby
+class CustomComponentsRequestBodyObject < R2OAS::Schema::V3::Components::RequestBodyObject
+  before_create do |doc, schema_name|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something .... 
+    })
+  end
+
+  after_create do |doc, schema_name|
+    # [Important] Please change doc destructively.
+    # [Important] To be able to use methods in Rails !
+    doc.merge!({
+      # Something ....
+    })
+  end
+end
+```
+
+If you want to determine the component schema name at runtime, like this:
+
+```ruby
+class CustomComponentsRequestBodyObject < R2OAS::Schema::V3::Components::RequestBodyObject
+  def components_request_body_name(doc, path_component, tag_name, verb, schema_name)
+    # [Important] Please return string.
+    # default
+    schema_name
+  end
+
+  def components_schema_name(doc, path_component, tag_name, verb, schema_name)
+    # [Important] Please return string.
+    # default
+    schema_name
+  end
+end
+```
+
+And write this to the configuration.
+
+```ruby
+# If only InfoObject and PathItemObject, use a custom class
+R2OAS.configure do |config|
+  # 
+  # omission ...
+  # 
+  config.use_object_classes.merge!({
+    info_object:      CustomInfoObject,
+    path_item_object: CustomPathItemObject
+  })
+end
+```
+
+This is the end.