highline 1.6.12 → 1.6.13

data/CHANGELOG

@@ -2,6 +2,12 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+== 1.6.13
+
+* Removed unneeded Shebang lines (by Scott Gonyea).
+* Protect the String passed to Question.new from modification (by michael).
+* Added a retype-to-verify setting (by michael).
+
 == 1.6.12
 
 * Silenced warnings (by James McEwan).

data/examples/ansi_colors.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 # ansi_colors.rb
 #

data/examples/asking_for_arrays.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 # asking_for_arrays.rb
 #

data/examples/basic_usage.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 # basic_usage.rb
 #

data/examples/menus.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 require "rubygems"
 require "highline/import"

data/examples/overwrite.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 # overwrite.rb
 # 

data/examples/page_and_wrap.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 # page_and_wrap.rb
 #

data/examples/password.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 require "rubygems"
 require "highline/import"

data/examples/repeat_entry.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "highline/import"
+
+tounge_twister = ask("... try saying that three times fast") do |q|
+  q.gather = 3
+  q.verify_match = true
+  q.responses[:mismatch] = "Nope, those don't match. Try again."
+end
+
+puts "Ok, you did it."
+
+pass = ask("Enter your password:  ") do |q|
+  q.echo = '*'
+  q.verify_match = true
+  q.gather = {"Enter a password" => '',
+              "Please type it again for verification" => ''}
+end
+
+puts "Your password is now #{pass}!"

data/examples/trapping_eof.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 # trapping_eof.rb
 #

data/examples/using_readline.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
 
 # using_readline.rb
 #

data/lib/highline.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # highline.rb
 #
 #  Created by James Edward Gray II on 2005-04-26.
@@ -30,7 +28,7 @@ require "highline/style"
 #
 class HighLine
   # The version of the installed library.
-  VERSION = "1.6.12".freeze
+  VERSION = "1.6.13".freeze
   
   # An internal HighLine error.  User code does not need to trap this.
   class QuestionError < StandardError
@@ -691,44 +689,68 @@ class HighLine
   # Raises EOFError if input is exhausted.
   # 
   def gather(  )
-    @gather           = @question.gather
-    @answers          = [ ]
     original_question = @question
-    
+    original_question_string = @question.question
+    original_gather = @question.gather
+
+    verify_match = @question.verify_match
     @question.gather = false
-    
-    case @gather
-    when Integer
-      @answers << ask(@question)
-      @gather  -= 1
 
-      original_question.question = ""
-      until @gather.zero?
-        @question =  original_question
-        @answers  << ask(@question)
-        @gather   -= 1
-      end
-    when ::String, Regexp
-      @answers << ask(@question)
+    begin   # when verify_match is set this loop will repeat until unique_answers == 1
+      @answers          = [ ]
+      @gather = original_gather
+      original_question.question = original_question_string
+
+      case @gather
+      when Integer
+        @answers << ask(@question)
+        @gather  -= 1
+
+        original_question.question = ""
+        until @gather.zero?
+          @question =  original_question
+          @answers  << ask(@question)
+          @gather   -= 1
+        end
+      when ::String, Regexp
+        @answers << ask(@question)
 
-      original_question.question = ""
-      until (@gather.is_a?(::String) and @answers.last.to_s == @gather) or
+        original_question.question = ""
+        until (@gather.is_a?(::String) and @answers.last.to_s == @gather) or
             (@gather.is_a?(Regexp) and @answers.last.to_s =~ @gather)
-        @question =  original_question
-        @answers  << ask(@question)
+          @question =  original_question
+          @answers  << ask(@question)
+        end
+
+        @answers.pop
+      when Hash
+        @answers = { }
+        @gather.keys.sort.each do |key|
+          @question     = original_question
+          @key          = key
+          @answers[key] = ask(@question)
+        end
       end
-      
-      @answers.pop
-    when Hash
-      @answers = { }
-      @gather.keys.sort.each do |key|
-        @question     = original_question
-        @key          = key
-        @answers[key] = ask(@question)
+
+      if verify_match && (unique_answers(@answers).size > 1)
+        @question =  original_question
+        explain_error(:mismatch)
+      else
+        verify_match = false
       end
-    end
-    
-    @answers
+
+    end while verify_match
+
+    original_question.verify_match ? @answer : @answers
+  end
+
+  #
+  # A helper method used by HighLine::Question.verify_match
+  # for finding whether a list of answers match or differ
+  # from each other.
+  #
+  def unique_answers(list = @answers)
+    (list.respond_to?(:values) ? list.values : list).uniq
   end
 
   #

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

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.
@@ -389,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)

data/lib/highline/simulate.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # simulate.rb
 #
 #  Created by Andy Rossmeissl on 2012-04-29.

data/lib/highline/style.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # color_scheme.rb
 #
 # Created by Richard LeBer on 2011-06-27.

data/lib/highline/system_extensions.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # system_extensions.rb
 #
 #  Created by James Edward Gray II on 2006-06-14.

data/test/string_methods.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # string_methods.rb
 #
 #  Created by Richard LeBer 2011-06-27

