highline 1.5.1 → 1.5.2

data/CHANGELOG

@@ -2,6 +2,11 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+== 1.5.2
+
+* Added support for using the ffi-ncurses gem which is supported in JRuby.
+* Added gem build instructions.
+
 == 1.5.1
 
 * Fixed the long standing echo true bug.

data/INSTALL

@@ -14,6 +14,12 @@ version, simply enter the following into your command prompt:
 You must have RubyGems[http://rubyforge.org/projects/rubygems/] installed for
 the above to work.
 
+If you want to build the gem locally, make sure you have
+Rake[http://rubyforge.org/projects/rake/] installed then run the following
+command:
+
+  $ rake package
+
 == Installing Manually
 
 Download the latest version of HighLine from the

data/lib/highline.rb

@@ -31,7 +31,7 @@ require "highline/color_scheme"
 #
 class HighLine
   # The version of the installed library.
-  VERSION = "1.5.1".freeze
+  VERSION = "1.5.2".freeze
   
   # An internal HighLine error.  User code does not need to trap this.
   class QuestionError < StandardError

data/lib/highline/system_extensions.rb

@@ -10,7 +10,9 @@
 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
@@ -19,7 +21,7 @@ class HighLine
     begin
       # Cygwin will look like Windows, but we want to treat it like a Posix OS:
       raise LoadError, "Cygwin is a Posix OS." if RUBY_PLATFORM =~ /\bcygwin\b/i
-      
+
       require "Win32API"             # See if we're on Windows.
 
       CHARACTER_MODE = "Win32API"    # For Debugging purposes only.
@@ -30,40 +32,40 @@ class HighLine
       # 
       def get_character( input = STDIN )
         @stdin_handle ||= GetStdHandle(STD_INPUT_HANDLE)
-        
+
         begin
-            SetConsoleEcho(@stdin_handle, false)
-            input.getbyte
+          SetConsoleEcho(@stdin_handle, false)
+          input.getbyte
         ensure
-            SetConsoleEcho(@stdin_handle, true)
+          SetConsoleEcho(@stdin_handle, true)
         end        
       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)
+        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
+          mode |=  ENABLE_ECHO_INPUT
         else
-            mode &= ~ENABLE_ECHO_INPUT
+          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
@@ -81,18 +83,18 @@ class HighLine
       @@apiGetConsoleMode             = nil
       @@apiSetConsoleMode             = nil
       @@apiGetConsoleScreenBufferInfo = nil      
-      
+
       def GetStdHandle( handle_type )
         @@apiGetStdHandle ||= Win32API.new( "kernel32", "GetStdHandle",
-                                            ['L'], 'L' )
-        
+        ['L'], 'L' )
+
         @@apiGetStdHandle.call( handle_type )
       end
-        
+
       def GetConsoleMode( console_handle )
         @@apiGetConsoleMode ||= Win32API.new( "kernel32", "GetConsoleMode",
-                                              ['L', 'P'], 'I' )
-        
+        ['L', 'P'], 'I' )
+
         mode = ' ' * 4
         @@apiGetConsoleMode.call(console_handle, mode)
         mode.unpack('L')[0]
@@ -100,25 +102,25 @@ class HighLine
 
       def SetConsoleMode( console_handle, mode )
         @@apiSetConsoleMode ||= Win32API.new( "kernel32", "SetConsoleMode",
-                                              ['L', 'L'], 'I' )
+        ['L', 'L'], 'I' )
 
         @@apiSetConsoleMode.call(console_handle, mode) != 0
       end            
 
       def GetConsoleScreenBufferInfo( console_handle )
         @@apiGetConsoleScreenBufferInfo ||=
-          Win32API.new( "kernel32", "GetConsoleScreenBufferInfo",
-                        ['L', 'P'], 'L' )
+        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.
+        require "termios"             # Unix, first choice termios.
 
         CHARACTER_MODE = "termios"    # For Debugging purposes only.
 
@@ -141,51 +143,96 @@ class HighLine
             Termios.setattr(input, Termios::TCSANOW, old_settings)
           end
         end
