highline-sgonyea 1.6.12

data/INSTALL

@@ -0,0 +1,55 @@
+= Installing HighLine
+
+RubyGems is the preferred easy install method for HighLine.  However, you can
+install HighLine manually as described below.
+
+== Installing the Gem
+
+HighLine is intended to be installed via the
+RubyGems[http://rubyforge.org/projects/rubygems/] system.  To get the latest
+version, simply enter the following into your command prompt:
+
+	$ sudo gem install highline
+
+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
+{RubyForge project page}[http://rubyforge.org/frs/?group_id=683].  Navigate to
+the root project directory and enter:
+
+	$ sudo ruby setup.rb
+
+== Installing HighLine on JRuby
+
+If you are using HighLine on JRuby, many features will not work properly
+without a working ncurses installation.  First, ensure that you have
+ncurses installed and then install the ffi-ncurses gem.
+
+If ffi-ncurses fails to find your ncurses library, you may need to set the
+RUBY_FFI_NCURSES envirionment variable, i.e:  
+
+  RUBY_FFI_NCURSES_LIB=ncursesw ruby examples/hello.rb
+
+For details, see the ffi-ncurses documentation at:
+http://github.com/seanohalpin/ffi-ncurses
+
+== Using termios
+
+While not a requirement, HighLine will take advantage of the termios library if
+installed (on Unix).  This slightly improves HighLine's character reading
+capabilities and thus is recommended for all Unix users.
+
+If using the HighLine gem, you should be able to add termios as easily as:
+
+	$ sudo gem install termios
+
+For manual installs, consult the termios documentation.

data/LICENSE

@@ -0,0 +1,7 @@
+= License Terms
+
+Distributed under the user's choice of the {GPL Version 2}[http://www.gnu.org/licenses/old-licenses/gpl-2.0.html] (see COPYING for details) or the
+{Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt] by
+James Edward Gray II and Greg Brown.
+
+Please email James[mailto:james@grayproductions.net] with any questions.

data/README.rdoc

@@ -0,0 +1,63 @@
+= Read Me
+
+by James Edward Gray II
+
+== Description
+
+Welcome to HighLine.
+
+HighLine was designed to ease the tedious tasks of doing console input and
+output with low-level methods like gets() and puts().  HighLine provides a
+robust system for requesting data from a user, without needing to code all the
+error checking and validation rules and without needing to convert the typed
+Strings into what your program really needs.  Just tell HighLine what you're
+after, and let it do all the work.
+
+== Documentation
+
+See HighLine and HighLine::Question for documentation.
+
+== Examples
+
+Basic usage:
+
+  ask("Company?  ") { |q| q.default = "none" }
+
+Validation:
+
+  ask("Age?  ", Integer) { |q| q.in = 0..105 }
+  ask("Name?  (last, first)  ") { |q| q.validate = /\A\w+, ?\w+\Z/ }
+
+Type conversion for answers:
+
+  ask("Birthday?  ", Date)
+  ask("Interests?  (comma sep list)  ", lambda { |str| str.split(/,\s*/) })
+
+Reading passwords:
+
+  ask("Enter your password:  ") { |q| q.echo = false }
+  ask("Enter your password:  ") { |q| q.echo = "x" }
+
+ERb based output (with HighLine's ANSI color tools):
+
+  say("This should be <%= color('bold', BOLD) %>!")
+
+Menus:
+
+  choose do |menu|
+    menu.prompt = "Please choose your favorite programming language?  "
+  
+    menu.choice(:ruby) { say("Good choice!") }
+    menu.choices(:python, :perl) { say("Not from around here, are you?") }
+  end
+  
+For more examples see the examples/ directory of this project.
+
+== Installing
+
+See the INSTALL file for instructions.
+
+== Questions and/or Comments
+
+Feel free to email {James Edward Gray II}[mailto:james@grayproductions.net] or
+{Gregory Brown}[mailto:gregory.t.brown@gmail.com] with any questions.

data/Rakefile

@@ -0,0 +1,50 @@
+require "rdoc/task"
+require "rake/testtask"
+require "rubygems/package_task"
+
+require "rubygems"
+
+task :default => [:test]
+
+Rake::TestTask.new do |test|
+  test.libs       << "test"
+  test.test_files =  [ "test/ts_all.rb"]
+  test.verbose    =  true
+  test.ruby_opts  << "-w"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.include( "README.rdoc", "INSTALL",
+                           "TODO", "CHANGELOG",
+                           "AUTHORS", "COPYING",
+                           "LICENSE", "lib/" )
+  rdoc.main     = "README.rdoc"
+  rdoc.rdoc_dir = "doc/html"
+  rdoc.title    = "HighLine Documentation"
+end
+
+desc "Upload current documentation to Rubyforge"
+task :upload_docs => [:rdoc] do
+  sh "scp -r doc/html/* " +
+     "bbazzarrakk@rubyforge.org:/var/www/gforge-projects/highline/doc/"
+  sh "scp -r site/* " +
+     "bbazzarrakk@rubyforge.org:/var/www/gforge-projects/highline/"
+end
+
+load(File.join(File.dirname(__FILE__), "highline.gemspec"))
+Gem::PackageTask.new(SPEC) do |package|
+  # do nothing:  I just need a gem but this block is required
+end
+
+desc "Show library's code statistics"
+task :stats do
+  require 'code_statistics'
+  CodeStatistics.new( ["HighLine", "lib"], 
+                      ["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/TODO

@@ -0,0 +1,6 @@
+= To Do List
+
+The following is a list of planned expansions for HighLine, in no particular
+order.
+
+* Rent this space.

data/examples/ansi_colors.rb

@@ -0,0 +1,36 @@
+# ansi_colors.rb
+#
+#  Created by James Edward Gray II on 2005-05-03.
+#  Copyright 2005 Gray Productions. All rights reserved.
+
+require "rubygems"
+require "highline/import"
+
+# Supported color sequences.
+colors = %w{black red green yellow blue magenta cyan white}
+
+# Using color() with symbols.
+colors.each_with_index do |c, i|
+  say("This should be <%= color('#{c}', :#{c}) %>!")
+  if i == 0
+    say( "This should be " +
+         "<%= color('white on #{c}', :white, :on_#{c}) %>!")
+  else
+    say( "This should be " +
+         "<%= color( '#{colors[i - 1]} on #{c}',
+                     :#{colors[i - 1]}, :on_#{c} ) %>!")
+  end
+end
+
+# Using color with constants.
+say("This should be <%= color('bold', BOLD) %>!")
+say("This should be <%= color('underlined', UNDERLINE) %>!")
+
+# Using constants only.
+say("This might even <%= BLINK %>blink<%= CLEAR %>!")
+
+# It even works with list wrapping.
+erb_digits = %w{Zero One Two Three Four}      +
+             ["<%= color('Five', :blue) %%>"] +
+             %w{Six Seven Eight Nine}
+say("<%= list(#{erb_digits.inspect}, :columns_down, 3) %>")

data/examples/asking_for_arrays.rb

@@ -0,0 +1,16 @@
+# asking_for_arrays.rb
+#
+#  Created by James Edward Gray II on 2005-07-05.
+#  Copyright 2005 Gray Productions. All rights reserved.
+
+require "rubygems"
+require "highline/import"
+require "pp"
+
+grades = ask( "Enter test scores (or a blank line to quit):",
+              lambda { |ans| ans =~ /^-?\d+$/ ? Integer(ans) : ans} ) do |q|
+  q.gather = ""
+end
+
+say("Grades:")
+pp grades

data/examples/basic_usage.rb

@@ -0,0 +1,73 @@
+# basic_usage.rb
+#
+#  Created by James Edward Gray II on 2005-04-28.
+#  Copyright 2005 Gray Productions. All rights reserved.
+
+require "rubygems"
+require "highline/import"
+require "yaml"
+
+contacts = [ ]
+
+class NameClass
+  def self.parse( string )
+    if string =~ /^\s*(\w+),\s*(\w+)\s*$/
+      self.new($2, $1)
+    else
+      raise ArgumentError, "Invalid name format."
+    end
+  end
+
+  def initialize(first, last)
+    @first, @last = first, last
+  end
+  
+  attr_reader :first, :last
+end
+
+begin
+  entry = Hash.new
+  
+  # basic output
+  say("Enter a contact:")
+
+  # basic input
+  entry[:name]        = ask("Name?  (last, first)  ", NameClass) do |q|
+    q.validate = /\A\w+, ?\w+\Z/
+  end
+  entry[:company]     = ask("Company?  ") { |q| q.default = "none" }
+  entry[:address]     = ask("Address?  ")
+  entry[:city]        = ask("City?  ")
+  entry[:state]       = ask("State?  ") do |q|
+    q.case     = :up
+    q.validate = /\A[A-Z]{2}\Z/
+  end
+  entry[:zip]         = ask("Zip?  ") do |q|
+    q.validate = /\A\d{5}(?:-?\d{4})?\Z/
+  end
+  entry[:phone]       = ask( "Phone?  ",
+                             lambda { |p| p.delete("^0-9").
+                                            sub(/\A(\d{3})/, '(\1) ').
+                                            sub(/(\d{4})\Z/, '-\1') } ) do |q|
+    q.validate              = lambda { |p| p.delete("^0-9").length == 10 }
+    q.responses[:not_valid] = "Enter a phone numer with area code."
+  end
+  entry[:age]         = ask("Age?  ", Integer) { |q| q.in = 0..105 }
+  entry[:birthday]    = ask("Birthday?  ", Date)
+  entry[:interests]   = ask( "Interests?  (comma separated list)  ",
+                             lambda { |str| str.split(/,\s*/) } )
+  entry[:description] = ask("Enter a description for this contact.") do |q|
+    q.whitespace = :strip_and_collapse
+  end
+
+  contacts << entry
+# shortcut for yes and no questions
+end while agree("Enter another contact?  ", true)
+
+if agree("Save these contacts?  ", true)
+  file_name = ask("Enter a file name:  ") do |q|
+    q.validate = /\A\w+\Z/
+    q.confirm  = true
+  end
+  File.open("#{file_name}.yaml", "w") { |file| YAML.dump(contacts, file) }
+end

data/examples/color_scheme.rb

@@ -0,0 +1,30 @@
+# 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/limit.rb

@@ -0,0 +1,10 @@
+# limit.rb
+# 
+#  Created by James Edward Gray II on 2008-11-12.
+#  Copyright 2008 Gray Productions. All rights reserved.
+
+require "rubygems"
+require "highline/import"
+
+text = ask("Enter text (max 10 chars): ") { |q| q.limit = 10 }
+puts "You entered: #{text}!"

data/examples/menus.rb

@@ -0,0 +1,63 @@
+require "rubygems"
+require "highline/import"
+
+# The old way, using ask() and say()...
+choices = %w{ruby python perl}
+say("This is the old way using ask() and say()...")
+say("Please choose your favorite programming language:")
+say(choices.map { |c| "  #{c}\n" }.join)
+
+case ask("?  ", choices)
+when "ruby"
+  say("Good choice!")
+else
+  say("Not from around here, are you?")
+end
+
+# The new and improved choose()...
+say("\nThis is the new mode (default)...")
+choose do |menu|
+  menu.prompt = "Please choose your favorite programming language?  "
+
+  menu.choice :ruby do say("Good choice!") end
+  menu.choices(:python, :perl) do say("Not from around here, are you?") end
+end
+
+say("\nThis is letter indexing...")
+choose do |menu|
+  menu.index        = :letter
+  menu.index_suffix = ") "
+
+  menu.prompt = "Please choose your favorite programming language?  "
+
+  menu.choice :ruby do say("Good choice!") end
+  menu.choices(:python, :perl) do say("Not from around here, are you?") end
+end
+
+say("\nThis is with a different layout...")
+choose do |menu|
+  menu.layout = :one_line
+
+  menu.header = "Languages"
+  menu.prompt = "Favorite?  "
+
+  menu.choice :ruby do say("Good choice!") end
+  menu.choices(:python, :perl) do say("Not from around here, are you?") end
+end
+
+say("\nYou can even build shells...")
+loop do
+  choose do |menu|
+    menu.layout = :menu_only
+  
+    menu.shell  = true
+  
+    menu.choice(:load, "Load a file.") do |command, details|
+      say("Loading file with options:  #{details}...")
+    end
+    menu.choice(:save, "Save a file.") do |command, details|
+      say("Saving file with options:  #{details}...")
+    end
+    menu.choice(:quit, "Exit program.") { exit }
+  end
+end

data/examples/overwrite.rb

@@ -0,0 +1,17 @@
+# 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) %>")