cli-kit 4.0.0 → 5.0.1

data/lib/cli/kit/util.rb

@@ -1,81 +1,26 @@
+# typed: true
+
+require 'cli/kit'
+
 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
+        extend T::Sig
         #
-        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
         #
+        sig { params(bytes: Integer, precision: Integer, space: T::Boolean).returns(String) }
         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
         #
+        sig do
+          params(number: Numeric, unit: String, factor: Integer, precision: Integer, space: T::Boolean)
+            .returns(String)
+        end
         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)
 
@@ -84,7 +29,7 @@ module CLI
           negative = number < 0
           number = number.abs.to_f
 
-          if number == 0 || number.between?(1, factor)
+          if number == 0.0 || number.between?(1, factor)
             prefix = ''
             scale = 0
           else
@@ -92,22 +37,24 @@ module CLI
             if number < 1
               index = [-scale - 1, small_scale.length].min
               scale = -(index + 1)
-              prefix = small_scale[index]
+              prefix = T.must(small_scale[index])
             else
               index = [scale - 1, big_scale.length].min
               scale = index + 1
-              prefix = big_scale[index]
+              prefix = T.must(big_scale[index])
             end
           end
 
           divider = (factor**scale)
-          fnum = (number / divider).round(precision)
+          fnum = (number / divider.to_f).round(precision)
 
           # Trim useless decimal
-          fnum = fnum.to_i if (fnum.to_i.to_f * divider) == number
+          fnum = fnum.to_i if (fnum.to_i.to_f * divider.to_f) == number
 
           fnum = -fnum if negative
-          prefix = ' ' + prefix if space
+          if space
+            prefix = ' ' + prefix
+          end
 
           "#{fnum}#{prefix}#{unit}"
         end
@@ -115,38 +62,18 @@ module CLI
         # 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)
+        sig do
+          type_parameters(:T).params(dir: String, block: T.proc.returns(T.type_parameter(:T)))
+            .returns(T.type_parameter(:T))
         end
-
-        def with_tmp_dir
-          require 'fileutils'
-          dir = Dir.mktmpdir
-          with_dir(dir) do
-            yield(dir)
+        def with_dir(dir, &block)
+          prev = Dir.pwd
+          begin
+            Dir.chdir(dir)
+            yield
+          ensure
+            Dir.chdir(prev)
           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
@@ -158,25 +85,43 @@ module CLI
         # end.retry_after(ExpectedError) do
         #   costly_prep()
         # end
+        sig do
+          type_parameters(:T).params(block_that_might_raise: T.proc.returns(T.type_parameter(:T)))
+            .returns(Retrier[T.type_parameter(:T)])
+        end
         def begin(&block_that_might_raise)
           Retrier.new(block_that_might_raise)
         end
       end
 
       class Retrier
+        extend T::Sig
+        extend T::Generic
+
+        BlockReturnType = type_member
+
+        sig { params(block_that_might_raise: T.proc.returns(BlockReturnType)).void }
         def initialize(block_that_might_raise)
           @block_that_might_raise = block_that_might_raise
         end
 
+        sig do
+          params(
+            exception: T.class_of(Exception),
+            retries: Integer,
+            before_retry: T.nilable(T.proc.params(e: Exception).void),
+          ).returns(BlockReturnType)
+        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
+              T.cast(before_retry, T.proc.void).call
             else
-              yield e
+              T.cast(before_retry, T.proc.params(e: Exception).void).call(e)
             end
           end
           retry

data/lib/cli/kit/version.rb

@@ -1,5 +1,7 @@
+# typed: true
+
 module CLI
   module Kit
-    VERSION = '4.0.0'
+    VERSION = '5.0.1'
   end
 end

data/lib/cli/kit.rb

@@ -1,17 +1,29 @@
+# typed: true
+
 require 'cli/ui'
-require 'cli/kit/ruby_backports/enumerable'
+
+unless defined?(T)
+  require('cli/kit/sorbet_runtime_stub')
+end
+
+require 'cli/kit/core_ext'
 
 module CLI
   module Kit
