highline 1.2.5 → 1.2.6

data/CHANGELOG

@@ -2,6 +2,14 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+== 1.2.6
+
+Patch by Jeremy Hinegardner:
+
+* Added ColorScheme support.
+* Added HighLine::Question.overwrite mode.
+* Various documentation fixes.
+
 == 1.2.5
 
 * Really fixed the bug I tried to fix in 1.2.4.

data/README

@@ -60,4 +60,4 @@ See the INSTALL file for instructions.
 == Questions and/or Comments
 
 Feel free to email {James Edward Gray II}[mailto:james@grayproductions.net] or
-{Grregory Brown}[mailto:gregory.t.brown@gmail.com] with any questions.
+{Gregory Brown}[mailto:gregory.t.brown@gmail.com] with any questions.

data/examples/color_scheme.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby -w
+
+# color_scheme.rb
+# 
+#  Created by Jeremy Hinegardner on 2007-01-24
+#  Copyright 2007 Jeremy Hinegardner.  All rights reserved 
+
+require 'rubygems'
+require 'highline/import'
+
+# Create a color scheme, naming color patterns with symbol names.
+ft = HighLine::ColorScheme.new do |cs|
+        cs[:headline]        = [ :bold, :yellow, :on_black ]
+        cs[:horizontal_line] = [ :bold, :white, :on_blue]
+        cs[:even_row]        = [ :green ]
+        cs[:odd_row]         = [ :magenta ]
+     end
+
+# Assign that color scheme to HighLine...
+HighLine.color_scheme = ft
+
+# ...and use it.
+say("<%= color('Headline', :headline) %>")
+say("<%= color('-'*20, :horizontal_line) %>")
+
+# Setup a toggle for rows.
+i = true
+("A".."D").each do |row|
+    row_color = i ? :even_row : :odd_row
+    say("<%= color('#{row}', '#{row_color}') %>")
+    i = !i
+end

data/examples/overwrite.rb

@@ -0,0 +1,19 @@
+#!/usr/local/bin/ruby -w
+
+# overwrite.rb
+# 
+#  Created by Jeremy Hinegardner on 2007-01-24
+#  Copyright 2007 Jeremy Hinegardner.  All rights reserved 
+
+require 'rubygems'
+require 'highline/import'
+
+prompt = "here is your password:"
+ask(
+  "#{prompt} <%= color('mypassword', RED, BOLD) %> (Press Any Key to blank) "
+) do |q|
+    q.overwrite = true
+    q.echo      = false  # overwrite works best when echo is false.
+    q.character = true   # if this is set to :getc then overwrite does not work
+end
+say("<%= color('Look! blanked out!', GREEN) %>")

data/lib/highline.rb

@@ -12,6 +12,7 @@
 require "highline/system_extensions"
 require "highline/question"
 require "highline/menu"
+require "highline/color_scheme"
 require "erb"
 require "optparse"
 require "stringio"
@@ -28,7 +29,7 @@ require "abbrev"
 #
 class HighLine
   # The version of the installed library.
-  VERSION = "1.2.5".freeze
+  VERSION = "1.2.6".freeze
   
   # An internal HighLine error.  User code does not need to trap this.
   class QuestionError < StandardError
@@ -48,6 +49,24 @@ class HighLine
     @@use_color
   end
 
+  # The setting used to control color schemes.
+  @@color_scheme = nil
+
+  # Pass ColorScheme to _setting_ to turn set a HighLine color scheme.
+  def self.color_scheme=( setting )
+    @@color_scheme = setting
+  end
+
+  # Returns the current color scheme.
+  def self.color_scheme
+    @@color_scheme
+  end
+
+  # Returns +true+ if HighLine is currently using a color scheme.
+  def self.using_color_scheme?
+    not @@color_scheme.nil?
+  end
+
   #
   # Embed in a String to clear all previous ANSI sequences.  This *MUST* be 
   # done before the program exits!
@@ -55,6 +74,8 @@ class HighLine
   CLEAR      = "\e[0m"
   # An alias for CLEAR.
   RESET      = CLEAR
+  # Erase the current line of terminal output.
+  ERASE_LINE = "\e[K" 
   # The start of an ANSI bold sequence.
   BOLD       = "\e[1m"
   # The start of an ANSI dark sequence.  (Terminal support uncommon.)
@@ -287,13 +308,15 @@ class HighLine
     return string unless self.class.use_color?
     
     colors.map! do |c|
-      if c.is_a?(Symbol)
+      if self.class.using_color_scheme? and self.class.color_scheme.include? c
+        self.class.color_scheme[c]
+      elsif c.is_a? Symbol
         self.class.const_get(c.to_s.upcase)
       else
         c
       end
     end
-    "#{colors.join}#{string}#{CLEAR}"
+    "#{colors.flatten.join}#{string}#{CLEAR}"
   end
   
   # 
@@ -584,7 +607,12 @@ class HighLine
                      (@question.limit and line.size == @question.limit)
             @output.print(@question.echo) if @question.echo != false
           end
