console-glitter 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90788325694ec068cfc935f33d158bc21a49d61b
-  data.tar.gz: 7103fb578db1f056c5806109a6a363ad9e9e2a28
+  metadata.gz: bca0b708e7d721160c7371babc90ae03901a0715
+  data.tar.gz: 37d30153c76f6f2118aa9419beeeb46b605b10eb
 SHA512:
-  metadata.gz: ffe819e0b0f0cb4dfebf32a67a727af2628da21c77572f86885315119e88a4bd7567d55998ee56a4880a3a01ffdb267a1ae77e17d9f3dd0c31d47f0355cd9671
-  data.tar.gz: 8ea90df7f43d7574121591c52a8ff9404449d98d201f3ed5f1980716d2c1b4dbae28032cb48a5ff493dfbb748bcb89f6453682854e31c31aeb416359699d2316
+  metadata.gz: 16e22ce68dfda6b492be65e4b26b7147a3bbf241c29454870d09c8f6b8b2cc86dd1f162716385eddfad9cd506adb0ae670a09ff3ccf89036d103ae9bdb2d819a
+  data.tar.gz: 5ae03963d116bfe502a8f54584c6dadba29e8f8a557afb2fdfd8a9417319dc0b616586c5ea4b7c266df6e3344fc5059860d3a1e86c749542b8ada5ae832752cb

data/lib/console-glitter.rb

@@ -1,264 +1,20 @@
-require 'console-glitter/version'
-require 'console-glitter/ansi'
-require 'readline'
-require 'io/console'
-
 module ConsoleGlitter
-  module UI extend self
-    extend ANSI
-    # Public: Prompt user for input, allowing for a default answer and a list
-    # of valid responses to be provided.
-    #
-    # question - Query to be presented to the user.
-    # options  - Hash containing arguments defining acceptable responses.
-    #            (default: {}):
-    #            :default_answer - String containing the default answer.  If
-    #                              this is nil, a non-empty answer MUST be
-    #                              given.
-    #            :allow_empty    - Whether or not to allow empty responses.
-    #                              Unless explicitly allowed, empty answers
-    #                              will be rejected.
-    #            :valid_answers  - An Array containing all valid responses.  If
-    #                              this is empty, any answer will be accepted
-    #                              (unless empty answers are disallowed as
-    #                              specified above).  Valid responses may be
-    #                              any class with a match method such as
-    #                              Strings or Regexps.
-    # wordlist - Array of words to be used for input auto-completion.
-    #            (default: [])
-    # block    - Lambda which will override the default autocompletion lambda
-    #            as defined in autocomplete_lambda if present.  (default: nil)
-    #
-    # Returns a String containing the answer provided by the user.
-    def prompt(question, options = {}, wordlist = [], block = nil)
-      default = options[:default_answer].to_s
-      allow_empty = options[:allow_empty]
-      valid = regexify_answers(options[:valid_answers])
-
-      default_display = " [#{default.strip}]" unless default.empty?
-      question = "#{question.strip}#{default_display}> "
-
-      answer = nil
-      while answer.nil?
-        answer = user_prompt(question, wordlist, block)
-        answer = default if answer.empty?
-
-        if answer.empty?
-          answer = nil unless allow_empty
-        elsif valid.any?
-          answer = nil unless valid.map { |valid| answer.match(valid) }.any?
-        end
-      end
-
-      answer
-    end
-
-    # Public: Wrap Console#prompt but accept only a Y/N response.
-    #
-    # question - String containing the question to present to the user.
-    # args     - Hash containing arguments to control acceptable responses.
-    #            (default: {}):
-    #            :default_answer - String containing the default answer.
-    #
-    # Returns true or false corresponding to Y or N answer respectively.
-    def prompt_yn(question, args = {})
-      args[:valid_answers] = [/^[yn]/i]
-      /^n/i.match(prompt(question, args)).nil?
-    end
+  VERSION = '0.3.0'
 
-    # Public: Wrap Console#prompt, disabling local echo of user input.
-    #
-    # question - Query to be presented to the user.
-    # options  - Hash containing arguments defining acceptable responses.
-    #            (default: {}):
-    #            :default_answer - String containing the default answer.  If
-    #                              this is nil, a non-empty answer MUST be
-    #                              given.
-    #            :allow_empty    - Whether or not to allow empty responses.
-    #                              Unless explicitly allowed, empty answers
-    #                              will be rejected.
-    #            :valid_answers  - An Array containing all valid responses.  If
-    #                              this is empty, any answer will be accepted
-    #                              (unless empty answers are disallowed as
-    #                              specified above).  Valid responses may be
-    #                              any class with a match method such as
-    #                              Strings or Regexps.
-    #
-    # Returns a String containing the answer provided by the user.
-    def secure_prompt(question, args = {})
-      IO.console.echo = false
-      prompt(question, args)
-    ensure
-      IO.console.echo = true
-      puts
-    end
+  extend self
 
-    # Public: Wrap Console#prompt, specifically targeting filesystem paths.
+    # Public: Return an appropriate escape sequence depending upon the current
+    # platform.
     #
-    # question - Query to be presented to the user.
-    # options  - Hash containing arguments defining acceptable responses.
-    #            (default: {}):
-    #            :default_answer - String containing the default answer.  If
-    #                              this is nil, a non-empty answer MUST be
-    #                              given.
-    #            :allow_empty    - Whether or not to allow empty responses.
-    #                              Unless explicitly allowed, empty answers
-    #                              will be rejected.
-    #            :valid_answers  - An Array containing all valid responses.  If
-    #                              this is empty, any answer will be accepted
-    #                              (unless empty answers are disallowed as
-    #                              specified above).  Valid responses may be
-    #                              any class with a match method such as
-    #                              Strings or Regexps.
+    # sequence - String containing control code(s) to be escaped.
     #
