highline 1.6.15 → 1.6.16

data/lib/highline/question.rb

@@ -4,7 +4,7 @@
 #  Copyright 2005 Gray Productions. All rights reserved.
 #
 #  This is Free Software.  See LICENSE and COPYING for details.
- 
+
 require "optparse"
 require "date"
 require "pathname"
@@ -26,13 +26,14 @@ class HighLine
     # Create an instance of HighLine::Question.  Expects a _question_ to ask
     # (can be <tt>""</tt>) and an _answer_type_ to convert the answer to.
     # The _answer_type_ parameter must be a type recognized by
-    # Question.convert(). If given, a block is yeilded the new Question
-    # object to allow custom initializaion.
+    # Question.convert(). If given, a block is yielded the new Question
+    # object to allow custom initialization.
     #
     def initialize( question, answer_type )
       # initialize instance data
       @question    = question.dup
       @answer_type = answer_type
+      @completion = @answer_type
 
       @character    = nil
       @limit        = nil
@@ -65,31 +66,33 @@ class HighLine
     attr_accessor :question
     # The type that will be used to convert this answer.
     attr_accessor :answer_type
+    # For Auto-completion
+    attr_accessor :completion
     #
     # Can be set to +true+ to use HighLine's cross-platform character reader
     # instead of fetching an entire line of input.  (Note: HighLine's character
     # reader *ONLY* supports STDIN on Windows and Unix.)  Can also be set to
     # <tt>:getc</tt> to use that method on the input stream.
     #
-    # *WARNING*:  The _echo_ and _overwrite_ attributes for a question are 
-    # ignored when using the <tt>:getc</tt> method.  
-    # 
+    # *WARNING*:  The _echo_ and _overwrite_ attributes for a question are
+    # ignored when using the <tt>:getc</tt> method.
+    #
     attr_accessor :character
     #
     # Allows you to set a character limit for input.
-    # 
+    #
     # *WARNING*:  This option forces a character by character read.
-    # 
+    #
     attr_accessor :limit
     #
     # Can be set to +true+ or +false+ to control whether or not input will
     # be echoed back to the user.  A setting of +true+ will cause echo to
-    # match input, but any other true value will be treated as to String to
+    # match input, but any other true value will be treated as a String to
     # echo for each character typed.
-    # 
+    #
     # This requires HighLine's character reader.  See the _character_
     # attribute for details.
-    # 
+    #
     # *Note*:  When using HighLine to manage echo on Unix based systems, we
     # recommend installing the termios gem.  Without it, it's possible to type
     # fast enough to have letters still show up (when reading character by
@@ -98,13 +101,13 @@ class HighLine
     attr_accessor :echo
     #
     # Use the Readline library to fetch input.  This allows input editing as
-    # well as keeping a history.  In addition, tab will auto-complete 
+    # well as keeping a history.  In addition, tab will auto-complete
     # within an Array of choices or a file listing.
-    # 
-    # *WARNING*:  This option is incompatible with all of HighLine's 
+    #
+    # *WARNING*:  This option is incompatible with all of HighLine's
     # character reading  modes and it causes HighLine to ignore the
     # specified _input_ stream.
-    # 
+    #
     attr_accessor :readline
     #
     # Used to control whitespace processing for the answer to this question.
@@ -132,25 +135,25 @@ class HighLine
     # Asks a yes or no confirmation question, to ensure a user knows what
     # they have just agreed to.  If set to +true+ the question will be,
     # "Are you sure?  "  Any other true value for this attribute is assumed
-    # to be the question to ask.  When +false+ or +nil+ (the default), 
+    # to be the question to ask.  When +false+ or +nil+ (the default),
     # answers are not confirmed.
-    # 
+    #
     attr_accessor :confirm
     #
     # When set, the user will be prompted for multiple answers which will
     # be collected into an Array or Hash and returned as the final answer.
-    # 
+    #
     # You can set _gather_ to an Integer to have an Array of exactly that
     # many answers collected, or a String/Regexp to match an end input which
     # will not be returned in the Array.
-    # 
+    #
     # Optionally _gather_ can be set to a Hash.  In this case, the question
     # will be asked once for each key and the answers will be returned in a
-    # Hash, mapped by key.  The <tt>@key</tt> variable is set before each 
+    # Hash, mapped by key.  The <tt>@key</tt> variable is set before each
     # question is evaluated, so you can use it in your question.
-    # 
+    #
     attr_accessor :gather
