cli-ui 0.1.2

data/lib/cli/ui/glyph.rb

@@ -0,0 +1,74 @@
+require 'cli/ui'
+
+module CLI
+  module UI
+    class Glyph
+      class InvalidGlyphHandle < ArgumentError
+        def initialize(handle)
+          @handle = handle
+        end
+
+        def message
+          keys = Glyph.available.join(',')
+          "invalid glyph handle: #{@handle} " \
+            "-- must be one of CLI::UI::Glyph.available (#{keys})"
+        end
+      end
+
+      attr_reader :handle, :codepoint, :color, :char, :to_s, :fmt
+
+      # Creates a new glyph
+      #
+      # ==== Attributes
+      #
+      # * +handle+ - The handle in the +MAP+ constant
+      # * +codepoint+ - The codepoint used to create the glyph (e.g. +0x2717+ for a ballot X)
+      # * +color+ - What color to output the glyph. Check +CLI::UI::Color+ for options.
+      #
+      def initialize(handle, codepoint, color)
+        @handle    = handle
+        @codepoint = codepoint
+        @color     = color
+        @char      = [codepoint].pack('U')
+        @to_s      = color.code + char + Color::RESET.code
+        @fmt       = "{{#{color.name}:#{char}}}"
+
+        MAP[handle] = self
+      end
+
+      # Mapping of glyphs to terminal output
+      MAP = {}
+      # YELLOw SMALL STAR (⭑)
+      STAR     = new('*', 0x2b51,  Color::YELLOW)
+      # BLUE MATHEMATICAL SCRIPT SMALL i (𝒾)
+      INFO     = new('i', 0x1d4be, Color::BLUE)
+      # BLUE QUESTION MARK (?)
+      QUESTION = new('?', 0x003f,  Color::BLUE)
+      # GREEN CHECK MARK (✓)
+      CHECK    = new('v', 0x2713,  Color::GREEN)
+      # RED BALLOT X (✗)
+      X        = new('x', 0x2717,  Color::RED)
+
+      # Looks up a glyph by name
+      #
+      # ==== Raises
+      # Raises a InvalidGlyphHandle if the glyph is not available
+      # You likely need to create it with +.new+ or you made a typo
+      #
+      # ==== Returns
+      # Returns a terminal output-capable string
+      #
+      def self.lookup(name)
+        MAP.fetch(name.to_s)
+      rescue KeyError
+        raise InvalidGlyphHandle, name
+      end
+
+      # All available glyphs by name
+      #
+      def self.available
+        MAP.keys
+      end
+    end
+  end
+end

data/lib/cli/ui/progress.rb

@@ -0,0 +1,90 @@
+require 'cli/ui'
+
+module CLI
+  module UI
+    class Progress
+      # A Cyan filled block
+      FILLED_BAR = "\e[46m"
+      # A bright white block
+      UNFILLED_BAR = "\e[1;47m"
+
+      # Add a progress bar to the terminal output
+      #
+      # https://user-images.githubusercontent.com/3074765/33799794-cc4c940e-dd00-11e7-9bdc-90f77ec9167c.gif
+      #
+      # ==== Example Usage:
+      #
+      # Set the percent to X
+      #   CLI::UI::Progress.progress do |bar|
+      #     bar.tick(set_percent: percent)
+      #   end
+      #
+      # Increase the percent by 1 percent
+      #   CLI::UI::Progress.progress do |bar|
+      #     bar.tick
+      #   end
+      #
+      # Increase the percent by X
+      #   CLI::UI::Progress.progress do |bar|
+      #     bar.tick(percent: 5)
+      #   end
+      def self.progress(width: Terminal.width)
+        bar = Progress.new(width: width)
+        print CLI::UI::ANSI.hide_cursor
+        yield(bar)
+      ensure
+        puts bar.to_s
+        CLI::UI.raw do
+          print(ANSI.show_cursor)
+          puts(ANSI.previous_line + ANSI.end_of_line)
+        end
+      end
+
+      # Initialize a progress bar. Typically used in a +Progress.progress+ block
+      #
+      # ==== Options
+      # One of the follow can be used, but not both together
+      #
+      # * +:width+ - The width of the terminal
+      #
+      def initialize(width: Terminal.width)
+        @percent_done = 0
+        @max_width = width
+      end
+
+      # Set the progress of the bar. Typically used in a +Progress.progress+ block
+      #
+      # ==== Options
+      # One of the follow can be used, but not both together
+      #
+      # * +:percent+ - Increment progress by a specific percent amount
+      # * +:set_percent+ - Set progress to a specific percent
+      #
+      def tick(percent: 0.01, set_percent: nil)
+        raise ArgumentError, 'percent and set_percent cannot both be specified' if percent != 0.01 && set_percent
+        @percent_done += percent
+        @percent_done = set_percent if set_percent
+        @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"
+      end
+
+      # Format the progress bar to be printed to terminal
+      #
+      def to_s
+        suffix = " #{(@percent_done * 100).round(2)}%"
+        workable_width = @max_width - Frame.prefix_width - suffix.size
+        filled = (@percent_done * workable_width.to_f).ceil
+        unfilled = workable_width - filled
+
+        CLI::UI.resolve_text [
+          FILLED_BAR + ' ' * filled,
+          UNFILLED_BAR + ' ' * unfilled,
+          CLI::UI::Color::RESET.code + suffix
+        ].join
+      end
+    end
+  end
+end