-          say("\n")
+          if @question.overwrite
+            @output.print("\r#{ERASE_LINE}")
+            @output.flush
+          else
+            say("\n")
+          end
         ensure
           restore_mode if stty
         end
@@ -595,14 +623,19 @@ class HighLine
       @question.change_case(@input.getc.chr)
     else
       response = get_character(@input).chr
-      echo = if @question.echo == true
-        response
-      elsif @question.echo != false
-        @question.echo
+      if @question.overwrite
+        @output.print("\r#{ERASE_LINE}")
+        @output.flush
       else
-        ""
+        echo = if @question.echo == true
+          response
+        elsif @question.echo != false
+          @question.echo
+        else
+          ""
+        end
+        say("#{echo}\n")
       end
-      say("#{echo}\n")
       @question.change_case(response)
     end
   end

data/lib/highline/color_scheme.rb

@@ -0,0 +1,120 @@
+#!/usr/local/bin/ruby -w
+
+# color_scheme.rb
+#
+# Created by Jeremy Hinegardner on 2007-01-24
+# Copyright 2007.  All rights reserved
+#
+# 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
+  # HighLine.colors() method call.  For example, by applying a ColorScheme that
+  # has a <tt>:warning</tt> color then the following could be used:
+  #
+  #   colors("This is a warning", :warning)
+  #
+  # A ColorScheme contains named sets of HighLine color constants. 
+  #
+  # Example: Instantiating a color scheme, applying it to HighLine,
+  #          and using it:
+  #
+  #   ft = HighLine::ColorScheme.new do |cs|
+  #          cs[:headline]        = [ :bold, :yellow, :on_black ]
+  #          cs[:horizontal_line] = [ :bold, :white ]
+  #          cs[:even_row]        = [ :green ]
+  #          cs[:odd_row]         = [ :magenta ]
+  #        end 
+  #
+  #   HighLine.color_scheme = ft
+  #   say("<%= color('Headline', :headline) %>")
+  #   say("<%= color('-'*20, :horizontal_line) %>")
+  #   i = true
+  #   ("A".."D").each do |row|
+  #      if i then
+  #        say("<%= color('#{row}', :even_row ) %>")
+  #      else
+  #        say("<%= color('#{row}', :odd_row) %>")
+  #      end 
+  #      i = !i
+  #   end
+  #
+  #
+  class ColorScheme 
+    #
+    # Create an instance of HighLine::ColorScheme. The customization can
+    # happen as a passed in Hash or via the yielded block.  Key's are
+    # converted to <tt>:symbols</tt> and values are converted to HighLine
+    # constants.
+    #
+    def initialize( h = nil )
+      @scheme = Hash.new
+      load_from_hash(h) unless h.nil?
+      yield self if block_given?
+    end
+
+    # Load multiple colors from key/value pairs.
+    def load_from_hash( h )
+      h.each_pair do |color_tag, constants|
+        self[color_tag] = constants
+      end
+    end
+
+    # Does this color scheme include the given tag name?
+    def include?( color_tag )
+      @scheme.keys.include?(to_symbol(color_tag))
+    end
+
+    # Allow the scheme to be accessed like a Hash.
+    def []( color_tag )
+      @scheme[to_symbol(color_tag)]
+    end
+
+    # Allow the scheme to be set like a Hash.
+    def []=( color_tag, constants )
+      @scheme[to_symbol(color_tag)] = constants.map { |c| to_constant(c) }
+    end
+
+    private
+
+    # Return a normalized representation of a color name.
+    def to_symbol( t )
+      t.to_s.downcase
+    end
+
+    # Return a normalized representation of a color setting.
+    def to_constant( v )
+      v = v.to_s if v.is_a?(Symbol)
+      if v.is_a?(String) then
+        HighLine.const_get(v.upcase)
+      else
+        v
+      end
+    end
+  end
+
+  # A sample ColorScheme.
+  class SampleColorScheme < ColorScheme
+    # 
+    # Builds the sample scheme with settings for <tt>:critical</tt>,
+    # <tt>:error</tt>, <tt>:warning</tt>, <tt>:notice</tt>, <tt>:info</tt>,
+    # <tt>:debug</tt>, <tt>:row_even</tt>, and <tt>:row_odd</tt> colors.
+    # 
+    def initialize( h = nil )
+      scheme = {
+        :critical => [ :yellow, :on_red  ],
+        :error    => [ :bold,   :red     ],
+        :warning  => [ :bold,   :yellow  ],
+        :notice   => [ :bold,   :magenta ],
+        :info     => [ :bold,   :cyan    ],
+        :debug    => [ :bold,   :green   ],
+        :row_even => [ :cyan    ],
+        :row_odd  => [ :magenta ]
+      }
+      super(scheme)
+    end
+  end
+end

data/lib/highline/import.rb

@@ -13,13 +13,13 @@ require "forwardable"
 $terminal = HighLine.new
 
 #
-# <tt>require "highline/import"</tt> adds shorcut methods to Kernel, making
+# <tt>require "highline/import"</tt> adds shortcut methods to Kernel, making
 # agree(), ask(), choose() and say() globally available.  This is handy for
 # quick and dirty input and output.  These methods use the HighLine object in
 # the global variable <tt>$terminal</tt>, which is initialized to used
 # <tt>$stdin</tt> and <tt>$stdout</tt> (you are free to change this).
