r2-oas 0.1.3 → 0.2.0

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'r2-oas/schema/v3/builder'
+
+module R2OAS
+  module Schema
+    class Builder
+      extend Forwardable
+
+      def_delegators :@builder, :build_docs, :oas_doc
+
+      def initialize(options = {})
+        case ::R2OAS.version
+        when :v3
+          @builder = V3::Builder.new(options)
+        else
+          raise NoImplementError, "Do not support version: #{::R2OAS.version}"
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module R2OAS
     class Generator
       extend Forwardable
 
-      def_delegators :@generator, :generate_docs, :oas_doc
+      def_delegators :@generator, :generate_docs
 
       def initialize(options = {})
         case ::R2OAS.version

data/lib/r2-oas/schema/manager/file_manager.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'r2-oas/schema/v3/manager/file_manager'
+
+module R2OAS
+  module Schema
+    class FileManager
+      extend Forwardable
+
+      def_delegators :@manager, :save, :delete
+
+      def initialize(path, path_type = :ref)
+        case ::R2OAS.version
+        when :v3
+          @manager = V3::FileManager.new(path, path_type)
+        else
+          raise "Do not support version: #{::R2OAS.version}"
+        end
+      end
+
+      class << self
+        alias build new
+      end
+    end
+  end
+end

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

@@ -26,14 +26,13 @@ module R2OAS
 
         private
 
-        attr_accessor :edited_schema_file_path
         attr_accessor :existing_schema_file_path
         attr_accessor :type
 
         def create_after_schema_data
           case @type
           when :edited
-            create_after_schema_data_when_edited
+            {}
           when :existing
             if existing_schema_file_path.present?
               create_after_schema_data_when_specify_path
@@ -43,10 +42,6 @@ module R2OAS
           end
         end
 
-        def create_after_schema_data_when_edited
-          YAML.load_file(edited_schema_file_path)
-        end
-
         def create_after_schema_data_when_not_specify_path
           if FileTest.exists?(doc_save_file_path)
             YAML.load_file(doc_save_file_path)

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
+
+        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,60 @@
+# 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 BaseBuilder < 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_load_dot_paths
+
+        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,43 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+require_relative 'base_builder'
+
+module R2OAS
+  module Schema
+    module V3
+      class DocBuilder < BaseBuilder
+        attr_accessor :oas_doc
+
+        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
+
+          @oas_doc = result
+          File.write(doc_save_file_path, result.to_yaml)
+        end
+      end
+    end
+  end
+end

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

@@ -12,16 +12,12 @@ module R2OAS
       class Generator < BaseGenerator
         extend Forwardable
 
-        def_delegators :@doc_generator, :oas_doc
+        def_delegators :@doc_generator, :generate_docs
 
         def initialize(options = {})
           super
           @doc_generator = DocGenerator.new(options)
         end
-
-        def generate_docs
-          @doc_generator.generate_docs
-        end
       end
     end
   end

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

@@ -4,6 +4,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/manager/file/path_item_file_manager'
+require 'r2-oas/store'
 
 module R2OAS
   module Schema
@@ -13,14 +14,16 @@ module R2OAS
 
         def initialize(options = {})
           super
+          @store = Store.create
           @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
+        attr_accessor :is_create_cache
+        attr_accessor :store
 
         # Scope Rails
         def create_docs
@@ -82,6 +85,32 @@ module R2OAS
         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

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

@@ -20,37 +20,17 @@ module R2OAS
           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
+            logger.info ' <From routes data>'
+            generate_docs_from_routes_data
           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}"
+              logger.info "  Add schema file into store: \t#{save_file_path}"
             end
           end
 
@@ -65,9 +45,10 @@ module R2OAS
 
               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?
+              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?
+              yield save_file_path if block_given?
             end
           end
 

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

@@ -24,18 +24,18 @@ module R2OAS
 
               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?
+              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)
-                unless file_manager.skip_save?
-                  result = data['has_one']['data']
-                  file_manager.save(result.to_yaml)
-                end
+                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 file_manager.save_file_path(type: :relative) if block_given?
+              yield save_file_path if block_given?
             end
           end
         end

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

@@ -2,6 +2,9 @@
 
 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'
 
@@ -9,8 +12,6 @@ module R2OAS
   module Schema
     module V3
       class DocGenerator < BaseGenerator
-        attr_accessor :oas_doc
-
         def initialize(options = {})
           super
           @schema_generator = SchemaGenerator.new(options)
@@ -18,31 +19,95 @@ module R2OAS
 
         def generate_docs
           logger.info '[Generate OAS schema files] start'
-          @schema_generator.generate_docs unless skip_generate_docs
+          @schema_generator.generate_docs
+          save_schemas_from_store
           logger.info '[Generate OAS schema files] end'
-          logger.info '[Generate OAS docs from schema files] start'
-          generate_docs_from_schema_files
-          logger.info '[Generate OAS docs from schema files] end'
         end
 
         private
 
-        def generate_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)}"
+        def save_schemas_from_store
+          local_store = 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
 
-          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
+          # 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
 
-          @oas_doc = result
-          File.write(doc_save_file_path, result.to_yaml)
+                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