cli-kit 3.0.0.pre → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d38479bdf5b6e03725e44c04e6b44c306bad6a59
-  data.tar.gz: 4268a52a77172588b586e1e5e21cee635e7ed99a
+  metadata.gz: 88690eeba1179ef8cb31ebd13b68d978e71f5c8a
+  data.tar.gz: f63da3dc52f120f759241232fb64953deb0e0b3f
 SHA512:
-  metadata.gz: ddd5316dc74a06d96a35ad8953b198de161b1700822f15ff62e9987e46957fc493a7c6af1e605d435235567805a2bc230d4d287677a372619d3653e12c31e66e
-  data.tar.gz: e61a9cac88db2728fd81c5d782288788a8b6a95579e00b3c27b0c86129e0afcee3fbdde18104e3c8beb997fc9d9ee9190f7de6e4f22570679b93f8ed494ad1d7
+  metadata.gz: abd4591db97ad44a9ebdf3645181ad90b443ad70d3849b3f247cf577cc394b04638646d14ab1cc18273d05a3a55cb1cdb3022ce9052792b025a7498c6d94a309
+  data.tar.gz: 6c8571d319162adfeb0dd66c294fb225565c10e50fdcb70ab60dcd4bbd705131ec43916691c8ce160939348491ec453d5b1054a2504bc13594e76aecc20cdf01

data/.rubocop.yml

@@ -2,12 +2,17 @@ inherit_from:
   - http://shopify.github.io/ruby-style-guide/rubocop.yml
 
 AllCops:
-  Exclude:
-    - 'vendor/**/*'
-  TargetRubyVersion: 2.0
+  Exclude: [ 'gen/template/**/*' ]
+  TargetRubyVersion: 2.3
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Shopify/RubocopComments:
+  Enabled: false
 
 # This doesn't understand that <<~ doesn't exist in 2.0
-Style/IndentHeredoc:
+Layout/IndentHeredoc:
   Enabled: false
 
 # This doesn't take into account retrying from an exception
@@ -21,3 +26,15 @@ Style/EmptyLiteral:
 # allow the use of globals which makes sense in a CLI app like this
 Style/GlobalVars:
   Enabled: false
+
+# allow using %r{} for regexes
+Style/RegexpLiteral:
+  Enabled: false
+
+# allow readable Dev::Util.begin formatting
+Style/MultilineBlockChain:
+  Enabled: false
+
+# allow using names to be more expressive
+Performance/RedundantBlockCall:
+  Enabled: false

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    cli-kit (2.0.0)
-      cli-ui (>= 1.0.0)
+    cli-kit (3.0.0)
+      cli-ui (>= 1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -11,7 +11,7 @@ GEM
     ast (2.3.0)
     builder (3.2.3)
     byebug (9.0.6)
-    cli-ui (1.0.0)
+    cli-ui (1.1.0)
     metaclass (0.0.4)
     method_source (0.8.2)
     minitest (5.10.2)

data/cli-kit.gemspec

@@ -1,29 +1,29 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cli/kit/version"
+require 'cli/kit/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cli-kit"
+  spec.name          = 'cli-kit'
   spec.version       = CLI::Kit::VERSION
-  spec.authors       = ["Burke Libbey", "Julian Nadeau"]
-  spec.email         = ["burke.libbey@shopify.com", "julian.nadeau@shopify.com"]
+  spec.authors       = ['Burke Libbey', 'Julian Nadeau', 'Lisa Ugray']
+  spec.email         = ['burke.libbey@shopify.com', 'julian.nadeau@shopify.com', 'lisa.ugray@shopify.com']
 
-  spec.summary       = %q{Terminal UI framework extensions}
-  spec.description   = %q{Terminal UI framework extensions}
-  spec.homepage      = "https://github.com/shopify/cli-kit"
-  spec.license       = "MIT"
+  spec.summary       = 'Terminal UI framework extensions'
+  spec.description   = 'Terminal UI framework extensions'
+  spec.homepage      = 'https://github.com/shopify/cli-kit'
+  spec.license       = 'MIT'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "cli-ui", ">= 1.0.0"
+  spec.add_runtime_dependency 'cli-ui', '>= 1.1.0'
 
-  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', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
 end

data/exe/cli-kit

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby --disable-gems
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+unshift_path = ->(path) {
+  p = File.expand_path("../../#{path}", __FILE__)
+  $LOAD_PATH.unshift(p) unless $LOAD_PATH.include?(p)
+}
+unshift_path.call('gen/lib')
+unshift_path.call('lib')
+
+require 'gen'
+
+exit(Gen::ErrorHandler.call { Gen::EntryPoint.call(ARGV) })

data/gen/lib/gen.rb

@@ -0,0 +1,35 @@
+require 'cli/ui'
+require 'cli/kit'
+
+CLI::UI::StdoutRouter.enable
+
+module Gen
+  extend CLI::Kit::Autocall
+
+  TOOL_NAME = 'cli-kit'
+  ROOT      = File.expand_path('../../..', __FILE__)
+  LOG_FILE  = '/tmp/cli-kit.log'
+
+  autoload(:Generator, 'gen/generator')
+
+  autoload(:EntryPoint, 'gen/entry_point')
+  autoload(:Commands,   'gen/commands')
+
+  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: Gen::Commands::Registry
+    )
+  end
+
+  autocall(:ErrorHandler) do
+    CLI::Kit::ErrorHandler.new(
+      log_file: LOG_FILE,
+      exception_reporter: nil
+    )
+  end
+end

