highline 1.6.1 → 1.6.14

data/site/.cvsignore

@@ -0,0 +1 @@
+.DS_Store

data/site/highline.css

@@ -0,0 +1,65 @@
+body {
+  margin: 0;
+  padding: 0;
+  text-align: center;
+  background: #abc;
+  font: 13px Trebuchet MS, Lucida Sans Unicode, Arial, sans-serif;
+}
+
+#container {
+  margin: 0 auto;
+  margin-top: 10px;
+  position: relative;
+  width: 785px;
+  background: #fff repeat;
+  padding-top: 20px;
+}
+
+#container #header {
+  padding-top: 20px;
+  height: 141px;
+  width:  785px;
+  background: url(images/logo.png) center no-repeat;
+}
+
+#container #content {
+  text-align: left;
+  margin-left: 230px;
+  width: 500px;
+}
+
+#container #sidebar {
+  text-align: left;
+  position: absolute;
+  top: 181px;
+  left: 0;
+  width: 170px;
+  margin-right: 25px;
+}
+
+#container #footer {
+  font: 9px Arial;
+  padding: 4px;
+  border-top: 1px solid;
+  color: #aaa;
+}
+
+ul {
+  list-style: none;
+}
+
+li {
+  border-bottom: 1px solid #e8e8e8;
+  padding-top: 10px;
+}
+
+a {
+  text-decoration: none;
+  color: #15528a;
+}
+
+pre {
+  padding: 5px;
+  padding-left: 20px;
+  font: 11px Courier;
+}

data/site/index.html

@@ -0,0 +1,58 @@
+<html>
+  <head>
+    <title> HighLine </title>
+    <style type="text/css"> @import url(highline.css); </style>
+  </head>
+  <body>
+    <div id="container">
+      <div id="header"></div>
+      <div id="content">
+        <h2>HighLine is about&#8230;</h2>
+
+
+	<h3>Saving time.</h3>
+
+
+	<p>Command line interfaces are meant to be easy.  So why shouldn&#8217;t building
+them be easy, too?  HighLine provides a solid toolset to help you get
+the job done cleanly so you can focus on the real task at hand, 
+<em>your task.</em></p>
+
+
+	<h3>Clean and intuitive design.</h3>
+
+
+	<p>Want to get a taste for how HighLine is used?  Take a look at this simple
+example, which asks a user for a zip code, automatically does validation,
+and returns the result:</p>
+
+
+	<pre><code>zip = ask("Zip?  ") { |q| q.validate = /\A\d{5}(?:-?\d{4})?\Z/ }</code></pre>
+
+
+	<h3>Hassle-free Installation.</h3>
+
+
+	<p>Installation is easy via RubyGems.  Simply enter the command:</p>
+
+
+	<pre><code>sudo gem install highline</code></pre>
+
+
+	<p>and you&#8217;ll be on your way! Of course, manual installation is an option,
+too.</p>
+      </div>
+      <div id="sidebar">
+        <ul>
+	<li><a href="http://rubyforge.org/projects/highline">Project Page</a></li>
+		<li><a href="http://highline.rubyforge.org/doc">Documentation</a></li>
+		<li><a href="https://github.com/JEG2/highline">Source</a></li>
+		<li><a href="mailto:james@grayproductions.net">Contact</a></li>
+	</ul>
+      </div>
+      <div id="footer">
+      Created by James Edward Gray II and Gregory Brown
+      </div>
+    </div>
+  </body>
+</html>

data/test/string_methods.rb

