r2-oas 0.2.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bf20ae2c0c99f94558e59869340907ff824e3ae915ca75937c3b442239e3abe
-  data.tar.gz: 1b4c900930a1ea5450f233f7f03a627ff5ae7c6976d62a3c8ffbf3e5ed07bd22
+  metadata.gz: 74e2483dd3c1980c894757819275ef05b794820d5aebe22b08bf737df2f31c63
+  data.tar.gz: 52b4b0abf260d18852cdaad9ea1d7b70aa76cc63e15a7793e528b8769e715b94
 SHA512:
-  metadata.gz: fdd920f94d39c3f0823c3aa6696f5ecb8d401808d3e0424115d2e8ac8758e052c50db3c2ac4ca6fd0b55fd44ab3b5d52ac175f3abacfab3e1c6adacdb1a58054
-  data.tar.gz: b01b1249e8fa3dc3de707783f33ff1720e96af0a85c5cd90e9877175419a143243bb6bbf6678f680af1a14af055ab87f3753c43d98903a4cca06cffd29b92055
+  metadata.gz: 23f55926a604e6f49424294867e183a4cb4d1dc0a5b6a0e3fa9751eb56bc667477868a56436a08a3c3855939f3d9b8959c56ca7d5496086be6ffe8b2f45a06bc
+  data.tar.gz: 799eae1d0bf672a6615cb8917b4aa633b92cb01df314adbfd00cab520176dff47b97be49316430e1b2c51bf0083f114331f6bcb48c5cab14837985b910846ace

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Change Log
 
+## v0.3.4
+
+2020-07-11
+
+- [`Other`] Modify gemspec `files` fields ([#147](https://github.com/yukihirop/r2-oas/pull/147))
+    - Add `r2-oas.gemspec` into gemspec `files`
+
+## v0.3.3
+
+2020-07-11
+
+- [`FixBugs`] A cute pet store syndrome 🐈 ([f3f4c30](https://github.com/yukihirop/r2-oas/pull/144))
+- [`FixBugs`]  R2OAS.logger.level does not work ([f3f4c30](https://github.com/yukihirop/r2-oas/pull/144))
+- [`Breaking`] Change default namespace type from `:underbar` to `:dot` ([f3f4c30](https://github.com/yukihirop/r2-oas/pull/144))
+- [`Other`] Modify gemspec `files` fields ([f3f4c30](https://github.com/yukihirop/r2-oas/pull/144))
+
+See milestone [v0.3.3](https://github.com/yukihirop/r2-oas/milestone/3?closed=1)
+
+## v0.3.2
+
+2020-07-05
+
+- [`Feature`] The file size at the time of gem install was reduced by about 10MB. ([dbdbce9 ](https://github.com/yukihirop/r2-oas/pull/138))
+
+## v0.3.1
+
+2020-06-07
+
+- [`Breaking`] Remove unnecessary runtime dependencies ([384ea1a](https://github.com/yukihirop/r2-oas/pull/132))
+
+## v0.3.0
+
+2020-05-30
+
+- [`Feature/Breaking`] Support Ruby 2.7 🎉 ([931ec4b](https://github.com/yukihirop/r2-oas/pull/122))
+
+  - Remove `Gemfile.lock`
+
+- [`Developer`] Create script to test all support ruby in development ([8d0df98](https://github.com/yukihirop/r2-oas/pull/124))
+- [`Docs`] Add docs about Trableshouting ([f4a782f](https://github.com/yukihirop/r2-oas/pull/125))
+
 ## v0.2.0
 
 2020-05-02

data/GEMSPEC.md

@@ -1,23 +1,20 @@
-Let's intuitively write API documentation with Swagger Editor in your Rails Project! 😊
-
-Configureless and no DSL. 👍 But you can also configure.
-
-Loosely coupled to your Rails project. 👍
-
-So If it doesn't, you can always stop easily. 😢
-
-Generate api docment(OpenAPI) side only from `Rails` routing.
-
-Provide rake tasks to management API Docment (OpenAPI) 🎉
-
-
-    $ bundle exec rake routes:oas:docs    # generate
-    $ bundle exec rake routes:oas:ui      # view
-    $ bundle exec rake routes:oas:editor  # edit
-    $ bundle exec rake routes:oas:monitor # monitor
-    $ bundle exec rake routes:oas:dist    # distribute
-    $ bundle exec rake routes:oas:clean   # clean
-    $ bundle exec rake routes:oas:analyze # analyze
-    $ bundle exec rake routes:oas:deploy  # deploy
-
+Configureless and no DSL. 👍 But you can also configure.  
+Manage with yaml file instead of Ruby code.  
+Loosely coupled to your Rails project. 👍  
+So if you want to use another tool, you can port it right away. 😢  
+Generate api docment(OpenAPI) side only from `Rails` routing.  
+  
+Provide rake tasks to management API Docment (OpenAPI) 🎉  
+  
+
+    $ bundle exec rake routes:oas:docs
+    $ bundle exec rake routes:oas:ui
+    $ bundle exec rake routes:oas:editor
+    $ bundle exec rake routes:oas:monitor
+    $ bundle exec rake routes:oas:dist
+    $ bundle exec rake routes:oas:clean
+    $ bundle exec rake routes:oas:analyze
+    $ bundle exec rake routes:oas:deploy
+
+  
 Happy Coding ❗️

data/README.ja.md

@@ -157,6 +157,67 @@ OpenAPIの3.0.0をサポートしてます。
 
 公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas/#/usage/use_hook_methods
 
+
+## Bundle and Rspec with multiple ruby ​​versions
+
+#### Bundle
+
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
+```
+
+rubyのバージョンを `2.6.6` と `2.7.1`　に指定する場合
+
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle 2.6.6 2.7.1
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
+```
+
+#### Rspec
+
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
+```
+
+rubyのバージョンを `2.6.6` と `2.7.1`　に指定する場合
+
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec 2.6.6 2.7.1
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
+```
+
 ## 🔩 CORS
 
 [rack-cors](https://github.com/cyu/rack-cors)を使用する事でCORSを可能にします。

data/README.md

@@ -156,6 +156,66 @@ Supported hook(life cycle methods) is like this:
 
 Full docs are available at https://yukihirop.github.io/r2-oas/#/usage/use_hook_methods
 
+## Bundle and Rspec with multiple ruby ​​versions
+
+#### Bundle
+
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
+```
+
+If specify ruby version `2.6.6` and `2.7.1`
+
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle 2.6.6 2.7.1
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
+```
+
+#### Rspec
+
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
+```
+
+If specify ruby version `2.6.6` and `2.7.1`
+
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec 2.6.6 2.7.1
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
+```
+
 ## 🔩 CORS
 
 Use [rack-cors](https://github.com/cyu/rack-cors) to enable CORS.

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,8 +22,6 @@ 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'

data/lib/r2-oas/app_configuration.rb

@@ -44,7 +44,7 @@ module R2OAS
     # rubocop:enable Style/MutableConstant
     DEFAULT_TOOL = Tool.new
     # :dot or :underbar
-    DEFAULT_NAMESPACE_TYPE = :underbar
+    DEFAULT_NAMESPACE_TYPE = :dot
     DEFAULT_DEPLOY_DIR_PATH = './deploy_docs'
 
     PUBLIC_VALID_OPTIONS_KEYS = %i[

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/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