r2-oas 0.1.0 → 0.3.1

data/gemfiles/ruby_2.5.8.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+ruby '2.5.8'
+
+group :test do
+  gem "sqlite3"
+end
+
+gemspec path: "../"

data/gemfiles/ruby_2.6.6.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+ruby '2.6.6'
+
+group :test do
+  gem "sqlite3"
+end
+
+gemspec path: "../"

data/gemfiles/ruby_2.7.1.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+ruby '2.7.1'
+
+group :test do
+  gem "sqlite3"
+end
+
+gemspec path: "../"

data/lib/r2-oas.rb

@@ -6,14 +6,14 @@ require 'r2-oas/errors'
 require 'r2-oas/schema/v3/object/public'
 
 module R2OAS
-  extend ActiveSupport::Autoload
-
   if !defined?(::Rails)
     raise NoImplementError, 'Can not load Rails'
   # support Rails version
   elsif ::Rails::VERSION::STRING >= '4.2.5.1'
     extend Configuration
     require 'r2-oas/task'
+    require 'r2-oas/lib/core_ext/hash/deep_merge'
+    require 'r2-oas/lib/core_ext/object/blank'
 
     autoload :Base, 'r2-oas/base'
     autoload :NoImplementError, 'r2-oas/errors'
@@ -22,10 +22,9 @@ module R2OAS
     autoload :Sortable, 'r2-oas/shared/all'
 
     module Schema
-      extend ActiveSupport::Autoload
-
       autoload :Base, 'r2-oas/schema/base'
       autoload :Generator, 'r2-oas/schema/generator'
+      autoload :Builder, 'r2-oas/schema/builder'
       autoload :Analyzer, 'r2-oas/schema/analyzer'
       autoload :Squeezer, 'r2-oas/schema/squeezer'
       autoload :Cleaner, 'r2-oas/schema/cleaner'

data/lib/r2-oas/app_configuration.rb

@@ -40,11 +40,12 @@ module R2OAS
       }
     }
     DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY = %w[post patch put]
+    DEFAULT_IGNORED_HTTP_STATUSES_WHEN_GENERATE_COMPONENT_SCHEMA = %w[204 404]
     # rubocop:enable Style/MutableConstant
     DEFAULT_TOOL = Tool.new
     # :dot or :underbar
     DEFAULT_NAMESPACE_TYPE = :underbar
