mini_readline 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ae245afb8c0c06f6ceb938eca139ce122ac986d
-  data.tar.gz: 9aa4b9661e8d2b2e9d645a1ec3158347d351a81b
+  metadata.gz: 020c03986052ff49549a37360b56b803d5b36cc0
+  data.tar.gz: 0e789a40a83f7cbc4ed39c72e2dd3fa05be64160
 SHA512:
-  metadata.gz: 47de3ca150396c1163f04da730f3f2c403c4f3ff72dee8a1f4069f15dd0b40ca1ca49d5f2fc51d6a8e6b6f504087423d00c5cfac2ee217ca50386739958bb300
-  data.tar.gz: f380c80b7bc5608d962e7aaa1d2af4a53687469c72b5b28a5179dd29a5d89b0a1d9daadb99c53e82cf05c580f08ac55c16752f558861235eba55bddd683005ff
+  metadata.gz: 09caa12ad44af13e3707315c87c0d822518d801bdb6eb8b3bf1aea00ca4135ce129d89b068c038176a4c7574b93d45a93af2c49e7aa934bcc92321917a84b563
+  data.tar.gz: 0aec83925d482a7a3861105f650e13cd3a5b86c58957288de9a753879d9576c5c838de49626a4115c64c6c0d45f53045005380dbc762b077f97a31785f3d14f9

data/lib/mini_readline.rb

@@ -7,10 +7,7 @@ require_relative "mini_readline/options"
 require_relative "mini_readline/raw_term"
 require_relative "mini_readline/read_line"
 
-#The \MiniReadline module. A replacement for the rb_readline gem predicated
-#on the notion/hope that the code shouldn't smell like an abandoned fish
-#processing plant. To this end, it drops the pretext of being compatible
-#with the GNU readline library and instead embraces OOD principles. I hope.
+#The \MiniReadline module.
 #* mini_readline.rb - The root file that gathers up all the system's parts.
 module MiniReadline
 

data/lib/mini_readline/raw_term.rb

@@ -1,33 +1,37 @@
 # coding: utf-8
 
-require_relative 'raw_term/mapper'
+require 'rbconfig'
 
 #* raw_term.rb - Platform determination for raw terminal access.
 module MiniReadline
 
-  #The class used to manipulate console i/o on a low level.
-  class RawTerm
-
-    #Create a mapper.
-    MAP = Mapper.new
-
-    #Map the printable characters.
-    (32..126).each do |code|
-      char = code.chr
-      MAP[char] = [:insert_text, char]
+  host_os = RbConfig::CONFIG['host_os']
+
+  #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
 
-    #Get a mapped sequence.
-    def get_mapped_keystroke
-      MAP.get_mapped_keystroke {get_raw_char}
-    end
-  end
+  #Is Java present in the environment?
+  TERM_JAVA = RUBY_PLATFORM =~ /java/
 
   #Select the type of platform in use.
-  if (RUBY_PLATFORM =~ /\bcygwin\b/i) || (RUBY_PLATFORM !~ /mswin|mingw/)
-    require_relative 'raw_term/other'
-  else
+  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.

data/lib/mini_readline/raw_term/{other.rb → ansi.rb}

@@ -1,14 +1,16 @@
 # coding: utf-8
 
 require          'io/console'
-require_relative 'other/map'
-require_relative 'other/set_posn'
+
+require_relative 'mapped_term'
+require_relative 'ansi/map'
+require_relative 'ansi/set_posn'
 
 #* raw_term/other.rb - Support for raw terminal access in non-windows systems.
 module MiniReadline
 
   #The detected platform is not windows.
-  PLATFORM = :other
+  PLATFORM = :ansi
 
   #The class used to manipulate console i/o on a low level.
   class RawTerm
@@ -22,7 +24,7 @@ module MiniReadline
     #Output a string
     def put_string(str)
       scan_string(str)
-      print(str)
+      STDOUT.print(str)
     end
 
     #Home the cursor and start at a known state.
@@ -32,17 +34,19 @@ module MiniReadline
     end
 
     #Conclude the terminal state.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
     def conclude
       STDIN.cooked!
-      print("\n")
+      STDOUT.print("\n")
     end
 
     #Sound a beep
     #<br>Endemic Code Smells
     #* :reek:UtilityFunction
     def beep
