highline 2.0.0.pre.develop.9 → 2.0.0.pre.develop.11

data/examples/menus.rb

@@ -1,13 +1,14 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 require "rubygems"
 require "highline/import"
 
-puts "Using: #{$terminal.terminal.class}"
+puts "Using: #{HighLine.default_instance.terminal.class}"
 puts
 
 # The old way, using ask() and say()...
-choices = %w{ruby python perl}
+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)
@@ -24,11 +25,10 @@ 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
+  menu.choice(:ruby) { say("Good choice!") }
+  menu.choices(:python, :perl) { say("Not from around here, are you?") }
 
   menu.default = :ruby
-
 end
 
 say("\nThis is letter indexing...")
@@ -38,8 +38,8 @@ 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
+  menu.choice(:ruby) { say("Good choice!") }
+  menu.choices(:python, :perl) { say("Not from around here, are you?") }
 end
 
 say("\nThis is with a different layout...")
@@ -49,8 +49,8 @@ choose do |menu|
   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
+  menu.choice(:ruby) { say("Good choice!") }
+  menu.choices(:python, :perl) { say("Not from around here, are you?") }
 end
 
 say("\nYou can even build shells...")
@@ -60,10 +60,10 @@ loop do
 
     menu.shell  = true
 
-    menu.choice(:load, "Load a file.") do |command, details|
+    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|
+    menu.choice(:save, "Save a file.") do |_command, details|
       say("Saving file with options:  #{details}...")
     end
     menu.choice(:quit, "Exit program.") { exit }

data/examples/overwrite.rb

@@ -1,22 +1,23 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # overwrite.rb
 #
 #  Created by Jeremy Hinegardner on 2007-01-24
 #  Copyright 2007 Jeremy Hinegardner.  All rights reserved
 
-require 'rubygems'
-require 'highline/import'
+require "rubygems"
+require "highline/import"
 
-puts "Using: #{$terminal.terminal.class}"
+puts "Using: #{HighLine.default_instance.terminal.class}"
 puts
 
 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
+  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/examples/page_and_wrap.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # page_and_wrap.rb
 #
@@ -8,10 +9,10 @@
 require "rubygems"
 require "highline/import"
 
-$terminal.wrap_at = 80
-$terminal.page_at = 22
+HighLine.default_instance.wrap_at = 80
+HighLine.default_instance.page_at = 22
 
-say(<<END)
+say(<<CONSTITUTION)
 THE UNITED STATES CONSTITUTION
 
 We the People of the United States, in Order to form a more perfect Union, establish Justice, insure domestic Tranquility, provide for the common defence, promote the general Welfare, and secure the Blessings of Liberty to ourselves and our Posterity, do ordain and establish this Constitution for the United States of America.
@@ -319,4 +320,4 @@ James Wilson.
 Gouv Morris
 
 Attest William Jackson Secretary
-END
+CONSTITUTION

data/examples/password.rb

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 require "rubygems"
 require "highline/import"
 
-puts "Using: #{$terminal.terminal.class}"
+puts "Using: #{HighLine.default_instance.terminal.class}"
 puts
 
 pass = ask("Enter your password:  ") { |q| q.echo = false }

data/examples/repeat_entry.rb

@@ -1,12 +1,14 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 require "rubygems"
 require "highline/import"
 
-puts "Using: #{$terminal.terminal.class}"
+puts "Using: #{HighLine.default_instance.terminal.class}"
 puts
 
-tounge_twister = ask("... try saying that three times fast") do |q|
+# tounge_twister
+ask("... try saying that three times fast") do |q|
   q.gather = 3
   q.verify_match = true
   q.responses[:mismatch] = "Nope, those don't match. Try again."
@@ -15,10 +17,10 @@ end
 puts "Ok, you did it."
 
 pass = ask("<%= key %>:  ") do |q|
-  q.echo = '*'
+  q.echo = "*"
   q.verify_match = true
-  q.gather = {"Enter a password" => '',
-              "Please type it again for verification" => ''}
+  q.gather = { "Enter a password" => "",
+               "Please type it again for verification" => "" }
 end
 
 puts "Your password is now #{pass}!"

data/examples/trapping_eof.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # trapping_eof.rb
 #
@@ -13,7 +14,7 @@ loop do
     name = ask("What's your name?")
     break if name == "exit"
     puts "Hello, #{name}!"
-  rescue EOFError  # HighLine throws this if @input.eof?
+  rescue EOFError # HighLine throws this if @input.eof?
     break
   end
 end

data/examples/using_readline.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # using_readline.rb
 #
@@ -9,7 +10,7 @@ require "rubygems"
 require "highline/import"
 
 loop do
-  cmd = ask("Enter command:  ", %w{save sample load reset quit}) do |q|
+  cmd = ask("Enter command:  ", %w[save sample load reset quit]) do |q|
     q.readline = true
   end
   say("Executing \"#{cmd}\"...")

data/highline.gemspec

@@ -1,35 +1,35 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'highline/version'
-
-GEM_VERSION = HighLine::VERSION
 
-SPEC = Gem::Specification.new do |spec|
-  spec.name     = "highline"
-  spec.version  = GEM_VERSION
-  spec.platform = Gem::Platform::RUBY
-  spec.summary  = "HighLine is a high-level command-line IO library."
-  spec.files    = `git ls-files`.split("\n")
-
-  spec.test_files       =  `git ls-files -- test/*.rb`.split("\n")
-  spec.has_rdoc         =  'yard'
-  spec.extra_rdoc_files =  %w[README.md TODO Changelog.md LICENSE]
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "highline/version"
 
-  spec.require_path      = 'lib'
+Gem::Specification.new do |spec|
+  spec.name        = "highline"
+  spec.version     = HighLine::VERSION
+  spec.author      = "James Edward Gray II"
+  spec.email       = "james@graysoftinc.com"
 
-  spec.author            = "James Edward Gray II"
-  spec.email             = "james@graysoftinc.com"
-  spec.rubyforge_project = "highline"
-  spec.homepage          = "https://github.com/JEG2/highline"
-  spec.license           = "Ruby"
-  spec.description       = <<END_DESC
+  spec.summary     = "HighLine is a high-level command-line IO library."
+  spec.description = <<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.
-END_DESC
+DESCRIPTION
+  spec.homepage    = "https://github.com/JEG2/highline"
+  spec.license     = "Ruby"
+
+  spec.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.extra_rdoc_files = %w[README.md TODO Changelog.md LICENSE]
+
+  spec.required_ruby_version = ">= 1.9.3"
 
-  spec.add_development_dependency "code_statistics"
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/lib/highline.rb

@@ -10,6 +10,7 @@
 #
 # This is Free Software.  See LICENSE and COPYING for details.
 
+require "English"
 require "erb"
 require "optparse"
 require "stringio"
@@ -29,90 +30,64 @@ require "highline/builtin_styles"
 #
 # A HighLine object is a "high-level line oriented" shell over an input and an
 # output stream.  HighLine simplifies common console interaction, effectively
-# replacing {Kernel#puts} and {Kernel#gets}.  User code can simply specify the question to ask
-# and any details about user interaction, then leave the rest of the work to
-# HighLine.  When {HighLine#ask} returns, you'll have the answer you requested,
-# even if HighLine had to ask many times, validate results, perform range
-# checking, convert types, etc.
+# replacing {Kernel#puts} and {Kernel#gets}.  User code can simply specify the
+# question to ask and any details about user interaction, then leave the rest
+# of the work to HighLine.  When {HighLine#ask} returns, you'll have the answer
+# you requested, even if HighLine had to ask many times, validate results,
+# perform range checking, convert types, etc.
 #
 # @example Basic usage
 #   cli = HighLine.new
 #   answer = cli.ask "What do you think?"
 #   puts "You have answered: #{answer}"
-
+#
 class HighLine
   include BuiltinStyles
   include CustomErrors
 
-  # Set it to false to disable ANSI coloring
-  attr_writer :use_color
-
-  # Returns true if HighLine instance is currently using color escapes.
-  def use_color?
-    @use_color
-  end
+  extend SingleForwardable
+  def_single_delegators :@default_instance, :agree, :ask, :choose, :say,
+                        :use_color=, :use_color?, :reset_use_color,
+                        :track_eof=, :track_eof?,
+                        :color, :uncolor, :color_code
 
-  # Resets the use of color.
-  def reset_use_color
-    @use_color = true
-  end
+  class << self
+    attr_accessor :default_instance
 
-  # For checking if the current version of HighLine supports RGB colors
-  # Usage: HighLine.supports_rgb_color? rescue false   # rescue for compatibility with older versions
-  # Note: color usage also depends on HighLine.use_color being set
-  def self.supports_rgb_color?
-    true
-  end
+    # Pass ColorScheme to set a HighLine color scheme.
+    attr_accessor :color_scheme
 
-  # The setting used to disable EOF tracking.
-  @track_eof = true
+    # Returns +true+ if HighLine is currently using a color scheme.
+    def using_color_scheme?
+      true if @color_scheme
+    end
 
-  # Pass +false+ to _setting_ to turn off HighLine's EOF tracking.
-  def self.track_eof=( setting )
-    @track_eof = setting
-  end
+    # Reset color scheme to default (+nil+)
+    def reset_color_scheme
+      self.color_scheme = nil
+    end
 
-  # Returns true if HighLine is currently tracking EOF for input.
-  def self.track_eof?
-    @track_eof
-  end
+    # Reset HighLine to default.
+    # Clears Style index and resets color_scheme and use_color settings.
+    def reset
+      Style.clear_index
+      reset_color_scheme
+      reset_use_color
+    end
 
-  # (see HighLine.track_eof?)
-  def track_eof?
-    self.class.track_eof?
+    # For checking if the current version of HighLine supports RGB colors
+    # Usage: HighLine.supports_rgb_color? rescue false
+    #  using rescue for compatibility with older versions
+    # Note: color usage also depends on HighLine.use_color being set
+    # TODO: Discuss removing this method
+    def supports_rgb_color?
+      true
+    end
   end
 
   # The setting used to control color schemes.
   @color_scheme = nil
 
-  # Pass ColorScheme to _setting_ to 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?
-    !!@color_scheme
-  end
-
-  # Reset HighLine to default.
-  # Clears Style index and resets color_scheme and use_color settings.
-  def self.reset
-    Style.clear_index
-    reset_color_scheme
-    reset_use_color
-  end
-
-  # Reset color scheme to default (+nil+)
-  def self.reset_color_scheme
-    self.color_scheme = nil
-  end
-
   #
   # Create an instance of HighLine connected to the given _input_
   # and _output_ streams.
@@ -124,8 +99,9 @@ class HighLine
   # @param page_at [Integer] page size and paginating.
   # @param indent_size [Integer] indentation size in spaces.
   # @param indent_level [Integer] how deep is indentated.
-  def initialize( input = $stdin, output = $stdout,
-                  wrap_at = nil, page_at = nil, indent_size=3, indent_level=0 )
+  def initialize(input = $stdin, output = $stdout,
+                 wrap_at = nil, page_at = nil,
+                 indent_size = 3, indent_level = 0)
     @input   = input
     @output  = output
 
@@ -140,10 +116,32 @@ class HighLine
     @prompt   = nil
     @key      = nil
     @use_color = true
+    @track_eof = true # The setting used to disable EOF tracking.
 
     @terminal = HighLine::Terminal.get_terminal(input, output)
   end
 
+  # Set it to false to disable ANSI coloring
+  attr_accessor :use_color
+
+  # Returns truethy if HighLine instance is currently using color escapes.
+  def use_color?
+    use_color
+  end
+
+  # Resets the use of color.
+  def reset_use_color
+    @use_color = true
+  end
+
+  # Pass +false+ to turn off HighLine's EOF tracking.
+  attr_accessor :track_eof
+
+  # Returns true if HighLine is currently tracking EOF for input.
+  def track_eof?
+    true if track_eof
+  end
+
   # @return [Integer] The current column setting for wrapping output.
   attr_reader :wrap_at
 
@@ -187,11 +185,13 @@ class HighLine
   #
   # Raises EOFError if input is exhausted.
   #
-  # @param yes_or_no_question [String] a question that accepts yes and no as answers
-  # @param character [Boolean, :getc] character mode to be passed to Question#character
+  # @param yes_or_no_question [String] a question that accepts yes and no as
+  #   answers
+  # @param character [Boolean, :getc] character mode to be passed to
+  #   Question#character
   # @see Question#character
-  def agree( yes_or_no_question, character = nil )
-    ask(yes_or_no_question, lambda { |yn| yn.downcase[0] == ?y}) do |q|
+  def agree(yes_or_no_question, character = nil)
+    ask(yes_or_no_question, ->(yn) { yn.downcase[0] == "y" }) do |q|
       q.validate                 = /\A(?:y(?:es)?|no?)\Z/i
       q.responses[:not_valid]    = 'Please enter "yes" or "no".'
       q.responses[:ask_on_error] = :question
@@ -241,7 +241,7 @@ class HighLine
   # @param items [Array<String>]
   # @param details [Proc] to be passed to Menu.new
   # @return [String] answer
-  def choose( *items, &details )
+  def choose(*items, &details)
     menu = Menu.new(&details)
     menu.choices(*items) unless items.empty?
 
@@ -273,7 +273,7 @@ class HighLine
   # @return [lambda] lambda to be used in autocompletion operations
 
   def shell_style_lambda(menu)
-    lambda do |command|    # shell-style selection
+    lambda do |command| # shell-style selection
       first_word = command.to_s.split.first || ""
 
       options = menu.options
@@ -294,23 +294,20 @@ class HighLine
   # (:blue for BLUE, for example).  A CLEAR will automatically be embedded to
   # the end of the returned String.
   #
-  # This method returns the original _string_ unchanged if HighLine::use_color?
+  # This method returns the original _string_ unchanged if use_color?
   # is +false+.
   #
   # @param string [String] string to be colored
   # @param colors [Array<Symbol>] array of colors like [:red, :blue]
   # @return [String] (ANSI escaped) colored string
   # @example
-  #    HighLine.color("Sustainable", :green, :bold)
+  #    cli = HighLine.new
+  #    cli.color("Sustainable", :green, :bold)
   #    # => "\e[32m\e[1mSustainable\e[0m"
-  def self.color( string, *colors )
-    return string unless self.use_color?
-    Style(*colors).color(string)
-  end
-
-  # (see .color)
-  # This method is a clone of the HighLine.color class method.
-  # But it checks for use_color? per instance
+  #
+  #    # As class method (delegating to HighLine.default_instance)
+  #    HighLine.color("Sustainable", :green, :bold)
+  #
   def color(string, *colors)
     return string unless use_color?
     HighLine.Style(*colors).color(string)
@@ -327,29 +324,19 @@ class HighLine
   #   s.code # => "\e[31m\e[34m"
   #
   #   HighLine.color_code(:red, :blue) # => "\e[31m\e[34m"
-
-  def self.color_code(*colors)
-    Style(*colors).code
-  end
-
-  # (see HighLine.color_code)
-  # Convenience instance method. It delegates to the class method.
+  #
+  #   cli = HighLine.new
+  #   cli.color_code(:red, :blue) # => "\e[31m\e[34m"
+  #
   def color_code(*colors)
-    self.class.color_code(*colors)
+    HighLine.Style(*colors).code
   end
 
   # Remove color codes from a string.
   # @param string [String] to be decolorized
   # @return [String] without the ANSI escape sequence (colors)
-  def self.uncolor(string)
-    Style.uncolor(string)
-  end
-
-  # (see .uncolor)
-  # Convenience instance method. It delegates to the class method.
-
   def uncolor(string)
-    self.class.uncolor(string)
+    Style.uncolor(string)
   end
 
   # Renders a list of itens using a {ListRenderer}
@@ -377,7 +364,7 @@ class HighLine
     statement = render_statement(statement)
     return if statement.empty?
 
-    statement = (indentation+statement)
+    statement = (indentation + statement)
 
     # Don't add a newline if statement ends with whitespace, OR
     # if statement ends with whitespace before a color escape code.
@@ -402,7 +389,7 @@ class HighLine
   # set to <tt>:auto</tt>, HighLine will attempt to determine the columns
   # available for the <tt>@output</tt> or use a sensible default.
   #
-  def wrap_at=( setting )
+  def wrap_at=(setting)
     @wrap_at = setting == :auto ? output_cols : setting
   end
 
@@ -412,7 +399,7 @@ class HighLine
   # set to <tt>:auto</tt>, HighLine will attempt to determine the rows available
   # for the <tt>@output</tt> or use a sensible default.
   #
-  def page_at=( setting )
+  def page_at=(setting)
     @page_at = setting == :auto ? output_rows - 2 : setting
   end
 
@@ -420,7 +407,7 @@ class HighLine
   # Outputs indentation with current settings
   #
   def indentation
-    ' '*@indent_size*@indent_level
+    " " * @indent_size * @indent_level
   end
 
   #
@@ -431,7 +418,7 @@ class HighLine
   # @param multiline [Boolean]
   # @return [void]
   # @see #multi_indent
-  def indent(increase=1, statement=nil, multiline=nil)
+  def indent(increase = 1, statement = nil, multiline = nil)
     @indent_level += increase
     multi = @multi_indent
     @multi_indent ||= multiline
@@ -461,7 +448,7 @@ class HighLine
   def output_cols
     return 80 unless @output.tty?
     terminal.terminal_size.first
-  rescue
+  rescue NoMethodError
     return 80
   end
 
@@ -472,7 +459,7 @@ class HighLine
   def output_rows
     return 24 unless @output.tty?
     terminal.terminal_size.last
-  rescue
+  rescue NoMethodError
     return 24
   end
 
@@ -486,7 +473,8 @@ class HighLine
   # Creates a new HighLine instance with the same options
   #
   def new_scope
-    self.class.new(@input, @output, @wrap_at, @page_at, @indent_size, @indent_level)
+    self.class.new(@input, @output, @wrap_at,
+                   @page_at, @indent_size, @indent_level)
   end
 
   private
@@ -523,7 +511,7 @@ class HighLine
   # @param question [Question]
   # @return [String] response
   def get_response_line_mode(question)
-    if question.echo == true and !question.limit
+    if question.echo == true && !question.limit
       get_line(question)
     else
       get_line_raw_no_echo_mode(question)
@@ -547,13 +535,15 @@ class HighLine
     line = ""
 
     terminal.raw_no_echo_mode_exec do
-      while character = terminal.get_character
+      loop do
+        character = terminal.get_character
+        break unless character
         break if ["\n", "\r"].include? character
 
         # honor backspace and delete
         if character == "\b"
           chopped = line.chop!
-          output_erase_char if chopped and question.echo
+          output_erase_char if chopped && question.echo
         else
           line << character
           say_last_char_or_echo_char(line, question)
@@ -581,11 +571,11 @@ class HighLine
 
   def say_last_char_or_echo_char(line, question)
     @output.print(line[-1]) if question.echo == true
-    @output.print(question.echo) if question.echo and question.echo != true
+    @output.print(question.echo) if question.echo && question.echo != true
   end
 
   def line_overflow_for_question?(line, question)
-    question.limit and line.size == question.limit
+    question.limit && line.size == question.limit
   end
 
   def output_erase_char
@@ -631,4 +621,6 @@ class HighLine
   end
 end
 
+HighLine.default_instance = HighLine.new
+
 require "highline/string"