cli-kit 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6c63b562d9e105af0a13a110ad973bbb56d40a4
-  data.tar.gz: f89728ea2fd0f05ed1c9b6f16dbad900c4bc5595
+  metadata.gz: 283b38ecb21fd3caac8399447f06f5bccff261af
+  data.tar.gz: fe47b61139d7df53eca531693ba385c44a0c6455
 SHA512:
-  metadata.gz: 7088f3a7a238311cb8aaad7e83f74611ef30f2cbe0db5bbdc393d6c7da7ca51e68d54884c73707ea9751644c9ebdec6156829f939f4cf65044b5a690b053450a
-  data.tar.gz: 19fbec7a9eaee07f188c69f1d776404227f554dc38e44ff08bd2160026a45aac0e843526703ba0a1312bbcb853d2496bd5b5bf2b41d232f1ac033353b05b83c3
+  metadata.gz: 6f8723304b346c20418debde33e203bc3794ae0defc4e34308a7c2fbf5364fb22c41f7b7e800bbe5f2fb76a0ac90ca37e980c5ec641c71b3deb19d277d029b19
+  data.tar.gz: 6f08ef957f6f63b6fe108b6b6e118b5f887a9050ae8aed548445d8b77ff8ec47ff5a488f881b3e95e3682c30ba7098196876096a5cd70fd7fe312dd74292928c

data/Gemfile

@@ -4,13 +4,13 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
-  gem 'rubocop'
+  gem 'rubocop', '~> 0.56.0'
   gem 'byebug'
   gem 'method_source'
 end
 
 group :test do
-  gem 'mocha', require: false
+  gem 'mocha', '~> 1.5.0', require: false
   gem 'minitest', '>= 5.0.0', require: false
   gem 'minitest-reporters', require: false
 end

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    cli-kit (3.0.1)
-      cli-ui (>= 1.1.0)
+    cli-kit (3.1.0)
+      cli-ui (>= 1.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
-    ast (2.3.0)
+    ast (2.4.0)
     builder (3.2.3)
     byebug (9.0.6)
-    cli-ui (1.1.1)
+    cli-ui (1.1.4)
     metaclass (0.0.4)
     method_source (0.8.2)
     minitest (5.10.2)
@@ -20,24 +20,23 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mocha (1.2.1)
+    mocha (1.5.0)
       metaclass (~> 0.0.1)
-    parallel (1.11.2)
-    parser (2.4.0.0)
-      ast (~> 2.2)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
     powerpack (0.1.1)
-    rainbow (2.2.2)
-      rake
+    rainbow (3.0.0)
     rake (10.5.0)
-    rubocop (0.49.1)
+    rubocop (0.56.0)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
+      parser (>= 2.5)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.3.2)
 
 PLATFORMS
   ruby
@@ -49,9 +48,9 @@ DEPENDENCIES
   method_source
   minitest (>= 5.0.0)
   minitest-reporters
-  mocha
+  mocha (~> 1.5.0)
   rake (~> 10.0)
-  rubocop
+  rubocop (~> 0.56.0)
 
 BUNDLED WITH
    1.16.1

data/cli-kit.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'cli-ui', '>= 1.1.0'
+  spec.add_runtime_dependency 'cli-ui', '>= 1.1.4'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'

data/gen/lib/gen.rb

@@ -8,7 +8,10 @@ module Gen
 
   TOOL_NAME = 'cli-kit'
   ROOT      = File.expand_path('../../..', __FILE__)
-  LOG_FILE  = '/tmp/cli-kit.log'
+
+  TOOL_CONFIG_PATH = File.expand_path(File.join('~', '.config', TOOL_NAME))
+  LOG_FILE = File.join(TOOL_CONFIG_PATH, 'logs', 'log.log')
+  DEBUG_LOG_FILE = File.join(TOOL_CONFIG_PATH, 'logs', 'debug.log')
 
   autoload(:Generator, 'gen/generator')
 