-      rescue LoadError             # If our first choice fails, default.
-        CHARACTER_MODE = "stty"    # For Debugging purposes only.
+      rescue LoadError            # If our first choice fails, try using ffi-ncurses.
+        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 
+                                  # JRuby. The ncurses library is only present on unix platforms
+                                  # so this is not a solution for using highline in JRuby on
+                                  # windows.
+
+          CHARACTER_MODE = "ncurses"    # For Debugging purposes only.
+
+          #
+          # ncurses savvy getc().  (JRuby choice.)
+          # 
+          def get_character( input = STDIN )
+            FFI::NCurses.initscr
+            FFI::NCurses.cbreak
+            begin
+              FFI::NCurses.curs_set 0
+              input.getc
+            ensure
+              FFI::NCurses.endwin
+            end
+          end
 
-        #
-        # Unix savvy getc().  (Second choice.)
-        # 
-        # *WARNING*:  This method requires the external "stty" program!
-        # 
-        def get_character( input = STDIN )
-          raw_no_echo_mode
+        rescue LoadError             # 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          
+          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
+
+            begin
+              input.getbyte
+            ensure
+              restore_mode
+            end
+          end
 
-          begin
-            input.getbyte
-          ensure
-            restore_mode
+          #
+          # 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"
+          end
+
+          #
+          # Restores a previously saved input mode.
+          # 
+          # *WARNING*:  This method requires the external "stty" program!
+          # 
+          def restore_mode
+            system "stty #{@state}"
           end
         end
-        
+      end
+      if CHARACTER_MODE == 'ncurses'
         #
-        # 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"
-        end
-        
+        # A ncurses savvy method to fetch the console columns, and rows.
         #
-        # Restores a previously saved input mode.
-        # 
-        # *WARNING*:  This method requires the external "stty" program!
-        # 
-        def restore_mode
-          system "stty #{@state}"
+        def terminal_size
+          size = [80, 40]
+          FFI::NCurses.initscr
+          begin
+            size = FFI::NCurses.getmaxyx(stdscr).reverse
+          ensure
+            FFI::NCurses.endwin
+          end
+          size
         end
-      end
-      
-      # A Unix savvy method to fetch the console columns, and rows.
-      def terminal_size
-        if /solaris/ =~ RUBY_PLATFORM and
-           `stty` =~ /\brows = (\d+).*\bcolumns = (\d+)/
-          [$2, $1].map { |c| x.to_i }
-        else
-          `stty size`.split.map { |x| x.to_i }.reverse
+      else
+        # A Unix savvy method using stty that to fetch the console columns, and rows.
+        # ... stty does not work in JRuby
+        def terminal_size
+          if /solaris/ =~ RUBY_PLATFORM and
+            `stty` =~ /\brows = (\d+).*\bcolumns = (\d+)/
+            [$2, $1].map { |c| x.to_i }
+          else
+            `stty size`.split.map { |x| x.to_i }.reverse
+          end
         end
       end
     end

data/test/tc_highline.rb

@@ -412,7 +412,7 @@ class TestHighLine < Test::Unit::TestCase
   end
   
   def test_mode
-    assert(%w[Win32API termios stty].include?(HighLine::CHARACTER_MODE))
+    assert(%w[Win32API termios ncurses stty].include?(HighLine::CHARACTER_MODE))
   end
   
   class NameClass

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: highline
 version: !ruby/object:Gem::Version 
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors: 
 - James Edward Gray II
@@ -9,11 +9,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-07 00:00:00 -04:00
+date: 2010-01-30 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: A high-level IO library that provides validation, type conversion, and more for command-line interfaces. HighLine also includes a complete menu system that can crank out anything from simple list selection to complete shells with just minutes of work.
+description: |
+  A high-level IO library that provides validation, type conversion, and more for
+  command-line interfaces. HighLine also includes a complete menu system that can
+  crank out anything from simple list selection to complete shells with just
+  minutes of work.
+
 email: james@grayproductions.net
 executables: []
 
@@ -58,6 +63,8 @@ files:
 - LICENSE
 has_rdoc: true
 homepage: http://highline.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -81,9 +88,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: highline
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: HighLine is a high-level command-line IO library.
 test_files: 
 - test/ts_all.rb