highline 1.6.1 → 1.6.14

data/lib/highline/color_scheme.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # color_scheme.rb
 #
 # Created by Jeremy Hinegardner on 2007-01-24
@@ -70,11 +68,29 @@ 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
+    end
 
     # Allow the scheme to be set like a Hash.
     def []=( color_tag, constants )
-      @scheme[to_symbol(color_tag)] = constants.map { |c| to_constant(c) }
+      @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
 
@@ -86,7 +102,7 @@ class HighLine
     # Return a normalized representation of a color setting.
     def to_constant( v )
       v = v.to_s if v.is_a?(Symbol)
-      if v.is_a?(String) then
+      if v.is_a?(::String) then
         HighLine.const_get(v.upcase)
       else
         v

data/lib/highline/import.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # import.rb
 #
 #  Created by James Edward Gray II on 2005-04-26.

data/lib/highline/menu.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # menu.rb
 #
 #  Created by Gregory Thomas Brown on 2005-05-10.
@@ -178,7 +176,7 @@ class HighLine
       @index = style
       
       # Default settings.
-      if @index == :none or @index.is_a?(String)
+      if @index == :none or @index.is_a?(::String)
         @index_suffix = " "
         @select_by    = :name
       end
@@ -306,13 +304,14 @@ class HighLine
       end
       
       # Run or return it.
-      if not @nil_on_handled and not action.nil?
+      if not action.nil?
         @highline = highline_context
         if @shell
-          action.call(name, details)
+          result = action.call(name, details)
         else
-          action.call(name)
+          result = action.call(name)
         end
+        @nil_on_handled ? nil : result
       elsif action.nil?
         name
       else
@@ -388,6 +387,8 @@ class HighLine
                      :not_in_range         =>
                        "Your answer isn't within the expected range " +
                        "(#{expected_range}).",
+                     :mismatch             =>
+                       "Your entries didn't match.",
                      :not_valid            =>
                        "Your answer isn't valid (must match " +
                        "#{@validate.inspect})."

data/lib/highline/question.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # question.rb
 #
 #  Created by James Edward Gray II on 2005-04-26.
@@ -33,9 +31,9 @@ class HighLine
     #
     def initialize( question, answer_type )
       # initialize instance data
-      @question    = question
+      @question    = question.dup
       @answer_type = answer_type
-      
+
       @character    = nil
       @limit        = nil
       @echo         = true
@@ -49,19 +47,20 @@ class HighLine
       @in           = nil
       @confirm      = nil
       @gather       = false
+      @verify_match = false
       @first_answer = nil
       @directory    = Pathname.new(File.expand_path(File.dirname($0)))
       @glob         = "*"
       @responses    = Hash.new
       @overwrite    = false
-      
+
       # allow block to override settings
       yield self if block_given?
 
       # finalize responses based on settings
       build_responses
     end
-    
+
     # The ERb template of the question to be asked.
     attr_accessor :question
     # The type that will be used to convert this answer.
@@ -152,6 +151,12 @@ class HighLine
     # 
     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.
+    #
+    attr_accessor :verify_match
+    #
     # 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, 
@@ -236,6 +241,8 @@ class HighLine
                      :not_in_range         =>
                        "Your answer isn't within the expected range " +
                        "(#{expected_range}).",
+                     :mismatch             =>
+                       "Your entries didn't match.",
                      :not_valid            =>
                        "Your answer isn't valid (must match " +
                        "#{@validate.inspect})." }.merge(@responses)
@@ -289,6 +296,7 @@ class HighLine
     # Pathname::               Same as File, save that a Pathname object is
     #                          returned.
     # String::                 Answer is converted with Kernel.String().
+    # HighLine::String::       Answer is converted with HighLine::String()
     # Regexp::                 Answer is fed to Regexp.new().
     # Symbol::                 The method to_sym() is called on answer and
     #                          the result returned.
@@ -301,6 +309,8 @@ class HighLine
     def convert( answer_string )
       if @answer_type.nil?
         answer_string
+      elsif [::String, HighLine::String].include?(@answer_type)
+        HighLine::String(answer_string)
       elsif [Float, Integer, String].include?(@answer_type)
         Kernel.send(@answer_type.to_s.to_sym, answer_string)
       elsif @answer_type == Symbol