data/gen/lib/gen/commands.rb

@@ -0,0 +1,18 @@
+require 'gen'
+
+module Gen
+  module Commands
+    Registry = CLI::Kit::CommandRegistry.new(
+      default: 'help',
+      contextual_resolver: nil
+    )
+
+    def self.register(const, cmd, path)
+      autoload(const, path)
+      Registry.add(->() { const_get(const) }, cmd)
+    end
+
+    register :Help, 'help', 'gen/commands/help'
+    register :New,  'new',  'gen/commands/new'
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'gen'
+
+module Gen
+  module Commands
+    class Help < Gen::Command
+      def call(_args, _name)
+        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 help = klass.help
+            puts CLI::UI.fmt(help)
+          end
+          puts ""
+        end
+      end
+    end
+  end
+end

data/gen/lib/gen/commands/new.rb

@@ -0,0 +1,21 @@
+require 'gen'
+
+module Gen
+  module Commands
+    class New < Gen::Command
+      def call(args, _name)
+        unless args.size == 1
+          puts CLI::UI.fmt(self.class.help)
+          raise(CLI::Kit::AbortSilent)
+        end
+        project = args.first
+
+        Gen::Generator.run(project)
+      end
+
+      def self.help
+        "Generate a new cli-kit project.\nUsage: {{command:#{Gen::TOOL_NAME} new <name>}}"
+      end
+    end
+  end
+end

data/gen/lib/gen/entry_point.rb

@@ -0,0 +1,10 @@
+require 'gen'
+
+module Gen
+  module EntryPoint
+    def self.call(args)
+      cmd, command_name, args = Gen::Resolver.call(args)
+      Gen::Executor.call(cmd, command_name, args)
+    end
+  end
+end

data/gen/lib/gen/generator.rb

