highline 1.6.21 → 1.7.1

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "rake", :require => false
+gem "rdoc", :require => false
+
+group(:development, :tests) do
+  gem "code_statistics", :require => false
+  gem "test-unit", :require => false
+end

data/INSTALL

@@ -3,6 +3,10 @@
 RubyGems is the preferred easy install method for HighLine.  However, you can
 install HighLine manually as described below.
 
+== Requirements
+
+HighLine from version >= 1.7.0 requires ruby >= 1.9.3
+
 == Installing the Gem
 
 HighLine is intended to be installed via the

data/README.rdoc

@@ -1,7 +1,9 @@
-= Read Me
+= HighLine
 
 by James Edward Gray II
 
+{<img src="https://travis-ci.org/JEG2/highline.svg" alt="Build Status" />}[https://travis-ci.org/JEG2/highline]
+
 == Description
 
 Welcome to HighLine.
@@ -57,6 +59,10 @@ Menus:
 
 For more examples see the examples/ directory of this project.
 
+== Requirements
+
+HighLine from version >= 1.7.0 requires ruby >= 1.9.3
+
 == Installing
 
 See the INSTALL file for instructions.

data/Rakefile

@@ -1,50 +1,30 @@
 require "rdoc/task"
 require "rake/testtask"
 require "rubygems/package_task"
+require "bundler/gem_tasks"
+require "code_statistics"
 
 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"
+  test.libs       = ["lib", "test"]
+  test.test_files = FileList[ "test/tc_*.rb"]
+  test.verbose    = true
+  test.warning    = true
 end
 
-Rake::RDocTask.new do |rdoc|
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include( "README.rdoc", "INSTALL",
-                           "TODO", "CHANGELOG",
+                           "TODO", "Changelog.md",
                            "AUTHORS", "COPYING",
-                           "LICENSE", "lib/" )
+                           "LICENSE", "lib /*.rb" )
   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/highline.gemspec

