cli-ui 1.2.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c3f9d8f4c1cd9dcf6d86319d35b947d2b99ae0dc0f1b975397d77f555f1f57
-  data.tar.gz: d7b3eee8bba21a191746ecf244c428f8c702e1c2fbfb41242740d38a9d317dab
+  metadata.gz: 8de8c1fd6c855f812125e71e85dbfc12163dfd504215fab462d56ad5f4d2cc7e
+  data.tar.gz: 404f164084fd9cf85aa382a5d5f93b77b08ea4bc529840ebfe230e1b5ea7c620
 SHA512:
-  metadata.gz: e35d9d93f31d2bacbd1623d63937f99deecc928e7ef97ebe0b5c4f6199b37952d9d7dad97cfe004ce7cc03296776f7767ccf08336dcbc261eb63f097450211cc
-  data.tar.gz: a184a3dc46bfe4074bbfb8571253e00bc016ac40734ea2ab13baeabe526cfa3194855d3ca69424fd1b069157c7ec4ee7fc76debbdca71ecaa48fc145446039a8
+  metadata.gz: 9f737c534e372589165a3263854d3a90f024181f632f6ae918fcb7aafea69abad27f50246d35c2957c238447a74871f4705add26d1bf272ad58f4fcc52d31ae6
+  data.tar.gz: 56c449900c817637b97d0e99b05ac01375bbde1458db3f2d5e7122027cdd525e0b8aaf9b9d5290cc2f1fa8cae314efb1365ac46ab277629f5cebf5d113e39b0d

data/.dependabot/config.yml

@@ -0,0 +1,8 @@
+version: 1
+update_configs:
+- package_manager: "ruby:bundler"
+  directory: "/"
+  update_schedule: "weekly"
+  automerged_updates:
+  - match:
+      update_type: "semver:minor"

data/.github/CODEOWNERS

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

data/.github/probots.yml

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

data/.gitignore

@@ -1,4 +1,3 @@
-Gemfile.lock
 *.gem
 build
 .vagrant

data/.rubocop.yml

@@ -1,11 +1,20 @@
-inherit_from:
-  - http://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop-cli.yml
 
 AllCops:
-  TargetRubyVersion: 2.1
+  Exclude:
+    - vendor/**/*
+  TargetRubyVersion: 2.5
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# This doesn't understand that <<~ doesn't exist in 2.0
+Layout/HeredocIndentation:
+  Enabled: false
 
 # This doesn't take into account retrying from an exception
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
 # allow String.new to create mutable strings
@@ -15,3 +24,18 @@ 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
+
+# we prefer rescue to align with the beginning of the line containing begin, not begin itself
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/.travis.yml

@@ -1,5 +1,7 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.15.0
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+  - jruby-9.2.14.0
+before_install: gem update --system

data/Gemfile

@@ -1,11 +1,12 @@
 # NOTE: These are development-only dependencies
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
 group :development, :test do
   gem 'rubocop'
