cli-ui 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dec73837349569f0f2d2555575e7fea915e3dc5d
+  data.tar.gz: b7386d60f9bdb31b1889e62356925cce2030cfbf
+SHA512:
+  metadata.gz: 19b01cb99b895ba3be3033576adcbf408bf0ce64859d7824c93ad26e1f3a04f5d23d06ce19338834191c5f9f6ea29c9f469334794d71898c273707019d31f7cc
+  data.tar.gz: 26c8932e7e8fe55808eabdecc03b5ff6bc2bb671c3f6339d1c145a2dd0ccc93439be8e03c6b622c07115ca5b6cd310fc6c38e74f8ba396a8f19e631ad3c98184

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,17 @@
+inherit_from:
+  - http://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.1
+
+# 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,54 @@
+PATH
+  remote: .
+  specs:
+    cli-ui (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.3.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    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.12.0)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  byebug
+  cli-ui!
+  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,164 @@
+CLI UI
+---
+
+CLI UI is a small framework for generating nice command-line user interfaces
+
+- [Master Documentation](http://www.rubydoc.info/github/Shopify/cli-ui/master/CLI/UI)
+- [Documentation of the Rubygems version](http://www.rubydoc.info/gems/cli-ui/)
+- [Rubygems](https://rubygems.org/gems/cli-ui)
+
+## Installation
+
+```bash
+gem install cli-ui
+```
+
+or add the following to your Gemfile:
+
+```ruby
+gem 'cli-ui'
+```
+
+In your code, simply add a `require 'cli/ui'`. Most options assume `CLI::UI::StdoutRouter.enable` has been called.
+
+## Features
+
+This may not be an exhaustive list. Please check our [documentation](http://www.rubydoc.info/github/Shopify/cli-ui/master/CLI/UI) for more information.
+
+---
+
+### Nested framing
+To handle content flow (see example below)
+
+```ruby
+CLI::UI::StdoutRouter.enable
+CLI::UI::Frame.open('Frame 1') do
+  CLI::UI::Frame.open('Frame 2') { puts "inside frame 2" }
+  puts "inside frame 1" 
+end
+```
+
+![Nested Framing](https://user-images.githubusercontent.com/3074765/33799861-cb5dcb5c-dd01-11e7-977e-6fad38cee08c.png)
+
+---
+
+### Interactive Prompts
+Prompt user with options and ask them to choose. Can answer using arrow keys, numbers, or vim bindings (or y/n for yes/no questions)
+
+```ruby
+CLI::UI.ask('What language/framework do you use?', options: %w(rails go ruby python))
+```
+
+![Interactive Prompt](https://user-images.githubusercontent.com/3074765/33797984-0ebb5e64-dcdf-11e7-9e7e-7204f279cece.gif)
+
+---
+
+### Free form text prompts
+
+```ruby
+CLI::UI.ask('Is CLI UI Awesome?', default: 'It is great!')
+```
+
+  ![Free form text prompt](https://user-images.githubusercontent.com/3074765/33799822-47f23302-dd01-11e7-82f3-9072a5a5f611.png)
+
+---
+
+### Spinner groups
+Handle many multi-threaded processes while suppressing output unless there is an issue. Can update title to show state.
+
+```ruby
+spin_group = CLI::UI::SpinGroup.new
+spin_group.add('Title')   { |spinner| sleep 3.0 }
+spin_group.add('Title 2') { |spinner| sleep 3.0; spinner.update_title('New Title'); sleep 3.0 }
+spin_group.wait
+```
+
+![Spinner Group](https://user-images.githubusercontent.com/3074765/33798295-d94fd822-dce3-11e7-819b-43e5502d490e.gif)
+
+---
+
+### Text Color formatting
+e.g. `{{red:Red}} {{green:Green}}`
+
+```ruby
+puts CLI::UI.fmt "{{red:Red}} {{green:Green}}"
+```
+
+![Text Format](https://user-images.githubusercontent.com/3074765/33799827-6d0721a2-dd01-11e7-9ab5-c3d455264afe.png)
+
+---
+
+### Symbol/Glyph Formatting
+e.g. `{{*}}` => a yellow ⭑
+
+```ruby
+puts CLI::UI.fmt "{{*}} {{x}} {{?}} {{v}}"
+```
+
+![Symbol Formatting](https://user-images.githubusercontent.com/3074765/33799847-9ec03fd0-dd01-11e7-93f7-5f5cc540e61e.png)
+
+---
+
+### Progress Bar
+
+Show progress of a process or operation.
+
+```ruby
+CLI::UI::Progress.progress do |bar|
+  100.times do
+    bar.tick
+  end
+end
+```
+
+![Progress Bar](https://user-images.githubusercontent.com/3074765/33799794-cc4c940e-dd00-11e7-9bdc-90f77ec9167c.gif)
+
+---
+
+## Example Usage
+
+The following code makes use of nested-framing, multi-threaded spinners, formatted text, and more.
+
+```ruby
+require 'cli/ui'
+
+CLI::UI::StdoutRouter.enable
+
+CLI::UI::Frame.open('{{*}} {{bold:a}}', color: :green) do
+  CLI::UI::Frame.open('{{i}} b', color: :magenta) do
+    CLI::UI::Frame.open('{{?}} c', color: :cyan) do
+      sg = CLI::UI::SpinGroup.new
+      sg.add('wow') do |spinner|
+        sleep(2.5)
+        spinner.update_title('second round!')
+        sleep (1.0)
+      end
+      sg.add('such spin') { sleep(1.6) }
+      sg.add('many glyph') { sleep(2.0) }
+      sg.wait
+    end
+  end
+  CLI::UI::Frame.divider('{{v}} lol')
+  puts CLI::UI.fmt '{{info:words}} {{red:oh no!}} {{green:success!}}'
+  sg = CLI::UI::SpinGroup.new
+  sg.add('more spins') { sleep(0.5) ; raise 'oh no' }
+  sg.wait
+end
+```
+
+Output:
+
+![Example Output](https://user-images.githubusercontent.com/3074765/33797758-7a54c7cc-dcdb-11e7-918e-a47c9689f068.gif)
+
+## Development
+
+- Run tests using `bundle exec rake test`. All code should be tested.
+- No code, outside of development and tests needs, should use dependencies. This is a self contained library
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/cli-ui.
+
+## License
+
+The code is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'cli/ui'
+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 default: [:test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cli/ui"
+
+# 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/cli-ui.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cli/ui/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli-ui"
+  spec.version       = CLI::UI::VERSION
+  spec.authors       = ["Burke Libbey", "Julian Nadeau", "Lisa Ugray"]
+  spec.email         = ["burke.libbey@shopify.com", "julian.nadeau@shopify.com", "lisa.ugray@shopify.com"]
+
+  spec.summary       = 'Terminal UI framework'
+  spec.description   = 'Terminal UI framework'
+  spec.homepage      = "https://github.com/shopify/cli-ui"
+  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_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,14 @@
+up:
+  - ruby: 2.3.3
+  - bundler
+
+commands:
+  test:
+    run: |
+      if [ "$#" -eq 1 ] && [[ -f $1 ]];
+      then
+        rake test TEST=$1
+      else
+        rake test $@
+      fi
+  style: "bundle exec rubocop -D"

data/lib/cli/ui.rb

@@ -0,0 +1,163 @@
+module CLI
+  module UI
+    autoload :ANSI,               'cli/ui/ansi'
+    autoload :Glyph,              'cli/ui/glyph'
+    autoload :Color,              'cli/ui/color'
+    autoload :Box,                'cli/ui/box'
+    autoload :Frame,              'cli/ui/frame'
+    autoload :Progress,           'cli/ui/progress'
+    autoload :Prompt,             'cli/ui/prompt'
+    autoload :Terminal,           'cli/ui/terminal'
+    autoload :Formatter,          'cli/ui/formatter'
+    autoload :Spinner,            'cli/ui/spinner'
+
+    # Convenience accessor to +CLI::UI::Spinner::SpinGroup+
+    SpinGroup = Spinner::SpinGroup
+
+    # Glyph resolution using +CLI::UI::Glyph.lookup+
+    # Look at the method signature for +Glyph.lookup+ for more details
+    #
+    # ==== Attributes
+    #
+    # * +handle+ - handle of the glyph to resolve
+    #
+    def self.glyph(handle)
+      CLI::UI::Glyph.lookup(handle)
+    end
+
+    # Color resolution using +CLI::UI::Color.lookup+
+    # Will lookup using +Color.lookup+ if a symbol, otherwise we assume it is a valid color and return it
+    #
+    # ==== Attributes
+    #
+    # * +input+ - color to resolve
+    #
+    def self.resolve_color(input)
+      case input
+      when Symbol
+        CLI::UI::Color.lookup(input)
+      else
+        input
+      end
+    end
+
+    # Conviencence Method for +CLI::UI::Prompt.confirm+
+    #
+    # ==== Attributes
+    #
+    # * +question+ - question to confirm
+    #
+    def self.confirm(question)
+      CLI::UI::Prompt.confirm(question)
+    end
+
+    # Conviencence Method for +CLI::UI::Prompt.ask+
+    #
+    # ==== Attributes
+    #
+    # * +question+ - question to ask
+    # * +kwargs+ - arugments for +Prompt.ask+
+    #
+    def self.ask(question, **kwargs)
+      CLI::UI::Prompt.ask(question, **kwargs)
+    end
+
+    # Conviencence Method to resolve text using +CLI::UI::Formatter.format+
+    # Check +CLI::UI::Formatter::SGR_MAP+ for available formatting options
+    #
+    # ==== Attributes
+    #
+    # * +input+ - input to format
+    #
+    def self.resolve_text(input)
+      return input if input.nil?
+      CLI::UI::Formatter.new(input).format
+    end
+
+    # Conviencence Method to format text using +CLI::UI::Formatter.format+
+    # Check +CLI::UI::Formatter::SGR_MAP+ for available formatting options
+    #
+    # https://user-images.githubusercontent.com/3074765/33799827-6d0721a2-dd01-11e7-9ab5-c3d455264afe.png
+    # https://user-images.githubusercontent.com/3074765/33799847-9ec03fd0-dd01-11e7-93f7-5f5cc540e61e.png
+    #
+    # ==== Attributes
+    #
+    # * +input+ - input to format
+    #
+    # ==== Options
+    #
+    # * +enable_color+ - should color be used? default to true
+    #
+    def self.fmt(input, enable_color: true)
+      CLI::UI::Formatter.new(input).format(enable_color: enable_color)
+    end
+
+    # Conviencence Method for +CLI::UI::Frame.open+
+    #
+    # ==== Attributes
+    #
+    # * +args+ - arguments for +Frame.open+
+    # * +block+ - block for +Frame.open+
+    #
+    def self.frame(*args, &block)
+      CLI::UI::Frame.open(*args, &block)
+    end
+
+    # Conviencence Method for +CLI::UI::Spinner.spin+
+    #
+    # ==== Attributes
+    #
+    # * +args+ - arguments for +Spinner.open+
+    # * +block+ - block for +Spinner.open+
+    #
+    def self.spinner(*args, &block)
+      CLI::UI::Spinner.spin(*args, &block)
+    end
+
+    # Conviencence Method to override frame color using +CLI::UI::Frame.with_frame_color+
+    #
+    # ==== Attributes
+    #
+    # * +color+ - color to override to
+    # * +block+ - block for +Frame.with_frame_color_override+
+    #
+    def self.with_frame_color(color, &block)
+      CLI::UI::Frame.with_frame_color_override(color, &block)
+    end
+
+    # Duplicate output to a file path
+    #
+    # ==== Attributes
+    #
+    # * +path+ - path to duplicate output to
+    #
+    def self.log_output_to(path)
+      if CLI::UI::StdoutRouter.duplicate_output_to
+        raise "multiple logs not allowed"
+      end
+      CLI::UI::StdoutRouter.duplicate_output_to = File.open(path, 'w')
+      yield
+    ensure
+      if file_descriptor = CLI::UI::StdoutRouter.duplicate_output_to
+        file_descriptor.close
+        CLI::UI::StdoutRouter.duplicate_output_to = nil
+      end
+    end
+
+    # Disable all framing within a block
+    #
+    # ==== Attributes
+    #
+    # * +block+ - block in which to disable frames
+    #
+    def self.raw
+      prev = Thread.current[:no_cliui_frame_inset]
+      Thread.current[:no_cliui_frame_inset] = true
+      yield
+    ensure
+      Thread.current[:no_cliui_frame_inset] = prev
+    end
+  end
+end
+
+require 'cli/ui/stdout_router'