highline 1.5.2 → 1.6.1

data/CHANGELOG

@@ -2,6 +2,23 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+== 1.6.1
+
+* Fixed raw_no_echo_mode so that it uses stty -icanon rather than cbreak
+  as cbreak does not appear to be the posixly correct argument. It fails
+  on Solaris if cbreak is used.
+* Fixed an issue that kept Menu from showing the correct choices for 
+  disambiguation.
+* Removed a circular require that kept Ruby 1.9.2 from loading HighLine.
+* Fixed a bug that caused infinite looping when wrapping text without spaces.
+* Fixed it so that :auto paging accounts for the two lines it adds.
+* On JRuby, improved error message about ffi-ncurses.  Before 1.5.3, 
+  HighLine was silently swallowing error messages when ffi-ncurses gem
+  was installed without ncurses present on the system.
+* Reverted Aaron Simmons's patch to allow redirecting STDIN on Windows.  This
+  is the only way we could find to restore HighLine's character reading to
+  working order.
+
 == 1.5.2
 
 * Added support for using the ffi-ncurses gem which is supported in JRuby.

data/INSTALL

@@ -28,6 +28,20 @@ the root project directory and enter:
 
 	$ sudo ruby setup.rb
 
+== Installing HighLine on JRuby
+
+If you are using HighLine on JRuby, many features will not work properly
+without a working ncurses installation.  First, ensure that you have
+ncurses installed and then install the ffi-ncurses gem.
+
+If ffi-ncurses fails to find your ncurses library, you may need to set the
+RUBY_FFI_NCURSES envirionment variable, i.e:  
+
+  RUBY_FFI_NCURSES_LIB=ncursesw ruby examples/hello.rb
+
+For details, see the ffi-ncurses documentation at:
+http://github.com/seanohalpin/ffi-ncurses
+
 == Using termios
 
 While not a requirement, HighLine will take advantage of the termios library if

data/lib/highline.rb

@@ -13,13 +13,11 @@ 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 
 # output stream.  HighLine simplifies common console interaction, effectively
@@ -31,7 +29,7 @@ require "highline/color_scheme"
 #
 class HighLine
   # The version of the installed library.
-  VERSION = "1.5.2".freeze
+  VERSION = "1.6.1".freeze
   
   # An internal HighLine error.  User code does not need to trap this.
   class QuestionError < StandardError
@@ -478,7 +476,7 @@ class HighLine
   # for the <tt>@output</tt> or use a sensible default.
   #
   def page_at=( setting )
-    @page_at = setting == :auto ? output_rows : setting
+    @page_at = setting == :auto ? output_rows - 2 : setting
   end
   
   # 
@@ -740,7 +738,7 @@ class HighLine
           replace.sub!(/\n[ \t]+/, "\n")
           line.sub!(search, replace)
         else
-          line[@wrap_at, 0] = "\n"
+          line[$~.begin(1) + @wrap_at, 0] = "\n"
         end
       end
       wrapped << line

data/lib/highline/color_scheme.rb

@@ -7,8 +7,6 @@
 #
 # This is Free Software.  See LICENSE and COPYING for details
 
-require 'highline'
-
 class HighLine
   #
   # ColorScheme objects encapsulate a named set of colors to be used in the

data/lib/highline/compatibility.rb

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

data/lib/highline/menu.rb

@@ -53,7 +53,6 @@ class HighLine
       yield self if block_given?
 
       init_help if @shell and not @help.empty?
-      update_responses     # rebuild responses based on our settings
     end
 
     #
@@ -140,6 +139,7 @@ class HighLine
       @items << [name, action]
       
       @help[name.to_s.downcase] = help unless help.nil?
+      update_responses  # rebuild responses based on our settings
     end
     
     #
@@ -374,7 +374,8 @@ class HighLine
     # 
     def update_responses(  )
       append_default unless default.nil?
-      @responses = { :ambiguous_completion =>
+      @responses = @responses.merge(
+                     :ambiguous_completion =>
                        "Ambiguous choice.  " +
                        "Please choose one of #{options.inspect}.",
                      :ask_on_error         =>
@@ -389,7 +390,8 @@ class HighLine
                        "(#{expected_range}).",
                      :not_valid            =>
                        "Your answer isn't valid (must match " +
-                       "#{@validate.inspect})." }.merge(@responses)
+                       "#{@validate.inspect})."
+                   )
     end
   end
 end

data/lib/highline/question.rb

@@ -27,7 +27,7 @@ class HighLine
     #
     # Create an instance of HighLine::Question.  Expects a _question_ to ask
     # (can be <tt>""</tt>) and an _answer_type_ to convert the answer to.
-    # The _answer_type_ parameter must be a type recongnized by
+    # The _answer_type_ parameter must be a type recognized by
     # Question.convert(). If given, a block is yeilded the new Question
     # object to allow custom initializaion.
     #
@@ -68,10 +68,9 @@ class HighLine
     attr_accessor :answer_type
     #
     # 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 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.
