highline 2.0.0.pre.develop.9 → 2.0.0.pre.develop.11

data/lib/highline/menu.rb

@@ -13,7 +13,8 @@ require "highline/menu/item"
 
 class HighLine
   #
-  # Menu objects encapsulate all the details of a call to {HighLine#choose HighLine#choose}.
+  # Menu objects encapsulate all the details of a call to
+  # {HighLine#choose 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.
   #
@@ -21,16 +22,16 @@ class HighLine
     # Pass +false+ to _color_ to turn off HighLine::Menu's
     # index coloring.
     # Pass a color and the Menu's indices will be colored.
-    def self.index_color=(color = :rgb_77bbff)
-      @index_color = color
+    class << self
+      attr_writer :index_color
     end
 
     # Initialize it
     self.index_color = false
 
     # Returns color used for coloring Menu's indices
-    def self.index_color
-      @index_color
+    class << self
+      attr_reader :index_color
     end
 
     #
@@ -53,10 +54,10 @@ class HighLine
       # Initialize Question objects with ignored values, we'll
       # adjust ours as needed.
       #
-      super("Ignored", [ ], &nil)    # avoiding passing the block along
+      super("Ignored", [], &nil) # avoiding passing the block along
 
-      @items           = [ ]
-      @hidden_items    = [ ]
+      @items           = []
+      @hidden_items    = []
       @help            = Hash.new("There's no help for that topic.")
 
       @index           = :number
@@ -75,13 +76,13 @@ class HighLine
       @index_color     = self.class.index_color
 
       # Override Questions responses, we'll set our own.
-      @responses       = { }
+      @responses       = {}
       # Context for action code.
       @highline        = nil
 
       yield self if block_given?
 
-      init_help if @shell and not @help.empty?
+      init_help if @shell && !@help.empty?
     end
 
     #
@@ -179,26 +180,27 @@ class HighLine
     #   cli.choose do |menu|
     #     menu.shell = true
     #
-    #     menu.choice(:load, text: 'Load a file', help: "Load a file using your favourite editor.")
+    #     menu.choice(:load, text: 'Load a file',
+    #                 help: "Load a file using your favourite editor.")
     #     menu.choice(:save, help: "Save data in file.")
     #     menu.choice(:quit, help: "Exit program.")
     #
     #     menu.help("rules", "The rules of this system are as follows...")
     #   end
 
-    def choice( name, help = nil, text = nil, &action )
+    def choice(name, help = nil, text = nil, &action)
       item = Menu::Item.new(name, text: text, help: help, action: action)
       @items << item
       @help.merge!(item.item_help)
-      update_responses  # rebuild responses based on our settings
+      update_responses # rebuild responses based on our settings
     end
 
     #
-    # This method helps reduce the namespaces in the original call, which would look
-    # like this: HighLine::Menu::Item.new(...)
+    # This method helps reduce the namespaces in the original call,
+    # which would look like this: HighLine::Menu::Item.new(...)
     # With #build_item, it looks like this: menu.build_item(...)
-    # @param *args splat args, the same args you would pass to an initialization of
-    #        HighLine::Menu::Item
+    # @param *args splat args, the same args you would pass to an
+    #   initialization of HighLine::Menu::Item
     # @return [HighLine::Menu::Item] the menu item
 
     def build_item(*args)
@@ -206,8 +208,8 @@ class HighLine
     end
 
     #
-    # Adds an item directly to the menu. If you want more configuraiton or options,
-    # use this method
+    # Adds an item directly to the menu. If you want more configuration
+    # or options, use this method
     #
     # @param item [Menu::Item] item containing choice fields and more
     # @return [void]
@@ -223,7 +225,8 @@ class HighLine
     # 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.
-    # @param names [Array<#to_s>] menu item titles/headers/names to be displayed.
+    # @param names [Array<#to_s>] menu item titles/headers/names to be
+    #   displayed.
     # @param action (see #choice)
     # @return [void]
     # @example (see HighLine::Menu#initialize)
@@ -231,7 +234,7 @@ class HighLine
     # choice has more options available to you, like longer text or help (and
     # of course, individual actions)
     #
-    def choices( *names, &action )
+    def choices(*names, &action)
       names.each { |n| choice(n, &action) }
     end
 
@@ -242,7 +245,7 @@ class HighLine
     # @param action (see #choice)
     # @return (see #choice)
 
-    def hidden( name, help = nil, &action )
+    def hidden(name, help = nil, &action)
       item = Menu::Item.new(name, text: name, help: help, action: action)
       @hidden_items << item
       @help.merge!(item.item_help)
@@ -263,31 +266,36 @@ class HighLine
     # _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 )
+    def index=(style)
       @index = style
 
+      return unless @index == :none || @index.is_a?(::String)
+
       # Default settings.
-      if @index == :none or @index.is_a?(::String)
-        @index_suffix = " "
-        @select_by    = :name
-      end
+      @index_suffix = " "
+      @select_by    = :name
     end
 
     #
     # Initializes the help system by adding a <tt>:help</tt> choice, some
     # action code, and the default help listing.
     #
-    def init_help(  )
+    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 " +
-                  "functionality, like this one.  To see the help for " +
-                  "a specific topic enter:\n\thelp [TOPIC]\nTry asking " +
-                  "for help on any of the following:\n\n" +
-                  "<%= list(#{topics.inspect}, :columns_across) %>"
-      choice(:help, help_help) do |command, topic|
+      help_help =
+        if @help.include?("help")
+          @help["help"]
+        else
+          "This command will display helpful messages about " \
+            "functionality, like this one.  To see the help for " \
+            "a specific topic enter:\n\thelp [TOPIC]\nTry asking " \
+            "for help on any of the following:\n\n" \
+            "<%= list(#{topics.inspect}, :columns_across) %>"
+        end
+
+      choice(:help, help_help) do |_command, topic|
         topic.strip!
         topic.downcase!
         if topic.empty?
@@ -302,11 +310,11 @@ class HighLine
     # Used to set help for arbitrary topics.  Use the topic <tt>"help"</tt>
     # to override the default message. Mainly for internal use.
     #
-    # @param topic [String] the menu item header/title/name to be associated with
-    #   a help message.
+    # @param topic [String] the menu item header/title/name to be associated
+    #   with a help message.
     # @param help [String] the help message to be associated with the menu
     #   item/title/name.
-    def help( topic, help )
+    def help(topic, help)
       @help[topic] = help
     end
 
@@ -339,14 +347,14 @@ class HighLine
     # will default to <tt>:none</tt> and _flow_ will default to
     # <tt>:inline</tt>.
     #
-    def layout=( new_layout )
+    def layout=(new_layout)
       @layout = new_layout
 
       # Default settings.
       case @layout
       when :one_line, :menu_only
         self.index = :none
-        @flow  = :inline
+        @flow = :inline
       end
     end
 
@@ -387,12 +395,14 @@ class HighLine
     # rules for this Menu object.  If an action was provided for the
     # selection, it will be executed as described in {#choice}.
     #
-    # @param highline_context [HighLine] a HighLine instance to be used as context.
-    # @param selection [String, Integer] index or title of the selected menu item.
+    # @param highline_context [HighLine] a HighLine instance to be used
+    #   as context.
+    # @param selection [String, Integer] index or title of the selected
+    #   menu item.
     # @param details additional parameter to be passed when in shell mode.
     # @return [nil, Object] if @nil_on_handled is set it returns +nil+,
     #   else it returns the action return value.
-    def select( highline_context, selection, details = nil )
+    def select(highline_context, selection, details = nil)
       # add in any hidden menu commands
       items = all_items
 
@@ -423,18 +433,20 @@ class HighLine
     def get_item_by_letter(items, selection)
       item = items.find { |i| i.name == selection }
       return item if item
-      l_index = "`" # character before the letter "a"
-      index = items.map { "#{l_index.succ!}" }.index(selection)
+
+      # 97 is the "a" letter at ascii table
+      # Ex: For "a" it will return 0, and for "c" it will return 2
+      index = selection.ord - 97
       items[index]
     end
 
     def value_for_selected_item(item, details)
       if item.action
-        if @shell
-          result = item.action.call(item.name, details)
-        else
-          result = item.action.call(item.name)
-        end
+        result = if @shell
+                   item.action.call(item.name, details)
+                 else
+                   item.action.call(item.name)
+                 end
         @nil_on_handled ? nil : result
       else
         item.name
@@ -451,7 +463,7 @@ class HighLine
       elsif selections.is_a?(Hash)
         value_for_hash_selections(items, selections, details)
       else
-        fail ArgumentError, 'selections must be either Array or Hash'
+        raise ArgumentError, "selections must be either Array or Hash"
       end
     end
 
@@ -512,23 +524,23 @@ class HighLine
     # Allows Menu to behave as a String, just like Question.  Returns the
     # _layout_ to be rendered, which is used by HighLine.say().
     #
-    def to_s(  )
+    def to_s
       case @layout
       when :list
         %(<%= header ? "#{header}:\n" : '' %>) +