@@ -0,0 +1,163 @@
+require 'gen'
+require 'fileutils'
+require 'open3'
+require 'pathname'
+require 'tmpdir'
+
+module Gen
+  class Generator
+    def self.run(project_name)
+      new(project_name).run
+    end
+
+    TEMPLATE_ROOT = File.expand_path('gen/template', Gen::ROOT)
+
+    VALID_PROJECT_NAME = /\A[a-z][a-z0-9]*\z/
+    private_constant :VALID_PROJECT_NAME
+
+    # false  -> delete file
+    # string -> rename file before applying template substitutions
+    VENDOR_TRANSLATIONS = {
+      'Gemfile'            => false,
+      'exe/__app__-gems'   => false,
+      'exe/__app__-vendor' => 'exe/__app__',
+      'dev-gems.yml'       => false,
+      'dev-vendor.yml'     => 'dev.yml',
+    }.freeze
+    private_constant :VENDOR_TRANSLATIONS
+
+    BUNDLER_TRANSLATIONS = {
+      'bin'                => false,
+      'bin/update-deps'    => false,
+      'exe/__app__-gems'   => 'exe/__app__',
+      'exe/__app__-vendor' => false,
+      'dev-gems.yml'       => 'dev.yml',
+      'dev-vendor.yml'     => false,
+    }.freeze
+    private_constant :BUNDLER_TRANSLATIONS
+
+    def initialize(project_name)
+      raise(
+        CLI::Kit::Abort,
+        "project name must match {{bold:#{VALID_PROJECT_NAME}}} (but can be changed later)"
+      ) unless project_name =~ VALID_PROJECT_NAME
+      @project_name = project_name
+      @title_case_project_name = @project_name.sub(/^./, &:upcase)
+    end
+
+    def run
+      vendor = ask_vendor?
+      create_project_dir
+      if vendor
+        copy_files(translations: VENDOR_TRANSLATIONS)
+        update_deps
+      else
+        copy_files(translations: BUNDLER_TRANSLATIONS)
+      end
+    end
+
+    private
+
+    def ask_vendor?
+      vendor = nil
+      CLI::UI::Frame.open('Configuration') do
+        q = 'How would you like the application to consume {{command:cli-kit}} and {{command:cli-ui}}?'
+        vendor = CLI::UI::Prompt.ask(q) do |c|
+          c.option('Vendor  {{italic:(faster execution, more difficult to update deps)}}') { 'vendor' }
+          c.option('Bundler {{italic:(slower execution, easier dep management)}}') { 'bundler' }
+        end
+      end
+      vendor == 'vendor'
+    end
+
+    def create_project_dir
+      info(create: '')
+      FileUtils.mkdir(@project_name)
+    rescue Errno::EEXIST
+      error("directory already exists: #{@project_name}")
+    end
+
+    def copy_files(translations:)
+      each_template_file do |source_name|
+        target_name = translations.fetch(source_name, source_name)
+        next if target_name == false
+        target_name = apply_template_variables(target_name)
+
+        source = File.join(TEMPLATE_ROOT, source_name)
+        target = File.join(@project_name, target_name)
+
+        info(create: target_name)
+
+        if Dir.exist?(source)
+          FileUtils.mkdir(target)
+        else
+          content = apply_template_variables(File.read(source))
+          File.write(target, content)
+        end
+        File.chmod(File.stat(source).mode, target)
+      end
+    end
+
+    def update_deps
+      Dir.mktmpdir do |tmp|
+        clone(tmp, 'cli-ui')
+        clone(tmp, 'cli-kit')
+        info(run: 'bin/update-deps')
+        Dir.chdir(@project_name) do
+          system({ 'SOURCE_ROOT' => tmp }, 'bin/update-deps')
+        end
+      end
+    end
+
+    def clone(dir, repo)
+      info(clone: repo)
+      out, stat = Open3.capture2e('git', '-C', dir, 'clone', "https://github.com/shopify/#{repo}")
+      unless stat.success?
+        STDERR.puts(out)
+        error("git clone failed")
+      end
+    end
+
+    def each_template_file
+      return enum_for(:each_template_file) unless block_given?
+
+      root = Pathname.new(TEMPLATE_ROOT)
+      Dir.glob("#{TEMPLATE_ROOT}/**/*").each do |f|
+        el = Pathname.new(f)
+        yield(el.relative_path_from(root).to_s)
+      end
+    end
+
+    def apply_template_variables(s)
+      s
+        .gsub(/__app__/, @project_name)
+        .gsub(/__App__/, @title_case_project_name)
+        .gsub(/__cli-kit-version__/, cli_kit_version)
+        .gsub(/__cli-ui-version__/, cli_ui_version)
+    end
+
+    def cli_kit_version
+      require 'cli/kit/version'
+      CLI::Kit::VERSION.to_s
+    end
+
+    def cli_ui_version
+      require 'cli/ui/version'
+      CLI::UI::VERSION.to_s
+    end
+
+    def info(create: nil, clone: nil, run: nil)
+      if clone
+        puts(CLI::UI.fmt("\t{{bold:{{yellow:clone}}\t#{clone}}}"))
+      elsif create
+        puts(CLI::UI.fmt("\t{{bold:{{blue:create}}\t#{create}}}"))
+      elsif run
+        puts(CLI::UI.fmt("\t{{bold:{{green:run}}\t#{run}}}"))
+      end
+    end
+
+    def error(msg)
+      raise(CLI::Kit::Abort, msg)
+    end
+  end
+end

data/gen/template/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/.bundle

data/gen/template/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'cli-kit', '~> __cli-kit-version__'
+gem 'cli-ui', '~> __cli-ui-version__'