+    # 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.
     #
     # *WARNING*:  The _echo_ and _overwrite_ attributes for a question are 
     # ignored when using the <tt>:getc</tt> method.  

data/lib/highline/system_extensions.rb

@@ -7,12 +7,14 @@
 #
 #  This is Free Software.  See LICENSE and COPYING for details.
 
+require "highline/compatibility"
+
 class HighLine
   module SystemExtensions
     module_function
 
     JRUBY = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
-
+    
     #
     # This section builds character reading and terminal size functions
     # to suit the proper platform we're running on.  Be warned:  Here be
@@ -29,106 +31,44 @@ class HighLine
       #
       # Windows savvy getc().
       # 
+      # *WARNING*:  This method ignores <tt>input</tt> and reads one
+      # character from +STDIN+!
       # 
       def get_character( input = STDIN )
-        @stdin_handle ||= GetStdHandle(STD_INPUT_HANDLE)
-
-        begin
-          SetConsoleEcho(@stdin_handle, false)
-          input.getbyte
-        ensure
-          SetConsoleEcho(@stdin_handle, true)
-        end        
+        Win32API.new("crtdll", "_getch", [ ], "L").Call
       end
 
       # A Windows savvy method to fetch the console columns, and rows.
       def terminal_size
-        stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE)
-
-        bufx, bufy, curx, cury, wattr, left, top, right, bottom, maxx, maxy =
-        GetConsoleScreenBufferInfo(stdout_handle)
+        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)
+        
+        m_GetConsoleScreenBufferInfo.call(stdout_handle, buf)
+        bufx, bufy, curx, cury, wattr,
+        left, top, right, bottom, maxx, maxy = buf.unpack(format)
         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
+        raise LoadError
         require "termios"             # Unix, first choice termios.
 
         CHARACTER_MODE = "termios"    # For Debugging purposes only.
 
         #
         # Unix savvy getc().  (First choice.)
-        # 
+        #
         # *WARNING*:  This method requires the "termios" library!
-        # 
+        #
         def get_character( input = STDIN )
           old_settings = Termios.getattr(input)
 
@@ -144,10 +84,10 @@ class HighLine
           end
         end
       rescue LoadError            # If our first choice fails, try using ffi-ncurses.
-        begin                     
+        begin
           require 'ffi-ncurses'   # The ffi gem is builtin to JRUBY and because stty does not
                                   # work correctly in JRuby manually installing the ffi-ncurses
-                                  # gem is the only way to get highline to operate correctly in 
+                                  # gem is the only way to get highline to operate correctly in
                                   # JRuby. The ncurses library is only present on unix platforms
                                   # so this is not a solution for using highline in JRuby on
                                   # windows.
@@ -156,29 +96,33 @@ class HighLine
 
           #
           # ncurses savvy getc().  (JRuby choice.)
-          # 
+          #
           def get_character( input = STDIN )
             FFI::NCurses.initscr
             FFI::NCurses.cbreak
             begin
               FFI::NCurses.curs_set 0
-              input.getc
+              input.getbyte
             ensure
               FFI::NCurses.endwin
             end
           end
 
-        rescue LoadError             # If the ffi-ncurses choice fails, try using stty
+        rescue LoadError => e            # If the ffi-ncurses choice fails, try using stty
           if JRUBY
-            STDERR.puts "\n*** Using highline effectively in JRuby requires manually installing the ffi-ncurses gem.\n*** jruby -S gem install ffi-ncurses"
-          end          
+            if e.message =~ /^no such file to load/
+              STDERR.puts "\n*** Using highline effectively in JRuby requires manually installing the ffi-ncurses gem.\n*** jruby -S gem install ffi-ncurses"
+            else
+              raise
+            end
+          end
           CHARACTER_MODE = "stty"    # For Debugging purposes only.
 
           #
           # Unix savvy getc().  (Second choice.)
-          # 
+          #
           # *WARNING*:  This method requires the external "stty" program!
-          # 
+          #
           def get_character( input = STDIN )
             raw_no_echo_mode
 
@@ -191,19 +135,19 @@ class HighLine
 
           #
           # Switched the input mode to raw and disables echo.
-          # 
+          #
           # *WARNING*:  This method requires the external "stty" program!
-          # 
+          #
           def raw_no_echo_mode
             @state = `stty -g`
-            system "stty raw -echo cbreak isig"
+            system "stty raw -echo -icanon isig"
           end
 
           #
           # Restores a previously saved input mode.
-          # 
+          #
           # *WARNING*:  This method requires the external "stty" program!
-          # 
+          #
           def restore_mode
             system "stty #{@state}"
           end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: highline
 version: !ruby/object:Gem::Version 
-  version: 1.5.2
+  hash: 13
+  prerelease: false
+  segments: 
+  - 1
+  - 6
+  - 1
+  version: 1.6.1
 platform: ruby
 authors: 
 - James Edward Gray II
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-30 00:00:00 -06:00
+date: 2010-07-15 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -74,21 +80,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: highline
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: HighLine is a high-level command-line IO library.