@@ -0,0 +1,32 @@
+# string_methods.rb
+#
+#  Created by Richard LeBer 2011-06-27
+#
+#  This is Free Software.  See LICENSE and COPYING for details.
+#
+#  String class convenience methods
+
+module StringMethods  
+  def test_color
+    assert_equal("\e[34mstring\e[0m", @string.color(:blue))
+    assert_equal("\e[1m\e[47mstring\e[0m", @string.color(:bold,:on_white))
+    assert_equal("\e[45mstring\e[0m", @string.on(:magenta))
+    assert_equal("\e[36mstring\e[0m", @string.cyan)
+    assert_equal("\e[41m\e[5mstring\e[0m\e[0m", @string.blink.on_red)
+    assert_equal("\e[38;5;137mstring\e[0m", @string.color(:rgb_906030))
+    assert_equal("\e[38;5;101mstring\e[0m", @string.rgb('606030'))
+    assert_equal("\e[38;5;107mstring\e[0m", @string.rgb('60','90','30'))
+    assert_equal("\e[38;5;107mstring\e[0m", @string.rgb(96,144,48))
+    assert_equal("\e[38;5;173mstring\e[0m", @string.rgb_c06030)
+    assert_equal("\e[48;5;137mstring\e[0m", @string.color(:on_rgb_906030))
+    assert_equal("\e[48;5;101mstring\e[0m", @string.on_rgb('606030'))
+    assert_equal("\e[48;5;107mstring\e[0m", @string.on_rgb('60','90','30'))
+    assert_equal("\e[48;5;107mstring\e[0m", @string.on_rgb(96,144,48))
+    assert_equal("\e[48;5;173mstring\e[0m", @string.on_rgb_c06030)
+  end
+  
+  def test_uncolor
+    colored_string = HighLine::String("\e[38;5;137mstring\e[0m")
+    assert_equal "string", colored_string.uncolor
+  end
+end

data/test/tc_color_scheme.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_color_scheme.rb
 #
 #  Created by Jeremy Hinegardner on 2007-01-24.  
@@ -46,6 +44,48 @@ class TestColorScheme < Test::Unit::TestCase
     @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
+    
+    # Check that keys are available, and as expected
+    assert_equal ["critical", "error", "warning", "notice", "info", "debug", "row_even", "row_odd"].sort,
+                 HighLine.color_scheme.keys.sort
+    
+    # Color scheme doesn't care if we use symbols or strings, and is case-insensitive
+    warning1 = HighLine.color_scheme[:warning]
+    warning2 = HighLine.color_scheme["warning"]
+    warning3 = HighLine.color_scheme[:wArning]
+    warning4 = HighLine.color_scheme["warniNg"]
+    assert_instance_of HighLine::Style, warning1
+    assert_instance_of HighLine::Style, warning2
+    assert_instance_of HighLine::Style, warning3
+    assert_instance_of HighLine::Style, warning4
+    assert_equal warning1, warning2
+    assert_equal warning1, warning3
+    assert_equal warning1, warning4
+
+    # Nonexistent keys return nil
+    assert_nil HighLine.color_scheme[:nonexistent]
+    
+    # Same as above, for definitions
+    defn1 = HighLine.color_scheme.definition(:warning)
+    defn2 = HighLine.color_scheme.definition("warning")
+    defn3 = HighLine.color_scheme.definition(:wArning)
+    defn4 = HighLine.color_scheme.definition("warniNg")
+    assert_instance_of Array, defn1
+    assert_instance_of Array, defn2
+    assert_instance_of Array, defn3
+    assert_instance_of Array, defn4
+    assert_equal [:bold, :yellow], defn1
+    assert_equal [:bold, :yellow], defn2
+    assert_equal [:bold, :yellow], defn3
+    assert_equal [:bold, :yellow], defn4
+    assert_nil HighLine.color_scheme.definition(:nonexistent)
+    
+    color_scheme_hash = HighLine.color_scheme.to_hash
+    assert_instance_of Hash, color_scheme_hash
+    assert_equal ["critical", "error", "warning", "notice", "info", "debug", "row_even", "row_odd"].sort,
+                 color_scheme_hash.keys.sort
+    assert_instance_of Array, HighLine.color_scheme.definition(:warning)
+    assert_equal [:bold, :yellow], HighLine.color_scheme.definition(:warning)
 
     # turn it back off, should raise an exception
     HighLine.color_scheme = @old_color_scheme

data/test/tc_highline.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_highline.rb
 #
 #  Created by James Edward Gray II on 2005-04-26.
@@ -62,6 +60,16 @@ class TestHighLine < Test::Unit::TestCase
     assert_raise(EOFError) { @terminal.ask("Any input left?  ") }
   end
   
+  def test_ask_string
+    name = "James Edward Gray II"
+    @input << name << "\n"
+    @input.rewind
+
+    assert_equal(name, @terminal.ask("What is your name?  ", String))
+
+    assert_raise(EOFError) { @terminal.ask("Any input left?  ", String) }
+  end
+  
   def test_bug_fixes
     # auto-complete bug
     @input << "ruby\nRuby\n"
@@ -198,6 +206,28 @@ class TestHighLine < Test::Unit::TestCase
 
     @output.truncate(@output.rewind)
 