-# Otherwise, these methods areidentical to their HighLine counterparts, see that
-# class for detailed explinations.
+# Otherwise, these methods are identical to their HighLine counterparts, see that
+# class for detailed explanations.
 #
 module Kernel
   extend Forwardable
@@ -40,4 +40,4 @@ class Object
       details.call(question) unless details.nil?
     end
   end
-end
+end

data/lib/highline/question.rb

@@ -53,6 +53,7 @@ class HighLine
       @directory    = Pathname.new(File.expand_path(File.dirname($0)))
       @glob         = "*"
       @responses    = Hash.new
+      @overwrite    = false
       
       # allow block to override settings
       yield self if block_given?
@@ -71,8 +72,8 @@ class HighLine
     # 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_ attribute for a question is ignored when using
-    # thw <tt>:getc</tt> method.
+    # *WARNING*:  The _echo_ and _overwrite_ attributes for a question are 
+    # ignored when using the <tt>:getc</tt> method.  
     # 
     attr_accessor :character
     #
@@ -193,7 +194,14 @@ class HighLine
     #                                   validation checks fail.
     #
     attr_reader :responses
-    
+    #
+    # When set to +true+ the question is asked, but output does not progress to
+    # the next line.  The Cursor is moved back to the beginning of the question
+    # line and it is cleared so that all the contents of the line disappear from
+    # the screen.
+    #
+    attr_accessor :overwrite
+   
     #
     # Returns the provided _answer_string_ or the default answer for this
     # Question if a default was set and the answer is empty.

data/test/tc_color_scheme.rb

@@ -0,0 +1,56 @@
+#!/usr/local/bin/ruby -w
+
+# tc_color_scheme.rb
+#
+#  Created by Jeremy Hinegardner on 2007-01-24.  
+#  Copyright 2007 Jeremy Hinegardner. All rights reserved.
+#
+#  This is Free Software.  See LICENSE and COPYING for details.
+
+require "test/unit"
+
+require "highline"
+require "stringio"
+
+class TestColorScheme < Test::Unit::TestCase
+  def setup
+    @input    = StringIO.new
+    @output   = StringIO.new
+    @terminal = HighLine.new(@input, @output)
+    
+    @old_color_scheme = HighLine.color_scheme
+  end
+  
+  def teardown
+    HighLine.color_scheme = @old_color_scheme
+  end
+
+  def test_using_color_scheme
+    assert_equal(false,HighLine.using_color_scheme?)
+
+    HighLine.color_scheme = HighLine::ColorScheme.new
+    assert_equal(true,HighLine.using_color_scheme?)
+  end
+
+  def test_scheme
+    HighLine.color_scheme = HighLine::SampleColorScheme.new
+
+    @terminal.say("This should be <%= color('warning yellow', :warning) %>.")
+    assert_equal("This should be \e[1m\e[33mwarning yellow\e[0m.\n",@output.string)
+    @output.rewind
+    
+    @terminal.say("This should be <%= color('warning yellow', 'warning') %>.")
+    assert_equal("This should be \e[1m\e[33mwarning yellow\e[0m.\n",@output.string)
+    @output.rewind
+
+    @terminal.say("This should be <%= color('warning yellow', 'WarNing') %>.")
+    assert_equal("This should be \e[1m\e[33mwarning yellow\e[0m.\n",@output.string)
+    @output.rewind
+
+    # turn it back off, should raise an exception
+    HighLine.color_scheme = @old_color_scheme
+    assert_raises(NameError) {
+      @terminal.say("This should be <%= color('nothing at all', :error) %>.")
+    }
+  end
+end 

data/test/ts_all.rb

@@ -12,3 +12,4 @@ require "test/unit"
 require "tc_highline"
 require "tc_import"
 require "tc_menu"
+require "tc_color_scheme"

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.1
 specification_version: 1
 name: highline
 version: !ruby/object:Gem::Version 
-  version: 1.2.5
-date: 2007-01-17 00:00:00 -06:00
+  version: 1.2.6
+date: 2007-01-25 00:00:00 -06:00
 summary: HighLine is a high-level command-line IO library.
 require_paths: 
 - lib
@@ -32,16 +32,20 @@ files:
 - examples/ansi_colors.rb
 - examples/asking_for_arrays.rb
 - examples/basic_usage.rb
+- examples/color_scheme.rb
 - examples/menus.rb
+- examples/overwrite.rb
 - examples/page_and_wrap.rb
 - examples/password.rb
 - examples/trapping_eof.rb
 - examples/using_readline.rb
 - lib/highline.rb
+- lib/highline/color_scheme.rb
 - lib/highline/import.rb
 - lib/highline/menu.rb
 - lib/highline/question.rb
 - lib/highline/system_extensions.rb
+- test/tc_color_scheme.rb
 - test/tc_highline.rb
 - test/tc_import.rb
 - test/tc_menu.rb