data/gen/template/README.md

@@ -0,0 +1 @@
+# __app__

data/gen/template/bin/update-deps

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby --disable-gems
+
+$LOAD_PATH.unshift(File.expand_path("../../vendor/deps/cli-ui/lib", __FILE__))
+require 'open3'
+require 'fileutils'
+
+def fmt(tag, msg)
+  # Not really CLI::UI.fmt compatible: no nesting support, for example.
+  # While we could pull in CLI::UI here, it makes it more difficult to
+  # bootstrap a new project and to fix a broken vendor.
+  fmt_msg = msg
+    .gsub(/{{yellow:(.*?)}}/,     "\x1b[33m\\1\x1b[31m")
+    .gsub(/{{green:(.*?)}}/,      "\x1b[32m\\1\x1b[31m")
+    .gsub(/{{blue:(.*?)}}/,       "\x1b[34m\\1\x1b[31m")
+    .gsub(/{{bold_blue:(.*?)}}/,  "\x1b[1;34m\\1\x1b[0;31m")
+    .gsub(/{{bold_green:(.*?)}}/, "\x1b[1;32m\\1\x1b[0;31m")
+  "\x1b[1;31m[#{tag}] \x1b[0;31m#{fmt_msg}\x1b[0m"
+end
+
+def bail(msg)
+  STDERR.puts(fmt("ERROR", msg))
+  exit 1
+end
+
+def warn(msg)
+  STDERR.puts(fmt("WARNING", msg))
+end
+
+def source_path
+  File.expand_path(ENV.fetch('SOURCE_ROOT', File.expand_path('../../..', __FILE__)))
+end
+
+deps = %w(cli-ui cli-kit)
+
+deps.each do |dep|
+  path = File.expand_path(dep, source_path)
+
+  unless Dir.exist?(path)
+    bail(
+      "dependency is not checked out: {{yellow:#{dep}}}.\n" \
+      "  This repo {{bold_blue:(github.com/shopify/#{dep})}} must be cloned at {{bold_blue:#{path}}} for this script to succeed.\n" \
+      "  Alternatively, you can set {{bold_blue:SOURCE_ROOT}} to a directory containing {{yellow:#{dep}}}.\n" \
+      "  {{bold_blue:SOURCE_ROOT}} defaults to {{bold_blue:../}}."
+    )
+  end
+
+  head_sha = nil
+  dirty = false
+
+  Dir.chdir(path) do
+    _, _, stat = Open3.capture3('git fetch origin master')
+    bail("couldn't git fetch in dependency: {{yellow:#{dep}}}") unless stat.success?
+
+    head_sha, stat = Open3.capture2('git rev-parse HEAD')
+    bail("couldn't determine HEAD: {{yellow:#{dep}}}") unless stat.success?
+    head_sha.chomp!
+
+    fetch_head_sha, stat = Open3.capture2('git rev-parse FETCH_HEAD')
+    bail("couldn't determine FETCH_HEAD: {{yellow:#{dep}}}") unless stat.success?
+    fetch_head_sha.chomp!
+
+    git_status, stat = Open3.capture2('git status --porcelain')
+    bail("couldn't determine git status: {{yellow:#{dep}}}") unless stat.success?
+
+    if head_sha != fetch_head_sha
+      warn(
+        "Copying files from {{yellow:#{path}}} to satisfy dependency {{yellow:#{dep}}}.\n" \
+        "  However, the repo at {{yellow:#{path}}} isn't up to date.\n" \
+        "  The checked-out revision is {{yellow:#{head_sha[0..8]}}}, and "\
+        "{{yellow:origin/master}} is {{yellow:#{fetch_head_sha[0..8]}}}.\n" \
+        "  Unless you know what you're doing, you should {{green:cd}} to that repo and {{green:git pull}}, then run this again."
+      )
+    end
+
+    unless git_status.chomp.empty?
+      dirty = true
+      warn("importing uncommitted changes from dependency: {{yellow:#{dep}}}")
+    end
+  end
+
+  depdir = File.expand_path("../../vendor/deps/#{dep}", __FILE__)
+  FileUtils.rm_rf(depdir)
+  FileUtils.mkdir_p(depdir)
+  dstlib = File.expand_path('lib', depdir)
+  srclib = File.expand_path('lib', path)
+
+  FileUtils.cp_r(srclib, dstlib)
+
+  rev = head_sha
+  rev << " (dirty)" if dirty
+  rev << "\n"
+
+  File.write("#{depdir}/REVISION", rev)
+end

