highline 1.6.13 → 1.6.14

data/CHANGELOG

@@ -2,6 +2,12 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+== 1.6.14
+
+* Added JRuby 1.7 support (by Mina Nagy).
+* Take into account color escape sequences when wrapping text (by Mark J.
+  Titorenko).
+
 == 1.6.13
 
 * Removed unneeded Shebang lines (by Scott Gonyea).

data/lib/highline.rb

@@ -28,7 +28,7 @@ require "highline/style"
 #
 class HighLine
   # The version of the installed library.
-  VERSION = "1.6.13".freeze
+  VERSION = "1.6.14".freeze
   
   # An internal HighLine error.  User code does not need to trap this.
   class QuestionError < StandardError
@@ -175,23 +175,9 @@ class HighLine
   #
   def initialize( input = $stdin, output = $stdout,
                   wrap_at = nil, page_at = nil )
+    super()
     @input   = input
     @output  = output
-    if JRUBY
-      require 'java'
-      java_import 'java.io.OutputStreamWriter'
-      java_import 'java.nio.channels.Channels'
-      java_import 'jline.ConsoleReader'
-      java_import 'jline.Terminal'
-
-      @java_input = Channels.newInputStream($stdin.to_channel)
-      @java_output = OutputStreamWriter.new(Channels.newOutputStream($stdout.to_channel))
-      @java_terminal = Terminal.getTerminal
-      @java_console = ConsoleReader.new(@java_input, @java_output)
-      @java_console.setUseHistory(false)
-      @java_console.setBellEnabled(true)
-      @java_console.setUsePagination(false)
-    end
     
     self.wrap_at = wrap_at
     self.page_at = page_at
@@ -255,7 +241,9 @@ class HighLine
     # readline() needs to handle it's own output, but readline only supports 
     # full line reading.  Therefore if @question.echo is anything but true, 
     # the prompt will not be issued. And we have to account for that now.
-    say(@question) unless (@question.readline and @question.echo == true)
+    # Also, JRuby-1.7's ConsoleReader.readLine() needs to be passed the prompt
+    # to handle line editing properly.
+    say(@question) unless ((JRUBY or @question.readline) and @question.echo == true)
     begin
       @answer = @question.answer_or_default(get_response)
       unless @question.valid_answer?(@answer)
@@ -796,13 +784,7 @@ class HighLine
       answer
     else
       if JRUBY
-        enable_echo_afterwards = @java_terminal.isEchoEnabled
-        @java_terminal.disableEcho
-        begin
-          raw_answer = @java_console.readLine(nil, nil)
-        ensure
-          @java_terminal.enableEcho if enable_echo_afterwards
-        end
+        raw_answer = @java_console.readLine(@question.question, nil)
       else
         raise EOFError, "The input stream is exhausted." if @@track_eof and
                                                             @input.eof?
@@ -813,16 +795,6 @@ class HighLine
     end
   end
 
-  def get_single_character(is_stty)
-    if JRUBY
-      @java_console.readVirtualKey
-    elsif is_stty
-      @input.getbyte
-    else
-      get_character(@input)
-    end
-  end
-
   #
   # Return a line or character of input, as requested for this question.
   # Character input will be returned as a single character String,
@@ -841,18 +813,13 @@ class HighLine
       if @question.echo == true and @question.limit.nil?
         get_line
       else
-        if JRUBY
-          enable_echo_afterwards = @java_terminal.isEchoEnabled
-          @java_terminal.disableEcho
-        elsif stty
-          raw_no_echo_mode
-        end
+        raw_no_echo_mode
 
         line            = ""
         backspace_limit = 0
         begin
 
-          while character = get_single_character(stty)
+          while character = get_character(@input)
             # honor backspace and delete
             if character == 127 or character == 8
               line.slice!(-1, 1)
@@ -885,11 +852,7 @@ class HighLine
             break if @question.limit and line.size == @question.limit
           end
         ensure
-          if JRUBY
-            @java_terminal.enableEcho if enable_echo_afterwards
-          elsif stty
-            restore_mode
-          end
+          restore_mode
         end
         if @question.overwrite
           @output.print("\r#{HighLine.Style(:erase_line).code}")
@@ -901,15 +864,12 @@ class HighLine
         @question.change_case(@question.remove_whitespace(line))
       end
     else
