r2-oas 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 517376839248a5dd6de6e70b753490e02a23ac70c967129fc7a578ec89da596c
-  data.tar.gz: 7eedf1ebcd319c0b93ee1ac58556ce0e4788658e62b64eecbad825862770245f
+  metadata.gz: 7a8548f2c821fe7b76548b748dbe733ce0f11386d76ae046cc047b0fe0eb017b
+  data.tar.gz: ee6ebb9740a854142b929195a57206cf8cedfeb1f965e4217e048152effc03a0
 SHA512:
-  metadata.gz: 20b7b68bbf6c4e8ec2d963301855d7bd078b78c31a98e8a01d421197a9e080682e459fb2a2b5541ca07580b995003f3fe17f88b97b1ab5295bdcda793d255c81
-  data.tar.gz: 140b4b5c71b4e34ed9f7ef7796414699db821ac078d6ad0101530145d0e3084cfd3f4e7b0c85e6a6091a2213b91ce6f976d4a2ee44d20434ce75f4f848595bf1
+  metadata.gz: fcdf6903f652e7109c137b05123d6d244aaec02e9bb2a1fd657bc710ae549c6d84bd887c281a2f881e070d757299f17334200273bb2b3f9e6b988d16578a246b
+  data.tar.gz: 129cfd622a8bd4c5b55bd5415cb24f24d0b918ea7cd9781aec7127b41640c3fe116b5f7e4dfe20add9ec68993d075471d172bd4919fda957893dc8b747c48ce2

data/CHANGELOG.md

@@ -1,4 +1,58 @@
-# Change Log
+# CHANGELOG
+
+## v0.5.0
+
+2020-01-29
+
+- [`Breaking`] Remove `use_object_classes` option ([#171](https://github.com/yukihirop/r2-oas/pull/171))
+- [`Feature`] Upgrade init command ([#176](https://github.com/yukihirop/r2-oas/pull/176))
+- [`EOL`] EOL Ruby `2.3` and Support over Ruby `2.5.0` ([#170](https://github.com/yukihirop/r2-oas/pull/170))
+
+Please see mileston [v0.5.0](https://github.com/yukihirop/r2-oas/milestone/5?closed=1)
+
+## v0.4.1
+
+2020-8-24
+
+- [`Breaking`] Remove `tool` tasks because it is infrequently used, it costs ([#162](https://github.com/yukihirop/r2-oas/pull/162))
+    - `routes:oas:paths_ls`
+    - `routes:oas:paths_stats`
+- [`Feature`] Add `SKIP_PLUGIN` enviroment variables ([#160](https://github.com/yukihirop/r2-oas/pull/160))
+
+Please see milestone [v0.4.1](https://github.com/yukihirop/r2-oas/milestone/6?closed=1)
+
+## v0.4.0
+
+2020-07-22
+
+- [`BigFeature`] 🎯 Implement plugin ([#154](https://github.com/yukihirop/r2-oas/pull/154))
+    - Please see [use plugins docs](https://yukihirop.github.io/r2-oas/#/usage/use_plugins)
+- [`Feature`] Implement `routes:oas:init`([#154](https://github.com/yukihirop/r2-oas/pull/154))
+    - Please see [initialize docs](https://yukihirop.github.io/r2-oas/#/usage/initialize)
+- [`Breaking`] Rename from `routes:oas:dist` to `routes:oas:build` ([#154](https://github.com/yukihirop/r2-oas/pull/154))
+- [`Feature`] Allowed definition of custom rake tasks ([#152](https://github.com/yukihirop/r2-oas/pull/152))
+    - Please see [define tasks docs](https://yukihirop.github.io/r2-oas/#/usage/define_tasks)
+- [`Deprecated`] Deprecated use of `R2OAS.use_object_classes=` ([#155](https://github.com/yukihirop/r2-oas/pull/155))
+
+Please see milestone [v0.4.0](https://github.com/yukihirop/r2-oas/milestone/4?closed=1)
+
+## v0.3.4
+
+2020-07-11
+
+- [`Other`] Modify gemspec `files` fields ([#147](https://github.com/yukihirop/r2-oas/pull/147))
+    - Add `r2-oas.gemspec` into gemspec `files`
+
+## v0.3.3
+
+2020-07-11
+
+- [`FixBugs`] A cute pet store syndrome 🐈 ([f3f4c30](https://github.com/yukihirop/r2-oas/pull/144))
+- [`FixBugs`]  R2OAS.logger.level does not work ([f3f4c30](https://github.com/yukihirop/r2-oas/pull/144))
+- [`Breaking`] Change default namespace type from `:underbar` to `:dot` ([f3f4c30](https://github.com/yukihirop/r2-oas/pull/144))
+- [`Other`] Modify gemspec `files` fields ([f3f4c30](https://github.com/yukihirop/r2-oas/pull/144))
+
+Please see milestone [v0.3.3](https://github.com/yukihirop/r2-oas/milestone/3?closed=1)
 
 ## v0.3.2
 

data/GEMSPEC.md

@@ -6,12 +6,12 @@ Generate api docment(OpenAPI) side only from `Rails` routing.
   
 Provide rake tasks to management API Docment (OpenAPI) 🎉  
   
-
+    $ bundle exec rake routes:oas:init
     $ 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:build
     $ bundle exec rake routes:oas:clean
     $ bundle exec rake routes:oas:analyze
     $ bundle exec rake routes:oas:deploy

data/README.ja.md

@@ -8,11 +8,12 @@
 Railsのルーティング情報からOpenAPI形式のドキュメントを生成し、閲覧・編集・管理するためのrakeタスクの提供をします。
 
 ```bash
+bundle exec rake routes:oas:init    # 初期化
 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:build   # ドキュメントビルド
 bundle exec rake routes:oas:clean   # ドキュメント清掃
 bundle exec rake routes:oas:analyze # ドキュメント分解・分析
 bundle exec rake routes:oas:deploy  # ドキュメントデプロイ
@@ -49,8 +50,17 @@ $ brew cask install chromedriver
 gemをrequire後、以下のrakeタスクを実行するだけです。
 
 ```bash
-bundle exec routes:oas:docs
-bundle exec routes:oas:editor
+$ bundle exec rake routes:oas:init
+      create	oas_docs
+      create	oas_docs/.paths
+      create	oas_docs/plugins/helpers
+      create	oas_docs/tasks/helpers
+      create	oas_docs/plugins/.gitkeep
+      create	oas_docs/plugins/helpers/.gitkeep
+      create	oas_docs/tasks/.gitkeep
+      create	oas_docs/tasks/helpers/.gitkeep
+$ bundle exec rake routes:oas:docs
+$ bundle exec rake routes:oas:editor
 ```
 
 #### Generate docs
@@ -68,39 +78,70 @@ bundle exec routes:oas:editor
 
 ## 📖 Usage
 
-railsプロジェクトのルートディレクトリで以下のコマンドが実行可能です。
+
+railsプロジェクトのルートディレクトリで以下のコマンドが実行可能です。  
+一般的なコマンドの使用例を示します。
+
+### Initialize
+
+`r2-oas`の初期化
 
 ```bash
-$ # ドキュメント生成
-$ bundle exec rake routes:oas:docs
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:docs    # pathsファイルを指定してドキュメント生成
+$ bundle exec rake routes:oas:init
+      create	oas_docs
+      create	oas_docs/.paths
+      create	oas_docs/plugins/helpers
+      create	oas_docs/tasks/helpers
+      create	oas_docs/plugins/.gitkeep
+      create	oas_docs/plugins/helpers/.gitkeep
+      create	oas_docs/tasks/.gitkeep
+      create	oas_docs/tasks/helpers/.gitkeep
+```
 
-$ # SwaggerEditorでドキュメント編集
-$ bundle exec rake routes:oas:editor
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor  # pathsファイルを指定してドキュメント編集
-$ # SwaggerUIでドキュメント閲覧
-$ bundle exec rake routes:oas:ui
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:ui      # pathsファイルを指定してドキュメント閲覧
-$ # テキストエディタでドキュメント編集(初期設定時、git管理しないoas_docs/oas_doc.ymlを監視)
-$ bundle exec rake routes:oas:monitor
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:monitor # pathsファイルを指定してドキュメント監視
-
-$ # ドキュメントを分解・分析
-$ OAS_FILE="~/Desktop/swagger.yml" bundle exec rake routes:oas:analyze
-$ # どこからも参照されてないcomponents/schemas(requestBodies, ...)を削除
-$ bundle exec rake routes:oas:clean
-$ # githubにホスティング
-$ bundle exec rake routes:oas:deploy
-$ # ドキュメントを配布(初期設定時、配布ファイルは、oas_docs/oas_doc.yml)
-$ bundle exec rake routes:oas:dist
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:dist    # pathsファイルを指定してドキュメント配布
- 
-# pathsファイルのリスト取得
-$ bundle exec rake routes:oas:paths_ls
-# pathsファイルの編集履歴表示
-$ bundle exec rake routes:oas:paths_stats
+### Generate
+
+ドキュメントの生成
+
+```bash
+$ bundle exec rake routes:oas:docs                                                       # Generate docs
+$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:docs    # Generate docs by specify unit paths
+```
+
+### Editor
+
+SwaggerEditorの起動
+
+```bash
+$ bundle exec rake routes:oas:editor                                                     # Start swagger editor
+$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor  # Start swagger editor by specify unit paths
+```
+
+### UI
+
+SwaggerUIの起動
+
+```bash
+$ bundle exec rake routes:oas:ui                                                         # Start swagger ui
+$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:ui      # Start swagger ui by specify unit paths
+```
+
+### Build
+
+ドキュメントのビルド  
+※プラグインが適用されます。
+
+```bash
+$ bundle exec rake routes:oas:build
 ```
 
+### Analyze
+
+ドキュメントの分割   
+OpenAPI形式のドキュメントを読み取り、それをいくつかの部分に分割してソースファイルを生成します
+
+```bash
+$ OAS_FILE="~/Desktop/swagger.yml" bundle exec rake routes:oas:analyze
+```
 
 ## ⚾️ sample
 
@@ -117,7 +158,7 @@ $ bundle exec rake routes:oas:paths_stats
 
 ## ❤️ Support Ruby Version
 
-- Ruby (>= 2.3.3p222 (2016-11-21 revision 56859) [x86_64-darwin18])
+- Ruby (>= 2.5.0)
 
 ## ❤️ Support Rouging
 
@@ -151,13 +192,6 @@ OpenAPIの3.0.0をサポートしてます。
 
 公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas/#/setting/configure
 
-## 💊 Life Cycle Methods (Hook Metohds)
-
-ドキュメント生成時に、フックを可能にするメソッドを用意しております。
-
-公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas/#/usage/use_hook_methods
-
-
 ## Bundle and Rspec with multiple ruby ​​versions
 
 #### Bundle
@@ -168,8 +202,6 @@ OpenAPIの3.0.0をサポートしてます。
 .
 .
 ===== 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
@@ -197,8 +229,6 @@ ruby-2.7.1: 0
 .
 .
 ===== 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

data/README.md

@@ -10,11 +10,12 @@ Generate api docment(OpenAPI) side only from `Rails` routing.
 Provides a rake command to help `generate` , `view` , and `edit` OpenAPI documents.
 
 ```bash
+bunlde exec rake routes:oas:init    # initialize
 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:build   # build
 bundle exec rake routes:oas:clean   # clean
 bundle exec rake routes:oas:analyze # analyze
 bundle exec rake routes:oas:deploy  # deploy
@@ -56,11 +57,24 @@ $ brew cask install chromedriver
 
 ## 🚀 Tutorial
 
-After requiring a gem,
+After requiring a gem and Configure `Rakefile` in your rails project
+
+```rb
+R2OAS.load_tasks
+```
 
 ```bash
-bundle exec routes:oas:docs
-bundle exec routes:oas:editor
+$ bundle exec rake routes:oas:init
+      create	oas_docs
+      create	oas_docs/.paths
+      create	oas_docs/plugins/helpers
+      create	oas_docs/tasks/helpers
+      create	oas_docs/plugins/.gitkeep
+      create	oas_docs/plugins/helpers/.gitkeep
+      create	oas_docs/tasks/.gitkeep
+      create	oas_docs/tasks/helpers/.gitkeep
+$ bundle exec rake routes:oas:docs
+$ bundle exec rake routes:oas:editor
 ```
 
 #### Generate docs
@@ -74,38 +88,70 @@ bundle exec routes:oas:editor
 
 ## Usage
 
-You can execute the following command in the root directory of rails.
+You can execute the following command in the root directory of rails.  
+The following are examples of typical command usage.
+
+Full docs are available at https://yukihirop.github.io/r2-oas
+
+### Initialize
+
+Initialize r2-oas.
+
+```bash
+$ bundle exec rake routes:oas:init
+      create	oas_docs
+      create	oas_docs/.paths
+      create	oas_docs/plugins/helpers
+      create	oas_docs/tasks/helpers
+      create	oas_docs/plugins/.gitkeep
+      create	oas_docs/plugins/helpers/.gitkeep
+      create	oas_docs/tasks/.gitkeep
+      create	oas_docs/tasks/helpers/.gitkeep
+```
+
+### Generate
+
+Generate docs.
 
 ```bash
-$ # Generate docs
-$ bundle exec rake routes:oas:docs                                                                        # Generate docs
+$ bundle exec rake routes:oas:docs                                                       # Generate docs
 $ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:docs    # Generate docs by specify unit paths
+```
 
-$ # Start swagger editor
-$ bundle exec rake routes:oas:editor                                                                      # Start swagger editor
+### Editor
+
+Start swagger editor.
+
+```bash
+$ bundle exec rake routes:oas:editor                                                     # Start swagger editor
 $ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor  # Start swagger editor by specify unit paths
-$ # Start swagger ui
-$ bundle exec rake routes:oas:ui                                                                          # Start swagger ui
+```
+
+### UI
+
+Start swagger ui.
+
+```bash
+$ bundle exec rake routes:oas:ui                                                         # Start swagger ui
 $ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:ui      # Start swagger ui by specify unit paths
-$ # Monitor swagger document
-$ bundle exec rake routes:oas:monitor                                                                     # Monitor swagger document
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:monitor # Monitor swagger by specify unit paths
+```
+
+### Build
+
+Build docs.  
+`Plugin is applied`
+
+```bash
+$ bundle exec rake routes:oas:build
+```
+
+### Analyze
+
+Analyze docs.  
+Reads OpenAPI format document and divides it into several parts to generate a source file
 
-$ # Analyze docs
+```bash
 $ OAS_FILE="~/Desktop/swagger.yml" bundle exec rake routes:oas:analyze
-$ # Clean docs
-$ bundle exec rake routes:oas:clean
-$ # Deploy docs
-$ bundle exec rake routes:oas:deploy
-$ # Distribute swagger document
-$ bundle exec rake routes:oas:dist
-$ # Distribute swagger document
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:dist # Distribute swagger document by specify unit paths
- 
-# Display paths list
-$ bundle exec rake routes:oas:paths_ls
-# Display paths stats
-$ bundle exec rake routes:oas:paths_stats
 ```
 
 ## 📚 Documents
@@ -118,7 +164,7 @@ Full docs are available at https://yukihirop.github.io/r2-oas
 
 ## ❤️ Support Ruby Version
 
-- Ruby (>= 2.3.3p222 (2016-11-21 revision 56859) [x86_64-darwin18])
+- Ruby (>= 2.5.0)
 
 ## ❤️ Support Rouging
 
@@ -150,12 +196,6 @@ All settings are `optional`
 
 Full docs are available at https://yukihirop.github.io/r2-oas/#/setting/configure
 
-## 💊 Life Cycle Methods (Hook Metohds)
-
-Supported hook(life cycle methods) is like this:
-
-Full docs are available at https://yukihirop.github.io/r2-oas/#/usage/use_hook_methods
-
 ## Bundle and Rspec with multiple ruby ​​versions
 
 #### Bundle
@@ -166,8 +206,6 @@ Full docs are available at https://yukihirop.github.io/r2-oas/#/usage/use_hook_m
 .
 .
 ===== 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
@@ -195,8 +233,6 @@ ruby-2.7.1: 0
 .
 .
 ===== 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

data/lib/r2-oas.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 require 'r2-oas/version'
-require 'r2-oas/configuration'
-require 'r2-oas/errors'
-require 'r2-oas/schema/v3/object/public'
+require 'r2-oas/public'
 
 module R2OAS
   if !defined?(::Rails)
@@ -12,14 +10,15 @@ module R2OAS
   elsif ::Rails::VERSION::STRING >= '4.2.5.1'
     extend Configuration
     require 'r2-oas/task'
-    require 'r2-oas/lib/core_ext/hash/deep_merge'
-    require 'r2-oas/lib/core_ext/object/blank'
+    require 'r2-oas/plugin/public'
+    require 'r2-oas/lib/core_ext/all'
 
     autoload :Base, 'r2-oas/base'
     autoload :NoImplementError, 'r2-oas/errors'
     autoload :NoFileExistsError, 'r2-oas/errors'
     autoload :NoSupportError, 'r2-oas/errors'
     autoload :Sortable, 'r2-oas/shared/all'
+    autoload :Deprecation, 'r2-oas/support/deprecation'
 
     module Schema
       autoload :Base, 'r2-oas/schema/base'