highline 2.0.0.pre.develop.2 → 2.0.0.pre.develop.4

data/lib/highline/terminal/io_console.rb

@@ -2,97 +2,28 @@
 
 class HighLine
   class Terminal
+    # io/console option for HighLine::Terminal.
+    # It's the most used terminal.
     class IOConsole < Terminal
+      # (see Terminal#terminal_size)
       def terminal_size
         output.winsize.reverse
       end
 
-      CHARACTER_MODE = "io_console"   # For Debugging purposes only.
-
+      # (see Terminal#raw_no_echo_mode)
       def raw_no_echo_mode
         input.echo = false
       end
 
+      # (see Terminal#restore_mode)
       def restore_mode
         input.echo = true
       end
 
+      # (see Terminal#get_character)
       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

@@ -1,26 +1,25 @@
 # 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
+  class Terminal
+    # NCurses HighLine::Terminal
+    # @note Code migrated +UNTESTED+ from the old code base to the new terminal api.
+    class NCurses < Terminal
       require 'ffi-ncurses'
-      CHARACTER_MODE = "ncurses"    # For Debugging purposes only.
 
+      # (see Terminal#raw_no_echo_mode)
       def raw_no_echo_mode
         FFI::NCurses.initscr
         FFI::NCurses.cbreak
       end
 
+      # (see Terminal#restore_mode)
       def restore_mode
         FFI::NCurses.endwin
       end
 
       #
+      # (see Terminal#terminal_size)
       # A ncurses savvy method to fetch the console columns, and rows.
       #
       def terminal_size

data/lib/highline/terminal/unix_stty.rb

@@ -1,94 +1,48 @@
 # 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
+  class Terminal
+    # HighLine::Terminal option that uses external "stty" program
+    # to control terminal options.
+    class UnixStty < Terminal
+
+      # A Unix savvy method using stty to fetch the console columns, and rows.
+      # ... stty does not work in JRuby
+      # @return (see Terminal#terminal_size)
+      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 { |x| x.to_i }
+        elsif `stty size` =~ /^(\d+)\s(\d+)$/
+          [$2.to_i, $1.to_i]
+        else
+          [ 80, 24 ]
+        end
       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 ]
+      # (see Terminal#raw_no_echo_mode)
+      def raw_no_echo_mode
+        @state = `stty -g`
+        system "stty raw -echo -icanon isig"
       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)
+      # (see Terminal#restore_mode)
+      def restore_mode
+        system "stty #{@state}"
+        print "\r"
       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)}/)
+      # (see Terminal#get_character)
+      def get_character( input = STDIN )
+        input.getc
       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

@@ -2,5 +2,5 @@
 
 class HighLine
   # The version of the installed library.
-  VERSION = "2.0.0-develop.2".freeze
+  VERSION = "2.0.0-develop.4".freeze
 end

data/lib/highline/wrapper.rb

@@ -1,6 +1,10 @@
 # coding: utf-8
 
 class HighLine
+
+  # A simple Wrapper module that is aware of ANSI escape codes.
+  # It compensates for the ANSI escape codes so it works on the
+  # actual (visual) line length.
   module Wrapper
 
     #
@@ -8,6 +12,8 @@ class HighLine
     # newlines will not be affected by this process, but additional newlines
     # may be added.
     #
+    # @param text [String] text to be wrapped
+    # @param wrap_at [#to_i] column count to wrap the text into
     def self.wrap(text, wrap_at)
       return text unless wrap_at
       wrap_at = Integer(wrap_at)
@@ -36,6 +42,9 @@ class HighLine
     # Returns the length of the passed +string_with_escapes+, minus and color
     # sequence escapes.
     #
+    # @param string_with_escapes [String] any ANSI colored String
+    # @return [Integer] length based on the visual size of the String
+    #   (without the escape codes)
     def self.actual_length( string_with_escapes )
       string_with_escapes.to_s.gsub(/\e\[\d{1,2}m/, "").length
     end

data/test/test_highline.rb

@@ -959,7 +959,7 @@ class TestHighLine < Minitest::Test
   end
   
   def test_mode
-    assert(%w[io_console Win32API termios ncurses stty unix_stty jline].include?(@terminal.terminal.character_mode),
+    assert(%w[HighLine::Terminal::IOConsole HighLine::Terminal::NCurses HighLine::Terminal::UnixStty].include?(@terminal.terminal.character_mode),
            "#{@terminal.terminal.character_mode} not in list")
   end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highline
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.develop.2
+  version: 2.0.0.pre.develop.4
 platform: ruby
 authors:
 - James Edward Gray II
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_statistics
@@ -33,8 +33,7 @@ email: james@graysoftinc.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
-- INSTALL
+- README.md
 - TODO
 - Changelog.md
 - LICENSE
@@ -46,9 +45,8 @@ files:
 - COPYING
 - Changelog.md
 - Gemfile
-- INSTALL
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - TODO
 - appveyor.yml
@@ -92,7 +90,6 @@ files:
 - lib/highline/terminal/unix_stty.rb
 - lib/highline/version.rb
 - lib/highline/wrapper.rb
-- setup.rb
 - site/.cvsignore
 - site/highline.css
 - site/images/logo.png
@@ -123,11 +120,7 @@ licenses:
 - Ruby
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--title"
-- HighLine Documentation
-- "--main"
-- README
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -142,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: highline
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: HighLine is a high-level command-line IO library.

data/INSTALL

@@ -1,59 +0,0 @@
-= Installing HighLine
-
-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
-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/README.rdoc

@@ -1,77 +0,0 @@
-= HighLine
-
-by James Edward Gray II
-
-{<img src="https://travis-ci.org/JEG2/highline.svg" alt="Build Status" />}[https://travis-ci.org/JEG2/highline]
-{<img src="https://ci.appveyor.com/api/projects/status/4p05fijpah77d28x?svg=true" alt="AppVeyor Build Status" />}[https://ci.appveyor.com/project/abinoam/highline]
-{<img src="https://img.shields.io/gem/v/highline.svg?style=flat" />}[http://rubygems.org/gems/highline]
-{<img src="https://codeclimate.com/github/JEG2/highline/badges/gpa.svg" />}[https://codeclimate.com/github/JEG2/highline]
-{<img src="https://codeclimate.com/github/JEG2/highline/badges/coverage.svg" />}[https://codeclimate.com/github/JEG2/highline/coverage]
-
-== 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.  
-
-Start hacking in your code with HighLine with:
-
-  require 'highline/import'
-
-== 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.
-
-== Requirements
-
-HighLine from version >= 1.7.0 requires ruby >= 1.9.3
-
-== 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.