r2-oas 0.4.0

data/lib/r2-oas/schema/v3/object/from_files/paths_object.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base_object'
+require_relative 'path_item_object'
+
+module R2OAS
+  module Schema
+    module V3
+      module FromFiles
+        class PathsObject < BaseObject
+          def initialize(doc, opts = {})
+            super(opts)
+            @doc = doc
+          end
+
+          def to_doc
+            create_doc
+            @doc
+          end
+
+          private
+
+          def create_doc
+            @doc.each do |path, doc_when_path|
+              ref = { path: path }
+              @doc[path] = PathItemObject.new(doc_when_path, ref, opts).to_doc
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/object/from_files/utils/all.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'deep_methods'
+require_relative 'refs'

data/lib/r2-oas/schema/v3/object/from_files/utils/deep_methods.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module Schema
+    module V3
+      module FromFiles
+        module DeepMethods
+          def deep_replace!(data, target, &blk)
+            return unless data.is_a?(Hash)
+
+            data.each do |key, value|
+              if key.eql? target
+                # MEMO:
+                # When using the same schema, it has already been replaced by an object
+                if value.is_a?(String)
+                  data[key] = block_given? ? yield(value) : value
+                end
+              else
+                deep_replace!(value, target, &blk)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/object/from_files/utils/refs.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'r2-oas/errors'
+
+module R2OAS
+  module Schema
+    module V3
+      module FromFiles
+        class BaseRef
+          def pretty_print(q)
+            pp_hash(q, to_h)
+          end
+
+          attr_reader :parent
+
+          def []=(key, value)
+            if writable_keys.include?(key)
+              send(:"#{key}=", value)
+              value
+            else
+              display_key = key.is_a?(Symbol) ? ":#{key}" : key
+              raise ::R2OAS::RefInvalidAssignment, "invalid method `[#{display_key}]=' called for #{self}"
+            end
+          end
+
+          def [](key)
+            send(key)
+          end
+
+          def to_h
+            valid_keys.each_with_object({}) do |key, result|
+              result[key] = send(key)
+            end
+          end
+
+          private
+
+          # MEMO:
+          # https://apidock.com/ruby/v1_9_3_392/PP/PPMethods/pp_hash
+          def pp_hash(q, obj)
+            q.group(1, '{', '}') do
+              q.seplist(obj, nil, :each_pair) do |k, v|
+                q.group do
+                  q.pp k
+                  q.text '=>'
+                  q.group(1) do
+                    q.breakable ''
+                    q.pp v
+                  end
+                end
+              end
+            end
+          end
+
+          def build(ref_or_data, merge_data = {})
+            data = ref_or_data.to_h.merge(merge_data)
+            data.keys.each do |key|
+              instance_variable_set(:"@#{key}", data[key])
+            end
+
+            @parent = ref_or_data if ref_or_data.respond_to?(:parent)
+          end
+
+          attr_writer :parent
+
+          def valid_keys
+            raise NoImplementError, 'Please implement in inherited class.'
+          end
+
+          def writable_keys
+            raise NoImplementError, 'Please implement in inherited class.'
+          end
+        end
+
+        class PathRef < BaseRef
+          VALID_KEYS = %i[type path].freeze
+
+          attr_reader(*VALID_KEYS)
+
+          def initialize(data)
+            build(data, { type: :path_item })
+          end
+
+          private
+
+          attr_writer(*VALID_KEYS)
+
+          def valid_keys
+            VALID_KEYS
+          end
+
+          def writable_keys
+            []
+          end
+        end
+
+        module Components
+          class SchemaRef < BaseRef
+            READONLY_KEYS = %i[type path parent_schema_name depth tag_name verb http_status from].freeze
+            WRITABLE_KEYS = [:schema_name].freeze
+            VALID_KEYS = READONLY_KEYS + WRITABLE_KEYS
+
+            attr_reader(*VALID_KEYS)
+            attr_writer(*WRITABLE_KEYS)
+
+            def initialize(ref_or_data)
+              build(ref_or_data, { type: :schema })
+            end
+
+            private
+
+            attr_writer(*READONLY_KEYS)
+
+            def valid_keys
+              VALID_KEYS
+            end
+
+            def writable_keys
+              WRITABLE_KEYS
+            end
+          end
+
+          class RequestBodyRef < BaseRef
+            READONLY_KEYS = %i[type path parent_schema_name depth tag_name verb from].freeze
+            WRITABLE_KEYS = [:schema_name].freeze
+            VALID_KEYS = READONLY_KEYS + WRITABLE_KEYS
+
+            attr_accessor(*VALID_KEYS)
+            attr_writer(*WRITABLE_KEYS)
+
+            def initialize(ref_or_data)
+              build(ref_or_data, { type: :request_body })
+            end
+
+            private
+
+            attr_writer(*READONLY_KEYS)
+
+            def valid_keys
+              VALID_KEYS
+            end
+
+            def writable_keys
+              WRITABLE_KEYS
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# 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
+
+          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
+          @use_object_classes[:info_object]
+        end
+
+        def paths_object_class
+          @use_object_classes[:paths_object]
+        end
+
+        def path_item_object_class
+          @use_object_classes[:path_item_object]
+        end
+
+        def external_document_object_class
+          @use_object_classes[:external_document_object]
+        end
+
+        def components_object_class
+          @use_object_classes[:components_object]
+        end
+
+        def components_schema_object_class
+          @use_object_classes[:components_schema_object]
+        end
+
+        def components_request_body_object_class
+          @use_object_classes[:components_request_body_object]
+        end
+
+        private
+
+        def app_configuration_options
+          R2OAS.app_configuration_options
+        end
+
+        def pluggable_configuration_options
+          R2OAS.pluggable_configuration_options
+        end
+
+        # Can not define attr_accessor for PluggableConfiguration::VALID_OPTIONS_KEYS.
+        # Because, PuggableConfiguration module is not loaded when this class is loaded.
+        attr_accessor *AppConfiguration::VALID_OPTIONS_KEYS
+
+        def to_doc
+          raise 'Implement Inherit Class'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+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::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, @opts)
+
+              unless child_file_manager.skip_save?
+                result = {
+                  'components' => {
+                    'schemas' => {
+                      _components_schema_name => schema_object.to_doc
+                    }
+                  }
+                }
+                doc.deep_merge!(
+                  'has_one' => {
+                    'type' => 'schema',
+                    'original_path' => child_file_manager.original_path,
+                    'data' => result
+                  }
+                )
+              end
+            end
+            execute_after_create(@schema_name)
+            doc
+          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 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
+
+          def _components_request_body_name
+            components_request_body_name(doc, @path_comp, @tag_name, @verb, @schema_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'r2-oas/dynamic/schema/v3/object/from_routes/hookable_base_object'
+
+module R2OAS
+  module Schema
+    module V3
+      module Components
+        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
+            execute_before_create(@schema_name)
+            create_doc
+            execute_after_create(@schema_name)
+            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',
+              'properties' => {
+                'id' => {
+                  'type' => 'integer',
+                  'format' => 'int64'
+                }
+              }
+            }
+            doc.merge!(result)
+          end
+
+          def _components_schema_name(http_status)
+            components_schema_name(doc, @path_comp, @tag_name, @verb, http_status, @schema_name)
+          end
+        end
+      end
+    end
+  end
+end