mini_readline 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 634b35a4a125886de4969dd4f807fdf2b35e5ec3
-  data.tar.gz: d6be43dd1584f371fea17f7600ee5b5e49ccefc4
+  metadata.gz: a8482183c12c0303a39f18bc9618078108f9c223
+  data.tar.gz: 09d16bd02e569d657acad881922a10f5ffb5f196
 SHA512:
-  metadata.gz: 09a90d21011cc4e47143fda7e2b01d2ae88bbea694e5c1bf350214a9af3d69f874211d26aa3cd7c065254f95b3b7ccca4fd102db2d21260eda190afe14606bd2
-  data.tar.gz: f713ffa03366f00f15203215656f4225c36e2e929f298bedd824e908885c005ddaf60c5581f8b46ca852ef0ad003c6cd6a932ac2f6b40002ba6e48b2016260f0
+  metadata.gz: 09d3ed8de2584e5637f3b6fc832b0ee74971fca0d215bc1c108aa14cb6af6e450afda6e67773cafeac2f688f93b56745e42eaba3e77923ce4baecd7bd98d0893
+  data.tar.gz: ed8ef74313404c8e253ee2ff773d487d79f724427d826bdc23f656772766a70dd41b5f6b0335519c494bed483ca90f10987b028e2cfe44b6f074480ba5480b09

data/README.md

@@ -27,7 +27,6 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'mini_readline'
 ```
-
 And then execute:
 
     $ bundle
@@ -62,7 +61,8 @@ End of Input     | Ctrl-Z                           | Alt-z
 * The label "Other" is an umbrella that bundles together the Linux, Mac,
 and Cygwin platforms.
 * References to Pad keys under Windows assume that Num Lock is not engaged.
-* Support for End of Input is controlled by the eoi_detect option.
+* Support for End of Input is controlled by the eoi_detect option. See options
+below.
 
 ## Usage
 
@@ -71,8 +71,7 @@ The typical way of utilizing this gem is to place the following:
 ```ruby
 require 'mini_readline'
 ```
-
-<br>By default, the constant Readline is set to the MiniReadline module. If this
+By default, the constant Readline is set to the MiniReadline module. If this
 is not desired use the following:
 
 ```ruby
@@ -114,19 +113,23 @@ In native mode, instances of the Readline class are used to get user input.
 edit = MiniReadline::Readline.new()
 ```
 
-The constructor takes two optional arguments. The first is either:
-* An array of strings; A history buffer pre-loaded with commands.
-* An empty array; A history buffer with no pre-load.
-
-<br>The second is a hash of options that are used as instance level options.
+The constructor takes an optional argument. A hash of options that are used
+as instance level options.
 
 <br>Once an instance is created it may be used as follows:
 
 ```ruby
-edit.readline(prompt, options)
+edit.readline(options)
 ```
-Where prompt is a prompt string and options is an optional hash of options
-settings. In addition, it is possible to get a hold
+Where an optional hash of options settings. For example, to specify a prompt,
+use the following:
+
+```ruby
+edit.readline(prompt: '>')
+```
+
+
+In addition, it is possible to get a hold
 of the history buffer of the edit object with:
 ```ruby
 hist = edit.history
