mini_readline 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66df58b8ca2e0db8aaf7f468d2875e319d85015b
-  data.tar.gz: 51b5958f048e2d2a9271df178c6ff858f4d98040
+  metadata.gz: 68a9bb122c272cbd3d0bdf26532cca602a75e140
+  data.tar.gz: 80fd1b109e5cdb190d4120f8762e1405cf533a9c
 SHA512:
-  metadata.gz: cabf7deb7ab36fcd201205de153e473f139593d752bfc19323ff03082aaa7eb4e2072096639da32ed30324395c5c3fc6d067a2ba60bcefce6d4a66f2e553d02b
-  data.tar.gz: a1fef7fd990291969cf1f0ef7bdbeaebc75a0a507bef7878675dd76200befc2b96e518c628dc6e3e7d3a5f068175746f81d93942ff6ae55c582c7663f931dfed
+  metadata.gz: e1a2dc21e88852da17e13cdf543232daaec3aac8def1b966e8984fd8084478183d18d28904d5c02295254501a369e7be86123c15149cee43eb95955f9ac4b8de
+  data.tar.gz: a4b000eb3ee2d956521f0a538c54863ed77a2908c0e6b71dc64e589aca38a60e74cc251b3c327f970ecd8930657f475770d70ec084bcb889219370d46f5d8e4b

data/README.md

@@ -6,12 +6,8 @@ inline editing, command history, and stock or customizable auto-complete.
 The mini readline gem is an experiment in replacing the standard readline gem
 that is part of Ruby. The mini readline project will try to focus on the needs
 of Ruby programs. It will also try to correct a number of irritating issues
-encountered when running cross platform environments.
-
-The mini_readline gem is designed for use with MRI version 1.9.3 or later. The
-long term goal is to be as portable to as many versions of ruby as is
-possible. To this end, portability usage (problem) experiences are especially
-desired. (See the Testing and Contributing sections below.)
+encountered when running cross platform environments. See Cross Platform
+Portability Progress below for more details.
 
 ## Installation
 
@@ -130,7 +126,7 @@ can be accomplished with these options settings.
 
 ##### Module Aliasing [Support Ended]
 
-In an attempt to enhance compatibility, the mini_readline gem has the ability
+In an attempt to enhance compatibility, the mini_readline gem had the ability
 to alias itself as the readline gem. This feature was found to be unworkable
 and has been removed as of Version 0.7.0.
 
@@ -230,10 +226,8 @@ BASE_OPTIONS = {
   :initial       => "",       #The initial text for the entry.
                               #An empty string for none.
 
-  :term          => nil,      #Filled in by raw_term.rb
+  :term          => nil}      #Filled in by raw_term.rb
                               #MiniReadline::RawTerm
-
-  :debug         => false}    #Used during development only.
 ```
 
 <br>While most of these options are self explanatory, a few could stand some
@@ -382,7 +376,7 @@ if all fails, it will load the "classic" Readline gem. Here is a typical run:
     Loaded mini_readline from the local code folder.
 
     Welcome to a Simple Interactive Ruby Environment
-    Use the command 'q' to quit.
+    Use the command 'quit' to exit.
 
     SIRE>
 Of note, the run method can be used to test for the shell process bug. For
@@ -411,17 +405,36 @@ system gem, use this:
 
     $ ruby sire.rb local
 
-## Testing
-To date this code has been tested under:
-* Windows 7 with ruby 1.9.3p484 (2013-11-22) [i386-mingw32]
-* Windows 7 with ruby 2.1.6p336 (2015-04-13 revision 50298) [i386-mingw32]
-* Windows 7+Cygwin with ruby 2.2.3p173 (2015-08-18 revision 51636) [i386-cygwin]
+## Cross Platform Portability Progress
+
+The mini_readline gem was initially designed for use with MRI version 1.9.3 or
+later. The long term goal is to be as portable to as many versions of Ruby and
+on as many operating systems platforms as is possible. So far the matrix of
+support looks like:
+
+Ruby           | Win32   | Win64   | Cygwin  | Linux   | Mac
+---------------|---------|---------|---------|---------|---------
+ruby 1.9.3p484 | Yes     | Yes     | ?       | ?       | ?
+ruby 2.1.6p336 | Yes     | ?       | ?       | ?       | ?
+ruby 2.2.3p173 | ?       | ?       | Yes     | ?       | ?
+jruby 9.1.5.0  | ~Yes    | ?       | Planned | Planned | Planned
+rubinius       | N/A     | N/A     | N/A     | Maybe   | Maybe
+
+<br>Where:
 
-<br>**More testing is clearly called for and suggestions/bug reports are most
-welcomed!!!**
+* 'Yes' means good to go! Coded and tested OK!
+* '~Yes' means mostly working but still some minor issues (See issue #7).
+* '?' _should_ work but are untested.
+* 'Planned' are not there yet and some work and much testing are needed.
+* 'N/A' entries reflect the fact that Rubinius does not run under Windows.
+* 'Maybe' entries are not on the radar now, but maybe later.
+
+There is clearly a lot of work to do.
 
 ## Contributing
 
+All participation is welcomed. There are two fabulous plans to choose from:
+
 #### Plan A
 
 1. Fork it ( https://github.com/PeterCamilleri/mini_readline/fork )
@@ -434,11 +447,7 @@ welcomed!!!**
 #### Plan B
 
 Go to the GitHub repository and raise an issue calling attention to some
-aspect that could use some TLC or a suggestion or an idea.
-
-
-## License
-
-The gem is available as open source under the terms of the MIT License. Please
-see LICENSE.txt for further details.
+aspect that could use some TLC or a suggestion or an idea. Please see
+( https://github.com/PeterCamilleri/mini_readline/issues )
 
+This is a low pressure environment. All are welcome!

data/lib/mini_readline/options.rb

@@ -29,9 +29,7 @@ module MiniReadline
                   :initial       => "",       #The initial text for the entry.
                                               #An empty string for none.
 
-                  :term          => nil,      #Filled in by raw_term.rb
+                  :term          => nil}      #Filled in by raw_term.rb
                                               #MiniReadline::RawTerm
 
-                  :debug         => false     #Used during development only.
-                 }
 end

data/lib/mini_readline/raw_term.rb

@@ -5,7 +5,9 @@ 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 =

data/lib/mini_readline/raw_term/windows.rb

@@ -44,7 +44,7 @@ module MiniReadline
       define_singleton_method(:kbhit) { kbhit_proc.call }
 
       beep_proc  = Win32API.new("user32", "MessageBeep", ['L'], '0')
-      define_singleton_method(:beep) { beep_proc.call(0) }
+      define_singleton_method(:beep) { beep_proc.call }
 
       set_cursor_posn_proc = Win32API.new("kernel32",
                                           "SetConsoleCursorPosition",

data/lib/mini_readline/read_line/edit/unmapped.rb

@@ -8,10 +8,6 @@ module MiniReadline
 
     #An unmapped key was pressed. Beep!
     def unmapped(keyboard_args)
-      if @options[:debug]
-        puts keyboard_args.inspect
-      end
-
       @term.beep
     end
   end

data/lib/mini_readline/version.rb

@@ -1,4 +1,4 @@
 module MiniReadline
   #The current version of the mini_readline gem.
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/mini_readline.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
                          Intermediate Range Ballistic Missile.
                         }.gsub(/\s+/, ' ').strip
 
-  spec.homepage      = "https://github.com/PeterCamilleri/mini_readline"
+  spec.homepage      = "http://teuthida-technologies.com/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/sire.rb

@@ -3,14 +3,15 @@
 
 require 'pp'
 
-if ARGV[0] == 'old'
-  require 'readline'
-  $old = true
-
-  class MiniReadlineEOI < StandardError
-  end
+#Some SIRE control variables.
+$sire_done    = false
+$sire_binding = binding
+$sire_old     = (ARGV[0] == 'old') || defined?(Readline)
 
-  puts "\nOption(old). Loaded the standard readline gem. Version #{Readline::VERSION}"
+if $sire_old
+  require 'readline'
+  class MiniReadlineEOI < StandardError; end #Compatibility stub.
+  puts "\nLoaded the standard readline gem. Version #{Readline::VERSION}"
 elsif ARGV[0] == 'local'
   require './lib/mini_readline'
   puts "\nOption(local). Loaded mini_readline from the local code folder. Version #{MiniReadline::VERSION}"
@@ -49,25 +50,20 @@ class Object
       result
     end
   end
-end
 
-class SIRE
-  #Set up the interactive session.
-  def initialize
-    @_done = false
-  end
+  private
 
   #Quit the interactive session.
-  def q
-    @_done = true
+  def quit
+    $sire_done = true
     puts
     "Quit command."
   end
 
   #Get a mapped keystroke.
-  def g
-    if $old
-      print 'Not supported by old readline.'
+  def get_mapped
+    if $sire_old
+      puts 'Not supported by old readline.'
     else
       print 'Press a key:'
       MiniReadline::BASE_OPTIONS[:term].get_mapped_keystroke
@@ -82,36 +78,24 @@ class SIRE
     end
   end
 
-  #Execute a single line.
-  def exec_line(line)
-    result = eval line
-    pp result unless line.length == 0
-
-  rescue Interrupt => e
-    puts "\nExecution Interrupted!"
-    puts "\n#{e.class} detected: #{e}\n"
-    puts e.backtrace
-    puts "\n"
+end
 
-  rescue Exception => e
-    puts "\n#{e.class} detected: #{e}\n"
-    puts e.backtrace
-    puts
-  end
+#The SIRE class contains the simplistic R.E.P.L.
+class SIRE
 
   #Run the interactive session.
   def run_sire
-    unless $old
+    unless $sire_old
       MiniReadline::BASE_OPTIONS[:auto_complete] = true
       MiniReadline::BASE_OPTIONS[:eoi_detect] = true
     end
 
     puts
     puts "Welcome to a Simple Interactive Ruby Environment\n"
-    puts "Use the command 'q' to quit.\n\n"
+    puts "Use the command 'quit' to exit.\n\n"
 
-    until @_done
-      exec_line(Readline.readline("SIRE>", true))
+    until $sire_done
+      exec_line(get_line)
     end
 
     puts "\n\n"
@@ -120,6 +104,40 @@ class SIRE
     puts "\n"
   end
 
+  private
+
+  #Get a line of input from the user.
+  def get_line
+    initial_input = Readline.readline("SIRE>", true)
+    get_extra_input(initial_input)
+  end
+
+  #Get any continuations of the inputs
+  def get_extra_input(str)
+    if /\\\s*$/ =~ str
+      get_extra_input($PREMATCH + "\n" + Readline.readline("SIRE\\", true))
+    else
+      str
+    end
+  end
+
+  #Execute a single line.
+  def exec_line(line)
+    result = $sire_binding.eval(line)
+    pp result unless line.length == 0
+
+  rescue Interrupt => e
+    puts "\nExecution Interrupted!"
+    puts "\n#{e.class} detected: #{e}\n"
+    puts e.backtrace
+    puts "\n"
+
+  rescue Exception => e
+    puts "\n#{e.class} detected: #{e}\n"
+    puts e.backtrace
+    puts
+  end
+
 end
 
 if __FILE__ == $0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -135,7 +135,7 @@ files:
 - reek.txt
 - sire.rb
 - tests/mini_readline_tests.rb
-homepage: https://github.com/PeterCamilleri/mini_readline
+homepage: http://teuthida-technologies.com/
 licenses:
 - MIT
 metadata: {}