r2-oas 0.3.2 → 0.5.0

data/lib/r2-oas/schema/v3/object/from_routes/base_object.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'r2-oas/plugin/executor'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseObject
+        extend Forwardable
+
+        def_delegators :@plugin_executor, :execute_transform_plugins
+
+        def initialize(opts = {})
+          AppConfiguration::VALID_OPTIONS_KEYS.each do |key|
+            send("#{key}=", app_configuration_options[key])
+          end
+
+          @opts = opts
+          @plugin_executor = ::R2OAS::Plugin::Executor.new(@plugins, opts)
+        end
+
+        def doc
+          @doc ||= {}
+        end
+
+        def to_doc
+          raise 'Implement Inherit Class'
+        end
+
+        private
+
+        def app_configuration_options
+          R2OAS.app_configuration_options
+        end
+
+        attr_accessor *AppConfiguration::VALID_OPTIONS_KEYS
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/object/{components → from_routes/components}/request_body_object.rb

@@ -1,28 +1,32 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require 'r2-oas/schema/v3/object/from_routes/base_object'
 require 'r2-oas/schema/v3/manager/file/components_file_manager'
+require_relative 'schema_object'
 
 module R2OAS
   module Schema
     module V3
       module Components
-        class RequestBodyObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
-          def initialize(route_data, path)
-            super()
+        class RequestBodyObject < R2OAS::Schema::V3::BaseObject
+          def initialize(route_data, path, opts = {})
+            super(opts)
             @path_comp   = Routing::PathComponent.new(path)
             @path        = @path_comp.symbol_to_brace
             @route_data  = route_data
             @verb        = route_data[:verb]
             @tag_name    = route_data[:tag_name]
             @schema_name = route_data[:schema_name]
+            # MEMO:
+            # Allow primitive types that cannot be passed by reference to be passed by reference
+            # This is Compromise
+            @ref         = { schema_name: @schema_name, tag_name: @tag_name, verb: @verb }
           end
 
           def to_doc
-            execute_before_create(@schema_name)
             create_doc do
               child_file_manager = ComponentsFileManager.new("#/components/schemas/#{_components_schema_name}", :ref)
-              schema_object = components_schema_object_class.new(@route_data, @path)
+              schema_object = Components::SchemaObject.new(@route_data, @path, @opts)
 
               unless child_file_manager.skip_save?
                 result = {
@@ -41,10 +45,16 @@ module R2OAS
                 )
               end
             end
-            execute_after_create(@schema_name)
             doc
           end
 
+          def generate?
+            file_manager = ComponentsFileManager.new("#/components/schemas/#{_components_schema_name}", :ref)
+            (@verb.in? http_methods_when_generate_request_body) && !file_manager.skip_save?
+          end
+
+          private
+
           def create_doc
             file_manager = ComponentsFileManager.new("#/components/schemas/#{_components_schema_name}", :ref)
             doc.deep_merge!(
@@ -59,31 +69,12 @@ module R2OAS
             yield if block_given?
           end
 
-          # MEMO:
-          # please override in inherited class.
-          def components_schema_name(_doc, _path_component, _tag_name, _verb, schema_name)
-            schema_name
-          end
-
-          # MEMO:
-          # please override in inherited class.
-          def components_request_body_name(_doc, _path_component, _tag_name, _verb, schema_name)
-            schema_name
-          end
-
-          def generate?
-            file_manager = ComponentsFileManager.new("#/components/schemas/#{_components_schema_name}", :ref)
-            (@verb.in? http_methods_when_generate_request_body) && !file_manager.skip_save?
-          end
-
-          private
-
           def _components_schema_name
-            components_schema_name(doc, @path_comp, @tag_name, @verb, @schema_name)
+            @schema_name
           end
 
           def _components_request_body_name
-            components_request_body_name(doc, @path_comp, @tag_name, @verb, @schema_name)
+            @schema_name
           end
         end
       end

data/lib/r2-oas/schema/v3/object/{components → from_routes/components}/schema_object.rb

@@ -1,29 +1,33 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require 'r2-oas/schema/v3/object/from_routes/base_object'
 
 module R2OAS
   module Schema
     module V3
       module Components
-        class SchemaObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
-          def initialize(route_data, path)
-            super()
+        class SchemaObject < R2OAS::Schema::V3::BaseObject
+          def initialize(route_data, path, opts = {})
+            super(opts)
             @path_comp    = Routing::PathComponent.new(path)
             @path         = @path_comp.symbol_to_brace
             @route_data   = route_data
             @verb         = route_data[:verb]
             @tag_name     = route_data[:tag_name]
             @schema_name  = route_data[:schema_name]
+            # MEMO:
+            # Allow primitive types that cannot be passed by reference to be passed by reference
+            # This is Compromise
+            @ref          = { schema_name: @schema_name, tag_name: @tag_name, verb: @verb }
           end
 
           def to_doc
-            execute_before_create(@schema_name)
             create_doc
-            execute_after_create(@schema_name)
             doc
           end
 
+          private
+
           def create_doc
             result = {
               'type' => 'object',
@@ -37,16 +41,8 @@ module R2OAS
             doc.merge!(result)
           end
 
-          # MEMO:
-          # please override in inherited class.
-          def components_schema_name(_doc, _path_component, _tag_name, _verb, _http_status, schema_name)
-            schema_name
-          end
-
-          private
-
-          def _components_schema_name(http_status)
-            components_schema_name(doc, @path_comp, @tag_name, @verb, http_status, @schema_name)
+          def _components_schema_name(_http_status)
+            @schema_name
           end
         end
       end

data/lib/r2-oas/schema/v3/object/{components_object.rb → from_routes/components_object.rb}

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require_relative 'base_object'
 require_relative 'components/schema_object'
 require_relative 'components/request_body_object'
+require_relative 'path_item_object'
 
 module R2OAS
   module Schema
     module V3
-      class ComponentsObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
-        def initialize(routes_data)
-          super()
+      class ComponentsObject < BaseObject
+        def initialize(routes_data, opts = {})
+          super(opts)
           @routes_data = routes_data
         end
 
+        def to_doc
+          create_doc
+          doc
+        end
+
         def create_doc
           create_doc_for_components_schemas!
           create_doc_for_components_request_bodies!
@@ -24,14 +30,14 @@ module R2OAS
           result = components_schema_docs.each_with_object({}) do |(schema_name, components_schema_doc), docs|
             docs[schema_name] = components_schema_doc
           end
-          doc.merge!('schemas' => result)
+          doc.merge!({ 'schemas' => result })
         end
 
         def create_doc_for_components_request_bodies!
           result = components_request_body_docs.each_with_object({}) do |(schema_name, components_request_body_doc), docs|
             docs[schema_name] = components_request_body_doc
           end
-          doc.merge!('requestBodies' => result)
+          doc.merge!({ 'requestBodies' => result })
         end
 
         # e.x.)
@@ -40,12 +46,12 @@ module R2OAS
         # ]
         def components_schema_docs
           @routes_data.each_with_object({}) do |(route_el), data|
-            path        = route_el[:path]
-            route_data  = route_el[:data]
+            path = route_el[:path]
+            route_data = route_el[:data]
 
-            path_item_object = path_item_object_class.new(route_data, path)
+            path_item_object = PathItemObject.new(route_data, path, @opts)
             path_item_object.http_statuses.each do |http_status|
-              components_schema_object = components_schema_object_class.new(route_data, path)
+              components_schema_object = Components::SchemaObject.new(route_data, path, @opts)
               components_schema_doc = components_schema_object.to_doc
               schema_name = components_schema_object.send(:_components_schema_name, http_status)
 
@@ -60,10 +66,10 @@ module R2OAS
 
         def components_request_body_docs
           @routes_data.each_with_object({}) do |(route_el), data|
-            path        = route_el[:path]
-            route_data  = route_el[:data]
+            path = route_el[:path]
+            route_data = route_el[:data]
 
-            components_request_body_object = components_request_body_object_class.new(route_data, path)
+            components_request_body_object = Components::RequestBodyObject.new(route_data, path, @opts)
             next unless components_request_body_object.generate?
 
             components_request_body_doc = components_request_body_object.to_doc

data/lib/r2-oas/schema/v3/object/{external_document_object.rb → from_routes/external_document_object.rb}

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require_relative 'base_object'
 
 module R2OAS
   module Schema
     module V3
-      class ExternalDocumentObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
+      class ExternalDocumentObject < BaseObject
+        def to_doc
+          create_doc
+          doc
+        end
+
+        private
+
         def create_doc
           result = {
             'description' => '',

data/lib/r2-oas/schema/v3/object/{info_object.rb → from_routes/info_object.rb}

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require_relative 'base_object'
 
 module R2OAS
   module Schema
     module V3
-      class InfoObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
+      class InfoObject < BaseObject
+        def to_doc
+          create_doc
+          doc
+        end
+
+        private
+
         def create_doc
           result = {
             'title' => 'OAS API Document Title',

data/lib/r2-oas/schema/v3/object/{openapi_object.rb → from_routes/openapi_object.rb}

@@ -3,20 +3,24 @@
 require_relative 'base_object'
 require_relative 'tag_object'
 require_relative 'server_object'
+require_relative 'info_object'
+require_relative 'external_document_object'
+require_relative 'components_object'
+require_relative 'paths_object'
 
 module R2OAS
   module Schema
     module V3
       class OpenapiObject < BaseObject
-        def initialize(routes_data, tags_data, schemas_data)
-          super()
-          @routes_data  = routes_data
-          @tags_data    = tags_data
+        def initialize(routes_data, tags_data, schemas_data, opts = {})
+          super(opts)
+          @routes_data = routes_data
+          @tags_data = tags_data
           @schemas_data = schemas_data
         end
 
         def to_doc
-          {
+          result = {
             'openapi' => '3.0.0',
             'info' => info_doc,
             'tags' => tags_doc,
@@ -25,32 +29,33 @@ module R2OAS
             'servers' => servers_doc,
             'components' => components_doc
           }
+          doc.merge!(result)
         end
 
         private
 
         def info_doc
-          info_object_class.new.to_doc
+          InfoObject.new(@opts).to_doc
         end
 
         def tags_doc
-          TagObject.new(@tags_data).to_doc
+          TagObject.new(@tags_data, @opts).to_doc
         end
 
         def paths_doc
-          paths_object_class.new(@routes_data).to_doc
+          PathsObject.new(@routes_data, @opts).to_doc
         end
 
         def external_docs_doc
-          external_document_object_class.new.to_doc
+          ExternalDocumentObject.new(@opts).to_doc
         end
 
         def servers_doc
-          ServerObject.new.to_doc
+          ServerObject.new(@opts).to_doc
         end
 
         def components_doc
-          components_object_class.new(@routes_data).to_doc
+          ComponentsObject.new(@routes_data, @opts).to_doc
         end
       end
     end

data/lib/r2-oas/schema/v3/object/{path_item_object.rb → from_routes/path_item_object.rb}

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
 require 'r2-oas/routing/components/path_component'
+require_relative 'base_object'
+require_relative 'components/schema_object'
+require_relative 'components/request_body_object'
 
 module R2OAS
   module Schema
     module V3
-      class PathItemObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
+      class PathItemObject < BaseObject
         extend Forwardable
         # reference
         # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#path-item-object
@@ -16,8 +18,8 @@ module R2OAS
 
         def_delegators :@http_status_manager, :http_statuses
 
-        def initialize(route_data, path)
-          super()
+        def initialize(route_data, path, opts = {})
+          super(opts)
           @path_comp                      = Routing::PathComponent.new(path)
           @path                           = @path_comp.symbol_to_brace
           @route_data                     = route_data
@@ -27,15 +29,13 @@ module R2OAS
           @required_parameters            = route_data[:required_parameters]
           @format_name                    = create_format_name
           @http_status_manager            = HttpStatusManager.new(@path, @verb, http_statuses_when_http_method)
-          @components_schema_object       = components_schema_object_class.new(route_data, path)
-          @components_request_body_object = components_request_body_object_class.new(route_data, path)
+          @components_schema_object       = Components::SchemaObject.new(route_data, path, opts)
+          @components_request_body_object = Components::RequestBodyObject.new(route_data, path, opts)
           support_field_name? if route_data.key?(:verb)
         end
 
         def to_doc
-          execute_before_create(@path)
           create_doc
-          execute_after_create(@path)
           doc
         end
 

data/lib/r2-oas/schema/v3/object/{paths_object.rb → from_routes/paths_object.rb}

@@ -1,22 +1,28 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require 'r2-oas/routing/components/path_component'
+require_relative 'base_object'
+require_relative 'path_item_object'
 
 module R2OAS
   module Schema
     module V3
-      class PathsObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
-        def initialize(routes_data)
-          super()
+      class PathsObject < BaseObject
+        def initialize(routes_data, opts = {})
+          super(opts)
           @routes_data = routes_data
-          define_hookable_tmp_object_class
+        end
+
+        def to_doc
+          create_doc
+          doc
         end
 
         def create_doc
           if unit_paths_file_path.present?
             unit_paths_data = YAML.load_file(unit_paths_file_path)['paths']
             result = unit_paths_data.each_with_object({}) do |(path, path_item_doc), docs|
-              docs[path] = HookableTmpObjectClass.new(path_item_doc, path).to_doc
+              docs[path] = PathItemObject.new(path_item_doc, path, @opts).to_doc
             end
           else
             result = path_item_docs.each_with_object({}) do |(path, path_item_doc), docs|
@@ -28,29 +34,6 @@ module R2OAS
 
         private
 
-        def define_hookable_tmp_object_class
-          klass = Class.new(path_item_object_class) do |_c|
-            def initialize(data, path)
-              super
-              @data = data
-              @path = path
-              use_superclass_hook
-            end
-
-            def create_doc
-              doc.merge!(@data)
-            end
-
-            def to_doc
-              execute_before_create(@path)
-              create_doc
-              execute_after_create(@path)
-              doc
-            end
-          end
-          Object.const_set(:HookableTmpObjectClass, klass) unless defined?(HookableTmpObjectClass)
-        end
-
         def path_item_docs
           # e.x.)
           # [
@@ -60,7 +43,7 @@ module R2OAS
             path = route_el[:path]
             route_data = route_el[:data]
 
-            path_item_doc = path_item_object_class.new(route_data, path).to_doc
+            path_item_doc = PathItemObject.new(route_data, path, @opts).to_doc
             if data[path].present?
               data[path].merge!(path_item_doc)
             else