cli-kit 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1c78454dde57819601c7ef40040c02943b72ea2f3831718a2a4362731c2cf9a
-  data.tar.gz: 6e4e1adcdd54eb38d419b2d2d936ec03a05190cf72baaabd1002e1407dfdcf49
+  metadata.gz: 523252459712e507c4579e244e6330eb3e8a5d8c71334d4e41553903ab651cd6
+  data.tar.gz: 459cb0a684e2890718d0cffdd74cd8540bd91a1995dfe1db593df9a189da20d7
 SHA512:
-  metadata.gz: f57fe58683a342a39957fd19cedc79641583456100e7e63b71e4e395b0fc705938ccaa1574bc36d975dda6f6b5c7fcbf28406972432abcf3ac890bb1334e2715
-  data.tar.gz: 5f1f0bf80809f7ff4ae97ab4cd0871ceaef6b4c4967b06fdcae5ccb1c869524c351c1a2acf7cab83cd2416ce37766033b5c63d6ff2480fd660067d74dcc51f8f
+  metadata.gz: 8579924711573ce6338b52dc44c47ad40c12f925bbd6f3ad6cee5be9f44b2b4f315e6d272adc309788b0418ee6806567660f0386d7e91d9d09a524beeb0a4a1f
+  data.tar.gz: b5507292ba97fd6f13b83b6426e81e4500e0ef1480387164c936164b7593bf7daac98e39cbb835362f198c39e562f2d12adf92384365a9c99a7f0ed42c158a45

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "07:00"
+    timezone: America/Toronto
+  open-pull-requests-limit: 99

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+        bundler-cache: true
+    - name: Check style
+      run: bundle exec rake style
+  test:
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        ruby-version: ['2.6', '2.7']
+
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake test

data/.rubocop.yml

@@ -1,9 +1,11 @@
-inherit_from:
-  - http://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop-cli.yml
 
 AllCops:
-  Exclude: [ 'gen/template/**/*' ]
-  TargetRubyVersion: 2.3
+  Exclude:
+    - gen/template/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.5
 
 Style/ClassAndModuleChildren:
   Exclude:
@@ -12,15 +14,8 @@ Style/ClassAndModuleChildren:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Shopify/RubocopComments:
-  Enabled: false
-
-# This doesn't understand that <<~ doesn't exist in 2.0
-Layout/IndentHeredoc:
-  Enabled: false
-
 # This doesn't take into account retrying from an exception
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
 # allow String.new to create mutable strings
@@ -39,6 +34,5 @@ Style/RegexpLiteral:
 Style/MultilineBlockChain:
   Enabled: false
 
-# allow using names to be more expressive
-Performance/RedundantBlockCall:
-  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/Gemfile

@@ -1,16 +1,17 @@
 # NOTE: These are development-only dependencies
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
 group :development, :test do
-  gem 'rubocop', '~> 0.56.0'
+  gem 'rubocop'
+  gem 'rubocop-shopify'
   gem 'byebug'
   gem 'method_source'
 end
 
 group :test do
-  gem 'mocha', '~> 1.5.0', require: false
+  gem 'mocha', '~> 1.13.0', require: false
   gem 'minitest', '>= 5.0.0', require: false
   gem 'minitest-reporters', require: false
 end

data/Gemfile.lock

@@ -1,56 +1,62 @@
 PATH
   remote: .
   specs:
