mini_readline 0.9.0 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 13d29a79c8b695d0491081997bfd2f78c2d6b6f4
-  data.tar.gz: a13e598d917734a3448e4d9316aee17cabc701b3
+SHA256:
+  metadata.gz: 33cf8359aa2da932030ed129ee92904857f87e85fb7e5b12d819b1a5029cbff6
+  data.tar.gz: 165b10fc4c40b9a22b213530d065300d3f5404b8f6cf7cd738546db27bd149d7
 SHA512:
-  metadata.gz: a92268026fa1ac6abfd573cb6debd80b4055fbe047dd58bae5a666f39745831397c089b54615537ad1aee765a19d480375fe208234ca2f957bb640abb46c2570
-  data.tar.gz: 568fa17fc7a40b0bf8f4bc7d01214e947f1503b8f49166a56636c049be91b595fd7284b86499942a91187cf75049855cc8eb0a13815400f56cf2ba2c3f6a7b1c
+  metadata.gz: dbf6fe9f4bc027f2a8d45ed09837c61f01a247a25e446e4eb04ed81865460f726c6ada4bee7c0c5abad9fea20baddf7a510f5170ba62c02163095df7232f33ff
+  data.tar.gz: 5b4efbf6bb03be62b5ffa9214c41ec4f0db467dafcf1b7db7fa5a120454f495c6997777536c22ee9ac8ab2fb07c840f8a4c206a85e59b20181f7eb8657b6000f

data/.reek.yml

@@ -0,0 +1,17 @@
+---
+
+### Generic smell configuration
+
+detectors:
+
+  TooManyStatements:
+    max_statements: 7
+
+  InstanceVariableAssumption:
+    enabled: false
+
+  TooManyMethods:
+    enabled: true
+
+  LongParameterList:
+    max_params: 3

data/README.md

@@ -6,11 +6,24 @@ 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. See Cross Platform
-Portability Progress below for more details.
-
-Finally, I know this code must seem to give off a sort of angry birds vibe
-against the original rb-readline gem. This sort of thing is not good. I owe
+encountered when running cross platform environments. This is achieved through
+the use of the mini_term gem that deals with the mess of getting proper access
+to the low-level "terminal".
+
+While the standard readline gem tries its best to be compatible with the GNU
+Readline library written in "C", mini_readline does not. Instead it takes on
+the goal of being best suited to the needs of Ruby programmers. While this
+makes it much less useful to those porting over Unix/Linux utilities, it makes
+it more useful to Ruby programmers creating CLI utilities in that language.
+
+Further, while spread out over a much larger number of smaller, manageable
+files, mini readline has only 1238 lines of code. In fact, only two files have
+more than 100 lines in total. The rb-readline gem has a much larger 9480 lines
+of code with 8920 of them in a single, monster file. While the smaller files do
+have some downsides, bloated files are, in my opinion, worse.
+
+Finally, I know this whole effort must seem to give off a sort of angry birds
+vibe against the original rb-readline gem. That is not my intent at all. I owe
 a great debt of gratitude to the authors and maintainers of that vital code.
 Their getting around the whole Win32API, dl obsolescence debacle saved me so
 much time and frustration that words do not suffice. Thanks!
@@ -64,6 +77,8 @@ replaced by Escape followed by the appropriate letter.
 * 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. See options
 below.
+* These keyboard mappings are the standard ones included with mini_readline.
+See the section Adding Custom Key Maps below for more info.
 
 ## Usage
 
@@ -203,30 +218,35 @@ entries.
 
 <br>The available options are described below:
 ```ruby
+# The base options shared by all instances.
 BASE_OPTIONS = {
-  :scroll_step   => 12,       #The amount horizontally scrolled.
+  :scroll_step   => 12,       # The amount scrolled.
+
+  :prompt        => ">",      # The default prompt.
+  :alt_prompt    => "<< ",    # The prompt when scrolled.
+                              # Set to nil to use main prompt.
 
-  :prompt        => ">",      #The default prompt.
-  :alt_prompt    => "<< ",    #The prompt when scrolled.
-                              #Set to nil for no alt prompt.
+  :auto_complete => false,    # Is auto complete enabled?
+  :auto_source   => nil,      # Filled in by auto_complete.rb
+                              # MiniReadline::QuotedFileFolderSource
 
-  :auto_complete => false,    #Is auto complete enabled?
-  :auto_source   => nil,      #Filled in by auto_complete.rb
-                              #MiniReadline::QuotedFileFolderSource
+  :chomp         => false,    # Remove the trailing new-line?
 
-  :eoi_detect    => false,    #Is end of input detection enabled?
+  :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.
+  :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.
+  :no_move       => false,    # Don't move history entries.
 
-  :secret_mask   => nil,      #No secret password mask. Use the
-                              #string "*" to use stars or " "
-                              #for invisible secrets.
+  :secret_mask   => nil,      # No secret password mask. Use the
+                              # string "*" to use stars or " "
+                              # for invisible secrets.
 
-  :initial       => ""}       #The initial text for the entry.
-                              #An empty string for none.
+  :initial       => ""        # The initial text for the entry.
+                              # An empty string for none.
+}
 ```
 
 <br>While most of these options are self explanatory, a few could stand some
@@ -247,9 +267,17 @@ MiniReadline::BASE_OPTION[:auto_complete] = true
 this is MiniReadline::QuotedFileFolderSource. This option can be changed up to
 get auto-complete data other than files and folders. See Auto-Compete below for
 more details.
+* :chomp is used to remove the trailing new-line character that garnishes the
+text from the user. Set to true for clean text, and to false for parsley to
+throw out.
 * :eoi_detect is used to control the end of input detection logic. If disabled,
 eoi inputs are treated as unmapped. If enabled, they raise a MiniReadlineEOI
 exception.
+* A few options control the history buffer. With the history option on, lines
+entered are retained in a buffer. Otherwise, no record is kept of entered text.
+When no_blanks is set, blank lines are not saved. When no_dups is set,
+duplicate lines are not saved. If so, when duplicates do occur, the no_move
+option keeps the older copy. Otherwise the newer copy is retained.
 * :secret_mask is a masking character to be used for sensitive input like a
 password or missile launch code. This should be exactly one character long.
 Typical values are "\*" or " ". Also, any secret entries should be done with
@@ -261,11 +289,6 @@ specified text. Leave as an empty string to default to the empty edit area.
 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.
-
 ### Auto-Complete
 The mini readline gem comes with four auto-complete engines. These are:
 
@@ -346,7 +369,55 @@ 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
+gem located at: https://github.com/PeterCamilleri/mysh/blob/master/lib/mysh/sources/smart_auto_complete.rb
+
+### Adding Custom Key Maps
+It is possible to override the default keyboard maps used by the mini_readline
+gem. The following shows the installation of a retro, WordStar&#8482; inspired
+keyboard mapping for a Windows system:
+
+```ruby
+MiniTerm.add_map(:windows) do |map|
+  map[" ".."~"] = :insert_text
+
+  #Left Arrows
+  map["\x13"]  = :go_left
+  map["\x01"]  = :word_left
+
+  #Right Arrows
+  map["\x04"]  = :go_right
+  map["\x06"]  = :word_right
+
+  #Up Arrows
+  map["\x05"]  = :previous_history
+
+  #Down Arrows
+  map["\x18"]  = :next_history
+
+  #The Home and End keys
+  map["\x17"]  = :go_home
+  map["\x12"]  = :go_end
+
+  #The Backspace and Delete keys
+  map["\x08"]  = :delete_left
+  map["\x7F"]  = :delete_right
+  map["\x11\x13"] = :delete_all_left
+  map["\x11\x04"] = :delete_all_right
+
+  #Auto-completion.
+  map["\t"]    = :auto_complete
+
+  #The Enter key
+  map["\x0D"]  = :enter
+
+  #The Escape key
+  map["\e"]    = :cancel
+
+  #End of Input
+  map["\x1A"]  = :end_of_input
+end
+```
+
 
 ### Important Security Note
 
@@ -357,24 +428,25 @@ command line itself. Untrusted users should **never** be given such access!
 
 ## Demo
 A simple demo of mini_readline in action is available. To access this demo use
-the following from the mini_readline root folder:
+the following:
 
-    $ ruby sire.rb
+    $ sire
 
 This will launch SIRE, a Simple Interactive Ruby Environment, a sort of
-simple minded irb knock-off. This starts off by requiring the mini
-readline gem from either the system gem library or the local lib folder or
-if all fails, it will load the "classic" Readline gem. Here is a typical run:
+simple minded irb knock-off. The utility supports a number of options that
+allow the behaviour of the gem to be explored. These are:
 
-    C:\Sites\mini_readline>ruby sire.rb
+Option | Effect
+-------|-------
+local  | Use the mini_readline in the lib folder. For testing.
+gem    | Use the mini_readline installed as a gem. The default.
+old    | Use the old readline facility.
+map1   | Install a Wordstar keyboard map.
+help   | Display usage info and exit.
+-?     | Same thing.
 
+#### Testing Shell Out Bugs
 
-    Loaded mini_readline from the local code folder.
-
-    Welcome to a Simple Interactive Ruby Environment
-    Use the command 'quit' to exit.
-
-    SIRE>
 Of note, the run method can be used to test for the shell process bug. For
 example:
 
@@ -391,15 +463,12 @@ example:
      "sire.rb",
      "tests"]
     SIRE>
-After this command is run, the program should continue to operate correctly
-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:
+After this command is run, the program should continue to operate correctly
+and not go bannanas. To test the behavior of the (currently broken) standard
+readline library, use:
 
-    $ ruby sire.rb local
+    $ sire.rb old
 
 ## Cross Platform Portability Progress
 
@@ -433,3 +502,14 @@ 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!
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the fully_freeze project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/bin/sire

@@ -0,0 +1,218 @@
+#!/usr/bin/env ruby
+#
+# A Simple Interactive Ruby Environment
+#
+
+require 'pp'
+
+# Capture a binding for code evaluation.
+sire_binding = binding
+
+# Process command line arguments.
+valid_options = {'local' => :reader,
+                 'gem'   => :reader,
+                 'old'   => :reader,
+                 'map1'  => :map,
+                 'help'  => :help,
+                 '?'     => :help}
+
+options = {reader: 'gem'}
+
+# Display help for SIRE and exit.
+def display_help(error=nil)
+  puts "SIRE: a Simple Interactive Ruby Environment\n"
+
+  puts "Invalid option: #{error}" if error
+
+  puts "", "Usage: sire <options>",
+       "  local       Use the local mini_readline code.",
+       "  gem         Use the mini_readline installed gem.",
+       "  old         Use the standard readline gem.",
+       "  map1        Use the alternate key mapping in Windows.",
+       "  help  -?    Display this help and exit."
+
+  exit
+end
+
+ARGV.each do |arg|
+  key = valid_options[arg]
+  display_help(arg) unless key
+  options[key] = arg
+end
+
+display_help if options[:help]
+
+case options[:reader]
+when 'local'
+  require_relative '../lib/mini_readline'
+  puts "", "Option(local). Loaded mini_readline from the local code folder. Version #{MiniReadline::VERSION}"
+when 'gem'
+  require 'mini_readline'
+  puts "", "Loaded mini_readline from the system gem. Version #{MiniReadline::VERSION}"
+when 'old'
+  require 'readline'
+  class MiniReadlineEOI < StandardError; end #Compatibility stub.
+  puts "", "Loaded the standard readline gem. Version #{Readline::VERSION}"
+end
+
+MiniReadline = Readline unless defined?(MiniReadline)
+
+class Object
+  # Generate the class lineage of the object.
+  def classes
+    begin
+      result = ""
+      klass  = self.instance_of?(Class) ? self : self.class
+
+      begin
+        result << klass.to_s
+        klass = klass.superclass
+        result << " < " if klass
+      end while klass
+
+      result
+    end
+  end
+
+  private
+
+  # Quit the interactive session.
+  def quit
+    puts "Quit command.", ""
+    exit
+  end
+
+  # Get a mapped keystroke.
+  def get_mapped
+    if old?
+      puts 'The get_mapped method is not supported by old readline.'
+    else
+      print 'Press a key: '
+      MiniTerm.get_mapped_char
+    end
+  end
+
+  # Test spawning a process. This breaks the regular readline gem.
+  def run(command)
+    IO.popen(command, "r+") do |io|
+      io.close_write
+      return io.read
+    end
+  end
+
+  def old?
+    defined?(Readline)
+  end
+
+end
+
+if options[:map] == 'map1'
+  if old?
+    puts 'Remapping is not supported by old readline.'
+    exit
+  end
+
+  puts "Remapping keyboard to WordStar(TM)."
+
+  [:windows, :ansi].each do |target|
+    MiniTerm.add_map(target) do |map|
+      map[" ".."~"] = :insert_text
+
+      #Left Arrows
+      map["\x13"]  = :go_left
+      map["\x01"]  = :word_left
+
+      #Right Arrows
+      map["\x04"]  = :go_right
+      map["\x06"]  = :word_right
+
+      #Up Arrows
+      map["\x05"]  = :previous_history
+
+      #Down Arrows
+      map["\x18"]  = :next_history
+
+      #The Home and End keys
+      map["\x17"]  = :go_home
+      map["\x12"]  = :go_end
+
+      #The Backspace and Delete keys
+      map["\x08"]  = :delete_left
+      map["\x7F"]  = :delete_right
+      map["\x11\x13"] = :delete_all_left
+      map["\x11\x04"] = :delete_all_right
+
+      #Auto-completion.
+      map["\t"]    = :auto_complete
+
+      #The Enter key
+      map["\x0D"]  = :enter
+
+      #The Escape key
+      map["\e"]    = :cancel
+
+      #End of Input
+      map["\x1A"]  = :end_of_input
+    end
+  end
+end
+
+#The SIRE module contains a simplistic R.E.P.L. to test out mini_readline.
+module SIRE
+
+  # Run the interactive session.
+  def self.run_sire(evaluator)
+    @evaluator = evaluator
+
+    unless 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 'quit' to exit.\n\n"
+
+    loop do
+      exec_line(get_line)
+    end
+
+    puts "\n\n"
+
+  rescue MiniReadlineEOI, Interrupt => e
+    puts "\n"
+  end
+
+  private
+
+  # Get a line of input from the user.
+  def self.get_line
+    initial_input = MiniReadline.readline("SIRE>", true)
+    get_extra_input(initial_input)
+  end
+
+  # Get any continuations of the inputs
+  def self.get_extra_input(str)
+    if /\\\s*$/ =~ str
+      get_extra_input($PREMATCH + "\n" + MiniReadline.readline("SIRE\\", true))
+    else
+      str
+    end
+  end
+
+  # Execute a single line.
+  def self.exec_line(line)
+    result = @evaluator.eval(line)
+    pp result unless line.length == 0
+
+  rescue Interrupt => e
+    puts "", "Execution Interrupted!",
+         "", "#{e.class} detected: #{e}", ""
+
+  rescue StandardError, ScriptError => e
+    puts "", "#{e.class} detected: #{e}", ""
+  end
+
+end
+
+SIRE.run_sire(sire_binding)

data/lib/mini_readline.rb

@@ -14,12 +14,6 @@ require_relative "mini_readline/read_line"
 # The MiniReadline main module.
 module MiniReadline
 
-  private_constant :Prompt
-  private_constant :Edit
-  private_constant :EditWindow
-  private_constant :History
-  private_constant :NoHistory
-
   # The (limited) compatibility module function.
   def self.readline(prompt = "", history = nil, options = {})
     get_reader.readline(options.merge({prompt: prompt, history: history}))

data/lib/mini_readline/options.rb

@@ -4,27 +4,32 @@
 module MiniReadline
 
   # The base options shared by all instances.
-  BASE_OPTIONS = {:scroll_step   => 12,       #The amount scrolled.
+  BASE_OPTIONS = {
+    :scroll_step   => 12,       # The amount scrolled.
 
-                  :prompt        => ">",      #The default prompt.
-                  :alt_prompt    => "<< ",    #The prompt when scrolled.
-                                              #Set to nil to use main prompt.
+    :prompt        => ">",      # The default prompt.
+    :alt_prompt    => "<< ",    # The prompt when scrolled.
+                                # Set to nil to use main prompt.
 
-                  :auto_complete => false,    #Is auto complete enabled?
-                  :auto_source   => nil,      #Filled in by auto_complete.rb
-                                              #MiniReadline::QuotedFileFolderSource
+    :auto_complete => false,    # Is auto complete enabled?
+    :auto_source   => nil,      # Filled in by auto_complete.rb
+                                # MiniReadline::QuotedFileFolderSource
 
-                  :eoi_detect    => false,    #Is end of input detection enabled?
+    :chomp         => false,    # Remove the trailing new-line?
 
-                  :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.
+    :eoi_detect    => false,    # Is end of input detection enabled?
 
-                  :secret_mask   => nil,      #No secret password mask. Use the
-                                              #string "*" to use stars or " "
-                                              #for invisible secrets.
+    :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.
+    :no_move       => false,    # Don't move history entries.
 
-                  :initial       => ""}       #The initial text for the entry.
-                                              #An empty string for none.
+    :secret_mask   => nil,      # No secret password mask. Use the
+                                # string "*" to use stars or " "
+                                # for invisible secrets.
+
+    :initial       => ""        # The initial text for the entry.
+                                # An empty string for none.
+  }
 end

