cli-kit 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 283b38ecb21fd3caac8399447f06f5bccff261af
-  data.tar.gz: fe47b61139d7df53eca531693ba385c44a0c6455
+SHA256:
+  metadata.gz: a1c78454dde57819601c7ef40040c02943b72ea2f3831718a2a4362731c2cf9a
+  data.tar.gz: 6e4e1adcdd54eb38d419b2d2d936ec03a05190cf72baaabd1002e1407dfdcf49
 SHA512:
-  metadata.gz: 6f8723304b346c20418debde33e203bc3794ae0defc4e34308a7c2fbf5364fb22c41f7b7e800bbe5f2fb76a0ac90ca37e980c5ec641c71b3deb19d277d029b19
-  data.tar.gz: 6f08ef957f6f63b6fe108b6b6e118b5f887a9050ae8aed548445d8b77ff8ec47ff5a488f881b3e95e3682c30ba7098196876096a5cd70fd7fe312dd74292928c
+  metadata.gz: f57fe58683a342a39957fd19cedc79641583456100e7e63b71e4e395b0fc705938ccaa1574bc36d975dda6f6b5c7fcbf28406972432abcf3ac890bb1334e2715
+  data.tar.gz: 5f1f0bf80809f7ff4ae97ab4cd0871ceaef6b4c4967b06fdcae5ccb1c869524c351c1a2acf7cab83cd2416ce37766033b5c63d6ff2480fd660067d74dcc51f8f

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+@Shopify/dev-infra

data/.github/probots.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cli-kit (3.1.0)
+    cli-kit (3.3.0)
       cli-ui (>= 1.1.4)
 
 GEM
@@ -11,7 +11,7 @@ GEM
     ast (2.4.0)
     builder (3.2.3)
     byebug (9.0.6)
-    cli-ui (1.1.4)
+    cli-ui (1.2.3)
     metaclass (0.0.4)
     method_source (0.8.2)
     minitest (5.10.2)
@@ -53,4 +53,4 @@ DEPENDENCIES
   rubocop (~> 0.56.0)
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/TODO.md

@@ -0,0 +1,5 @@
+* Build a help system
+* Build a tabular data formatter
+* Suppress colour by default when printing to non-TTY
+* Do frames in a way that works on BK when running on BK
+

data/cli-kit.gemspec

@@ -6,8 +6,8 @@ require 'cli/kit/version'
 Gem::Specification.new do |spec|
   spec.name          = 'cli-kit'
   spec.version       = CLI::Kit::VERSION
-  spec.authors       = ['Burke Libbey', 'Julian Nadeau', 'Lisa Ugray']
-  spec.email         = ['burke.libbey@shopify.com', 'julian.nadeau@shopify.com', 'lisa.ugray@shopify.com']
+  spec.authors       = ['Burke Libbey', 'Aaron Olson', 'Lisa Ugray']
+  spec.email         = ['burke.libbey@shopify.com', 'aaron.olson@shopify.com', 'lisa.ugray@shopify.com']
 
   spec.summary       = 'Terminal UI framework extensions'
   spec.description   = 'Terminal UI framework extensions'

data/examples/README.md

@@ -0,0 +1,21 @@
+# Examples
+
+**Note: If you're looking to bootstrap a new app, consider running `cli-kit new` instead of
+copy/pasting one of these.**
+
+## Full Example
+
+The full example lives in its own repository at https://github.com/Shopify/cli-kit-example.
+This is quite similar to the output of `cli-kit new`, but fleshed out a little bit more with
+a couple of commands.
+
+## Single-File starting point
+
+Maybe it appeals to you to start from a single file and grow, rather than generating framework.
+Check out the [`examples/single-file`](single-file) example.
+
+## Minimal example
+
+This example demonstrates the core of what `cli-kit` does very simply, but in general, shouldn't be
+used for anything other than quick hacks. It leaves out a few best practices that help CLI apps
+scale gracefully. Find it at [`examples/minimal`](minimal).

