mini_readline 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68a9bb122c272cbd3d0bdf26532cca602a75e140
-  data.tar.gz: 80fd1b109e5cdb190d4120f8762e1405cf533a9c
+  metadata.gz: c95e47d89d4da95acdbd7f8e0ae7008012bf1066
+  data.tar.gz: 4c3e1c916492b4c31aaab3edc1e4a15c6dfc4fbc
 SHA512:
-  metadata.gz: e1a2dc21e88852da17e13cdf543232daaec3aac8def1b966e8984fd8084478183d18d28904d5c02295254501a369e7be86123c15149cee43eb95955f9ac4b8de
-  data.tar.gz: a4b000eb3ee2d956521f0a538c54863ed77a2908c0e6b71dc64e589aca38a60e74cc251b3c327f970ecd8930657f475770d70ec084bcb889219370d46f5d8e4b
+  metadata.gz: a3d3c236b0853b86719e628d4627420bfe89fa7ebd02c38dda626a9df1d3b4fad37a779230819593e0b1291c60456fb8a95f0d5eb291778513d76c2e6c5a0ac7
+  data.tar.gz: f90214f1d610e02ce7dc28859654c6ca97b2e67cb0dfc6e62c76a18f1a121834b593d4f42ff1cc6a48898aa2dc69998fe5891acdbe4b1a65842f3bf59aa075bd

data/README.md

@@ -73,7 +73,7 @@ There are a number of demo/test programs available for the mini_readline gem.
 These are:
 
     $ irbm
-    Starting an IRB console with mini_readline.
+    Starting an IRB console with mini_readline (0.7.2).
     irb(main):001:0>
 
 This runs against the most recently installed gem. Also available in the gem
