cli-ui 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ad712abce399f06334f0af18135d831f788ab217
-  data.tar.gz: dd3befbb4a7cf345965bdc10ebbaaa208a93a8db
+SHA256:
+  metadata.gz: e8c6abe82a837c62e28cded106185a5ce2d09413637b94fb5bdb6524552648ac
+  data.tar.gz: 780168b9d23cd55acd5e95e6abcb7b5b0732c694db2feb0f73d5b04ce71dcd63
 SHA512:
-  metadata.gz: 843c4c640d52da02bded3f3ac79bc3b4a7d8e56227f3914a1b3289887bceb89b54d26b11d8cc55e2cf2ad871e04f408e9f5cc631a79ebc3bba4d89ec1fd15afd
-  data.tar.gz: 133dada99d103ea7449e6138f39d58929b09552895869317a3fba69844057a92eab3a3a0ecb920667a1c3357813c25bfd72af1b9d8ac6feccdb99697a26b928b
+  metadata.gz: cea8f4f738765f77a8474221a9449da3f7bb1cae7610fb5d21dc2ee02f7c03996fc26b661db4eefb1af924ab2b7af0469539040763804c7154353037100fdd0f
+  data.tar.gz: bfe35b8ded93b0fe857d55836fd0b1aef67b6c5cb036550a152db464e3657607c0fde84621ccfd2541bb477d262b16e3adef0b320a1b037b3664f2141df99404

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

@@ -2,10 +2,19 @@ inherit_from:
   - http://shopify.github.io/ruby-style-guide/rubocop.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,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
+
+# we prefer rescue to align with the beginning of the line containing begin, not begin itself
+Layout/RescueEnsureAlignment:
+  Enabled: false

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
+before_install: gem update --system

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    cli-ui (1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.1)
+    builder (3.2.4)
+    byebug (11.1.3)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.11.2)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rubocop (1.1.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  cli-ui!
+  method_source
+  minitest (>= 5.0.0)
+  minitest-reporters
+  mocha
+  rake (~> 13.0)
+  rubocop
+
+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

@@ -17,4 +17,4 @@ RuboCop::RakeTask.new(:style) do |t|
   t.options = ['--display-cop-names']
 end
 
-task default: [:test]
+task(default: [:test, :style])

data/cli-ui.gemspec

@@ -14,14 +14,14 @@ Gem::Specification.new do |spec|
   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.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"
+  # 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

@@ -3,14 +3,16 @@ module CLI
     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 :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'
 
     # Convenience accessor to +CLI::UI::Spinner::SpinGroup+
     SpinGroup = Spinner::SpinGroup
@@ -27,7 +29,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 +37,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 +92,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 +113,40 @@ module CLI
       CLI::UI::Formatter.new(input).format(enable_color: enable_color)
     end
 
-    # Conviencence Method for +CLI::UI::Frame.open+
+    # 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
     #
@@ -142,7 +170,7 @@ module CLI
       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 +209,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
 

data/lib/cli/ui/ansi.rb

@@ -106,7 +106,9 @@ module CLI
       # * +n+ - The column to move to
       #
       def self.cursor_horizontal_absolute(n = 1)
-        control(n.to_s, 'G')
+        cmd = control(n.to_s, 'G')
+        cmd += control('1', 'D') if CLI::UI::OS.current.shift_cursor_on_line_reset?
+        cmd
       end
 
       # Show the cursor
@@ -136,13 +138,17 @@ module CLI
       # Move to the next line
       #
       def self.next_line
-        cursor_down + control('1', 'G')
+        cmd = cursor_down + control('1', 'G')
+        cmd += control('1', 'D') if CLI::UI::OS.current.shift_cursor_on_line_reset?
+        cmd
       end
 
       # Move to the previous line
       #
       def self.previous_line
-        cursor_up + control('1', 'G')
+        cmd = cursor_up + control('1', 'G')
+        cmd += control('1', 'D') if CLI::UI::OS.current.shift_cursor_on_line_reset?
+        cmd
       end
 
       def self.clear_to_end_of_line