r2-oas 0.3.1 → 0.4.1

data/lib/r2-oas/plugin/public.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'transform/transform'

data/lib/r2-oas/plugin/transform/transform.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'r2-oas/plugin/transform/v3/transform'
+
+R2OAS::Plugin::Transform = case ::R2OAS.version
+                           when :v3
+                             R2OAS::Plugin::V3::Transform
+                           else
+                             raise NoImplementError, "Do not support version: #{::R2OAS.version}"
+  end

data/lib/r2-oas/plugin/transform/v3/transform.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'visitable'
+require 'r2-oas/plugin/base'
+
+module R2OAS
+  module Plugin
+    module V3
+      class Transform < ::R2OAS::Plugin::Base
+        extend Visitable
+
+        def self.inherited(base)
+          super
+          self.hook_klass = ::R2OAS::Hooks::Hook.register(:plugin, base)
+          base.type = :transform
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/plugin/transform/v3/visitable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'r2-oas/plugin/hookable'
+
+module R2OAS
+  module Plugin
+    module V3
+      module Visitable
+        include R2OAS::Plugin::Hookable
+
+        SCHEMA_OBJECTS = %i[
+          info
+          path_item
+          external_document
+          components_schema
+          components_request_body
+          components_schema_name
+          components_schema_name_at_request_body
+          components_request_body_name
+        ].freeze
+
+        SCHEMA_OBJECTS.each do |schema_name|
+          define_method schema_name.to_s do |&block|
+            return if block.blank?
+
+            callback = proc { |*args| block.call(*args) }
+            on(schema_name, callback)
+          end
+
+          define_method "execute_#{schema_name}" do |*args|
+            execute_hook(schema_name, *args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/public.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'r2-oas/configuration'
+require 'r2-oas/errors'
+require 'r2-oas/schema/v3/object/from_routes/public'

data/lib/r2-oas/schema/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../base'
+require 'r2-oas/base'
 
 # Scope Rails
 module R2OAS

data/lib/r2-oas/schema/builder.rb

@@ -8,7 +8,7 @@ module R2OAS
     class Builder
       extend Forwardable
 
-      def_delegators :@builder, :build_docs, :oas_doc
+      def_delegators :@builder, :build_docs, :oas_doc, :pure_oas_doc
 
       def initialize(options = {})
         case ::R2OAS.version

data/lib/r2-oas/schema/editor.rb

@@ -114,7 +114,14 @@ module R2OAS
         @browser ||= Watir::Browser.new(:chrome, capabilities)
         @browser.goto(url)
         if wait_for_loaded
-          @browser.driver.local_storage[storage_key] = @schema_doc_from_local
+          # MEMO:
+          # Because it may not be updated
+          # Make sure that the launched local storage is updated reliably
+          Watir::Wait.until do
+            old_storage = @browser.driver.local_storage[storage_key].dup
+            @browser.driver.local_storage[storage_key] = new_storage = @schema_doc_from_local
+            old_storage != new_storage
+          end
           @browser.refresh
         end
       end

data/lib/r2-oas/schema/v3/analyzer/path_analyzer.rb

@@ -3,7 +3,7 @@
 require_relative 'base_analyzer'
 require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
 require 'r2-oas/schema/v3/manager/file_manager'
-require 'r2-oas/schema/v3/object/tag_object'
+require 'r2-oas/schema/v3/object/from_routes/tag_object'
 
 # Scope Rails
 module R2OAS

data/lib/r2-oas/schema/v3/builder.rb

@@ -12,7 +12,7 @@ module R2OAS
       class Builder < BaseBuilder
         extend Forwardable
 
-        def_delegators :@doc_builder, :oas_doc
+        def_delegators :@doc_builder, :oas_doc, :pure_oas_doc
 
         def initialize(options = {})
           super

data/lib/r2-oas/schema/v3/builder/base_builder.rb

@@ -2,7 +2,7 @@
 
 require 'r2-oas/schema/v3/base'
 require 'r2-oas/routing/parser'
-require 'r2-oas/schema/v3/object/openapi_object'
+require 'r2-oas/schema/v3/object/from_routes/openapi_object'
 require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
 
 module R2OAS
@@ -11,8 +11,14 @@ module R2OAS
       class BaseBuilder < Base
         include Sortable
 
-        def initialize(options = {})
+        def initialize(opts = {})
           super
+
+          opts.keys.each do |key|
+            send("#{key}=", opts[key])
+          end
+
+          @opts = opts
           @glob_schema_paths = create_glob_schema_paths
         end
 
@@ -20,6 +26,12 @@ module R2OAS
 
         attr_accessor :unit_paths_file_path
         attr_accessor :skip_load_dot_paths
+        attr_accessor :opts
+        attr_accessor :use_plugin
+        attr_accessor :output
+
+        alias use_plugin? use_plugin
+        alias output? output
 
         def schema_file_do_not_exists?
           schema_files_paths.count == 0

data/lib/r2-oas/schema/v3/builder/doc_builder.rb

@@ -2,13 +2,18 @@
 
 require 'yaml'
 require 'fileutils'
+require 'r2-oas/schema/v3/object/from_files/openapi_object'
 require_relative 'base_builder'
 
 module R2OAS
   module Schema
     module V3
       class DocBuilder < BaseBuilder
-        attr_accessor :oas_doc
+        attr_accessor :oas_doc, :pure_oas_doc
+
+        def initialize(opts = {})
+          super
+        end
 
         def build_docs
           logger.info '[Build OAS schema files] start'
@@ -34,8 +39,11 @@ module R2OAS
                      result_before_squeeze
                   end
 
+          @pure_oas_doc = result.dup
+          rsult = FromFiles::OpenapiObject.new(result, opts).to_doc if use_plugin?
           @oas_doc = result
-          File.write(doc_save_file_path, result.to_yaml)
+
+          File.write(output? ? output_path : doc_save_file_path, result.to_yaml)
         end
       end
     end

data/lib/r2-oas/schema/v3/generator/base_generator.rb

@@ -2,7 +2,7 @@
 
 require 'r2-oas/schema/v3/base'
 require 'r2-oas/routing/parser'
-require 'r2-oas/schema/v3/object/openapi_object'
+require 'r2-oas/schema/v3/object/from_routes/openapi_object'
 require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
 require 'r2-oas/store'
 
@@ -14,7 +14,12 @@ module R2OAS
 
         def initialize(options = {})
           super
-          @store = Store.create
+
+          options.keys.each do |key|
+            send("#{key}=", options[key])
+          end
+
+          @store = ::R2OAS::Store.create(:schema)
           @glob_schema_paths = create_glob_schema_paths
         end
 

data/lib/r2-oas/schema/v3/generator/doc_generator.rb

@@ -27,7 +27,7 @@ module R2OAS
         private
 
         def save_schemas_from_store
-          local_store = Store.new(cache_docs)
+          local_store = ::R2OAS::Store.new(cache_docs)
 
           # Check checksum
           unless local_store.checksum?

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

@@ -36,12 +36,13 @@ module R2OAS
         attr_accessor :parent_save_file_paths, :recursive_search_class
 
         def deep_search_ref_recursive(yaml, &block)
-          if yaml.is_a?(Hash)
+          case yaml
+          when Hash
             yaml.each do |key, value|
               process_deep_search_ref_recursive(key, value, &block)
             end
           # Support allOf/oneOf/anyOf
-          elsif yaml.is_a?(Array)
+          when Array
             yaml.each do |el|
               next unless el.is_a?(Hash)
 

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'key_flatten'
+
+require 'r2-oas/plugin/executor'
+require 'r2-oas/schema/v3/object/store'
+
+module R2OAS
+  module Schema
+    module V3
+      module FromFiles
+        class BaseObject
+          extend Forwardable
+
+          class << self
+            def obj_store
+              ::R2OAS::Schema::V3::Store.create(:obj)
+            end
+          end
+
+          def_delegators :@plugin_executor, :execute_transform_plugins
+
+          def initialize(opts = {})
+            @opts = opts
+            plugins = app_configuration_options[:plugins]
+            @plugin_executor = ::R2OAS::Plugin::Executor.new(plugins, opts)
+          end
+
+          def to_doc
+            raise 'Implement Inherit Class'
+          end
+
+          private
+
+          def obj_store
+            self.class.obj_store
+          end
+
+          def set_root_doc(root_doc)
+            obj_store.root_doc = root_doc.dup
+          end
+
+          def root_doc
+            obj_store.root_doc
+          end
+
+          def set_components_name_list(root_doc)
+            obj_store.components_schema_name_list = (root_doc.fetch('components', nil)&.fetch('schemas', nil) || {}).keys.sort.uniq
+            obj_store.components_request_body_name_list = (root_doc.fetch('components', nil)&.fetch('schemas', nil) || {}).keys.sort.uniq
+          end
+
+          def app_configuration_options
+            R2OAS.app_configuration_options
+          end
+
+          attr_accessor :opts
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'r2-oas/shared/callable'
+require 'r2-oas/errors'
+require_relative '../base_object'
+require_relative 'schema_object'
+require_relative '../utils/all'
+
+module R2OAS
+  module Schema
+    module V3
+      module FromFiles
+        module Components
+          class RequestBodyObject < ::R2OAS::Schema::V3::FromFiles::BaseObject
+            include ::R2OAS::Callable
+            include DeepMethods
+
+            def initialize(doc, ref, opts)
+              super(opts)
+              @doc = doc
+              @parent_ref = Components::RequestBodyRef.new(ref)
+              resolve_dependencies!
+            end
+
+            def to_doc
+              call_ref_path!
+
+              # MEMO:
+              # If it is overwritten, it may lead to unexpected problems, so give a copy
+              execute_transform_plugins(:components_request_body, @doc, ref_dup)
+              @doc
+            end
+
+            def resolve_dependencies!
+              deep_replace!(@doc, '$ref') do |ref_path|
+                schema_obj, schema_type, pure_schema_name = ref_path.split('/').slice(1..-1)
+                schema_doc = root_doc&.fetch(schema_obj, nil)&.fetch(schema_type, nil)&.fetch(pure_schema_name, nil) || {}
+
+                ref = create_child_ref(pure_schema_name)
+                obj = Components::SchemaObject.new(schema_doc, ref, opts)
+
+                obj_store.add('components/schemas', pure_schema_name, obj)
+                obj
+              end
+            end
+
+            def call_ref_path!
+              callback = proc { |obj| obj.ref_path }
+              deep_call(@doc, '$ref', callback)
+            end
+
+            def schema_name
+              return @resolved_schema_name if @resolved_schema_name.present?
+
+              before_schema_name = ref_dup[:schema_name]
+
+              _ref_dup = ref_dup
+              execute_transform_plugins(:components_request_body_name, _ref_dup)
+              @resolved_schema_name = _ref_dup[:schema_name]
+
+              if before_schema_name != @resolved_schema_name
+                if reserved_schema_name_list.include?(@resolved_schema_name)
+                  raise DepulicateSchemaNameError, "Transformed schema name: '#{@resolved_schema_name}' cannot be used. It already exists."
+                else
+                  obj_store.appended_components_request_body_name_list.push(@resolved_schema_name)
+                end
+              end
+
+              @resolved_schema_name
+            end
+
+            def ref_path
+              "#/components/requestBodies/#{schema_name}"
+            end
+
+            private
+
+            def ref_dup
+              @parent_ref.dup
+            end
+
+            def reserved_schema_name_list
+              (
+                obj_store.components_request_body_name_list +
+                obj_store.appended_components_request_body_name_list
+              ).uniq
+            end
+
+            def create_child_ref(schema_name)
+              local_ref_hash = ref_dup.to_h
+              parent_schema_name = local_ref_hash[:schema_name]
+              depth = local_ref_hash[:depth] + 1
+              ref_data = local_ref_hash.merge({ from: :request_body, schema_name: schema_name, parent_schema_name: parent_schema_name, depth: depth })
+              ref = Components::SchemaRef.new(ref_data)
+              ref.send(:parent=, ref_dup)
+              ref
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'r2-oas/shared/callable'
+require 'r2-oas/errors'
+require_relative '../base_object'
+require_relative '../utils/all'
+
+module R2OAS
+  module Schema
+    module V3
+      module FromFiles
+        module Components
+          class SchemaObject < ::R2OAS::Schema::V3::FromFiles::BaseObject
+            include ::R2OAS::Callable
+            include DeepMethods
+
+            def initialize(doc, ref, opts)
+              super(opts)
+              @doc = doc
+              @parent_ref = Components::SchemaRef.new(ref)
+              resolve_dependencies!
+            end
+
+            def to_doc
+              call_ref_path!
+
+              # MEMO:
+              # If it is overwritten, it may lead to unexpected problems, so give a copy
+              execute_transform_plugins(:components_schema, @doc, ref_dup)
+              @doc
+            end
+
+            def resolve_dependencies!
+              deep_replace!(@doc, '$ref') do |ref_path|
+                schema_obj, schema_type, pure_schema_name = ref_path.split('/').slice(1..-1)
+                schema_doc = root_doc&.fetch(schema_obj, nil)&.fetch(schema_type, nil)&.fetch(pure_schema_name, nil) || {}
+
+                ref = create_child_ref(pure_schema_name)
+                obj = Components::SchemaObject.new(schema_doc, ref, opts)
+
+                obj_store.add('components/schemas', pure_schema_name, obj)
+                obj
+              end
+            end
+
+            def call_ref_path!
+              callback = proc { |obj| obj.ref_path }
+              deep_call(@doc, '$ref', callback)
+            end
+
+            def schema_name
+              return @resolved_schema_name if @resolved_schema_name.present?
+
+              before_schema_name = ref_dup[:schema_name]
+
+              _ref_dup = ref_dup
+              execute_transform_plugins(:components_schema_name, _ref_dup)
+              @resolved_schema_name = _ref_dup[:schema_name]
+
+              if before_schema_name != @resolved_schema_name
+                if reserved_schema_name_list.include?(@resolved_schema_name)
+                  raise DepulicateSchemaNameError, "Transformed schema name: '#{@resolved_schema_name}' cannot be used. It already exists."
+                else
+                  obj_store.appended_components_schema_name_list.push(@resolved_schema_name)
+                end
+              end
+
+              @resolved_schema_name
+            end
+
+            def ref_path
+              "#/components/schemas/#{schema_name}"
+            end
+
+            private
+
+            def ref_dup
+              @parent_ref.dup
+            end
+
+            def reserved_schema_name_list
+              (
+                obj_store.components_schema_name_list +
+                obj_store.appended_components_schema_name_list
+              ).uniq
+            end
+
+            def create_child_ref(schema_name)
+              local_ref_hash = ref_dup.to_h
+              parent_schema_name = local_ref_hash[:schema_name]
+              depth = local_ref_hash[:depth] + 1
+              ref_data = local_ref_hash.merge({ from: :schema, schema_name: schema_name, parent_schema_name: parent_schema_name, depth: depth })
+              ref = Components::SchemaRef.new(ref_data)
+              ref.send(:parent=, ref_dup)
+              ref
+            end
+          end
+        end
+      end
+    end
+  end
+end