-    autoload :Autocall,        'cli/kit/autocall'
+    extend T::Sig
+
+    autoload :Args,            'cli/kit/args'
     autoload :BaseCommand,     'cli/kit/base_command'
     autoload :CommandRegistry, 'cli/kit/command_registry'
+    autoload :CommandHelp,     'cli/kit/command_help'
     autoload :Config,          'cli/kit/config'
     autoload :ErrorHandler,    'cli/kit/error_handler'
     autoload :Executor,        'cli/kit/executor'
     autoload :Ini,             'cli/kit/ini'
     autoload :Levenshtein,     'cli/kit/levenshtein'
     autoload :Logger,          'cli/kit/logger'
+    autoload :Opts,            'cli/kit/opts'
+    autoload :ParseArgs,       'cli/kit/parse_args'
     autoload :Resolver,        'cli/kit/resolver'
     autoload :Support,         'cli/kit/support'
     autoload :System,          'cli/kit/system'
@@ -28,7 +40,8 @@ module CLI
     # a bare `rescue => e`.
     #
     # * Abort prints its message in red and exits 1;
-    # * Bug additionally submits the exception to Bugsnag;
+    # * Bug additionally submits the exception to the exception_reporter passed to
+    #     `CLI::Kit::ErrorHandler.new`
     # * AbortSilent and BugSilent do the same as above, but do not print
     #     messages before exiting.
     #
@@ -51,10 +64,94 @@ module CLI
     #       1. rescue Abort or Bug
     #       2. Print a contextualized error message
     #       3. Re-raise AbortSilent or BugSilent respectively.
+    #
+    # These aren't the only exceptions that can carry this 'bug' and 'silent'
+    # metadata, however:
+    #
+    # If you raise an exception with `CLI::Kit.raise(..., bug: x, silent: y)`,
+    # those last two (optional) keyword arguments will attach the metadata to
+    # whatever exception you raise. This is interpreted later in the
+    # ErrorHandler to decide how to print output and whether to submit the
+    # exception to bugsnag.
     GenericAbort = Class.new(Exception) # rubocop:disable Lint/InheritException
-    Abort        = Class.new(GenericAbort)
-    Bug          = Class.new(GenericAbort)
-    BugSilent    = Class.new(GenericAbort)
-    AbortSilent  = Class.new(GenericAbort)
+
+    class Abort < GenericAbort # bug:false; silent: false
+      extend(T::Sig)
+
+      sig { returns(T::Boolean) }
+      def bug?
+        false
+      end
+    end
+
+    class Bug < GenericAbort # bug:true; silent:false
+    end
+
+    class BugSilent < GenericAbort # bug:true; silent:true
+      extend(T::Sig)
+
+      sig { returns(T::Boolean) }
+      def silent?
+        true
+      end
+    end
+
+    class AbortSilent < GenericAbort # bug:false; silent:true
+      extend(T::Sig)
+
+      sig { returns(T::Boolean) }
+      def bug?
+        false
+      end
+
+      sig { returns(T::Boolean) }
+      def silent?
+        true
+      end
+    end
+
+    class << self
+      extend T::Sig
+
+      # Mirrors the API of Kernel#raise, but with the addition of a few new
+      # optional keyword arguments. `bug` and `silent` attach metadata to the
+      # exception being raised, which is interpreted later in the ErrorHandler to
+      # decide what to print and whether to submit to bugsnag.
+      #
+      # `depth` is used to trim leading elements of the backtrace. If you wrap
+      # this method in your own wrapper, you'll want to pass `depth: 2`, for
+      # example.
+      sig do
+        params(
+          exception: T.any(Class, String, Exception),
+          string: T.untyped,
+          array: T.nilable(T::Array[String]),
+          cause: T.nilable(Exception),
+          bug: T.nilable(T::Boolean),
+          silent: T.nilable(T::Boolean),
+          depth: Integer,
+        ).returns(T.noreturn)
+      end
+      def raise(
+        # default arguments
+        exception = T.unsafe(nil), string = T.unsafe(nil), array = T.unsafe(nil), cause: $ERROR_INFO,
+        # new arguments
+        bug: nil, silent: nil, depth: 1
+      )
+        if array
+          T.unsafe(Kernel).raise(exception, string, array, cause: cause)
+        elsif string
+          T.unsafe(Kernel).raise(exception, string, Kernel.caller(depth), cause: cause)
+        elsif exception.is_a?(String)
+          T.unsafe(Kernel).raise(RuntimeError, exception, Kernel.caller(depth), cause: cause)
+        else
+          T.unsafe(Kernel).raise(exception, exception.message, Kernel.caller(depth), cause: cause)
+        end
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        e.bug!(bug) unless bug.nil?
+        e.silent!(silent) unless silent.nil?
+        Kernel.raise(e, cause: cause)
+      end
+    end
   end
 end

