r2-oas 0.1.0

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'base_analyzer'
+require 'r2-oas/schema/v3/manager/file_manager'
+require 'r2-oas/schema/v3/manager/diff/tag_diff_manager'
+
+# Scope Rails
+module R2OAS
+  module Schema
+    module V3
+      class TagAnalyzer < BaseAnalyzer
+        def initialize(after_schema_data, options = {})
+          super({}, after_schema_data, options)
+          @file_manager = FileManager.new('tags', :relative)
+          before_schema_data = @file_manager.load_data
+          @diff_manager = TagDiffManager.new(before_schema_data, after_schema_data)
+        end
+
+        def analyze_docs
+          save_file_path = @file_manager.save_file_path
+          case @type
+          when :edited
+            @diff_manager.process_by_using_diff_data do |after_edited_data|
+              @file_manager.save(after_edited_data.to_yaml)
+              logger.info "  Write schema file: \t#{save_file_path}"
+            end
+          when :existing
+            result = @diff_manager.after_target_data
+            @file_manager.save(result.to_yaml)
+            logger.info "  Write schema file: \t#{save_file_path}"
+          else
+            raise NoImplementError
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+
+# Scope Rails
+module R2OAS
+  module Schema
+    module V3
+      class Base < ::R2OAS::Schema::Base
+        SUPPORT_COMPONENTS_OBJECTS = %w[
+          schemas
+          requestBodies
+          securitySchemes
+          parameters
+          responses
+          examples
+          headers
+          links
+          callbacks
+        ].freeze
+
+        def support_components_objects
+          SUPPORT_COMPONENTS_OBJECTS
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'cleaner/base_cleaner'
+require_relative 'cleaner/components_cleaner'
+
+module R2OAS
+  module Schema
+    module V3
+      class Cleaner < BaseCleaner
+        def clean_docs
+          logger.info '[Clean OAS file] start'
+          components_cleaner = ComponentsCleaner.new(@options)
+          components_cleaner.clean_docs
+          logger.info '[Clean OAS file] end'
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/cleaner/base_cleaner.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'r2-oas/schema/v3/base'
+require 'r2-oas/schema/v3/manager/file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseCleaner < Base
+        def clean_docs
+          clean_target_files.each do |file_path|
+            file_manager = FileManager.new(file_path, :full)
+            file_manager.delete
+            yield file_manager.save_file_path if block_given?
+          end
+        end
+
+        private
+
+        def many_paths_file_paths
+          Dir.glob("#{schema_save_dir_path}/paths/**/**.yml")
+        end
+
+        def clean_target_files
+          raise 'Please implement in inherited class.'
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/cleaner/components_cleaner.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'base_cleaner'
+require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class ComponentsCleaner < BaseCleaner
+        def initialize(options = {})
+          super
+          @components_file_paths = Dir.glob("#{schema_save_dir_path}/components/**/**.yml")
+          @security_schemes_paths = Dir.glob("#{schema_save_dir_path}/components/securitySchemes/**/**.yml")
+        end
+
+        def clean_docs
+          logger.info '[Clean OAS file (components)] start'
+          super do |file_path|
+            logger.info "  Delete schema file: \t#{file_path}"
+          end
+          logger.info '[Clean OAS file (components)] end'
+        end
+
+        private
+
+        def clean_target_files
+          used_file_paths = many_paths_file_paths.each_with_object([]) do |unit_paths_path, result|
+            file_manager = PathItemFileManager.new(unit_paths_path, :full)
+            components_file_paths_at_path = file_manager.descendants_ref_paths
+            result.push(*components_file_paths_at_path)
+          end.uniq
+
+          all_file_paths - used_file_paths
+        end
+
+        def all_file_paths
+          (@components_file_paths - @security_schemes_paths).uniq
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'forwardable'
+require 'r2-oas/routing/parser'
+require_relative 'generator/doc_generator'
+require_relative 'generator/base_generator'
+
+module R2OAS
+  module Schema
+    module V3
+      class Generator < BaseGenerator
+        extend Forwardable
+
+        def_delegators :@doc_generator, :oas_doc
+
+        def initialize(options = {})
+          super
+          @doc_generator = DocGenerator.new(options)
+        end
+
+        def generate_docs
+          @doc_generator.generate_docs
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'r2-oas/schema/v3/base'
+require 'r2-oas/routing/parser'
+require 'r2-oas/schema/v3/object/openapi_object'
+require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseGenerator < Base
+        include Sortable
+
+        def initialize(options = {})
+          super
+          @glob_schema_paths = create_glob_schema_paths
+        end
+
+        private
+
+        attr_accessor :unit_paths_file_path
+        attr_accessor :skip_generate_docs
+        attr_accessor :skip_load_dot_paths
+
+        # Scope Rails
+        def create_docs
+          all_routes = create_all_routes
+          parser = Routing::Parser.new(all_routes)
+
+          routes_data = parser.routes_data
+          tags_data = parser.tags_data
+          schemas_data = parser.schemas_data
+
+          Schema::V3::OpenapiObject.new(routes_data, tags_data, schemas_data).to_doc
+        end
+
+        def create_all_routes
+          ::Rails.application.reload_routes!
+          ::Rails.application.routes.routes
+        end
+
+        def schema_file_do_not_exists?
+          schema_files_paths.count == 0
+        end
+
+        def create_glob_schema_paths
+          exclude_paths_regexp_paths               = ["#{schema_save_dir_path}/**.yml"]
+          paths_regexp_paths                       = ["#{schema_save_dir_path}/paths/**/**.yml"]
+          components_schemas_regexp_paths          = ["#{schema_save_dir_path}/components/**/**.yml"]
+          components_security_schemes_regexp_paths = ["#{schema_save_dir_path}/components/securitySchemes/**/**.yml"]
+
+          if exists_paths_files?
+            # components/securitySchemes is not referenced in $ ref.
+            exclude_paths_regexp_paths + many_paths_file_paths + many_components_file_paths + components_security_schemes_regexp_paths
+          else
+            exclude_paths_regexp_paths + paths_regexp_paths + components_schemas_regexp_paths
+          end
+        end
+
+        def schema_files_paths
+          Dir.glob(@glob_schema_paths)
+        end
+
+        def many_paths_file_paths
+          if unit_paths_file_path.present? && !skip_load_dot_paths
+            [unit_paths_file_path]
+          elsif !unit_paths_file_path.present? && !skip_load_dot_paths && paths_config.all_load_paths?
+            paths_config.many_paths_file_paths
+          else
+            Dir.glob("#{schema_save_dir_path}/paths/**/**.yml")
+          end
+        end
+
+        def many_components_file_paths
+          @many_components_file_paths ||= many_paths_file_paths.each_with_object([]) do |unit_paths_path, result|
+            file_manager = PathItemFileManager.new(unit_paths_path, :full)
+            components_file_paths_at_path = file_manager.descendants_ref_paths
+            result.push(*components_file_paths_at_path)
+          end.uniq
+        end
+
+        def exists_paths_files?
+          Dir.glob("#{schema_save_dir_path}/paths/**/**.yml").present?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# 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
+            if components_objects_file_do_not_exists?
+              logger.info ' <From routes data>'
+              generate_docs_from_routes_data
+            else
+              logger.info ' <From schema files>'
+              generate_docs_from_schema_fiels
+            end
+          end
+
+          private
+
+          alias components_objects_files_paths schema_files_paths
+          alias components_objects_file_do_not_exists? schema_file_do_not_exists?
+
+          def generate_docs_from_schema_fiels
+            components_schemas_from_schema_files = components_objects_files_paths.each_with_object({}) do |path, data|
+              yaml = YAML.load_file(path)
+              data.deep_merge!(yaml)
+              full_path = File.expand_path(path, './')
+              logger.info "  Fetch Components schema file: \t#{full_path}"
+            end
+            @components_objects.deep_merge!(components_schemas_from_schema_files[@major_category][@middle_category])
+
+            process_when_generate_docs do |save_file_path|
+              logger.info "  Merge schema file: \t#{save_file_path}"
+            end
+          end
+
+          def generate_docs_from_routes_data
+            process_when_generate_docs do |save_file_path|
+              logger.info "  Write schema file: \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)
+              file_manager.save(result.to_yaml) unless file_manager.skip_save?
+
+              yield file_manager.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)
+              file_manager.save(result.to_yaml) unless file_manager.skip_save?
+
+              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)
+                unless file_manager.skip_save?
+                  result = data['has_one']['data']
+                  file_manager.save(result.to_yaml)
+                end
+              end
+
+              yield file_manager.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