r2-oas 0.2.0 → 0.3.4

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

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

data/lib/r2-oas/task_logging.rb

@@ -30,10 +30,6 @@ module R2OAS
       R2OAS.logger
     end
 
-    def set_info_level
-      R2OAS.logger.level = StdoutLogger::INFO
-    end
-
     def set_debug_level
       R2OAS.logger.level = StdoutLogger::DEBUG
     end

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/tool.rake

@@ -11,12 +11,19 @@ namespace :routes do
     desc 'Deploy OAS Document'
     task deploy: [:common] do
       start do
+        client_options = {}
+        client = R2OAS::Deploy::Client.new(client_options)
+
+        download_dist_th = Thread.new do
+          puts 'Download swagger-api/swagger-ui/dist ... (async)'
+          client.download_swagger_ui_dist
+        end
+
         builder_options = { unit_paths_file_path: unit_paths_file_path }
         builder = R2OAS::Schema::Builder.new(builder_options)
         builder.build_docs
 
-        client_options = {}
-        client = R2OAS::Deploy::Client.new(client_options)
+        download_dist_th.join
         client.deploy
       end
     end

data/lib/r2-oas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module R2OAS
-  VERSION = '0.2.0'
+  VERSION = '0.3.4'
 end

data/r2-oas.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['te108186@gmail.com']
 
   spec.summary       = 'Provide rake tasks to management API Docment (OpenAPI)'
