mini_readline 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93b007ca4b55761c9dc6f4ddae5e6d45bd118a63
-  data.tar.gz: d1f1f3750bbe1b621b8a2c624d6e009e40eec839
+  metadata.gz: 5cb399d7a4ffc7fcf703330024c6422386ff2c67
+  data.tar.gz: 748e2eacc096c0eadd51b84f79586b411d1abfa6
 SHA512:
-  metadata.gz: 2a2a9ff735c9918757542baf9ae5800d63154d0c0ad795f2b172ba4d7063de5bf89865efa42aa4c87929966e474e7c22ec9e87c5047b6bed730fd3568d09c114
-  data.tar.gz: ea4ef0dfc1a29f67dec243961bcee04e8f419098f6b3168ef966a01068ec6bc4eebd56f5386d3cbc9bf23d8e3286429fe63d2a876bdcb26ee54060f70c5c49cd
+  metadata.gz: 63c11cfeaf488a056405e9b8f6b0c07536b6ef3727d7d584b516f2252c1af8272fe35c2f35f9c5b41d7d2c5de13f8b5b7bc09a9329b3e12db23e03c7da2db939
+  data.tar.gz: acc1855c61e90bba831229f9a05bbfc125371075ba48a4bd8baf2a5fbd695c18495ca4244c1ca19d76ea5bda978a72dfcc56aa65df3622bfbab9ab50e05834d3

data/README.md

@@ -59,7 +59,7 @@ Erase All        | Escape                           | Ctrl-L
 ### Notes
 * The label "Other" is an umbrella that bundles together the Linux, Mac,
 and Cygwin platforms.
-* References to Keypad keys under Windows assume that Num Lock is not engaged.
+* References to Pad keys under Windows assume that Num Lock is not engaged.
 
 ## Usage
 
