r2-oas 0.3.1 → 0.4.1

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

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+require 'r2-oas/plugin/executor'
+
 module R2OAS
   module Schema
     module V3
       class BaseObject
-        def initialize(*_args)
+        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
@@ -12,6 +19,9 @@ module R2OAS
           PluggableConfiguration::VALID_OPTIONS_KEYS.each do |key|
             instance_variable_set(:"@#{key}", pluggable_configuration_options[key])
           end
+
+          @opts = opts
+          @plugin_executor = ::R2OAS::Plugin::Executor.new(@plugins, opts)
         end
 
         def info_object_class

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/dynamic/schema/v3/object/from_routes/hookable_base_object'
 require 'r2-oas/schema/v3/manager/file/components_file_manager'
 
 module R2OAS
   module Schema
     module V3
       module Components
-        class RequestBodyObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
-          def initialize(route_data, path)
-            super()
+        class RequestBodyObject < R2OAS::Dynamic::Schema::V3::HookableBaseObject
+          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_schema_object_class.new(@route_data, @path, @opts)
 
               unless child_file_manager.skip_save?
                 result = {
@@ -45,20 +49,6 @@ module R2OAS
             doc
           end
 
-          def create_doc
-            file_manager = ComponentsFileManager.new("#/components/schemas/#{_components_schema_name}", :ref)
-            doc.deep_merge!(
-              'content' => {
-                'application/json' => {
-                  'schema' => {
-                    '$ref' => file_manager.original_path
-                  }
-                }
-              }
-            )
-            yield if block_given?
-          end
-
           # MEMO:
           # please override in inherited class.
           def components_schema_name(_doc, _path_component, _tag_name, _verb, schema_name)
@@ -78,6 +68,20 @@ module R2OAS
 
           private
 
+          def create_doc
+            file_manager = ComponentsFileManager.new("#/components/schemas/#{_components_schema_name}", :ref)
+            doc.deep_merge!(
+              'content' => {
+                'application/json' => {
+                  'schema' => {
+                    '$ref' => file_manager.original_path
+                  }
+                }
+              }
+            )
+            yield if block_given?
+          end
+
           def _components_schema_name
             components_schema_name(doc, @path_comp, @tag_name, @verb, @schema_name)
           end

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

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require 'r2-oas/dynamic/schema/v3/object/from_routes/hookable_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::Dynamic::Schema::V3::HookableBaseObject
+          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
@@ -24,6 +28,14 @@ module R2OAS
             doc
           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 create_doc
             result = {
               'type' => 'object',
@@ -37,14 +49,6 @@ 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)
           end

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

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require 'r2-oas/dynamic/schema/v3/object/from_routes/hookable_base_object'
 require_relative 'components/schema_object'
 require_relative 'components/request_body_object'
 
 module R2OAS
   module Schema
     module V3
-      class ComponentsObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
-        def initialize(routes_data)
-          super()
+      class ComponentsObject < R2OAS::Dynamic::Schema::V3::HookableBaseObject
+        def initialize(routes_data, opts = {})
+          super(opts)
           @routes_data = routes_data
         end
 
@@ -40,12 +40,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 = path_item_object_class.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_schema_object_class.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 +60,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_request_body_object_class.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/from_routes/external_document_object.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'r2-oas/dynamic/schema/v3/object/from_routes/hookable_base_object'
+
+module R2OAS
+  module Schema
+    module V3
+      class ExternalDocumentObject < R2OAS::Dynamic::Schema::V3::HookableBaseObject
+        def to_doc
+          execute_before_create
+          create_doc
+          execute_after_create
+          doc
+        end
+
+        private
+
+        def create_doc
+          result = {
+            'description' => '',
+            'url' => ''
+          }
+          doc.merge!(result)
+        end
+      end
+    end
+  end
+end

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

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require 'r2-oas/dynamic/schema/v3/object/from_routes/hookable_base_object'
 
 module R2OAS
   module Schema
     module V3
-      class InfoObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
+      class InfoObject < R2OAS::Dynamic::Schema::V3::HookableBaseObject
+        def to_doc
+          execute_before_create
+          create_doc
+          execute_after_create
+          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}

@@ -8,15 +8,15 @@ 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 +25,33 @@ module R2OAS
             'servers' => servers_doc,
             'components' => components_doc
           }
+          result
         end
 
         private
 
         def info_doc
-          info_object_class.new.to_doc
+          info_object_class.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
+          paths_object_class.new(@routes_data, @opts).to_doc
         end
 
         def external_docs_doc
-          external_document_object_class.new.to_doc
+          external_document_object_class.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
+          components_object_class.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,13 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require 'r2-oas/dynamic/schema/v3/object/from_routes/hookable_base_object'
 require 'r2-oas/routing/components/path_component'
 
 module R2OAS
   module Schema
     module V3
-      class PathItemObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
+      class PathItemObject < R2OAS::Dynamic::Schema::V3::HookableBaseObject
         extend Forwardable
         # reference
         # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#path-item-object
@@ -16,8 +16,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,8 +27,8 @@ 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_schema_object_class.new(route_data, path, opts)
+          @components_request_body_object = components_request_body_object_class.new(route_data, path, opts)
           support_field_name? if route_data.key?(:verb)
         end
 

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

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+require 'r2-oas/dynamic/schema/v3/object/from_routes/hookable_base_object'
+require 'r2-oas/routing/components/path_component'
 
 module R2OAS
   module Schema
     module V3
-      class PathsObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
-        def initialize(routes_data)
-          super()
+      class PathsObject < R2OAS::Dynamic::Schema::V3::HookableBaseObject
+        def initialize(routes_data, opts = {})
+          super(opts)
           @routes_data = routes_data
           define_hookable_tmp_object_class
         end
@@ -16,7 +17,7 @@ module R2OAS
           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] = HookableTmpObjectClass.new(path_item_doc, path, @opts).to_doc
             end
           else
             result = path_item_docs.each_with_object({}) do |(path, path_item_doc), docs|
@@ -30,10 +31,11 @@ module R2OAS
 
         def define_hookable_tmp_object_class
           klass = Class.new(path_item_object_class) do |_c|
-            def initialize(data, path)
-              super
+            def initialize(data, path, opts = {})
+              super(opts)
               @data = data
               @path = path
+              @path_comp = Routing::PathComponent.new(path)
               use_superclass_hook
             end
 
@@ -45,6 +47,7 @@ module R2OAS
               execute_before_create(@path)
               create_doc
               execute_after_create(@path)
+              execute_transform_plugins(:path_item, doc, @path_comp)
               doc
             end
           end
@@ -60,7 +63,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 = path_item_object_class.new(route_data, path, @opts).to_doc
             if data[path].present?
               data[path].merge!(path_item_doc)
             else

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

@@ -7,7 +7,8 @@ module R2OAS
   module Schema
     module V3
       class TagObject < BaseObject
-        def initialize(tags_data)
+        def initialize(tags_data, opts = {})
+          super(opts)
           @tags_data = tags_data
         end
 

data/lib/r2-oas/schema/v3/object/store.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module Schema
+    module V3
+      class Store
+        attr_accessor :root_doc
+        attr_accessor :components_schema_name_list, :appended_components_schema_name_list
+        attr_accessor :components_request_body_name_list, :appended_components_request_body_name_list
+
+        def initialize(type = :obj)
+          @data = {}
+          @data['type'] = type
+          @data['data'] = {}
+          @root_doc = {}
+          @components_schema_name_list = []
+          @appended_components_schema_name_list = []
+          @components_request_body_name_list = []
+          @appended_components_request_body_name_list = []
+        end
+
+        def add(obj_type, key, value)
+          @data['data'][obj_type] ||= {}
+          # MEMO:
+          # Do not save the same thing in store by using unique contents for schema name
+          @data['data'][obj_type][key] ||= value
+        end
+
+        def gets(obj_type)
+          (@data['data'][obj_type] || {}).values.present? ? @data['data'][obj_type].values : []
+        end
+
+        class << self
+          extend Forwardable
+
+          def_delegators :instance, :add, :gets, :root_doc
+          def_delegators :instance, :components_schema_name_list, :appended_components_schema_name_list
+          def_delegators :instance, :components_request_body_name_list, :appended_components_request_body_name_list
+
+          def create(type = :obj)
+            instance(type)
+          end
+
+          private
+
+          def instance(type)
+            @instance ||= {}
+            @instance[type] ||= new(type)
+          end
+        end
+      end
+    end
+  end
+end