@@ -329,7 +339,7 @@ class HighLine
       end
     end
 
-    # Returns a english explination of the current range settings.
+    # Returns an English explanation of the current range settings.
     def expected_range(  )
       expected = [ ]
 

data/lib/highline/simulate.rb

@@ -0,0 +1,48 @@
+# simulate.rb
+#
+#  Created by Andy Rossmeissl on 2012-04-29.
+#  Copyright 2005 Gray Productions. All rights reserved.
+#
+#  This is Free Software.  See LICENSE and COPYING for details.
+#
+# adapted from https://gist.github.com/194554
+class HighLine
+
+  # Simulates Highline input for use in tests.
+  class Simulate
+
+    # Creates a simulator with an array of Strings as a script
+    def initialize(strings)
+      @strings = strings
+    end
+    
+    # Simulate StringIO#gets by shifting a string off of the script
+    def gets
+      @strings.shift
+    end
+
+    # Simulate StringIO#getbyte by shifting a single character off of the next line of the script
+    def getbyte
+      line = gets
+      if line.length > 0
+        char = line.slice! 0
+        @strings.unshift line
+        char
+      end
+    end
+
+    # The simulator handles its own EOF
+    def eof?
+      false
+    end
+
+    # A wrapper method that temporarily replaces the Highline instance in $terminal with an instance of this object for the duration of the block
+    def self.with(*strings)
+      @input = $terminal.instance_variable_get :@input
+      $terminal.instance_variable_set :@input, new(strings)
+      yield
+    ensure
+      $terminal.instance_variable_set :@input, @input
+    end
+  end
+end

data/lib/highline/string_extensions.rb