-    DEFAULT_DEPLOY_DIR_PATH = "./deploy_docs"
+    DEFAULT_DEPLOY_DIR_PATH = './deploy_docs'
 
     PUBLIC_VALID_OPTIONS_KEYS = %i[
       version
@@ -59,6 +60,7 @@ module R2OAS
       swagger
       http_statuses_when_http_method
       http_methods_when_generate_request_body
+      ignored_http_statuses_when_generate_component_schema
       tool
       namespace_type
       deploy_dir_path
@@ -82,21 +84,22 @@ module R2OAS
     private
 
     module_function def set_default(target)
-      target.version                                 = DEFAULT_VERSION
-      target.root_dir_path                           = DEFAULT_ROOT_DIR_PATH
-      target.schema_save_dir_name                    = DEFAULT_SCHEMA_SAVE_DIR_NAME
-      target.doc_save_file_name                      = DEFAULT_DOC_SAVE_FILE_NAME
-      target.force_update_schema                     = DEFAULT_FORCE_UPDATE_SCHEMA
-      target.use_tag_namespace                       = DEFAULT_USE_TAG_NAMESPACE
-      target.use_schema_namespace                    = DEFAULT_USE_SCHEMA_NAMESPACE
-      target.server                                  = DEFAULT_SERVER
-      target.interval_to_save_edited_tmp_schema      = DEFAULT_INTERVAL_TO_SAVE_EDITED_TMP_SCHEMA
-      target.swagger                                 = DEFAULT_SWAGGER
-      target.http_statuses_when_http_method          = DEFAULT_HTTP_STATUSES_WHEN_HTTP_METHOD
-      target.tool                                    = DEFAULT_TOOL
-      target.http_methods_when_generate_request_body = DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY
-      target.namespace_type                          = DEFAULT_NAMESPACE_TYPE
-      target.deploy_dir_path                         = DEFAULT_DEPLOY_DIR_PATH
+      target.version                                              = DEFAULT_VERSION
+      target.root_dir_path                                        = DEFAULT_ROOT_DIR_PATH
+      target.schema_save_dir_name                                 = DEFAULT_SCHEMA_SAVE_DIR_NAME
+      target.doc_save_file_name                                   = DEFAULT_DOC_SAVE_FILE_NAME
+      target.force_update_schema                                  = DEFAULT_FORCE_UPDATE_SCHEMA
+      target.use_tag_namespace                                    = DEFAULT_USE_TAG_NAMESPACE
+      target.use_schema_namespace                                 = DEFAULT_USE_SCHEMA_NAMESPACE
+      target.server                                               = DEFAULT_SERVER
+      target.interval_to_save_edited_tmp_schema                   = DEFAULT_INTERVAL_TO_SAVE_EDITED_TMP_SCHEMA
+      target.swagger                                              = DEFAULT_SWAGGER
+      target.http_statuses_when_http_method                       = DEFAULT_HTTP_STATUSES_WHEN_HTTP_METHOD
+      target.tool                                                 = DEFAULT_TOOL
+      target.http_methods_when_generate_request_body              = DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY
+      target.ignored_http_statuses_when_generate_component_schema = DEFAULT_IGNORED_HTTP_STATUSES_WHEN_GENERATE_COMPONENT_SCHEMA
+      target.namespace_type                                       = DEFAULT_NAMESPACE_TYPE
+      target.deploy_dir_path                                      = DEFAULT_DEPLOY_DIR_PATH
     end
   end
 end

data/lib/r2-oas/deploy/client.rb

@@ -25,11 +25,11 @@ module R2OAS
       end
 
       def copy_swagger_ui_index
-        index_path = File.expand_path(Rails.root.join(deploy_dir_path, "index.html"), __FILE__)
+        index_path = File.expand_path(Rails.root.join(deploy_dir_path, 'index.html'), __FILE__)
         @schema_file_path = doc_save_file_name
         template_path = File.expand_path('swagger-ui/index.html.erb', __dir__)
         template = File.read(template_path)
-        index = ERB.new(template, nil, '%').result(binding)
+        index = make_index(template)
         File.write(index_path, index)
       end
 
@@ -38,6 +38,18 @@ module R2OAS
         oas_doc_file_path = File.expand_path("#{root_dir_path}/#{doc_save_file_name}")
         FileUtils.cp_r(oas_doc_file_path, swagger_file_path)
       end
+
+      # [ref]
+      # https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Lint/ErbNewArguments
+      def make_index(template)
+        if RUBY_VERSION >= '2.6'
+          ERB.new(template, trim_mode: '%').result(binding)
+        else
+          # rubocop:disable Lint/ErbNewArguments
+          ERB.new(template, nil, trim_mode: '%').result(binding)
+          # rubocop:enable Lint/ErbNewArguments
+        end
+      end
     end
   end
 end

data/lib/r2-oas/errors.rb

@@ -4,4 +4,5 @@ module R2OAS
   class NoImplementError < StandardError; end
   class NoFileExistsError < StandardError; end
   class NoSupportError < StandardError; end
+  class ChecksumError < StandardError; end
 end

data/lib/r2-oas/lib/core_ext/hash/deep_merge.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copy From https://github.com/rails/rails/blob/v4.2.5/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+
+# rubocop:disable all
+class Hash
+  # Returns a new hash with +self+ and +other_hash+ merged recursively.
+  #
+  #   h1 = { a: true, b: { c: [1, 2, 3] } }
+  #   h2 = { a: false, b: { x: [3, 4, 5] } }
+  #
+  #   h1.deep_merge(h2) #=> { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
+  #
+  # Like with Hash#merge in the standard library, a block can be provided
+  # to merge values:
+  #
+  #   h1 = { a: 100, b: 200, c: { c1: 100 } }
+  #   h2 = { b: 250, c: { c1: 200 } }
+  #   h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
+  #   # => { a: 100, b: 450, c: { c1: 300 } }
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+
+  # Same as +deep_merge+, but modifies +self+.
+  def deep_merge!(other_hash, &block)
+    other_hash.each_pair do |current_key, other_value|
+      this_value = self[current_key]
+
+      self[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+        this_value.deep_merge(other_value, &block)
+      else
+        if block_given? && key?(current_key)
+          block.call(current_key, this_value, other_value)
+        else
+          other_value
+        end
+      end
+    end
+
+    self
+  end
+end
+# rubocop:enable all

data/lib/r2-oas/lib/core_ext/object/blank.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+# Copy From https://github.com/rails/rails/blob/v4.2.5/activesupport/lib/active_support/core_ext/object/blank.rb
+
+# rubocop:disable all
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, +false+, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies
+  #
+  #   !address || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_REGEXP = /\A[[:space:]]*\z/
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    BLANK_REGEXP === self
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+# rubocop:enable all

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