r2-oas 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74e2483dd3c1980c894757819275ef05b794820d5aebe22b08bf737df2f31c63
-  data.tar.gz: 52b4b0abf260d18852cdaad9ea1d7b70aa76cc63e15a7793e528b8769e715b94
+  metadata.gz: b365f9c68dd7df3c642a3b6d067d4a63f8e112806ee68711f949c76a244652e2
+  data.tar.gz: c3c3ef2eca59de1d9db5889d1191ae480b8c96e09ac58cf8ef9036bb932c3781
 SHA512:
-  metadata.gz: 23f55926a604e6f49424294867e183a4cb4d1dc0a5b6a0e3fa9751eb56bc667477868a56436a08a3c3855939f3d9b8959c56ca7d5496086be6ffe8b2f45a06bc
-  data.tar.gz: 799eae1d0bf672a6615cb8917b4aa633b92cb01df314adbfd00cab520176dff47b97be49316430e1b2c51bf0083f114331f6bcb48c5cab14837985b910846ace
+  metadata.gz: 24fd75460c287ff115e05b9fb86fb8f5e253a99e0c368943d54ee4b5142425ce90086857220fa158e998b3325bc7ff40f5f0af87f9adf27a9d899e3d4a4747b5
+  data.tar.gz: 6a8b41ccaad2f0a4fc38b4af4fbb7a569042b76623a859ec8a9d4c42072805c5d7d0b037129ce7d82c6d50637fd493e7a08e0f2b7fa64773fe8218c3b7eadd7b

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## 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
@@ -16,7 +31,7 @@
 - [`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))
 
-See milestone [v0.3.3](https://github.com/yukihirop/r2-oas/milestone/3?closed=1)
+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  # ドキュメントデプロイ
@@ -68,39 +69,62 @@ 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ファイルを指定してドキュメント生成
-
-$ # 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
+$ bundle exec rake routes:oas:init
+```
+
+### 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
 
@@ -151,13 +175,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

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
@@ -74,38 +75,62 @@ 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
-$ # Generate docs
-$ bundle exec rake routes:oas:docs                                                                        # Generate docs
+$ bundle exec rake routes:oas:init
+```
+
+### Generate
+
+Generate docs.
+
+```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
+
+Start swagger editor.
 
-$ # Start swagger editor
-$ bundle exec rake routes:oas: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
+```
 
-$ # Analyze docs
+### 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
+
+```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
@@ -150,12 +175,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

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,6 +10,7 @@ module R2OAS
   elsif ::Rails::VERSION::STRING >= '4.2.5.1'
     extend Configuration
     require 'r2-oas/task'
+    require 'r2-oas/plugin/public'
     require 'r2-oas/lib/core_ext/hash/deep_merge'
     require 'r2-oas/lib/core_ext/object/blank'
 
@@ -20,6 +19,7 @@ module R2OAS
     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'

data/lib/r2-oas/app_configuration.rb

@@ -3,6 +3,7 @@
 require_relative 'app_configuration/server'
 require_relative 'app_configuration/swagger'
 require_relative 'app_configuration/tool'
+require_relative 'app_configuration/deprecation'
 
 module R2OAS
   module AppConfiguration
@@ -46,6 +47,11 @@ module R2OAS
     # :dot or :underbar
     DEFAULT_NAMESPACE_TYPE = :dot
     DEFAULT_DEPLOY_DIR_PATH = './deploy_docs'
+    EDFAULT_PLUGINS = [].freeze
+    DEFAULT_LOCAL_PLUGINS_DIR_NAME = 'plugins'
+    DEFAULT_LOCAL_TASKS_DIR_NAME = 'tasks'
+    DEFAULT_OUTPUT_PATH = './oas_docs/dist/oas_doc.yml'
+    DEFAULT_DEPRECATION = Deprecation.new
 
     PUBLIC_VALID_OPTIONS_KEYS = %i[
       version
@@ -64,6 +70,11 @@ module R2OAS
       tool
       namespace_type
       deploy_dir_path
+      plugins
+      local_plugins_dir_name
+      local_tasks_dir_name
+      output_path
+      deprecation
     ].freeze
 
     UNPUBLIC_VALID_OPTIONS_KEYS = %i[
@@ -100,6 +111,11 @@ module R2OAS
       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
+      target.plugins                                              = EDFAULT_PLUGINS
+      target.local_plugins_dir_name                               = DEFAULT_LOCAL_PLUGINS_DIR_NAME
+      target.local_tasks_dir_name                                 = DEFAULT_LOCAL_TASKS_DIR_NAME
+      target.output_path                                          = DEFAULT_OUTPUT_PATH
+      target.deprecation                                          = DEFAULT_DEPRECATION
     end
   end
 end

data/lib/r2-oas/app_configuration/deprecation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'r2-oas/support/deprecation'
+
+module R2OAS
+  module AppConfiguration
+    class Deprecation
+      DEFAULT_SILENCED = ::R2OAS::Deprecation.silenced
+
+      attr_reader :silenced
+
+      def silenced=(value)
+        @silenced = !!value
+        ::R2OAS::Deprecation.silenced = !!value
+      end
+
+      def initialize
+        set_default
+      end
+
+      private
+
+      def set_default
+        self.silenced = DEFAULT_SILENCED
+      end
+    end
+  end
+end

data/lib/r2-oas/configuration.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 require_relative 'app_configuration'
 require_relative 'pluggable_configuration'
 require_relative 'configuration/paths_config'
 require_relative 'logger/stdout_logger'
+require_relative 'support/deprecation'
 
 module R2OAS
   module Configuration
@@ -21,6 +24,15 @@ module R2OAS
 
     attr_accessor *PUBLIC_VALID_OPTIONS_KEYS
 
+    # MEMO: override because deprecated
+    def use_object_classes=(data)
+      ::R2OAS::Deprecation.will_remove(<<-MSG.squish)
+        Using a R2OAS.use_object_classes= in configuration is deprecated and
+        will be removed in r2-oas (v0.4.2).
+      MSG
+      @use_object_classes = data
+    end
+
     def self.extended(base)
       base.send :set_default_for_configuration, base
       base.send :set_default_for_pluggable, base
@@ -28,6 +40,7 @@ module R2OAS
 
     def configure
       yield self if block_given?
+      load_local_plugins
     end
 
     def options
@@ -56,8 +69,47 @@ module R2OAS
       end
     end
 
+    def load_tasks
+      tasks_path = File.expand_path("#{root_dir_path}/#{local_tasks_dir_name}")
+      Dir.glob("#{tasks_path}/**/*.rake").sort.each do |file|
+        load file if FileTest.exists?(file)
+      end
+    end
+
+    def init
+      plugins_path = File.expand_path("#{root_dir_path}/#{local_plugins_dir_name}")
+      plugins_helpers_path = "#{plugins_path}/helpers"
+      tasks_path = File.expand_path("#{root_dir_path}/#{local_tasks_dir_name}")
+      tasks_helpers_path = "#{tasks_path}/helpers"
+
+      gitkeep_plugins_path = "#{plugins_path}/.gitkeep"
+      gitkeep_plugins_helpers_path = "#{plugins_helpers_path}/.gitkeep"
+      gitkeep_tasks_path = "#{tasks_path}/.gitkeep"
+      gitkeep_tasks_helpers_path = "#{tasks_helpers_path}/.gitkeep"
+
+      FileUtils.mkdir_p(plugins_helpers_path) unless FileTest.exists?(plugins_helpers_path)
+      FileUtils.mkdir_p(tasks_helpers_path) unless FileTest.exists?(tasks_helpers_path)
+
+      File.write(gitkeep_plugins_path, '') unless FileTest.exists?(gitkeep_plugins_path)
+      File.write(gitkeep_plugins_helpers_path, '') unless FileTest.exists?(gitkeep_plugins_helpers_path)
+      File.write(gitkeep_tasks_path, '') unless FileTest.exists?(gitkeep_tasks_path)
+      File.write(gitkeep_tasks_helpers_path, '') unless FileTest.exists?(gitkeep_tasks_helpers_path)
+      paths_config.create_dot_paths
+    end
+
+    def output_dir_path
+      output_path.to_s.split('/').slice(0..-2).join('/')
+    end
+
     private
 
+    def load_local_plugins
+      plugins_path = File.expand_path("#{root_dir_path}/#{local_plugins_dir_name}")
+      Dir.glob("#{plugins_path}/**/*.rb").sort.each do |file|
+        require file if FileTest.exists?(file)
+      end
+    end
+
     def set_default_for_configuration(target)
       AppConfiguration.set_default(target)
     end