highline 1.5.0 → 1.5.1

data/CHANGELOG

@@ -2,6 +2,17 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+== 1.5.1
+
+* Fixed the long standing echo true bug.
+  (reported by Lauri Tuominen)
+* Improved Windows API calls to support the redirection of STDIN.
+  (patch by Aaron Simmons)
+* Updated gem specification to avoid a deprecated call.
+* Made a minor documentation clarification about character mode support.
+* Worked around some API changes in Ruby's standard library in Ruby 1.9.
+  (patch by Jake Benilov)
+
 == 1.5.0
 
 * Fixed a bug that would prevent Readline from showing all completions.

data/Rakefile

@@ -43,7 +43,7 @@ spec = Gem::Specification.new do |spec|
                       delete_if { |item| item.include?("CVS") } +
                       ["Rakefile", "setup.rb"]
 
-  spec.test_suite_file  =  "test/ts_all.rb"
+  spec.test_files       =  "test/ts_all.rb"
   spec.has_rdoc         =  true
   spec.extra_rdoc_files =  %w{README INSTALL TODO CHANGELOG LICENSE}
   spec.rdoc_options     << '--title' << 'HighLine Documentation' <<

data/examples/limit.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby -w
+
+# limit.rb
+# 
+#  Created by James Edward Gray II on 2008-11-12.
+#  Copyright 2008 Gray Productions. All rights reserved.
+
+require "rubygems"
+require "highline/import"
+
+text = ask("Enter text (max 10 chars): ") { |q| q.limit = 10 }
+puts "You entered: #{text}!"

data/lib/highline.rb

@@ -9,14 +9,16 @@
 #
 # This is Free Software.  See LICENSE and COPYING for details.
 
-require "highline/system_extensions"
-require "highline/question"
-require "highline/menu"
-require "highline/color_scheme"
 require "erb"
 require "optparse"
 require "stringio"
 require "abbrev"
+require "highline/compatibility"
+require "highline/system_extensions"
+require "highline/question"
+require "highline/menu"
+require "highline/color_scheme"
+
 
 #
 # A HighLine object is a "high-level line oriented" shell over an input and an 
@@ -29,7 +31,7 @@ require "abbrev"
 #
 class HighLine
   # The version of the installed library.
-  VERSION = "1.5.0".freeze
+  VERSION = "1.5.1".freeze
   
   # An internal HighLine error.  User code does not need to trap this.
   class QuestionError < StandardError
@@ -247,16 +249,20 @@ class HighLine
       end
     rescue QuestionError
       retry
-    rescue ArgumentError
-      explain_error(:invalid_type)
+    rescue ArgumentError, NameError => error
+      raise if error.is_a?(NoMethodError)
+      if error.message =~ /ambiguous/
+        # the assumption here is that OptionParser::Completion#complete
+        # (used for ambiguity resolution) throws exceptions containing 
+        # the word 'ambiguous' whenever resolution fails
+        explain_error(:ambiguous_completion)
+      else
+        explain_error(:invalid_type)
+      end
       retry
     rescue Question::NoAutoCompleteMatch
       explain_error(:no_completion)
       retry
-    rescue NameError
-      raise if $!.is_a?(NoMethodError)
-      explain_error(:ambiguous_completion)
-      retry
     ensure
       @question = nil    # Reset Question object.
     end
@@ -619,11 +625,11 @@ class HighLine
       else
         raw_no_echo_mode if stty = CHARACTER_MODE == "stty"
         
-        line = ""
+        line            = ""
         backspace_limit = 0
         begin
 
-          while character = (stty ? @input.getc : get_character(@input))
+          while character = (stty ? @input.getbyte : get_character(@input))
             # honor backspace and delete
             if character == 127 or character == 8
               line.slice!(-1, 1)
@@ -646,7 +652,11 @@ class HighLine
                       # do nothing
                   end
               else
-                @output.print(@question.echo)
+                if @question.echo == true
+                  @output.print(character.chr)
+                else
+                  @output.print(@question.echo)
+                end
               end
               @output.flush
             end
