highline 1.2.0 → 1.2.1

data/CHANGELOG

@@ -2,6 +2,15 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+== 1.2.1
+
+* Applied Justin Bailey's fix for the page_print() infinite loop bug.
+* Made a SystemExtensions module to expose OS level functionality other
+  libraries may want to access.
+* Publicly exposed the get_character() method, per user requests.
+* Added terminal_size(), output_cols(), and output_rows() methods.
+* Added :auto setting for warp_at=() and page_at=().
+
 == 1.2.0
 
 * Improved RubyForge and gem spec project descriptions.

data/Rakefile

@@ -4,6 +4,10 @@ require "rake/gempackagetask"
 
 require "rubygems"
 
+dir     = File.dirname(__FILE__)
+lib     = File.join(dir, "lib", "highline.rb")
+version = File.read(lib)[/^\s*VERSION\s*=\s*(['"])(\d\.\d\.\d)\1/, 2]
+
 task :default => [:test]
 
 Rake::TestTask.new do |test|
@@ -32,7 +36,7 @@ end
 
 spec = Gem::Specification.new do |spec|
   spec.name     = "highline"
-  spec.version  = "1.2.0"
+  spec.version  = version
   spec.platform = Gem::Platform::RUBY
   spec.summary  = "HighLine is a high-level command-line IO library."
   spec.files    = Dir.glob("{examples,lib,test}/**/*.rb").
@@ -45,11 +49,8 @@ spec = Gem::Specification.new do |spec|
   spec.rdoc_options     << '--title' << 'HighLine Documentation' <<
                            '--main'  << 'README'
 
-  ### Removed due to Windows' install problems ###
-#  spec.add_dependency("termios", ">= 0.9.4")
-
   spec.require_path      = 'lib'
-  spec.autorequire       = "highline"
+
   spec.author            = "James Edward Gray II"
   spec.email             = "james@grayproductions.net"
   spec.rubyforge_project = "highline"
@@ -74,3 +75,8 @@ task :stats do
                       ["Functionals", "examples"], 
                       ["Units", "test"] ).to_s
 end
+
+desc "Add new files to Subversion"
+task :add_to_svn do
+  sh %Q{svn status | ruby -nae 'system "svn add \#{$F[1]}" if $F[0] == "?"' }
+end

data/lib/highline.rb

@@ -7,8 +7,9 @@
 #
 # See HighLine for documentation.
 #
-# This is Free Software.  See LICENSE and COPYING for details
+# This is Free Software.  See LICENSE and COPYING for details.
 
+require "highline/system_extensions"
 require "highline/question"
 require "highline/menu"
 require "erb"
@@ -27,7 +28,7 @@ require "abbrev"
 #
 class HighLine
   # The version of the installed library.
-  VERSION = "1.2.0".freeze
+  VERSION = "1.2.1".freeze
   
   # An internal HighLine error.  User code does not need to trap this.
   class QuestionError < StandardError
@@ -111,8 +112,9 @@ class HighLine
                   wrap_at = nil, page_at = nil )
     @input   = input
     @output  = output
-    @wrap_at = wrap_at
-    @page_at = page_at
+    
+    self.wrap_at = wrap_at
+    self.page_at = page_at
     
     @question = nil
     @answer   = nil
@@ -124,16 +126,12 @@ class HighLine
     @key      = nil
   end
   
-  #
-  # Set to an integer value to cause HighLine to wrap output lines at the
-  # indicated character limit.  When +nil+, the default, no wrapping occurs.
-  #
-  attr_accessor :wrap_at
-  #
-  # Set to an integer value to cause HighLine to page output lines over the
-  # indicated line limit.  When +nil+, the default, no paging occurs.
-  #
-  attr_accessor :page_at
+  include HighLine::SystemExtensions
+  
+  # The current column setting for wrapping output.
+  attr_reader :wrap_at
+  # The current row setting for paging output.
+  attr_reader :page_at
   
   #
   # A shortcut to HighLine.ask() a question that only accepts "yes" or "no"
@@ -414,6 +412,48 @@ class HighLine
     end
   end
   
+  #
+  # Set to an integer value to cause HighLine to wrap output lines at the
+  # indicated character limit.  When +nil+, the default, no wrapping occurs.  If
+  # set to <tt>:auto</tt>, HighLine will attempt to determing the columns
+  # available for the <tt>@output</tt> or use a sensible default.
+  #
+  def wrap_at=( setting )
+    @wrap_at = setting == :auto ? output_cols : setting
+  end
+  
+  #
+  # Set to an integer value to cause HighLine to page output lines over the
+  # indicated line limit.  When +nil+, the default, no paging occurs.  If
+  # set to <tt>:auto</tt>, HighLine will attempt to determing the rows available
+  # for the <tt>@output</tt> or use a sensible default.
+  #
+  def page_at=( setting )
+    @page_at = setting == :auto ? output_rows : setting
+  end
+  
+  # 
+  # Returns the number of columns for the console, or a default it they cannot
+  # be determined.
+  # 
+  def output_cols
+    return 80 unless @output.tty?
+    terminal_size.first
+  rescue
+    return 80
+  end
+  
+  # 
+  # Returns the number of rows for the console, or a default if they cannot be
+  # determined.
+  # 
+  def output_rows
+    return 24 unless @output.tty?
+    terminal_size.last
+  rescue
+    return 24
+  end
+  
   private
   
   #
@@ -475,69 +515,6 @@ class HighLine
     
     @answers
   end
-  
-  #
-  # This section builds a character reading function to suit the proper
-  # platform we're running on.  Be warned:  Here be dragons!
-  #
-  begin
-    require "Win32API"       # See if we're on Windows.
-
-    CHARACTER_MODE = "Win32API"    # For Debugging purposes only.
-
-    #
-    # Windows savvy getc().
-    # 
-    # *WARNING*:  This method ignores <tt>@input</tt> and reads one
-    # character from +STDIN+!
-    # 
-    def get_character
-      Win32API.new("crtdll", "_getch", [ ], "L").Call
-    end
-  rescue LoadError             # If we're not on Windows try...
-    begin
-      require "termios"    # Unix, first choice.
-    
-      CHARACTER_MODE = "termios"    # For Debugging purposes only.
-
-      #
-      # Unix savvy getc().  (First choice.)
-      # 
-      # *WARNING*:  This method requires the "termios" library!
-      # 
-      def get_character
-        old_settings = Termios.getattr(@input)
-
-        new_settings         =  old_settings.dup
-        new_settings.c_lflag &= ~(Termios::ECHO | Termios::ICANON)
-    
-        begin
-          Termios.setattr(@input, Termios::TCSANOW, new_settings)
-          @input.getc
-        ensure
-          Termios.setattr(@input, Termios::TCSANOW, old_settings)
-        end
-      end
-    rescue LoadError         # If our first choice fails, default.
-      CHARACTER_MODE = "stty"    # For Debugging purposes only.
-
-      #
-      # Unix savvy getc().  (Second choice.)
-      # 
-      # *WARNING*:  This method requires the external "stty" program!
-      # 
-      def get_character
-        state = `stty -g`
-        
-        begin
-          system "stty raw -echo cbreak"
-          @input.getc
-        ensure
-          system "stty #{state}"
-        end
-      end
-    end
-  end
 
   #
   # Read a line of input from the input stream and process whitespace as
@@ -596,7 +573,7 @@ class HighLine
         get_line
       else
         line = ""
-        while character = get_character
+        while character = get_character(@input)
           line << character.chr
           # looking for carriage return (decimal 13) or
           # newline (decimal 10) in raw input
@@ -610,7 +587,7 @@ class HighLine
     elsif @question.character == :getc
       @question.change_case(@input.getc.chr)
     else
-      response = get_character.chr
+      response = get_character(@input).chr
       echo = if @question.echo == true
         response
       elsif @question.echo != false
@@ -636,7 +613,7 @@ class HighLine
     while lines.size > @page_at
       @output.puts lines.slice!(0...@page_at).join
       @output.puts
-      ask("-- press enter/return to continue -- ")
+      HighLine.new(@input, @output).ask("-- press enter/return to continue -- ")
       @output.puts
     end
     return lines.join
@@ -666,6 +643,10 @@ class HighLine
     return wrapped.join
   end
   
+  # 
+  # Returns the length of the passed +string_with_escapes+, minus and color
+  # sequence escapes.
+  # 
   def actual_length( string_with_escapes )
     string_with_escapes.gsub(/\e\[\d{1,2}m/, "").length
   end

data/lib/highline/import.rb

@@ -5,7 +5,7 @@
 #  Created by James Edward Gray II on 2005-04-26.
 #  Copyright 2005 Gray Productions. All rights reserved.
 #
-#  This is Free Software.  See LICENSE and COPYING for details
+#  This is Free Software.  See LICENSE and COPYING for details.
 
 require "highline"
 require "forwardable"

data/lib/highline/menu.rb

@@ -5,7 +5,7 @@
 #  Created by Gregory Thomas Brown on 2005-05-10.
 #  Copyright 2005. All rights reserved.
 #
-#  This is Free Software.  See LICENSE and COPYING for details
+#  This is Free Software.  See LICENSE and COPYING for details.
 
 require "highline/question"
 

data/lib/highline/question.rb

@@ -5,7 +5,7 @@
 #  Created by James Edward Gray II on 2005-04-26.
 #  Copyright 2005 Gray Productions. All rights reserved.
 #
-#  This is Free Software.  See LICENSE and COPYING for details 
+#  This is Free Software.  See LICENSE and COPYING for details.
  
 require "optparse"
 require "date"

data/lib/highline/system_extensions.rb

@@ -0,0 +1,103 @@
+#!/usr/local/bin/ruby -w
+
+# import.rb
+#
+#  Created by James Edward Gray II on 2006-06-14.
+#  Copyright 2006 Gray Productions. All rights reserved.
+#
+#  This is Free Software.  See LICENSE and COPYING for details.
+
+class HighLine
+  module SystemExtensions
+    module_function
+    
+    #
+    # This section builds character reading and terminal size functions
+    # to suit the proper platform we're running on.  Be warned:  Here be
+    # dragons!
+    #
+    begin
+      require "Win32API"       # See if we're on Windows.
+
+      CHARACTER_MODE = "Win32API"    # For Debugging purposes only.
+
+      #
+      # 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
+      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)
+        
+        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
+    rescue LoadError             # If we're not on Windows try...
+      begin
+        require "termios"    # Unix, first choice.
+
+        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)
+
+          new_settings         =  old_settings.dup
+          new_settings.c_lflag &= ~(Termios::ECHO | Termios::ICANON)
+
+          begin
+            Termios.setattr(input, Termios::TCSANOW, new_settings)
+            input.getc
+          ensure
+            Termios.setattr(input, Termios::TCSANOW, old_settings)
+          end
+        end
+      rescue LoadError         # If our first choice fails, default.
+        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 )
+          state = `stty -g`
+
+          begin
+            system "stty raw -echo cbreak"
+            input.getc
+          ensure
+            system "stty #{state}"
+          end
+        end
+      end
+      
+      # A Unix savvy method to fetch the console columns, and rows.
+      def terminal_size
+       `stty size`.split.map { |x| x.to_i }.reverse
+      end
+    end
+  end
+end

