r2-oas 0.1.2 → 0.3.2

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/deploy/client.rb

@@ -6,22 +6,33 @@ require 'fileutils'
 module R2OAS
   module Deploy
     class Client < Schema::Base
+      SWAGGER_UI_DIST_URL = 'https://github.com/swagger-api/swagger-ui/trunk/dist'
+
+      def initialize(options = {})
+        super(options)
+        @download_dir = "#{SecureRandom.uuid[0..7]}/dist"
+        @dist_path = File.expand_path(Rails.root.join(@download_dir), __FILE__)
+      end
+
+      def download_swagger_ui_dist
+        system("svn export #{SWAGGER_UI_DIST_URL} #{@dist_path}")
+      end
+
       def deploy
         copy_swagger_ui_dist
         copy_swagger_ui_index
         copy_oas_doc_file
+      ensure
+        remove_download_dist
       end
 
       private
 
       def copy_swagger_ui_dist
         docs_path = File.expand_path(Rails.root.join(deploy_dir_path), __FILE__)
-        return if FileTest.exists?(docs_path)
-
         FileUtils.mkdir_p(docs_path) unless FileTest.exists?(docs_path)
-
-        dist_path = File.expand_path('swagger-ui/dist', __dir__)
-        FileUtils.cp_r(dist_path, docs_path)
+        FileUtils.mkdir_p(@dist_path) unless FileTest.exists?(@dist_path)
+        FileUtils.cp_r(@dist_path, docs_path)
       end
 
       def copy_swagger_ui_index
@@ -29,7 +40,7 @@ module R2OAS
         @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 +49,22 @@ 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
+
+      def remove_download_dist
+        FileUtils.rm_rf(File.expand_path('..', @dist_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

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
@@ -20,6 +19,7 @@ module R2OAS
       extend Forwardable
 
       TMP_FILE_NAME = 'edited_schema'
+      ALERT_TEXT = 'Would you like to convert your JSON into YAML?'
 
       attr_accessor :edited_schema
 
@@ -27,6 +27,7 @@ module R2OAS
         super(options)
         @editor = swagger.editor
         @before_schema_data = before_schema_data
+        @schema_doc_from_local = YAML.load_file(doc_save_file_path).to_yaml
       end
 
       def start
@@ -71,15 +72,34 @@ 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
-          if @browser.exists?
-            @after_schema_data = @browser.driver.local_storage[storage_key] || @after_schema_data
-            save_edited_schema
-            puts "\nwait for signal trap ..."
+          m = Mutex.new
+          return nil unless @browser.exists?
+
+          m.synchronize do
+            begin
+              save_after_fetch_local_strage
+            rescue Selenium::WebDriver::Error::UnexpectedAlertOpenError
+              alert = @browser.driver.switch_to.alert
+              if alert.text.eql?(ALERT_TEXT)
+                alert.accept && save_after_fetch_local_strage
+              end
+            end
           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
+        save_edited_schema
+        puts "\nwait for signal trap ..."
+      end
 
       def fetch_edited_schema_from_browser
         @after_schema_data = @browser.driver.local_storage[storage_key] if @browser.exists?
@@ -94,8 +114,7 @@ module R2OAS
         @browser ||= Watir::Browser.new(:chrome, capabilities)
         @browser.goto(url)
         if wait_for_loaded
-          schema_doc_from_local = YAML.load_file(doc_save_file_path)
-          @browser.driver.local_storage[storage_key] = schema_doc_from_local.to_yaml
+          @browser.driver.local_storage[storage_key] = @schema_doc_from_local
           @browser.refresh
         end
       end