highline 1.6.15 → 1.6.16

data/lib/highline/color_scheme.rb

@@ -13,17 +13,17 @@ class HighLine
   #
   #   colors("This is a warning", :warning)
   #
-  # A ColorScheme contains named sets of HighLine color constants. 
+  # A ColorScheme contains named sets of HighLine color constants.
   #
   # Example: Instantiating a color scheme, applying it to HighLine,
-  #          and using it:
+  # and using it:
   #
   #   ft = HighLine::ColorScheme.new do |cs|
   #          cs[:headline]        = [ :bold, :yellow, :on_black ]
   #          cs[:horizontal_line] = [ :bold, :white ]
   #          cs[:even_row]        = [ :green ]
   #          cs[:odd_row]         = [ :magenta ]
-  #        end 
+  #        end
   #
   #   HighLine.color_scheme = ft
   #   say("<%= color('Headline', :headline) %>")
@@ -34,15 +34,15 @@ class HighLine
   #        say("<%= color('#{row}', :even_row ) %>")
   #      else
   #        say("<%= color('#{row}', :odd_row) %>")
-  #      end 
+  #      end
   #      i = !i
   #   end
   #
   #
-  class ColorScheme 
+  class ColorScheme
     #
     # Create an instance of HighLine::ColorScheme. The customization can
-    # happen as a passed in Hash or via the yielded block.  Key's are
+    # happen as a passed in Hash or via the yielded block.  Keys are
     # converted to <tt>:symbols</tt> and values are converted to HighLine
     # constants.
     #
@@ -68,13 +68,13 @@ class HighLine
     def []( color_tag )
       @scheme[to_symbol(color_tag)]
     end
-    
+
     # Retrieve the original form of the scheme
     def definition( color_tag )
       style = @scheme[to_symbol(color_tag)]
       style && style.list
     end
-    
+
     # Retrieve the keys in the scheme
     def keys
       @scheme.keys
@@ -82,15 +82,15 @@ class HighLine
 
     # Allow the scheme to be set like a Hash.
     def []=( color_tag, constants )