-    cli-kit (3.3.0)
+    cli-kit (4.0.0)
       cli-ui (>= 1.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
-    ast (2.4.0)
-    builder (3.2.3)
-    byebug (9.0.6)
-    cli-ui (1.2.3)
-    metaclass (0.0.4)
-    method_source (0.8.2)
-    minitest (5.10.2)
-    minitest-reporters (1.1.14)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    cli-ui (1.5.1)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mocha (1.5.0)
-      metaclass (~> 0.0.1)
-    parallel (1.12.1)
-    parser (2.5.1.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.1)
+    mocha (1.13.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rubocop (0.56.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.22.3)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    unicode-display_width (1.3.2)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-shopify (2.3.0)
+      rubocop (~> 1.22)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.15)
+  bundler (~> 2.1)
   byebug
   cli-kit!
   method_source
   minitest (>= 5.0.0)
   minitest-reporters
-  mocha (~> 1.5.0)
-  rake (~> 10.0)
-  rubocop (~> 0.56.0)
+  mocha (~> 1.13.0)
+  rake (~> 13.0)
+  rubocop
+  rubocop-shopify
 
 BUNDLED WITH
-   1.17.3
+   2.2.24

data/Rakefile

@@ -1 +1,27 @@
-require "bundler/gem_tasks"
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+
+TEST_ROOT = File.expand_path('../test', __FILE__)
+
+Rake::TestTask.new do |t|
+  t.libs += ['test']
+  t.test_files = FileList[File.join(TEST_ROOT, '**', '*_test.rb')]
+  t.verbose = false
+  t.warning = false
+end
+
+RuboCop::RakeTask.new(:style) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task :test_gen_bundler do
+  sh 'DEPS=bundler bin/test_gen'
+end
+
+task :test_gen_vendor do
+  sh 'DEPS=vendor bin/test_gen'
+end
+
+task(default: [:test, :style, :test_gen_bundler, :test_gen_vendor])

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "cli/kit"
+require 'bundler/setup'
+require 'cli/kit'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "cli/kit"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/test_gen

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+set -euo pipefail
 
 # Make sure we're in the cli kit directory
 CURR_DIR=$(dirname "$0")
@@ -19,7 +20,9 @@ mv myapp ../
 cd ../myapp
 
 # Test
-bundle install
+if [[ $DEPS == 'bundler' ]]; then
+  bundle install
+fi
 bin/testunit
 
 if [[ $DEPS == 'vendor' ]]; then

data/bin/testunit

@@ -9,12 +9,12 @@ CLI_TEST_ROOT = root + '/test'
 $LOAD_PATH.unshift(CLI_TEST_ROOT)
 
 def test_files
-  Dir.glob(CLI_TEST_ROOT + "/**/*_test.rb")
+  Dir.glob(CLI_TEST_ROOT + '/**/*_test.rb')
 end
 
 if ARGV.empty?
   test_files.each { |f| require(f) }
-  exit 0
+  exit(0)
 end
 
 # A list of files is presumed to be specified

data/cli-kit.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cli/kit/version'
@@ -14,16 +15,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/shopify/cli-kit'
   spec.license       = 'MIT'
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = %x(git ls-files -z).split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'cli-ui', '>= 1.1.4'
+  spec.add_runtime_dependency('cli-ui', '>= 1.1.4')
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency('bundler', '~> 2.1')
+  spec.add_development_dependency('minitest', '~> 5.0')
+  spec.add_development_dependency('rake', '~> 13.0')
 end

data/dev.yml

@@ -1,5 +1,5 @@
 up:
-  - ruby: 2.3.3
+  - ruby: 2.7.0
   - bundler
 
 commands:

data/examples/minimal/example.rb

@@ -5,12 +5,12 @@ require 'cli/kit'
 
 CLI::UI::StdoutRouter.enable
 
-include CLI::Kit
+include(CLI::Kit)
 
 registry = CommandRegistry.new(default: 'hello', contextual_resolver: nil)
 registry.add(Class.new(BaseCommand) do
   def call(_args, _name)
-    puts "hello, world!"
+    puts 'hello, world!'
   end
 end, 'hello')
 

data/examples/single-file/example.rb

@@ -30,7 +30,7 @@ module Example
     register(:Hello, 'hello') do
       Class.new(Example::Command) do
         def call(_args, _name)
-          puts "hello, world!"
+          puts 'hello, world!'
         end
       end
     end

data/gen/lib/gen/commands/help.rb

@@ -4,15 +4,15 @@ module Gen
   module Commands
     class Help < Gen::Command
       def call(_args, _name)
-        puts CLI::UI.fmt("{{bold:Available commands}}")
-        puts ""
+        puts CLI::UI.fmt('{{bold:Available commands}}')
+        puts ''
 
         Gen::Commands::Registry.resolved_commands.each do |name, klass|
           puts CLI::UI.fmt("{{command:#{Gen::TOOL_NAME} #{name}}}")
-          if klass.respond_to?(:help) && help = klass.help
+          if klass.respond_to?(:help) && (help = klass.help)
             puts CLI::UI.fmt(help)
           end
-          puts ""
+          puts ''
         end
       end
     end

data/gen/lib/gen/generator.rb

@@ -18,20 +18,20 @@ module Gen
     # false  -> delete file
     # string -> rename file before applying template substitutions
     VENDOR_TRANSLATIONS = {
-      'Gemfile'            => false,
-      'exe/__app__-gems'   => false,
+      'Gemfile' => false,
+      'exe/__app__-gems' => false,
       'exe/__app__-vendor' => 'exe/__app__',
-      'dev-gems.yml'       => false,
-      'dev-vendor.yml'     => 'dev.yml',
+      'dev-gems.yml' => false,
+      'dev-vendor.yml' => 'dev.yml',
     }.freeze
     private_constant :VENDOR_TRANSLATIONS
 
     BUNDLER_TRANSLATIONS = {
-      'bin/update-deps'    => false,
-      'exe/__app__-gems'   => 'exe/__app__',
+      'bin/update-deps' => false,
+      'exe/__app__-gems' => 'exe/__app__',
       'exe/__app__-vendor' => false,
-      'dev-gems.yml'       => 'dev.yml',
-      'dev-vendor.yml'     => false,
+      'dev-gems.yml' => 'dev.yml',
+      'dev-vendor.yml' => false,
     }.freeze
     private_constant :BUNDLER_TRANSLATIONS
 
@@ -58,8 +58,8 @@ module Gen
     private
 
     def ask_vendor?
-      return 'vendor' if ENV['DEPS'] == 'vendor'
-      return 'bundler' if ENV['DEPS'] == 'bundler'
+      return true if ENV['DEPS'] == 'vendor'
+      return false if ENV['DEPS'] == 'bundler'
 
       vendor = nil
       CLI::UI::Frame.open('Configuration') do
@@ -116,7 +116,7 @@ module Gen
       out, stat = Open3.capture2e('git', '-C', dir, 'clone', "https://github.com/shopify/#{repo}")
       unless stat.success?
         STDERR.puts(out)
-        error("git clone failed")
+        error('git clone failed')
       end
     end
 

data/lib/cli/kit/base_command.rb

@@ -19,13 +19,13 @@ module CLI
         cmd = new
         stats_tags = cmd.stats_tags(args, command_name)
         begin
-          statsd_increment("cli.command.invoked", tags: stats_tags)
-          statsd_time("cli.command.time", tags: stats_tags) do
+          statsd_increment('cli.command.invoked', tags: stats_tags)
+          statsd_time('cli.command.time', tags: stats_tags) do
             cmd.call(args, command_name)
           end
-          statsd_increment("cli.command.success", tags: stats_tags)
+          statsd_increment('cli.command.success', tags: stats_tags)
         rescue Exception => e # rubocop:disable Lint/RescueException
-          statsd_increment("cli.command.exception", tags: stats_tags + ["exception:#{e.class}"])
+          statsd_increment('cli.command.exception', tags: stats_tags + ["exception:#{e.class}"])
           raise e
         end
       end
@@ -38,7 +38,7 @@ module CLI
       end
 
       def call(_args, _command_name)
-        raise NotImplementedError
+        raise NotImplementedError, "#{self.class.name} must implement #{__method__}"
       end
 
       def has_subcommands?

data/lib/cli/kit/config.rb

@@ -18,22 +18,24 @@ module CLI
       # `name` : the name of the config value you are looking for
       #
       # #### Returns
-      # `value` : the value of the config variable (false if none)
+      # `value` : the value of the config variable (nil if none)
       #
       # #### Example Usage
       # `config.get('name.of.config')`
       #
-      def get(section, name, default: false)
+      def get(section, name, default: nil)
         all_configs.dig("[#{section}]", name) || default
       end
 
       # Coalesce and enforce the value of a config to a boolean
       def get_bool(section, name, default: false)
-        case get(section, name, default: default).to_s
-        when "true"
+        case get(section, name, default: default)
+        when 'true'
           true
-        when "false"
+        when 'false'
           false
+        when default
+          default
         else
           raise CLI::Kit::Abort, "Invalid config: #{section}.#{name} is expected to be true or false"
         end
@@ -116,7 +118,7 @@ module CLI
 
       def ini
         @ini ||= CLI::Kit::Ini
-          .new(file, default_section: "[global]", convert_types: false)
+          .new(file, default_section: '[global]', convert_types: false)
           .tap(&:parse)
       end
 

data/lib/cli/kit/error_handler.rb

@@ -22,7 +22,7 @@ module CLI
       end
 
       def handle_exception(error)
-        if notify_with = exception_for_submission(error)
+        if (notify_with = exception_for_submission(error))
           logs = begin
             File.read(@log_file)
           rescue => e
@@ -46,7 +46,7 @@ module CLI
         when CLI::Kit::Abort, CLI::Kit::AbortSilent # Not a bug
           nil
         when SignalException
-          skip = %w(SIGTERM SIGHUP SIGINT)
+          skip = ['SIGTERM', 'SIGHUP', 'SIGINT']
           skip.include?(error.message) ? nil : error
         when SystemExit # "exit N" called
           case error.status
@@ -56,7 +56,7 @@ module CLI
             # if it was `exit 30`, translate the exit code to 1, and submit nothing.
             # 30 is used to signal normal failures that are not indicative of bugs.
             # However, users should see it presented as 1.
-            exit 1
+            exit(1)
           else
             # A weird termination status happened. `error.exception "message"` will maintain backtrace
             # but allow us to set a message
@@ -83,18 +83,24 @@ module CLI
 
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       rescue Interrupt
-        $stderr.puts(format_error_message("Interrupt"))
+        stderr_puts_message('Interrupt')
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       rescue Errno::ENOSPC
         message = if @tool_name
           "Your disk is full - {{command:#{@tool_name}}} requires free space to operate"
         else
-          "Your disk is full - free space is required to operate"
+          'Your disk is full - free space is required to operate'
         end
-        $stderr.puts(format_error_message(message))
+        stderr_puts_message(message)
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       end
 
+      def stderr_puts_message(message)
+        $stderr.puts(format_error_message(message))
+      rescue Errno::EPIPE
+        nil
+      end
+
       def exception_reporter
         if @exception_reporter_or_proc.respond_to?(:report)
           @exception_reporter_or_proc

data/lib/cli/kit/executor.rb

@@ -13,19 +13,17 @@ module CLI
       def call(command, command_name, args)
         with_traps do
           with_logging do |id|
+            command.call(args, command_name)
+          rescue => e
             begin
-              command.call(args, command_name)
-            rescue => e
-              begin
-                $stderr.puts "This command ran with ID: #{id}"
-                $stderr.puts "Please include this information in any issues/report along with relevant logs"
-              rescue SystemCallError
-                # Outputting to stderr is best-effort.  Avoid raising another error when outputting debug info so that
-                # we can detect and log the original error, which may even be the source of this error.
-                nil
-              end
-              raise e
+              $stderr.puts "This command ran with ID: #{id}"
+              $stderr.puts 'Please include this information in any issues/report along with relevant logs'
+            rescue SystemCallError
+              # Outputting to stderr is best-effort.  Avoid raising another error when outputting debug info so that
+              # we can detect and log the original error, which may even be the source of this error.
+              nil
             end
+            raise e
           end
         end
       end
@@ -41,11 +39,9 @@ module CLI
         end
       end
 
-      def with_traps
+      def with_traps(&block)
         twrap('QUIT', method(:quit_handler)) do
-          twrap('INFO', method(:info_handler)) do
-            yield
-          end
+          twrap('INFO', method(:info_handler), &block)
         end
       end
 
@@ -53,10 +49,17 @@ module CLI
         return yield unless Signal.list.key?(signal)
 
         begin
-          prev_handler = trap(signal, handler)
+          begin
+            prev_handler = trap(signal, handler)
+            installed = true
+          rescue ArgumentError
+            # If we couldn't install a signal handler because the signal is
+            # reserved, remember not to uninstall it later.
+            installed = false
+          end
           yield
         ensure
-          trap(signal, prev_handler)
+          trap(signal, prev_handler) if installed
         end
       end
 

data/lib/cli/kit/ini.rb

@@ -61,11 +61,11 @@ module CLI
       private
 
       def to_ini(h, git_format: false)
-        optional_tab = git_format ? "\t" : ""
+        optional_tab = git_format ? "\t" : ''
         str = []
         h.each do |k, v|
           if section_designator?(k)
-            str << "" unless str.empty? || git_format
+            str << '' unless str.empty? || git_format
             str << k
             str << to_ini(v, git_format: git_format)
           else

data/lib/cli/kit/logger.rb

@@ -10,9 +10,10 @@ module CLI
       # 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:)
+      def initialize(debug_log_file:, env_debug_name: 'DEBUG')
         FileUtils.mkpath(File.dirname(debug_log_file))
         @debug_logger = ::Logger.new(debug_log_file, MAX_NUM_LOGS, MAX_LOG_SIZE)
+        @env_debug_name = env_debug_name
       end
 
       # Functionally equivalent to Logger#info
@@ -60,7 +61,7 @@ module CLI
       #
       # @param msg [String] the message to log
       def debug(msg)
-        $stdout.puts CLI::UI.fmt(msg) if ENV['DEBUG']
+        $stdout.puts CLI::UI.fmt(msg) if debug?
         @debug_logger.debug(format_debug(msg))
       end
 
@@ -71,6 +72,11 @@ module CLI
         return msg unless CLI::UI::StdoutRouter.current_id
         "[#{CLI::UI::StdoutRouter.current_id[:id]}] #{msg}"
       end
+
+      def debug?
+        val = ENV[@env_debug_name]
+        val && val != '0' && val != ''
+      end
     end
   end
 end

data/lib/cli/kit/resolver.rb

@@ -25,7 +25,7 @@ module CLI
       private
 
       def command_not_found(name)
-        CLI::UI::Frame.open("Command not found", color: :red, timing: false) do
+        CLI::UI::Frame.open('Command not found', color: :red, timing: false) do
           $stderr.puts(CLI::UI.fmt("{{command:#{@tool_name} #{name}}} was not found"))
         end
 
@@ -43,7 +43,7 @@ module CLI
 
           # If we have any matches left, tell the user
           if possible_matches.any?
-            CLI::UI::Frame.open("{{bold:Did you mean?}}", timing: false, color: :blue) do
+            CLI::UI::Frame.open('{{bold:Did you mean?}}', timing: false, color: :blue) do
               possible_matches.each do |possible_match|
                 $stderr.puts CLI::UI.fmt("{{command:#{@tool_name} #{possible_match}}}")
               end

data/lib/cli/kit/support/test_helper.rb

@@ -10,7 +10,7 @@ module CLI
         def assert_all_commands_run(should_raise: true)
           errors = CLI::Kit::System.error_message
           CLI::Kit::System.reset!
-          assert false, errors if should_raise && !errors.nil?
+          assert(false, errors) if should_raise && !errors.nil?
           errors
         end
 
@@ -134,8 +134,8 @@ module CLI
                 #
                 # Note: Must set allow or success
                 #
-                def fake(*a, stdout: "", stderr: "", allow: nil, success: nil, sudo: false, env: {})
-                  raise ArgumentError, "success or allow must be set" if success.nil? && allow.nil?
+                def fake(*a, stdout: '', stderr: '', allow: nil, success: nil, sudo: false, env: {})
+                  raise ArgumentError, 'success or allow must be set' if success.nil? && allow.nil?
 
                   @delegate_open3 ||= {}
                   @delegate_open3[a.join(' ')] = {
@@ -196,22 +196,22 @@ module CLI
 
                   unless errors[:unexpected].empty?
                     final_error << CLI::UI.fmt(<<~EOF)
-                    {{bold:Unexpected command invocations:}}
-                    {{command:#{errors[:unexpected].join("\n")}}}
+                      {{bold:Unexpected command invocations:}}
+                      {{command:#{errors[:unexpected].join("\n")}}}
                     EOF
                   end
 
                   unless errors[:not_run].empty?
                     final_error << CLI::UI.fmt(<<~EOF)
-                    {{bold:Expected commands were not run:}}
-                    {{command:#{errors[:not_run].join("\n")}}}
+                      {{bold:Expected commands were not run:}}
+                      {{command:#{errors[:not_run].join("\n")}}}
                     EOF
                   end
 
                   unless errors[:other].empty?
                     final_error << CLI::UI.fmt(<<~EOF)
-                    {{bold:Commands were not run as expected:}}
-                    #{errors[:other].map { |cmd, msg| "{{command:#{cmd}}}\n#{msg}" }.join("\n\n")}
+                      {{bold:Commands were not run as expected:}}
+                      #{errors[:other].map { |cmd, msg| "{{command:#{cmd}}}\n#{msg}" }.join("\n\n")}
                     EOF
                   end
 

data/lib/cli/kit/system.rb

@@ -6,7 +6,7 @@ require 'English'
 module CLI
   module Kit
     module System
-      SUDO_PROMPT = CLI::UI.fmt("{{info:(sudo)}} Password: ")
+      SUDO_PROMPT = CLI::UI.fmt('{{info:(sudo)}} Password: ')
       class << self
         # Ask for sudo access with a message explaning the need for it
         # Will make subsequent commands capable of running with sudo for a period of time
@@ -19,7 +19,7 @@ module CLI
         #
         def sudo_reason(msg)
           # See if sudo has a cached password
-          `env SUDO_ASKPASS=/usr/bin/false sudo -A true`
+          %x(env SUDO_ASKPASS=/usr/bin/false sudo -A true)
           return if $CHILD_STATUS.success?
           CLI::UI.with_frame_color(:blue) do
             puts(CLI::UI.fmt("{{i}} #{msg}"))
@@ -90,6 +90,18 @@ module CLI
           delegate_open3(*a, sudo: sudo, env: env, method: :capture3, **kwargs)
         end
 
+        def popen2(*a, sudo: false, env: ENV, **kwargs, &block)
+          delegate_open3(*a, sudo: sudo, env: env, method: :popen2, **kwargs, &block)
+        end
+
+        def popen2e(*a, sudo: false, env: ENV, **kwargs, &block)
+          delegate_open3(*a, sudo: sudo, env: env, method: :popen2e, **kwargs, &block)
+        end
+
+        def popen3(*a, sudo: false, env: ENV, **kwargs, &block)
+          delegate_open3(*a, sudo: sudo, env: env, method: :popen3, **kwargs, &block)
+        end
+
         # Execute a command in the user's environment
         # Outputs result of the command without capturing it
         #
@@ -100,7 +112,7 @@ module CLI
         # - `**kwargs`: additional keyword arguments to pass to Process.spawn
         #
         # #### Returns
-        # - `status`: boolean success status of the command execution
+        # - `status`: The `Process:Status` result for the command execution
         #
         # #### Usage
         # `stat = CLI::Kit::System.system('ls', 'a_folder')`
@@ -116,11 +128,15 @@ module CLI
           err_w.close
 
           handlers = if block_given?
-            { out_r => ->(data) { yield(data.force_encoding(Encoding::UTF_8), '') },
-              err_r => ->(data) { yield('', data.force_encoding(Encoding::UTF_8)) } }
+            {
+              out_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) } }
+            {
+              out_r => ->(data) { STDOUT.write(data) },
+              err_r => ->(data) { STDOUT.write(data) },
+            }
           end
 
           previous_trailing = Hash.new('')
@@ -130,13 +146,11 @@ module CLI
 
             readers, = IO.select(ios)
             readers.each do |io|
-              begin
-                data, trailing = split_partial_characters(io.readpartial(4096))
-                handlers[io].call(previous_trailing[io] + data)
-                previous_trailing[io] = trailing
-              rescue IOError
-                io.close
-              end
+              data, trailing = split_partial_characters(io.readpartial(4096))
+              handlers[io].call(previous_trailing[io] + data)
+              previous_trailing[io] = trailing
+            rescue IOError
+              io.close
             end
           end
 
@@ -163,6 +177,14 @@ module CLI
           [data.byteslice(0...partial_character_index), data.byteslice(partial_character_index..-1)]
         end
 
+        def os
+          return :mac if /darwin/.match(RUBY_PLATFORM)
+          return :linux if /linux/.match(RUBY_PLATFORM)
+          return :windows if /mingw32/.match(RUBY_PLATFORM)
+
+          raise "Could not determine OS from platform #{RUBY_PLATFORM}"
+        end
+
         private
 
         def apply_sudo(*a, sudo)
@@ -171,11 +193,11 @@ module CLI
           a
         end
 
-        def delegate_open3(*a, sudo: raise, env: raise, method: raise, **kwargs)
+        def delegate_open3(*a, sudo: raise, env: raise, method: raise, **kwargs, &block)
           a = apply_sudo(*a, sudo)
-          Open3.send(method, env, *resolve_path(a, env), **kwargs)
+          Open3.send(method, env, *resolve_path(a, env), **kwargs, &block)
         rescue Errno::EINTR
-          raise(Errno::EINTR, "command interrupted: #{a.join(' ')}")
+          raise(Errno::EINTR, "command interrupted: #{a.join(" ")}")
         end
 
         # Ruby resolves the program to execute using its own PATH, but we want it to
@@ -189,17 +211,30 @@ module CLI
         # See https://github.com/Shopify/dev/pull/625 for more details.
         def resolve_path(a, env)
           # If only one argument was provided, make sure it's interpreted by a shell.
-          return ["true ; " + a[0]] if a.size == 1
+          if a.size == 1
+            if os == :windows
+              return ['break && ' + a[0]]
+            else
+              return ['true ; ' + a[0]]
+            end
+          end
           return a if a.first.include?('/')
 
-          paths = env.fetch('PATH', '').split(':')
-          item = paths.detect do |f|
-            command_path = "#{f}/#{a.first}"
-            File.executable?(command_path) && File.file?(command_path)
+          item = which(a.first, env)
+          a[0] = item if item
+          a
+        end
+
+        def which(cmd, env)
+          exts = os == :windows ? env.fetch('PATHEXT').split(';') : ['']
+          env.fetch('PATH', '').split(File::PATH_SEPARATOR).each do |path|
+            exts.each do |ext|
+              exe = File.join(path, "#{cmd}#{ext}")
+              return exe if File.executable?(exe) && !File.directory?(exe)
+            end
           end
 
-          a[0] = "#{item}/#{a.first}" if item
-          a
+          nil
         end
       end
     end

data/lib/cli/kit/util.rb

@@ -2,7 +2,7 @@ module CLI
   module Kit
     module Util
       class << self
-        def snake_case(camel_case, seperator = "_")
+        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
@@ -43,15 +43,15 @@ module CLI
         # non-empty line in the whole string
         #
         def strip_heredoc(str)
-          str.gsub(/^#{str.scan(/^[ \t]*(?=\S)/).min}/, "".freeze)
+          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
+          return '' if array.nil?
+          return array.join(' and ') if array.length < 3
 
-          "#{array[0..-2].join(', ')}, and #{array[-1]}"
+          "#{array[0..-2].join(", ")}, and #{array[-1]}"
         end
 
         # Execute a block within the context of a variable enviroment
@@ -77,15 +77,15 @@ module CLI
         # 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)
+          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)
+          small_scale = ['m', 'µ', 'n', 'p', 'f', 'a', 'z', 'y']
+          big_scale = ['k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y']
           negative = number < 0
           number = number.abs.to_f
 
           if number == 0 || number.between?(1, factor)
-            prefix = ""
+            prefix = ''
             scale = 0
           else
             scale = Math.log(number, factor).floor
@@ -107,7 +107,7 @@ module CLI
           fnum = fnum.to_i if (fnum.to_i.to_f * divider) == number
 
           fnum = -fnum if negative
-          prefix = " " + prefix if space
+          prefix = ' ' + prefix if space
 
           "#{fnum}#{prefix}#{unit}"
         end

data/lib/cli/kit/version.rb

@@ -1,5 +1,5 @@
 module CLI
   module Kit
-    VERSION = "3.3.0"
+    VERSION = '4.0.0'
   end
 end

data/lib/cli/kit.rb

@@ -51,7 +51,7 @@ module CLI
     #       1. rescue Abort or Bug
     #       2. Print a contextualized error message
     #       3. Re-raise AbortSilent or BugSilent respectively.
-    GenericAbort = Class.new(Exception)
+    GenericAbort = Class.new(Exception) # rubocop:disable Lint/InheritException
     Abort        = Class.new(GenericAbort)
     Bug          = Class.new(GenericAbort)
     BugSilent    = Class.new(GenericAbort)

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: cli-kit
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Burke Libbey
 - Aaron Olson
 - Lisa Ugray
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -32,42 +32,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
 description: Terminal UI framework extensions
 email:
 - burke.libbey@shopify.com
@@ -79,10 +79,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/dependabot.yml"
 - ".github/probots.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -142,7 +143,7 @@ homepage: https://github.com/shopify/cli-kit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.20
+signing_key:
 specification_version: 4
 summary: Terminal UI framework extensions
 test_files: []

data/.travis.yml

@@ -1,14 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.3
-  - 2.5.0
-os:
-  - linux
-  - osx
-script:
-  - bin/testunit
-  - git clone https://github.com/Shopify/cli-ui.git
-  - DEPS=vendor bin/test_gen
-  - DEPS=bundler bin/test_gen