@@ -201,8 +201,7 @@ entries.
 <br>The available options are described below:
 ```ruby
 BASE_OPTIONS = {
-  :window_width  => 79,       #The width of the edit area.
-  :scroll_step   => 12,       #The amount scrolled.
+  :scroll_step   => 12,       #The amount horizontally scrolled.
 
   :prompt        => ">",      #The default prompt.
   :alt_prompt    => "<< ",    #The prompt when scrolled.
@@ -265,6 +264,10 @@ further actions on the part of the user. The terminal support class can be
 changed, to a user supplied class, to get data from another source, such as
 a serial attached terminal.
 
+Finally the :window_width option is now ignored. Screen width now automatically
+determined.
+
+
 #### Notes
 * Since the compatibility mode does not accept an options hash, the only way to
 affect options in this case is to modify the MiniReadline::BASE_OPTIONS hash.
@@ -352,6 +355,9 @@ options.
 statement to permit the use of clearer, easier to read access to regular
 expression results.
 
+<br> An example of a custom auto-complete facility may be found in the mysh
+gem located at: https://github.com/PeterCamilleri/mysh/blob/master/lib/mysh/user_input/smart_source.rb
+
 ### Important Security Note
 
 It must be remembered that any time strings are passed to the command line
@@ -417,13 +423,13 @@ 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
+jruby 9.1.5.0  | Mostly  | ?       | Planned | Planned | Planned
 rubinius       | N/A     | N/A     | N/A     | Maybe   | Maybe
 
 <br>Where:
 
 * 'Yes' means good to go! Coded and tested OK!
-* '~Yes' means mostly working but still some minor issues (See issue #7).
+* 'Mostly' is 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.

data/lib/mini_readline/options.rb

@@ -4,8 +4,7 @@
 module MiniReadline
 
   #The base options shared by all instances.
-  BASE_OPTIONS = {:window_width  => 79,       #The width of the edit area.
-                  :scroll_step   => 12,       #The amount scrolled.
+  BASE_OPTIONS = {:scroll_step   => 12,       #The amount scrolled.
 
                   :prompt        => ">",      #The default prompt.
                   :alt_prompt    => "<< ",    #The prompt when scrolled.

data/lib/mini_readline/raw_term.rb

@@ -29,13 +29,19 @@ module MiniReadline
   #Is Java present in the environment?
   TERM_JAVA = RUBY_PLATFORM =~ /java/
 
-  #Select the type of platform in use.
-  if TERM_PLATFORM == :windows
-    require_relative 'raw_term/windows'
-  else
-    require_relative 'raw_term/ansi'
+  #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
 
-  #Get an instance of a raw terminal controller object.
-  BASE_OPTIONS[:term] = RawTerm.new
 end

data/lib/mini_readline/raw_term/ansi.rb

@@ -5,8 +5,9 @@ require          'io/console'
 require_relative 'mapped_term'
 require_relative 'ansi/map'
 require_relative 'ansi/set_posn'
+require_relative 'ansi/window_width'
 
-#* raw_term/other.rb - Support for raw terminal access in non-windows systems.
+#* raw_term/ansi.rb - Support for raw terminal access in non-windows systems.
 module MiniReadline
 
   #The detected platform is not windows.

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

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+#* ansi/window_width.rb - Determine the available screen width.
+module MiniReadline
+
+  #* ansi/window_width.rb - Determine the available screen width.
+  class RawTerm
+
+    #Determine the available screen width.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def window_width
+      IO.console.winsize[1]
+    end
+
+  end
+end

data/lib/mini_readline/raw_term/windows.rb

@@ -9,6 +9,7 @@ end
 require_relative 'mapped_term'
 require_relative 'windows/map'
 require_relative 'windows/set_posn'
+require_relative 'windows/window_width'
 
 #* raw_term/windows.rb - Support for raw terminal access in windows systems.
 module MiniReadline
@@ -44,7 +45,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 }
+      define_singleton_method(:beep) { beep_proc.call(0) }
 
       set_cursor_posn_proc = Win32API.new("kernel32",
                                           "SetConsoleCursorPosition",

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

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+#* windows/window_width.rb - Determine the available screen width.
+module MiniReadline
+
+  #* windows/window_width.rb - Determine the available screen width.
+  class RawTerm
+
+    #Determine the available screen width.
+    def window_width
+      raw_buffer = 0.chr * 24
+      get_screen_info(raw_buffer)
+      (raw_buffer[0,2].unpack('S'))[0]
+    end
+
+  end
+end

data/lib/mini_readline/read_line.rb

@@ -58,9 +58,13 @@ module MiniReadline
 
     #Set up the options
     def set_options(options)
-      @options = MiniReadline::BASE_OPTIONS.merge(instance_options)
-      @options.merge!(options)
+      @options = MiniReadline::BASE_OPTIONS
+                   .merge(instance_options)
+                   .merge(options)
+
       (@term = @options[:term]).initialize_parms
+
+      @options[:window_width] = @term.window_width - 1
       set_prompt(@options[:prompt])
       verify_mask(@options[:secret_mask])
     end

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

@@ -7,7 +7,7 @@ module MiniReadline
   class Edit
 
     #An unmapped key was pressed. Beep!
-    def unmapped(keyboard_args)
+    def unmapped(_keyboard_args)
       @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.1"
+  VERSION = "0.7.2"
 end

data/mini_readline.gemspec

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

data/mini_readline.reek

@@ -24,6 +24,9 @@ DuplicateMethodCall:
 FeatureEnvy:
   enabled: true
   exclude: []
+InstanceVariableAssumption:
+  enabled: false
+  exclude: []
 IrresponsibleModule:
   enabled: true
   exclude: []

data/tests/mini_readline_tests.rb

@@ -193,7 +193,7 @@ class MiniReadlineTester < Minitest::Test
   end
 
   def test_prompt_verification
-    opts = {prompt: ">"*20, window_width: 39}
+    opts = {prompt: ">"*70}
     edit = MiniReadline::Readline.new()
     assert_raises(RuntimeError) {edit.readline(opts)}
   end

metadata

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