@@ -164,6 +167,8 @@ entries.
 BASE_OPTIONS = {
   :window_width  => 79,       #The width of the edit area.
   :scroll_step   => 12,       #The amount scrolled.
+
+  :prompt        => ">",      #The default prompt.
   :alt_prompt    => "<< ",    #The prompt when scrolled.
                               #Set to nil for no alt prompt.
 
@@ -173,6 +178,7 @@ BASE_OPTIONS = {
   :eoi_detect    => false,    #Is end of input detection enabled?
 
   :history       => false,    #Is the history buffer enabled?
+  :log           => [],       #Default is no previous history
   :no_blanks     => true,     #No empty lines in history.
   :no_dups       => true,     #No duplicate lines in history.
 

data/lib/mini_readline.rb

@@ -18,7 +18,7 @@ module MiniReadline
 
   #The (limited) compatibility module function.
   def self.readline(prompt, history = nil)
-    @reader.readline(prompt, history: history)
+    @reader.readline(prompt: prompt, history: history)
   end
 end
 

data/lib/mini_readline/options.rb

@@ -6,6 +6,8 @@ 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.
+
+                  :prompt        => ">",      #The default prompt.
                   :alt_prompt    => "<< ",    #The prompt when scrolled.
                                               #Set to nil to use main prompt.
 
@@ -15,6 +17,7 @@ module MiniReadline
                   :eoi_detect    => false,    #Is end of input detection enabled?
 
                   :history       => false,    #Is the history buffer enabled?
+                  :log           => [],       #Default is no previous history
                   :no_blanks     => true,     #No empty lines in history.
                   :no_dups       => true,     #No duplicate lines in history.
 

data/lib/mini_readline/raw_term.rb

@@ -6,6 +6,8 @@ require_relative 'raw_term/mapper'
 module MiniReadline
 
   #The class used to manipulate console i/o on a low level.
+  #<br>Endemic Code Smells
+  # :reek:TooManyInstanceVariables
   class RawTerm
 
     #Create a mapper.

data/lib/mini_readline/raw_term/other.rb

@@ -11,6 +11,8 @@ module MiniReadline
   PLATFORM = :other
 
   #The class used to manipulate console i/o on a low level.
+  #<br>Endemic Code Smells
+  # :reek:TooManyInstanceVariables
   class RawTerm
 
     #Carriage return

data/lib/mini_readline/raw_term/windows.rb

@@ -11,6 +11,8 @@ module MiniReadline
   PLATFORM = :windows
 
   #The class used to manipulate console i/o on a low level.
+  #<br>Endemin Code Smells
+  # :reek:TooManyInstanceVariables
   class RawTerm
 
     #The sleep interval waiting for a key to be pressed.

data/lib/mini_readline/read_line.rb

@@ -11,6 +11,8 @@ module MiniReadline
   #The \Readline class that does the actual work of getting lines from the
   #user. Note that each instance of this class maintains its own copy of
   #the optional command history.
+  #<br>Endemic Code Smells
+  # :reek:TooManyInstanceVariables
   class Readline
 
     #The options specifically associated with this instance.
@@ -18,14 +20,11 @@ module MiniReadline
 
     #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.
     #* 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={})
+    def initialize(instance_options={})
       @instance_options = instance_options
-      @history    = History.new(buffer)
+      log = (@instance_options[:log] || BASE_OPTIONS[:log] || []).clone
+      @history    = History.new(log)
       @no_history = NoHistory.new
     end
 
@@ -38,8 +37,8 @@ module MiniReadline
     #<br>Parameters:
     #* prompt - A string used to prompt the user. '>' is popular.
     #* options - A hash of options; Typically symbol: value
-    def readline(prompt, options = {})
-      initialize_parms(prompt, options)
+    def readline(options = {})
+      initialize_parms(options)
       @edit.edit_process
     ensure
       @term.conclude
@@ -47,9 +46,8 @@ module MiniReadline
 
     #Initialize the read line process. This basically process the arguments
     #of the readline method.
-    def initialize_parms(prompt, options)
+    def initialize_parms(options)
       set_options(options)
-      set_prompt(prompt)
 
       history = @options[:history] ? @history : @no_history
       @edit = Edit.new(history, @options)
@@ -62,6 +60,7 @@ module MiniReadline
       @options = MiniReadline::BASE_OPTIONS.merge(instance_options)
       @options.merge!(options)
       (@term = @options[:term]).initialize_parms
+      set_prompt(@options[:prompt])
     end
 
     #Set up the prompt.

data/lib/mini_readline/read_line/edit.rb

@@ -30,6 +30,8 @@ require_relative 'edit/unmapped'
 module MiniReadline
 
   #* read_line/edit.rb - The line editor.
+  #<br>Endemic Code Smells
+  # :reek:TooManyInstanceVariables
   class Edit
 
     #Set up the edit instance.

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

@@ -7,6 +7,8 @@ require_relative 'edit_window/sync_cursor'
 module MiniReadline
 
   #* read_line/edit_window.rb - Support for the edit window.
+  #<br>Endemic Code Smells
+  # :reek:TooManyInstanceVariables
   class EditWindow
 
     #Determine the edit window limits.
@@ -20,7 +22,7 @@ module MiniReadline
     end
 
     #What is the offset of the window's left margin?
-    attr_accessor :left_margin
+    attr_reader :left_margin
 
     #What is the offset of the window's right margin?
     def right_margin
@@ -41,7 +43,7 @@ module MiniReadline
     end
 
     #The shadow copy of what is actually on the screen?
-    attr_accessor :window_buffer
+    attr_reader :window_buffer
 
     #The width of the window with the base prompt
     attr_reader :base_width

data/lib/mini_readline/read_line/edit/edit_window/sync_window.rb

@@ -19,9 +19,9 @@ module MiniReadline
       old_margins = [left_margin, right_margin]
 
       if length < base_width
-        self.left_margin = 0
+        @left_margin = 0
       elsif edit_posn < left_margin
-        self.left_margin = [edit_posn - scroll_step, 0].max
+        @left_margin = [edit_posn - scroll_step, 0].max
       elsif edit_posn > right_margin
         self.right_margin = edit_posn + scroll_step
       end

data/lib/mini_readline/version.rb

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

data/sire.rb

@@ -87,6 +87,11 @@ class SIRE
     (\g<x>|\g<y>)$
   }x
 
+  #Test the WRE
+  def wre(str)
+    WRE.match str
+  end
+
   #Rubified Windows Regex.
   # a File name character, no spaces.
   # b File name character, with spaces.
@@ -103,6 +108,11 @@ class SIRE
     (\g<x>|\g<y>)$
   }x
 
+  #Test the RRE
+  def rre(str)
+    RRE.match str
+  end
+
   #Other Platforms Regex.
   # a File name character, no spaces.
   # b File name character, with spaces.
@@ -119,6 +129,10 @@ class SIRE
     (\g<x>|\g<y>)$
   }x
 
+  #Test the ORE
+  def ore(str)
+    ORE.match str
+  end
 
   #Execute a single line.
   def exec_line(line)

data/tests/mini_readline_tests.rb

@@ -46,7 +46,24 @@ class MiniReadlineTester < Minitest::Test
     result = ''
 
     loop do
-      result = edit.readline(">", history: true)
+      result = edit.readline(prompt: ">", history: true)
+      puts result.inspect
+      break unless result != 'quit'
+    end
+
+    assert_equal("quit", result)
+  end
+
+  def test_reading_a_line_no_history
+    puts
+    puts "No history: To finish this test, enter the word: quit"
+
+    edit = MiniReadline::Readline.new
+
+    result = ''
+
+    loop do
+      result = edit.readline(prompt: ">")
       puts result.inspect
       break unless result != 'quit'
     end
@@ -57,13 +74,13 @@ class MiniReadlineTester < Minitest::Test
   def test_end_of_input_detection
     edit = MiniReadline::Readline.new()
     puts "Exit by signaling end of input"
-    assert_raises(MiniReadlineEOI) {edit.readline(">", eoi_detect: true)}
+    assert_raises(MiniReadlineEOI) {edit.readline(prompt: ">", eoi_detect: true)}
   end
 
   def test_prompt_verification
-    opts = {:window_width  => 39}
+    opts = {prompt: ">"*20, window_width: 39}
     edit = MiniReadline::Readline.new()
-    assert_raises(RuntimeError) {edit.readline(">"*20, opts)}
+    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.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest