r2-oas 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b365f9c68dd7df3c642a3b6d067d4a63f8e112806ee68711f949c76a244652e2
-  data.tar.gz: c3c3ef2eca59de1d9db5889d1191ae480b8c96e09ac58cf8ef9036bb932c3781
+  metadata.gz: a6ff37fb9f530ea30d7a06154dd6036ae63fdbd1358cab2d38bad3b2fd6334fc
+  data.tar.gz: 99f6574107d260c8961d645c1dfbc29b19143b19d5a903554e4576be39280f9f
 SHA512:
-  metadata.gz: 24fd75460c287ff115e05b9fb86fb8f5e253a99e0c368943d54ee4b5142425ce90086857220fa158e998b3325bc7ff40f5f0af87f9adf27a9d899e3d4a4747b5
-  data.tar.gz: 6a8b41ccaad2f0a4fc38b4af4fbb7a569042b76623a859ec8a9d4c42072805c5d7d0b037129ce7d82c6d50637fd493e7a08e0f2b7fa64773fe8218c3b7eadd7b
+  metadata.gz: 964aefff2e439e5d0eab907fc0c1301826dd81bdefa23f07d8ec822b054a4eb31c689b8e927e0ed28b4c790a26013c8d14d65d5706205fec5a02207fee661ec3
+  data.tar.gz: 484e127af388c3b633a5a7683f8493fa95fa2d1a6ef4981d227e37ce2676d7022170c18d708eb6ecb23eacfa9c48ac39865fe9e746e7d6fd94073e224c673047

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## v0.4.1
+
+2020-8-24
+
+- [`Breaking`] Remove `tool` tasks because it is infrequently used, it costs ([#162](https://github.com/yukihirop/r2-oas/pull/162))
+    - `routes:oas:paths_ls`
+    - `routes:oas:paths_stats`
+- [`Feature`] Add `SKIP_PLUGIN` enviroment variables ([#160](https://github.com/yukihirop/r2-oas/pull/160))
+
+Please see milestone [v0.4.1](https://github.com/yukihirop/r2-oas/milestone/6?closed=1)
+
 ## v0.4.0
 
 2020-07-22

data/README.md

@@ -57,7 +57,11 @@ $ brew cask install chromedriver
 
 ## 🚀 Tutorial
 
-After requiring a gem,
+After requiring a gem and Configure `Rakefile` in your rails project
+
+```rb
+R2OAS.load_tasks
+```
 
 ```bash
 bundle exec routes:oas:docs

data/lib/r2-oas.rb

@@ -11,8 +11,7 @@ module R2OAS
     extend Configuration
     require 'r2-oas/task'
     require 'r2-oas/plugin/public'
-    require 'r2-oas/lib/core_ext/hash/deep_merge'
-    require 'r2-oas/lib/core_ext/object/blank'
+    require 'r2-oas/lib/core_ext/all'
 
     autoload :Base, 'r2-oas/base'
     autoload :NoImplementError, 'r2-oas/errors'

data/lib/r2-oas/app_configuration.rb

@@ -2,7 +2,6 @@
 
 require_relative 'app_configuration/server'
 require_relative 'app_configuration/swagger'
-require_relative 'app_configuration/tool'
 require_relative 'app_configuration/deprecation'
 
 module R2OAS
@@ -43,7 +42,6 @@ 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 = :dot
     DEFAULT_DEPLOY_DIR_PATH = './deploy_docs'
@@ -67,7 +65,6 @@ module R2OAS
       http_statuses_when_http_method
       http_methods_when_generate_request_body
       ignored_http_statuses_when_generate_component_schema
-      tool
       namespace_type
       deploy_dir_path
       plugins
@@ -106,7 +103,6 @@ module R2OAS
       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

data/lib/r2-oas/configuration.rb

@@ -70,10 +70,7 @@ module R2OAS
     end
 
     def load_tasks
-      tasks_path = File.expand_path("#{root_dir_path}/#{local_tasks_dir_name}")
-      Dir.glob("#{tasks_path}/**/*.rake").sort.each do |file|
-        load file if FileTest.exists?(file)
-      end
+      load_local_tasks
     end
 
     def init
@@ -103,6 +100,13 @@ module R2OAS
 
     private
 
+    def load_local_tasks
+      tasks_path = File.expand_path("#{root_dir_path}/#{local_tasks_dir_name}")
+      Dir.glob("#{tasks_path}/**/*.rake").sort.each do |file|
+        load file if FileTest.exists?(file)
+      end
+    end
+
     def load_local_plugins
       plugins_path = File.expand_path("#{root_dir_path}/#{local_plugins_dir_name}")
       Dir.glob("#{plugins_path}/**/*.rb").sort.each do |file|

data/lib/r2-oas/lib/core_ext/all.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'hash/deep_merge'
+require_relative 'object/blank'
+require_relative 'string/filters'

data/lib/r2-oas/lib/core_ext/string/filters.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copy from https://github.com/rails/rails/blob/45b609c9964242f5c169d913c612eedce2a47397/activesupport/lib/active_support/core_ext/string/filters.rb#L11
+
+class String
+  # Returns the string, first removing all whitespace on both ends of
+  # the string, and then changing remaining consecutive whitespace
+  # groups into one space each.
+  #
+  # Note that it handles both ASCII and Unicode whitespace.
+  #
+  #   %{ Multi-line
+  #      string }.squish                   # => "Multi-line string"
+  #   " foo   bar    \n   \t   boo".squish # => "foo bar boo"
+  def squish
+    dup.squish!
+  end
+
+  # Performs a destructive squish. See String#squish.
+  #   str = " foo   bar    \n   \t   boo"
+  #   str.squish!                         # => "foo bar boo"
+  #   str                                 # => "foo bar boo"
+  def squish!
+    gsub!(/\A[[:space:]]+/, '')
+    gsub!(/[[:space:]]+\z/, '')
+    gsub!(/[[:space:]]+/, ' ')
+    self
+  end
+end

data/lib/r2-oas/support/deprecation.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'singleton'
+
 require_relative 'deprecation/instance_delegator'
 require_relative 'deprecation/reporting'
 require_relative 'deprecation/behavior'

data/lib/r2-oas/task.rb

@@ -4,8 +4,7 @@ module R2OAS
   class Task < ::Rails::Railtie
     rake_tasks do
       main_task_path = File.join(File.dirname(__FILE__), './tasks/main.rake')
-      tool_task_path = File.join(File.dirname(__FILE__), './tasks/tool.rake')
-      Dir[main_task_path, tool_task_path].each { |f| load f }
+      Dir[main_task_path].each { |f| load f }
     end
   end
 end

data/lib/r2-oas/tasks/main.rake

@@ -3,6 +3,7 @@
 require 'r2-oas/schema/editor'
 require 'r2-oas/schema/ui'
 require 'r2-oas/schema/monitor'
+require 'r2-oas/deploy/client'
 require 'r2-oas/task_logging'
 load File.expand_path('common.rake', __dir__)
 
@@ -44,7 +45,8 @@ namespace :routes do
         FileUtils.mkdir_p(output_dir_path) unless FileTest.exists?(output_dir_path)
 
         is_overrirde_src = override_src.eql? 'true'
-        builder_options = { unit_paths_file_path: unit_paths_file_path, use_plugin: true, output: true }
+        use_plugin = skip_plugin.eql? 'false'
+        builder_options = { unit_paths_file_path: unit_paths_file_path, use_plugin: use_plugin, output: true }
         builder = R2OAS::Schema::Builder.new(builder_options)
         builder.build_docs
 
@@ -111,6 +113,29 @@ namespace :routes do
       end
     end
 
+    desc '[R2-OAS] 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
+
+        output_dir_path = File.expand_path(R2OAS.output_dir_path)
+        FileUtils.mkdir_p(output_dir_path) unless FileTest.exists?(output_dir_path)
+
+        builder_options = { unit_paths_file_path: unit_paths_file_path, use_plugin: true, output: true }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        download_dist_th.join
+        client.deploy
+      end
+    end
+
     private
 
     def unit_paths_file_path
@@ -128,5 +153,9 @@ namespace :routes do
     def override_src
       ENV.fetch('OVERRIDE_SRC', 'false')
     end
+
+    def skip_plugin
+      ENV.fetch('SKIP_PLUGIN', 'false')
+    end
   end
 end

data/lib/r2-oas/version.rb

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

data/r2-oas.gemspec

@@ -33,9 +33,7 @@ Gem::Specification.new do |spec|
   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 '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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r2-oas
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - yukihirop
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: paint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.5
-- !ruby/object:Gem::Dependency
-  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
@@ -263,8 +235,6 @@ files:
 - lib/r2-oas/app_configuration/swagger.rb
 - lib/r2-oas/app_configuration/swagger/editor.rb
 - lib/r2-oas/app_configuration/swagger/ui.rb
-- lib/r2-oas/app_configuration/tool.rb
-- lib/r2-oas/app_configuration/tool/paths/stats.rb
 - lib/r2-oas/base.rb
 - lib/r2-oas/configuration.rb
 - lib/r2-oas/configuration/paths_config.rb
@@ -275,8 +245,10 @@ files:
 - 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/all.rb
 - lib/r2-oas/lib/core_ext/hash/deep_merge.rb
 - lib/r2-oas/lib/core_ext/object/blank.rb
+- lib/r2-oas/lib/core_ext/string/filters.rb
 - lib/r2-oas/lib/three-way-merge/twm.rb
 - lib/r2-oas/logger/stdout_logger.rb
 - lib/r2-oas/pluggable_configuration.rb
@@ -380,9 +352,6 @@ files:
 - lib/r2-oas/task_logging.rb
 - lib/r2-oas/tasks/common.rake
 - lib/r2-oas/tasks/main.rake
-- lib/r2-oas/tasks/tool.rake
-- lib/r2-oas/tool/paths/ls.rb
-- lib/r2-oas/tool/paths/stats.rb
 - lib/r2-oas/version.rb
 - r2-oas.gemspec
 homepage: https://github.com/yukihirop/r2-oas
@@ -390,9 +359,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/yukihirop/r2-oas/issues
-  changelog_uri: https://github.com/yukihirop/r2-oas/blob/v0.4.0/CHANGELOG.md
+  changelog_uri: https://github.com/yukihirop/r2-oas/blob/v0.4.1/CHANGELOG.md
   documentation_uri: https://yukihirop.github.io/r2-oas
-  source_code_uri: https://github.com/yukihirop/r2-oas/tree/v0.4.0
+  source_code_uri: https://github.com/yukihirop/r2-oas/tree/v0.4.1
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/r2-oas/app_configuration/tool.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'tool/paths/stats'
-
-module R2OAS
-  module AppConfiguration
-    class Tool
-      DEFAULT_PATHS_STATS = PathsStats.new
-
-      VALID_OPTIONS_KEYS = [
-        :paths_stats
-      ].freeze
-
-      attr_accessor *VALID_OPTIONS_KEYS
-
-      def initialize
-        set_default
-      end
-
-      def configure
-        yield self
-      end
-
-      private
-
-      def set_default
-        self.paths_stats = DEFAULT_PATHS_STATS
-      end
-    end
-  end
-end

data/lib/r2-oas/app_configuration/tool/paths/stats.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module R2OAS
-  module AppConfiguration
-    class Tool
-      class PathsStats
-        DEFAULT_MONTH_TO_TURN_TO_WARNING_COLOR = 3
-        DEFAULT_WARNING_COLOR = :red
-        DEFAULT_TABLE_TITLE_COLOR = :yellow
-        DEFAULT_HEADING_COLOR = :yellow
-        DEFAULT_HIGHLIGHT_COLOR = :magenta
-
-        VALID_OPTIONS_KEYS = %i[
-          month_to_turn_to_warning_color
-          warning_color
-          table_title_color
-          heading_color
-          highlight_color
-        ].freeze
-
-        attr_accessor *VALID_OPTIONS_KEYS
-
-        def initialize
-          set_default
-        end
-
-        def configure
-          yield self
-        end
-
-        private
-
-        def set_default
-          self.month_to_turn_to_warning_color = DEFAULT_MONTH_TO_TURN_TO_WARNING_COLOR
-          self.warning_color                  = DEFAULT_WARNING_COLOR
-          self.table_title_color              = DEFAULT_TABLE_TITLE_COLOR
-          self.heading_color                  = DEFAULT_HEADING_COLOR
-          self.highlight_color                = DEFAULT_HIGHLIGHT_COLOR
-        end
-      end
-    end
-  end
-end

data/lib/r2-oas/tasks/tool.rake

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require 'r2-oas/deploy/client'
-require 'r2-oas/tool/paths/ls'
-require 'r2-oas/tool/paths/stats'
-require 'r2-oas/task_logging'
-load File.expand_path('common.rake', __dir__)
-
-namespace :routes do
-  namespace :oas do
-    desc '[R2-OAS] 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
-
-        output_dir_path = File.expand_path(R2OAS.output_dir_path)
-        FileUtils.mkdir_p(output_dir_path) unless FileTest.exists?(output_dir_path)
-
-        builder_options = { unit_paths_file_path: unit_paths_file_path, use_plugin: true, output: true }
-        builder = R2OAS::Schema::Builder.new(builder_options)
-        builder.build_docs
-
-        download_dist_th.join
-        client.deploy
-      end
-    end
-
-    desc '[R2-OAS] Display paths list'
-    task paths_ls: [:common] do
-      fd = IO.sysopen('/dev/null', 'w+')
-      $stdout = IO.new(fd)
-      logger.level = :null
-
-      start do
-        $stdout = StringIO.new
-
-        paths_ls_options = {}
-        paths_ls = R2OAS::Tool::Paths::Ls.new(paths_ls_options)
-        paths_ls.print
-      end
-
-      result = $stdout.string
-      $stdout = STDOUT
-      puts result
-    end
-
-    desc '[R2-OAS] Display paths stats'
-    task paths_stats: [:common] do
-      fd = IO.sysopen('/dev/null', 'w+')
-      $stdout = IO.new(fd)
-      logger.level = :null
-
-      start do
-        builder_options = { skip_load_dot_paths: true }
-        builder = R2OAS::Schema::Builder.new(builder_options)
-        builder.build_docs
-
-        $stdout = StringIO.new
-
-        paths_log_options = {}
-        paths_log = R2OAS::Tool::Paths::Stats.new(paths_log_options)
-        paths_log.print
-      end
-
-      result = $stdout.string
-      $stdout = STDOUT
-      puts result
-    end
-
-    private
-
-    def unit_paths_file_path
-      ENV.fetch('PATHS_FILE', '')
-    end
-
-    def existing_schema_file_path
-      ENV.fetch('OAS_FILE', '')
-    end
-  end
-end

data/lib/r2-oas/tool/paths/ls.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module R2OAS
-  module Tool
-    module Paths
-      class Ls < Base
-        def print
-          Dir.glob("#{schema_save_dir_path}/paths/**/**.yml").each do |path|
-            puts path.sub(%r{^#{Dir.getwd}/?}, '')
-          end
-        end
-      end
-    end
-  end
-end

data/lib/r2-oas/tool/paths/stats.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-require 'terminal-table'
-require 'paint'
-require 'forwardable'
-
-module R2OAS
-  module Tool
-    module Paths
-      class Stats < Base
-        extend Forwardable
-
-        TIMESTAMPS = ['Created At', 'Updated At'].freeze
-        TABLE_TITLE = 'Paths Stats'
-
-        def initialize(options = {})
-          super
-          @paths_list = Dir.glob("#{schema_save_dir_path}/paths/**/**.yml")
-          @path_from = Pathname(File.dirname(File.expand_path(root_dir_path)))
-          @paths_stats = tool.paths_stats
-        end
-
-        def print
-          table.title = Paint[TABLE_TITLE, table_title_color]
-          puts table
-          puts "\n#{Paint['Red', warning_color]}: over #{month_to_turn_to_warning_color} months since the last update."
-        end
-
-        private
-
-        def_delegators :@paths_stats, :month_to_turn_to_warning_color, :warning_color, :table_title_color, :heading_color, :highlight_color
-
-        def table
-          @table ||= Terminal::Table.new do |t|
-            @paths_list.each_with_index do |file_path, index|
-              t.headings = ['No', 'File Path', *TIMESTAMPS].map { |head| Paint[head, heading_color] }
-              t << table_content(index, file_path)
-              t.style = { all_separators: true }
-            end
-          end
-        end
-
-        def table_content(index, file_path)
-          content = [(index + 1).to_s, relative_file_path(file_path), *timestamps(file_path)]
-          if file_path.in? paths_config.many_paths_file_paths
-            content.map { |c| Paint[c, highlight_color] }
-          else
-            content
-          end
-        end
-
-        def relative_file_path(file_path)
-          path_to = Pathname(file_path)
-          path_to.relative_path_from(@path_from).to_s
-        end
-
-        def timestamps(file_path)
-          timestamps_data(file_path) do |result, stat|
-            mtime = stat.mtime
-            result.deep_merge!(
-              mtime: expired?(mtime) ? Paint[mtime, warning_color] : mtime
-            )
-          end.values
-        end
-
-        def timestamps_data(file_path)
-          stat = File::Stat.new(file_path)
-          result = {
-            birthtime: stat.birthtime,
-            mtime: stat.mtime
-          }
-          yield result, stat if block_given?
-          result
-        end
-
-        def expired?(mtime)
-          month = month_to_turn_to_warning_color.send(:month)
-          expired_at = Time.current.ago(month)
-          mtime < expired_at
-        end
-      end
-    end
-  end
-end