r2-oas 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 464bbc729526628547f9d689984b3925eeab1c6b7d2e58ee7a9712f222643f60
-  data.tar.gz: 808faa249dc984ccf43928188cc139bce945fe7b7e3a296ee336f755cb063315
+  metadata.gz: 202a93f6e116bb378c723a0810746749dea8059e91d2c199727739850ca528e7
+  data.tar.gz: 8061d7a71e56c7656065b20ac85f39755df665dd0d22031e01374e82a773114c
 SHA512:
-  metadata.gz: 82f601ac4610d3744422b11f58b9eab7dca668bde7e3da02ef013816d2b2edab6294404d1820579465e0f3a545904f48bb53777f9099d6f462cfd4717b69ab13
-  data.tar.gz: e12135a40bf94764064b0dc6b42dbe1880e7fd8e536c140fda3241d79fa82671d4f7aef899df287516b3ce2ba0fc7ad2d035196d6ebfc7e3f2a25efad2033930
+  metadata.gz: 0700ad89a7147febd6b7fabb6c2343403a0f0fc4fa2e244996e3a2fa24a9e951e6e5899335f4fb4e26858796c87b04e4af4984992ce06d3a0d6864fdd6f2659f
+  data.tar.gz: 2bab390d140d5eeef3b12b7563ffe20e3b2179e129f38bf4c3c4483777d80f4b91e5f73f8d74ad7a8f7c9db81ff258915a6a57cda90b4b2edcf199eb26b2ec49

data/.gitignore

@@ -10,3 +10,7 @@
 # rspec failure tracking
 .rspec_status
 /example*
+Gemfile.lock
+**/vendor/bundle
+gemfiles/*.lock
+gemfiles/.bundle/*

data/.rubocop.yml

@@ -1,7 +1,10 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
   Exclude:
-    - 'example*/**/*'
-    - 'vendor/**/*'
+    - "example*/**/*"
+    - "vendor/**/*"
+    - "r2-oas.gemspec"
+    - "gemfiles/**/*"
+    - "Appraisals"

data/.rubocop_todo.yml

@@ -10,7 +10,7 @@
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 2088
 
 Metrics/AbcSize:
@@ -26,6 +26,7 @@ Metrics/AbcSize:
     - "lib/r2-oas/routing/components/request_component.rb"
     - "spec/r2-oas/schema/v3/object/components/schema_object_spec.rb"
     - "spec/support/helpers/config_helper.rb"
+    - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
 
 Style/Documentation:
   Enabled: false
@@ -55,6 +56,7 @@ Metrics/BlockLength:
     - "spec/r2-oas/tasks/tool_spec.rb"
     - "spec/r2-oas/configuration_spec.rb"
     - "spec/r2-oas/schema/v3/generator_spec.rb"
+    - "spec/r2-oas/schema/v3/builder_spec.rb"
     - "spec/r2-oas/schema/v3/analyzer_spec.rb"
     - "spec/support/helpers/config_helper.rb"
     - "spec/r2-oas/schema/v3/object/components_object_spec.rb"
@@ -62,6 +64,7 @@ Metrics/BlockLength:
     - "spec/r2-oas/schema/v3/manager/diff/base_array_diff_manager_spec.rb"
     - "spec/r2-oas/schema/v3/manager/file/include_ref_base_file_manager_spec.rb"
     - "spec/r2-oas/schema/v3/generator/base_generator_spec.rb"
+    - "spec/r2-oas/schema/v3/builder/base_builder_spec.rb"
     - "spec/r2-oas/schema/v3/object/openapi_object_spec.rb"
     - "spec/r2-oas/schema/v3/object/info_object_spec.rb"
 
@@ -112,17 +115,20 @@ Metrics/MethodLength:
     - "lib/r2-oas/schema/v3/generator/schema_generator.rb"
     - "lib/r2-oas/schema/v3/generator/components/schema_generator.rb"
     - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
+    - "lib/r2-oas/schema/v3/builder/doc_builder.rb"
     - "lib/r2-oas/schema/v3/object/components/request_body_object.rb"
     - "lib/r2-oas/schema/v3/squeezer/path_squeezer.rb"
     - "lib/r2-oas/schema/v3/generator/components/object_generator.rb"
     - "lib/r2-oas/routing/components/request_component.rb"
     - "spec/support/helpers/config_helper.rb"
     - "lib/r2-oas/schema/v3/analyzer/components/object_analyzer.rb"