@@ -664,7 +674,7 @@ class HighLine
         @question.change_case(@question.remove_whitespace(line))
       end
     elsif @question.character == :getc
-      @question.change_case(@input.getc.chr)
+      @question.change_case(@input.getbyte.chr)
     else
       response = get_character(@input).chr
       if @question.overwrite
@@ -719,9 +729,9 @@ class HighLine
   # newlines will not be affected by this process, but additional newlines
   # may be added.
   #
-  def wrap( lines )
+  def wrap( text )
     wrapped = [ ]
-    lines.each do |line|
+    text.each_line do |line|
       while line =~ /([^\n]{#{@wrap_at + 1},})/
         search  = $1.dup
         replace = $1.dup

data/lib/highline/compatibility.rb

@@ -0,0 +1,17 @@
+unless STDIN.respond_to?(:getbyte)
+  class IO
+    alias_method :getbyte, :getc
+  end
+
+  class StringIO
+    alias_method :getbyte, :getc
+  end
+end
+
+unless "".respond_to?(:each_line)
+  
+  # Not a perfect translation, but sufficient for our needs.
+  class String
+    alias_method :each_line, :each
+  end
+end

data/lib/highline/question.rb

@@ -69,8 +69,9 @@ class HighLine
     #
     # 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.
+    # character reader *ONLY* supports STDIN on Windows and Unix and may not
+    # work correctly if STDIN is redirected.)  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.  

data/lib/highline/system_extensions.rb

@@ -27,32 +27,95 @@ class HighLine
       #
       # Windows savvy getc().
       # 
-      # *WARNING*:  This method ignores <tt>input</tt> and reads one
-      # character from +STDIN+!
       # 
       def get_character( input = STDIN )
-        Win32API.new("crtdll", "_getch", [ ], "L").Call
+        @stdin_handle ||= GetStdHandle(STD_INPUT_HANDLE)
+        
+        begin
+            SetConsoleEcho(@stdin_handle, false)
+            input.getbyte
+        ensure
+            SetConsoleEcho(@stdin_handle, true)
+        end        
       end
 
       # A Windows savvy method to fetch the console columns, and rows.
       def terminal_size
-        m_GetStdHandle               = Win32API.new( 'kernel32',
-                                                     'GetStdHandle',
-                                                     ['L'],
-                                                     'L' )
-        m_GetConsoleScreenBufferInfo = Win32API.new(
-          'kernel32', 'GetConsoleScreenBufferInfo', ['L', 'P'], 'L'
-        )
-
-        format        = 'SSSSSssssSS'
-        buf           = ([0] * format.size).pack(format)
-        stdout_handle = m_GetStdHandle.call(0xFFFFFFF5)
+        stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE)
         
-        m_GetConsoleScreenBufferInfo.call(stdout_handle, buf)
-        bufx, bufy, curx, cury, wattr,
-        left, top, right, bottom, maxx, maxy = buf.unpack(format)
+        bufx, bufy, curx, cury, wattr, left, top, right, bottom, maxx, maxy =
+          GetConsoleScreenBufferInfo(stdout_handle)
         return right - left + 1, bottom - top + 1
       end
+
+      # windows savvy console echo toggler
+      def SetConsoleEcho( console_handle, on )
+        mode = GetConsoleMode(console_handle)
+        
+        # toggle the console echo bit
+        if on
+            mode |=  ENABLE_ECHO_INPUT
+        else
+            mode &= ~ENABLE_ECHO_INPUT
+        end
+        
+        ok = SetConsoleMode(console_handle, mode)    
+      end
+      
+      # win32 console APIs
+      
+      STD_INPUT_HANDLE  = -10
+      STD_OUTPUT_HANDLE = -11
+      STD_ERROR_HANDLE  = -12
+
+      ENABLE_PROCESSED_INPUT    = 0x0001
+      ENABLE_LINE_INPUT         = 0x0002
+      ENABLE_WRAP_AT_EOL_OUTPUT = 0x0002
+      ENABLE_ECHO_INPUT         = 0x0004
+      ENABLE_WINDOW_INPUT       = 0x0008
+      ENABLE_MOUSE_INPUT        = 0x0010
+      ENABLE_INSERT_MODE        = 0x0020
+      ENABLE_QUICK_EDIT_MODE    = 0x0040 
+
+      @@apiGetStdHandle               = nil
+      @@apiGetConsoleMode             = nil
+      @@apiSetConsoleMode             = nil
+      @@apiGetConsoleScreenBufferInfo = nil      
+      
+      def GetStdHandle( handle_type )
+        @@apiGetStdHandle ||= Win32API.new( "kernel32", "GetStdHandle",
+                                            ['L'], 'L' )
+        
+        @@apiGetStdHandle.call( handle_type )
+      end
+        
+      def GetConsoleMode( console_handle )
+        @@apiGetConsoleMode ||= Win32API.new( "kernel32", "GetConsoleMode",
+                                              ['L', 'P'], 'I' )
+        
+        mode = ' ' * 4
+        @@apiGetConsoleMode.call(console_handle, mode)
+        mode.unpack('L')[0]
+      end
+
+      def SetConsoleMode( console_handle, mode )
+        @@apiSetConsoleMode ||= Win32API.new( "kernel32", "SetConsoleMode",
+                                              ['L', 'L'], 'I' )
+
+        @@apiSetConsoleMode.call(console_handle, mode) != 0
+      end            
+
+      def GetConsoleScreenBufferInfo( console_handle )
+        @@apiGetConsoleScreenBufferInfo ||=
+          Win32API.new( "kernel32", "GetConsoleScreenBufferInfo",
+                        ['L', 'P'], 'L' )
+
+        format = 'SSSSSssssSS'
+        buf    = ([0] * format.size).pack(format)        
+        @@apiGetConsoleScreenBufferInfo.call(console_handle, buf)
+        buf.unpack(format)
+      end   
+      
     rescue LoadError                  # If we're not on Windows try...
       begin
         require "termios"             # Unix, first choice.
@@ -73,7 +136,7 @@ class HighLine
 
           begin
             Termios.setattr(input, Termios::TCSANOW, new_settings)
-            input.getc
+            input.getbyte
           ensure
             Termios.setattr(input, Termios::TCSANOW, old_settings)
           end
@@ -90,7 +153,7 @@ class HighLine
           raw_no_echo_mode
 
           begin
-            input.getc
+            input.getbyte
           ensure
             restore_mode
           end

data/test/tc_highline.rb

@@ -670,14 +670,14 @@ class TestHighLine < Test::Unit::TestCase
     assert_equal(animal, answer)
 
     @input.truncate(@input.rewind)
-    @input << "6/16/76\n"
+    @input << "16th June 1976\n"
     @input.rewind
 
     answer = @terminal.ask("Enter your birthday.", Date)
     assert_instance_of(Date, answer)
     assert_equal(16, answer.day)
     assert_equal(6, answer.month)
-    assert_equal(76, answer.year)
+    assert_equal(1976, answer.year)
 
     @input.truncate(@input.rewind)
     pattern = "^yes|no$"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: highline
 version: !ruby/object:Gem::Version 
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors: 
 - James Edward Gray II
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-05 00:00:00 -06:00
+date: 2009-05-07 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,7 @@ files:
 - examples/asking_for_arrays.rb
 - examples/basic_usage.rb
 - examples/color_scheme.rb
+- examples/limit.rb
 - examples/menus.rb
 - examples/overwrite.rb
 - examples/page_and_wrap.rb
@@ -37,6 +38,7 @@ files:
 - examples/trapping_eof.rb
 - examples/using_readline.rb
 - lib/highline/color_scheme.rb
+- lib/highline/compatibility.rb
 - lib/highline/import.rb
 - lib/highline/menu.rb
 - lib/highline/question.rb