r2-oas 0.4.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(type: :relative)
+          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/builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'forwardable'
+require 'r2-oas/routing/parser'
+require_relative 'builder/doc_builder'
+require_relative 'builder/base_builder'
+
+module R2OAS
+  module Schema
+    module V3
+      class Builder < BaseBuilder
+        extend Forwardable
+
+        def_delegators :@doc_builder, :oas_doc, :pure_oas_doc
+
+        def initialize(options = {})
+          super
+          @doc_builder = DocBuilder.new(options)
+        end
+
+        def build_docs
+          @doc_builder.build_docs
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'r2-oas/schema/v3/base'
+require 'r2-oas/routing/parser'
+require 'r2-oas/schema/v3/object/from_routes/openapi_object'
+require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseBuilder < Base
+        include Sortable
+
+        def initialize(opts = {})
+          super
+
+          opts.keys.each do |key|
+            send("#{key}=", opts[key])
+          end
+
+          @opts = opts
+          @glob_schema_paths = create_glob_schema_paths
+        end
+
+        private
+
+        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
+        end
+
+        def create_glob_schema_paths
+          exclude_paths_regexp_paths               = ["#{schema_save_dir_path}/**.yml"]
+          components_security_schemes_regexp_paths = ["#{schema_save_dir_path}/components/securitySchemes/**/**.yml"]
+
+          # components/securitySchemes is not referenced in $ ref.
+          exclude_paths_regexp_paths + many_paths_file_paths + many_components_file_paths + components_security_schemes_regexp_paths
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+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, :pure_oas_doc
+
+        def initialize(opts = {})
+          super
+        end
+
+        def build_docs
+          logger.info '[Build OAS schema files] start'
+          logger.info '[Build OAS docs from schema files] start'
+          build_docs_from_schema_files
+          logger.info '[Build OAS docs from schema files] end'
+          logger.info '[Build OAS schema files] end'
+        end
+
+        private
+
+        def build_docs_from_schema_files
+          result_before_squeeze = schema_files_paths.each_with_object({}) do |path, data|
+            file_manager = FileManager.new(path)
+            yaml = YAML.load_file(path)
+            data.deep_merge!(yaml)
+            logger.info " Use schema file: \t#{file_manager.save_file_path(type: :relative)}"
+          end
+
+          result = if many_paths_file_paths.present?
+                     Squeezer.new(result_before_squeeze, many_paths_file_paths: many_paths_file_paths).squeeze_docs
+                   else
+                     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(output? ? output_path : doc_save_file_path, result.to_yaml)
+        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(type: :relative) 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,24 @@
+# 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, :generate_docs
+
+        def initialize(options = {})
+          super
+          @doc_generator = DocGenerator.new(options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'r2-oas/schema/v3/base'
+require 'r2-oas/routing/parser'
+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'
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseGenerator < Base
+        include Sortable
+
+        def initialize(options = {})
+          super
+
+          options.keys.each do |key|
+            send("#{key}=", options[key])
+          end
+
+          @store = ::R2OAS::Store.create(:schema)
+          @glob_schema_paths = create_glob_schema_paths
+        end
+
+        private
+
+        attr_accessor :unit_paths_file_path
+        attr_accessor :skip_load_dot_paths
+        attr_accessor :is_create_cache
+        attr_accessor :store
+
+        # 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
+
+        def cache_docs
+          if exists_cache?
+            result = IO.binread(abs_cache_docs_path)
+            inflate = Zlib::Inflate.inflate(result)
+            @cache_docs ||= Marshal.load(inflate)
+          else
+            @cache_docs ||= {}
+          end
+        end
+
+        def exists_cache?
+          FileTest.exists?(abs_cache_docs_path)
+        end
+
+        def abs_cache_docs_path
+          File.expand_path(relative_cahe_docs_path)
+        end
+
+        def relative_cahe_docs_path
+          "#{@root_dir_path}/.docs"
+        end
+
+        def unknown_paths_path
+          "#{@root_dir_path}/src/paths/unknown.yml"
+        end
+      end
+    end
+  end
+end