-  spec.description   = %Q{#{IO.read('GEMSPEC.md')}}
+  spec.description   = %Q{== Let's intuitively write API documentation with Swagger Editor in your Rails Project! 😊\n#{IO.read('GEMSPEC.md')}}
 
   spec.homepage      = 'https://github.com/yukihirop/r2-oas'
   spec.license       = 'MIT'
@@ -23,27 +23,26 @@ Gem::Specification.new do |spec|
   }
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files         = Dir["CHANGELOG.md", "GEMSPEC.md", "README.md", "README.ja.md", "LICENSE.txt", "lib/**/*", "r2-oas.gemspec"]
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.3p222')
 
-  spec.add_runtime_dependency 'docker-api', '~> 1.34.2'
-  spec.add_runtime_dependency 'easy_diff', '~> 1.0.0'
-  spec.add_runtime_dependency 'eventmachine', '~> 1.2.0'
-  spec.add_runtime_dependency 'key_flatten', '~> 1.0.0'
+  spec.add_runtime_dependency 'docker-api', '>= 1.34.2'
+  spec.add_runtime_dependency 'easy_diff', '>= 1.0.0'
+  spec.add_runtime_dependency 'eventmachine', '>= 1.2.0'
+  spec.add_runtime_dependency 'key_flatten', '>= 1.0.0'
   spec.add_runtime_dependency 'paint'
-  spec.add_runtime_dependency 'rails', '>= 4.2.5'
-  spec.add_runtime_dependency 'terminal-table', '~> 1.6.0'
-  spec.add_runtime_dependency 'watir', '~> 6.16.5'
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_runtime_dependency 'railties', '>= 4.2.5'
+  spec.add_runtime_dependency 'terminal-table', '>= 1.6.0'
+  spec.add_runtime_dependency 'watir', '>= 6.16.5'
+  spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'activerecord', '>= 4.2.5'
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: r2-oas
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.4
 platform: ruby
 authors:
 - yukihirop
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.34.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.34.2
 - !ruby/object:Gem::Dependency
   name: easy_diff
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: key_flatten
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,42 +98,42 @@ dependencies:
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.16.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.16.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
@@ -206,63 +206,56 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "Let's intuitively write API documentation with Swagger Editor in your
-  Rails Project! \U0001F60A\n\nConfigureless and no DSL. \U0001F44D But you can also
-  configure.\n\nLoosely coupled to your Rails project. \U0001F44D\n\nSo If it doesn't,
-  you can always stop easily. \U0001F622\n\nGenerate api docment(OpenAPI) side only
-  from `Rails` routing.\n\nProvide rake tasks to management API Docment (OpenAPI)
-  \U0001F389\n\n\n    $ bundle exec rake routes:oas:docs    # generate\n    $ bundle
-  exec rake routes:oas:ui      # view\n    $ bundle exec rake routes:oas:editor  #
-  edit\n    $ bundle exec rake routes:oas:monitor # monitor\n    $ bundle exec rake
-  routes:oas:dist    # distribute\n    $ bundle exec rake routes:oas:clean   # clean\n
-  \   $ bundle exec rake routes:oas:analyze # analyze\n    $ bundle exec rake routes:oas:deploy
-  \ # deploy\n\nHappy Coding ❗️\n"
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+description: "== Let's intuitively write API documentation with Swagger Editor in
+  your Rails Project! \U0001F60A\nConfigureless and no DSL. \U0001F44D But you can
+  also configure.  \nManage with yaml file instead of Ruby code.  \nLoosely coupled
+  to your Rails project. \U0001F44D  \nSo if you want to use another tool, you can
+  port it right away. \U0001F622  \nGenerate api docment(OpenAPI) side only from `Rails`
+  routing.  \n  \nProvide rake tasks to management API Docment (OpenAPI) \U0001F389
+  \ \n  \n\n    $ bundle exec rake routes:oas:docs\n    $ bundle exec rake routes:oas:ui\n
+  \   $ bundle exec rake routes:oas:editor\n    $ bundle exec rake routes:oas:monitor\n
+  \   $ bundle exec rake routes:oas:dist\n    $ bundle exec rake routes:oas:clean\n
+  \   $ bundle exec rake routes:oas:analyze\n    $ bundle exec rake routes:oas:deploy\n\n
+  \ \nHappy Coding ❗️\n"
 email:
 - te108186@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - GEMSPEC.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.ja.md
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- docs/.nojekyll
-- docs/README.md
-- docs/_sidebar.md
-- docs/attention/if_clash.md
-- docs/index.html
-- docs/schema/3.0.0.md
-- docs/setting/COC.md
-- docs/setting/CORS.md
-- docs/setting/configure.md
-- docs/usage/analyze_docs.md
-- docs/usage/clean_docs.md
-- docs/usage/deploy_docs.md
-- docs/usage/display_paths_list.md
-- docs/usage/display_paths_stats.md
-- docs/usage/edit_docs.md
-- docs/usage/generate_docs.md
-- docs/usage/monitor_docs.md
-- docs/usage/use_hook_methods.md
-- docs/usage/use_hook_to_generate_docs.md
-- docs/usage/use_schema_namespace.md
-- docs/usage/use_tag_namespace.md
-- docs/usage/view_docs.md
 - lib/r2-oas.rb
 - lib/r2-oas/app_configuration.rb
 - lib/r2-oas/app_configuration/server.rb
@@ -275,22 +268,13 @@ files:
 - lib/r2-oas/configuration.rb
 - lib/r2-oas/configuration/paths_config.rb
 - lib/r2-oas/deploy/client.rb
-- lib/r2-oas/deploy/swagger-ui/dist/favicon-16x16.png
-- lib/r2-oas/deploy/swagger-ui/dist/favicon-32x32.png
-- lib/r2-oas/deploy/swagger-ui/dist/oauth2-redirect.html
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-bundle.js
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-bundle.js.map
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-standalone-preset.js
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-standalone-preset.js.map
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.css
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.css.map
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.js
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.js.map
 - lib/r2-oas/deploy/swagger-ui/index.html.erb
 - lib/r2-oas/errors.rb
 - lib/r2-oas/hooks/global_hook.rb
 - lib/r2-oas/hooks/hook.rb
 - lib/r2-oas/hooks/repository.rb
+- lib/r2-oas/lib/core_ext/hash/deep_merge.rb
+- lib/r2-oas/lib/core_ext/object/blank.rb
 - lib/r2-oas/lib/three-way-merge/twm.rb
 - lib/r2-oas/logger/stdout_logger.rb
 - lib/r2-oas/pluggable_configuration.rb
@@ -379,9 +363,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/yukihirop/r2-oas/issues
-  changelog_uri: https://github.com/yukihirop/r2-oas/blob/v0.2.0/CHANGELOG.md
+  changelog_uri: https://github.com/yukihirop/r2-oas/blob/v0.3.4/CHANGELOG.md
   documentation_uri: https://yukihirop.github.io/r2-oas
-  source_code_uri: https://github.com/yukihirop/r2-oas/tree/v0.2.0
+  source_code_uri: https://github.com/yukihirop/r2-oas/tree/v0.3.4
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -397,8 +381,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Provide rake tasks to management API Docment (OpenAPI)

data/.github/ISSUE_TEMPLATE.md

@@ -1,12 +0,0 @@
-### Steps to reproduce
-
-### Expected behavior
-Tell us what should happen
-
-### Actual behavior
-Tell us what happens instead
-
-### System configuration
-**r2-oas version**:
-
-**Ruby version**:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +0,0 @@
-### Summary
-
-### Other Information
-
-If there's anything else that's important and relevant to your pull
-request, mention that information here. This could include
-benchmarks, or other information.
-
-If you are updating any of the CHANGELOG files or are asked to update the
-CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
-
-Thanks for contributing to r2-oas!