r2-oas 0.1.3 → 0.3.3

data/lib/r2-oas/lib/three-way-merge/twm.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'key_flatten'
+
+# rubocop:disable all
+module Twm
+  class << self
+    #
+    # orig: local docs
+    # left: generate docs
+    # right: local src files
+    #
+    # condition: merge right into left
+    def yaml_merge(left, orig, right)
+      flat_orig = KeyFlatten.key_flatten(orig || {}).to_h
+      flat_left = KeyFlatten.key_flatten(left || {}).to_h
+      flat_right = KeyFlatten.key_flatten(right || {}).to_h
+
+      all_keys = (flat_left.keys + flat_orig.keys + flat_right.keys).uniq
+
+      twm = all_keys.each_with_object({}) do |key, result|
+        r = three_equal?(flat_left[key], flat_orig[key], flat_right[key])
+
+        if r[:left_orig] && r[:orig_right] && r[:left_right]
+          # no change
+          result[key] = flat_orig[key]
+        elsif r[:left_orig] && !r[:orig_right] && !r[:left_right]
+          # edited
+          result[key] = flat_right[key]
+        elsif !r[:left_orig] && r[:orig_right] && !r[:left_right]
+          # generate
+          result[key] = flat_left[key]
+        elsif !r[:left_orig] && !r[:orig_right] && r[:left_right]
+          # edited
+          result[key] = flat_right[key]
+        elsif !r[:left_orig] && !r[:orig_right] && !r[:left_right]
+          # conflict => prioritize edited
+          result[key] = flat_right[key]
+        end
+      end
+
+      twm = twm.delete_if { |_k, v| v.nil? }
+      KeyFlatten.key_unflatten(twm)
+    end
+
+    private
+
+    def three_equal?(left, orig, right)
+      if left == orig && orig == right
+        {
+          left_orig: true,
+          orig_right: true,
+          left_right: true
+        }
+      elsif left == orig && orig != right
+        {
+          left_orig: true,
+          orig_right: false,
+          left_right: false
+        }
+      elsif left != orig && orig == right
+        {
+          left_orig: false,
+          orig_right: true,
+          left_right: false
+        }
+      elsif left != orig && orig != right && left == right
+        {
+          left_orig: false,
+          orig_right: false,
+          left_right: true
+        }
+      elsif left != orig && orig != right && left != right
+        {
+          left_orig: false,
+          orig_right: false,
+          left_right: false
+        }
+      end
+    end
+  end
+end
+# rubocop:enable all

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/editor.rb

@@ -5,7 +5,6 @@ require 'eventmachine'
 require 'watir'
 require 'tempfile'
 require 'fileutils'
-require 'shell'
 require 'forwardable'
 
 # Can't use ActiveSupport::Autroload
@@ -73,6 +72,10 @@ module R2OAS
         analyzer.analyze_docs
       end
 
+      # MEMO
+      # TargetRubyVersion is 2.7 and there is a warning
+      # Because it is necessary to support from ruby2.3 series where begin cannot be omitted
+      # rubocop:disable Style/RedundantBegin
       def ensure_save_tmp_schema_file
         EM.add_periodic_timer(interval_to_save_edited_tmp_schema) do
           m = Mutex.new
@@ -90,6 +93,7 @@ module R2OAS
           end
         end
       end
+      # rubocop:enable Style/RedundantBegin
 
       def save_after_fetch_local_strage
         @after_schema_data = @browser.driver.local_storage[storage_key] || @after_schema_data
@@ -110,7 +114,14 @@ module R2OAS
         @browser ||= Watir::Browser.new(:chrome, capabilities)
         @browser.goto(url)
         if wait_for_loaded
-          @browser.driver.local_storage[storage_key] = @schema_doc_from_local
+          # MEMO:
+          # Because it may not be updated
+          # Make sure that the launched local storage is updated reliably
+          Watir::Wait.until do
+            old_storage = @browser.driver.local_storage[storage_key].dup
+            @browser.driver.local_storage[storage_key] = new_storage = @schema_doc_from_local
+            old_storage != new_storage
+          end
           @browser.refresh
         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/ui.rb

@@ -3,7 +3,6 @@
 require 'docker'
 require 'eventmachine'
 require 'watir'
-require 'shell'
 require 'forwardable'
 
 # Scope Rails

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