data/gen/template/dev-gems.yml

@@ -0,0 +1,3 @@
+up:
+  - ruby: 2.5.0
+  - bundler

data/gen/template/dev-vendor.yml

@@ -0,0 +1,4 @@
+up:
+  - ruby: 2.5.0
+
+build: bin/update-deps

data/gen/template/exe/__app__-gems

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+unshift_path = ->(path) {
+  p = File.expand_path("../../#{path}", __FILE__)
+  $LOAD_PATH.unshift(p) unless $LOAD_PATH.include?(p)
+}
+unshift_path.call('lib')
+
+require 'bundler/setup'
+require '__app__'
+
+exit(__App__::ErrorHandler.call do
+  __App__::EntryPoint.call(ARGV.dup)
+end)

data/gen/template/exe/__app__-vendor

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby --disable-gems
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+unshift_path = ->(path) {
+  p = File.expand_path("../../#{path}", __FILE__)
+  $LOAD_PATH.unshift(p) unless $LOAD_PATH.include?(p)
+}
+unshift_path.call('vendor/deps/cli-ui/lib')
+unshift_path.call('vendor/deps/cli-kit/lib')
+unshift_path.call('lib')
+
+require '__app__'
+
+exit(__App__::ErrorHandler.call do
+  __App__::EntryPoint.call(ARGV.dup)
+end)

data/gen/template/lib/__app__.rb

@@ -0,0 +1,33 @@
+require 'cli/ui'
+require 'cli/kit'
+
+CLI::UI::StdoutRouter.enable
+
+module __App__
+  extend CLI::Kit::Autocall
+
+  TOOL_NAME = '__app__'
+  ROOT      = File.expand_path('../..', __FILE__)
+  LOG_FILE  = '/tmp/__app__.log'
+
+  autoload(:EntryPoint, '__app__/entry_point')
+  autoload(:Commands,   '__app__/commands')
+
+  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: __App__::Commands::Registry
+    )
+  end
+
+  autocall(:ErrorHandler) do
+    CLI::Kit::ErrorHandler.new(
+      log_file: LOG_FILE,
+      exception_reporter: nil
+    )
+  end
+end

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

@@ -0,0 +1,18 @@
+require '__app__'
+
+module __App__
+  module Commands
+    Registry = CLI::Kit::CommandRegistry.new(
+      default: 'help',
+      contextual_resolver: nil
+    )
+
+    def self.register(const, cmd, path)
+      autoload(const, path)
+      Registry.add(->() { const_get(const) }, cmd)
+    end
+
+    register :Example, 'example', '__app__/commands/example'
+    register :Help,    'help',    '__app__/commands/help'
+  end
+end

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

@@ -0,0 +1,20 @@
+require '__app__'
+require 'json'
+
+module __App__
+  module Commands
+    class Example < __App__::Command
+      def call(_args, _name)
+        puts 'neato'
+
+        if rand < 0.05
+          raise(CLI::Kit::Abort, "you got unlucky!")
+        end
+      end
+
+      def self.help
+        "A dummy command.\nUsage: {{command:#{__App__::TOOL_NAME} example}}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require '__app__'
+
+module __App__
+  module Commands
+    class Help < __App__::Command
+      def call(args, _name)
+        puts CLI::UI.fmt("{{bold:Available commands}}")
+        puts ""
+
+        __App__::Commands::Registry.resolved_commands.each do |name, klass|
+          next if name == 'help'
+          puts CLI::UI.fmt("{{command:#{__App__::TOOL_NAME} #{name}}}")
+          if help = klass.help
+            puts CLI::UI.fmt(help)
+          end
+          puts ""
+        end
+      end
+    end
+  end
+end

data/gen/template/lib/__app__/entry_point.rb

@@ -0,0 +1,10 @@
+require '__app__'
+
+module __App__
+  module EntryPoint
+    def self.call(args)
+      cmd, command_name, args = __App__::Resolver.call(args)
+      __App__::Executor.call(cmd, command_name, args)
+    end
+  end
+end

data/lib/cli/kit.rb

@@ -3,6 +3,7 @@ require 'cli/kit/ruby_backports/enumerable'
 
 module CLI
   module Kit
+    autoload :Autocall,        'cli/kit/autocall'
     autoload :BaseCommand,     'cli/kit/base_command'
     autoload :CommandRegistry, 'cli/kit/command_registry'
     autoload :Config,          'cli/kit/config'

data/lib/cli/kit/autocall.rb

@@ -0,0 +1,21 @@
+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/base_command.rb

@@ -7,11 +7,11 @@ module CLI
         true
       end
 
-      def self.statsd_increment(metric, **kwargs)
+      def self.statsd_increment(_metric, **_kwargs)
         nil
       end
 
-      def self.statsd_time(metric, **kwargs)
+      def self.statsd_time(_metric, **_kwargs)
         yield
       end
 
@@ -31,7 +31,7 @@ module CLI
         end
       end
 
-      def call(args, command_name)
+      def call(_args, _command_name)
         raise NotImplementedError
       end
 

data/lib/cli/kit/command_registry.rb

@@ -19,11 +19,11 @@ module CLI
         end
       end
 
-      def initialize(default:, contextual_resolver: NullContextualResolver)
+      def initialize(default:, contextual_resolver: nil)
         @commands = {}
         @aliases  = {}
         @default = default
-        @contextual_resolver = contextual_resolver
+        @contextual_resolver = contextual_resolver || NullContextualResolver
       end
 
       def resolved_commands
@@ -45,47 +45,48 @@ module CLI
         aliases[from] = to unless aliases[from]
       end
 
-      def resolve_command(name)
-        resolve_global_command(name) || \
-          resolve_contextual_command(name) || \
-          [nil, resolve_alias(name)]
+      def command_names
+        @contextual_resolver.command_names + commands.keys
+      end
+
+      def exist?(name)
+        !resolve_command(name).first.nil?
       end
 
+      private
+
       def resolve_alias(name)
         aliases[name] || @contextual_resolver.aliases.fetch(name, name)
       end
 
-      def resolve_global_command(name)
+      def resolve_command(name)
         name = resolve_alias(name)
-        klass = resolve_class(commands.fetch(name, ""))
-        return nil unless klass.defined? # (BaseCommand)
+        resolve_global_command(name) || \
+          resolve_contextual_command(name) || \
+          [nil, name]
+      end
+
+      def resolve_global_command(name)
+        klass = resolve_class(commands.fetch(name, nil))
+        return nil unless klass
         [klass, name]
       rescue NameError
         nil
       end
 
       def resolve_contextual_command(name)
-        name = resolve_alias(name)
         found = @contextual_resolver.command_names.include?(name)
         return nil unless found
         [@contextual_resolver.command_class(name), name]
       end
 
-      def command_names
-        @contextual_resolver.command_names + commands.keys
-      end
-
-      def exist?(name)
-        !resolve_command(name).first.nil?
-      end
-
-      private
-
       def resolve_class(class_or_proc)
         if class_or_proc.is_a?(Class)
           class_or_proc
-        else
+        elsif class_or_proc.respond_to?(:call)
           class_or_proc.call
+        else
+          class_or_proc
         end
       end
     end

data/lib/cli/kit/error_handler.rb

@@ -1,25 +1,34 @@
 require 'cli/kit'
+require 'English'
 
 module CLI
   module Kit
     class ErrorHandler
-      def initialize(log_file: nil, exception_reporter: NullExceptionReporter)
+      def initialize(log_file:, exception_reporter:)
         @log_file = log_file
-        @exception_reporter_or_proc = exception_reporter
+        @exception_reporter_or_proc = exception_reporter || NullExceptionReporter
       end
 
       module NullExceptionReporter
-        def self.report(exception, logs)
+        def self.report(_exception, _logs)
           nil
         end
       end
 
+      def call(&block)
+        install!
+        handle_abort(&block)
+      end
+
+      private
+
       def install!
         at_exit { handle_final_exception(@exception || $ERROR_INFO) }
       end
 
       def handle_abort
         yield
+        CLI::Kit::EXIT_SUCCESS
       rescue CLI::Kit::GenericAbort => e
         is_bug    = e.is_a?(CLI::Kit::Bug) || e.is_a?(CLI::Kit::BugSilent)
         is_silent = e.is_a?(CLI::Kit::AbortSilent) || e.is_a?(CLI::Kit::BugSilent)
@@ -29,12 +38,10 @@ module CLI
 
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       rescue Interrupt
-        STDERR.puts(format_error_message("Interrupt"))
+        $stderr.puts(format_error_message("Interrupt"))
         return CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       end
 
-      private
-
       def handle_final_exception(error)
         notify_with = nil
 
@@ -47,13 +54,13 @@ module CLI
           unless skip.include?(error.message)
             notify_with = error
           end
-        when SystemExit  # "exit N" called
+        when SystemExit # "exit N" called
           case error.status
-          when CLI::Kit::EXIT_SUCCESS  # submit nothing if it was `exit 0`
+          when CLI::Kit::EXIT_SUCCESS # submit nothing if it was `exit 0`
           when CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
-            # if it was `exit 30`, translate the exit code to 1, and submit nothing
+            # 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.
-            # But users should see it presented as 1.
+            # However, users should see it presented as 1.
             exit 1
           else
             # A weird termination status happened. `error.exception "message"` will maintain backtrace
@@ -70,7 +77,7 @@ module CLI
           rescue => e
             "(#{e.class}: #{e.message})"
           end
-          exceptiono_reporter.report(notify_with, logs)
+          exception_reporter.report(notify_with, logs)
         end
       end
 
@@ -86,9 +93,8 @@ module CLI
         CLI::UI.fmt("{{red:#{msg}}}")
       end
 
-
       def print_error_message(e)
-        STDERR.puts(format_error_message(e.message))
+        $stderr.puts(format_error_message(e.message))
       end
     end
   end

data/lib/cli/kit/executor.rb

@@ -4,82 +4,50 @@ require 'English'
 module CLI
   module Kit
     class Executor
-      def initialize(
-        tool_name:, command_registry:, error_handler:, log_file: nil
-      )
-        @tool_name = tool_name
-        @command_registry = command_registry
-        @error_handler = error_handler
+      def initialize(log_file:)
         @log_file = log_file
       end
 
+      def call(command, command_name, args)
+        with_traps { with_logging { command.call(args, command_name) } }
+      end
+
+      private
+
       def with_logging(&block)
         return yield unless @log_file
         CLI::UI.log_output_to(@log_file, &block)
       end
 
-      def commands_and_aliases
-        @command_registry.command_names + @command_registry.aliases.keys
-      end
-
-      def trap_signals
-        trap('QUIT') do
-          z = caller
-          CLI::UI.raw do
-            STDERR.puts('SIGQUIT: quit')
-            STDERR.puts(z)
-          end
-          exit 1
-        end
-        trap('INFO') do
-          z = caller
-          CLI::UI.raw do
-            STDERR.puts('SIGINFO:')
-            STDERR.puts(z)
-            # Thread.list.map { |t| t.backtrace }
+      def with_traps
+        twrap('QUIT', method(:quit_handler)) do
+          twrap('INFO', method(:info_handler)) do
+            yield
           end
         end
       end
 
-      def call(command, command_name, args)
-        trap_signals
-        with_logging do
-          @error_handler.handle_abort do
-            if command.nil?
-              command_not_found(command_name)
-              raise CLI::Kit::AbortSilent # Already output message
-            end
-            command.call(args, command_name)
-            CLI::Kit::EXIT_SUCCESS # unless an exception was raised
-          end
-        end
+      def twrap(signal, handler)
+        prev_handler = trap(signal, handler)
+        yield
+      ensure
+        trap(signal, prev_handler)
       end
 
-      def command_not_found(name)
-        CLI::UI::Frame.open("Command not found", color: :red, timing: false) do
-          STDERR.puts(CLI::UI.fmt("{{command:#{@tool_name} #{name}}} was not found"))
+      def quit_handler(_sig)
+        z = caller
+        CLI::UI.raw do
+          $stderr.puts('SIGQUIT: quit')
+          $stderr.puts(z)
         end
+        exit(CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG)
+      end
 
