r2-oas 0.1.3 → 0.3.3

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

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

@@ -17,29 +17,17 @@ module R2OAS
         end
 
         def generate_docs
-          if paths_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 paths_files_paths schema_files_paths
-        alias paths_file_do_not_exists? schema_file_do_not_exists?
-
-        def generate_docs_from_schema_fiels
-          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
 
@@ -47,11 +35,11 @@ module R2OAS
           logger.info ' <Update schema files (paths)>'
           save_each_tags(@paths) do |tag_name, result|
             relative_path = "paths/#{tag_name}"
-            path_item_file_manager = PathItemFileManager.new(relative_path, :relative)
-
-            path_item_file_manager.save(result.to_yaml) unless path_item_file_manager.skip_save?
+            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 path_item_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/schema_generator.rb

@@ -17,36 +17,15 @@ module R2OAS
         end
 
         def generate_docs
-          if force_update_schema || schema_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
-
-        def create_docs
-          if !skip_generate_docs
-            super
-          elsif skip_generate_docs && FileTest.exists?(doc_save_file_path)
-            YAML.load_file(doc_save_file_path)
-          else
-            {}
-          end
+          logger.info '<From routes data>'
+          generate_docs_from_routes_data
         end
 
         private
 
-        def generate_docs_from_schema_fiels
-          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
 
@@ -66,7 +45,8 @@ module R2OAS
               logger.info ' [Generate OAS schema files (components)] end'
             else
               file_manager = FileManager.new(field_name, :relative)
-              file_manager.save(result.to_yaml)
+              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

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

@@ -23,6 +23,8 @@ module R2OAS
         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
 
@@ -32,10 +34,7 @@ module R2OAS
         end
 
         def save_file_path(type: :full)
-          file_path = File.expand_path(@relative_save_file_path).tap do |abs_path|
-            abs_dir = File.dirname(abs_path)
-            FileUtils.mkdir_p(abs_dir) unless FileTest.exists?(abs_dir)
-          end
+          file_path = File.expand_path(@relative_save_file_path)
 
           case type
           when :relative

data/lib/r2-oas/schema/v3/manager/pathname_manager.rb

@@ -60,7 +60,12 @@ module R2OAS
           when :ref
             "#{@path.gsub('#/', '')}.#{@ext_name}"
           when :relative
-            "#{@path}.#{@ext_name}"
+            ext_name = File.extname(@path)
+            if ext_name.empty?
+              "#{@path}.#{@ext_name}"
+            else
+              @path
+            end
           when :full
             @path
           else

data/lib/r2-oas/store.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'digest/sha1'
+require 'zlib'
+
+require 'r2-oas/schema/manager/file_manager'
+
+module R2OAS
+  class Store
+    attr_accessor :data
+
+    def initialize(data = {})
+      if data.empty?
+        @data = {}
+        @data['type'] = :schema
+        @data['data'] = {}
+      else
+        @data = data
+      end
+    end
+
+    def add(key, value, type = :schema)
+      sha1 = calc_sha1(key, value)
+
+      @data['data'][sha1] ||= {}
+      @data['type'] = type
+      @data['data'][sha1]['key'] = key
+      @data['data'][sha1]['value'] = Zlib::Deflate.deflate(value)
+    end
+
+    def save
+      type = @data['type']
+      @data['data'].values.each do |value|
+        case type
+        when :schema
+          save_path = value['key']
+          save_data = Zlib::Inflate.inflate(value['value'])
+          manager = Schema::FileManager.new(save_path, :full)
+          manager.save(save_data)
+          yield save_path
+        end
+      end
+    end
+
+    def dup_slice(*sha1s)
+      dup_store = Store.new(@data.dup)
+      dup_data = dup_store.data['data']
+      dup_store.data['data'] = sha1s.each_with_object({}) { |sha1, data| data[sha1] = dup_data[sha1] if dup_store.key?(sha1) }
+      dup_store
+    end
+
+    def checksum?
+      @data['data'].each_with_object([]) do |(sha1, value), arr|
+        child_key = value['key']
+        child_value = Zlib::Inflate.inflate(value['value'])
+        arr.push(sha1.eql? calc_sha1(child_key, child_value))
+      end.all?
+    end
+
+    def key?(key)
+      @data['data']&.key?(key)
+    end
+
+    def exists?
+      !@data['data']&.empty?
+    end
+
+    def diff_from(local_store)
+      to_hash = adjust(values.to_h, 'after')
+      from_hash = adjust(local_store.send(:values).to_h, 'before')
+      analyze_data = to_hash.deep_merge(from_hash)
+      if block_given?
+        yield analyze_data
+      else
+        analyze_data
+      end
+    end
+
+    private
+
+    def calc_sha1(key, value)
+      Digest::SHA1.hexdigest("#{key}\0#{value}")
+    end
+
+    def values
+      arr = @data['data'].values
+      arr.each_with_object([]) do |el, result|
+        key = el['key']
+        value = el['value']
+        result.push([key, value])
+      end
+    end
+
+    def adjust(hash, direct)
+      hash.each_with_object({}) do |(key, value), result|
+        result[key] = { direct => {} }
+        result[key][direct] = YAML.safe_load(Zlib::Inflate.inflate(value))
+        result
+      end
+    end
+
+    class << self
+      extend Forwardable
+
+      def_delegators :instance, :add
+
+      def create
+        instance
+      end
+
+      private
+
+      def instance
+        @instance ||= new
+      end
+    end
+  end
+end

data/lib/r2-oas/task_logging.rb

@@ -20,12 +20,14 @@ module R2OAS
 
     private
 
-    def logger
-      R2OAS.logger
+    def start
+      logger.info '[R2-OAS] start'
+      yield
+      logger.info '[R2-OAS] end'
     end
 
-    def set_info_level
-      R2OAS.logger.level = StdoutLogger::INFO
+    def logger
+      R2OAS.logger
     end
 
     def set_debug_level

data/lib/r2-oas/tasks/common.rake

@@ -10,7 +10,6 @@ namespace :routes do
     # desc "Setup a common setting for every tasks"
     task common: [:environment] do
       create_dot_paths
-      set_info_level
     end
 
     # private

data/lib/r2-oas/tasks/main.rake

@@ -8,100 +8,89 @@ load File.expand_path('common.rake', __dir__)
 
 namespace :routes do
   namespace :oas do
-    desc 'Generate Swagger documentation files'
+    desc 'Generate OAS documentation files'
     task docs: [:common] do
-      logger.info '[R2-OAS] start'
-      options = { unit_paths_file_path: unit_paths_file_path, skip_load_dot_paths: true }
-      generator = R2OAS::Schema::Generator.new(options)
-      generator.generate_docs
-      logger.info '[R2-OAS] end'
+      start do
+        is_create_cache = cache_docs.eql? 'true'
+        options = { unit_paths_file_path: unit_paths_file_path, skip_load_dot_paths: true, is_create_cache: is_create_cache }
+        generator = R2OAS::Schema::Generator.new(options)
+        generator.generate_docs
+      end
     end
 
-    desc 'Analyze Swagger documentation'
+    desc 'Analyze OAS documentation'
     task analyze: [:common] do
-      logger.info '[R2-OAS] start'
-
-      analyzer_options = { type: :existing, existing_schema_file_path: existing_schema_file_path }
-      analyzer = R2OAS::Schema::Analyzer.new({}, {}, analyzer_options)
-      analyzer.analyze_docs
-
-      generator_options = { skip_generate_docs: true }
-      generator = R2OAS::Schema::Generator.new(generator_options)
-      generator.generate_docs
-
-      logger.info '[R2-OAS] end'
+      start do
+        analyzer_options = { type: :existing, existing_schema_file_path: existing_schema_file_path }
+        analyzer = R2OAS::Schema::Analyzer.new({}, {}, analyzer_options)
+        analyzer.analyze_docs
+
+        builder_options = {}
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+      end
     end
 
-    desc 'Distribute Swagger documentation'
+    desc 'Distribute OAS documentation'
     task dist: [:common] do
-      logger.info '[R2-OAS] start'
-
-      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
-      generator = R2OAS::Schema::Generator.new(generator_options)
-      generator.generate_docs
-
-      logger.info '[R2-OAS] end'
+      start do
+        builder_options = { unit_paths_file_path: unit_paths_file_path }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+      end
     end
 
     desc 'Open Swagger Editor'
     task editor: [:common] do
-      logger.info '[R2-OAS] start'
-
-      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
-      generator = R2OAS::Schema::Generator.new(generator_options)
-      generator.generate_docs
-
-      before_schema_data = generator.oas_doc
-      editor_options = { unit_paths_file_path: unit_paths_file_path }
-      editor = R2OAS::Schema::Editor.new(before_schema_data, editor_options)
-      editor.start
-
-      logger.info '[R2-OAS] end'
+      start do
+        builder_options = { unit_paths_file_path: unit_paths_file_path }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        before_schema_data = builder.oas_doc
+        editor_options = { unit_paths_file_path: unit_paths_file_path }
+        editor = R2OAS::Schema::Editor.new(before_schema_data, editor_options)
+        editor.start
+      end
     end
 
     desc 'Open Swagger UI'
     task ui: [:common] do
-      logger.info '[R2-OAS] start'
-
-      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
-      generator = R2OAS::Schema::Generator.new(generator_options)
-      generator.generate_docs
-
-      ui_options = { unit_paths_file_path: unit_paths_file_path }
-      ui = R2OAS::Schema::UI.new(ui_options)
-      ui.start
-
-      logger.info '[R2-OAS] end'
+      start do
+        builder_options = { unit_paths_file_path: unit_paths_file_path }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        ui_options = { unit_paths_file_path: unit_paths_file_path }
+        ui = R2OAS::Schema::UI.new(ui_options)
+        ui.start
+      end
     end
 
-    desc 'Monitor Swagger Document'
+    desc 'Monitor OAS Document'
     task monitor: [:common] do
-      logger.info '[R2-OAS] start'
-
-      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
-      generator = R2OAS::Schema::Generator.new(generator_options)
-      generator.generate_docs
-
-      before_schema_data = generator.oas_doc
-      monitor_options = { unit_paths_file_path: unit_paths_file_path }
-      monitor = R2OAS::Schema::Monitor.new(before_schema_data, monitor_options)
-      monitor.start
-
-      logger.info '[R2-OAS] end'
+      start do
+        builder_options = { unit_paths_file_path: unit_paths_file_path }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        before_schema_data = builder.oas_doc
+        monitor_options = { unit_paths_file_path: unit_paths_file_path }
+        monitor = R2OAS::Schema::Monitor.new(before_schema_data, monitor_options)
+        monitor.start
+      end
     end
 
-    desc 'Clean Swagger Document'
+    desc 'Clean OAS Document'
     task clean: [:common] do
-      logger.info '[R2-OAS] start'
-
-      generator_options = { skip_generate_docs: true, skip_load_dot_paths: true }
-      generator = R2OAS::Schema::Generator.new(generator_options)
-      generator.generate_docs
-
-      cleaner = R2OAS::Schema::Cleaner.new
-      cleaner.clean_docs
-
-      logger.info '[R2-OAS] end'
+      start do
+        builder_options = { skip_load_dot_paths: true }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        cleaner = R2OAS::Schema::Cleaner.new
+        cleaner.clean_docs
+      end
     end
 
     private
@@ -113,5 +102,9 @@ namespace :routes do
     def existing_schema_file_path
       ENV.fetch('OAS_FILE', '')
     end
+
+    def cache_docs
+      ENV.fetch('CACHE_DOCS', 'false')
+    end
   end
 end