data/lib/cli/ui/prompt.rb

@@ -0,0 +1,156 @@
+require 'cli/ui'
+require 'readline'
+
+module CLI
+  module UI
+    module Prompt
+      autoload :InteractiveOptions,  'cli/ui/prompt/interactive_options'
+      private_constant :InteractiveOptions
+
+      class << self
+        # Ask a user a question with either free form answer or a set of answers
+        # Do not use this method for yes/no questions. Use +confirm+
+        # Can use arrows, y/n, numbers, and vim bindings to control
+        #
+        # * Handles free form answers (options are nil)
+        # * Handles default answers for free form text
+        # * Handles file auto completion for file input
+        # * Handles interactively choosing answers using +InteractiveOptions+
+        #
+        # https://user-images.githubusercontent.com/3074765/33799822-47f23302-dd01-11e7-82f3-9072a5a5f611.png
+        #
+        # ==== Attributes
+        #
+        # * +question+ - (required) The question to ask the user
+        #
+        # ==== Options
+        #
+        # * +:options+ - Options to ask the user. Will use +InteractiveOptions+ to do so
+        # * +:default+ - The default answer to the question (e.g. they just press enter and don't input anything)
+        # * +:is_file+ - Tells the input to use file auto-completion (tab completion)
+        # * +:allow_empty+ - Allows the answer to be empty
+        #
+        # Note:
+        # * +:options+ conflicts with +:default+ and +:is_file+, you cannot set options with either of these keywords
+        # * +:default+ conflicts with +:allow_empty:, you cannot set these together
+        #
+        # ==== Example Usage:
+        #
+        # Free form question
+        #   CLI::UI::Prompt.ask('What color is the sky?')
+        #
+        # Free form question with a file answer
+        #   CLI::UI::Prompt.ask('Where is your Gemfile located?', is_file: true)
+        #
+        # Free form question with a default answer
+        #   CLI::UI::Prompt.ask('What color is the sky?', default: 'blue')
+        #
+        # Free form question when the answer can be empty
+        #   CLI::UI::Prompt.ask('What is your opinion on this question?', allow_empty: true)
+        #
+        # Question with answers
+        #   CLI::UI::Prompt.ask('What kind of project is this?', options: %w(rails go ruby python))
+        #
+        #
+        def ask(question, options: nil, default: nil, is_file: nil, allow_empty: true)
+          if (default && !allow_empty) || (options && (default || is_file))
+            raise(ArgumentError, 'conflicting arguments')
+          end
+
+          if default
+            puts_question("#{question} (empty = #{default})")
+          elsif options
+            puts_question("#{question} {{yellow:(choose with ↑ ↓ ⏎)}}")
+          else
+            puts_question(question)
+          end
+
+          # Present the user with options
+          if options
+            resp = InteractiveOptions.call(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}}})")
+
+            return resp
+          end
+
+          # Ask a free form question
+          loop do
+            line = readline(is_file: is_file)
+
+            if line.empty? && default
+              write_default_over_empty_input(default)
+              return default
+            end
+
+            if !line.empty? || allow_empty
+              return line
+            end
+          end
+        end
+
+        # Asks the user a yes/no question.
+        # Can use arrows, y/n, numbers (1/2), and vim bindings to control
+        #
+        # ==== Example Usage:
+        #
+        # Confirmation question
+        #   CLI::UI::Prompt.confirm('Is the sky blue?')
+        #
+        def confirm(question)
+          ask(question, options: %w(yes no)) == 'yes'
+        end
+
+        private
+
+        def write_default_over_empty_input(default)
+          CLI::UI.raw do
+            STDERR.puts(
+              CLI::UI::ANSI.cursor_up(1) +
+              "\r" +
+              CLI::UI::ANSI.cursor_forward(4) + # TODO: width
+              default +
+              CLI::UI::Color::RESET.code
+            )
+          end
+        end
+
+        def puts_question(str)
+          CLI::UI.with_frame_color(:blue) do
+            STDOUT.puts(CLI::UI.fmt('{{?}} ' + str))
+          end
+        end
+
+        def readline(is_file: false)
+          if is_file
+            Readline.completion_proc = Readline::FILENAME_COMPLETION_PROC
+            Readline.completion_append_character = ""
+          else
+            Readline.completion_proc = proc { |*| nil }
+            Readline.completion_append_character = " "
+          end
+
+          # because Readline is a C library, CLI::UI's hooks into $stdout don't
+          # work. We could work around this by having CLI::UI use a pipe and a
+          # thread to manage output, but the current strategy feels like a
+          # better tradeoff.
+          prefix = CLI::UI.with_frame_color(:blue) { CLI::UI::Frame.prefix }
+          prompt = prefix + CLI::UI.fmt('{{blue:> }}{{yellow:')
+
+          begin
+            line = Readline.readline(prompt, true)
+            line.to_s.chomp
+          rescue Interrupt
+            CLI::UI.raw { STDERR.puts('^C' + CLI::UI::Color::RESET.code) }
+            raise
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,171 @@
+require 'io/console'
+
+module CLI
+  module UI
+    module Prompt
+      class InteractiveOptions
+        # 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
+        #
+        # https://user-images.githubusercontent.com/3074765/33797984-0ebb5e64-dcdf-11e7-9e7e-7204f279cece.gif
+        #
+        # ==== Example Usage:
+        #
+        # Ask an interactive question
+        #   CLI::UI::Prompt::InteractiveOptions.call(%w(rails go python))
+        #
+        def self.call(options)
+          list = new(options)
+          options[list.call - 1]
+        end
+
+        # Initializes a new +InteractiveOptions+
+        # Usually called from +self.call+
+        #
+        # ==== Example Usage:
+        #
+        #   CLI::UI::Prompt::InteractiveOptions.new(%w(rails go python))
+        #
+        def initialize(options)
+          @options = options
+          @active = 1
+          @marker = '>'
+          @answer = nil
+          @state = :root
+        end
+
+        # Calls the +InteractiveOptions+ and asks the question
+        # Usually used from +self.call+
+        #
+        def call
+          CLI::UI.raw { print(ANSI.hide_cursor) }
+          while @answer.nil?
+            render_options
+            wait_for_user_input
+            reset_position
+          end
+          clear_output
+          @answer
+        ensure
+          CLI::UI.raw do
+            print(ANSI.show_cursor)
+            puts(ANSI.previous_line + ANSI.end_of_line)
+          end
+        end
+
+        private
+
+        def reset_position
+          # This will put us back at the beginning of the options
+          # 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
+
+        def clear_output
+          CLI::UI.raw do
+            # Write over all lines with whitespace
+            num_lines.times { puts(' ' * CLI::UI::Terminal.width) }
+          end
+          reset_position
+        end
+
+        def num_lines
+          # @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
+          joined_options = @options.join("\n")
+          joined_options.split("\n").reject(&:empty?).size
+        end
+
+        ESC = "\e"
+
+        def up
+          @active = @active - 1 >= 1 ? @active - 1 : @options.length
+        end
+
+        def down
+          @active = @active + 1 <= @options.length ? @active + 1 : 1
+        end
+
+        def select_n(n)
+          @active = n
+          @answer = n
+        end
+
+        def select_bool(char)
+          return unless (@options - %w(yes no)).empty?
+          opt = @options.detect { |o| o.start_with?(char) }
+          @active = @options.index(opt) + 1
+          @answer = @options.index(opt) + 1
+        end
+
+        # rubocop:disable Style/WhenThen,Layout/SpaceBeforeSemicolon
+        def wait_for_user_input
+          char = read_char
+          case @state
+          when :root
+            case char
+            when ESC                       ; @state = :esc
+            when 'k'                       ; up
+            when 'j'                       ; down
+            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
+            end
+          when :esc
+            case char
+            when '[' ; @state = :esc_bracket
+            else     ; raise Interrupt # unhandled escape sequence.
+            end
+          when :esc_bracket
+            @state = :root
+            case char
+            when 'A' ; up
+            when 'B' ; down
+            else     ; raise Interrupt # unhandled escape sequence.
+            end
+          end
+        end
+        # rubocop:enable Style/WhenThen,Layout/SpaceBeforeSemicolon
+
+        def read_char
+          raw_tty! { $stdin.getc.chr }
+        rescue IOError
+          "\e"
+        end
+
+        def raw_tty!
+          if ENV['TEST'] || !$stdin.tty?
+            yield
+          else
+            $stdin.raw { yield }
+          end
+        end
+
+        def render_options
+          max_num_length = (@options.size + 1).to_s.length
+          @options.each_with_index do |choice, index|
+            num = index + 1
+            padding = ' ' * (max_num_length - num.to_s.length)
+            message = "  #{num}.#{padding}"
+            message += choice.split("\n").map { |l| " {{bold:#{l}}}" }.join("\n")
+
+            if num == @active
+              message = message.split("\n").map.with_index do |l, idx|
+                idx == 0 ? "{{blue:> #{l.strip}}}" : "{{blue:>#{l.strip}}}"
+              end.join("\n")
+            end
+
+            CLI::UI.with_frame_color(:blue) do
+              puts CLI::UI.fmt(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end