cli-kit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 194c6fb318a717adb92458539db84f4e82c0c7d8
+  data.tar.gz: ed39204760603166cb42990fef86db6f69f1e44a
+SHA512:
+  metadata.gz: 325c4f7a072a9004275079d04b9925ef791a4d450ac63d757f9bf294234551a4b8f946e817d4287b146849d6823d46ae7a22a732b616bb1a2ceb1cbcd24f3fe2
+  data.tar.gz: 0507ec4b45eddf96c736c4b552a45bea2528cdff30666006c86d5796d71503b1e25ec9dea415d1b1220b86a055a29a12535e94ed671dec5719301a2e55ee7670

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+build
+.vagrant
+.DS_Store
+.bundle
+
+.starscope.db
+cscope.out
+tags
+
+.byebug_history
+
+.rubocop-*
+doc

data/.rubocop.yml

@@ -0,0 +1,23 @@
+inherit_from:
+  - http://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.0
+
+# This doesn't understand that <<~ doesn't exist in 2.0
+Style/IndentHeredoc:
+  Enabled: false
+
+# This doesn't take into account retrying from an exception
+Lint/HandleExceptions:
+  Enabled: false
+
+# allow String.new to create mutable strings
+Style/EmptyLiteral:
+  Enabled: false
+
+# allow the use of globals which makes sense in a CLI app like this
+Style/GlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    dev-kit (0.1.0)
+      dev-ui (>= 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.3.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    dev-ui (0.1.0)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.10.2)
+    minitest-reporters (1.1.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  byebug
+  dev-kit!
+  method_source
+  minitest (>= 5.0.0)
+  minitest-reporters
+  mocha
+  rake (~> 10.0)
+  rubocop
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Burke Libbey
+
+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.

data/README.md

@@ -0,0 +1,2 @@
+# cli-kit
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/testunit

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+
+root = File.expand_path('../..', __FILE__)
+CLI_TEST_ROOT = root + '/test'
+
+$LOAD_PATH.unshift(CLI_TEST_ROOT)
+
+def test_files
+  Dir.glob(CLI_TEST_ROOT + "/**/*_test.rb")
+end
+
+if ARGV.empty?
+  test_files.each { |f| require(f) }
+  exit 0
+end
+
+# A list of files is presumed to be specified
+ARGV.each do |a|
+  require a.sub(%r{^test/}, '')
+end

data/cli-kit.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cli/kit/version"
+
+Gem::Specification.new do |spec|
+  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.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.files = `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.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/dev.yml

@@ -0,0 +1,7 @@
+up:
+  - ruby: 2.3.3
+  - bundler
+
+commands:
+  test: bin/testunit
+  style: "bundle exec rubocop -D"

data/lib/cli/kit.rb

@@ -0,0 +1,7 @@
+require 'cli/ui'
+
+module CLI
+  module Kit
+    autoload :System, 'cli/kit/system'
+  end
+end

data/lib/cli/kit/system.rb

@@ -0,0 +1,204 @@
+require 'cli/kit'
+
+require 'open3'
+require 'English'
+
+module CLI
+  module Kit
+    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
+        #
+        # #### Parameters
+        # - `msg`: A message telling the user why sudo is needed
+        #
+        # #### Usage
+        # `ctx.sudo_reason("We need to do a thing")`
+        #
+        def sudo_reason(msg)
+          # See if sudo has a cached password
+          `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}"))
+          end
+        end
+
+        # Execute a command in the user's environment
+        # This is meant to be largely equivalent to backticks, only with the env passed in.
+        # Captures the results of the command without output to the console
+        #
+        # #### Parameters
+        # - `*a`: A splat of arguments evaluated as a command. (e.g. `'rm', folder` is equivalent to `rm #{folder}`)
+        # - `sudo`: If truthy, run this command with sudo. If String, pass to `sudo_reason`
+        # - `env`: process environment with which to execute this command
+        # - `**kwargs`: additional arguments to pass to Open3.capture2
+        #
+        # #### Returns
+        # - `output`: output (STDOUT) of the command execution
+        # - `status`: boolean success status of the command execution
+        #
+        # #### Usage
+        # `out, stat = CLI::Kit::System.capture2('ls', 'a_folder')`
+        #
+        def capture2(*a, sudo: false, env: ENV, **kwargs)
+          delegate_open3(*a, sudo: sudo, env: env, method: :capture2, **kwargs)
+        end
+
+        # Execute a command in the user's environment
+        # This is meant to be largely equivalent to backticks, only with the env passed in.
+        # Captures the results of the command without output to the console
+        #
+        # #### Parameters
+        # - `*a`: A splat of arguments evaluated as a command. (e.g. `'rm', folder` is equivalent to `rm #{folder}`)
+        # - `sudo`: If truthy, run this command with sudo. If String, pass to `sudo_reason`
+        # - `env`: process environment with which to execute this command
+        # - `**kwargs`: additional arguments to pass to Open3.capture2e
+        #
+        # #### Returns
+        # - `output`: output (STDOUT merged with STDERR) of the command execution
+        # - `status`: boolean success status of the command execution
+        #
+        # #### Usage
+        # `out_and_err, stat = CLI::Kit::System.capture2e('ls', 'a_folder')`
+        #
+        def capture2e(*a, sudo: false, env: ENV, **kwargs)
+          delegate_open3(*a, sudo: sudo, env: env, method: :capture2e, **kwargs)
+        end
+
+        # Execute a command in the user's environment
+        # This is meant to be largely equivalent to backticks, only with the env passed in.
+        # Captures the results of the command without output to the console
+        #
+        # #### Parameters
+        # - `*a`: A splat of arguments evaluated as a command. (e.g. `'rm', folder` is equivalent to `rm #{folder}`)
+        # - `sudo`: If truthy, run this command with sudo. If String, pass to `sudo_reason`
+        # - `env`: process environment with which to execute this command
+        # - `**kwargs`: additional arguments to pass to Open3.capture3
+        #
+        # #### Returns
+        # - `output`: STDOUT of the command execution
+        # - `error`: STDERR of the command execution
+        # - `status`: boolean success status of the command execution
+        #
+        # #### Usage
+        # `out, err, stat = CLI::Kit::System.capture3('ls', 'a_folder')`
+        #
+        def capture3(*a, sudo: false, env: ENV, **kwargs)
+          delegate_open3(*a, sudo: sudo, env: env, method: :capture3, **kwargs)
+        end
+
+        # Execute a command in the user's environment
+        # Outputs result of the command without capturing it
+        #
+        # #### Parameters
+        # - `*a`: A splat of arguments evaluated as a command. (e.g. `'rm', folder` is equivalent to `rm #{folder}`)
+        # - `sudo`: If truthy, run this command with sudo. If String, pass to `sudo_reason`
+        # - `env`: process environment with which to execute this command
+        # - `**kwargs`: additional keyword arguments to pass to Process.spawn
+        #
+        # #### Returns
+        # - `status`: boolean success status of the command execution
+        #
+        # #### Usage
+        # `stat = CLI::Kit::System.system('ls', 'a_folder')`
+        #
+        def system(*a, sudo: false, env: ENV, **kwargs)
+          a = apply_sudo(*a, sudo)
+
+          out_r, out_w = IO.pipe
+          err_r, err_w = IO.pipe
+          in_stream = STDIN.closed? ? :close : STDIN
+          pid = Process.spawn(env, *resolve_path(a, env), 0 => in_stream, :out => out_w, :err => err_w, **kwargs)
+          out_w.close
+          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)) }, }
+          else
+            { out_r => ->(data) { STDOUT.write(data) },
+              err_r => ->(data) { STDOUT.write(data) }, }
+          end
+
+          previous_trailing = Hash.new('')
+          loop do
+            ios = [err_r, out_r].reject(&:closed?)
+            break if ios.empty?
+
+            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
+            end
+          end
+
+          Process.wait(pid)
+          $CHILD_STATUS
+        end
+
+        # Split off trailing partial UTF-8 Characters. UTF-8 Multibyte characters start with a 11xxxxxx byte that tells
+        # how many following bytes are part of this character, followed by some number of 10xxxxxx bytes.  This simple
+        # algorithm will split off a whole trailing multi-byte character.
+        def split_partial_characters(data)
+          last_byte = data.getbyte(-1)
+          return [data, ''] if (last_byte & 0b1000_0000).zero?
+
+          # UTF-8 is up to 6 characters per rune, so we could never want to trim more than that, and we want to avoid
+          # allocating an array for the whole of data with bytes
+          min_bound = -[6, data.bytesize].min
+          final_bytes = data.byteslice(min_bound..-1).bytes
+          partial_character_sub_index = final_bytes.rindex { |byte| byte & 0b1100_0000 == 0b1100_0000 }
+          # Bail out for non UTF-8
+          return [data, ''] unless partial_character_sub_index
+          partial_character_index = min_bound + partial_character_sub_index
+
+          [data.byteslice(0...partial_character_index), data.byteslice(partial_character_index..-1)]
+        end
+
+        private
+
+        def apply_sudo(*a, sudo)
+          a.unshift('sudo', '-S', '-p', SUDO_PROMPT, '--') if sudo
+          sudo_reason(sudo) if sudo.is_a?(String)
+          a
+        end
+
+        def delegate_open3(*a, sudo: raise, env: raise, method: raise, **kwargs)
+          a = apply_sudo(*a, sudo)
+          Open3.send(method, env, *resolve_path(a, env), **kwargs)
+        rescue Errno::EINTR
+          raise(Errno::EINTR, "command interrupted: #{a.join(' ')}")
+        end
+
+        # Ruby resolves the program to execute using its own PATH, but we want it to
+        # use the provided one, so we ensure ruby chooses to spawn a shell, which will
+        # parse our command and properly spawn our target using the provided environment.
+        #
+        # This is important because dev clobbers its own environment such that ruby
+        # means /usr/bin/ruby, but we want it to select the ruby targeted by the active
+        # project.
+        #
+        # 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
+          return a if a.first.include?('/')
+          item = env.fetch('PATH', '').split(':').detect do |f|
+            File.exist?("#{f}/#{a.first}")
+          end
+          a[0] = "#{item}/#{a.first}" if item
+          a
+        end
+      end
+    end
+  end
+end

data/lib/cli/kit/version.rb

@@ -0,0 +1,5 @@
+module CLI
+  module Kit
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: cli-kit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Burke Libbey
+- Julian Nadeau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-15 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.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Terminal UI framework extensions
+email:
+- burke.libbey@shopify.com
+- julian.nadeau@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/testunit
+- cli-kit.gemspec
+- dev.yml
+- lib/cli/kit.rb
+- lib/cli/kit/system.rb
+- lib/cli/kit/version.rb
+homepage: https://github.com/shopify/cli-kit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Terminal UI framework extensions
+test_files: []