data/lib/mini_readline/read_line.rb

@@ -8,9 +8,10 @@ require_relative 'read_line/no_history'
 # The ReadLine class that does the actual work.
 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.
+  # 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.
+  # :reek:TooManyInstanceVariables  -- Yes and it needs them!
   class Readline
 
     # The options specifically associated with this instance.

data/lib/mini_readline/read_line/edit.rb

@@ -32,6 +32,7 @@ require_relative 'edit/unmapped'
 module MiniReadline
 
   # The line editor.
+  # :reek:TooManyInstanceVariables  -- Yes and it needs them!
   class Edit
 
     # Set up the edit instance.
@@ -60,7 +61,7 @@ module MiniReadline
     def edit_process
       result = edit_loop
       @history.append_history(result)
-      result + "\n"
+      result + (@options[:chomp] ? "" : "\n")
     end
 
     # The line editor processing loop.

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

@@ -7,6 +7,7 @@ require_relative 'edit_window/sync_cursor'
 module MiniReadline
 
   # Support for the edit window.
+  # :reek:TooManyInstanceVariables  -- Yes and it needs them!
   class EditWindow
 
     # Determine the edit window limits.

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

@@ -7,6 +7,7 @@ module MiniReadline
   class Edit
 
     # An unmapped key was pressed. Beep!
+    # :reek:UtilityFunction  -- Does not depend on state.
     def unmapped(_keyboard_args)
       MiniTerm.beep
     end

data/lib/mini_readline/read_line/history.rb

@@ -45,8 +45,15 @@ module MiniReadline
 
     # Append a string to the history buffer if enabled.
     def append_history(str)
-      return              if @options[:no_blanks] && str.strip.empty?
-      history.delete(str) if @options[:no_dups]
+      return if @options[:no_blanks] && str.strip.empty?
+
+      if history.include?(str)
+        if @options[:no_dups]
+          return if @options[:no_move]
+
+          history.delete(str)
+        end
+      end
 
       history << str
     end

data/lib/mini_readline/version.rb

@@ -3,8 +3,8 @@
 # Version info for the gem.
 module MiniReadline
   #The current version of the mini_readline gem.
-  VERSION = "0.9.0".freeze
+  VERSION = "0.9.5".freeze
 
   # A brief description.
-  DESCRIPTION = "Get console input with edit, history, and auto-complete.".freeze
+  DESCRIPTION = "mini_readline: Get console input with edit, history, and auto-complete.".freeze
 end

data/mini_readline.gemspec

@@ -9,12 +9,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Peter Camilleri"]
   spec.email         = ["peter.c.camilleri@gmail.com"]
 