-        cmds = commands_and_aliases
-        if cmds.all? { |cmd| cmd.is_a?(String) }
-          possible_matches = cmds.min_by(2) do |cmd|
-            CLI::Kit::Levenshtein.distance(cmd, name)
-          end
-
-          # We don't want to match against any possible command
-          # so reject anything that is too far away
-          possible_matches.reject! do |possible_match|
-            CLI::Kit::Levenshtein.distance(possible_match, name) > 3
-          end
-
-          # 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
-              possible_matches.each do |possible_match|
-                STDERR.puts CLI::UI.fmt("{{command:#{@tool_name} #{possible_match}}}")
-              end
-            end
-          end
+      def info_handler(_sig)
+        z = caller
+        CLI::UI.raw do
+          $stderr.puts('SIGINFO:')
+          $stderr.puts(z)
         end
       end
     end

data/lib/cli/kit/resolver.rb

@@ -3,21 +3,57 @@ require 'cli/kit'
 module CLI
   module Kit
     class Resolver
-      def initialize(command_registry:, error_handler:)
+      def initialize(tool_name:, command_registry:)
+        @tool_name = tool_name
         @command_registry = command_registry
-        @error_handler = error_handler
       end
 
       def call(args)
         args = args.dup
         command_name = args.shift
 
-        @error_handler.handle_abort do
-          command, command_name = @command_registry.lookup_command(command_name)
-          return [command, command_name, args]
+        command, resolved_name = @command_registry.lookup_command(command_name)
+
+        if command.nil?
+          command_not_found(command_name)
+          raise CLI::Kit::AbortSilent # Already output message
+        end
+
+        [command, resolved_name, args]
+      end
+
+      private
+
+      def command_not_found(name)
+        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
 
-        exit CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+        cmds = commands_and_aliases
+        if cmds.all? { |cmd| cmd.is_a?(String) }
+          possible_matches = cmds.min_by(2) do |cmd|
+            CLI::Kit::Levenshtein.distance(cmd, name)
+          end
+
+          # We don't want to match against any possible command
+          # so reject anything that is too far away
+          possible_matches.reject! do |possible_match|
+            CLI::Kit::Levenshtein.distance(possible_match, name) > 3
+          end
+
+          # 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
+              possible_matches.each do |possible_match|
+                $stderr.puts CLI::UI.fmt("{{command:#{@tool_name} #{possible_match}}}")
+              end
+            end
+          end
+        end
+      end
+
+      def commands_and_aliases
+        @command_registry.command_names + @command_registry.aliases.keys
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Enumerable
-  def min_by(n=nil, &block)
+  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

data/lib/cli/kit/system.rb

@@ -8,7 +8,6 @@ module CLI
     module System
       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
         #

data/lib/cli/kit/version.rb

@@ -1,5 +1,5 @@
 module CLI
   module Kit
-    VERSION = "3.0.0.pre"
+    VERSION = "3.0.0"
   end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: cli-kit
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre
+  version: 3.0.0
 platform: ruby
 authors:
 - Burke Libbey
 - Julian Nadeau
+- Lisa Ugray
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -17,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -71,7 +72,9 @@ description: Terminal UI framework extensions
 email:
 - burke.libbey@shopify.com
 - julian.nadeau@shopify.com
-executables: []
+- lisa.ugray@shopify.com
+executables:
+- cli-kit
 extensions: []
 extra_rdoc_files: []
 files:
@@ -86,7 +89,28 @@ files:
 - bin/testunit
 - cli-kit.gemspec
 - dev.yml
+- exe/cli-kit
+- gen/lib/gen.rb
+- gen/lib/gen/commands.rb
+- gen/lib/gen/commands/help.rb
+- gen/lib/gen/commands/new.rb
+- gen/lib/gen/entry_point.rb
+- gen/lib/gen/generator.rb
+- gen/template/.gitignore
+- gen/template/Gemfile
+- gen/template/README.md
+- gen/template/bin/update-deps
+- gen/template/dev-gems.yml
+- gen/template/dev-vendor.yml
+- gen/template/exe/__app__-gems
+- gen/template/exe/__app__-vendor
+- gen/template/lib/__app__.rb
+- gen/template/lib/__app__/commands.rb
+- gen/template/lib/__app__/commands/example.rb
+- gen/template/lib/__app__/commands/help.rb
+- gen/template/lib/__app__/entry_point.rb
 - lib/cli/kit.rb
+- lib/cli/kit/autocall.rb
 - lib/cli/kit/base_command.rb
 - lib/cli/kit/command_registry.rb
 - lib/cli/kit/config.rb
@@ -113,9 +137,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14