mini_readline 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13d29a79c8b695d0491081997bfd2f78c2d6b6f4
-  data.tar.gz: a13e598d917734a3448e4d9316aee17cabc701b3
+  metadata.gz: ba0cff3f1c82679c0bdf6c1c6e65a04c3b9f2354
+  data.tar.gz: f1935e5795e939426f20991657a8d12a95d22468
 SHA512:
-  metadata.gz: a92268026fa1ac6abfd573cb6debd80b4055fbe047dd58bae5a666f39745831397c089b54615537ad1aee765a19d480375fe208234ca2f957bb640abb46c2570
-  data.tar.gz: 568fa17fc7a40b0bf8f4bc7d01214e947f1503b8f49166a56636c049be91b595fd7284b86499942a91187cf75049855cc8eb0a13815400f56cf2ba2c3f6a7b1c
+  metadata.gz: a9258f743e1c7fc664d065587adfc684c64eb61429b6f11dc2252bffa7b0e32596caf2f9656362b02aeb65e91495f69dcb5608dd6f81f5d0fcf004a1d600d9e2
+  data.tar.gz: 973efb417ef924216fcbf9a8523987bf86f9974ed70ba77fbde7390fd5452a9aee4f30ae1c026724534652d593813b0a51ee423e9fff11316a83dc426152c1d0

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!
@@ -203,30 +216,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 +265,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 +287,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:
 

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.1".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"

data/tests/history_tests.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+require_relative '../lib/mini_readline'
+gem              'minitest'
+require          'minitest/autorun'
+require          'minitest_visible'
+
+class SomeHistoryTester < Minitest::Test
+
+  #Track mini-test progress.
+  include MinitestVisible
+
+  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

@@ -47,7 +47,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 +64,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.1
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_term
@@ -94,10 +94,10 @@ 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:
@@ -106,6 +106,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -149,10 +150,10 @@ 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:
@@ -177,5 +178,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 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