@@ -17,6 +20,7 @@ module Gen
 
   autocall(:Config)  { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
   autocall(:Command) { CLI::Kit::BaseCommand }
+  autocall(:Logger)  { CLI::Kit::Logger.new(debug_log_file: DEBUG_LOG_FILE) }
 
   autocall(:Executor) { CLI::Kit::Executor.new(log_file: LOG_FILE) }
   autocall(:Resolver) do

data/gen/template/Gemfile

@@ -4,7 +4,7 @@ gem 'cli-kit', '~> __cli-kit-version__'
 gem 'cli-ui', '~> __cli-ui-version__'
 
 group :test do
-  gem 'mocha', require: false
+  gem 'mocha', '~> 1.5.0', require: false
   gem 'minitest', '>= 5.0.0', require: false
   gem 'minitest-reporters', require: false
 end

data/gen/template/test/example_test.rb

@@ -6,10 +6,12 @@ module __App__
 
     def test_example
       CLI::Kit::System.fake("ls -al", stdout: "a\nb", success: true)
-      assert_all_commands_run do
-        out, = CLI::Kit::System.capture2('ls', '-al')
-        assert_equal ['a', 'b'], out.split("\n")
-      end
+
+      out, = CLI::Kit::System.capture2('ls', '-al')
+      assert_equal %w(a b), out.split("\n")
+
+      errors = assert_all_commands_run(should_raise: false)
+      assert_nil errors, "expected command to run successfully"
     end
   end
 end

data/gen/template/test/test_helper.rb

@@ -18,4 +18,5 @@ require 'bundler/setup'
 CLI::UI::StdoutRouter.enable
 
 require 'minitest/autorun'
-require 'mocha/mini_test'
+require "minitest/unit"
+require 'mocha/minitest'

data/lib/cli/kit.rb

@@ -11,9 +11,11 @@ module CLI
     autoload :Executor,        'cli/kit/executor'
     autoload :Ini,             'cli/kit/ini'
     autoload :Levenshtein,     'cli/kit/levenshtein'
+    autoload :Logger,          'cli/kit/logger'
     autoload :Resolver,        'cli/kit/resolver'
     autoload :Support,         'cli/kit/support'
     autoload :System,          'cli/kit/system'
+    autoload :Util,            'cli/kit/util'
 
     EXIT_FAILURE_BUT_NOT_BUG = 30
     EXIT_BUG                 = 1

data/lib/cli/kit/base_command.rb

@@ -17,8 +17,7 @@ module CLI
 
       def self.call(args, command_name)
         cmd = new
-        stats_tags = ["task:#{cmd.class}"]
-        stats_tags << "subcommand:#{args.first}" if args && args.first && cmd.has_subcommands?
+        stats_tags = cmd.stats_tags(args)
         begin
           statsd_increment("cli.command.invoked", tags: stats_tags)
           statsd_time("cli.command.time", tags: stats_tags) do
@@ -31,6 +30,12 @@ module CLI
         end
       end
 
+      def stats_tags(args)
+        tags = ["task:#{self.class}"]
+        tags << "subcommand:#{args.first}" if args&.first && has_subcommands?
+        tags
+      end
+
       def call(_args, _command_name)
         raise NotImplementedError
       end

data/lib/cli/kit/command_registry.rb

@@ -68,7 +68,7 @@ module CLI
 
       def resolve_global_command(name)
         klass = resolve_class(commands.fetch(name, nil))
-        return nil unless klass && klass.defined?
+        return nil unless klass&.defined?
         [klass, name]
       rescue NameError
         nil

data/lib/cli/kit/config.rb

@@ -27,6 +27,18 @@ module CLI
         all_configs.dig("[#{section}]", name) || false
       end
 
+      # Coalesce and enforce the value of a config to a boolean
+      def get_bool(section, name)
+        case get(section, name).to_s
+        when "true"
+          true
+        when "false"
+          false
+        else
+          raise CLI::Kit::Abort, "Invalid config: #{section}.#{name} is expected to be true or false"
+        end
+      end
+
       # Sets the config value in the config file
       #
       # #### Parameters

data/lib/cli/kit/error_handler.rb

@@ -83,7 +83,7 @@ module CLI
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       rescue Interrupt
         $stderr.puts(format_error_message("Interrupt"))
-        return CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+        CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       end
 
       def exception_reporter

data/lib/cli/kit/executor.rb

@@ -1,22 +1,38 @@
 require 'cli/kit'
 require 'English'
+require 'fileutils'
 
 module CLI
   module Kit
     class Executor
       def initialize(log_file:)
+        FileUtils.mkpath(File.dirname(log_file))
         @log_file = log_file
       end
 
       def call(command, command_name, args)
-        with_traps { with_logging { command.call(args, command_name) } }
+        with_traps do
+          with_logging do |id|
+            begin
+              command.call(args, command_name)
+            rescue => e
+              $stderr.puts "This command ran with ID: #{id}"
+              $stderr.puts "Please include this information in any issues/report along with relevant logs"
+              raise e
+            end
+          end
+        end
       end
 
       private
 
       def with_logging(&block)
         return yield unless @log_file
-        CLI::UI.log_output_to(@log_file, &block)
+        CLI::UI.log_output_to(@log_file) do
+          CLI::UI::StdoutRouter.with_id(on_streams: [CLI::UI::StdoutRouter.duplicate_output_to]) do |id|
+            block.call(id)
+          end
+        end
       end
 
       def with_traps

data/lib/cli/kit/logger.rb

@@ -0,0 +1,76 @@
+require 'logger'
+require 'fileutils'
+
+module CLI
+  module Kit
+    class Logger
+      MAX_LOG_SIZE = 5 * 1024 * 1000 # 5MB
+      MAX_NUM_LOGS = 10
+
+      # Constructor for CLI::Kit::Logger
+      #
+      # @param debug_log_file [String] path to the file where debug logs should be stored
+      def initialize(debug_log_file:)
+        FileUtils.mkpath(File.dirname(debug_log_file))
+        @debug_logger = ::Logger.new(debug_log_file, MAX_NUM_LOGS, MAX_LOG_SIZE)
+      end
+
+      # Functionally equivalent to Logger#info
+      # Also logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      # @param debug [Boolean] determines if the debug logger will receive the log (default true)
+      def info(msg, debug: true)
+        $stdout.puts CLI::UI.fmt(msg)
+        @debug_logger.info(format_debug(msg)) if debug
+      end
+
+      # Functionally equivalent to Logger#warn
+      # Also logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      # @param debug [Boolean] determines if the debug logger will receive the log (default true)
+      def warn(msg, debug: true)
+        $stdout.puts CLI::UI.fmt("{{yellow:#{msg}}}")
+        @debug_logger.warn(format_debug(msg)) if debug
+      end
+
+      # Functionally equivalent to Logger#error
+      # Also logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      # @param debug [Boolean] determines if the debug logger will receive the log (default true)
+      def error(msg, debug: true)
+        $stderr.puts CLI::UI.fmt("{{red:#{msg}}}")
+        @debug_logger.error(format_debug(msg)) if debug
+      end
+
+      # Functionally equivalent to Logger#fatal
+      # Also logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      # @param debug [Boolean] determines if the debug logger will receive the log (default true)
+      def fatal(msg, debug: true)
+        $stderr.puts CLI::UI.fmt("{{red:{{bold:Fatal:}} #{msg}}}")
+        @debug_logger.fatal(format_debug(msg)) if debug
+      end
+
+      # Similar to Logger#debug, however will not output to STDOUT unless DEBUG env var is set
+      # Logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      def debug(msg)
+        $stdout.puts CLI::UI.fmt(msg) if ENV['DEBUG']
+        @debug_logger.debug(format_debug(msg))
+      end
+
+      private
+
+      def format_debug(msg)
+        msg = CLI::UI.fmt(msg)
+        return msg unless CLI::UI::StdoutRouter.current_id
+        "[#{CLI::UI::StdoutRouter.current_id[:id]}] #{msg}"
+      end
+    end
+  end
+end

data/lib/cli/kit/system.rb

@@ -117,10 +117,10 @@ module CLI
 
           handlers = if block_given?
             { out_r => ->(data) { yield(data.force_encoding(Encoding::UTF_8), '') },
-              err_r => ->(data) { yield('', data.force_encoding(Encoding::UTF_8)) }, }
+              err_r => ->(data) { yield('', data.force_encoding(Encoding::UTF_8)) } }
           else
             { out_r => ->(data) { STDOUT.write(data) },
-              err_r => ->(data) { STDOUT.write(data) }, }
+              err_r => ->(data) { STDOUT.write(data) } }
           end
 
           previous_trailing = Hash.new('')