@@ -1,12 +1,9 @@
-DIR         = File.dirname(__FILE__)
-LIB         = File.join(DIR, *%w[lib highline.rb])
-GEM_VERSION = open(LIB) { |lib|
-  lib.each { |line|
-    if v = line[/^\s*VERSION\s*=\s*(['"])(\d+\.\d+\.\d+)\1/, 2]
-      break v
-    end
-  }
-}
+# 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"
@@ -17,7 +14,7 @@ SPEC = Gem::Specification.new do |spec|
 
   spec.test_files       =  `git ls-files -- test/*.rb`.split("\n")
   spec.has_rdoc         =  true
-  spec.extra_rdoc_files =  %w[README.rdoc INSTALL TODO CHANGELOG LICENSE]
+  spec.extra_rdoc_files =  %w[README.rdoc INSTALL TODO Changelog.md LICENSE]
   spec.rdoc_options     << '--title' << 'HighLine Documentation' <<
                            '--main'  << 'README'
 
@@ -26,7 +23,7 @@ SPEC = Gem::Specification.new do |spec|
   spec.author            = "James Edward Gray II"
   spec.email             = "james@graysoftinc.com"
   spec.rubyforge_project = "highline"
-  spec.homepage          = "http://highline.rubyforge.org"
+  spec.homepage          = "https://github.com/JEG2/highline"
   spec.license           = "Ruby"
   spec.description       = <<END_DESC
 A high-level IO library that provides validation, type conversion, and more for
@@ -34,4 +31,7 @@ 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
+
+  spec.add_development_dependency "code_statistics"
+  spec.required_ruby_version = '>= 1.9.3'
 end

data/lib/highline.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # highline.rb
 #
 #  Created by James Edward Gray II on 2005-04-26.
@@ -16,6 +17,7 @@ require "highline/question"
 require "highline/menu"
 require "highline/color_scheme"
 require "highline/style"
+require "highline/version"
 
 #
 # A HighLine object is a "high-level line oriented" shell over an input and an
@@ -27,9 +29,6 @@ require "highline/style"
 # checking, convert types, etc.
 #
 class HighLine
-  # The version of the installed library.
-  VERSION = "1.6.21".freeze
-
   # An internal HighLine error.  User code does not need to trap this.
   class QuestionError < StandardError
     # do nothing, just creating a unique error type
@@ -119,17 +118,22 @@ class HighLine
   WHITE_STYLE      = Style.new(:name=>:white,      :builtin=>true, :code=>"\e[37m", :rgb=>[192,192,192])
   # Alias for WHITE, since WHITE is actually a light gray on Macs
   GRAY_STYLE       = Style.new(:name=>:gray,       :builtin=>true, :code=>"\e[37m", :rgb=>[192,192,192])
+  GREY_STYLE       = Style.new(:name=>:grey,       :builtin=>true, :code=>"\e[37m", :rgb=>[192,192,192])
   # On Mac OSX Terminal, this is black foreground, or bright white background.
   # Also used as base for RGB colors, if available
   NONE_STYLE       = Style.new(:name=>:none,       :builtin=>true, :code=>"\e[38m", :rgb=>[  0,  0,  0])
 
-  BASIC_COLORS = %w{BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE GRAY NONE}
+  BASIC_COLORS = %w{BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE GRAY GREY NONE}
 
   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
   COLORS = colors
 
@@ -244,7 +248,7 @@ class HighLine
   #
   # Raises EOFError if input is exhausted.
   #
-  def ask( question, answer_type = String, &details ) # :yields: question
+  def ask( question, answer_type = nil, &details ) # :yields: question
     @question ||= Question.new(question, answer_type, &details)
 
     return gather if @question.gather
@@ -254,7 +258,7 @@ class HighLine
     # the prompt will not be issued. And we have to account for that now.
     # Also, JRuby-1.7's ConsoleReader.readLine() needs to be passed the prompt
     # to handle line editing properly.
-    say(@question) unless ((JRUBY or @question.readline) and @question.echo == true)
+    say(@question) unless ((JRUBY or @question.readline) and (@question.echo == true and @question.limit.nil?))
 
     begin
       @answer = @question.answer_or_default(get_response)
@@ -617,13 +621,15 @@ class HighLine
     statement = format_statement(statement)
     return unless statement.length > 0
 
-      # Don't add a newline if statement ends with whitespace, OR
+    out = (indentation+statement).encode(Encoding.default_external, { :undef => :replace  } )
+
+    # Don't add a newline if statement ends with whitespace, OR
     # if statement ends with whitespace before a color escape code.
     if /[ \t](\e\[\d+(;\d+)*m)?\Z/ =~ statement
-      @output.print(indentation+statement)
+      @output.print(out)
       @output.flush
     else
-      @output.puts(indentation+statement)
+      @output.puts(out)
     end
   end
 
@@ -708,19 +714,19 @@ class HighLine
   private
 
   def format_statement statement
-    statement = statement.dup.to_str
+    statement = String(statement || "").dup
     return statement unless statement.length > 0
 
-  # Allow non-ascii menu prompts in ruby > 1.9.2. ERB eval the menu statement
-    # with the environment's default encoding(usually utf8)
-    statement.force_encoding(Encoding.default_external) if defined?(Encoding) && Encoding.default_external
-
     template  = ERB.new(statement, nil, "%")
     statement = template.result(binding)
 
     statement = wrap(statement) unless @wrap_at.nil?
     statement = page_print(statement) unless @page_at.nil?
 
+    # 'statement' is encoded in US-ASCII when using ruby 1.9.3(-p551)
+    # 'indentation' is correctly encoded (same as default_external encoding)
+    statement = statement.force_encoding(Encoding.default_external)
+
     statement = statement.gsub(/\n(?!$)/,"\n#{indentation}") if @multi_indent
 
     statement
@@ -886,18 +892,20 @@ class HighLine
       else
         raw_no_echo_mode
 
-        line            = ""
+        line            = "".encode(Encoding::BINARY)
         backspace_limit = 0
         begin
 
           while character = get_character(@input)
             # honor backspace and delete
             if character == 127 or character == 8
+              line = line.force_encoding(Encoding.default_external)
               line.slice!(-1, 1)
               backspace_limit -= 1
+              line = line.force_encoding(Encoding::BINARY)
             else
               line << character.chr
-              backspace_limit = line.size
+              backspace_limit = line.dup.force_encoding(Encoding.default_external).size
             end
             # looking for carriage return (decimal 13) or
             # newline (decimal 10) in raw input
@@ -912,10 +920,16 @@ class HighLine
                     # do nothing
                 end
               else
-                if @question.echo == true
-                  @output.print(character.chr)
-                else
-                  @output.print(@question.echo)
+                line_with_next_char_encoded = line.dup.force_encoding(Encoding.default_external)
+                # For multi-byte character, does this
+                #   last character completes the character?
+                # Then print it.
+                if line_with_next_char_encoded.valid_encoding?
+                  if @question.echo == true
+                    @output.print(line_with_next_char_encoded[-1])
+                  else
+                    @output.print(@question.echo)
+                  end
                 end
               end
               @output.flush
@@ -932,7 +946,7 @@ class HighLine
           say("\n")
         end
 
-        @question.change_case(@question.remove_whitespace(line))
+        @question.change_case(@question.remove_whitespace(line.force_encoding(Encoding.default_external)))
       end
     else
       if JRUBY #prompt has not been shown

data/lib/highline/menu.rb

@@ -345,7 +345,7 @@ class HighLine
     # Allows Menu to behave as a String, just like Question.  Returns the
     # _layout_ to be rendered, which is used by HighLine.say().
     #
-    def to_str(  )
+    def to_s(  )
       case @layout
       when :list
         '<%= if @header.nil? then '' else "#{@header}:\n" end %>' +

data/lib/highline/question.rb

@@ -228,8 +228,7 @@ class HighLine
     # Also used by Menu#update_responses.
     #
     def build_responses(message_source = answer_type, new_hash_wins = false)
-
-      append_default unless default.nil?
+      append_default if [::String, Symbol].include? default.class
 
       choice_error_str_func = lambda do
         message_source.is_a?(Array) \
@@ -442,7 +441,7 @@ class HighLine
     end
 
     # Stringifies the question to be asked.
-    def to_str(  )
+    def to_s
       @question
     end
 

data/lib/highline/style.rb

@@ -168,14 +168,25 @@ class HighLine
     end
 
     def bright
-      raise "Cannot create a bright variant of a style list (#{inspect})" if @list
-      new_name = ('bright_'+@name.to_s).to_sym
-      if style = self.class.list[new_name]
-        style
-      else
-        new_rgb = @rgb == [0,0,0] ? [128, 128, 128] : @rgb.map {|color|  color==0 ? 0 : [color+128,255].min }
-        variant(new_name, :increment=>60, :rgb=>new_rgb)
-      end
+      create_bright_variant(:bright)
+    end
+
+    def light
+      create_bright_variant(:light)
+    end
+
+    private
+
+    def create_bright_variant(variant_name)
+      raise "Cannot create a #{name} variant of a style list (#{inspect})" if @list
+      new_name = ("#{variant_name}_"+@name.to_s).to_sym
+      new_rgb = @rgb == [0,0,0] ? [128, 128, 128] : @rgb.map {|color|  color==0 ? 0 : [color+128,255].min }
+
+      find_style(new_name) or variant(new_name, :increment=>60, :rgb=>new_rgb)
+    end
+
+    def find_style(name)
+      self.class.list[name]
     end
   end
 end

data/lib/highline/system_extensions.rb

@@ -223,11 +223,20 @@ class HighLine
         # A Unix savvy method using stty to fetch the console columns, and rows.
         # ... stty does not work in JRuby
         def terminal_size
+          begin
+            require "io/console"
+            winsize = IO.console.winsize rescue nil
+            return winsize if winsize
+          rescue LoadError
+          end
+
           if /solaris/ =~ RUBY_PLATFORM and
             `stty` =~ /\brows = (\d+).*\bcolumns = (\d+)/
             [$2, $1].map { |c| x.to_i }
+          elsif `stty size` =~ /^(\d+)\s(\d+)$/
+            [$2.to_i, $1.to_i]
           else
-            `stty size`.split.map { |x| x.to_i }.reverse
+            [ 80, 24 ]
           end
         end
       end

data/lib/highline/version.rb

@@ -0,0 +1,4 @@
+class HighLine
+  # The version of the installed library.
+  VERSION = "1.7.1".freeze
+end

data/test/tc_highline.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 # tc_highline.rb
 #
 #  Created by James Edward Gray II on 2005-04-26.
@@ -9,6 +10,8 @@ require "test/unit"
 
 require "highline"
 require "stringio"
+require "readline"
+require "tempfile"
 
 if HighLine::CHARACTER_MODE == "Win32API"
   class HighLine
@@ -224,7 +227,95 @@ class TestHighLine < Test::Unit::TestCase
       assert_equal("", answer)
       assert_equal("Please enter your password: \n", @output.string)
   end
-  
+
+  def test_after_some_chars_backspace_does_not_enter_prompt_when_ascii
+      @input << "apple\b\b\b\b\b\b\b\b\b\b"
+      @input.rewind
+      answer = @terminal.ask("Please enter your password: ") do |q|
+        q.echo = "*"
+      end
+      assert_equal("", answer)
+      assert_equal("apple".size, @output.string.count("\b"))
+  end
+
+  def test_after_some_chars_backspace_does_not_enter_prompt_when_utf8
+      @input << "maçã\b\b\b\b\b\b\b\b"
+      @input.rewind
+      answer = @terminal.ask("Please enter your password: ") do |q|
+        q.echo = "*"
+      end
+      assert_equal("", answer)
+      assert_equal("maçã".size, @output.string.count("\b"))
+  end
+
+  def test_readline_mode
+    # Rubinius seems to be ignoring Readline input
+    # and output assignments. This ruins testing.
+    # but it doesn't mean readline is not working
+    # properly on rubinius.
+
+    return if RUBY_ENGINE == "rbx"
+
+    # Creating Tempfiles here because Readline.input
+    #   and Readline.output only accepts a File object
+    #   as argument (not any duck type as StringIO)
+
+    temp_stdin  = Tempfile.new "temp_stdin"
+    temp_stdout = Tempfile.new "temp_stdout"
+
+    Readline.input  = @input  = File.open(temp_stdin.path, 'w+')
+    Readline.output = @output = File.open(temp_stdout.path, 'w+')
+
+    @terminal = HighLine.new(@input, @output)
+
+    @input << "any input\n"
+    @input.rewind
+
+    answer = @terminal.ask("Prompt:  ") do |q|
+      q.readline = true
+    end
+
+    @output.rewind
+    output = @output.read
+
+    assert_equal "any input", answer
+    assert_match "Prompt:  any input\n", output
+
+    @input.close
+    @output.close
+    Readline.input  = STDIN
+    Readline.output = STDOUT
+  end
+
+  def test_readline_mode_with_limit_set
+    temp_stdin  = Tempfile.new "temp_stdin"
+    temp_stdout = Tempfile.new "temp_stdout"
+
+    Readline.input  = @input  = File.open(temp_stdin.path, 'w+')
+    Readline.output = @output = File.open(temp_stdout.path, 'w+')
+
+    @terminal = HighLine.new(@input, @output)
+
+    @input << "any input\n"
+    @input.rewind
+
+    answer = @terminal.ask("Prompt:  ") do |q|
+      q.limit = 50
+      q.readline = true
+    end
+
+    @output.rewind
+    output = @output.read
+
+    assert_equal "any input", answer
+    assert_equal "Prompt:  any input\n", output
+
+    @input.close
+    @output.close
+    Readline.input  = STDIN
+    Readline.output = STDOUT
+  end
+
   def test_readline_on_non_echo_question_has_prompt
     @input << "you can't see me"
     @input.rewind
@@ -327,6 +418,30 @@ class TestHighLine < Test::Unit::TestCase
                   @terminal.uncolor("This should be \e[38;5;137mrgb_906030\e[0m!\n") 
                 )
   end
+
+  def test_grey_is_the_same_of_gray
+    @terminal.say("<%= GRAY %>")
+    gray_code = @output.string.dup
+    @output.truncate(@output.rewind)
+
+    @terminal.say("<%= GREY %>")
+    grey_code = @output.string.dup
+    @output.truncate(@output.rewind)
+
+    assert_equal gray_code, grey_code
+  end
+
+  def test_light_is_the_same_as_bright
+    @terminal.say("<%= BRIGHT_BLUE %>")
+    bright_blue_code = @output.string.dup
+    @output.truncate(@output.rewind)
+
+    @terminal.say("<%= LIGHT_BLUE %>")
+    light_blue_code = @output.string.dup
+    @output.truncate(@output.rewind)
+
+    assert_equal bright_blue_code, light_blue_code
+  end
                                   
   def test_confirm
     @input << "junk.txt\nno\nsave.txt\ny\n"
@@ -380,6 +495,51 @@ class TestHighLine < Test::Unit::TestCase
                   @output.string )
   end
 
+  def test_default_with_String
+    @input << "\n"
+    @input.rewind
+
+    answer = @terminal.ask("Question:  ") do |q|
+      q.default = "string"
+    end
+
+    assert_equal "string", answer
+    assert_equal "Question:  |string|  ", @output.string
+  end
+
+  def test_default_with_Symbol
+    # With a Symbol, it should show up the String version
+    #   at prompt, but return the Symbol as answer
+
+    @input << "\n"
+    @input.rewind
+
+    answer = @terminal.ask("Question:  ") do |q|
+      q.default = :string
+    end
+
+    assert_equal :string, answer
+    assert_equal "Question:  |string|  ", @output.string
+  end
+
+  def test_default_with_non_String_objects
+    # With a non-string object, it should not show
+    #   any 'default' at prompt line. And should
+    #   return the "default" object, without conversion.
+
+    @input << "\n"
+    @input.rewind
+
+    default_non_string_object = Object.new
+
+    answer = @terminal.ask("Question:  ") do |q|
+      q.default = default_non_string_object
+    end
+
+    assert_equal default_non_string_object, answer
+    assert_equal "Question:  ", @output.string
+  end
+
   def test_string_preservation
     @input << "Maybe\nYes\n"
     @input.rewind
@@ -427,7 +587,7 @@ class TestHighLine < Test::Unit::TestCase
       q.glob      = "*.rb"
     end
     assert_instance_of(File, file)
-    assert_equal("# tc_highline.rb\n", file.gets)
+    assert_equal("# encoding: utf-8\n", file.gets)
     file.close
 
     @input.rewind
@@ -755,6 +915,54 @@ class TestHighLine < Test::Unit::TestCase
     assert_equal("Pick a letter or number:  \n", @output.string)
   end
   
+  def test_correct_string_encoding_when_echo_false
+    @input << "ação\r" # An UTF-8 portuguese word for 'action'
+    @input.rewind
+
+    answer = @terminal.ask("Please enter your password:  ") do |q|
+      q.echo = false
+    end
+
+    assert_equal "ação", answer
+    assert_equal Encoding::default_external, answer.encoding
+  end
+
+  def test_backspace_with_ascii_when_echo_false
+    @input << "password\b\r"
+    @input.rewind
+
+    answer = @terminal.ask("Please enter your password:  ") do |q|
+      q.echo = false
+    end
+
+    assert_not_equal("password", answer)
+    assert_equal("passwor", answer)
+  end
+
+  def test_backspace_with_utf8_when_echo_false
+    @input << "maçã\b\r"
+    @input.rewind
+
+    answer = @terminal.ask("Please enter your password:  ") do |q|
+      q.echo = false
+    end
+
+    assert_not_equal("maçã", answer)
+    assert_equal("maç", answer)
+  end
+
+  def test_echoing_with_utf8_when_echo_is_star
+    @input << "maçã\r"
+    @input.rewind
+
+    answer = @terminal.ask("Type:  ") do |q|
+      q.echo = "*"
+    end
+
+    assert_equal("Type:  ****\n", @output.string)
+    assert_equal("maçã", answer)
+  end
+
   def test_paging
     @terminal.page_at = 22
 
@@ -933,6 +1141,24 @@ class TestHighLine < Test::Unit::TestCase
     colorized = @terminal.color("This will have a newline.", :green)
     @terminal.say(colorized)
     assert_equal("\e[32mThis will have a newline.\e[0m\n", @output.string)
+
+    @output.truncate(@output.rewind)
+
+    assert_nothing_raised { @terminal.say(nil) }
+    assert_equal("", @output.string)
+  end
+
+  def test_say_handles_non_string_argument
+    integer = 10
+    hash    = { :a => 20 }
+
+    assert_nothing_raised { @terminal.say(integer) }
+    assert_equal String(integer), @output.string.chomp
+
+    @output.truncate(@output.rewind)
+
+    assert_nothing_raised { @terminal.say(hash) }
+    assert_equal String(hash), @output.string.chomp
   end
 
   def test_terminal_size