-      $stderr.write(BELL)
-      $stderr.flush
+      STDERR.write(BELL)
+      STDERR.flush
     end
 
     #Get a uncooked character keystroke.

data/lib/mini_readline/raw_term/{other → ansi}/set_posn.rb

@@ -11,9 +11,9 @@ module MiniReadline
       if new_posn == 0
         put_string(CARRIAGE_RETURN)
       elsif new_posn > @cursor_posn
-        print("\e[#{new_posn - @cursor_posn}C")
+        STDOUT.print("\e[#{new_posn - @cursor_posn}C")
       elsif new_posn < @cursor_posn
-        print("\e[#{@cursor_posn - new_posn}D")
+        STDOUT.print("\e[#{@cursor_posn - new_posn}D")
       end
 
       @cursor_posn = new_posn

data/lib/mini_readline/raw_term/mapped_term.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+require_relative 'mapped_term/mapper'
+
+#* raw_term/mapped_term.rb - Base class for a terminal with key mapping.
+module MiniReadline
+
+  #The class used for terminal i/o that is mapped to command sequences.
+  class RawTerm
+
+    #Create a mapper.
+    MAP = Mapper.new
+
+    #Set up the printable characters.
+    MAP.map_ascii(:insert_text)
+
+    #Get a mapped sequence.
+    def get_mapped_keystroke
+      MAP.get_mapped_keystroke {get_raw_char}
+    end
+  end
+
+end

data/lib/mini_readline/raw_term/{mapper.rb → mapped_term/mapper.rb}

@@ -18,6 +18,15 @@ module MiniReadline
       @map[index] = value
     end
 
+    #Map the printable ascii key codes to a command.
+    def map_ascii(command)
+      #Map the printable characters.
+      (32..126).each do |code|
+        value = [command, char = code.chr]
+        self[char] = value
+      end
+    end
+
     #Handle the preamble characters in the command sequence.
     def process_non_terminals(index)
       seq = ""

data/lib/mini_readline/raw_term/windows.rb

@@ -1,6 +1,12 @@
 # coding: utf-8
 
-require_relative 'windows/win_32_api'
+if MiniReadline::TERM_JAVA
+  require 'win32api'
+else
+  require_relative 'windows/win_32_api'
+end
+
+require_relative 'mapped_term'
 require_relative 'windows/map'
 require_relative 'windows/set_posn'
 
@@ -11,8 +17,6 @@ module MiniReadline
   PLATFORM = :windows
 
   #The class used to manipulate console i/o on a low level.
-  #<br>Endemic Code Smells
-  # :reek:TooManyInstanceVariables
   class RawTerm
 
     #The sleep interval waiting for a key to be pressed.
@@ -25,45 +29,72 @@ module MiniReadline
     STD_OUTPUT_HANDLE = -11
 
     #Set up the Windows Raw Terminal.
+    #<br>Singleton Methods Added:
+    #* getch - Low-level get char.
+    #* kbhit - Low-level keyboard hit test.
+    #* beep - Low-level beep.
+    #* set_cursor_posn - Set the cursor position given coordinates (y*65536+x).
+    #* get_screen_info - Get info about the console.
+    #* get_handle - Get the internal handle associated with a file index.
     def initialize
-      @_getch = Win32API.new("msvcrt", "_getch", [], 'I')
-      @_kbhit = Win32API.new("msvcrt", "_kbhit", [], 'I')
-      @_beep  = Win32API.new("user32", "MessageBeep", ['L'])
-      @_set_cursor_posn = Win32API.new("kernel32", "SetConsoleCursorPosition",
-                                       ['L','L'], 'L')
-      @_get_screen_info = Win32API.new("kernel32", "GetConsoleScreenBufferInfo",
-                                       ['L','P'], 'L')
-      @_get_handle = Win32API.new("kernel32", "GetStdHandle", ['L'], 'L')
+      getch_proc = Win32API.new("msvcrt", "_getch", [], 'I')
+      define_singleton_method(:getch) { getch_proc.call.chr }
+
+      kbhit_proc = Win32API.new("msvcrt", "_kbhit", [], 'I')
+      define_singleton_method(:kbhit) { kbhit_proc.call }
+
+      beep_proc  = Win32API.new("user32", "MessageBeep", ['L'], '0')
+      define_singleton_method(:beep) { beep_proc.call }
+
+      set_cursor_posn_proc = Win32API.new("kernel32",
+                                          "SetConsoleCursorPosition",
+                                          ['L','L'], 'L')
+
+      define_singleton_method(:set_cursor_posn) do |position|
+        set_cursor_posn_proc.call(@_out_handle, position)
+      end
+
+      get_screen_info_proc = Win32API.new("kernel32",
+                                          "GetConsoleScreenBufferInfo",
+                                          ['L','P'], 'L')
+
+      define_singleton_method(:get_screen_info) do |buffer|
+        get_screen_info_proc.call(@_out_handle, buffer)
+      end
+
+      get_handle_proc = Win32API.new("kernel32", "GetStdHandle", ['L'], 'L')
+
+      define_singleton_method(:get_handle) do |handle_index|
+        get_handle_proc.call(handle_index)
+      end
+
     end
 
     #Output a string
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
     def put_string(str)
-      print(str)
+      STDOUT.print(str)
     end
 
     #Home the cursor and start at a known state.
     def initialize_parms
-      @_out_handle = @_get_handle.call(STD_OUTPUT_HANDLE)
-      put_string CARRIAGE_RETURN
+      @_out_handle = get_handle(STD_OUTPUT_HANDLE)
+      put_string(CARRIAGE_RETURN)
     end
 
     #Conclude the terminal state.
     def conclude
-      print("\n")
-    end
-
-    #Sound a beep
-    def beep
-      @_beep.call(0)
+      put_string("\n")
     end
 
     #Get a uncooked character keystroke.
     def get_raw_char
-      while (@_kbhit.call == 0)
+      while (kbhit == 0)
         sleep(WAIT_SLEEP)
       end
 
-      @_getch.call.chr
+      getch
     end
   end
 end

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

@@ -9,10 +9,10 @@ module MiniReadline
     #Move the cursor using windows voodoo API.
     def set_posn(new_posn)
       raw_buffer = 0.chr * 24
-      @_get_screen_info.call(@_out_handle, raw_buffer)
+      get_screen_info(raw_buffer)
       y_posn = (raw_buffer[6,2].unpack('S'))[0]
 
-      @_set_cursor_posn.call(@_out_handle, y_posn * 65536 + new_posn)
+      set_cursor_posn(y_posn * 65536 + new_posn)
     end
 
   end

data/lib/mini_readline/read_line/prompt.rb

@@ -13,6 +13,7 @@ module MiniReadline
     #Get the length without ANSI sequences.
     attr_reader :length
 
+    #Create a special prompt text.
     def initialize(text)
       @text = text
       @length = text.gsub(/\x1B\[(\d|;)*[@-~]/, "").length

data/lib/mini_readline/version.rb

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

data/rakefile.rb

@@ -10,7 +10,7 @@ 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", "README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb", "license.txt")
 
   #Make all access levels visible.
   rdoc.options << '--visibility' << 'private'
@@ -43,3 +43,12 @@ task :vers do |t|
   puts
   puts "mini_readline version = #{MiniReadline::VERSION}"
 end
+
+desc "What is the module load out?"
+task :vls do |t|
+  require 'vls'
+
+  puts
+  VersionLS.print_vls(/./)
+end
+

data/tests/mini_readline_tests.rb

@@ -32,10 +32,10 @@ class MiniReadlineTester < Minitest::Test
   end
 
   def test_platform_detection
-    if (RUBY_PLATFORM =~ /\bcygwin\b/i) || (RUBY_PLATFORM !~ /mswin|mingw/)
-      assert_equal(:other, MiniReadline::PLATFORM)
-    else
+    if (MiniReadline::TERM_PLATFORM == :windows)
       assert_equal(:windows, MiniReadline::PLATFORM)
+    else
+      assert_equal(:other, MiniReadline::PLATFORM)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-13 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -88,10 +88,11 @@ files:
 - lib/mini_readline/exceptions.rb
 - lib/mini_readline/options.rb
 - lib/mini_readline/raw_term.rb
-- lib/mini_readline/raw_term/mapper.rb
-- lib/mini_readline/raw_term/other.rb
-- lib/mini_readline/raw_term/other/map.rb
-- lib/mini_readline/raw_term/other/set_posn.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/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