-        parse_list +
-        show_default_if_any + 
-        "<%= prompt %>"
+          parse_list +
+          show_default_if_any +
+          "<%= prompt %>"
       when :one_line
         %(<%= header ? "#{header}:  " : '' %>) +
-        "<%= prompt %>" +
-        "(" + parse_list + ")" +
-        show_default_if_any +
-        "<%= prompt[/\s*$/] %>"
+          "<%= prompt %>" \
+          "(" + parse_list + ")" +
+          show_default_if_any +
+          "<%= prompt[/\s*$/] %>"
       when :menu_only
         parse_list +
-        show_default_if_any +
-        "<%= prompt %>"
+          show_default_if_any +
+          "<%= prompt %>"
       else
         @layout
       end
@@ -536,11 +548,11 @@ class HighLine
 
     def parse_list
       "<%= list( menu, #{@flow.inspect},
-           #{@list_option.inspect} ) %>" 
+           #{@list_option.inspect} ) %>"
     end
 
     def show_default_if_any
-      return default.to_s.empty? ? "" : "(#{default}) "
+      default.to_s.empty? ? "" : "(#{default}) "
     end
 
     #

data/lib/highline/menu/item.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 class HighLine
   class Menu < Question
     # Represents an Item of a HighLine::Menu.

data/lib/highline/paginator.rb

@@ -3,7 +3,6 @@
 class HighLine
   # Take the task of paginating some piece of text given a HighLine context
   class Paginator
-
     # @return [HighLine] HighLine context
     attr_reader :highline
 
@@ -36,18 +35,18 @@ class HighLine
         # Return last line if user wants to abort paging
         return "...\n#{lines.last}" unless continue_paging?
       end
-      return lines.join
+      lines.join
     end
 
     #
-    # Ask user if they wish to continue paging output. Allows them to type "q" to
-    # cancel the paging process.
+    # Ask user if they wish to continue paging output. Allows them to
+    # type "q" to cancel the paging process.
     #
     def continue_paging?
       command = highline.new_scope.ask(
         "-- press enter/return to continue or q to stop -- "
       ) { |q| q.character = true }
-      command !~ /\A[qQ]\Z/  # Only continue paging if Q was not hit.
+      command !~ /\A[qQ]\Z/ # Only continue paging if Q was not hit.
     end
   end
-end
+end

data/lib/highline/question.rb

@@ -8,6 +8,7 @@
 #
 #  This is Free Software.  See LICENSE and COPYING for details.
 
+require "English"
 require "optparse"
 require "date"
 require "pathname"
@@ -59,11 +60,11 @@ class HighLine
       @case         = nil
       @in           = nil
       @first_answer = nil
-      @directory    = Pathname.new(File.expand_path(File.dirname($0)))
       @glob         = "*"
-      @user_responses = Hash.new
-      @internal_responses = default_responses_hash
       @overwrite    = false
+      @user_responses = {}
+      @internal_responses = default_responses_hash
+      @directory = Pathname.new(File.expand_path(File.dirname($PROGRAM_NAME)))
 
       # allow block to override settings
       yield self if block_given?
@@ -148,11 +149,11 @@ class HighLine
     #
     # Asks a yes or no confirmation question, to ensure a user knows what
     # they have just agreed to.  The confirm attribute can be set to :
-    # +true+  :     In this case the question will be, "Are you sure?". 
-    # Proc    :     The Proc is yielded the answer given. The Proc must 
-    #               output a string which is then used as the confirm 
-    #               question. 
-    # String  :     The String must use ERB syntax. The String is 
+    # +true+  :     In this case the question will be, "Are you sure?".
+    # Proc    :     The Proc is yielded the answer given. The Proc must
+    #               output a string which is then used as the confirm
+    #               question.
+    # String  :     The String must use ERB syntax. The String is
     #               evaluated with access to question and answer and
     #               is then used as the confirm question.
     # When set to +false+ or +nil+ (the default), answers are not confirmed.
@@ -261,8 +262,8 @@ class HighLine
 
     def default_responses_hash
       {
-        :ask_on_error         => "?  ",
-        :mismatch             => "Your entries didn't match."
+        ask_on_error: "?  ",
+        mismatch: "Your entries didn't match."
       }
     end
 
@@ -270,15 +271,15 @@ class HighLine
     # @param message_source (see #build_responses)
     # @return [Hash] responses hash
     def build_responses_new_hash(message_source)