@@ -135,11 +135,25 @@ hist << "launch --weapons:nuclear --all"
 ```
 
 ### Options
-In mini_readline, options exist at two levels:
+In mini_readline, options exist at three levels:
 * The MiniReadline module hash BASE_OPTIONS. These options are shared by
-all instances of the Readline class.
+all instances of the Readline class. These options can be modified by
+changing entries in the MiniReadline::BASE_OPTIONS hash.
+* The instance options associated with each instance of the Readline class.
+These options may be specified when a Readline instance is created (with new)
+or by getting the instance options with the instance_options property and
+adding/changing entries to/in it.
 * The options hash argument of the Readline class's readline instance method.
 
+<br>The options in effect during a read line operation are expressed as:
+
+```ruby
+MiniReadline::BASE_OPTIONS.merge(instance_options).merge(options)
+```
+<br>This means that instance_options entries override those in BASE_OPTION and
+readline parameter option entries override both instance_options and BASE_OPTION
+entries.
+
 <br>The available options are described below:
 ```ruby
 BASE_OPTIONS = {
@@ -148,6 +162,7 @@ BASE_OPTIONS = {
   :alt_prompt    => "<< ",    #The prompt when scrolled.
                               #Set to nil for no alt prompt.
 
+  :history       => false,    #Is the history buffer enabled?
   :no_blanks     => true,     #No empty lines in history.
   :no_dups       => true,     #No duplicate lines in history.
 
@@ -210,7 +225,7 @@ and not go bannanas. To test the behavior of the standard readline library, use:
     $ ruby sire.rb old
 
 To test the local copy of mini_readline in the lib folder instead of the
-system gem, use this instead:
+system gem, use this:
 
     $ ruby sire.rb local
 

data/lib/mini_readline.rb

@@ -12,14 +12,12 @@ require_relative "mini_readline/raw_term"
 #* mini_readline.rb - The root file that gathers up all the system's parts.
 module MiniReadline
 
-  #The instances of Readline with and without history.
-  @readers = {true => Readline.new([]), false => Readline.new(nil)}
+  #The shared instance of Readline.
+  @reader = Readline.new()
 
   #The (limited) compatibility module function.
-  #<br>Endemic Code Smells
-  #* :reek:BooleanParameter -- Required for compatibility
-  def self.readline(prompt, history = false)
-    @readers[history].readline(prompt)
+  def self.readline(prompt, history = nil)
+    @reader.readline(prompt, history: history)
   end
 end
 

data/lib/mini_readline/options.rb

@@ -7,8 +7,9 @@ module MiniReadline
   BASE_OPTIONS = {:window_width  => 79,       #The width of the edit area.
                   :scroll_step   => 12,       #The amount scrolled.
                   :alt_prompt    => "<< ",    #The prompt when scrolled.
-                                              #Set to nil for no alt prompt.
+                                              #Set to nil to use main prompt.
 
+                  :history       => false,    #Is the history buffer enabled?
                   :no_blanks     => true,     #No empty lines in history.
                   :no_dups       => true,     #No duplicate lines in history.
 

data/lib/mini_readline/read_line.rb

@@ -1,6 +1,9 @@
 # coding: utf-8
 
 require_relative 'read_line/edit'
+require_relative 'read_line/history'
+require_relative 'read_line/no_history'
+
 
 #* read_line.rb - The ReadLine class that does the actual work.
 module MiniReadline
@@ -10,24 +13,31 @@ module MiniReadline
   #the optional command history.
   class Readline
 
+    #The options specifically associated with this instance.
+    attr_reader :instance_options
+
     #Setup the instance of the mini line editor.
     #<br>Parameters:
     #* buffer - An array of strings used to contain the history. Use an empty
-    #  array to have a history buffer with no initial entries. Use the
-    #  value nil (or false) to maintain no history at all.
-    def initialize(buffer=[])
-      @edit = Edit.new(buffer)
+    #  array to have a history buffer with no initial entries.
+    #* instance_options - A hash of options owned by this \Readline instance.
+    #<br>Notes
+    #* In order to specify any instance options, buffer must also be specified.
+    def initialize(buffer=[], instance_options={})
+      @instance_options = instance_options
+      @history    = History.new(buffer)
+      @no_history = NoHistory.new
     end
 
     #Get the history buffer of this read line instance.
     def history
-      @edit.history
+      @history.history
     end
 
     #Read a line from the console with edit and history.
     #<br>Parameters:
     #* prompt - A string used to prompt the user. '>' is popular.
-    #* options - A hash of options; Typically :symbol => value
+    #* options - A hash of options; Typically symbol: value
     def readline(prompt, options = {})
       initialize_parms(prompt, options)
       @edit.edit_process
@@ -38,14 +48,23 @@ module MiniReadline
     #Initialize the read line process. This basically process the arguments
     #of the readline method.
     def initialize_parms(prompt, options)
-      @options = MiniReadline::BASE_OPTIONS.merge(options)
-      (@term = @options[:term]).initialize_parms
-
+      set_options(options)
       set_prompt(prompt)
-      @edit.initialize_edit_parms(@options)
+
+      history = @options[:history] ? @history : @no_history
+      @edit = Edit.new(history, @options)
+
+      @history.initialize_parms(@options)
+    end
+
+    #Set up the options
+    def set_options(options)
+      @options = MiniReadline::BASE_OPTIONS.merge(instance_options)
+      @options.merge!(options)
+      (@term = @options[:term]).initialize_parms
     end
 
-    #Set up the prompt options.
+    #Set up the prompt.
     def set_prompt(prompt)
       @options[:base_prompt]   = prompt
       @options[:scroll_prompt] = @options[:alt_prompt] || prompt

data/lib/mini_readline/read_line/edit.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 
 require_relative 'edit_window'
-require_relative 'history'
 
 require_relative 'edit/insert_text'
 require_relative 'edit/enter'
@@ -31,21 +30,15 @@ module MiniReadline
   class Edit
 
     #Set up the edit instance.
-    def initialize(buffer)
-      @history     = History.new(buffer)
-      @edit_window = EditWindow.new
-    end
-
-    #Set up the initial edit settings.
-    def initialize_edit_parms(options)
+    def initialize(history, options)
       @options     = options
+      @history     = history
       @term        = @options[:term]
       @edit_posn   = 0
       @edit_buffer = ""
       @working     = true
 
-      @edit_window.initialize_parms(@options)
-      @history.initialize_parms(@options)
+      @edit_window = EditWindow.new(@options)
     end
 
     #The main edit buffer
@@ -59,11 +52,6 @@ module MiniReadline
       edit_buffer.length
     end
 
-    #Get the history array for this edit instance.
-    def history
-      @history.history
-    end
-
     #Interact with the user
     def edit_process
       result = edit_loop

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

@@ -9,8 +9,8 @@ module MiniReadline
     #A little more to the left please!
     def word_left(_keyboard_args)
       if @edit_posn > 0
-        posn =  @edit_buffer[0...@edit_posn].rstrip.rindex(' ')
-        @edit_posn = posn ? posn + 1 : 0
+        left = @edit_buffer[0...@edit_posn]
+        @edit_posn = (posn = left.rindex(/\s\S/)) ? posn+1 : 0
       else
         @term.beep
       end

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

@@ -8,11 +8,9 @@ module MiniReadline
 
     #A little more to the right please!
     def word_right(_keyboard_args)
-      len = edit_buffer.length
-
-      if @edit_posn < len
+      if @edit_posn < length
         right = @edit_buffer[(@edit_posn+1)..-1]
-        @edit_posn = (posn = /\s\S/ =~ right) ? @edit_posn + posn + 2 : len
+        @edit_posn = (posn = right.index(/\s\S/)) ? @edit_posn+posn+2 : length
       else
         @term.beep
       end

data/lib/mini_readline/read_line/edit_window.rb

@@ -10,7 +10,7 @@ module MiniReadline
   class EditWindow
 
     #Determine the edit window limits.
-    def initialize_parms(options)
+    def initialize(options)
       @options      = options
       @base_width   = window_width - @options[:base_prompt].length
       @scroll_width = window_width - @options[:scroll_prompt].length

data/lib/mini_readline/read_line/history.rb

@@ -53,7 +53,7 @@ module MiniReadline
 
     #Get the history buffer associated with this instance.
     def history
-      @_buffer || []
+      @_buffer
     end
   end
 end

data/lib/mini_readline/read_line/no_history.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+#* read_line/no_history.rb - Support for the edit without history.
+module MiniReadline
+
+  #* read_line/no_history.rb - Support for the edit without history.
+  class NoHistory
+
+    #Get the history object ready for the next read line operation. NOP
+    def initialize_parms(_options)
+    end
+
+    #Go to the end of the history array. NOP
+    def goto_end_of_history
+    end
+
+    #Get the previous history string. NOP
+    def get_previous_history
+      false
+    end
+
+    #Get the next history string. NOP
+    def get_next_history
+      false
+    end
+
+    #Append a string to the history buffer if enabled. NOP
+    def append_history(_str)
+    end
+
+    #Get the history buffer associated with this instance. Empty
+    def history
+      []
+    end
+  end
+end

data/lib/mini_readline/version.rb

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

data/mini_readline.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>=1.9.3'
 
+  spec.add_development_dependency "minitest", ">= 5.7"
+  spec.add_development_dependency "minitest_visible", ">= 0.0.2"
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/tests/mini_readline_tests.rb

@@ -15,11 +15,20 @@ class MiniReadlineTester < Minitest::Test
     assert_equal(Module, MiniReadline.class)
     assert_equal(String, MiniReadline::VERSION.class)
     assert_equal(Class,  MiniReadline::Readline.class)
+    assert_equal(Class,  MiniReadline::History.class)
+    assert_equal(Class,  MiniReadline::NoHistory.class)
     assert_equal(Class,  MiniReadline::Edit.class)
     assert_equal(Class,  MiniReadline::EditWindow.class)
     assert_equal(Class,  MiniReadline::Mapper.class)
   end
 
+  def test_for_storage_of_options
+    assert_equal(Hash, MiniReadline::BASE_OPTIONS.class)
+    edit = MiniReadline::Readline.new()
+    assert_equal(Hash, edit.instance_options.class)
+    refute_equal(MiniReadline::BASE_OPTIONS, edit.instance_options)
+  end
+
   def test_platform_detection
     if (RUBY_PLATFORM =~ /\bcygwin\b/i) || (RUBY_PLATFORM !~ /mswin|mingw/)
       assert_equal(:other, MiniReadline::PLATFORM)
@@ -32,12 +41,12 @@ class MiniReadlineTester < Minitest::Test
     puts
     puts "To finish this test, enter the word: quit"
 
-    edit = MiniReadline::Readline.new()
+    edit = MiniReadline::Readline.new
 
     result = ''
 
     loop do
-      result = edit.readline(">")
+      result = edit.readline(">", history: true)
       puts result.inspect
       break unless result != 'quit'
     end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.7'
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +111,7 @@ files:
 - lib/mini_readline/read_line/edit_window/sync_cursor.rb
 - lib/mini_readline/read_line/edit_window/sync_window.rb
 - lib/mini_readline/read_line/history.rb
+- lib/mini_readline/read_line/no_history.rb
 - lib/mini_readline/version.rb
 - mini_readline.gemspec
 - reek.txt