-    # 
+    #
     # When set to +true+ multiple entries will be collected according to
     # the setting for _gather_, except they will be required to match
     # each other. Multiple identical entries will return a single answer.
@@ -159,20 +162,20 @@ class HighLine
     #
     # When set to a non *nil* value, this will be tried as an answer to the
     # question.  If this answer passes validations, it will become the result
-    # without the user ever being prompted.  Otherwise this value is discarded, 
+    # without the user ever being prompted.  Otherwise this value is discarded,
     # and this Question is resolved as a normal call to HighLine.ask().
-    # 
+    #
     attr_writer :first_answer
     #
     # The directory from which a user will be allowed to select files, when
     # File or Pathname is specified as an _answer_type_.  Initially set to
     # <tt>Pathname.new(File.expand_path(File.dirname($0)))</tt>.
-    # 
+    #
     attr_accessor :directory
-    # 
+    #
     # The glob pattern used to limit file selection when File or Pathname is
     # specified as an _answer_type_.  Initially set to <tt>"*"</tt>.
-    # 
+    #
     attr_accessor :glob
     #
     # A Hash that stores the various responses used by HighLine to notify
@@ -206,7 +209,7 @@ class HighLine
     # the screen.
     #
     attr_accessor :overwrite
-   
+
     #
     # Returns the provided _answer_string_ or the default answer for this
     # Question if a default was set and the answer is empty.
@@ -218,7 +221,7 @@ class HighLine
         answer_string
       end
     end
-    
+
     #
     # Called late in the initialization process to build intelligent
     # responses based on the details of this Question object.
@@ -250,21 +253,21 @@ class HighLine
       ### Menu.update_responses().  Check there too when ###
       ### making changes!                                ###
     end
-    
+
     #
     # Returns the provided _answer_string_ after changing character case by
     # the rules of this Question.  Valid settings for whitespace are:
     #
-    # +nil+::                        Do not alter character case. 
+    # +nil+::                        Do not alter character case.
     #                                (Default.)
     # <tt>:up</tt>::                 Calls upcase().
     # <tt>:upcase</tt>::             Calls upcase().
     # <tt>:down</tt>::               Calls downcase().
     # <tt>:downcase</tt>::           Calls downcase().
     # <tt>:capitalize</tt>::         Calls capitalize().
-    # 
+    #
     # An unrecognized choice (like <tt>:none</tt>) is treated as +nil+.
-    # 
+    #
     def change_case( answer_string )
       if [:up, :upcase].include?(@case)
         answer_string.upcase
@@ -281,13 +284,13 @@ class HighLine
     # Transforms the given _answer_string_ into the expected type for this
     # Question.  Currently supported conversions are:
     #
-    # <tt>[...]</tt>::         Answer must be a member of the passed Array. 
+    # <tt>[...]</tt>::         Answer must be a member of the passed Array.
     #                          Auto-completion is used to expand partial
     #                          answers.
     # <tt>lambda {...}</tt>::  Answer is passed to lambda for conversion.
     # Date::                   Date.parse() is called with answer.
     # DateTime::               DateTime.parse() is called with answer.
-    # File::                   The entered file name is auto-completed in 
+    # File::                   The entered file name is auto-completed in
     #                          terms of _directory_ + _glob_, opened, and
     #                          returned.
     # Float::                  Answer is converted with Kernel.Float().
@@ -305,7 +308,7 @@ class HighLine
     #
     # This method throws ArgumentError, if the conversion cannot be
     # completed for any reason.
-    # 
+    #
     def convert( answer_string )
       if @answer_type.nil?
         answer_string
@@ -361,15 +364,15 @@ class HighLine
     ensure
       @first_answer = nil
     end
-    
+
     # Returns true if _first_answer_ is set.
     def first_answer?( )
       not @first_answer.nil?
     end
-    
+
     #
     # Returns +true+ if the _answer_object_ is greater than the _above_
-    # attribute, less than the _below_ attribute and included?()ed in the
+    # attribute, less than the _below_ attribute and include?()ed in the
     # _in_ attribute.  Otherwise, +false+ is returned.  Any +nil+ attributes
     # are not checked.
     #
@@ -378,7 +381,7 @@ class HighLine
       (@below.nil? or answer_object < @below) and
       (@in.nil? or @in.include?(answer_object))
     end
-    
+
     #
     # Returns the provided _answer_string_ after processing whitespace by
     # the rules of this Question.  Valid settings for whitespace are:
@@ -386,18 +389,18 @@ class HighLine
     # +nil+::                        Do not alter whitespace.
     # <tt>:strip</tt>::              Calls strip().  (Default.)
     # <tt>:chomp</tt>::              Calls chomp().
-    # <tt>:collapse</tt>::           Collapses all whitspace runs to a
+    # <tt>:collapse</tt>::           Collapses all whitespace runs to a
     #                                single space.
     # <tt>:strip_and_collapse</tt>:: Calls strip(), then collapses all
-    #                                whitspace runs to a single space.
+    #                                whitespace runs to a single space.
     # <tt>:chomp_and_collapse</tt>:: Calls chomp(), then collapses all
-    #                                whitspace runs to a single space.
+    #                                whitespace runs to a single space.
     # <tt>:remove</tt>::             Removes all whitespace.
-    # 
+    #
     # An unrecognized choice (like <tt>:none</tt>) is treated as +nil+.
-    # 
-    # This process is skipped, for single character input.
-    # 
+    #
+    # This process is skipped for single character input.
+    #
     def remove_whitespace( answer_string )
       if @whitespace.nil?
         answer_string
@@ -419,39 +422,39 @@ class HighLine
     # Returns an Array of valid answers to this question.  These answers are
     # only known when _answer_type_ is set to an Array of choices, File, or
     # Pathname.  Any other time, this method will return an empty Array.
-    # 
+    #
     def selection(  )
-      if @answer_type.is_a?(Array)
-        @answer_type
-      elsif [File, Pathname].include?(@answer_type)
+      if @completion.is_a?(Array)
+        @completion
+      elsif [File, Pathname].include?(@completion)
         Dir[File.join(@directory.to_s, @glob)].map do |file|
           File.basename(file)
         end
       else
         [ ]
-      end      
+      end
     end
-    
+
     # Stringifies the question to be asked.
     def to_str(  )
       @question
     end
 
     #
-    # Returns +true+ if the provided _answer_string_ is accepted by the 
+    # Returns +true+ if the provided _answer_string_ is accepted by the
     # _validate_ attribute or +false+ if it's not.
-    # 
+    #
     # It's important to realize that an answer is validated after whitespace
     # and case handling.
     #
     def valid_answer?( answer_string )
-      @validate.nil? or 
+      @validate.nil? or
       (@validate.is_a?(Regexp) and answer_string =~ @validate) or
       (@validate.is_a?(Proc)   and @validate[answer_string])
     end
-    
+
     private
-    
+
     #
     # Adds the default choice to the end of question between <tt>|...|</tt>.
     # Trailing whitespace is preserved so the function of HighLine.say() is

data/lib/highline/simulate.rb

@@ -15,7 +15,7 @@ class HighLine
     def initialize(strings)
       @strings = strings
     end
-    
+
     # Simulate StringIO#gets by shifting a string off of the script
     def gets
       @strings.shift

data/lib/highline/string_extensions.rb

@@ -17,8 +17,8 @@
 #   highline_string.color(:bright_blue, :blink, :underline)
 #   HighLine.color(highline_string, :bright_blue, :blink, :underline)
 #
-# For those less squeamish about possible conflicts, the same convenience methods can be 
-# added to the builtin String class, as follows:
+# For those less squeamish about possible conflicts, the same convenience methods can be
+# added to the built-in String class, as follows:
 #
 #  require 'highline'
 #  Highline.colorize_strings
@@ -27,7 +27,7 @@ class HighLine
   def self.String(s)
     HighLine::String.new(s)
   end
-  
+
   module StringExtensions
     def self.included(base)
       HighLine::COLORS.each do |color|
@@ -61,7 +61,7 @@ class HighLine
           END
         end
       end
-      
+
       base.class_eval do
         if public_instance_methods.map { |m| m.to_s }.include? "color"
           undef :color
@@ -73,7 +73,7 @@ class HighLine
           self.class.new(HighLine.color(self, *args))
         end
         alias_method :foreground, :color
-        
+
         if public_instance_methods.map { |m| m.to_s }.include? "on"
           undef :on
         end
@@ -87,7 +87,7 @@ class HighLine
         def uncolor
           self.class.new(HighLine.uncolor(self))
         end
-        
+
         if public_instance_methods.map { |m| m.to_s }.include? "rgb"
           undef :rgb
         end