-  spec.summary       = "Get console input with edit, history, and auto-complete."
-  spec.description   = %{A gem, for console command entry with line edit and
-                         history, inspired by the standard readline gem. Also
-                         included are four sample auto-complete agents and the
-                         irbm utility, which is irb + mini_readline and not an
-                         Intermediate Range Ballistic Missile.
+  spec.summary       = "mini_readline: Get console input with edit, history, and auto-complete."
+  spec.description   = %{mini_readline: A compact, little gem for console
+                         command entry with line edit and history, inspired by
+                         the standard readline gem. Also included are four
+                         sample auto-complete agents and the irbm utility,
+                         which is irb + mini_readline and not an Intermediate
+                         Range Ballistic Missile.
                         }.gsub(/\s+/, ' ').strip
 
   spec.homepage      = "https://github.com/PeterCamilleri/mini_readline"
@@ -29,10 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency     'mini_term', "~> 0.1.0"
 
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "bundler", ">= 2.1.0"
   spec.add_development_dependency 'minitest', "~> 5.7"
-  spec.add_development_dependency 'minitest_visible', "~> 0.1"
   spec.add_development_dependency 'reek', ">= 5.0.2"
 
 end

data/tests/history_tests.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+require_relative '../lib/mini_readline'
+gem              'minitest'
+require          'minitest/autorun'
+
+class SomeHistoryTester < Minitest::Test
+
+  def test_some_history_options
+    buffer = ["one", "two", "three"]
+    options = {:no_blanks => true,
+               :no_dups   => true,
+               :no_move   => false}
+
+    history = MiniReadline::History.new(buffer)
+    history.initialize_parms(options)
+
+    assert_equal(3, history.history.length)
+    assert_equal(["one", "two", "three"], history.history)
+
+    history.append_history("four")
+    assert_equal(4, history.history.length)
+    assert_equal(["one", "two", "three", "four"], history.history)
+
+    history.append_history("two")
+    assert_equal(4, history.history.length)
+    assert_equal(["one", "three", "four", "two"], history.history)
+
+    options[:no_move] = true
+    history.append_history("three")
+    assert_equal(4, history.history.length)
+    assert_equal(["one", "three", "four", "two"], history.history)
+  end
+
+end

data/tests/mini_readline_tests.rb

@@ -3,14 +3,10 @@
 require_relative '../lib/mini_readline'
 gem              'minitest'
 require          'minitest/autorun'
-require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
 class MiniReadlineTester < Minitest::Test
 
-  #Track mini-test progress.
-  include MinitestVisible
-
   def test_that_it_has_a_version_number
     refute_nil ::MiniReadline::VERSION
     assert(::MiniReadline::VERSION.frozen?)
@@ -47,7 +43,7 @@ class MiniReadlineTester < Minitest::Test
     result = ''
 
     loop do
-      result = edit.readline(prompt: ">", history: true).chomp
+      result = edit.readline(prompt: ">", chomp: true, history: true)
       puts result.inspect
       break unless result != "quit"
     end
@@ -64,12 +60,12 @@ class MiniReadlineTester < Minitest::Test
     result = ''
 
     loop do
-      result = edit.readline(prompt: ">").chomp
+      result = edit.readline(prompt: ">")
       puts result.inspect
-      break unless result != "quit"
+      break unless result != "quit\n"
     end
 
-    assert_equal("quit", result)
+    assert_equal("quit\n", result)
   end
 
   def test_reading_with_a_default

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.5
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_term
@@ -28,30 +28,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !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.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -94,23 +80,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.2
-description: A gem, for console command entry with line edit and history, inspired
-  by the standard readline gem. Also included are four sample auto-complete agents
-  and the irbm utility, which is irb + mini_readline and not an Intermediate Range
-  Ballistic Missile.
+description: 'mini_readline: A compact, little gem for console command entry with
+  line edit and history, inspired by the standard readline gem. Also included are
+  four sample auto-complete agents and the irbm utility, which is irb + mini_readline
+  and not an Intermediate Range Ballistic Missile.'
 email:
 - peter.c.camilleri@gmail.com
 executables:
 - irbm
+- sire
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - bin/irbm
+- bin/sire
 - irbt.rb
 - lib/mini_readline.rb
 - lib/mini_readline/exceptions.rb
@@ -149,10 +138,9 @@ files:
 - lib/mini_readline/read_line/prompt.rb
 - lib/mini_readline/version.rb
 - mini_readline.gemspec
-- mini_readline.reek
 - rakefile.rb
 - reek.txt
-- sire.rb
+- tests/history_tests.rb
 - tests/mini_readline_tests.rb
 homepage: https://github.com/PeterCamilleri/mini_readline
 licenses:
@@ -173,9 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
-summary: Get console input with edit, history, and auto-complete.
+summary: 'mini_readline: Get console input with edit, history, and auto-complete.'
 test_files: []

data/mini_readline.reek

@@ -1,115 +0,0 @@
----
-Attribute:
-  enabled: false
-  exclude: []
-BooleanParameter:
-  enabled: true
-  exclude: []
-ClassVariable:
-  enabled: true
-  exclude: []
-ControlParameter:
-  enabled: true
-  exclude: []
-DataClump:
-  enabled: true
-  exclude: []
-  max_copies: 2
-  min_clump_size: 2
-DuplicateMethodCall:
-  enabled: true
-  exclude: []
-  max_calls: 1
-  allow_calls: []
-FeatureEnvy:
-  enabled: true
-  exclude: []
-InstanceVariableAssumption:
-  enabled: false
-  exclude: []
-IrresponsibleModule:
-  enabled: true
-  exclude: []
-LongParameterList:
-  enabled: true
-  exclude: []
-  max_params: 3
-  overrides:
-    initialize:
-      max_params: 5
-LongYieldList:
-  enabled: true
-  exclude: []
-  max_params: 3
-NestedIterators:
-  enabled: true
-  exclude: []
-  max_allowed_nesting: 1
-  ignore_iterators: []
-NilCheck:
-  enabled: true
-  exclude: []
-PrimaDonnaMethod:
-  enabled: true
-  exclude: []
-RepeatedConditional:
-  enabled: true
-  exclude: []
-  max_ifs: 2
-TooManyInstanceVariables:
-  enabled: true
-  exclude: []
-  max_instance_variables: 9
-TooManyMethods:
-  enabled: true
-  exclude: []
-  max_methods: 25
-TooManyStatements:
-  enabled: true
-  exclude:
-  - initialize
-  max_statements: 7
-UncommunicativeMethodName:
-  enabled: true
-  exclude: []
-  reject:
-  - !ruby/regexp /^[a-z]$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-  accept: []
-UncommunicativeModuleName:
-  enabled: true
-  exclude: []
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  accept:
-  - Inline::C
-UncommunicativeParameterName:
-  enabled: true
-  exclude: []
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-  - !ruby/regexp /^_/
-  accept: []
-UncommunicativeVariableName:
-  enabled: true
-  exclude: []
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-  accept:
-  - _
-UnusedParameters:
-  enabled: true
-  exclude: []
-UnusedPrivateMethod:
-  enabled: false
-  exclude: []
-UtilityFunction:
-  enabled: true
-  exclude: []
-  max_helper_calls: 1

data/sire.rb

@@ -1,145 +0,0 @@
-# coding: utf-8
-# A Simple Interactive Ruby Environment
-
-require 'pp'
-
-#Some SIRE control variables.
-$sire_done    = false
-$sire_binding = binding
-$sire_old     = (ARGV[0] == 'old') || defined?(Readline)
-
-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}"
-elsif defined?(MiniReadline)
-  puts "\nThe mini_readline gem is already loaded. Version #{MiniReadline::VERSION}"
-else
-  begin
-    require 'mini_readline'
-    puts "\nLoaded mini_readline from the system gem. Version #{MiniReadline::VERSION}"
-  rescue LoadError
-    begin
-      require './lib/mini_readline'
-      puts "\nLoaded mini_readline from the local code folder. Version #{MiniReadline::VERSION}"
-    rescue LoadError
-      require 'readline'
-      puts "\nLoaded the standard readline gem. Version #{Readline::VERSION}"
-    end
-  end
-end
-
-Readline = MiniReadline unless defined?(Readline)
-
-class Object
-  #Generate the class lineage of the object.
-  def classes
-    begin
-      result = ""
-      klass  = self.instance_of?(Class) ? self : self.class
-
-      begin
-        result << klass.to_s
-        klass = klass.superclass
-        result << " < " if klass
-      end while klass
-
-      result
-    end
-  end
-
-  private
-
-  #Quit the interactive session.
-  def quit
-    $sire_done = true
-    puts
-    "Quit command."
-  end
-
-  #Get a mapped keystroke.
-  def get_mapped
-    if $sire_old
-      puts 'Not supported by old readline.'
-    else
-      print 'Press a key:'
-      MiniTerm.get_mapped_char
-    end
-  end
-
-  #Test spawning a process. This breaks the regular readline gem.
-  def run(command)
-    IO.popen(command, "r+") do |io|
-      io.close_write
-      return io.read
-    end
-  end
-
-end
-
-#The SIRE class contains the simplistic R.E.P.L.
-class SIRE
-
-  #Run the interactive session.
-  def run_sire
-    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 'quit' to exit.\n\n"
-
-    until $sire_done
-      exec_line(get_line)
-    end
-
-    puts "\n\n"
-
-  rescue MiniReadlineEOI, Interrupt => e
-    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
-  SIRE.new.run_sire
-end