+    - "lib/r2-oas/store.rb"
 
 Metrics/CyclomaticComplexity:
   Exclude:
     - "lib/r2-oas/logger/stdout_logger.rb"
     - "lib/r2-oas/schema/v3/manager/pathname_manager.rb"
+    - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
 
 Naming/ConstantName:
   Exclude:
@@ -180,6 +186,7 @@ Style/AccessModifierDeclarations:
 Style/NumericPredicate:
   Exclude:
     - "lib/r2-oas/schema/v3/generator/base_generator.rb"
+    - "lib/r2-oas/schema/v3/builder/base_builder.rb"
 
 Metrics/ClassLength:
   Exclude:
@@ -195,6 +202,7 @@ Layout/EndAlignment:
   Exclude:
     - "lib/r2-oas/shared/sortable.rb"
     - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
+    - "lib/r2-oas/schema/v3/builder/doc_builder.rb"
 
 Security/YAMLLoad:
   Exclude:
@@ -222,3 +230,62 @@ Style/ClassAndModuleChildren:
 Lint/RequireParentheses:
   Exclude:
     - "spec/r2-oas/schema/v3/object/components/schema_object_spec.rb"
+
+Style/IfUnlessModifier:
+  Exclude:
+    - "lib/r2-oas/schema/editor.rb"
+
+Security/MarshalLoad:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: false
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: false
+
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - "spec/spec_helper.rb"
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: false
+
+Style/RedundantRegexpEscape:
+  Enabled: false

data/.travis.yml

@@ -7,8 +7,12 @@ cache: bundler
 
 rvm:
   - 2.3.3
+  - 2.4.2
+  - 2.5.7
+  - 2.6.5
+  - 2.7.1
 
-before_install: gem install bundler -v 1.17.3
+before_install: gem install bundler
 
 gemfile:
   - Gemfile
@@ -18,5 +22,5 @@ install:
   - bundle install
 
 script:
-  - bundle exec rubocop --fail-level=W
+  - ruby -e "if RUBY_VERSION >= '2.7'; system('bundle exec rubocop --fail-level=W'); end"
   - bundle exec rspec spec --exclude-pattern "spec/r2-oas/tasks/tool_spec.rb,spec/r2-oas/tool/paths/stats_spec.rb"

data/Appraisals

@@ -0,0 +1,13 @@
+appraise 'ruby-2.3.3' do
+end
+appraise 'ruby-2.4.2' do
+end
+# stable
+appraise 'ruby-2.5.8' do
+end
+# stable
+appraise 'ruby-2.6.6' do
+end
+# stable
+appraise 'ruby-2.7.1' do
+end

data/CHANGELOG.md