data/test/tc_color_scheme.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_color_scheme.rb
 #
 #  Created by Jeremy Hinegardner on 2007-01-24.  

data/test/tc_highline.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_highline.rb
 #
 #  Created by James Edward Gray II on 2005-04-26.
@@ -310,7 +308,19 @@ class TestHighLine < Test::Unit::TestCase
     assert_equal( "Are you sexually active?  |No Comment|  ",
                   @output.string )
   end
-  
+
+  def test_string_preservation
+    @input << "Maybe\nYes\n"
+    @input.rewind
+
+    my_string = "Is that your final answer? "
+
+    @terminal.ask(my_string) { |q| q.default = "Possibly" }
+    @terminal.ask(my_string) { |q| q.default = "Maybe" }
+
+    assert_equal("Is that your final answer? ", my_string)
+  end
+
   def test_empty
     @input << "\n"
     @input.rewind
@@ -346,8 +356,6 @@ class TestHighLine < Test::Unit::TestCase
       q.glob      = "*.rb"
     end
     assert_instance_of(File, file)
-    assert_equal("#!/usr/local/bin/ruby -w\n", file.gets)
-    assert_equal("\n", file.gets)
     assert_equal("# tc_highline.rb\n", file.gets)
     file.close
 
@@ -398,15 +406,72 @@ class TestHighLine < Test::Unit::TestCase
                   answers )
     assert_equal("Age:  Father's Age:  Wife's Age:  ", @output.string)
   end
- 
-  def test_lists 
+
+  def test_typing_verification
+    @input << "all work and no play makes jack a dull boy\n" * 3
+    @input.rewind
+
+    answer = @terminal.ask("How's work? ") do |q|
+      q.gather = 3
+      q.verify_match = true
+    end
+    assert_equal("all work and no play makes jack a dull boy", answer)
+
+    @input.truncate(@input.rewind)
+    @input << "all play and no work makes jack a mere toy\n"
+    @input << "all work and no play makes jack a dull boy\n" * 5
+    @input.rewind
+    @output.truncate(@output.rewind)
+
+    answer = @terminal.ask("How are things going? ") do |q|
+      q.gather = 3
+      q.verify_match = true
+      q.responses[:mismatch] = 'Typing mismatch!'
+      q.responses[:ask_on_error] = ''
+    end
+    assert_equal("all work and no play makes jack a dull boy", answer)
+
+    # now try using a hash for gather
+
+    @input.truncate(@input.rewind)
+    @input << "Password\nPassword\n"
+    @input.rewind
+    @output.truncate(@output.rewind)
+
+    answer = @terminal.ask("<%= @key %>: ") do |q|
+      q.verify_match = true
+      q.gather = {"Enter a password" => '', "Please type it again" => ''}
+    end
+    assert_equal("Password", answer)
+
+    @input.truncate(@input.rewind)
+    @input << "Password\nMistake\nPassword\nPassword\n"
+    @input.rewind
+    @output.truncate(@output.rewind)
+
+    answer = @terminal.ask("<%= @key %>: ") do |q|
+      q.verify_match = true
+      q.responses[:mismatch] = 'Typing mismatch!'
+      q.responses[:ask_on_error] = ''
+      q.gather = {"Enter a password" => '', "Please type it again" => ''}
+    end
+
+    assert_equal("Password", answer)
+    assert_equal( "Enter a password: " +
+                  "Please type it again: " +
+                  "Typing mismatch!\n" +
+                  "Enter a password: " +
+                  "Please type it again: ", @output.string )
+  end
+
+  def test_lists
     digits     = %w{Zero One Two Three Four Five Six Seven Eight Nine}
     erb_digits = digits.dup
     erb_digits[erb_digits.index("Five")] = "<%= color('Five', :blue) %%>"
-    
+
     @terminal.say("<%= list(#{digits.inspect}) %>")
     assert_equal(digits.map { |d| "#{d}\n" }.join, @output.string)
-    
+
     @output.truncate(@output.rewind)
 
     @terminal.say("<%= list(#{digits.inspect}, :inline) %>")

data/test/tc_import.rb

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

data/test/tc_menu.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_menu.rb
 #
 #  Created by Gregory Thomas Brown on 2005-05-10.

data/test/tc_string_extension.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_string_extension.rb
 #
 #  Created by Richard LeBer 2011-06-27

data/test/tc_string_highline.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_highline_string.rb
 #
 #  Created by Richard LeBer 2011-06-27

data/test/tc_style.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_style.rb
 #
 #  Created by Richard LeBer on 2011-06-11.

data/test/ts_all.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: highline
 version: !ruby/object:Gem::Version
-  version: 1.6.12
+  version: 1.6.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-09 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies: []
 description: ! 'A high-level IO library that provides validation, type conversion,
   and more for
@@ -50,6 +50,7 @@ files:
 - examples/overwrite.rb
 - examples/page_and_wrap.rb
 - examples/password.rb
+- examples/repeat_entry.rb
 - examples/trapping_eof.rb
 - examples/using_readline.rb
 - highline.gemspec