+    @terminal.say("This should be <%= NONE %>none<%= CLEAR %>!")
+    assert_equal("This should be \e[38mnone\e[0m!\n", @output.string)
+
+    @output.truncate(@output.rewind)
+
+    @terminal.say("This should be <%= RGB_906030 %>rgb_906030<%= CLEAR %>!")
+    assert_equal("This should be \e[38;5;137mrgb_906030\e[0m!\n", @output.string)
+
+    @output.truncate(@output.rewind)
+
+    @terminal.say("This should be <%= ON_RGB_C06030 %>on_rgb_c06030<%= CLEAR %>!")
+    assert_equal("This should be \e[48;5;173mon_rgb_c06030\e[0m!\n", @output.string)
+
+    @output.truncate(@output.rewind)
+    
+    # Does class method work, too?
+    @terminal.say("This should be <%= HighLine.color('reverse underlined magenta', :reverse, :underline, :magenta) %>!")
+    assert_equal( "This should be \e[7m\e[4m\e[35mreverse underlined magenta\e[0m!\n",
+                  @output.string )
+
+    @output.truncate(@output.rewind)
+
     # turn off color
     old_setting = HighLine.use_color?
     assert_nothing_raised(Exception) { HighLine.use_color = false }
@@ -205,6 +235,27 @@ class TestHighLine < Test::Unit::TestCase
     assert_equal("This should be cyan!\n", @output.string)
     HighLine.use_color = old_setting
   end
+
+  def test_uncolor
+    # instance method
+    assert_equal( "This should be reverse underlined magenta!\n",
+                  @terminal.uncolor("This should be \e[7m\e[4m\e[35mreverse underlined magenta\e[0m!\n") 
+                )
+
+    @output.truncate(@output.rewind)
+
+    # class method
+    assert_equal( "This should be reverse underlined magenta!\n",
+                  HighLine.uncolor("This should be \e[7m\e[4m\e[35mreverse underlined magenta\e[0m!\n") 
+                )
+
+    @output.truncate(@output.rewind)
+
+    # RGB color
+    assert_equal( "This should be rgb_906030!\n",
+                  @terminal.uncolor("This should be \e[38;5;137mrgb_906030\e[0m!\n") 
+                )
+  end
                                   
   def test_confirm
     @input << "junk.txt\nno\nsave.txt\ny\n"
@@ -257,7 +308,19 @@ class TestHighLine < Test::Unit::TestCase
     assert_equal( "Are you sexually active?  |No Comment|  ",
                   @output.string )
   end
-  
+
+  def test_string_preservation
+    @input << "Maybe\nYes\n"
+    @input.rewind
+
+    my_string = "Is that your final answer? "
+
+    @terminal.ask(my_string) { |q| q.default = "Possibly" }
+    @terminal.ask(my_string) { |q| q.default = "Maybe" }
+
+    assert_equal("Is that your final answer? ", my_string)
+  end
+
   def test_empty
     @input << "\n"
     @input.rewind
@@ -284,14 +347,15 @@ class TestHighLine < Test::Unit::TestCase
   def test_files
     @input << "#{File.basename(__FILE__)[0, 5]}\n"
     @input.rewind
+    
+    assert_equal "tc_hi\n",@input.read
+    @input.rewind
 
     file = @terminal.ask("Select a file:  ", File) do |q|
       q.directory = File.expand_path(File.dirname(__FILE__))
       q.glob      = "*.rb"
     end
     assert_instance_of(File, file)
-    assert_equal("#!/usr/local/bin/ruby -w\n", file.gets)
-    assert_equal("\n", file.gets)
     assert_equal("# tc_highline.rb\n", file.gets)
     file.close
 
@@ -342,15 +406,72 @@ class TestHighLine < Test::Unit::TestCase
                   answers )
     assert_equal("Age:  Father's Age:  Wife's Age:  ", @output.string)
   end
