highline 1.7.10 → 2.0.0.pre.develop.2

data/lib/highline/template_renderer.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+require 'forwardable'
+
+class HighLine
+  class TemplateRenderer
+    extend Forwardable
+
+    def_delegators :@highline, :color, :list, :key
+    def_delegators :@source, :answer_type, :prompt, :header, :answer
+
+    attr_reader :template, :source, :highline
+
+    def initialize(template, source, highline)
+      @template = template
+      @source   = source
+      @highline = highline
+    end
+
+    def render
+      template.result(binding)
+    end
+
+    def method_missing(method, *args)
+      "Method #{method} with args #{args.inspect} " +
+      "is not available on #{self.inspect}. " +
+      "Try #{methods(false).sort.inspect}"
+    end
+
+    def menu
+      source
+    end
+
+    def self.const_missing(name)
+      HighLine.const_get(name)
+    end
+  end
+end

data/lib/highline/terminal.rb

@@ -0,0 +1,78 @@
+# coding: utf-8
+
+#--
+# terminal.rb
+#
+#  Originally created by James Edward Gray II on 2006-06-14 as
+#  system_extensions.rb.
+#  Copyright 2006 Gray Productions. All rights reserved.
+#
+#  This is Free Software.  See LICENSE and COPYING for details.
+
+require "highline/compatibility"
+
+class HighLine
+  class Terminal
+    def self.get_terminal(input, output)
+      terminal = nil
+
+      # First of all, probe for io/console
+      begin
+        require "io/console"
+        require "highline/terminal/io_console"
+        terminal = HighLine::Terminal::IOConsole.new(input, output)
+      rescue LoadError
+      end
+
+      # Fall back to UnixStty
+      unless terminal
+        require 'highline/terminal/unix_stty'
+        terminal = HighLine::Terminal::UnixStty.new(input, output)
+      end
+
+      terminal.initialize_system_extensions
+      terminal
+    end
+
+    attr_reader :input, :output
+
+    def initialize(input, output)
+      @input  = input
+      @output = output
+    end
+
+    def initialize_system_extensions
+    end
+
+    def terminal_size
+    end
+
+    def raw_no_echo_mode
+    end
+
+    def raw_no_echo_mode_exec
+      raw_no_echo_mode
+      yield
+    ensure
+      restore_mode
+    end
+
+    def restore_mode
+    end
+
+    def get_character
+    end
+
+    def jruby?
+      defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    end
+
+    def rubinius?
+      defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+    end
+
+    def windows?
+      defined?(RUBY_PLATFORM) && (RUBY_PLATFORM =~ /mswin|mingw|cygwin/)
+    end
+  end
+end

data/lib/highline/terminal/io_console.rb

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+class HighLine
+  class Terminal
+    class IOConsole < Terminal
+      def terminal_size
+        output.winsize.reverse
+      end
+
+      CHARACTER_MODE = "io_console"   # For Debugging purposes only.
+
+      def raw_no_echo_mode
+        input.echo = false
+      end
+
+      def restore_mode
+        input.echo = true
+      end
+
+      def get_character
+        input.getch # from ruby io/console
+      end
+
+      def character_mode
+        "io_console"
+      end
+
+      def get_line(question, highline, options={})
+        raw_answer =
+        if question.readline
+          get_line_with_readline(question, highline, options={})
+        else
+          get_line_default(highline)
+        end
+
+        question.format_answer(raw_answer)
+      end
+
+      def get_line_with_readline(question, highline, options={})
+        require "readline"    # load only if needed
+
+        question_string = highline.render_statement(question)
+
+        raw_answer = readline_read(question_string, question)
+
+        if !raw_answer and highline.track_eof?
+          raise EOFError, "The input stream is exhausted."
+        end
+
+        raw_answer || ""
+      end
+
+      def readline_read(string, question)
+        # prep auto-completion
+        unless question.selection.empty?
+          Readline.completion_proc = lambda do |str|
+            question.selection.grep(/\A#{Regexp.escape(str)}/)
+          end
+        end
+
+        # work-around ugly readline() warnings
+        old_verbose = $VERBOSE
+        $VERBOSE    = nil
+
+        raw_answer  = run_preserving_stty do
+          Readline.readline(string, true)
+        end
+
+        $VERBOSE    = old_verbose
+
+        raw_answer
+      end
+
+      def get_line_default(highline)
+        raise EOFError, "The input stream is exhausted." if highline.track_eof? and
+                                                              highline.input.eof?
+        highline.input.gets
+      end
+
+      private
+
+      def run_preserving_stty
+        save_stty
+        yield
+      ensure
+        restore_stty
+      end
+
+      def save_stty
+        @stty_save = `stty -g`.chomp rescue nil
+      end
+
+      def restore_stty
+        system("stty", @stty_save) if @stty_save
+      end
+    end
+  end
+end

data/lib/highline/terminal/ncurses.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+# TODO:
+# Code below to be discussed.
+# Will we maintain an ncurses version of HighLine::Terminal?
+# If so, port it to the new api.
+
+class HighLine
+  module SystemExtensions
+    module NCurses
+      require 'ffi-ncurses'
+      CHARACTER_MODE = "ncurses"    # For Debugging purposes only.
+
+      def raw_no_echo_mode
+        FFI::NCurses.initscr
+        FFI::NCurses.cbreak
+      end
+
+      def restore_mode
+        FFI::NCurses.endwin
+      end
+
+      #
+      # A ncurses savvy method to fetch the console columns, and rows.
+      #
+      def terminal_size
+        size = [80, 40]
+        FFI::NCurses.initscr
+        begin
+          size = FFI::NCurses.getmaxyx(FFI::NCurses.stdscr).reverse
+        ensure
+          FFI::NCurses.endwin
+        end
+        size
+      end
+    end
+  end
+end

data/lib/highline/terminal/unix_stty.rb

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+class HighLine
+  class Terminal::UnixStty < Terminal
+
+    # 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.reverse 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
+        [ 80, 24 ]
+      end
+    end
+
+                              # *WARNING*:  This requires the external "stty" program!
+    CHARACTER_MODE = "unix_stty"   # For Debugging purposes only.
+
+    def raw_no_echo_mode
+      @state = `stty -g`
+      system "stty raw -echo -icanon isig"
+    end
+
+    def restore_mode
+      system "stty #{@state}"
+      print "\r"
+    end
+
+    def get_character( input = STDIN )
+      input.getc
+    end
+
+    def character_mode
+      "unix_stty"
+    end
+
+    def get_line(question, highline, options={})
+      raw_answer =
+      if question.readline
+        get_line_with_readline(question, highline, options={})
+      else
+        get_line_default(highline)
+      end
+
+      question.format_answer(raw_answer)
+    end
+
+    def get_line_with_readline(question, highline, options={})
+      require "readline"    # load only if needed
+
+      question_string = highline.render_statement(question)
+
+      raw_answer = readline_read(question_string, question)
+
+      if !raw_answer and highline.track_eof?
+        raise EOFError, "The input stream is exhausted."
+      end
+
+      raw_answer || ""
+    end
+
+    def readline_read(string, question)
+      # prep auto-completion
+      Readline.completion_proc = lambda do |string|
+        question.selection.grep(/\A#{Regexp.escape(string)}/)
+      end
+
+      # work-around ugly readline() warnings
+      old_verbose = $VERBOSE
+      $VERBOSE    = nil
+      raw_answer  = Readline.readline(string, true)
+
+      $VERBOSE    = old_verbose
+
+      raw_answer
+    end
+
+    def get_line_default(highline)
+      raise EOFError, "The input stream is exhausted." if highline.track_eof? and
+                                                            highline.input.eof?
+      highline.input.gets
+    end
+  end
+end

data/lib/highline/version.rb

@@ -1,4 +1,6 @@
+# coding: utf-8
+
 class HighLine
   # The version of the installed library.
-  VERSION = "1.7.10".freeze
+  VERSION = "2.0.0-develop.2".freeze
 end

data/lib/highline/wrapper.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+class HighLine
+  module Wrapper
+
+    #
+    # Wrap a sequence of _lines_ at _wrap_at_ characters per line.  Existing
+    # newlines will not be affected by this process, but additional newlines
+    # may be added.
+    #
+    def self.wrap(text, wrap_at)
+      return text unless wrap_at
+      wrap_at = Integer(wrap_at)
+
+      wrapped = [ ]
+      text.each_line do |line|
+        # take into account color escape sequences when wrapping
+        wrap_at = wrap_at + (line.length - actual_length(line))
+        while line =~ /([^\n]{#{wrap_at + 1},})/
+          search  = $1.dup
+          replace = $1.dup
+          if index = replace.rindex(" ", wrap_at)
+            replace[index, 1] = "\n"
+            replace.sub!(/\n[ \t]+/, "\n")
+            line.sub!(search, replace)
+          else
+            line[$~.begin(1) + wrap_at, 0] = "\n"
+          end
+        end
+        wrapped << line
+      end
+      return wrapped.join
+    end
+
+    #
+    # Returns the length of the passed +string_with_escapes+, minus and color
+    # sequence escapes.
+    #
+    def self.actual_length( string_with_escapes )
+      string_with_escapes.to_s.gsub(/\e\[\d{1,2}m/, "").length
+    end
+  end
+end

data/test/acceptance/acceptance.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+current_dir = File.dirname(File.expand_path(__FILE__))
+
+# All acceptance test files begins with 'at_'
+acceptance_test_files = Dir["#{current_dir}/at_*"]
+
+# Load each acceptance test file making
+# all tests to be run
+acceptance_test_files.each { |file| load file }
+
+# Print a report
+
+report = <<EOF
+
+===
+Well done!
+
+Below you have a report with all the answers you gave.
+It has also some environment information to help us debugging.
+
+If any of the tests have not passed on your environment,
+please copy/past the text bellow and send to us.
+
+If you are familiar with GitHub you can report the failing test
+as a GitHub issue at https://github.com/JEG2/highline/issues.
+If possible, always check if your issue is already reported
+by someone else. If so, just report that you are also affected
+on the same alredy open issued.
+
+If you are more confortable with e-mail, you could send it to
+james@grayproductions.net
+
+=== HighLine Acceptance Tests Report
+Date: #{Time.now.utc}
+HighLine::VERSION: #{HighLine::VERSION}
+Terminal: #{$terminal.terminal.class}
+RUBY_DESCRIPTION: #{RUBY_DESCRIPTION rescue 'not available'}
+Readline::VERSION: #{Readline::VERSION rescue 'not availabe'}
+ENV['SHELL']: #{ENV['SHELL']}
+ENV['TERM']: #{ENV['TERM']}
+ENV['TERM_PROGRAM']: #{ENV['TERM_PROGRAM']}
+
+Answers:
+#{HighLine::AcceptanceTest.answers_for_report}
+EOF
+
+puts report
+
+timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+filename  = "highlinetests-#{timestamp}.log"
+
+File.open "#{filename}", 'w+' do |f|
+  f.puts report
+end
+
+puts
+puts "You can also see the above information in"
+puts "a timestamped file named #{filename}"
+puts "at the current directory."
+puts