-    # Returns a String containing the answer provided by the user.
-    def prompt_filesystem(question, args = {})
-      fs_lambda = lambda { |d| Dir[d + '*'].grep(/^#{Regexp.escape(d)}/) }
-      old_append = Readline.completion_append_character
-
-      Readline.completion_append_character = ''
-      response = prompt(question, args, [], fs_lambda)
-      Readline.completion_append_character = old_append
-
-      response
-    end
-
-    # Public: Render a "spinner" on the command line and yield to a block,
-    # reporting success if nothing is raised, or else reporting failure.
+    # Examples
     #
-    # message - Message to be displayed describing the task being evaluated.
-    # block   - Block to be yielded to determine pass or fail.
-    #
-    # Returns the result of the yielded block if successful.
-    # Raises whatever is raised inside the yielded block.
-    def spinner(message, &block)
-      success = nil
-      result = nil
-
-      pre = "\r#{bold}#{white} [#{reset}"
-      post = "#{bold}#{white}] #{reset}#{message}"
-      pre_ok = "\r#{bold}#{white} [#{green} ok "
-      pre_fail = "\r#{bold}#{white} [#{red}fail"
-
-      thread = Thread.new do
-        step = 0
-        spin = ["    ", ".   ", "..  ", "... ", "....", " ...", "  ..", "   ."]
-        while success.nil?
-          print "#{pre}#{spin[step % 8]}#{post}"
-          step += 1
-          sleep 0.5
-        end
-
-        if success
-          print "#{pre_ok}#{post}\n"
-        else
-          print "#{pre_fail}#{post}\n"
-        end
-      end
-
-      begin
-        result = yield
-        success = true
-        thread.join
-        return result
-      rescue
-        success = false
-        thread.join
-        raise
-      end
-    end
-
-    # Public: Generate a formatted, printable table.
-    #
-    # rows   - An Array containing Hashes which contain desired options to
-    #          display. (e.g. [{"col1" => "a", "col2" => "b"}])
-    # labels - Hash containing key-value pairs to label each key in options.
-    #          (default: nil)
-    #
-    # Returns a String containing the grid.
-    # Raises ArgumentError if anything but an Array is passed as rows.
-    def build_grid(rows, labels = nil)
-      if labels.nil?
-        labels = rows[0].keys.reduce({}) { |c,e| c.merge({e => e}) }
-      end
-
-      keys = labels.keys
-
-      max_width = labels.reduce({}) do |c,e|
-        c.merge({e[0]=> ([labels] + rows).map { |r| r[e[0]].length }.max})
-      end
-
-      grid_rule = max_width.reduce('+') do |c,e|
-        c + ('-' * (e[1] + 2)) + '+'
-      end
-      grid_rule << "\n"
-
-      grid = grid_rule.dup
-      grid << keys.reduce('|') do |c,e|
-        c + " #{bold}% #{max_width[e]}s#{reset} |" % labels[e]
-      end
-      grid << "\n"
-
-      grid << rows.reduce(grid_rule) do |c,e|
-        content = keys.reduce('') do |s,k|
-          s + " % #{max_width[k]}s |" % e[k]
-        end
-        c + "|#{content}\n"
-      end
-      grid << grid_rule
-    end
-
-    private
-
-    # Internal: Promp user for input via Readline, handling automatic setting
-    # and restoring of Readline's autocompletion proc, avoiding trampling over
-    # other uses.
-    #
-    # question - String containing a question to be displayed to the user.
-    # wordlist - Array containing Strings which are considered valid answers
-    #            for autocompletion.
-    # block    - Lambda which will override the default autocompletion lambda
-    #            as defined in autocomplete_lambda if present.  (default: nil)
+    #   ConsoleGlitter.escape 'A'
+    #   # => "\033[A"
     #
     # Returns a String.
-    def user_prompt(question, wordlist, block = nil)
-      block = autocomplete_lambda(wordlist) if block.nil?
-      old_completion_proc = Readline.completion_proc
-
-      Readline.completion_proc = block
-      response = Readline.readline(question)
-      Readline.completion_proc = old_completion_proc
-
-      response.to_s
-    end
-
-    # Internal: Generate a lambda which retuns an array of autocompletion
-    # candidates.
-    #
-    # wordlist - Array containing Strings which are considered valid answers
-    #            for autocompletion.
-    #
-    # Returns a lambda which returns an Array.
-    def autocomplete_lambda(wordlist)
-      lambda { |s| wordlist.grep(/^#{Regexp.escape(s)}/) }
-    end
-
-    # Internal: Generate Regexps for any String in an array to be used in order
-    # to match against user input.  Strings are expected to indicate exact
-    # matches desired.
-    #
-    # valid_answers - Array containing Objects against which user input may be
-    #                 matched.
-    #
-    # Returns an Array of Regexps.
-    def regexify_answers(valid_answers)
-      valid_answers.to_a.map do |answer|
-        if answer.is_a?(String)
-          Regexp.new("^#{Regexp.escape(answer)}$")
-        else
-          answer
-        end
-      end
+    def escape(sequence)
+      RUBY_PLATFORM =~ /(^win)|mingw/i ? '' : "\033[#{sequence}" 
     end
-  end
 end

data/lib/console-glitter/ansi.rb

@@ -1,21 +1,7 @@
+require 'console-glitter'
+
 module ConsoleGlitter
   module ANSI extend self
-    # Public: Return an appropriate escape sequence depending upon the current
-    # platform.
-    #
-    # sequence - Control code(s) to be escaped.  Multiple codes may be chained,
-    #            separated by ';'.
-    #
-    # Examples
-    #
-    #   ConsoleGlitter::ANSI.escape 0
-    #   # => "\033[0m"
-    #
-    # Returns a String.
-    def escape(sequence)
-      RUBY_PLATFORM =~ /win|mingw/i ? '' : "\033[#{sequence}m" 
-    end
-
     # Public: Generate an escape sequence to set the foreground color to an
     # approximation of a 4 or 8 bit per channel hex RGB color a la CSS.
     #
@@ -56,6 +42,24 @@ module ConsoleGlitter
 
     private
 
+    # Internal: Wrap ConsoleGlitter#escape, appending the character 'm' to the
+    # control code (per SGR spec).
+    #
+    # sequence - String containing the control code(s) to be escaped.  Multiple
+    #            codes may be chained, separated by a ';'.
+    #
+    # Examples
+    #
+    #   escape('0')
+    #   # => "\033[0m"
+    #   escape('1;31')
+    #   # => "\033[1;31m"
+    #
+    # Returns a String.
+    def escape(sequence)
+      ConsoleGlitter.escape(sequence.to_s + 'm')
+    end
+
     # Internal: Allow on-the-fly definition of ANSI control sequences.  Methods
     # are created for convenience which will either wrap the result of a block
     # in the tag specified and a reset tag, or else simply return the code in

data/lib/console-glitter/cursor.rb

@@ -0,0 +1,112 @@
+require 'console-glitter'
+
+module ConsoleGlitter
+  module Cursor extend self
+    # Public: Move the cursor up for a given distance.
+    #
+    # distance  - Distance to move the cursor.
+    #
+    # Returns a String containing the VT control code.
+    def up(distance = 1)
+      ConsoleGlitter.escape("#{distance}A")
+    end
+
+    # Public: Move the cursor down for a given distance.
+    #
+    # distance  - Distance to move the cursor.
+    #
+    # Returns a String containing the VT control code.
+    def down(distance = 1)
+      ConsoleGlitter.escape("#{distance}B")
+    end
+
+    # Public: Move the cursor forward for a given distance.
+    #
+    # distance  - Distance to move the cursor.
+    #
+    # Returns a String containing the VT control code.
+    def forward(distance = 1)
+      ConsoleGlitter.escape("#{distance}C")
+    end
+    alias :right :forward
+
+    # Public: Move the cursor back for a given distance.
+    #
+    # distance  - Distance to move the cursor.
+    #
+    # Returns a String containing the VT control code.
+    def back(distance = 1)
+      ConsoleGlitter.escape("#{distance}D")
+    end
+    alias :left :back
+
+    # Public: Move the cursor to the next line, returning the cursor to the
+    # beginning of the line.
+    #
+    # Returns a String containing the VT control code.
+    def nextline(distance = 1)
+      ConsoleGlitter.escape("#{distance}E")
+    end
+
+    # Public: Move the cursor to the previous line, returning the cursor to the
+    # beginning of the line.
+    #
+    # Returns a String containing the VT control code.
+    def prevline(distance = 1)
+      ConsoleGlitter.escape("#{distance}F")
+    end
+    alias :previousline :prevline
+
+    # Public: Move the absolute horizontal position specified.
+    #
+    # position - Number of the column to which the cursor should be moved.
+    #
+    # Returns a String containing the VT control code.
+    def column(position)
+      ConsoleGlitter.escape("#{position}G")
+    end
+
+    # Public: Move the cursor to the position specified.  The top left position
+    # is 1,1.
+    #
+    # x - Column (x-position) to which the cursor should be moved.
+    # x - Row (y-position) to which the cursor should be moved.
+    #
+    # Returns a String containing the VT control code.
+    def move(x, y)
+      ConsoleGlitter.escape("#{y};#{x}H")
+    end
+
+    # Public: Save the cursor's current position, replacing any previously
+    # saved position.
+    #
+    # Returns a String containing the VT control code.
+    def save
+      ConsoleGlitter.escape("s")
+    end
+
+    # Public: Move the cursor to a previously saved position.
+    #
+    # Note: If the cursor's position was never previously saved, it will
+    # default to 1,1.
+    #
+    # Returns a String containing the VT control code.
+    def restore
+      ConsoleGlitter.escape("u")
+    end
+
+    # Public: Hide the cursor.
+    #
+    # Returns a String containing the VT control code.
+    def hide
+      ConsoleGlitter.escape("?25l")
+    end
+
+    # Public: Show the cursor.
+    #
+    # Returns a String containing the VT control code.
+    def show
+      ConsoleGlitter.escape("?25h")
+    end
+  end
+end

data/lib/console-glitter/screen.rb

@@ -0,0 +1,106 @@
+require 'console-glitter'
+
+module ConsoleGlitter
+  module Screen extend self
+    # Public: From the cursor's position clear either the whole screen, or from
+    # the cursor's position to the beginning or end of the screen.
+    #
+    # direction - Symbol denoting the direction the screen should be cleared,
+    #             between :both :end or :beginning.  (default: :both)
+    #
+    # Returns a String containing the VT control code.
+    def clear(direction = :both)
+      options = [:both, :beginning, :end]
+      target  = "clear_to_#{direction}"
+      return(self.send(target)) if options.grep(direction).any?
+
+      raise(ArgumentError,
+            "Expected :both, :end, or :beginning, got #{direction}.")
+    end
+    alias :clear_to :clear
+
+    # Public: Return the VT control code to clear from the cursor to the end of
+    # the screen.
+    #
+    # Returns a String containing the VT control code.
+    def clear_to_end
+      ConsoleGlitter.escape('0J')
+    end
+
+    # Public: Return the VT control code to clear from the cursor to the
+    # beginning of the screen.
+    #
+    # Returns a String containing the VT control code.
+    def clear_to_beginning
+      ConsoleGlitter.escape('1J')
+    end
+
+    # Public: Return the VT control code to clear the screen.
+    #
+    # Returns a String containing the VT control code.
+    def clear_to_both
+      ConsoleGlitter.escape('2J')
+    end
+    alias :clear_screen :clear_to_both
+
+    # Public: From the cursor's position clear either the whole line, or from
+    # the cursor's position to the beginning or end of the line.
+    #
+    # direction - Symbol denoting the direction the line should be cleared,
+    #             between :both :end or :beginning.  (default: :both)
+    #
+    # Returns a String containing the VT control code.
+    def erase_line(direction = :both)
+      options = [:both, :beginning, :end]
+      target  = "erase_line_to_#{direction}"
+      return(self.send(target)) if options.grep(direction).any?
+
+      raise(ArgumentError,
+            "Expected :both, :end, or :beginning, got #{direction}.")
+    end
+    alias :erase_line_to :erase_line
+
+    # Public: Return the VT control code to clear from the cursor to the end of
+    # the line.
+    #
+    # Returns a String containing the VT control code.
+    def erase_line_to_end
+      ConsoleGlitter.escape('0K')
+    end
+
+    # Public: Return the VT control code to clear from the cursor to the
+    # beginning of the line.
+    #
+    # Returns a String containing the VT control code.
+    def erase_line_to_beginning
+      ConsoleGlitter.escape('1K')
+    end
+
+    # Public: Return the VT control code to clear the line where the cursor is.
+    #
+    # Returns a String containing the VT control code.
+    def erase_line_to_both
+      ConsoleGlitter.escape('2K')
+    end
+
+    # Public: Return the VT control code to scroll the screen up by a given
+    # amount.
+    #
+    # distance - Number of lines to scroll the screen.  (default: 1)
+    #
+    # Returns a String containing the VT control code.
+    def scroll_up(distance = 1)
+      ConsoleGlitter.escape("#{distance}S")
+    end
+
+    # Public: Return the VT control code to scroll the screen down by a given
+    # amount.
+    #
+    # distance - Number of lines to scroll the screen.  (default: 1)
+    #
+    # Returns a String containing the VT control code.
+    def scroll_down(distance = 1)
+      ConsoleGlitter.escape("#{distance}T")
+    end
+  end
+end

data/lib/console-glitter/ui.rb

@@ -0,0 +1,264 @@
+require 'console-glitter'
+require 'console-glitter/ansi'
+require 'readline'
+require 'io/console'
+
+module ConsoleGlitter
+  module UI extend self
+    extend ANSI
+    # Public: Prompt user for input, allowing for a default answer and a list
+    # of valid responses to be provided.
+    #
+    # question - Query to be presented to the user.
+    # options  - Hash containing arguments defining acceptable responses.
+    #            (default: {}):
+    #            :default_answer - String containing the default answer.  If
+    #                              this is nil, a non-empty answer MUST be
+    #                              given.
+    #            :allow_empty    - Whether or not to allow empty responses.
+    #                              Unless explicitly allowed, empty answers
+    #                              will be rejected.
+    #            :valid_answers  - An Array containing all valid responses.  If
+    #                              this is empty, any answer will be accepted
+    #                              (unless empty answers are disallowed as
+    #                              specified above).  Valid responses may be
+    #                              any class with a match method such as
+    #                              Strings or Regexps.
+    # wordlist - Array of words to be used for input auto-completion.
+    #            (default: [])
+    # block    - Lambda which will override the default autocompletion lambda
+    #            as defined in autocomplete_lambda if present.  (default: nil)
+    #
+    # Returns a String containing the answer provided by the user.
+    def prompt(question, options = {}, wordlist = [], block = nil)
+      default = options[:default_answer].to_s
+      allow_empty = options[:allow_empty]
+      valid = regexify_answers(options[:valid_answers])
+
+      default_display = " [#{default.strip}]" unless default.empty?
+      question = "#{question.strip}#{default_display}> "
+
+      answer = nil
+      while answer.nil?
+        answer = user_prompt(question, wordlist, block)
+        answer = default if answer.empty?
+
+        if answer.empty?
+          answer = nil unless allow_empty
+        elsif valid.any?
+          answer = nil unless valid.map { |valid| answer.match(valid) }.any?
+        end
+      end
+
+      answer
+    end
+
+    # Public: Wrap Console#prompt but accept only a Y/N response.
+    #
+    # question - String containing the question to present to the user.
+    # args     - Hash containing arguments to control acceptable responses.
+    #            (default: {}):
+    #            :default_answer - String containing the default answer.
+    #
+    # Returns true or false corresponding to Y or N answer respectively.
+    def prompt_yn(question, args = {})
+      args[:valid_answers] = [/^[yn]/i]
+      /^n/i.match(prompt(question, args)).nil?
+    end
+
+    # Public: Wrap Console#prompt, disabling local echo of user input.
+    #
+    # question - Query to be presented to the user.
+    # options  - Hash containing arguments defining acceptable responses.
+    #            (default: {}):
+    #            :default_answer - String containing the default answer.  If
+    #                              this is nil, a non-empty answer MUST be
+    #                              given.
+    #            :allow_empty    - Whether or not to allow empty responses.
+    #                              Unless explicitly allowed, empty answers
+    #                              will be rejected.
+    #            :valid_answers  - An Array containing all valid responses.  If
+    #                              this is empty, any answer will be accepted
+    #                              (unless empty answers are disallowed as
+    #                              specified above).  Valid responses may be
+    #                              any class with a match method such as
+    #                              Strings or Regexps.
+    #
+    # Returns a String containing the answer provided by the user.
+    def secure_prompt(question, args = {})
+      IO.console.echo = false
+      prompt(question, args)
+    ensure
+      IO.console.echo = true
+      puts
+    end
+
+    # Public: Wrap Console#prompt, specifically targeting filesystem paths.
+    #
+    # question - Query to be presented to the user.
+    # options  - Hash containing arguments defining acceptable responses.
+    #            (default: {}):
+    #            :default_answer - String containing the default answer.  If
+    #                              this is nil, a non-empty answer MUST be
+    #                              given.
+    #            :allow_empty    - Whether or not to allow empty responses.
+    #                              Unless explicitly allowed, empty answers
+    #                              will be rejected.
+    #            :valid_answers  - An Array containing all valid responses.  If
+    #                              this is empty, any answer will be accepted
+    #                              (unless empty answers are disallowed as
+    #                              specified above).  Valid responses may be
+    #                              any class with a match method such as
+    #                              Strings or Regexps.
+    #
+    # Returns a String containing the answer provided by the user.
+    def prompt_filesystem(question, args = {})
+      fs_lambda = lambda { |d| Dir[d + '*'].grep(/^#{Regexp.escape(d)}/) }
+      old_append = Readline.completion_append_character
+
+      Readline.completion_append_character = ''
+      response = prompt(question, args, [], fs_lambda)
+      Readline.completion_append_character = old_append
+
+      response
+    end
+
+    # Public: Render a "spinner" on the command line and yield to a block,
+    # reporting success if nothing is raised, or else reporting failure.
+    #
+    # message - Message to be displayed describing the task being evaluated.
+    # block   - Block to be yielded to determine pass or fail.
+    #
+    # Returns the result of the yielded block if successful.
+    # Raises whatever is raised inside the yielded block.
+    def spinner(message, &block)
+      success = nil
+      result = nil
+
+      pre = "\r#{bold}#{white} [#{reset}"
+      post = "#{bold}#{white}] #{reset}#{message}"
+      pre_ok = "\r#{bold}#{white} [#{green} ok "
+      pre_fail = "\r#{bold}#{white} [#{red}fail"
+
+      thread = Thread.new do
+        step = 0
+        spin = ["    ", ".   ", "..  ", "... ", "....", " ...", "  ..", "   ."]
+        while success.nil?
+          print "#{pre}#{spin[step % 8]}#{post}"
+          step += 1
+          sleep 0.5
+        end
+
+        if success
+          print "#{pre_ok}#{post}\n"
+        else
+          print "#{pre_fail}#{post}\n"
+        end
+      end
+
+      begin
+        result = yield
+        success = true
+        thread.join
+        return result
+      rescue
+        success = false
+        thread.join
+        raise
+      end
+    end
+
+    # Public: Generate a formatted, printable table.
+    #
+    # rows   - An Array containing Hashes which contain desired options to
+    #          display. (e.g. [{"col1" => "a", "col2" => "b"}])
+    # labels - Hash containing key-value pairs to label each key in options.
+    #          (default: nil)
+    #
+    # Returns a String containing the grid.
+    # Raises ArgumentError if anything but an Array is passed as rows.
+    def build_grid(rows, labels = nil)
+      if labels.nil?
+        labels = rows[0].keys.reduce({}) { |c,e| c.merge({e => e}) }
+      end
+
+      keys = labels.keys
+
+      max_width = labels.reduce({}) do |c,e|
+        c.merge({e[0]=> ([labels] + rows).map { |r| r[e[0]].length }.max})
+      end
+
+      grid_rule = max_width.reduce('+') do |c,e|
+        c + ('-' * (e[1] + 2)) + '+'
+      end
+      grid_rule << "\n"
+
+      grid = grid_rule.dup
+      grid << keys.reduce('|') do |c,e|
+        c + " #{bold}% #{max_width[e]}s#{reset} |" % labels[e]
+      end
+      grid << "\n"
+
+      grid << rows.reduce(grid_rule) do |c,e|
+        content = keys.reduce('') do |s,k|
+          s + " % #{max_width[k]}s |" % e[k]
+        end
+        c + "|#{content}\n"
+      end
+      grid << grid_rule
+    end
+
+    private
+
+    # Internal: Promp user for input via Readline, handling automatic setting
+    # and restoring of Readline's autocompletion proc, avoiding trampling over
+    # other uses.
+    #
+    # question - String containing a question to be displayed to the user.
+    # wordlist - Array containing Strings which are considered valid answers
+    #            for autocompletion.
+    # block    - Lambda which will override the default autocompletion lambda
+    #            as defined in autocomplete_lambda if present.  (default: nil)
+    #
+    # Returns a String.
+    def user_prompt(question, wordlist, block = nil)
+      block = autocomplete_lambda(wordlist) if block.nil?
+      old_completion_proc = Readline.completion_proc
+
+      Readline.completion_proc = block
+      response = Readline.readline(question)
+      Readline.completion_proc = old_completion_proc
+
+      response.to_s
+    end
+
+    # Internal: Generate a lambda which retuns an array of autocompletion
+    # candidates.
+    #
+    # wordlist - Array containing Strings which are considered valid answers
+    #            for autocompletion.
+    #
+    # Returns a lambda which returns an Array.
+    def autocomplete_lambda(wordlist)
+      lambda { |s| wordlist.grep(/^#{Regexp.escape(s)}/) }
+    end
+
+    # Internal: Generate Regexps for any String in an array to be used in order
+    # to match against user input.  Strings are expected to indicate exact
+    # matches desired.
+    #
+    # valid_answers - Array containing Objects against which user input may be
+    #                 matched.
+    #
+    # Returns an Array of Regexps.
+    def regexify_answers(valid_answers)
+      valid_answers.to_a.map do |answer|
+        if answer.is_a?(String)
+          Regexp.new("^#{Regexp.escape(answer)}$")
+        else
+          answer
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,24 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: console-glitter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
-- Chris Wuest
+- Tina Wuest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies: []
 description: Tools for building nice looking CLI applications
-email: chris@chriswuest.com
+email: tina@wuest.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/console-glitter.rb
 - lib/console-glitter/ansi.rb
-- lib/console-glitter/version.rb
+- lib/console-glitter/cursor.rb
+- lib/console-glitter/screen.rb
+- lib/console-glitter/ui.rb
 homepage: https://gitlab.com/wuest/console-glitter
 licenses:
 - MIT
@@ -39,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Tools for prettier CLI apps

data/lib/console-glitter/version.rb

@@ -1,3 +0,0 @@
-module ConsoleGlitter
-  VERSION = '0.2.1'
-end