mini_readline 0.8.1 → 0.9.0

data/lib/mini_readline/version.rb

@@ -1,4 +1,10 @@
+# coding: utf-8
+
+# Version info for the gem.
 module MiniReadline
   #The current version of the mini_readline gem.
-  VERSION = "0.8.1"
+  VERSION = "0.9.0".freeze
+
+  # A brief description.
+  DESCRIPTION = "Get console input with edit, history, and auto-complete.".freeze
 end

data/mini_readline.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Peter Camilleri"]
   spec.email         = ["peter.c.camilleri@gmail.com"]
 
-  spec.summary       = "A simplified replacement for readline."
+  spec.summary       = "Get console input with edit, history, and auto-complete."
   spec.description   = %{A gem, for console command entry with line edit and
                          history, inspired by the standard readline gem. Also
                          included are four sample auto-complete agents and the
@@ -25,13 +25,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>=1.9.3'
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency     'mini_term', "~> 0.1.0"
 
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency 'minitest', "~> 5.7"
   spec.add_development_dependency 'minitest_visible', "~> 0.1"
-  spec.add_development_dependency 'rdoc', "~> 5.0"
-  spec.add_development_dependency 'reek', "~> 4.5"
+  spec.add_development_dependency 'reek', ">= 5.0.2"
 
 end

data/rakefile.rb

@@ -2,25 +2,8 @@
 # coding: utf-8
 
 require 'rake/testtask'
-require 'rdoc/task'
 require "bundler/gem_tasks"
 
-#Generate internal documentation with rdoc.
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-
-  #List out all the files to be documented.
-  rdoc.rdoc_files.include("lib/**/*.rb", "license.txt")
-
-  #Make all access levels visible.
-  rdoc.options << '--visibility' << 'private'
-  #rdoc.options << '--verbose'
-  #rdoc.options << '--coverage-report'
-
-  #Set a title.
-  rdoc.options << '--title' << 'Mini Readline Gem'
-end
-
 #Run the mini_readline unit test suite.
 Rake::TestTask.new do |t|
   #List out all the test files.
@@ -44,11 +27,13 @@ task :vers do |t|
   puts "mini_readline version = #{MiniReadline::VERSION}"
 end
 
-desc "What is the module load out?"
-task :vls do |t|
-  require 'vls'
+desc "Alternative test procedure."
+task :alt_test do |t, args|
+  here  = File.dirname(__FILE__)
+  target = "#{here}/tests/*.rb"
 
-  puts
-  VersionLS.print_vls(/./)
-end
+  block = "{|file| require file if File.basename(file) =~ /test/}"
+  code  = "Dir['#{target}'].each #{block}"
 
+  system "ruby -e\"#{code}\""
+end

data/sire.rb

@@ -66,7 +66,7 @@ class Object
       puts 'Not supported by old readline.'
     else
       print 'Press a key:'
-      MiniReadline::BASE_OPTIONS[:term].get_mapped_keystroke
+      MiniTerm.get_mapped_char
     end
   end
 

data/tests/mini_readline_tests.rb

@@ -11,6 +11,19 @@ class MiniReadlineTester < Minitest::Test
   #Track mini-test progress.
   include MinitestVisible
 
+  def test_that_it_has_a_version_number
+    refute_nil ::MiniReadline::VERSION
+    assert(::MiniReadline::VERSION.frozen?)
+    assert(::MiniReadline::VERSION.is_a?(String))
+    assert(/\A\d+\.\d+\.\d+/ =~ ::MiniReadline::VERSION)
+  end
+
+  def test_that_it_has_a_description
+    refute_nil ::MiniReadline::DESCRIPTION
+    assert(::MiniReadline::DESCRIPTION.frozen?)
+    assert(::MiniReadline::DESCRIPTION.is_a?(String))
+  end
+
   def test_that_module_entities_exists
     assert_equal(Module, MiniReadline.class)
     assert_equal(String, MiniReadline::VERSION.class)
@@ -24,20 +37,6 @@ class MiniReadlineTester < Minitest::Test
     refute_equal(MiniReadline::BASE_OPTIONS, edit.instance_options)
   end
 
-  def test_mapper_checking
-    MiniReadline::RawTerm::MAP["\xC0test"] = [:go_left]
-
-    assert_raises(MiniReadlineKME) { MiniReadline::RawTerm::MAP["\xC0t"]    = [:go_left] }
-    assert_raises(MiniReadlineKME) { MiniReadline::RawTerm::MAP["\xC0test"] = [:go_left] }
-  end
-
-  def test_platform_detection
-    if (MiniReadline::TERM_PLATFORM == :windows)
-      assert_equal(:windows, MiniReadline::PLATFORM)
-    else
-      assert_equal(:other, MiniReadline::PLATFORM)
-    end
-  end
 
   def test_reading_a_line
     puts

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-16 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_term
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 5.0.2
 description: A gem, for console command entry with line edit and history, inspired
   by the standard readline gem. Also included are four sample auto-complete agents
   and the irbm utility, which is irb + mini_readline and not an Intermediate Range
@@ -114,19 +114,8 @@ files:
 - irbt.rb
 - lib/mini_readline.rb
 - lib/mini_readline/exceptions.rb
+- lib/mini_readline/maps.rb
 - lib/mini_readline/options.rb
-- lib/mini_readline/raw_term.rb
-- lib/mini_readline/raw_term/ansi.rb
-- lib/mini_readline/raw_term/ansi/map.rb
-- lib/mini_readline/raw_term/ansi/set_posn.rb
-- lib/mini_readline/raw_term/ansi/window_width.rb
-- lib/mini_readline/raw_term/mapped_term.rb
-- lib/mini_readline/raw_term/mapped_term/mapper.rb
-- lib/mini_readline/raw_term/windows.rb
-- lib/mini_readline/raw_term/windows/map.rb
-- lib/mini_readline/raw_term/windows/set_posn.rb
-- lib/mini_readline/raw_term/windows/win_32_api.rb
-- lib/mini_readline/raw_term/windows/window_width.rb
 - lib/mini_readline/read_line.rb
 - lib/mini_readline/read_line/edit.rb
 - lib/mini_readline/read_line/edit/auto_complete.rb
@@ -177,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -188,5 +177,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: A simplified replacement for readline.
+summary: Get console input with edit, history, and auto-complete.
 test_files: []

data/lib/mini_readline/raw_term.rb

@@ -1,47 +0,0 @@
-# coding: utf-8
-
-require 'rbconfig'
-
-#* raw_term.rb - Platform determination for raw terminal access.
-module MiniReadline
-
-  # :stopdoc:
-  host_os = RbConfig::CONFIG['host_os']
-  # :startdoc:
-
-  #What operating platform is in effect?
-  TERM_PLATFORM =
-    case host_os
-    when /mswin|msys|mingw|bccwin|wince|emc/
-      :windows
-    when /cygwin/
-      :cygwin
-    when /darwin|mac os/
-      :macosx
-    when /linux/
-      :linux
-    when /solaris|bsd/
-      :unix
-    else
-      raise "Unknown os: #{host_os.inspect}"
-    end
-
-  #Is Java present in the environment?
-  TERM_JAVA = RUBY_PLATFORM =~ /java/
-
-  #Only install a terminal if one is not already provided.
-  unless BASE_OPTIONS[:term]
-
-    #Select the type of platform in use.
-    if TERM_PLATFORM == :windows
-      require_relative 'raw_term/windows'
-    else
-      require_relative 'raw_term/ansi'
-    end
-
-    #Get an instance of a raw terminal controller object.
-    BASE_OPTIONS[:term] = RawTerm.new
-
-  end
-
-end

data/lib/mini_readline/raw_term/ansi.rb

@@ -1,70 +0,0 @@
-# coding: utf-8
-
-require          'io/console'
-
-require_relative 'mapped_term'
-require_relative 'ansi/map'
-require_relative 'ansi/set_posn'
-require_relative 'ansi/window_width'
-
-#* raw_term/ansi.rb - Support for raw terminal access in non-windows systems.
-module MiniReadline
-
-  #The detected platform is not windows.
-  PLATFORM = :ansi
-
-  #The class used to manipulate console i/o on a low level.
-  class RawTerm
-
-    CARRIAGE_RETURN = "\x0D"
-    BELL = "\x07"
-
-    #Output a string
-    def put_string(str)
-      scan_string(str)
-      STDOUT.print(str)
-    end
-
-    #Home the cursor and start at a known state.
-    def initialize_parms
-      put_string CARRIAGE_RETURN
-      STDIN.raw!
-    end
-
-    #Conclude the terminal state.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
-    def conclude
-      STDIN.cooked!
-      STDOUT.print("\n")
-    end
-
-    #Sound a beep
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
-    def beep
-      STDERR.write(BELL)
-      STDERR.flush
-    end
-
-    #Get a uncooked character keystroke.
-    #<br>Notes
-    #* This needs to be tested under Linux, Cygwin, and Apple.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction -- For now, the way things are.
-    def get_raw_char
-      STDIN.getch
-    end
-
-    #Determine the affect of a string on the cursor.
-    def scan_string(str)
-      str.chars.each do |char|
-        if char == CARRIAGE_RETURN
-          @cursor_posn = 0
-        else
-          @cursor_posn += 1
-        end
-      end
-    end
-  end
-end

data/lib/mini_readline/raw_term/ansi/map.rb

@@ -1,68 +0,0 @@
-# coding: utf-8
-
-#* other/map.rb - Character mapping for other systems.
-module MiniReadline
-
-  #* other/map.rb - Character mapping for other systems.
-  class RawTerm
-
-    #Map the non-printing characters.
-
-    #Left Arrows
-    MAP["\e[D"]  = [:go_left]
-    MAP["\eOD"]  = [:go_left]
-    MAP["\x02"]  = [:go_left]
-
-    MAP["\e[1;5D"] = [:word_left]
-    MAP["\eb"]     = [:word_left]
-
-    #Right Arrows
-    MAP["\e[C"]  = [:go_right]
-    MAP["\eOC"]  = [:go_right]
-    MAP["\x06"]  = [:go_right]
-
-    MAP["\e[1;5C"] = [:word_right]
-    MAP["\ef"]     = [:word_right]
-
-    #Up Arrows
-    MAP["\e[A"]  = [:previous_history]
-    MAP["\eOA"]  = [:previous_history]
-    MAP["\x12"]  = [:previous_history]
-
-    #Down Arrows
-    MAP["\e[B"]  = [:next_history]
-    MAP["\eOB"]  = [:next_history]
-
-    #The Home keys
-    MAP["\e[H"]  = [:go_home]
-    MAP["\eOH"]  = [:go_home]
-    MAP["\x01"]  = [:go_home]
-
-    #The End keys
-    MAP["\e[F"]  = [:go_end]
-    MAP["\eOF"]  = [:go_end]
-    MAP["\x05"]  = [:go_end]
-
-    #The Backspace key
-    MAP["\x7F"]  = [:delete_left]
-    MAP["\x08"]  = [:delete_left]
-    MAP["\x15"]  = [:delete_all_left]
-
-    #The Delete keys
-    MAP["\x1F"]  = [:delete_right]
-    MAP["\e[3~"] = [:delete_right]
-    MAP["\x0B"]  = [:delete_all_right]
-
-    #Auto-completion.
-    MAP["\t"]    = [:auto_complete]
-
-    #The Enter key
-    MAP["\x0D"]  = [:enter]
-
-    #The Cancel key
-    MAP["\f"]    = [:cancel]
-
-    #End of Input
-    MAP["\ez"] = [:end_of_input]
-  end
-end

data/lib/mini_readline/raw_term/ansi/set_posn.rb

@@ -1,22 +0,0 @@
-# coding: utf-8
-
-#* windows/set_posn.rb - Set the column of the cursor.
-module MiniReadline
-
-  #* windows/set_posn.rb - Set the column of the cursor.
-  class RawTerm
-
-    #Move the cursor using terminal primitives.
-    def set_posn(new_posn)
-      if new_posn == 0
-        put_string(CARRIAGE_RETURN)
-      elsif new_posn > @cursor_posn
-        STDOUT.print("\e[#{new_posn - @cursor_posn}C")
-      elsif new_posn < @cursor_posn
-        STDOUT.print("\e[#{@cursor_posn - new_posn}D")
-      end
-
-      @cursor_posn = new_posn
-    end
-  end
-end