metadata

@@ -1,31 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: cli-kit
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Burke Libbey
 - Aaron Olson
 - Lisa Ugray
-autorequire:
+- Don Kelly
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +74,7 @@ email:
 - burke.libbey@shopify.com
 - aaron.olson@shopify.com
 - lisa.ugray@shopify.com
+- don.kelly@shopify.com
 executables:
 - cli-kit
 extensions: []
@@ -80,10 +82,12 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/dependabot.yml"
-- ".github/probots.yml"
+- ".github/workflows/cla.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rubocop.sorbet.yml"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -91,6 +95,8 @@ files:
 - Rakefile
 - TODO.md
 - bin/console
+- bin/onchange
+- bin/tapioca
 - bin/test_gen
 - bin/testunit
 - cli-kit.gemspec
@@ -106,6 +112,7 @@ files:
 - gen/lib/gen/commands/new.rb
 - gen/lib/gen/entry_point.rb
 - gen/lib/gen/generator.rb
+- gen/lib/gen/help.rb
 - gen/template/.gitignore
 - gen/template/Gemfile
 - gen/template/README.md
@@ -123,17 +130,26 @@ files:
 - gen/template/test/example_test.rb
 - gen/template/test/test_helper.rb
 - lib/cli/kit.rb
-- lib/cli/kit/autocall.rb
+- lib/cli/kit/args.rb
+- lib/cli/kit/args/definition.rb
+- lib/cli/kit/args/evaluation.rb
+- lib/cli/kit/args/parser.rb
+- lib/cli/kit/args/parser/node.rb
+- lib/cli/kit/args/tokenizer.rb
 - lib/cli/kit/base_command.rb
+- lib/cli/kit/command_help.rb
 - lib/cli/kit/command_registry.rb
 - lib/cli/kit/config.rb
+- lib/cli/kit/core_ext.rb
 - lib/cli/kit/error_handler.rb
 - lib/cli/kit/executor.rb
 - lib/cli/kit/ini.rb
 - lib/cli/kit/levenshtein.rb
 - lib/cli/kit/logger.rb
+- lib/cli/kit/opts.rb
+- lib/cli/kit/parse_args.rb
 - lib/cli/kit/resolver.rb
-- lib/cli/kit/ruby_backports/enumerable.rb
+- lib/cli/kit/sorbet_runtime_stub.rb
 - lib/cli/kit/support.rb
 - lib/cli/kit/support/test_helper.rb
 - lib/cli/kit/system.rb
@@ -143,7 +159,7 @@ homepage: https://github.com/shopify/cli-kit
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -151,15 +167,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Terminal UI framework extensions
 test_files: []

data/.github/probots.yml

@@ -1,2 +0,0 @@
-enabled:
-  - cla

data/lib/cli/kit/autocall.rb

@@ -1,21 +0,0 @@
-require 'cli/kit'
-
-module CLI
-  module Kit
-    module Autocall
-      def autocall(const, &block)
-        @autocalls ||= {}
-        @autocalls[const] = block
-      end
-
-      def const_missing(const)
-        block = begin
-          @autocalls.fetch(const)
-        rescue KeyError
-          return super
-        end
-        const_set(const, block.call)
-      end
-    end
-  end
-end

data/lib/cli/kit/ruby_backports/enumerable.rb

@@ -1,6 +0,0 @@
-module Enumerable
-  def min_by(n = nil, &block)
-    return sort_by(&block).first unless n
-    sort_by(&block).first(n)
-  end if instance_method(:min_by).arity == 0
-end