cli-ui 1.2.2 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c658a2195a92d5e4ccf05fc1359eef09d25b5a01e0110c6ab84190d4a10c922
-  data.tar.gz: 4745f15513a91abef5cce3e3523d26de38d60336dbdf723601402fe8bd4b2635
+  metadata.gz: 1e28f7cb02b8647ee32e91b11f2b25b450c33a245514a520783d50cc6d5f7d84
+  data.tar.gz: 894e2a52591d18c5210efa36beab81d761c18734a42f8362d8af0c97e3bd4ae2
 SHA512:
-  metadata.gz: 609b7cab1cde15280659813f6b283c419c76b744a9089dcded708c3cf08113b7118150fd5e6642f8e41709f8b481ad0a51927d48ac294432ce108209faefccce
-  data.tar.gz: feb06db36c85af0d83c2407bf6ebb06ee1c65ea8ec38b7b80b09bbeaac0a25220a7fe2707993bee950916cd203e31d219b6db6adf132b08e9027be8e00df846a
+  metadata.gz: af8bd2b36c0d4c65e93aa966062e040109f5a10347404b112331975f04eb9cfe2a8601a9a9d1d4c1787f92f5a306b81f68e21d1e4f6728705fdfc81dd58fc25c
+  data.tar.gz: a94fa31ff9991a26202f8c4d4d85f87d9efdd23489ed47c5f719b0389a6106be4eee4ee86075fcddafe367d847b8299f69e6fe014fdffce629b0c9df43e156d1

data/README.md

@@ -108,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.
@@ -131,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/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,14 +38,29 @@ 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
     #
@@ -52,18 +70,18 @@ module CLI
       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
 

data/lib/cli/ui/ansi.rb

@@ -21,6 +21,8 @@ module CLI
           when 0x200d # zero-width joiner
             zwj = true
             acc
+          when "\n"
+            acc
           else
             acc + 1
           end
@@ -45,7 +47,7 @@ module CLI
       # - +cmd+ - ANSI control sequence Command
       #
       def self.control(args, cmd)
-        ESC + "[" + args + cmd
+        ESC + '[' + args + cmd
       end
 
       # https://en.wikipedia.org/wiki/ANSI_escape_code#graphics
@@ -106,19 +108,21 @@ 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
       #
       def self.show_cursor
-        control('', "?25h")
+        control('', '?25h')
       end
 
       # Hide the cursor
       #
       def self.hide_cursor
-        control('', "?25l")
+        control('', '?25l')
       end
 
       # Save the cursor position
@@ -136,13 +140,13 @@ module CLI
       # Move to the next line
       #
       def self.next_line
-        cursor_down + control('1', 'G')
+        cursor_down + cursor_horizontal_absolute
       end
 
       # Move to the previous line
       #
       def self.previous_line
-        cursor_up + control('1', 'G')
+        cursor_up + cursor_horizontal_absolute
       end
 
       def self.clear_to_end_of_line

data/lib/cli/ui/color.rb

@@ -31,19 +31,24 @@ module CLI
       BOLD    = new('1',  :bold)
       WHITE   = new('97', :white)
 
+      # 240 is very dark gray; 255 is very light gray. 244 is somewhat dark.
+      GRAY = new('38;5;244', :grey)
+
       MAP = {
-        red:     RED,
-        green:   GREEN,
-        yellow:  YELLOW,
-        blue:    BLUE,
+        red: RED,
+        green: GREEN,
+        yellow: YELLOW,
+        blue: BLUE,
         magenta: MAGENTA,
-        cyan:    CYAN,
-        reset:   RESET,
-        bold:    BOLD,
+        cyan: CYAN,
+        reset: RESET,
+        bold: BOLD,
+        gray: GRAY,
       }.freeze
 
       class InvalidColorName < ArgumentError
         def initialize(name)
+          super
           @name = name
         end
 

data/lib/cli/ui/formatter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
-
-require 'cli/ui'
-require 'strscan'
+require('cli/ui')
+require('strscan')
 
 module CLI
   module UI
@@ -13,39 +12,40 @@ module CLI
       #
       SGR_MAP = {
         # presentational
-        'red'       => '31',
-        'green'     => '32',
-        'yellow'    => '33',
-         # default blue is low-contrast against black in some default terminal color scheme
-        'blue'      => '94', # 9x = high-intensity fg color x
-        'magenta'   => '35',
-        'cyan'      => '36',
-        'bold'      => '1',
-        'italic'    => '3',
+        'red' => '31',
+        'green' => '32',
+        'yellow' => '33',
+        # default blue is low-contrast against black in some default terminal color scheme
+        'blue' => '94', # 9x = high-intensity fg color x
+        'magenta' => '35',
+        'cyan' => '36',
+        'bold' => '1',
+        'italic' => '3',
         'underline' => '4',
-        'reset'     => '0',
+        'reset' => '0',
 
         # semantic
-        'error'   => '31', # red
+        'error' => '31', # red
         'success' => '32', # success
         'warning' => '33', # yellow
-        'info'    => '94', # bright blue
+        'info' => '94', # bright blue
         'command' => '36', # cyan
       }.freeze
 
       BEGIN_EXPR = '{{'
       END_EXPR   = '}}'
 
+      SCAN_WIDGET   = %r[@widget/(?<handle>\w+):(?<args>.*?)}}]
       SCAN_FUNCNAME = /\w+:/
       SCAN_GLYPH    = /.}}/
-      SCAN_BODY     = /
+      SCAN_BODY     = %r{
         .*?
         (
           #{BEGIN_EXPR} |
           #{END_EXPR}   |
           \z
         )
-      /mx
+      }mx
 
       DISCARD_BRACES = 0..-3
 
@@ -123,7 +123,7 @@ module CLI
       end
 
       def parse_expr(sc, stack)
-        if match = sc.scan(SCAN_GLYPH)
+        if (match = sc.scan(SCAN_GLYPH))
           glyph_handle = match[0]
           begin
             glyph = Glyph.lookup(glyph_handle)
@@ -136,7 +136,20 @@ module CLI
               index
             )
           end
-        elsif match = sc.scan(SCAN_FUNCNAME)
+        elsif (match = sc.scan(SCAN_WIDGET))
+          match_data = SCAN_WIDGET.match(match) # Regexp.last_match doesn't work here
+          widget_handle = match_data['handle']
+          begin
+            widget = Widgets.lookup(widget_handle)
+            emit(widget.call(match_data['args']), stack)
+          rescue Widgets::InvalidWidgetHandle
+            index = sc.pos - 2 # rewind past '}}'
+            raise(FormatError.new(
+              "invalid widget handle at index #{index}: '#{widget_handle}'",
+              @text, index,
+            ))
+          end
+        elsif (match = sc.scan(SCAN_FUNCNAME))
           funcname = match.chop
           stack.push(funcname)
         else
@@ -153,10 +166,10 @@ module CLI
 
       def parse_body(sc, stack = [])
         match = sc.scan(SCAN_BODY)
-        if match && match.end_with?(BEGIN_EXPR)
+        if match&.end_with?(BEGIN_EXPR)
           emit(match[DISCARD_BRACES], stack)
           parse_expr(sc, stack)
-        elsif match && match.end_with?(END_EXPR)
+        elsif match&.end_with?(END_EXPR)
           emit(match[DISCARD_BRACES], stack)
           if stack.pop == LITERAL_BRACES
             emit('}}', stack)