data/examples/minimal/example.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'cli/ui'
+require 'cli/kit'
+
+CLI::UI::StdoutRouter.enable
+
+include CLI::Kit
+
+registry = CommandRegistry.new(default: 'hello', contextual_resolver: nil)
+registry.add(Class.new(BaseCommand) do
+  def call(_args, _name)
+    puts "hello, world!"
+  end
+end, 'hello')
+
+executor      = Executor.new(log_file: '/tmp/example.log')
+error_handler = ErrorHandler.new(log_file: '/tmp/example.log', exception_reporter: nil)
+resolver      = Resolver.new(tool_name: 'example', command_registry: registry)
+entry_point   = ->(args) { executor.call(*resolver.call(args)) }
+
+exit(error_handler.call { entry_point.call(ARGV.dup) }) if __FILE__ == $PROGRAM_NAME

data/examples/single-file/example.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'cli/ui'
+require 'cli/kit'
+
+CLI::UI::StdoutRouter.enable
+
+module Example
+  extend CLI::Kit::Autocall
+
+  TOOL_NAME = 'example'
+  ROOT      = File.expand_path('../..', __FILE__)
+  LOG_FILE  = '/tmp/example.log'
+
+  module Commands
+    extend CLI::Kit::Autocall
+
+    Registry = CLI::Kit::CommandRegistry.new(
+      default: 'hello',
+      contextual_resolver: nil
+    )
+
+    def self.register(const, cmd, path = nil, &block)
+      path ? autoload(const, path) : autocall(const, &block)
+      Registry.add(->() { const_get(const) }, cmd)
+    end
+
+    # register(:Hello, 'hello', 'a/b/hello')
+
+    register(:Hello, 'hello') do
+      Class.new(Example::Command) do
+        def call(_args, _name)
+          puts "hello, world!"
+        end
+      end
+    end
+  end
+
+  autocall(:EntryPoint) do
+    Module.new do
+      def self.call(args)
+        cmd, command_name, args = Example::Resolver.call(args)
+        Example::Executor.call(cmd, command_name, args)
+      end
+    end
+  end
+
+  autocall(:Config)  { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
+  autocall(:Command) { CLI::Kit::BaseCommand }
+
+  autocall(:Executor) { CLI::Kit::Executor.new(log_file: LOG_FILE) }
+  autocall(:Resolver) do
+    CLI::Kit::Resolver.new(
+      tool_name: TOOL_NAME,
+      command_registry: Example::Commands::Registry
+    )
+  end
+
+  autocall(:ErrorHandler) do
+    CLI::Kit::ErrorHandler.new(
+      log_file: LOG_FILE,
+      exception_reporter: nil
+    )
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  exit(Example::ErrorHandler.call do
+    Example::EntryPoint.call(ARGV.dup)
+  end)
+end

data/examples/todo-list/README.md

@@ -0,0 +1 @@
+Full example at https://github.com/Shopify/cli-kit-example

data/gen/template/lib/__app__/commands/example.rb

@@ -1,5 +1,4 @@
 require '__app__'
-require 'json'
 
 module __App__
   module Commands

data/lib/cli/kit/base_command.rb

@@ -17,21 +17,22 @@ module CLI
 
       def self.call(args, command_name)
         cmd = new
-        stats_tags = cmd.stats_tags(args)
+        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
             cmd.call(args, command_name)
           end
           statsd_increment("cli.command.success", tags: stats_tags)
-        rescue => e
+        rescue Exception => e # rubocop:disable Lint/RescueException
           statsd_increment("cli.command.exception", tags: stats_tags + ["exception:#{e.class}"])
           raise e
         end
       end
 
-      def stats_tags(args)
+      def stats_tags(args, command_name)
         tags = ["task:#{self.class}"]
+        tags << "command:#{command_name}" if command_name
         tags << "subcommand:#{args.first}" if args&.first && has_subcommands?
         tags
       end

data/lib/cli/kit/config.rb

@@ -23,13 +23,13 @@ module CLI
       # #### Example Usage
       # `config.get('name.of.config')`
       #
-      def get(section, name)
-        all_configs.dig("[#{section}]", name) || false
+      def get(section, name, default: false)
+        all_configs.dig("[#{section}]", name) || default
       end
 
       # Coalesce and enforce the value of a config to a boolean
-      def get_bool(section, name)
-        case get(section, name).to_s
+      def get_bool(section, name, default: false)
+        case get(section, name, default: default).to_s
         when "true"
           true
         when "false"

data/lib/cli/kit/error_handler.rb

@@ -4,9 +4,10 @@ require 'English'
 module CLI
   module Kit
     class ErrorHandler
-      def initialize(log_file:, exception_reporter:)
+      def initialize(log_file:, exception_reporter:, tool_name: nil)
         @log_file = log_file
         @exception_reporter_or_proc = exception_reporter || NullExceptionReporter
+        @tool_name = tool_name
       end
 
       module NullExceptionReporter
@@ -84,6 +85,14 @@ module CLI
       rescue Interrupt
         $stderr.puts(format_error_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"
+        end
+        $stderr.puts(format_error_message(message))
+        CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       end
 
       def exception_reporter

data/lib/cli/kit/executor.rb

@@ -16,8 +16,14 @@ module CLI
             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"
+              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
             end
           end

data/lib/cli/kit/ini.rb

@@ -15,8 +15,12 @@ module CLI
     class Ini
       attr_accessor :ini
 
-      def initialize(path = nil, default_section: nil, convert_types: true)
-        @config = File.readlines(path) if path && File.exist?(path)
+      def initialize(path = nil, config: nil, default_section: nil, convert_types: true)
+        @config = if path && File.exist?(path)
+          File.readlines(path)
+        elsif config
+          config.lines
+        end
         @ini = {}
         @current_key = nil
         @default_section = default_section
@@ -39,7 +43,7 @@ module CLI
 
           # Otherwise set the values
           else
-            k, v = l.split('=').map(&:strip)
+            k, v = l.split('=', 2).map(&:strip)
             set_val(k, v)
           end
         end

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

@@ -19,6 +19,24 @@ module CLI
           assert_all_commands_run
         end
 
+        module FakeConfig
+          require 'tmpdir'
+          require 'fileutils'
+
+          def setup
+            super
+            @tmpdir = Dir.mktmpdir
+            @prev_xdg = ENV['XDG_CONFIG_HOME']
+            ENV['XDG_CONFIG_HOME'] = @tmpdir
+          end
+
+          def teardown
+            FileUtils.rm_rf(@tmpdir)
+            ENV['XDG_CONFIG_HOME'] = @prev_xdg
+            super
+          end
+        end
+
         class FakeSuccess
           def initialize(success)
             @success = success

data/lib/cli/kit/system.rb

@@ -191,9 +191,13 @@ module CLI
           # If only one argument was provided, make sure it's interpreted by a shell.
           return ["true ; " + a[0]] if a.size == 1
           return a if a.first.include?('/')
-          item = env.fetch('PATH', '').split(':').detect do |f|
-            File.exist?("#{f}/#{a.first}")
+
+          paths = env.fetch('PATH', '').split(':')
+          item = paths.detect do |f|
+            command_path = "#{f}/#{a.first}"
+            File.executable?(command_path) && File.file?(command_path)
           end
+
           a[0] = "#{item}/#{a.first}" if item
           a
         end

data/lib/cli/kit/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: cli-kit
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Burke Libbey
-- Julian Nadeau
+- Aaron Olson
 - Lisa Ugray
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -71,13 +71,15 @@ dependencies:
 description: Terminal UI framework extensions
 email:
 - burke.libbey@shopify.com
-- julian.nadeau@shopify.com
+- aaron.olson@shopify.com
 - lisa.ugray@shopify.com
 executables:
 - cli-kit
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/probots.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -86,11 +88,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/test_gen
 - bin/testunit
 - cli-kit.gemspec
 - dev.yml
+- examples/README.md
+- examples/minimal/example.rb
+- examples/single-file/example.rb
+- examples/todo-list/README.md
 - exe/cli-kit
 - gen/lib/gen.rb
 - gen/lib/gen/commands.rb
@@ -150,8 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Terminal UI framework extensions