data/test/tc_highline.rb

@@ -12,6 +12,15 @@ require "test/unit"
 require "highline"
 require "stringio"
 
+if HighLine::CHARACTER_MODE == "Win32API"
+  class HighLine
+    # Override Windows' character reading so it's not tied to STDIN.
+    def get_character( input = STDIN )
+      input.getc
+    end
+  end
+end
+
 class TestHighLine < Test::Unit::TestCase
   def setup
     @input    = StringIO.new
@@ -374,9 +383,7 @@ class TestHighLine < Test::Unit::TestCase
   end
   
   def test_mode
-    # *WARNING*:  These tests wil only complete is "stty" mode!
-    assert_equal( "stty", HighLine::CHARACTER_MODE,
-                  "Tests require \"stty\" mode." )
+    assert(%w[Win32API termios stty].include?(HighLine::CHARACTER_MODE))
   end
   
   class NameClass

data/test/tc_menu.rb

@@ -395,4 +395,15 @@ class TestMenu < Test::Unit::TestCase
     end
     assert_equal(:quit, selected)
   end
+
+  def test_paged_print_infinite_loop_bug
+    @terminal.page_at = 5
+    # Will page twice, so start with two new lines
+    @input << "\n\n3\n"
+    @input.rewind
+  
+    # Sadly this goes into an infinite loop without the fix to page_print    
+    selected = @terminal.choose(* 1..10) 
+    assert_equal(selected, 3)
+  end
 end

data/test/ts_all.rb

@@ -6,6 +6,7 @@
 #  Copyright 2005 Gray Productions. All rights reserved.
 #
 #  This is Free Software.  See LICENSE and COPYING for details.
+
 require "test/unit"
 
 require "tc_highline"

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: highline
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
-date: 2006-03-22 00:00:00 -06:00
+  version: 1.2.1
+date: 2006-06-14 00:00:00 -05:00
 summary: HighLine is a high-level command-line IO library.
 require_paths: 
 - lib
@@ -12,7 +12,7 @@ email: james@grayproductions.net
 homepage: http://highline.rubyforge.org
 rubyforge_project: highline
 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.
-autorequire: highline
+autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -40,6 +40,7 @@ files:
 - lib/highline/import.rb
 - lib/highline/menu.rb
 - lib/highline/question.rb
+- lib/highline/system_extensions.rb
 - test/tc_highline.rb
 - test/tc_import.rb
 - test/tc_menu.rb