r2-oas 0.4.0

data/lib/r2-oas/schema/v3/manager/diff/base_diff_manager.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'easy_diff'
+require 'r2-oas/schema/v3/base'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseDiffManager < Base
+        include Sortable
+
+        def initialize(before_schema_data, after_schema_data)
+          @before_schema_data = before_schema_data
+          @after_schema_data  = after_schema_data
+        end
+
+        def process_by_using_diff_data
+          raise NoImplementError, 'Please implement in inherited class.'
+        end
+
+        private
+
+        def ensure_presence_or_blank(data)
+          data.present? ? data : {}
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/manager/diff/base_hash_diff_manager.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative 'base_diff_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseHashDiffManager < BaseDiffManager
+        include Sortable
+
+        def initialize(before_schema_data, after_schema_data)
+          super
+          @major_category     = 'base'
+          @middle_category    = 'middle'
+        end
+
+        def process_by_using_diff_data
+          before_target_data       = sorted_target_data(@before_schema_data)
+          before_target_data_names = before_target_data.keys.uniq
+          after_target_data        = sorted_target_data(@after_schema_data)
+          after_target_data_names  = after_target_data.keys.uniq
+          target_names             = (before_target_data_names + after_target_data_names).uniq
+
+          target_names.each do |target_name|
+            before_schema_data = schema_data_at(before_target_data, target_name)
+            after_schema_data = schema_data_at(after_target_data, target_name)
+
+            removed, added = before_schema_data.easy_diff(after_schema_data)
+            leftovers, = before_schema_data.easy_diff(removed)
+
+            is_removed   = to_boolean(removed, target_name)
+            is_added     = to_boolean(added, target_name)
+            is_leftovers = to_boolean(leftovers, target_name)
+
+            yield(target_name, is_removed, is_added, is_leftovers, after_schema_data) if block_given?
+          end
+
+          nil
+        end
+
+        private
+
+        def normalized(data)
+          if data.present?
+            data
+          elsif @middle_category.present?
+            { @major_category => { @middle_category => {} } }
+          else
+            { @major_category => {} }
+          end
+        end
+
+        def schema_data_at(data, key)
+          if @middle_category.present?
+            {
+              @major_category => {
+                @middle_category => {
+                  key => data.fetch(key, nil)
+                }
+              }
+            }
+          else
+            {
+              @major_category => {
+                key => data.fetch(key, nil)
+              }
+            }
+          end
+        end
+
+        def sorted_target_data(data)
+          data = ensure_presence_or_blank(data)
+
+          if @middle_category.present?
+            sorted_data = deep_sort(data[@major_category], @middle_category)
+            result = ensure_presence_or_blank(sorted_data[@middle_category])
+          else
+            sorted_data = deep_sort(data, @major_category)
+            result = ensure_presence_or_blank(sorted_data[@major_category])
+          end
+
+          result
+        end
+
+        def to_boolean(diff, target_name)
+          if diff.present?
+            diff.fetch(@major_category, nil)&.fetch(@middle_category, nil)&.fetch(target_name, nil).present?
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/manager/diff/components_diff_manager.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'base_hash_diff_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class ComponentsDiffManager < BaseHashDiffManager
+        def initialize(before_schema_data, after_schema_data, options = {})
+          super(before_schema_data, after_schema_data)
+          @major_category = 'components'
+          @middle_category = options[:middle_category]
+          @before_schema_data = normalized(before_schema_data)
+          @after_schema_data  = normalized(after_schema_data)
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/manager/diff/tag_diff_manager.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'base_array_diff_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class TagDiffManager < BaseArrayDiffManager
+        def initialize(before_schema_data, after_schema_data)
+          super
+          @major_category  = 'tags'
+          @judge_key       = 'name'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../pathname_manager'
+require 'r2-oas/schema/v3/base'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseFileManager < Base
+        attr_accessor :original_path
+
+        # e.x.) openapi_path = "#/components/schemas/Account"
+        def initialize(path, path_type = :full)
+          super()
+          @ext_name = :yml
+          @path_type = path_type
+          @original_path = path
+          @relative_save_file_path = PathnameManager.new(path, path_type).relative_save_file_path
+        end
+
+        def delete
+          File.delete(save_file_path) if FileTest.exists?(save_file_path)
+        end
+
+        def save(data)
+          abs_dir = File.dirname(save_file_path)
+          FileUtils.mkdir_p(abs_dir) unless FileTest.exists?(abs_dir)
+          File.write(save_file_path, data)
+        end
+
+        def save_after_deep_merge(data)
+          result = load_data.deep_merge(data)
+          save(result.to_yaml)
+        end
+
+        def save_file_path(type: :full)
+          file_path = File.expand_path(@relative_save_file_path)
+
+          case type
+          when :relative
+            file_path.sub(%r{^#{Dir.getwd}/?}, '')
+          else
+            file_path
+          end
+        end
+
+        def load_data
+          case @ext_name
+          when :yml
+            if FileTest.exists?(save_file_path)
+              YAML.load_file(save_file_path)
+            else
+              {}
+            end
+          else
+            raise NoSupportError, "Do not support @ext_name: #{@ext_name}"
+          end
+        end
+
+        def descendants_paths
+          []
+        end
+      end
+    end
+  end
+end

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,89 @@
+# 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)
+          case yaml
+          when Hash
+            yaml.each do |key, value|
+              process_deep_search_ref_recursive(key, value, &block)
+            end
+          # Support allOf/oneOf/anyOf
+          when 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,78 @@
+# 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
+            ext_name = File.extname(@path)
+            if ext_name.empty?
+              "#{@path}.#{@ext_name}"
+            else
+              @path
+            end
+          when :full
+            @path
+          else
+            raise NoSupportError, "Do not support path_type: #{@path_type}"
+          end
+        end
+      end
+    end
+  end
+end