-  
+
+  def test_typing_verification
+    @input << "all work and no play makes jack a dull boy\n" * 3
+    @input.rewind
+
+    answer = @terminal.ask("How's work? ") do |q|
+      q.gather = 3
+      q.verify_match = true
+    end
+    assert_equal("all work and no play makes jack a dull boy", answer)
+
+    @input.truncate(@input.rewind)
+    @input << "all play and no work makes jack a mere toy\n"
+    @input << "all work and no play makes jack a dull boy\n" * 5
+    @input.rewind
+    @output.truncate(@output.rewind)
+
+    answer = @terminal.ask("How are things going? ") do |q|
+      q.gather = 3
+      q.verify_match = true
+      q.responses[:mismatch] = 'Typing mismatch!'
+      q.responses[:ask_on_error] = ''
+    end
+    assert_equal("all work and no play makes jack a dull boy", answer)
+
+    # now try using a hash for gather
+
+    @input.truncate(@input.rewind)
+    @input << "Password\nPassword\n"
+    @input.rewind
+    @output.truncate(@output.rewind)
+
+    answer = @terminal.ask("<%= @key %>: ") do |q|
+      q.verify_match = true
+      q.gather = {"Enter a password" => '', "Please type it again" => ''}
+    end
+    assert_equal("Password", answer)
+
+    @input.truncate(@input.rewind)
+    @input << "Password\nMistake\nPassword\nPassword\n"
+    @input.rewind
+    @output.truncate(@output.rewind)
+
+    answer = @terminal.ask("<%= @key %>: ") do |q|
+      q.verify_match = true
+      q.responses[:mismatch] = 'Typing mismatch!'
+      q.responses[:ask_on_error] = ''
+      q.gather = {"Enter a password" => '', "Please type it again" => ''}
+    end
+
+    assert_equal("Password", answer)
+    assert_equal( "Enter a password: " +
+                  "Please type it again: " +
+                  "Typing mismatch!\n" +
+                  "Enter a password: " +
+                  "Please type it again: ", @output.string )
+  end
+
   def test_lists
     digits     = %w{Zero One Two Three Four Five Six Seven Eight Nine}
     erb_digits = digits.dup
     erb_digits[erb_digits.index("Five")] = "<%= color('Five', :blue) %%>"
-    
+
     @terminal.say("<%= list(#{digits.inspect}) %>")
     assert_equal(digits.map { |d| "#{d}\n" }.join, @output.string)
-    
+
     @output.truncate(@output.rewind)
 
     @terminal.say("<%= list(#{digits.inspect}, :inline) %>")
@@ -368,7 +489,7 @@ class TestHighLine < Test::Unit::TestCase
     @terminal.say("<%= list(#{digits.inspect}, :columns_down, 3) %>")
     assert_equal( "Zero   Four   Eight\n" +
                   "One    Five   Nine \n" +
-                  "Two    Six  \n" +
+                  "Two    Six  \n"        +
                   "Three  Seven\n",
                   @output.string )
 
@@ -387,7 +508,7 @@ class TestHighLine < Test::Unit::TestCase
 
     @terminal.say("<%= list(#{colums_of_twenty.inspect}, :columns_down) %>")
     assert_equal( "12345678901234567890  12345678901234567890  " +
-                  "12345678901234567890\n" +
+                  "12345678901234567890\n"                       +
                   "12345678901234567890  12345678901234567890\n",
                   @output.string )
 
@@ -409,6 +530,89 @@ class TestHighLine < Test::Unit::TestCase
                   "12345678901234567890\n" +
                   "12345678901234567890\n",
                   @output.string )