-      { :ambiguous_completion => "Ambiguous choice.  Please choose one of " +
-                                  choice_error_str(message_source) + '.',
-        :invalid_type         => "You must enter a valid #{message_source}.",
-        :no_completion        => "You must choose one of " +
-                                  choice_error_str(message_source) + '.',
-        :not_in_range         => "Your answer isn't within the expected range " +
-                                 "(#{expected_range}).",
-        :not_valid            => "Your answer isn't valid (must match " +
-                                 "#{validate.inspect})." }
+      { ambiguous_completion: "Ambiguous choice.  Please choose one of " +
+        choice_error_str(message_source) + ".",
+        invalid_type: "You must enter a valid #{message_source}.",
+        no_completion: "You must choose one of " +
+          choice_error_str(message_source) + ".",
+        not_in_range: "Your answer isn't within the expected range " \
+          "(#{expected_range}).",
+        not_valid: "Your answer isn't valid (must match " \
+          "#{validate.inspect})." }
     end
 
     # This is the actual responses hash that gets used in determining output
@@ -369,7 +370,7 @@ class HighLine
 
     # Returns an English explanation of the current range settings.
     def expected_range
-      expected = [ ]
+      expected = []
 
       expected << "above #{above}" if above
       expected << "below #{below}" if below
@@ -392,7 +393,7 @@ class HighLine
 
     # Returns true if _first_answer_ is set.
     def first_answer?
-      !!@first_answer
+      true if @first_answer
     end
 
     #
@@ -402,9 +403,9 @@ class HighLine
     # are not checked.
     #
     def in_range?
-      (!above or answer > above) and
-      (!below or answer < below) and
-      (!@in or @in.include?(answer))
+      (!above || answer > above) &&
+        (!below || answer < below) &&
+        (!@in || @in.include?(answer))
     end
 
     #
@@ -468,7 +469,7 @@ class HighLine
           File.basename(file)
         end
       else
-        [ ]
+        []
       end
     end
 
@@ -485,9 +486,9 @@ class HighLine
     # and case handling.
     #
     def valid_answer?
-      !validate or
-      (validate.is_a?(Regexp) and answer =~ validate) or
-      (validate.is_a?(Proc)   and validate[answer])
+      !validate ||
+        (validate.is_a?(Regexp) && answer =~ validate) ||
+        (validate.is_a?(Proc)   && validate[answer])
     end
 
     #
@@ -534,11 +535,11 @@ class HighLine
       if confirm == true
         "Are you sure?  "
       elsif confirm.is_a?(Proc)
-        confirm.call(self.answer)
+        confirm.call(answer)
       else
         # evaluate ERb under initial scope, so it will have
         # access to question and answer
-        template  = ERB.new(confirm, nil, "%")
+        template = ERB.new(confirm, nil, "%")
         template_renderer = TemplateRenderer.new(template, self, highline)
         template_renderer.render
       end
@@ -547,7 +548,8 @@ class HighLine
     # Provides the String to be asked when at an error situation.
     # It may be just the question itself (repeat on error).
     # @return [self] if :ask_on_error on responses Hash is set to :question
-    # @return [String] if :ask_on_error on responses Hash is set to something else
+    # @return [String] if :ask_on_error on responses Hash is set to
+    #   something else
     def ask_on_error_msg
       if final_responses[:ask_on_error] == :question
         self
@@ -564,7 +566,7 @@ class HighLine
     # @param highline [HighLine] context
     # @return [void]
     def show_question(highline)
-      highline.say(self) unless (readline && (echo == true && !limit))
+      highline.say(self) unless readline && (echo == true && !limit)
     end
 
     # Returns an echo string that is adequate for this Question settings.
@@ -577,7 +579,7 @@ class HighLine
       if echo == true
         response
       # any truethy value, probably a String
-      elsif !!echo
+      elsif echo
         echo
       # any falsy value, false or nil
       else
@@ -594,11 +596,11 @@ class HighLine
     #
     def append_default
       if template =~ /([\t ]+)\Z/
-        template << "|#{default}|#{$1}"
+        template << "|#{default}|#{Regexp.last_match(1)}"
       elsif template == ""
         template << "|#{default}|  "
       elsif template[-1, 1] == "\n"
-        template[-2, 0] =  "  |#{default}|"
+        template[-2, 0] = "  |#{default}|"
       else
         template << "  |#{default}|"
       end
@@ -606,7 +608,7 @@ class HighLine
 
     def choice_error_str(message_source)
       if message_source.is_a? Array
-        '[' +  message_source.join(', ') + ']'
+        "[" + message_source.join(", ") + "]"
       else
         message_source.inspect
       end