data/lib/cli/kit/util.rb

@@ -0,0 +1,189 @@
+module CLI
+  module Kit
+    module Util
+      class << self
+        def snake_case(camel_case, seperator = "_")
+          camel_case.to_s # MyCoolThing::MyAPIModule
+            .gsub(/::/, '/') # MyCoolThing/MyAPIModule
+            .gsub(/([A-Z]+)([A-Z][a-z])/, "\\1#{seperator}\\2") # MyCoolThing::MyAPI_Module
+            .gsub(/([a-z\d])([A-Z])/, "\\1#{seperator}\\2") # My_Cool_Thing::My_API_Module
+            .downcase # my_cool_thing/my_api_module
+        end
+
+        def dash_case(camel_case)
+          snake_case(camel_case, '-')
+        end
+
+        # The following methods is taken from activesupport
+        # All credit for this method goes to the original authors.
+        # https://github.com/rails/rails/blob/d66e7835bea9505f7003e5038aa19b6ea95ceea1/activesupport/lib/active_support/core_ext/string/strip.rb
+        #
+        # Copyright (c) 2005-2018 David Heinemeier Hansson
+        #
+        # Permission is hereby granted, free of charge, to any person obtaining
+        # a copy of this software and associated documentation files (the
+        # "Software"), to deal in the Software without restriction, including
+        # without limitation the rights to use, copy, modify, merge, publish,
+        # distribute, sublicense, and/or sell copies of the Software, and to
+        # permit persons to whom the Software is furnished to do so, subject to
+        # the following conditions:
+        #
+        # The above copyright notice and this permission notice shall be
+        # included in all copies or substantial portions of the Software.
+        #
+        # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+        # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+        # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+        # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+        # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+        # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        #
+        # Strips indentation by removing the amount of leading whitespace in the least indented
+        # non-empty line in the whole string
+        #
+        def strip_heredoc(str)
+          str.gsub(/^#{str.scan(/^[ \t]*(?=\S)/).min}/, "".freeze)
+        end
+
+        # Joins an array with commas and "and", using the Oxford comma.
+        def english_join(array)
+          return "" if array.nil?
+          return array.join(" and ") if array.length < 3
+
+          "#{array[0..-2].join(', ')}, and #{array[-1]}"
+        end
+
+        # Execute a block within the context of a variable enviroment
+        #
+        def with_environment(environment, value)
+          return yield unless environment
+
+          old_env = ENV[environment]
+          begin
+            ENV[environment] = value
+            yield
+          ensure
+            old_env ? ENV[environment] = old_env : ENV.delete(environment)
+          end
+        end
+
+        # Converts an integer representing bytes into a human readable format
+        #
+        def to_filesize(bytes, precision: 2, space: false)
+          to_si_scale(bytes, 'B', precision: precision, space: space, factor: 1024)
+        end
+
+        # Converts a number to a human readable format on the SI scale
+        #
+        def to_si_scale(number, unit = '', factor: 1000, precision: 2, space: false)
+          raise ArgumentError, "factor should only be 1000 or 1024" unless [1000, 1024].include?(factor)
+
+          small_scale = %w(m µ n p f a z y)
+          big_scale = %w(k M G T P E Z Y)
+          negative = number < 0
+          number = number.abs.to_f
+
+          if number == 0 || number.between?(1, factor)
+            prefix = ""
+            scale = 0
+          else
+            scale = Math.log(number, factor).floor
+            if number < 1
+              index = [-scale - 1, small_scale.length].min
+              scale = -(index + 1)
+              prefix = small_scale[index]
+            else
+              index = [scale - 1, big_scale.length].min
+              scale = index + 1
+              prefix = big_scale[index]
+            end
+          end
+
+          divider = (factor**scale)
+          fnum = (number / divider).round(precision)
+
+          # Trim useless decimal
+          fnum = fnum.to_i if (fnum.to_i.to_f * divider) == number
+
+          fnum = -fnum if negative
+          prefix = " " + prefix if space
+
+          "#{fnum}#{prefix}#{unit}"
+        end
+
+        # Dir.chdir, when invoked in block form, complains when we call chdir
+        # again recursively. There's no apparent good reason for this, so we
+        # simply implement our own block form of Dir.chdir here.
+        def with_dir(dir)
+          prev = Dir.pwd
+          Dir.chdir(dir)
+          yield
+        ensure
+          Dir.chdir(prev)
+        end
+
+        def with_tmp_dir
+          require 'fileutils'
+          dir = Dir.mktmpdir
+          with_dir(dir) do
+            yield(dir)
+          end
+        ensure
+          FileUtils.remove_entry(dir)
+        end
+
+        # Standard way of checking for CI / Tests
+        def testing?
+          ci? || ENV['TEST']
+        end
+
+        # Set only in IntegrationTest#session; indicates that the process was
+        # called by `session.execute` from an IntegrationTest subclass.
+        def integration_test_session?
+          ENV['INTEGRATION_TEST_SESSION']
+        end
+
+        # Standard way of checking for CI
+        def ci?
+          ENV['CI']
+        end
+
+        # Must call retry_after on the result in order to execute the block
+        #
+        # Example usage:
+        #
+        # CLI::Kit::Util.begin do
+        #   might_raise_if_costly_prep_not_done()
+        # end.retry_after(ExpectedError) do
+        #   costly_prep()
+        # end
+        def begin(&block_that_might_raise)
+          Retrier.new(block_that_might_raise)
+        end
+      end
+
+      class Retrier
+        def initialize(block_that_might_raise)
+          @block_that_might_raise = block_that_might_raise
+        end
+
+        def retry_after(exception = StandardError, retries: 1, &before_retry)
+          @block_that_might_raise.call
+        rescue exception => e
+          raise if (retries -= 1) < 0
+          if before_retry
+            if before_retry.arity == 0
+              yield
+            else
+              yield e
+            end
+          end
+          retry
+        end
+      end
+
+      private_constant :Retrier
+    end
+  end
+end

data/lib/cli/kit/version.rb

@@ -1,5 +1,5 @@
 module CLI
   module Kit
-    VERSION = "3.0.1"
+    VERSION = "3.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-kit
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Burke Libbey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,11 +123,13 @@ files:
 - lib/cli/kit/executor.rb
 - lib/cli/kit/ini.rb
 - lib/cli/kit/levenshtein.rb
+- lib/cli/kit/logger.rb
 - lib/cli/kit/resolver.rb
 - lib/cli/kit/ruby_backports/enumerable.rb
 - lib/cli/kit/support.rb
 - lib/cli/kit/support/test_helper.rb
 - lib/cli/kit/system.rb
+- lib/cli/kit/util.rb
 - lib/cli/kit/version.rb
 homepage: https://github.com/shopify/cli-kit
 licenses: