r2-oas 0.4.0

data/lib/r2-oas/schema/v3/generator/components/object_generator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'fileutils'
+require_relative '../base_generator'
+require 'r2-oas/schema/v3/manager/file/components_file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      module Components
+        class ObjectGenerator < BaseGenerator
+          def initialize(schema_data = {}, options = {})
+            super(options.except(:middle_category))
+            @major_category = 'components'
+            @middle_category = options[:middle_category]
+            sorted_schema_data = deep_sort(schema_data, @middle_category)
+            @components_objects = sorted_schema_data[@middle_category]
+            @glob_schema_paths = create_glob_components_objects_paths
+          end
+
+          def generate_docs
+            logger.info ' <From routes data>'
+            generate_docs_from_routes_data
+          end
+
+          private
+
+          alias components_objects_files_paths schema_files_paths
+
+          def generate_docs_from_routes_data
+            process_when_generate_docs do |save_file_path|
+              logger.info "  Add schema file into store: \t#{save_file_path}"
+            end
+          end
+
+          def process_when_generate_docs
+            logger.info " <Update Components schema files (#{@major_category}/#{@middle_category})>"
+            @components_objects&.each do |schema_name, data|
+              result = {
+                @major_category => {
+                  @middle_category => { schema_name.to_s => data }
+                }
+              }
+
+              relative_path = "#{@major_category}/#{@middle_category}/#{schema_name}"
+              file_manager = ComponentsFileManager.build(relative_path, :relative)
+              save_file_path = file_manager.save_file_path(type: :relative)
+              store.add(save_file_path, result.to_yaml)
+
+              yield save_file_path if block_given?
+            end
+          end
+
+          def create_glob_components_objects_paths
+            many_components_file_paths.select do |file_path|
+              file_path.include? "#{schema_save_dir_path}/#{@major_category}/#{@middle_category}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/generator/components/request_body_generator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'fileutils'
+require_relative 'object_generator'
+require 'r2-oas/schema/v3/manager/file/components_file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      module Components
+        class RequestBodyGenerator < ObjectGenerator
+          private
+
+          # override
+          def process_when_generate_docs
+            logger.info " <Update Components schema files (#{@major_category}/#{@middle_category})>"
+            @components_objects&.each do |schema_name, data|
+              result = {
+                @major_category => {
+                  @middle_category => { schema_name.to_s => data.slice('content') }
+                }
+              }
+
+              relative_path = "#{@major_category}/#{@middle_category}/#{schema_name}"
+              file_manager = ComponentsFileManager.build(relative_path, :relative)
+              save_file_path = file_manager.save_file_path(type: :relative)
+              store.add(save_file_path, result.to_yaml)
+
+              if data.key?('has_one') && data['has_one']['type'].eql?('schema')
+                original_path = data['has_one']['original_path']
+                file_manager = ComponentsFileManager.new(original_path, :ref)
+                result = data['has_one']['data']
+                save_file_path = file_manager.save_file_path(type: :relative)
+                store.add(save_file_path, result.to_yaml)
+              end
+
+              yield save_file_path if block_given?
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'base_generator'
+require_relative 'components/object_generator'
+require_relative 'components/request_body_generator'
+
+module R2OAS
+  module Schema
+    module V3
+      class ComponentsGenerator < BaseGenerator
+        def initialize(schema_data = {}, options = {})
+          super(options)
+          @components = schema_data['components'] || scehma_data[:components]
+          @options = options
+        end
+
+        def generate_docs
+          support_components_objects.each do |object_name|
+            generator_class(object_name).new(@components, @options.merge(
+                                                            middle_category: object_name
+                                                          )).generate_docs
+          end
+        end
+
+        private
+
+        def generator_class(object_name)
+          case object_name
+          when 'requestBodies'
+            Components::RequestBodyGenerator
+          else
+            Components::ObjectGenerator
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+require 'r2-oas/errors'
+require 'r2-oas/lib/three-way-merge/twm'
+require 'r2-oas/schema/v3/manager/file_manager'
+require_relative 'base_generator'
+require_relative 'schema_generator'
+
+module R2OAS
+  module Schema
+    module V3
+      class DocGenerator < BaseGenerator
+        def initialize(options = {})
+          super
+          @schema_generator = SchemaGenerator.new(options)
+        end
+
+        def generate_docs
+          logger.info '[Generate OAS schema files] start'
+          @schema_generator.generate_docs
+          save_schemas_from_store
+          logger.info '[Generate OAS schema files] end'
+        end
+
+        private
+
+        def save_schemas_from_store
+          local_store = ::R2OAS::Store.new(cache_docs)
+
+          # Check checksum
+          unless local_store.checksum?
+            raise R2OAS::ChecksumError, <<-ERR
+
+              Invalid file: #{relative_cahe_docs_path}
+              Please delete #{relative_cahe_docs_path} and execute the following command again.
+
+              CACHE_DOCS=true bundle exec rake routes:oas:docs
+            ERR
+          end
+
+          save_diff_schemas_from(local_store)
+        end
+
+        def save_diff_schemas_from(local_store)
+          local_sha1s = local_store.data['data'].keys
+          global_sha1s = store.data['data'].keys
+
+          # Maake diff sha1s
+          new_sha1s, after_sha1s, before_sha1s = nil
+          if exists_cache?
+            after_sha1s = global_sha1s - local_sha1s
+            before_sha1s = local_sha1s - global_sha1s
+          else
+            new_sha1s = global_sha1s - local_sha1s
+          end
+
+          # Make diff store
+          new_store = store.dup_slice(*new_sha1s)
+          after_store = store.dup_slice(*after_sha1s)
+          before_store = local_store.dup_slice(*before_sha1s)
+
+          is_exists_cache = exists_cache?
+          if is_exists_cache || schema_file_do_not_exists?
+            unless is_create_cache
+              # First try
+              if new_store&.exists?
+                new_store.save do |save_path|
+                  logger.info "  Write schema file: \t#{save_path}"
+                end
+              end
+
+              # Change routing
+              after_store.diff_from(before_store) do |analyze_data|
+                analyze_data.each do |file_path, data|
+                  left = data['after']
+                  orig = data['before']
+                  right = FileManager.new(file_path, :full).load_data
+                  merged3 =  Twm.yaml_merge(left, orig, right)
+                  analyzer = Analyzer.new({}, merged3, type: :edited)
+                  analyzer.analyze_docs
+                end
+              end
+
+              # TODO: Fix Bugs
+              # Delete paths/unknown.yml
+              file_manager = FileManager.new(unknown_paths_path, :full)
+              file_manager.delete
+            end
+          else
+            unless is_create_cache || is_exists_cache
+              raise NoFileExistsError, <<-ERR
+
+                Can't find the file #{relative_cahe_docs_path}
+                Please execute the following command to create #{relative_cahe_docs_path}
+
+                CACHE_DOCS=true bundle exec rake routes:oas:docs
+              ERR
+            end
+          end
+
+          # Save docs cache
+          deflated_cache_docs = Zlib::Deflate.deflate(Marshal.dump(store.data))
+          IO.binwrite(abs_cache_docs_path, deflated_cache_docs)
+          if is_exists_cache
+            logger.info "[Generate OAS docs] Update cache at #{relative_cahe_docs_path}"
+          else
+            logger.info "[Generate OAS docs] Create cache at #{relative_cahe_docs_path}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'fileutils'
+require_relative 'base_generator'
+require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class PathGenerator < BaseGenerator
+        def initialize(schema_data = {}, options = {})
+          super(options)
+          sorted_schema_data = deep_sort(schema_data, 'paths')
+          @paths = sorted_schema_data['paths']
+          @glob_schema_paths = create_glob_paths_paths
+        end
+
+        def generate_docs
+          logger.info ' <From routes data>'
+          generate_docs_from_routes_data
+        end
+
+        private
+
+        alias paths_files_paths schema_files_paths
+
+        def generate_docs_from_routes_data
+          process_when_generate_docs do |save_file_path|
+            logger.info "  Add schema file into store: \t#{save_file_path}"
+          end
+        end
+
+        def process_when_generate_docs
+          logger.info ' <Update schema files (paths)>'
+          save_each_tags(@paths) do |tag_name, result|
+            relative_path = "paths/#{tag_name}"
+            file_manager = PathItemFileManager.new(relative_path, :relative)
+            save_file_path = file_manager.save_file_path(type: :relative)
+            store.add(save_file_path, result.to_yaml)
+
+            yield save_file_path if block_given?
+          end
+        end
+
+        def create_glob_paths_paths
+          if many_paths_file_paths.present? && !skip_load_dot_paths
+            many_paths_file_paths
+          else
+            ["#{schema_save_dir_path}/paths/**/**.yml"]
+          end
+        end
+
+        def unit_paths_data_group_by_tags(unit_paths_data)
+          unit_paths_data.each_with_object({}) do |(path, data_when_path), result|
+            data_when_path.each do |verb, data_when_verb|
+              tag_name = data_when_verb['tags'].first
+              result[tag_name] ||= {}
+              result[tag_name].deep_merge!(
+                'paths' => {
+                  path => {
+                    verb => data_when_verb
+                  }
+                }
+              )
+            end
+          end
+        end
+
+        def save_each_tags(unit_paths_data)
+          unit_paths_data_group_by_tags(unit_paths_data).each do |tag_name, result|
+            yield [tag_name, result] if block_given?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require_relative 'base_generator'
+require_relative 'path_generator'
+require_relative 'components_generator'
+require 'r2-oas/schema/v3/manager/file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class SchemaGenerator < BaseGenerator
+        def initialize(options = {})
+          super(options)
+          @docs = create_docs
+          @options = options
+        end
+
+        def generate_docs
+          logger.info '<From routes data>'
+          generate_docs_from_routes_data
+        end
+
+        private
+
+        def generate_docs_from_routes_data
+          process_when_generate_docs do |save_file_path|
+            logger.info " Add schema file into store: \t#{save_file_path}"
+          end
+        end
+
+        def process_when_generate_docs
+          logger.info '<Update schema files>'
+          @docs.each do |field_name, data|
+            result = { field_name.to_s => data }
+
+            case field_name
+            when 'paths'
+              logger.info ' [Generate OAS schema files (paths)] start'
+              PathGenerator.new(result, @options).generate_docs
+              logger.info ' [Generate OAS schema files (paths)] end'
+            when 'components'
+              logger.info ' [Generate OAS schema files (components)] start'
+              ComponentsGenerator.new(result, @options).generate_docs
+              logger.info ' [Generate OAS schema files (components)] end'
+            else
+              file_manager = FileManager.new(field_name, :relative)
+              save_file_path = file_manager.save_file_path(type: :relative)
+              store.add(save_file_path, result.to_yaml)
+
+              yield file_manager.save_file_path(type: :relative) if block_given?
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'base_diff_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseArrayDiffManager < BaseDiffManager
+        def initialize(before_schema_data, after_schema_data)
+          super
+          @major_category = 'base'
+          @judge_key      = ''
+        end
+
+        def process_by_using_diff_data
+          before_data_at_major         = @before_schema_data[@major_category]
+          after_data_at_major          = @after_schema_data[@major_category]
+          after_schema_data_grouped_by = schema_data_grouped_by_judge_key(after_data_at_major)
+
+          result = before_data_at_major.map do |data|
+            judge_name = data[@judge_key]
+            if judge_name.in? after_schema_data_grouped_by.keys
+              after_schema_data_grouped_by[judge_name]
+            else
+              data
+            end
+          end
+
+          yield schema_data_at(result) if block_given?
+        end
+
+        def after_target_data
+          schema_data_at(@after_schema_data[@major_category])
+        end
+
+        private
+
+        def schema_data_grouped_by_judge_key(arr)
+          arr.each_with_object({}) do |data, result|
+            result.deep_merge!(data[@judge_key] => data)
+          end
+        end
+
+        def schema_data_at(data)
+          {
+            @major_category => data
+          }
+        end
+
+        def to_boolean(diff)
+          if diff.present?
+            diff[@major_category].present?
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end