cli-ui 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd5d21387192d8ab8f7195f3e298674e1678e850
-  data.tar.gz: 63524be481c12c133473aafbd6ce588e0e633d90
+  metadata.gz: ad712abce399f06334f0af18135d831f788ab217
+  data.tar.gz: dd3befbb4a7cf345965bdc10ebbaaa208a93a8db
 SHA512:
-  metadata.gz: '0352484323c19b74b86edfff5cdef454f92e488113a06feef7bf27314b30dd077e88201cddac07c4c58fcb020a0e84290b24e97a4944152277867aae1246ec8f'
-  data.tar.gz: 46d12fc29cee51ffb384151d8f75df27a4f88e5ed5d45788d04898ce5dd050df22d6ad4609debe2b17e07990d07269d362d8af326e5cda74316c22da8e77e5b7
+  metadata.gz: 843c4c640d52da02bded3f3ac79bc3b4a7d8e56227f3914a1b3289887bceb89b54d26b11d8cc55e2cf2ad871e04f408e9f5cc631a79ebc3bba4d89ec1fd15afd
+  data.tar.gz: 133dada99d103ea7449e6138f39d58929b09552895869317a3fba69844057a92eab3a3a0ecb920667a1c3357813c25bfd72af1b9d8ac6feccdb99697a26b928b

data/lib/cli/ui.rb

@@ -8,6 +8,7 @@ module CLI
     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'
 
@@ -68,10 +69,13 @@ module CLI
     # ==== Attributes
     #
     # * +input+ - input to format
+    # * +truncate_to+ - number of characters to truncate the string to (or nil)
     #
-    def self.resolve_text(input)
+    def self.resolve_text(input, truncate_to: nil)
       return input if input.nil?
-      CLI::UI::Formatter.new(input).format
+      formatted = CLI::UI::Formatter.new(input).format
+      return formatted unless truncate_to
+      return CLI::UI::Truncater.call(formatted, truncate_to)
     end
 
     # Conviencence Method to format text using +CLI::UI::Formatter.format+
@@ -86,9 +90,9 @@ module CLI
     #
     # ==== Options
     #
-    # * +enable_color+ - should color be used? default to true
+    # * +enable_color+ - should color be used? default to true unless output is redirected.
     #
-    def self.fmt(input, enable_color: true)
+    def self.fmt(input, enable_color: enable_color?)
       CLI::UI::Formatter.new(input).format(enable_color: enable_color)
     end
 
@@ -157,6 +161,26 @@ module CLI
     ensure
       Thread.current[:no_cliui_frame_inset] = prev
     end
+
+    # Check whether colour is enabled in Formatter output. By default, colour
+    # is enabled when STDOUT is a TTY; that is, when output has not been
+    # redirected to another program or to a file.
+    #
+    def self.enable_color?
+      @enable_color
+    end
+
+    # Turn colour output in Formatter on or off.
+    #
+    # ==== Attributes
+    #
+    # * +bool+ - true or false; enable or disable colour.
+    #
+    def self.enable_color=(bool)
+      @enable_color = !!bool
+    end
+
+    self.enable_color = $stdout.tty?
   end
 end
 

data/lib/cli/ui/ansi.rb

@@ -145,10 +145,8 @@ module CLI
         cursor_up + control('1', 'G')
       end
 
-      # Move to the end of the line
-      #
-      def self.end_of_line
-        control("\033[", 'C')
+      def self.clear_to_end_of_line
+        control('', 'K')
       end
     end
   end

data/lib/cli/ui/formatter.rb

@@ -16,7 +16,8 @@ module CLI
         'red'       => '31',
         'green'     => '32',
         'yellow'    => '33',
-        'blue'      => '34',
+         # 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',
@@ -28,7 +29,7 @@ module CLI
         'error'   => '31', # red
         'success' => '32', # success
         'warning' => '33', # yellow
-        'info'    => '34', # blue
+        'info'    => '94', # bright blue
         'command' => '36', # cyan
       }.freeze
 
@@ -78,9 +79,9 @@ module CLI
       #
       # ===== Options
       #
-      # * +:enable_color+ - enable color output? Default is true
+      # * +:enable_color+ - enable color output? Default is true unless output is redirected
       #
-      def format(sgr_map = SGR_MAP, enable_color: true)
+      def format(sgr_map = SGR_MAP, enable_color: CLI::UI.enable_color?)
         @nodes = []
         stack = parse_body(StringScanner.new(@text))
         prev_fmt = nil

data/lib/cli/ui/glyph.rb

@@ -48,6 +48,10 @@ module CLI
       CHECK    = new('v', 0x2713,  Color::GREEN)
       # RED BALLOT X (✗)
       X        = new('x', 0x2717,  Color::RED)
+      # Bug emoji (🐛)
+      BUG      = new('b', 0x1f41b, Color::WHITE)
+      # RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK (»)
+      CHEVRON  = new('>', 0xbb,    Color::YELLOW)
 
       # Looks up a glyph by name
       #

data/lib/cli/ui/progress.rb

@@ -36,7 +36,6 @@ module CLI
         puts bar.to_s
         CLI::UI.raw do
           print(ANSI.show_cursor)
-          puts(ANSI.previous_line + ANSI.end_of_line)
         end
       end
 
@@ -67,8 +66,7 @@ module CLI
         @percent_done = [@percent_done, 1.0].min # Make sure we can't go above 1.0
 
         print to_s
-        print CLI::UI::ANSI.previous_line
-        print CLI::UI::ANSI.end_of_line + "\n"
+        print CLI::UI::ANSI.previous_line + "\n"
       end
 
       # Format the progress bar to be printed to terminal

data/lib/cli/ui/prompt.rb

@@ -71,13 +71,13 @@ module CLI
         #     handler.option('python') { |selection| selection }
         #   end
         #
-        def ask(question, options: nil, default: nil, is_file: nil, allow_empty: true, &options_proc)
+        def ask(question, options: nil, default: nil, is_file: nil, allow_empty: true, multiple: false, &options_proc)
           if ((options || block_given?) && (default || is_file))
             raise(ArgumentError, 'conflicting arguments: options provided with default or is_file')
           end
 
           if options || block_given?
-            ask_interactive(question, options, &options_proc)
+            ask_interactive(question, options, multiple: multiple, &options_proc)
           else
             ask_free_form(question, default, is_file, allow_empty)
           end
@@ -121,7 +121,7 @@ module CLI
           end
         end
 
-        def ask_interactive(question, options = nil)
+        def ask_interactive(question, options = nil, multiple: false)
           raise(ArgumentError, 'conflicting arguments: options and block given') if options && block_given?
 
           options ||= if block_given?
@@ -131,23 +131,36 @@ module CLI
           end
 
           raise(ArgumentError, 'insufficient options') if options.nil? || options.size < 2
-          puts_question("#{question} {{yellow:(choose with ↑ ↓ ⏎)}}")
-          resp = interactive_prompt(options)
-
-          # Clear the line, and reset the question to include the answer
-          print(ANSI.previous_line + ANSI.end_of_line + ' ')
-          print(ANSI.cursor_save)
-          print(' ' * CLI::UI::Terminal.width)
-          print(ANSI.cursor_restore)
-          puts_question("#{question} (You chose: {{italic:#{resp}}})")
+          instructions = (multiple ? "Toggle options. " : "") + "Choose with ↑ ↓ ⏎"
+          puts_question("#{question} {{yellow:(#{instructions})}}")
+          resp = interactive_prompt(options, multiple: multiple)
+
+          # Clear the line
+          print ANSI.previous_line + ANSI.clear_to_end_of_line
+          # Force StdoutRouter to prefix
+          print ANSI.previous_line + "\n"
+
+          # reset the question to include the answer
+          resp_text = resp
+          if multiple
+            resp_text = case resp.size
+            when 0
+              "<nothing>"
+            when 1..2
+              resp.join(" and ")
+            else
+              "#{resp.size} items"
+            end
+          end
+          puts_question("#{question} (You chose: {{italic:#{resp_text}}})")
 
           return handler.call(resp) if block_given?
           resp
         end
 
         # Useful for stubbing in tests
-        def interactive_prompt(options)
-          InteractiveOptions.call(options)
+        def interactive_prompt(options, multiple: false)
+          InteractiveOptions.call(options, multiple: multiple)
         end
 
         def write_default_over_empty_input(default)

data/lib/cli/ui/prompt/interactive_options.rb

@@ -4,6 +4,9 @@ module CLI
   module UI
     module Prompt
       class InteractiveOptions
+        DONE = "Done"
+        CHECKBOX_ICON = { false => "☐", true => "☑" }
+
         # Prompts the user with options
         # Uses an interactive session to allow the user to pick an answer
         # Can use arrows, y/n, numbers (1/2), and vim bindings to control
@@ -15,9 +18,14 @@ module CLI
         # Ask an interactive question
         #   CLI::UI::Prompt::InteractiveOptions.call(%w(rails go python))
         #
-        def self.call(options)
-          list = new(options)
-          options[list.call - 1]
+        def self.call(options, multiple: false)
+          list = new(options, multiple: multiple)
+          selected = list.call
+          if multiple
+            selected.map { |s| options[s - 1] }
+          else
+            options[selected - 1]
+          end
         end
 
         # Initializes a new +InteractiveOptions+
@@ -27,12 +35,17 @@ module CLI
         #
         #   CLI::UI::Prompt::InteractiveOptions.new(%w(rails go python))
         #
-        def initialize(options)
+        def initialize(options, multiple: false)
           @options = options
           @active = 1
           @marker = '>'
           @answer = nil
           @state = :root
+          @multiple = multiple
+          # 0-indexed array representing if selected
+          # @options[0] is selected if @chosen[0]
+          @chosen = Array.new(@options.size) { false } if multiple
+          @redraw = true
         end
 
         # Calls the +InteractiveOptions+ and asks the question
@@ -42,7 +55,7 @@ module CLI
           CLI::UI.raw { print(ANSI.hide_cursor) }
           while @answer.nil?
             render_options
-            wait_for_user_input
+            process_input_until_redraw_required
             reset_position
           end
           clear_output
@@ -50,7 +63,6 @@ module CLI
         ensure
           CLI::UI.raw do
             print(ANSI.show_cursor)
-            puts(ANSI.previous_line + ANSI.end_of_line)
           end
         end
 
@@ -61,7 +73,6 @@ module CLI
           # When we redraw the options, they will be overwritten
           CLI::UI.raw do
             num_lines.times { print(ANSI.previous_line) }
-            print(ANSI.previous_line + ANSI.end_of_line + "\n")
           end
         end
 
@@ -74,30 +85,52 @@ module CLI
         end
 
         def num_lines
+          options = presented_options.map(&:first)
           # @options will be an array of questions but each option can be multi-line
           # so to get the # of lines, you need to join then split
 
           # empty_option_count is needed since empty option titles are omitted
           # from the line count when reject(&:empty?) is called
 
-          empty_option_count =  @options.count(&:empty?)
-          joined_options = @options.join("\n")
+          empty_option_count = options.count(&:empty?)
+          joined_options = options.join("\n")
           joined_options.split("\n").reject(&:empty?).size + empty_option_count
         end
 
         ESC = "\e"
 
         def up
-          @active = @active - 1 >= 1 ? @active - 1 : @options.length
+          min_pos = @multiple ? 0 : 1
+          @active = @active - 1 >= min_pos ? @active - 1 : @options.length
+          @redraw = true
         end
 
         def down
-          @active = @active + 1 <= @options.length ? @active + 1 : 1
+          min_pos = @multiple ? 0 : 1
+          @active = @active + 1 <= @options.length ? @active + 1 : min_pos
+          @redraw = true
         end
 
+        # n is 1-indexed selection
+        # n == 0 if "Done" was selected in @multiple mode
         def select_n(n)
-          @active = n
-          @answer = n
+          if @multiple
+            if n == 0
+              @answer = []
+              @chosen.each_with_index do |selected, i|
+                @answer << i + 1 if selected
+              end
+            else
+              @active = n
+              @chosen[n - 1] = !@chosen[n - 1]
+            end
+          elsif n == 0
+            # Ignore pressing "0" when not in multiple mode
+          else
+            @active = n
+            @answer = n
+          end
+          @redraw = true
         end
 
         def select_bool(char)
@@ -105,6 +138,16 @@ module CLI
           opt = @options.detect { |o| o.start_with?(char) }
           @active = @options.index(opt) + 1
           @answer = @options.index(opt) + 1
+          @redraw = true
+        end
+
+        def select_current
+          select_n(@active)
+        end
+
+        def process_input_until_redraw_required
+          @redraw = false
+          wait_for_user_input until @redraw
         end
 
         # rubocop:disable Style/WhenThen,Layout/SpaceBeforeSemicolon
@@ -117,10 +160,11 @@ module CLI
             when ESC                       ; @state = :esc
             when 'k'                       ; up
             when 'j'                       ; down
+            when '0'                       ; select_n(char.to_i)
             when ('1'..@options.size.to_s) ; select_n(char.to_i)
             when 'y', 'n'                  ; select_bool(char)
-            when " ", "\r", "\n"           ; @answer = @active # <enter>
-            when "\u0003"                  ; raise Interrupt   # Ctrl-c
+            when " ", "\r", "\n"           ; select_current  # <enter>
+            when "\u0003"                  ; raise Interrupt # Ctrl-c
             end
           when :esc
             case char
@@ -157,13 +201,67 @@ module CLI
           end
         end
 
+        def presented_options(recalculate: false)
+          return @presented_options unless recalculate
+
+          @presented_options = @options.zip(1..Float::INFINITY)
+          @presented_options.unshift([DONE, 0]) if @multiple
+
+          while num_lines > max_options
+            # try to keep the selection centered in the window:
+            if distance_from_selection_to_end > distance_from_start_to_selection
+              # selection is closer to top than bottom, so trim a row from the bottom
+              ensure_last_item_is_continuation_marker
+              @presented_options.delete_at(-2)
+            else
+              # selection is closer to bottom than top, so trim a row from the top
+              ensure_first_item_is_continuation_marker
+              @presented_options.delete_at(1)
+            end
+          end
+
+          @presented_options
+        end
+
+        def distance_from_selection_to_end
+          last_visible_option_number = @presented_options[-1].last || @presented_options[-2].last
+          last_visible_option_number - @active
+        end
+
+        def distance_from_start_to_selection
+          first_visible_option_number = @presented_options[0].last || @presented_options[1].last
+          @active - first_visible_option_number
+        end
+
+        def ensure_last_item_is_continuation_marker
+          @presented_options.push(["...", nil]) if @presented_options.last.last
+        end
+
+        def ensure_first_item_is_continuation_marker
+          @presented_options.unshift(["...", nil]) if @presented_options.first.last
+        end
+
+        def max_options
+          @max_options ||= CLI::UI::Terminal.height - 2 # Keeps a one line question visible
+        end
+
         def render_options
           max_num_length = (@options.size + 1).to_s.length
-          @options.each_with_index do |choice, index|
-            num = index + 1
+
+          presented_options(recalculate: true).each do |choice, num|
+            is_chosen = @multiple && num && @chosen[num - 1]
+
             padding = ' ' * (max_num_length - num.to_s.length)
-            message = "  #{num}.#{padding}"
-            message += choice.split("\n").map { |l| " {{bold:#{l}}}" }.join("\n")
+            message = "  #{num}#{num ? '.' : ' '}#{padding}"
+
+            format = "%s"
+            # If multiple, bold only selected. If not multiple, bold everything
+            format = "{{bold:#{format}}}" if !@multiple || is_chosen
+            format = "{{cyan:#{format}}}" if @multiple && is_chosen && num != @active
+            format = " #{format}"
+
+            message += sprintf(format, CHECKBOX_ICON[is_chosen]) if @multiple && num && num > 0
+            message += choice.split("\n").map { |l| sprintf(format, l) }.join("\n")
 
             if num == @active
               message = message.split("\n").map.with_index do |l, idx|
@@ -172,7 +270,7 @@ module CLI
             end
 
             CLI::UI.with_frame_color(:blue) do
-              puts CLI::UI.fmt(message)
+              puts CLI::UI.fmt(message) + CLI::UI::ANSI.clear_to_end_of_line
             end
           end
         end

data/lib/cli/ui/spinner/spin_group.rb

@@ -81,9 +81,10 @@ module CLI
           #
           # * +index+ - index of the task
           # * +force+ - force rerender of the task
+          # * +width+ - current terminal width to format for
           #
-          def render(index, force = true)
-            return full_render(index) if force || @force_full_render
+          def render(index, force = true, width: CLI::UI::Terminal.width)
+            return full_render(index, width) if force || @force_full_render
             partial_render(index)
           ensure
             @force_full_render = false
@@ -102,8 +103,17 @@ module CLI
 
           private
 
-          def full_render(index)
-            inset + glyph(index) + CLI::UI::Color::RESET.code + ' ' + CLI::UI.resolve_text(title) + "\e[K"
+          def full_render(index, terminal_width)
+            prefix = inset +
+              glyph(index) +
+              CLI::UI::Color::RESET.code +
+              ' '
+
+            truncation_width = terminal_width - CLI::UI::ANSI.printing_width(prefix)
+
+            prefix +
+              CLI::UI.resolve_text(title, truncate_to: truncation_width) +
+              "\e[K"
           end
 
           def partial_render(index)
@@ -158,6 +168,8 @@ module CLI
           loop do
             all_done = true
 
+            width = CLI::UI::Terminal.width
+
             @m.synchronize do
               CLI::UI.raw do
                 @tasks.each.with_index do |task, int_index|
@@ -166,14 +178,14 @@ module CLI
                   all_done = false unless task_done
 
                   if nat_index > @consumed_lines
-                    print(task.render(idx, true) + "\n")
+                    print(task.render(idx, true, width: width) + "\n")
                     @consumed_lines += 1
                   else
                     offset = @consumed_lines - int_index
                     move_to   = CLI::UI::ANSI.cursor_up(offset) + "\r"
                     move_from = "\r" + CLI::UI::ANSI.cursor_down(offset)
 
-                    print(move_to + task.render(idx, idx.zero?) + move_from)
+                    print(move_to + task.render(idx, idx.zero?, width: width) + move_from)
                   end
                 end
               end

data/lib/cli/ui/terminal.rb

@@ -5,6 +5,7 @@ module CLI
   module UI
     module Terminal
       DEFAULT_WIDTH = 80
+      DEFAULT_HEIGHT = 24
 
       # Returns the width of the terminal, if possible
       # Otherwise will return 80
@@ -19,6 +20,17 @@ module CLI
       rescue Errno::EIO
         DEFAULT_WIDTH
       end
+
+      def self.height
+        if console = IO.respond_to?(:console) && IO.console
+          height = console.winsize[0]
+          height.zero? ? DEFAULT_HEIGHT : height
+        else
+          DEFAULT_HEIGHT
+        end
+      rescue Errno::EIO
+        DEFAULT_HEIGHT
+      end
     end
   end
 end

data/lib/cli/ui/truncater.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'cli/ui'
+
+module CLI
+  module UI
+    # Truncater truncates a string to a provided printable width.
+    module Truncater
+      PARSE_ROOT = :root
+      PARSE_ANSI = :ansi
+      PARSE_ESC  = :esc
+      PARSE_ZWJ  = :zwj
+
+      ESC                 = 0x1b
+      LEFT_SQUARE_BRACKET = 0x5b
+      ZWJ                 = 0x200d # emojipedia.org/emoji-zwj-sequences
+      SEMICOLON           = 0x3b
+
+      # EMOJI_RANGE in particular is super inaccurate. This is best-effort.
+      # If you need this to be more accurate, we'll almost certainly accept a
+      # PR improving it.
+      EMOJI_RANGE    = 0x1f300..0x1f5ff
+      NUMERIC_RANGE  = 0x30..0x39
+      LC_ALPHA_RANGE = 0x40..0x5a
+      UC_ALPHA_RANGE = 0x60..0x71
+
+      TRUNCATED = "\x1b[0m…"
+
+      class << self
+        def call(text, printing_width)
+          return text if text.size <= printing_width
+
+          width            = 0
+          mode             = PARSE_ROOT
+          truncation_index = nil
+
+          codepoints = text.codepoints
+          codepoints.each.with_index do |cp, index|
+            case mode
+            when PARSE_ROOT
+              case cp
+              when ESC # non-printable, followed by some more non-printables.
+                mode = PARSE_ESC
+              when ZWJ # non-printable, followed by another non-printable.
+                mode = PARSE_ZWJ
+              else
+                width += width(cp)
+                if width >= printing_width
+                  truncation_index ||= index
+                  # it looks like we could break here but we still want the
+                  # width calculation for the rest of the characters.
+                end
+              end
+            when PARSE_ESC
+              case cp
+              when LEFT_SQUARE_BRACKET
+                mode = PARSE_ANSI
+              else
+                mode = PARSE_ROOT
+              end
+            when PARSE_ANSI
+              # ANSI escape codes preeeetty much have the format of:
+              # \x1b[0-9;]+[A-Za-z]
+              case cp
+              when NUMERIC_RANGE, SEMICOLON
+              when LC_ALPHA_RANGE, UC_ALPHA_RANGE
+                mode = PARSE_ROOT
+              else
+                # unexpected. let's just go back to the root state I guess?
+                mode = PARSE_ROOT
+              end
+            when PARSE_ZWJ
+              # consume any character and consider it as having no width
+              # width(x+ZWJ+y) = width(x).
+              mode = PARSE_ROOT
+            end
+          end
+
+          # Without the `width <= printing_width` check, we truncate
+          # "foo\x1b[0m" for a width of 3, but it should not be truncated.
+          # It's specifically for the case where we decided "Yes, this is the
+          # point at which we'd have to add a truncation!" but it's actually
+          # the end of the string.
+          return text if !truncation_index || width <= printing_width
+
+          codepoints[0...truncation_index].pack("U*") + TRUNCATED
+        end
+
+        private
+
+        def width(printable_codepoint)
+          case printable_codepoint
+          when EMOJI_RANGE
+            2
+          else
+            1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cli/ui/version.rb

@@ -1,5 +1,5 @@
 module CLI
   module UI
-    VERSION = "1.1.4"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-ui
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Burke Libbey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - lib/cli/ui/spinner/spin_group.rb
 - lib/cli/ui/stdout_router.rb
 - lib/cli/ui/terminal.rb
+- lib/cli/ui/truncater.rb
 - lib/cli/ui/version.rb
 homepage: https://github.com/shopify/cli-ui
 licenses: