highline 1.7.10 → 2.0.3

data/appveyor.yml

@@ -0,0 +1,37 @@
+version: 2.0.{build}-{branch}
+
+cache:
+  - vendor/bundle
+
+environment:
+  matrix:
+    - RUBY_VERSION: "193"
+    - RUBY_VERSION: "200"
+    - RUBY_VERSION: "200-x64"
+    - RUBY_VERSION: "21"
+    - RUBY_VERSION: "21-x64"
+    - RUBY_VERSION: "22"
+    - RUBY_VERSION: "22-x64"
+    - RUBY_VERSION: "23"
+    - RUBY_VERSION: "23-x64"
+    - RUBY_VERSION: "24"
+    - RUBY_VERSION: "24-x64"
+
+matrix:
+  allow_failures:
+    - RUBY_VERSION: "193"
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle config --local path vendor/bundle
+  - bundle install --retry=3 --without code_quality
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake

data/examples/ansi_colors.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # ansi_colors.rb
 #
@@ -9,19 +10,13 @@ require "rubygems"
 require "highline/import"
 
 # Supported color sequences.
-colors = %w{black red green yellow blue magenta cyan white}
+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
+  say("This should be <%= color('#{colors[i - 1]} on #{c}', \
+      :#{colors[i - 1]}, :on_#{c} ) %>!")
 end
 
 # Using color with constants.
@@ -32,7 +27,7 @@ say("This should be <%= color('underlined', UNDERLINE) %>!")
 say("This might even <%= BLINK %>blink<%= CLEAR %>!")
 
 # It even works with list wrapping.
-erb_digits = %w{Zero One Two Three Four}      +
+erb_digits = %w[Zero One Two Three Four]      +
              ["<%= color('Five', :blue) %%>"] +
-             %w{Six Seven Eight Nine}
+             %w[Six Seven Eight Nine]
 say("<%= list(#{erb_digits.inspect}, :columns_down, 3) %>")

data/examples/asking_for_arrays.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # asking_for_arrays.rb
 #
@@ -9,8 +10,11 @@ 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|
+puts "Using: #{HighLine.default_instance.class}"
+puts
+
+grades = ask("Enter test scores (or a blank line to quit):",
+             ->(ans) { ans =~ /^-?\d+$/ ? Integer(ans) : ans }) do |q|
   q.gather = ""
 end
 

data/examples/basic_usage.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # basic_usage.rb
 #
@@ -9,32 +10,38 @@ require "rubygems"
 require "highline/import"
 require "yaml"
 
-contacts = [ ]
+puts "Using: #{HighLine.default_instance.terminal.class}"
+puts
 
+contacts = []
+
+# Just define a parse class method and use the class
+# as a parser for HighLine#ask
+#
 class NameClass
-  def self.parse( string )
-    if string =~ /^\s*(\w+),\s*(\w+)\s*$/
-      self.new($2, $1)
-    else
-      raise ArgumentError, "Invalid name format."
-    end
+  def self.parse(string)
+    raise ArgumentError, "Invalid name format." unless
+      string =~ /^\s*(\w+),\s*(\w+)\s*$/
+
+    new(Regexp.last_match(2), Regexp.last_match(1))
   end
 
   def initialize(first, last)
-    @first, @last = first, last
+    @first = first
+    @last = last
   end
 
   attr_reader :first, :last
 end
 
-begin
-  entry = Hash.new
+loop do
+  entry = {}
 
   # basic output
   say("Enter a contact:")
 
   # basic input
-  entry[:name]        = ask("Name?  (last, first)  ", NameClass) do |q|
+  entry[:name] = ask("Name?  (last, first)  ", NameClass) do |q|
     q.validate = /\A\w+, ?\w+\Z/
   end
   entry[:company]     = ask("Company?  ") { |q| q.default = "none" }
@@ -44,27 +51,30 @@ begin
     q.case     = :up
     q.validate = /\A[A-Z]{2}\Z/
   end
-  entry[:zip]         = ask("Zip?  ") do |q|
+  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 }
+  entry[:phone] = ask("Phone?  ",
+                      lambda { |p|
+                        p.delete("^0-9").
+                                     sub(/\A(\d{3})/, '(\1) ').
+                                     sub(/(\d{4})\Z/, '-\1')
+                      }) do |q|
+    q.validate              = ->(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[:interests]   = ask("Interests?  (comma separated list)  ",
+                            ->(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)
+  # shortcut for yes and no questions
+  break unless agree("Enter another contact?  ", true)
+end
 
 if agree("Save these contacts?  ", true)
   file_name = ask("Enter a file name:  ") do |q|

data/examples/color_scheme.rb

@@ -1,20 +1,21 @@
 #!/usr/bin/env ruby -w
+# encoding: utf-8
 
 # color_scheme.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"
 
 # 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
+  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
@@ -26,7 +27,7 @@ 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
+  row_color = i ? :even_row : :odd_row
+  say("<%= color('#{row}', '#{row_color}') %>")
+  i = !i
 end

data/examples/get_character.rb

@@ -1,12 +1,16 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 require "rubygems"
 require "highline/import"
 
+puts "Using: #{HighLine.default_instance.terminal.class}"
+puts
+
 choices = "ynaq"
 answer = ask("Your choice [#{choices}]? ") do |q|
-           q.echo      = false
-           q.character = true
-           q.validate  = /\A[#{choices}]\Z/
-         end
+  q.echo = false
+  q.character = true
+  q.validate  = /\A[#{choices}]\Z/
+end
 say("Your choice: #{answer}")

data/examples/limit.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -w
+# encoding: utf-8
 
 # limit.rb
 #
@@ -8,5 +9,8 @@
 require "rubygems"
 require "highline/import"
 
+puts "Using: #{HighLine.default_instance.terminal.class}"
+puts
+
 text = ask("Enter text (max 10 chars): ") { |q| q.limit = 10 }
 puts "You entered: #{text}!"

data/examples/menus.rb

@@ -1,10 +1,14 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 require "rubygems"
 require "highline/import"
 
+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)
@@ -21,19 +25,21 @@ 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...")
 choose do |menu|
-  menu.index        = :letter
+  menu.index        = :letter # Use :capital_letter for uppercase
   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
+  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...")
@@ -43,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...")
@@ -54,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,19 +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: #{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,7 +1,11 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 require "rubygems"
 require "highline/import"
 
+puts "Using: #{HighLine.default_instance.terminal.class}"
+puts
+
 pass = ask("Enter your password:  ") { |q| q.echo = false }
 puts "Your password is #{pass}!"

data/examples/repeat_entry.rb

@@ -1,9 +1,14 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 require "rubygems"
 require "highline/import"
 
-tounge_twister = ask("... try saying that three times fast") do |q|
+puts "Using: #{HighLine.default_instance.terminal.class}"
+puts
+
+# 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."
@@ -11,11 +16,11 @@ end
 
 puts "Ok, you did it."
 
-pass = ask("<%= @key %>:  ") do |q|
-  q.echo = '*'
+pass = ask("<%= key %>:  ") do |q|
+  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,37 +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         =  true
-  spec.extra_rdoc_files =  %w[README.rdoc INSTALL TODO Changelog.md LICENSE]
-  spec.rdoc_options     << '--title' << 'HighLine Documentation' <<
-                           '--main'  << 'README'
+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/builtin_styles.rb

@@ -0,0 +1,129 @@
+# coding: utf-8
+
+class HighLine
+  # Builtin Styles that are included at HighLine initialization.
+  # It has the basic styles like :bold and :underline.
+  module BuiltinStyles
+    # Included callback
+    # @param base [Class, Module] base class
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    # Basic styles' ANSI escape codes like :bold => "\e[1m"
+    STYLE_LIST = {
+      erase_line: "\e[K",
+      erase_char: "\e[P",
+      clear:      "\e[0m",
+      reset:      "\e[0m",
+      bold:       "\e[1m",
+      dark:       "\e[2m",
+      underline:  "\e[4m",
+      underscore: "\e[4m",
+      blink:      "\e[5m",
+      reverse:    "\e[7m",
+      concealed:  "\e[8m"
+    }.freeze
+
+    STYLE_LIST.each do |style_name, code|
+      style = String(style_name).upcase
+
+      const_set style, code
+      const_set style + "_STYLE",
+                Style.new(name: style_name, code: code, builtin: true)
+    end
+
+    # Basic Style names like CLEAR, BOLD, UNDERLINE
+    STYLES = %w[CLEAR RESET BOLD DARK UNDERLINE
+                UNDERSCORE BLINK REVERSE CONCEALED].freeze
+
+    # A Hash with the basic colors an their ANSI escape codes.
+    COLOR_LIST = {
+      black:   { code: "\e[30m", rgb: [0, 0, 0] },
+      red:     { code: "\e[31m", rgb: [128, 0, 0] },
+      green:   { code: "\e[32m", rgb: [0, 128, 0] },
+      blue:    { code: "\e[34m", rgb: [0, 0, 128] },
+      yellow:  { code: "\e[33m", rgb: [128, 128, 0] },
+      magenta: { code: "\e[35m", rgb: [128, 0, 128] },
+      cyan:    { code: "\e[36m", rgb: [0, 128, 128] },
+      white:   { code: "\e[37m", rgb: [192, 192, 192] },
+      gray:    { code: "\e[37m", rgb: [192, 192, 192] },
+      grey:    { code: "\e[37m", rgb: [192, 192, 192] },
+      none:    { code: "\e[38m", rgb: [0, 0, 0] }
+    }.freeze
+
+    COLOR_LIST.each do |color_name, attributes|
+      color = String(color_name).upcase
+
+      style = Style.new(
+        name: color_name,
+        code: attributes[:code],
+        rgb:  attributes[:rgb],
+        builtin: true
+      )
+
+      const_set color + "_STYLE", style
+    end
+
+    # The builtin styles basic colors like black, red, green.
+    BASIC_COLORS =
+      %w[BLACK RED GREEN YELLOW BLUE
+         MAGENTA CYAN WHITE GRAY GREY NONE].freeze
+
+    colors = BASIC_COLORS.dup
+    BASIC_COLORS.each do |color|
+      bright_color = "BRIGHT_#{color}"
+      colors << bright_color
+      const_set bright_color + "_STYLE", const_get(color + "_STYLE").bright
+
+      light_color = "LIGHT_#{color}"
+      colors << light_color
+      const_set light_color + "_STYLE", const_get(color + "_STYLE").light
+    end
+
+    # The builtin styles' colors like LIGHT_RED and BRIGHT_BLUE.
+    COLORS = colors
+
+    colors.each do |color|
+      const_set color, const_get("#{color}_STYLE").code
+      const_set "ON_#{color}_STYLE", const_get("#{color}_STYLE").on
+      const_set "ON_#{color}", const_get("ON_#{color}_STYLE").code
+    end
+
+    ON_NONE_STYLE.rgb = [255, 255, 255] # Override; white background
+
+    # BuiltinStyles class methods to be extended.
+    module ClassMethods
+      # Regexp to match against RGB style constant names.
+      RGB_COLOR_PATTERN = /^(ON_)?(RGB_)([A-F0-9]{6})(_STYLE)?$/
+
+      # const_missing callback for automatically respond to
+      # builtin constants (without explicitly defining them)
+      # @param name [Symbol] missing constant name
+      def const_missing(name)
+        raise NameError, "Bad color or uninitialized constant #{name}" unless
+          name.to_s =~ RGB_COLOR_PATTERN
+
+        on = Regexp.last_match(1)
+        suffix = Regexp.last_match(4)
+
+        code_name = if suffix
+                      Regexp.last_match(1).to_s +
+                        Regexp.last_match(2) +
+                        Regexp.last_match(3)
+                    else
+                      name.to_s
+                    end
+
+        style_name = code_name + "_STYLE"
+        style = Style.rgb(Regexp.last_match(3))
+        style = style.on if on
+
+        const_set(style_name, style)
+        const_set(code_name, style.code)
+
+        suffix ? style : style.code
+      end
+    end
+  end
+end