+
+    @output.truncate(@output.rewind)
+    
+    wide = %w[0123456789 a b c d e f g h i j k l m n o p q r s t u v w x y z]
+
+    @terminal.say("<%= list( #{wide.inspect}, :uneven_columns_across ) %>")
+    assert_equal( "0123456789  a  b  c  d  e  f  g  h  i  j  k  l  m  n  o  " +
+                  "p  q  r  s  t  u  v  w\n"                                  +
+                  "x           y  z\n",
+                  @output.string )
+
+    @output.truncate(@output.rewind)
+
+    @terminal.say("<%= list( #{wide.inspect}, :uneven_columns_across, 10 ) %>")
+    assert_equal( "0123456789  a  b  c  d  e  f  g  h  i\n" +
+                  "j           k  l  m  n  o  p  q  r  s\n" +
+                  "t           u  v  w  x  y  z\n",
+                  @output.string )
+
+    @output.truncate(@output.rewind)
+
+    @terminal.say("<%= list( #{wide.inspect}, :uneven_columns_down ) %>")
+    assert_equal( "0123456789  b  d  f  h  j  l  n  p  r  t  v  x  z\n" +
+                  "a           c  e  g  i  k  m  o  q  s  u  w  y\n",
+                  @output.string )
+
+    @output.truncate(@output.rewind)
+
+    @terminal.say("<%= list( #{wide.inspect}, :uneven_columns_down, 10 ) %>")
+    assert_equal( "0123456789  c  f  i  l  o  r  u  x\n" +
+                  "a           d  g  j  m  p  s  v  y\n" +
+                  "b           e  h  k  n  q  t  w  z\n",
+                  @output.string )
+  end
+  
+  def test_lists_with_zero_items
+    modes = [nil, :rows, :inline, :columns_across, :columns_down]
+    modes.each do |mode|
+      result = @terminal.list([], mode)
+      assert_equal("", result)
+    end
+  end
+  
+  def test_lists_with_one_item
+    items = ['Zero']
+    modes = { nil            => "Zero\n",
+             :rows           => "Zero\n",
+             :inline         => "Zero",
+             :columns_across => "Zero\n",
+             :columns_down   => "Zero\n" }
+             
+    modes.each do |mode, expected|
+      result = @terminal.list(items, mode)
+      assert_equal(expected, result)
+    end
+  end
+  
+  def test_lists_with_two_items
+    items = ['Zero', 'One']
+    modes = { nil            => "Zero\nOne\n",
+             :rows           => "Zero\nOne\n",
+             :inline         => "Zero or One",
+             :columns_across => "Zero  One \n",
+             :columns_down   => "Zero  One \n" }
+             
+    modes.each do |mode, expected|
+      result = @terminal.list(items, mode)
+      assert_equal(expected, result)
+    end
+  end
+  
+  def test_lists_with_three_items
+    items = ['Zero', 'One', 'Two']
+    modes = { nil            => "Zero\nOne\nTwo\n",
+             :rows           => "Zero\nOne\nTwo\n",
+             :inline         => "Zero, One or Two",
+             :columns_across => "Zero  One   Two \n",
+             :columns_down   => "Zero  One   Two \n" }
+
+    modes.each do |mode, expected|
+      result = @terminal.list(items, mode)
+      assert_equal(expected, result)
+    end
   end
   
   def test_mode
@@ -818,6 +1022,6 @@ class TestHighLine < Test::Unit::TestCase
     assert_not_nil(HighLine::VERSION)
     assert_instance_of(String, HighLine::VERSION)
     assert(HighLine::VERSION.frozen?)
-    assert_match(/\A\d\.\d\.\d\Z/, HighLine::VERSION)
+    assert_match(/\A\d+\.\d+\.\d+\Z/, HighLine::VERSION)
   end
 end

data/test/tc_import.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_import.rb
 #
 #  Created by James Edward Gray II on 2005-04-26.

data/test/tc_menu.rb

@@ -1,5 +1,3 @@
-#!/usr/local/bin/ruby -w
-
 # tc_menu.rb
 #
 #  Created by Gregory Thomas Brown on 2005-05-10.

data/test/tc_string_extension.rb

@@ -0,0 +1,20 @@
+# tc_string_extension.rb
+#
+#  Created by Richard LeBer 2011-06-27
+#
+#  This is Free Software.  See LICENSE and COPYING for details.
+
+require "test/unit"
+
+require "highline"
+require "stringio"
+require "string_methods"
+
+class TestStringExtension < Test::Unit::TestCase
+  def setup
+    HighLine.colorize_strings
+    @string = "string"
+  end
+
+  include StringMethods
+end

data/test/tc_string_highline.rb

@@ -0,0 +1,38 @@
+# tc_highline_string.rb
+#
+#  Created by Richard LeBer 2011-06-27
+#
+#  This is Free Software.  See LICENSE and COPYING for details.
+
+require "test/unit"
+
+require "highline"
+require "stringio"
+require "string_methods"
+
+class TestHighLineString < Test::Unit::TestCase
+  def setup
+    @string = HighLine::String.new("string")
+  end
+
+  def test_string_class
+    # Basic constructor
+    assert_equal HighLine::String, @string.class
+    assert_equal "string", @string
+    
+    # Alternative constructor method
+    new_string = HighLine::String("string")
+    assert_equal HighLine::String, new_string.class
+    assert_equal @string, new_string
+    
+    # String methods work
+    assert_equal 6, @string.size
+    assert_equal "STRING", @string.upcase
+  end
+
+  include StringMethods
+  
+  def test_string_class_is_unchanged
+    assert_raise(::NoMethodError) { "string".color(:blue) }
+  end
+end