@@ -1,3 +1,60 @@
+# Change Log
+
+## v0.3.1
+
+2020-06-07
+
+- [`Breaking`] Remove unnecessary runtime dependencies ([384ea1a](https://github.com/yukihirop/r2-oas/pull/132))
+
+## v0.3.0
+
+2020-05-30
+
+- [`Feature/Breaking`] Support Ruby 2.7 🎉 ([931ec4b](https://github.com/yukihirop/r2-oas/pull/122))
+
+  - Remove `Gemfile.lock`
+
+- [`Developer`] Create script to test all support ruby in development ([8d0df98](https://github.com/yukihirop/r2-oas/pull/124))
+- [`Docs`] Add docs about Trableshouting ([f4a782f](https://github.com/yukihirop/r2-oas/pull/125))
+
+## v0.2.0
+
+2020-05-02
+
+- [`Feature/Breaking`] Upgrade `routes:oas:docs` cmd ([37ccddf](https://github.com/yukihirop/r2-oas/pull/117))
+  
+  - `.docs` is needed to continue using r2-oas. `If you are using previous version`,you need to run the following command to generate `.docs`.
+
+    ```bash
+    CACHE_DOCS=true bundle exec rake routes:oas:docs
+    ```
+
+- [`Breaking`] Divide into `Generator` and `Builder` ([00fea7d](https://github.com/yukihirop/r2-oas/pull/116))
+  - `routes:oas:docs` cmd do not generate `oas_docs/oas_doc.yml`
+
+## v0.1.3
+
+2020-04-27
+
+- [`FixBugs`] Fix clash when edit ([906d068](https://github.com/yukihirop/r2-oas/pull/109))
+- [`Feature`] Change log display to relative path ([c735d22](https://github.com/yukihirop/r2-oas/pull/111))
+
+## v0.1.2
+
+2020-04-22
+
+- No Change
+
+## v0.1.1
+
+2020-04-22
+
+- [`Feature`] Create document by docsify([def4463](https://github.com/yukihirop/r2-oas/pull/99))
+- [`Breaking`] Do not generate component schema when http_status equal 204 and 404 by default ([f7fcafd](https://github.com/yukihirop/r2-oas/pull/103))
+
+
 ## v0.1.0
 
-- first release [2019-10-22 / The day of the throne (called 即位礼正殿の儀の行われる日 in Japanease)]
+2019-10-22 / The day of the throne (called 即位礼正殿の儀の行われる日 in Japanease)
+
+- first release

data/GEMSPEC.md

@@ -0,0 +1,20 @@
+Configureless and no DSL. 👍 But you can also configure.  
+Manage with yaml file instead of Ruby code.  
+Loosely coupled to your Rails project. 👍  
+So if you want to use another tool, you can port it right away. 😢  
+Generate api docment(OpenAPI) side only from `Rails` routing.  
+  
+Provide rake tasks to management API Docment (OpenAPI) 🎉  
+  
+
+    $ bundle exec rake routes:oas:docs
+    $ bundle exec rake routes:oas:ui
+    $ bundle exec rake routes:oas:editor
+    $ bundle exec rake routes:oas:monitor
+    $ bundle exec rake routes:oas:dist
+    $ bundle exec rake routes:oas:clean
+    $ bundle exec rake routes:oas:analyze
+    $ bundle exec rake routes:oas:deploy
+
+  
+Happy Coding ❗️

data/README.ja.md

@@ -1,10 +1,11 @@
 # R2-OAS
 
+[![Gem Version](https://badge.fury.io/rb/r2-oas.svg)](https://badge.fury.io/rb/r2-oas)
 [![Build Status](https://travis-ci.org/yukihirop/r2-oas.svg?branch=master)](https://travis-ci.org/yukihirop/r2-oas)
 [![Coverage Status](https://coveralls.io/repos/github/yukihirop/r2-oas/badge.svg)](https://coveralls.io/github/yukihirop/r2-oas)
 [![Maintainability](https://api.codeclimate.com/v1/badges/f8c3846f350bb412fd63/maintainability)](https://codeclimate.com/github/yukihirop/r2-oas/maintainability)
 
-railsのルーティング情報からOpenAPI形式のドキュメントを生成し、閲覧・編集・管理するためのrakeタスクの提供をします。
+Railsのルーティング情報からOpenAPI形式のドキュメントを生成し、閲覧・編集・管理するためのrakeタスクの提供をします。
 
 ```bash
 bundle exec rake routes:oas:docs    # ドキュメント生成
@@ -52,90 +53,20 @@ bundle exec routes:oas:docs
 bundle exec routes:oas:editor
 ```
 
-## 📖 Usage
+#### Generate docs
 
-全ての設定は `オプショナル` です。設定してもしなくても構いません。
+![oas_docs](https://user-images.githubusercontent.com/11146767/80856236-0b839a80-8c83-11ea-888f-d0e659e0c251.gif)
 
-設定はrailsプロジェクトの `config/environments/development.rb` に書きます。
 
-デフォルトでは以下に設定されています。
+#### Edit docs
 
-```ruby
-# default setting
-R2OAS.configure do |config|
-  config.version                            = :v3
-  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.interval_to_save_edited_tmp_schema = 15
-  # :dot or :underbar
-  config.namespace_type                     = :underbar
-  config.deploy_dir_path                    = "./deploy_docs"
-
-  config.server.data = [
-    {
-      url: "http://localhost:3000",
-      description: "localhost"
-    }
-  ]
-
-  config.swagger.configure do |swagger|
-    swagger.ui.image            = "swaggerapi/swagger-ui"
-    swagger.ui.port             = "8080"
-    swagger.ui.exposed_port     = "8080/tcp"
-    swagger.ui.volume           = "/app/swagger.json"
-    swagger.editor.image        = "swaggerapi/swagger-editor"
-    swagger.editor.port         = "81"
-    swagger.editor.exposed_port = "8080/tcp" 
-  end
+![oas_editor](https://user-images.githubusercontent.com/11146767/80856240-15a59900-8c83-11ea-9dbd-4382528944f2.gif)
 
-  config.use_object_classes = {
-    info_object:                    R2OAS::Schema::V3::InfoObject,
-    paths_object:                   R2OAS::Schema::V3::PathsObject,
-    path_item_object:               R2OAS::Schema::V3::PathItemObject,
-    external_document_object:       R2OAS::Schema::V3::ExternalDocumentObject,
-    components_object:              R2OAS::Schema::V3::ComponentsObject,
-    components_schema_object:       R2OAS::Schema::V3::Components::SchemaObject,
-    components_request_body_object: R2OAS::Schema::V3::Components::RequestBodyObject
-  }
-
-  config.http_statuses_when_http_method = {
-    get: {
-      default: %w(200 422),
-      path_parameter: %w(200 404 422)
-    },
-    post: {
-      default: %w(201 422),
-      path_parameter: %w(201 404 422)
-    },
-    patch: {
-      default: %w(204 422),
-      path_parameter: %w(204 404 422)
-    },
-    put: {
-      default: %w(204 422),
-      path_parameter: %w(204 404 422)
-    },
-    delete: {
-      default: %w(200 422),
-      path_parameter: %w(200 404 422)
-    }
-  }
-
-  config.http_methods_when_generate_request_body = %w[post patch put]
-
-  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
-    paths_stats.highlight_color                = :magenta
-  end
-end
-```
+## 📚 Documents
+
+公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas
+
+## 📖 Usage
 
 railsプロジェクトのルートディレクトリで以下のコマンドが実行可能です。
 
@@ -170,21 +101,6 @@ $ bundle exec rake routes:oas:paths_ls
 $ bundle exec rake routes:oas:paths_stats
 ```
 
-## 📚 More Usage
-
-- [How to generate docs](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_GENERATE_DOCS.md)
-- [How to start swagger editor](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_START_SWAGGER_EDITOR.md)
-- [How to start swagger ui](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_START_SWAGGER_UI.md)
-- [How to monitor swagger document](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_MONITOR_SWAGGER_DOC.md)
-- [How to analyze docs](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_ANALYZE_DOCS.md)
-- [How to clean docs](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_CLEAN_DOCS.md)
-- [How to deploy swagger doc](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_DEPLOY_SWAGGER_DOC.md)
-- [How to use tag namespace](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_USE_TAG_NAMESPACE.md)
-- [How to use schema namespace](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_USE_SCHEMA_NAMESPACE.md)
-- [How to use hook when generate doc](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_USE_HOOK_WHEN_GENERATE_DOC.md)
-- [How to display paths list](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_DISPLAY_PATHS_LIST.md)
-- [How to display paths stats](https://github.com/yukihirop/r2-oas/blob/master/docs/HOW_TO_DISPLAY_PATHS_STATS.md)
-
 
 ## ⚾️ sample
 
@@ -210,11 +126,11 @@ $ bundle exec rake routes:oas:paths_stats
 
 ## ❤️ Support OpenAPI Schema
 
-|version|document|
-|-------|--------|
-|v3|[versions/v3.md](https://github.com/yukihirop/r2-oas/blob/master/docs/versions/v3.md)|
+OpenAPIの3.0.0をサポートしてます。
+
+公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas/#/schema/3.0.0
 
-## ❗️ Convention over Configuration (CoC)
+## ❗️Convention over Configuration (CoC)
 
 ツールを便利にするために、設定よりも制約があります。
 
@@ -231,324 +147,77 @@ $ bundle exec rake routes:oas:paths_stats
 
 ## ⚙ Configure
 
-設定可能な設定に関して説明します。
-
-#### basic
-
-|option|description|default|
-|------|-----------|---|
-|version|OpenAPIのバージョン| `:v3` |
-|root_dir_path|ドキュメントの保存パス| `"./oas_docs"` |
-|schema_save_dir_name|分解したスキーマの保存ディレクトリ名|`"src"`|
-|doc_save_file_name|生成したドキュメントのファイル名|`"oas_doc.yml"`|
-|force_update_schema|既生のドキュメントをルーティング情報から生成されたデータで更新するか否か|`false`|
-|use_tag_namespace|タグ名にネームスペースを使うか否か|`true`|
-|use_schema_namespace|components/{schemas,requestBodies}名に擬似ネームスペースを利用するか否か|`true`|
-|interval_to_save_edited_tmp_schema|SwaggerEditor上で編集されたドキュメントをメモリに保存する間隔(sec)|`15`|
-|http_statuses_when_http_method|HTTPメソッド毎にどのHTTPステータスのレスポンスを用意するかを決める設定|omission...|
-|http_methods_when_generate_request_body|リクエストボディーを生成する時のHTTPメソッド|`[post put patch]`|
-|namespace_type|components/{schemas,requestBodies,...}名で使用する擬似ネームスペースの種類(:dot or :underbar)| `:underbar` |
-|deploy_dir_path|deployのディレクトリパス|`"./deploy_docs"`|
-
-#### server
-
-|option|children option|description|default|
-|------|---------------|-----------|-------|
-|server|data|サーバー情報(url, description) |[{ url: `http://localhost:3000`, description: `localhost` }] |
-
-#### swagger
-
-|option|children option|grandchild option|description|default|
-|------|---------------|-----------------|-----------|-------|
-|swagger|ui|image|SwaggerUIのDockerイメージ|`"swaggerapi/swagger-ui"`|
-|swagger|ui|port|SwaggerUIのポート|`"8080"`|
-|swagger|ui|exposed_port|SwaggerUIの公開ポート|`"8080/tcp"`|
-|swagger|ui|volume|SwaggerUIのVolume|`"/app/swagger.json"`|
-|swagger|editor|image|SwaggerEditorのDockerイメージ|`"swaggerapi/swagger-editor"`|
-|swagger|editor|port|SwaggerEditorのポート|`"8080"`|
-|swagger|editor|exposed_port|SwaggerEditorの公開ポート|`"8080/tcp"`|
-
-#### hook
-
-|option|description|default|
-|------|-----------|-------|
-|use_object_classes|ドキュメント生成時に使用するオブジェクトクラスの設定|{ info_object: `R2OAS::Schema::V3::InfoObject`,<br>paths_object: `R2OAS::Schema::V3::PathsObject`,<br>path_item_object: `R2OAS::Schema::V3::PathItemObject`, external_document_object: `R2OAS::Schema::V3::ExternalDocumentObject`,<br> components_object: `R2OAS::Schema::V3::ComponentsObject`,<br> components_schema_object: `R2OAS::Schema::V3::Components::SchemaObject`, <br> components_request_body_object:`R2OAS::Schema::V3::Components::RequestBodyObject` }|
-
-#### tool
-
-|option|children option|grandchild option|description|default|
-|------|---------------|-----------------|-----------|-------|
-|tool|paths_stats|month_to_turn_to_warning_color|警告色を表示するまでの期間(ヶ月)|`3`|
-|tool|paths_stats|warning_color|警告色|`:red`|
-|tool|paths_stats|table_title_color|テーブルのタイトルの色|`:yellow`|
-|tool|paths_stats|heading_color|ヘッダーの色|`:yellow`|
-|tool|paths_stats|highlight_color|強調色|`:magenta`|
-
-Please refer to [here](https://github.com/janlelis/paint) for the color.
-
-## Environment variables
-
-環境変数は以下を用意しております。
-
-|variable|description|default|
-|--------|-----------|-------|
-|PATHS_FILE|pathsファイルのパス|`""`|
-|OAS_FILE|analyzeするドキュメントへのパス|`""`|
-
-
-## .paths
-
-`.paths` ファイルを書くことで必要な分だけドキュメントを閲覧・編集・配布する事が可能になります。
-
-`#` から始まる行はコメントとして扱われ無視されます。重複も無視されます。
-
-`paths` ディレクトリ以下のパスを書きます。
+全ての設定は `オプショナル` です。設定してもしなくても構いません。
 
-`oas_docs/.paths`
-```
-#account_user_role.yml    # ignore
-account.yml
-account.yml               # ignore
-account.yml               # ignore
-```
+公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas/#/setting/configure
 
 ## 💊 Life Cycle Methods (Hook Metohds)
 
 ドキュメント生成時に、フックを可能にするメソッドを用意しております。
 
-- `before_create`
-- `after_create`
-
-フック可能なオブジェクトは以下の通りです。
-
-- `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`
-
-これらのクラスを継承して、フックの設定を書きます。以下に例を用意しました。
-
-#### case: InfoObject
-
-```ruby
-class CustomInfoObject < R2OAS::Schema::V3::InfoObject
-  before_create do |doc|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something .... 
-    })
-  end
-
-  after_create do |doc, path|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something ....
-    })
-  end
-end
-```
-
-#### case: PathsObject
-
-```ruby
-class CustomPathsObject < R2OAS::Schema::V3::PathsObject
-  before_create do |doc|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something .... 
-    })
-  end
-
-  after_create do |doc|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something ....
-    })
-  end
-end
-```
-
-#### case: PathItemObject
-
-```ruby
-class CustomPathItemObject < R2OAS::Schema::V3::PathItemObject
-  before_create do |doc, path|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something .... 
-    })
-  end
-
-  after_create do |doc, schema_name|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something ....
-    })
-  end
-end
-```
-
-#### case: ExternalDocumentObject
-
-```ruby
-class CustomExternalDocumentObject < R2OAS::Schema::V3::ExternalDocumentObject
-  before_create do |doc|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something .... 
-    })
-  end
-
-  after_create do |doc|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something ....
-    })
-  end
-end
-```
-
-#### case: ComponentsObject
-
-```ruby
-class CustomComponentsObject < R2OAS::Schema::V3::ComponentsObject
-  before_create do |doc|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something .... 
-    })
-  end
-
-  after_create do |doc|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something ....
-    })
-  end
-end
-```
-
-#### case: Components::SchemaObject
-
-```ruby
-class CustomComponentsSchemaObject < R2OAS::Schema::V3::Components::SchemaObject
-  before_create do |doc, schema_name|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something .... 
-    })
-  end
-
-  after_create do |doc, schema_name|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something ....
-    })
-  end
-end
-```
+公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas/#/usage/use_hook_methods
 
-ドキュメント生成時にcomponents/schemas名を上書きしたい場合は以下の様にします。
 
-```ruby
-class CustomComponentsSchemaObject < R2OAS::Schema::V3::Components::SchemaObject
-  def components_schema_name(doc, path_component, tag_name, verb, http_status, schema_name)
-    # [重要] 返値は文字列であるべきです。
-    # 初期値はschema_name
-    schema_name
-  end
-end
-```
+## Bundle and Rspec with multiple ruby ​​versions
 
-`path_component` は `R2OAS::Routing::PathComponent` のインスタンスです。
+#### Bundle
 
-```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
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
 ```
 
-#### case: Components::RequestBodyObject
-
-```ruby
-class CustomComponentsRequestBodyObject < R2OAS::Schema::V3::Components::RequestBodyObject
-  before_create do |doc, schema_name|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something .... 
-    })
-  end
+rubyのバージョンを `2.6.6` と `2.7.1`　に指定する場合
 
-  after_create do |doc, schema_name|
-    # [重要] docへの破壊的な変更をしてください。
-    # [重要] railsが提供するメソッドを使用する事ができます。
-    doc.merge!({
-      # Something ....
-    })
-  end
-end
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle 2.6.6 2.7.1
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
 ```
 
-ドキュメント生成時にcomponents/requestBodies名を上書きしたい場合は以下の様にします。
+#### Rspec
 
-```ruby
-class CustomComponentsRequestBodyObject < R2OAS::Schema::V3::Components::RequestBodyObject
-  def components_request_body_name(doc, path_component, tag_name, verb, schema_name)
-    # [重要] 返値は文字列であるべきです。
-    # 初期値はschema_name
-    schema_name
-  end
-
-  def components_schema_name(doc, path_component, tag_name, verb, schema_name)
-    # [重要] 返値は文字列であるべきです。
-    # 初期値はschema_name
-    schema_name
-  end
-end
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
 ```
 
-そして最後に設定を書きます。
+rubyのバージョンを `2.6.6` と `2.7.1`　に指定する場合
 
-```ruby
-# もし、InfoObjectとPathItemObjectをカスタムのものにしたい場合は以下の様にします。
-R2OAS.configure do |config|
-  # 
-  # omission ...
-  # 
-  config.use_object_classes.merge!({
-    info_object:      CustomInfoObject,
-    path_item_object: CustomPathItemObject
-  })
-end
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec 2.6.6 2.7.1
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
 ```
 
-これだけです。
-
 ## 🔩 CORS
 
 [rack-cors](https://github.com/cyu/rack-cors)を使用する事でCORSを可能にします。