@@ -0,0 +1,131 @@
+# Extensions for class String
+#
+# HighLine::String is a subclass of String with convenience methods added for colorization.
+#
+# Available convenience methods include:
+#   * 'color' method         e.g.  highline_string.color(:bright_blue, :underline)
+#   * colors                 e.g.  highline_string.magenta
+#   * RGB colors             e.g.  highline_string.rgb_ff6000
+#                             or   highline_string.rgb(255,96,0)
+#   * background colors      e.g.  highline_string.on_magenta
+#   * RGB background colors  e.g.  highline_string.on_rgb_ff6000
+#                             or   highline_string.on_rgb(255,96,0)
+#   * styles                 e.g.  highline_string.underline
+#
+# Additionally, convenience methods can be chained, for instance the following are equivalent:
+#   highline_string.bright_blue.blink.underline
+#   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:
+#
+#  require 'highline'
+#  Highline.colorize_strings
+
+class HighLine
+  def self.String(s)
+    HighLine::String.new(s)
+  end
+  
+  module StringExtensions
+    def self.included(base)
+      HighLine::COLORS.each do |color|
+        base.class_eval <<-END
+          if public_instance_methods.map { |m| m.to_s }.
+                                     include? "#{color.downcase}"
+            undef :#{color.downcase}
+          end
+          def #{color.downcase}
+            color(:#{color.downcase})
+          end
+        END
+        base.class_eval <<-END
+          if public_instance_methods.map { |m| m.to_s }.
+                                     include? "on_#{color.downcase}"
+            undef :on_#{color.downcase}
+          end
+          def on_#{color.downcase}
+            on(:#{color.downcase})
+          end
+        END
+        HighLine::STYLES.each do |style|
+          base.class_eval <<-END
+            if public_instance_methods.map { |m| m.to_s }.
+                                       include? "#{style.downcase}"
+              undef :#{style.downcase}
+            end
+            def #{style.downcase}
+              color(:#{style.downcase})
+            end
+          END
+        end
+      end
+      
+      base.class_eval do
+        if public_instance_methods.map { |m| m.to_s }.include? "color"
+          undef :color
+        end
+        if public_instance_methods.map { |m| m.to_s }.include? "foreground"
+          undef :foreground
+        end
+        def color(*args)
+          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
+        def on(arg)
+          color(('on_' + arg.to_s).to_sym)
+        end
+
+        if public_instance_methods.map { |m| m.to_s }.include? "uncolor"
+          undef :uncolor
+        end
+        def uncolor
+          self.class.new(HighLine.uncolor(self))
+        end
+        
+        if public_instance_methods.map { |m| m.to_s }.include? "rgb"
+          undef :rgb
+        end
+        def rgb(*colors)
+          color_code = colors.map{|color| color.is_a?(Numeric) ? '%02x'%color : color.to_s}.join
+          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
+        def on_rgb(*colors)
+          color_code = colors.map{|color| color.is_a?(Numeric) ? '%02x'%color : color.to_s}.join
+          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
+        # TODO Chain existing method_missing
+        def method_missing(method, *args, &blk)
+          if method.to_s =~ /^(on_)?rgb_([0-9a-fA-F]{6})$/
+            color(method)
+          else
+            raise NoMethodError, "undefined method `#{method}' for #<#{self.class}:#{'%#x'%self.object_id}>"
+          end
+        end
+      end
+    end
+  end
+  
+  class HighLine::String < ::String
+    include StringExtensions
+  end
+  
+  def self.colorize_strings
+    ::String.send(:include, StringExtensions)
+  end
+end

data/lib/highline/style.rb

@@ -0,0 +1,181 @@
+# color_scheme.rb
+#
+# Created by Richard LeBer on 2011-06-27.
+# Copyright 2011.  All rights reserved
+#
+# This is Free Software.  See LICENSE and COPYING for details
+
+class HighLine
+  
+  def self.Style(*args)
+    args = args.compact.flatten
+    if args.size==1
+      arg = args.first
+      if arg.is_a?(Style)
+        Style.list[arg.name] || Style.index(arg)
+      elsif arg.is_a?(::String) && arg =~ /^\e\[/ # arg is a code
+        if styles = Style.code_index[arg]
+          styles.first
+        else
+          Style.new(:code=>arg)
+        end
+      elsif style = Style.list[arg]
+        style
+      elsif HighLine.color_scheme && HighLine.color_scheme[arg]
+        HighLine.color_scheme[arg]
+      elsif arg.is_a?(Hash)
+        Style.new(arg)
+      elsif arg.to_s.downcase =~ /^rgb_([a-f0-9]{6})$/
+        Style.rgb($1)
+      elsif arg.to_s.downcase =~ /^on_rgb_([a-f0-9]{6})$/
+        Style.rgb($1).on
+      else
+        raise NameError, "#{arg.inspect} is not a defined Style"
+      end
+    else
+      name = args
+      Style.list[name] || Style.new(:list=>args)
+    end
+  end
+  
+  class Style
+    
+    def self.index(style)
+      if style.name
+        @@styles ||= {}
+        @@styles[style.name] = style
+      end
+      if !style.list
+        @@code_index ||= {}
+        @@code_index[style.code] ||= []
+        @@code_index[style.code].reject!{|indexed_style| indexed_style.name == style.name}
+        @@code_index[style.code] << style
+      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
+      if style = list[name]
+        style
+      else
+        parts = rgb_parts(hex)
+        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 = {})
+      @definition = defn
+      @name    = defn[:name]
+      @code    = defn[:code]
+      @rgb     = defn[:rgb]
+      @list    = defn[:list]
+      @builtin = defn[:builtin]
+      if @rgb
+        hex = self.class.rgb_hex(@rgb)
+        @name ||= 'rgb_' + hex
+      elsif @list
+        @name ||= @list
+      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
+      else
+        @code
+      end
+    end
+      
+    def red
+      @rgb && @rgb[0]
+    end
+
+    def green
+      @rgb && @rgb[1]
+    end
+
+    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
+      if options[:increment]
+        raise "Unexpected code in #{inspect}" unless new_code =~ /^(.*?)(\d+)(.*)/
+        new_code = $1 + ($2.to_i + options[:increment]).to_s + $3
+      end
+      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
+      if style = self.class.list[new_name]
+        style
+      else
+        new_rgb = @rgb == [0,0,0] ? [128, 128, 128] : @rgb.map {|color|  color==0 ? 0 : [color+128,255].min }
+        variant(new_name, :increment=>60, :rgb=>new_rgb)
+      end
+    end
+  end
+end