-  gem 'byebug'
+  gem 'rubocop-shopify'
+  gem 'byebug', platforms: [:mri]
   gem 'method_source'
 end
 

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    cli-ui (1.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.12.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-shopify (2.0.1)
+      rubocop (~> 1.11)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  byebug
+  cli-ui!
+  method_source
+  minitest (>= 5.0.0)
+  minitest-reporters
+  mocha
+  rake (~> 13.0)
+  rubocop
+  rubocop-shopify
+
+BUNDLED WITH
+   2.1.0

data/README.md

@@ -34,7 +34,7 @@ To handle content flow (see example below)
 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" 
+  puts "inside frame 1"
 end
 ```
 
@@ -43,7 +43,10 @@ end
 ---
 
 ### 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)
+Prompt user with options and ask them to choose. Can answer using arrow keys, vim bindings (`j`/`k`), or numbers  (or y/n for yes/no questions).
+
+For large numbers of options, using `e`, `:`, or `G` will toggle "line select" mode which allows numbers greater than 9 to be typed and
+`f` or `/` will allow the user to filter options using a free-form text input.
 
 ```ruby
 CLI::UI.ask('What language/framework do you use?', options: %w(rails go ruby python))
@@ -105,13 +108,26 @@ puts CLI::UI.fmt "{{red:Red}} {{green:Green}}"
 e.g. `{{*}}` => a yellow ⭑
 
 ```ruby
-puts CLI::UI.fmt "{{*}} {{x}} {{?}} {{v}}"
+puts CLI::UI.fmt "{{*}} {{v}} {{?}} {{x}}"
 ```
 
 ![Symbol Formatting](https://user-images.githubusercontent.com/3074765/33799847-9ec03fd0-dd01-11e7-93f7-5f5cc540e61e.png)
 
 ---
 
+### Status Widget
+
+```ruby
+CLI::UI::Spinner.spin("building packages: {{@widget/status:1:2:3:4}}") do |spinner|
+  # spinner.update_title(...)
+  sleep(3)
+end
+```
+
+![Status Widget](https://user-images.githubusercontent.com/1284/61405142-11042580-a8a7-11e9-9885-46ba44c46358.gif)
+
+---
+
 ### Progress Bar
 
 Show progress of a process or operation.
@@ -128,6 +144,37 @@ end
 
 ---
 
+### Frame Styles
+
+Modify the appearance of CLI::UI both globally and on an individual frame level.
+
+To set the default style:
+
+```ruby
+CLI::UI.frame_style = :box
+```
+
+To style an individual frame:
+
+```ruby
+CLI::UI.frame('New Style!', frame_style: :bracket) { puts 'It's pretty cool!' }
+```
+
+The default style - `:box` - is what has been used up until now.  The other style - `:bracket` - looks like this:
+
+```ruby
+CLI::UI.frame_style = :bracket
+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
+```
+
+![Frame Style](https://user-images.githubusercontent.com/315948/65287373-9a82de80-db08-11e9-94fb-20f4b7561c07.png)
+
+---
+
 ## Example Usage
 
 The following code makes use of nested-framing, multi-threaded spinners, formatted text, and more.

data/Rakefile

@@ -7,7 +7,7 @@ require 'bundler/gem_tasks'
 TEST_ROOT = File.expand_path('../test', __FILE__)
 
 Rake::TestTask.new do |t|
-  t.libs += ["test"]
+  t.libs += ['test']
   t.test_files = FileList[File.join(TEST_ROOT, '**', '*_test.rb')]
   t.verbose = false
   t.warning = false
@@ -17,4 +17,4 @@ RuboCop::RakeTask.new(:style) do |t|
   t.options = ['--display-cop-names']
 end
 
-task default: [:test]
+task(default: [:test, :style])

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "cli/ui"
+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.
@@ -10,5 +10,5 @@ require "cli/ui"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/cli-ui.gemspec

@@ -1,27 +1,27 @@
 # 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/ui/version"
+require 'cli/ui/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cli-ui"
+  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.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.homepage      = 'https://github.com/shopify/cli-ui'
+  spec.license       = 'MIT'
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = %x(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_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  # spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency('rake', '~> 13.0')
+  spec.add_development_dependency('minitest', '~> 5.0')
 end

data/dev.yml

@@ -1,5 +1,5 @@
 up:
-  - ruby: 2.3.3
+  - ruby: 2.5.1
   - bundler
 
 commands:

data/lib/cli/ui.rb

@@ -1,16 +1,19 @@
 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 :Truncater,          'cli/ui/truncater'
-    autoload :Formatter,          'cli/ui/formatter'
-    autoload :Spinner,            'cli/ui/spinner'
+    autoload :ANSI,      'cli/ui/ansi'
+    autoload :Glyph,     'cli/ui/glyph'
+    autoload :Color,     'cli/ui/color'
+    autoload :Frame,     'cli/ui/frame'
+    autoload :OS,        'cli/ui/os'
+    autoload :Printer,   'cli/ui/printer'
+    autoload :Progress,  'cli/ui/progress'
+    autoload :Prompt,    'cli/ui/prompt'
+    autoload :Terminal,  'cli/ui/terminal'
+    autoload :Truncater, 'cli/ui/truncater'
+    autoload :Formatter, 'cli/ui/formatter'
+    autoload :Spinner,   'cli/ui/spinner'
+    autoload :Widgets,   'cli/ui/widgets'
+    autoload :Wrap,      'cli/ui/wrap'
 
     # Convenience accessor to +CLI::UI::Spinner::SpinGroup+
     SpinGroup = Spinner::SpinGroup
@@ -27,7 +30,7 @@ module CLI
     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
+    # Will lookup using +Color.lookup+ unless it's already a CLI::UI::Color (or nil)
     #
     # ==== Attributes
     #
@@ -35,35 +38,50 @@ module CLI
     #
     def self.resolve_color(input)
       case input
-      when Symbol
-        CLI::UI::Color.lookup(input)
+      when CLI::UI::Color, nil
+        input
       else
+        CLI::UI::Color.lookup(input)
+      end
+    end
+
+    # Frame style resolution using +CLI::UI::Frame::FrameStyle.lookup+.
+    # Will lookup using +FrameStyle.lookup+ unless it's already a CLI::UI::Frame::FrameStyle(or nil)
+    #
+    # ==== Attributes
+    #
+    # * +input+ - frame style to resolve
+    def self.resolve_style(input)
+      case input
+      when CLI::UI::Frame::FrameStyle, nil
         input
+      else
+        CLI::UI::Frame::FrameStyle.lookup(input)
       end
     end
 
-    # Conviencence Method for +CLI::UI::Prompt.confirm+
+    # Convenience Method for +CLI::UI::Prompt.confirm+
     #
     # ==== Attributes
     #
     # * +question+ - question to confirm
     #
-    def self.confirm(question)
-      CLI::UI::Prompt.confirm(question)
+    def self.confirm(question, **kwargs)
+      CLI::UI::Prompt.confirm(question, **kwargs)
     end
 
-    # Conviencence Method for +CLI::UI::Prompt.ask+
+    # Convenience Method for +CLI::UI::Prompt.ask+
     #
     # ==== Attributes
     #
     # * +question+ - question to ask
-    # * +kwargs+ - arugments for +Prompt.ask+
+    # * +kwargs+ - arguments 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+
+    # Convenience Method to resolve text using +CLI::UI::Formatter.format+
     # Check +CLI::UI::Formatter::SGR_MAP+ for available formatting options
     #
     # ==== Attributes
@@ -75,10 +93,10 @@ module CLI
       return input if input.nil?
       formatted = CLI::UI::Formatter.new(input).format
       return formatted unless truncate_to
-      return CLI::UI::Truncater.call(formatted, truncate_to)
+      CLI::UI::Truncater.call(formatted, truncate_to)
     end
 
-    # Conviencence Method to format text using +CLI::UI::Formatter.format+
+    # Convenience 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
@@ -96,29 +114,44 @@ module CLI
       CLI::UI::Formatter.new(input).format(enable_color: enable_color)
     end
 
-    # Conviencence Method for +CLI::UI::Frame.open+
+    def self.wrap(input)
+      CLI::UI::Wrap.new(input).wrap
+    end
+
+    # Convenience Method for +CLI::UI::Printer.puts+
+    #
+    # ==== Attributes
+    #
+    # * +msg+ - Message to print
+    # * +kwargs+ - keyword arguments for +Printer.puts+
+    #
+    def self.puts(msg, **kwargs)
+      CLI::UI::Printer.puts(msg, **kwargs)
+    end
+
+    # Convenience 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)
+    def self.frame(*args, **kwargs, &block)
+      CLI::UI::Frame.open(*args, **kwargs, &block)
     end
 
-    # Conviencence Method for +CLI::UI::Spinner.spin+
+    # Convenience 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)
+    def self.spinner(*args, **kwargs, &block)
+      CLI::UI::Spinner.spin(*args, **kwargs, &block)
     end
 
-    # Conviencence Method to override frame color using +CLI::UI::Frame.with_frame_color+
+    # Convenience Method to override frame color using +CLI::UI::Frame.with_frame_color+
     #
     # ==== Attributes
     #
@@ -137,12 +170,12 @@ module CLI
     #
     def self.log_output_to(path)
       if CLI::UI::StdoutRouter.duplicate_output_to
-        raise "multiple logs not allowed"
+        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
+      if (file_descriptor = CLI::UI::StdoutRouter.duplicate_output_to)
         file_descriptor.close
         CLI::UI::StdoutRouter.duplicate_output_to = nil
       end
@@ -181,6 +214,19 @@ module CLI
     end
 
     self.enable_color = $stdout.tty?
+
+    # Set the default frame style.
+    # Convenience method for setting the default frame style with +CLI::UI::Frame.frame_style=+
+    #
+    # Raises ArgumentError if +frame_style+ is not valid
+    #
+    # ==== Attributes
+    #
+    # * +symbol+ - the default frame style to use for frames
+    #
+    def self.frame_style=(frame_style)
+      Frame.frame_style = frame_style.to_sym
+    end
   end
 end