-      if JRUBY
-        enable_echo_afterwards = @java_terminal.isEchoEnabled
-        @java_terminal.disableEcho
-      end
+      raw_no_echo_mode
       begin
         if @question.character == :getc
-          response = get_single_character(true).chr
+          response = @input.getbyte.chr
         else
-          response = get_single_character(stty).chr
+          response = get_character(@input).chr
           if @question.overwrite
             @output.print("\r#{HighLine.Style(:erase_line).code}")
             @output.flush
@@ -925,9 +885,7 @@ class HighLine
           end
         end
       ensure
-        if JRUBY
-          @java_terminal.enableEcho if enable_echo_afterwards
-        end
+        restore_mode
       end
       @question.change_case(response)
     end
@@ -971,15 +929,17 @@ class HighLine
   def wrap( text )
     wrapped = [ ]
     text.each_line do |line|
-      while line =~ /([^\n]{#{@wrap_at + 1},})/
+      # take into account color escape sequences when wrapping
+      wrap_at = @wrap_at + (line.length - actual_length(line))
+      while line =~ /([^\n]{#{wrap_at + 1},})/
         search  = $1.dup
         replace = $1.dup
-        if index = replace.rindex(" ", @wrap_at)
+        if index = replace.rindex(" ", wrap_at)
           replace[index, 1] = "\n"
           replace.sub!(/\n[ \t]+/, "\n")
           line.sub!(search, replace)
         else
-          line[$~.begin(1) + @wrap_at, 0] = "\n"
+          line[$~.begin(1) + wrap_at, 0] = "\n"
         end
       end
       wrapped << line

data/lib/highline/system_extensions.rb

@@ -9,9 +9,41 @@ require "highline/compatibility"
 
 class HighLine
   module SystemExtensions
+    JRUBY = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+
+    def initialize
+      if JRUBY
+        require 'java'
+        if JRUBY_VERSION =~ /^1.7/
+          java_import 'jline.console.ConsoleReader'
+
+          @java_console = ConsoleReader.new($stdin.to_inputstream, $stdout.to_outputstream)
+          @java_console.set_history_enabled(false)
+          @java_console.set_bell_enabled(true)
+          @java_console.set_pagination_enabled(false)
+          @java_terminal = @java_console.getTerminal
+        elsif JRUBY_VERSION =~ /^1.6/
+          java_import 'java.io.OutputStreamWriter'
+          java_import 'java.nio.channels.Channels'
+          java_import 'jline.ConsoleReader'
+          java_import 'jline.Terminal'
+
+          @java_input = Channels.newInputStream($stdin.to_channel)
+          @java_output = OutputStreamWriter.new(Channels.newOutputStream($stdout.to_channel))
+          @java_terminal = Terminal.getTerminal
+          @java_console = ConsoleReader.new(@java_input, @java_output)
+          @java_console.setUseHistory(false)
+          @java_console.setBellEnabled(true)
+          @java_console.setUsePagination(false)
+        end
+      end
+    end
+
     module_function
 
-    JRUBY = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    def get_character( input = STDIN )
+      input.getbyte
+    end
 
     #
     # This section builds character reading and terminal size functions
@@ -38,6 +70,13 @@ class HighLine
         Win32API.new("crtdll", "_getch", [ ], "L").Call
       end
 
+      # We do not define a raw_no_echo_mode for Windows as _getch turns off echo
+      def raw_no_echo_mode
+      end
+
+      def restore_mode
+      end
+
       # A Windows savvy method to fetch the console columns, and rows.
       def terminal_size
         m_GetStdHandle               = Win32API.new( 'kernel32',
@@ -63,114 +102,79 @@ class HighLine
 
         CHARACTER_MODE = "termios"    # For Debugging purposes only.
 
-        #
-        # Unix savvy getc().  (First choice.)
-        #
-        # *WARNING*:  This method requires the "termios" library!
-        #
-        def get_character( input = STDIN )
-          return input.getbyte if input.is_a? StringIO
-
-          old_settings = Termios.getattr(input)
-
-          new_settings                     =  old_settings.dup
+        def raw_no_echo_mode
+          @state = Termios.getattr(input)
+          new_settings                     =  @state.dup
           new_settings.c_lflag             &= ~(Termios::ECHO | Termios::ICANON)
           new_settings.c_cc[Termios::VMIN] =  1
+          Termios.setattr(input, Termios::TCSANOW, new_settings)
+        end
 
-          begin
-            Termios.setattr(input, Termios::TCSANOW, new_settings)
-            input.getbyte
-          ensure
-            Termios.setattr(input, Termios::TCSANOW, old_settings)
-          end
+        def restore_mode
+            Termios.setattr(input, Termios::TCSANOW, @state)
         end
-      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().
-          #
-          def get_character( input = STDIN )
-            FFI::NCurses.initscr
-            FFI::NCurses.cbreak
-            begin
-              FFI::NCurses.curs_set 0
-              input.getbyte
-            ensure
-              FFI::NCurses.endwin
-            end
-          end
+      rescue LoadError                # If our first choice fails, try using JLine
+        if JRUBY                      # if we are on JRuby. JLine is bundled with JRuby.
+          CHARACTER_MODE = "jline"    # For Debugging purposes only.
 
-        rescue LoadError                # If the ffi-ncurses choice fails, try using stty
-          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
+          def terminal_size
+            [ @java_terminal.getTerminalWidth, @java_terminal.getTerminalHeight ]
           end
 
-          #
-          # 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 -icanon isig"
+            @state = @java_console.getEchoCharacter
+            @java_console.setEchoCharacter 0
           end
 
-          #
-          # Restores a previously saved input mode.
-          #
-          # *WARNING*:  This method requires the external "stty" program!
-          #
           def restore_mode
-            system "stty #{@state}"
+            @java_console.setEchoCharacter @state
           end
-        end
-      end
-      if CHARACTER_MODE == 'ncurses'
-        #
-        # A ncurses savvy method to fetch the console columns, and rows.
-        #
-        def terminal_size
-          size = [80, 40]
-          FFI::NCurses.initscr
+        else                          # If we are not on JRuby, try ncurses
           begin
-            size = FFI::NCurses.getmaxyx(stdscr).reverse
-          ensure
-            FFI::NCurses.endwin
+            require 'ffi-ncurses'
+            CHARACTER_MODE = "ncurses"    # For Debugging purposes only.
+
+            def raw_no_echo_mode
+              FFI::NCurses.initscr
+              FFI::NCurses.cbreak
+            end
+
+            def restore_mode
+              FFI::NCurses.endwin
+            end
+
+            #
+            # A ncurses savvy method to fetch the console columns, and rows.
+            #
+            def terminal_size
+              size = [80, 40]
+              FFI::NCurses.initscr
+              begin
+                size = FFI::NCurses.getmaxyx(stdscr).reverse
+              ensure
+                FFI::NCurses.endwin
+              end
+              size
+            end
+          rescue LoadError            # Finally, if all else fails, use stty
+                                      # *WARNING*:  This requires the external "stty" program!
+            CHARACTER_MODE = "stty"   # For Debugging purposes only.
+
+            def raw_no_echo_mode
+              @state = `stty -g`
+              system "stty raw -echo -icanon isig"
+            end
+
+            def restore_mode
+              system "stty #{@state}"
+            end
           end
-          size
         end
-      elsif JRUBY
-        # JRuby running on Unix can fetch the number of columns and rows from the builtin Jline library
-        require 'java'
-        java_import 'jline.Terminal'
-        def terminal_size
-          java_terminal = @java_terminal || Terminal.getTerminal
-          [ java_terminal.getTerminalWidth, java_terminal.getTerminalHeight ]
-        end
-      else
-        # A Unix savvy method using stty that to fetch the console columns, and rows.
+      end
+
+      # For termios and stty
+      if not defined?(terminal_size)
+        # A Unix savvy method using stty to fetch the console columns, and rows.
         # ... stty does not work in JRuby
         def terminal_size
           if /solaris/ =~ RUBY_PLATFORM and

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: highline
 version: !ruby/object:Gem::Version
-  version: 1.6.13
+  version: 1.6.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-15 00:00:00.000000000 Z
+date: 2012-08-25 00:00:00.000000000 Z
 dependencies: []
 description: ! 'A high-level IO library that provides validation, type conversion,
   and more for