-      @scheme[to_symbol(color_tag)] = HighLine::Style.new(:name=>color_tag.to_s.downcase.to_sym, 
+      @scheme[to_symbol(color_tag)] = HighLine::Style.new(:name=>color_tag.to_s.downcase.to_sym,
                                                           :list=>constants, :no_index=>true)
     end
-    
+
     # Retrieve the color scheme hash (in original definition format)
     def to_hash
       @scheme.inject({}) { |hsh, pair| key, value = pair; hsh[key] = value.list; hsh }
     end
-      
+
 
     private
 
@@ -112,11 +112,11 @@ class HighLine
 
   # A sample ColorScheme.
   class SampleColorScheme < ColorScheme
-    # 
+    #
     # Builds the sample scheme with settings for <tt>:critical</tt>,
     # <tt>:error</tt>, <tt>:warning</tt>, <tt>:notice</tt>, <tt>:info</tt>,
     # <tt>:debug</tt>, <tt>:row_even</tt>, and <tt>:row_odd</tt> colors.
-    # 
+    #
     def initialize( h = nil )
       scheme = {
         :critical => [ :yellow, :on_red  ],

data/lib/highline/import.rb

@@ -25,16 +25,16 @@ module Kernel
 end
 
 class Object
-  # 
+  #
   # Tries this object as a _first_answer_ for a HighLine::Question.  See that
   # attribute for details.
-  # 
+  #
   # *Warning*:  This Object will be passed to String() before set.
-  # 
+  #
   def or_ask( *args, &details )
     ask(*args) do |question|
       question.first_answer = String(self) unless nil?
-      
+
       details.call(question) unless details.nil?
     end
   end

data/lib/highline/menu.rb

@@ -8,11 +8,11 @@
 require "highline/question"
 
 class HighLine
-  # 
+  #
   # Menu objects encapsulate all the details of a call to HighLine.choose().
   # Using the accessors and Menu.choice() and Menu.choices(), the block passed
   # to HighLine.choose() can detail all aspects of menu display and control.
-  # 
+  #
   class Menu < Question
     #
     # Create an instance of HighLine::Menu.  All customization is done
@@ -20,14 +20,14 @@ class HighLine
     # choices() as needed to define the Menu.  Note that Menus are also
     # Questions, so all that functionality is available to the block as
     # well.
-    # 
+    #
     def initialize(  )
       #
       # Initialize Question objects with ignored values, we'll
       # adjust ours as needed.
-      # 
+      #
       super("Ignored", [ ], &nil)    # avoiding passing the block along
-      
+
       @items           = [ ]
       @hidden_items    = [ ]
       @help            = Hash.new("There's no help for that topic.")
@@ -42,12 +42,12 @@ class HighLine
       @layout          = :list
       @shell           = false
       @nil_on_handled  = false
-      
+
       # Override Questions responses, we'll set our own.
       @responses       = { }
       # Context for action code.
       @highline        = nil
-      
+
       yield self if block_given?
 
       init_help if @shell and not @help.empty?
@@ -56,52 +56,52 @@ class HighLine
     #
     # An _index_ to append to each menu item in display.  See
     # Menu.index=() for details.
-    # 
+    #
     attr_reader   :index
     #
     # The String placed between an _index_ and a menu item.  Defaults to
     # ". ".  Switches to " ", when _index_ is set to a String (like "-").
     #
     attr_accessor :index_suffix
-    # 
-    # The _select_by_ attribute controls how the user is allowed to pick a 
+    #
+    # The _select_by_ attribute controls how the user is allowed to pick a
     # menu item.  The available choices are:
-    # 
+    #
     # <tt>:index</tt>::          The user is allowed to type the numerical
-    #                            or alphetical index for their selection.
+    #                            or alphabetical index for their selection.
     # <tt>:index_or_name</tt>::  Allows both methods from the
     #                            <tt>:index</tt> option and the
     #                            <tt>:name</tt> option.
     # <tt>:name</tt>::           Menu items are selected by typing a portion
     #                            of the item name that will be
     #                            auto-completed.
-    # 
+    #
     attr_accessor :select_by
-    # 
+    #
     # This attribute is passed directly on as the mode to HighLine.list() by
     # all the preset layouts.  See that method for appropriate settings.
-    # 
+    #
     attr_accessor :flow
     #
     # This setting is passed on as the third parameter to HighLine.list()
     # by all the preset layouts.  See that method for details of its
     # effects.  Defaults to +nil+.
-    # 
+    #
     attr_accessor :list_option
     #
     # Used by all the preset layouts to display title and/or introductory
     # information, when set.  Defaults to +nil+.
-    # 
+    #
     attr_accessor :header
     #
     # Used by all the preset layouts to ask the actual question to fetch a
     # menu selection from the user.  Defaults to "?  ".
-    # 
+    #
     attr_accessor :prompt
     #
     # An ERb _layout_ to use when displaying this Menu object.  See
     # Menu.layout=() for details.
-    # 
+    #
     attr_reader   :layout
     #
     # When set to +true+, responses are allowed to be an entire line of
@@ -109,21 +109,21 @@ class HighLine
     # "word" of input will be matched against the menu choices, but both the
     # command selected and the rest of the line will be passed to provided
     # action blocks.  Defaults to +false+.
-    # 
+    #
     attr_accessor :shell
     #
-    # When +true+, any selected item handled by provided action code, will
+    # When +true+, any selected item handled by provided action code will
     # return +nil+, instead of the results to the action code.  This may
     # prove handy when dealing with mixed menus where only the names of
     # items without any code (and +nil+, of course) will be returned.
     # Defaults to +false+.
-    # 
+    #
     attr_accessor :nil_on_handled
-    
+
     #
     # Adds _name_ to the list of available menu items.  Menu items will be
     # displayed in the order they are added.
-    # 
+    #
     # An optional _action_ can be associated with this name and if provided,
     # it will be called if the item is selected.  The result of the method
     # will be returned, unless _nil_on_handled_ is set (when you would get
@@ -132,20 +132,20 @@ class HighLine
     # just the command is passed.  The <tt>@highline</tt> variable is set to
     # the current HighLine context before the action code is called and can
     # thus be used for adding output and the like.
-    # 
+    #
     def choice( name, help = nil, &action )
       @items << [name, action]
-      
+
       @help[name.to_s.downcase] = help unless help.nil?
       update_responses  # rebuild responses based on our settings
     end
-    
+
     #
     # A shortcut for multiple calls to the sister method choice().  <b>Be
     # warned:</b>  An _action_ set here will apply to *all* provided
     # _names_.  This is considered to be a feature, so you can easily
     # hand-off interface processing to a different chunk of code.
-    # 
+    #
     def choices( *names, &action )
       names.each { |n| choice(n, &action) }
     end
@@ -153,42 +153,42 @@ class HighLine
     # Identical to choice(), but the item will not be listed for the user.
     def hidden( name, help = nil, &action )
       @hidden_items << [name, action]
-      
+
       @help[name.to_s.downcase] = help unless help.nil?
     end
-    
-    # 
+
+    #
     # Sets the indexing style for this Menu object.  Indexes are appended to
     # menu items, when displayed in list form.  The available settings are:
-    # 
+    #
     # <tt>:number</tt>::   Menu items will be indexed numerically, starting
     #                      with 1.  This is the default method of indexing.
     # <tt>:letter</tt>::   Items will be indexed alphabetically, starting
     #                      with a.
     # <tt>:none</tt>::     No index will be appended to menu items.
     # <i>any String</i>::  Will be used as the literal _index_.
-    # 
-    # Setting the _index_ to <tt>:none</tt> a literal String, also adjusts
-    # _index_suffix_ to a single space and _select_by_ to <tt>:none</tt>. 
+    #
+    # Setting the _index_ to <tt>:none</tt> or a literal String also adjusts
+    # _index_suffix_ to a single space and _select_by_ to <tt>:name</tt>.
     # Because of this, you should make a habit of setting the _index_ first.
-    # 
+    #
     def index=( style )
       @index = style
-      
+
       # Default settings.
       if @index == :none or @index.is_a?(::String)
         @index_suffix = " "
         @select_by    = :name
       end
     end
-    
-    # 
+
+    #
     # Initializes the help system by adding a <tt>:help</tt> choice, some
     # action code, and the default help listing.
-    # 
+    #
     def init_help(  )
       return if @items.include?(:help)
-      
+
       topics    = @help.keys.sort
       help_help = @help.include?("help") ? @help["help"] :
                   "This command will display helpful messages about " +
@@ -206,21 +206,21 @@ class HighLine
         end
       end
     end
-    
+
     #
     # Used to set help for arbitrary topics.  Use the topic <tt>"help"</tt>
     # to override the default message.
-    # 
+    #
     def help( topic, help )
       @help[topic] = help
     end
-    
-    # 
+
+    #
     # Setting a _layout_ with this method also adjusts some other attributes
     # of the Menu object, to ideal defaults for the chosen _layout_.  To
     # account for that, you probably want to set a _layout_ first in your
     # configuration block, if needed.
-    # 
+    #
     # Accepted settings for _layout_ are:
     #
     # <tt>:list</tt>::         The default _layout_.  The _header_ if set
@@ -228,26 +228,26 @@ class HighLine
     #                          a trailing colon.  Then the list of menu
     #                          items will follow.  Finally, the _prompt_
     #                          will be used as the ask()-like question.
-    # <tt>:one_line</tt>::     A shorter _layout_ that fits on one line.  
+    # <tt>:one_line</tt>::     A shorter _layout_ that fits on one line.
     #                          The _header_ comes first followed by a
     #                          colon and spaces, then the _prompt_ with menu
     #                          items between trailing parenthesis.
     # <tt>:menu_only</tt>::    Just the menu items, followed up by a likely
     #                          short _prompt_.
     # <i>any ERb String</i>::  Will be taken as the literal _layout_.  This
-    #                          String can access <tt>@header</tt>, 
+    #                          String can access <tt>@header</tt>,
     #                          <tt>@menu</tt> and <tt>@prompt</tt>, but is
     #                          otherwise evaluated in the typical HighLine
     #                          context, to provide access to utilities like
     #                          HighLine.list() primarily.
-    # 
+    #
     # If set to either <tt>:one_line</tt>, or <tt>:menu_only</tt>, _index_
     # will default to <tt>:none</tt> and _flow_ will default to
     # <tt>:inline</tt>.
-    # 
+    #
     def layout=( new_layout )
       @layout = new_layout
-      
+
       # Default settings.
       case @layout
       when :one_line, :menu_only
@@ -259,11 +259,11 @@ class HighLine
     #
     # This method returns all possible options for auto-completion, based
     # on the settings of _index_ and _select_by_.
-    # 
+    #
     def options(  )
       # add in any hidden menu commands
       @items.concat(@hidden_items)
-      
+
       by_index = if @index == :letter
         l_index = "`"
         @items.map { "#{l_index.succ!}" }
@@ -287,13 +287,13 @@ class HighLine
 
     #
     # This method processes the auto-completed user selection, based on the
-    # rules for this Menu object.  If an action was provided for the 
+    # rules for this Menu object.  If an action was provided for the
     # selection, it will be executed as described in Menu.choice().
-    # 
+    #
     def select( highline_context, selection, details = nil )
       # add in any hidden menu commands
       @items.concat(@hidden_items)
-      
+
       # Find the selected action.
       name, action = if selection =~ /^\d+$/
         @items[selection.to_i - 1]
@@ -302,7 +302,7 @@ class HighLine
         index = @items.map { "#{l_index.succ!}" }.index(selection)
         @items.find { |c| c.first == selection } or @items[index]
       end
-      
+
       # Run or return it.
       if not action.nil?
         @highline = highline_context
@@ -321,12 +321,12 @@ class HighLine
       # make sure the hidden items are removed, before we return
       @items.slice!(@items.size - @hidden_items.size, @hidden_items.size)
     end
-    
+
     #
     # Allows Menu objects to pass as Arrays, for use with HighLine.list().
     # This method returns all menu items to be displayed, complete with
     # indexes.
-    # 
+    #
     def to_ary(  )
       case @index
       when :number
@@ -340,11 +340,11 @@ class HighLine
         @items.map { |c| "#{index}#{@index_suffix}#{c.first}" }
       end
     end
-    
+
     #
     # Allows Menu to behave as a String, just like Question.  Returns the
     # _layout_ to be rendered, which is used by HighLine.say().
-    # 
+    #
     def to_str(  )
       case @layout
       when :list
@@ -364,13 +364,13 @@ class HighLine
       else
         @layout
       end
-    end      
+    end
 
     #
     # This method will update the intelligent responses to account for
-    # Menu specific differences.  This overrides the work done by 
+    # Menu specific differences.  This overrides the work done by
     # Question.build_responses().
-    # 
+    #
     def update_responses(  )
       append_default unless default.nil?
       @responses = @responses.merge(