@@ -96,7 +96,7 @@ class HighLine
           raise "Bad RGB color #{colors.inspect}" unless color_code =~ /^[a-fA-F0-9]{6}/
           color("rgb_#{color_code}".to_sym)
         end
-        
+
         if public_instance_methods.map { |m| m.to_s }.include? "on_rgb"
           undef :on_rgb
         end
@@ -105,7 +105,7 @@ class HighLine
           raise "Bad RGB color #{colors.inspect}" unless color_code =~ /^[a-fA-F0-9]{6}/
           color("on_rgb_#{color_code}".to_sym)
         end
-        
+
         if public_instance_methods.map { |m| m.to_s }.include? "method_missing"
           undef :method_missing
         end
@@ -120,12 +120,12 @@ class HighLine
       end
     end
   end
-  
+
   class HighLine::String < ::String
     include StringExtensions
   end
-  
+
   def self.colorize_strings
     ::String.send(:include, StringExtensions)
   end
-end
+end

data/lib/highline/style.rb

@@ -6,7 +6,7 @@
 # This is Free Software.  See LICENSE and COPYING for details
 
 class HighLine
-  
+
   def self.Style(*args)
     args = args.compact.flatten
     if args.size==1
@@ -37,9 +37,9 @@ class HighLine
       Style.list[name] || Style.new(:list=>args)
     end
   end
-  
+
   class Style
-    
+
     def self.index(style)
       if style.name
         @@styles ||= {}
@@ -53,17 +53,17 @@ class HighLine
       end
       style
     end
-    
+
     def self.rgb_hex(*colors)
       colors.map do |color|
         color.is_a?(Numeric) ? '%02x'%color : color.to_s
       end.join
     end
-    
+
     def self.rgb_parts(hex)
       hex.scan(/../).map{|part| part.to_i(16)}
     end
-    
+
     def self.rgb(*colors)
       hex = rgb_hex(*colors)
       name = ('rgb_' + hex).to_sym
@@ -74,33 +74,33 @@ class HighLine
         new(:name=>name, :code=>"\e[38;5;#{rgb_number(parts)}m", :rgb=>parts)
       end
     end
-    
+
     def self.rgb_number(*parts)
       parts = parts.flatten
       16 + parts.inject(0) {|kode, part| kode*6 + (part/256.0*6.0).floor}
     end
-    
+
     def self.ansi_rgb_to_hex(ansi_number)
       raise "Invalid ANSI rgb code #{ansi_number}" unless (16..231).include?(ansi_number)
       parts = (ansi_number-16).to_s(6).rjust(3,'0').scan(/./).map{|d| (d.to_i*255.0/6.0).ceil}
       rgb_hex(*parts)
     end
-    
+
     def self.list
       @@styles ||= {}
     end
-    
+
     def self.code_index
       @@code_index ||= {}
     end
-    
+
     def self.uncolor(string)
       string.gsub(/\e\[\d+(;\d+)*m/, '')
     end
-    
+
     attr_reader :name, :list
     attr_accessor :rgb, :builtin
-    
+
     # Single color/styles have :name, :code, :rgb (possibly), :builtin
     # Compound styles have :name, :list, :builtin
     def initialize(defn = {})
@@ -118,19 +118,19 @@ class HighLine
       end
       self.class.index self unless defn[:no_index]
     end
-    
+
     def dup
       self.class.new(@definition)
     end
-    
+
     def to_hash
       @definition
     end
-    
+
     def color(string)
       code + string + HighLine::CLEAR
     end
-    
+
     def code
       if @list
         @list.map{|element| HighLine.Style(element).code}.join
@@ -138,7 +138,7 @@ class HighLine
         @code
       end
     end
-      
+
     def red
       @rgb && @rgb[0]
     end
@@ -150,7 +150,7 @@ class HighLine
     def blue
       @rgb && @rgb[2]
     end
-    
+
     def variant(new_name, options={})
       raise "Cannot create a variant of a style list (#{inspect})" if @list
       new_code = options[:code] || code
@@ -161,12 +161,12 @@ class HighLine
       new_rgb = options[:rgb] || @rgb
       self.class.new(self.to_hash.merge(:name=>new_name, :code=>new_code, :rgb=>new_rgb))
     end
-    
+
     def on
       new_name = ('on_'+@name.to_s).to_sym
       self.class.list[new_name] ||= variant(new_name, :increment=>10)
     end
-    
+
     def bright
       raise "Cannot create a bright variant of a style list (#{inspect})" if @list
       new_name = ('bright_'+@name.to_s).to_sym