r2-oas 0.1.0

data/lib/r2-oas/schema/v3/manager/file/components_file_manager.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'include_ref_base_file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class ComponentsFileManager < IncludeRefBaseFileManager
+        def initialize(path, path_type = :ref)
+          super
+          @path_type = path_type
+          @original_path = path
+          @recursive_search_class = self.class
+        end
+
+        def skip_save?
+          save_file_path.in? paths_config.many_components_file_paths
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/manager/file/include_ref_base_file_manager.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'base_file_manager'
+require_relative '../pathname_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class IncludeRefBaseFileManager < BaseFileManager
+        REF = '$ref'
+
+        def initialize(path, path_type = :ref)
+          super
+          @convert_underscore_to_slash = true
+          @parent_save_file_paths = []
+          @recursive_search_class = self.class
+        end
+
+        class << self
+          alias build new
+        end
+
+        def descendants_paths
+          results = []
+
+          deep_search_ref_recursive(load_data) do |relative_paths|
+            results.push(*relative_paths)
+          end
+
+          results.uniq
+        end
+        alias descendants_ref_paths descendants_paths
+
+        private
+
+        attr_accessor :parent_save_file_paths, :recursive_search_class
+
+        def deep_search_ref_recursive(yaml, &block)
+          if yaml.is_a?(Hash)
+            yaml.each do |key, value|
+              process_deep_search_ref_recursive(key, value, &block)
+            end
+          # Support allOf/oneOf/anyOf
+          elsif yaml.is_a?(Array)
+            yaml.each do |el|
+              next unless el.is_a?(Hash)
+
+              el.each do |key, value|
+                process_deep_search_ref_recursive(key, value, &block)
+              end
+            end
+          end
+        end
+
+        def process_deep_search_ref_recursive(ref_key_or_not, ref_value_or_not, &block)
+          # Don't pick up JSON Schema $ref
+          # e.x.)
+          #  $ref: { "type" => "string" }
+          if (ref_key_or_not.eql? REF) && ref_value_or_not.to_s.start_with?('#/')
+
+            # Avoid $ ref circular references
+            pm = PathnameManager.new(ref_value_or_not, :ref)
+            relative_save_file_path = pm.relative_save_file_path
+
+            if @parent_save_file_paths.include?(relative_save_file_path)
+              return
+            else
+              @parent_save_file_paths.push(relative_save_file_path)
+            end
+
+            child_file_manager = @recursive_search_class.build(ref_value_or_not, :ref)
+            child_load_data = child_file_manager.load_data
+
+            children_paths = []
+            deep_search_ref_recursive(child_load_data) do |children_path|
+              children_paths.push(*children_path)
+            end
+
+            results = [child_file_manager.save_file_path] + children_paths
+            yield results if block_given?
+          else
+            deep_search_ref_recursive(ref_value_or_not, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/manager/file/path_item_file_manager.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'include_ref_base_file_manager'
+require_relative 'components_file_manager'
+require_relative '../pathname_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class PathItemFileManager < IncludeRefBaseFileManager
+        def initialize(path, path_type = :ref)
+          super
+          @recursive_search_class = ComponentsFileManager
+        end
+
+        def skip_save?
+          save_file_path.in? paths_config.many_paths_file_paths
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/manager/file_manager.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'file/base_file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class FileManager < BaseFileManager
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/manager/pathname_manager.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'r2-oas/schema/v3/base'
+
+module R2OAS
+  module Schema
+    module V3
+      class PathnameManager < Base
+        # e.x.) path = "#/components/schemas/Account" (when path_type = :ref)
+        def initialize(path, path_type = :full)
+          super()
+          @ext_name = :yml
+          @path_type = path_type
+          @path = path
+        end
+
+        def object_type
+          case @path
+          when /schemas/
+            'schemas'
+          when /requestBodies/
+            'requestBodies'
+          when /securitySchemes/
+            'securitySchemes'
+          when /parameters/
+            'parameters'
+          when /responses/
+            'responses'
+          when /examples/
+            'examples'
+          when /headers/
+            'headers'
+          when /links/
+            'links'
+          when /callbacks/
+            'callbacks'
+          end
+        end
+
+        def relative_save_file_path
+          result = normalized_about_path_type
+          if (@path_type.in? %i[ref relative]) && support_components_objects.include?(object_type)
+            dirname = File.dirname(result)
+            basename = File.basename(result, '.yml')
+            basename = basename.gsub(ns_div, '/').underscore
+            "#{schema_save_dir_path}/#{dirname}/#{basename}.yml"
+          elsif @path_type.eql?(:relative) && !support_components_objects.include?(object_type)
+            "#{schema_save_dir_path}/#{result.underscore}"
+          elsif @path_type.eql?(:full)
+            result
+          else
+            "#{schema_save_dir_path}/#{result}"
+          end
+        end
+
+        private
+
+        def normalized_about_path_type
+          case @path_type
+          when :ref
+            "#{@path.gsub('#/', '')}.#{@ext_name}"
+          when :relative
+            "#{@path}.#{@ext_name}"
+          when :full
+            @path
+          else
+            raise NoSupportError, "Do not support path_type: #{@path_type}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseObject
+        def initialize(*_args)
+          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
+        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/components/request_body_object.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'r2-oas/plugins/schema/v3/object/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()
+            @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]
+          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)
+
+              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
+
+          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)
+            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)
+          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/components/schema_object.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'r2-oas/plugins/schema/v3/object/hookable_base_object'
+
+module R2OAS
+  module Schema
+    module V3
+      module Components
+        class SchemaObject < R2OAS::Plugins::Schema::V3::HookableBaseObject
+          def initialize(route_data, path)
+            super()
+            @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]
+          end
+
+          def to_doc
+            execute_before_create(@schema_name)
+            create_doc
+            execute_after_create(@schema_name)
+            doc
+          end
+
+          def create_doc
+            result = {
+              'type' => 'object',
+              'properties' => {
+                'id' => {
+                  'type' => 'integer',
+                  'format' => 'int64'
+                }
+              }
+            }
+            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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'r2-oas/plugins/schema/v3/object/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()
+          @routes_data = routes_data
+        end
+
+        def create_doc
+          create_doc_for_components_schemas!
+          create_doc_for_components_request_bodies!
+        end
+
+        private
+
+        def create_doc_for_components_schemas!
+          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)
+        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)
+        end
+
+        # e.x.)
+        # [
+        #  { path: "/tasks", data: {:verb=>"get", :path=>"/tasks", :tag_name=>"task" } },
+        # ]
+        def components_schema_docs
+          @routes_data.each_with_object({}) do |(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.http_statuses.each do |http_status|
+              components_schema_object = components_schema_object_class.new(route_data, path)
+              components_schema_doc = components_schema_object.to_doc
+              schema_name = components_schema_object.send(:_components_schema_name, http_status)
+
+              if data[schema_name].present?
+                data[schema_name].merge!(components_schema_doc)
+              else
+                data[schema_name] = components_schema_doc
+              end
+            end
+          end
+        end
+
+        def components_request_body_docs
+          @routes_data.each_with_object({}) do |(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)
+            next unless components_request_body_object.generate?
+
+            components_request_body_doc = components_request_body_object.to_doc
+            schema_name = components_request_body_object.send(:_components_request_body_name)
+            if data[schema_name].present?
+              data[schema_name].merge!(components_request_body_doc)
+            else
+              data[schema_name] = components_request_body_doc
+            end
+          end
+        end
+      end
+    end
+  end
+end