mini_readline 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cfcf3f362557c6f4ab5ec93418b4ca44ae54a07
-  data.tar.gz: cf0b61fd89ff2bb18d1b8b9a3d06d343e8e2d896
+  metadata.gz: de25a37c0b75ebcb2e6e8edbcc0e7bfb08aaa863
+  data.tar.gz: b842f03c9f0804b79ee9254bf7d623a06536e111
 SHA512:
-  metadata.gz: 709d6bac30409e21669602e21cc55d0caa9ff198b9599ddfdcc73cbe45f6b6acb4ccc4655e894314af175fc01679b57fa2ca299b4cdf149a3eb11080654952b8
-  data.tar.gz: 6cb9c33a15db38317a2a7d933cc61acf4f01d83d996d739316821ac21de9eb6eaf3b9865d0701be63971756c69629f9860e1179757cec830001b8966b93e955f
+  metadata.gz: 8c9a5d664a358812295f1358f21c6857abd02204f94d9b0c317636da9d11a506c868e1822887774cf6bb88e8524986898d01d5af9258ddc51530872aacb71692
+  data.tar.gz: 294db641b431ea5a069441332405185cc89ae771ca74115d4dad71e88213f31d6508c41c9a65bebdf261d8d503742e73184ac622601c7845c45ccccb26e235cc

data/README.md

@@ -102,35 +102,46 @@ also be accomplished with the command:
 
 ### Compatible Mode
 
-In this mode, mini_readline is somewhat compatible with the classic readline.
-Simply use:
+In compatible mode, mini_readline tries to be somewhat compatible with the
+classic system readline facility. Here is this compatible mode in action with
+entry history enabled:
 
 ```ruby
-Readline.readline('>', true)
+MiniReadline.readline('>', true)
 ```
-or to avoid tracking command history, use:
-
+and with entry history disabled:
 ```ruby
-Readline.readline('>', false)
+MiniReadline.readline('>', false)
 ```
 Where the string argument is the prompt seen by the user and the flag controls
-the history buffer. This assumes that the $no_alias_read_line_module setting
-mentioned above was *not* used. If it was, then these somewhat less compatible
-forms are required:
+the history buffer. Use true to enable history and false to disable it.
+
+##### Extensions
+
+In addition to the standard readline arguments, additional arguments may be
+passed in to access additional features. This is done with an optional trailing
+hash argument. For example, the following bit of compatibility mode code gets
+a string with password hiding:
 ```ruby
-MiniReadline.readline('>', true)
+MiniReadline.readline(">", false, secret_mask: "*")
 ```
-and
-```ruby
-MiniReadline.readline('>', false)
-```
-While it does require some small changes, the latter form is the preferred one.
+See the section Options below for more information on the sorts of things that
+can be accomplished with these options settings.
 
 ##### Module Aliasing [Deprecated]
 
 For enhanced compatibility, the mini_readline gem has the ability to alias
-itself as the readline gem. This ability is subject to the following list
-of conditions.
+itself as the readline gem. When this feature is used, compatible code is even
+more compatible looking:
+```ruby
+Readline.readline('>', true)
+```
+or to avoid tracking command history, use:
+
+```ruby
+Readline.readline('>', false)
+```
+The aliasing of modules is subject to the following list of conditions:
 
 1) If the global variable $no_alias_read_line_module is set to true before the
 mini_readline gem is required, *no* aliasing will take place.
@@ -259,6 +270,9 @@ BASE_OPTIONS = {
                               #string "*" to use stars or " "
                               #for invisible secrets.
 
+  :initial       => "",       #The initial text for the entry.
+                              #An empty string for none.
+
   :term          => nil,      #Filled in by raw_term.rb
                               #MiniReadline::RawTerm
 
@@ -288,7 +302,11 @@ eoi inputs are treated as unmapped. If enabled, they raise a MiniReadlineEOI
 exception.
 * :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 " ".
+Typical values are "\*" or " ". Also, any secret entries should be done with
+the history option **TURNED OFF**. Otherwise later entries will be able to
+retrieve the secret codes by just scrolling through previous entries.
+* :initial is the initial text used to prefill the readline edit area with the
+specified text. Leave as an empty string to default to the empty edit area.
 * :term is the interactive source of data, the console by default. The raw
 terminal console driver automatically adapts to the system environment
 (Windows or Other) so that correct operation is normally achieved with no

data/lib/mini_readline.rb

@@ -26,8 +26,8 @@ module MiniReadline
   end
 
   #The (limited) compatibility module function.
-  def self.readline(prompt = "", history = nil)
-    get_reader.readline(prompt: prompt, history: history)
+  def self.readline(prompt = "", history = nil, options = {})
+    get_reader.readline(options.merge({prompt: prompt, history: history}))
   end
 
 end

data/lib/mini_readline/options.rb

@@ -26,6 +26,9 @@ module MiniReadline
                                               #string "*" to use stars or " "
                                               #for invisible secrets.
 
+                  :initial       => "",       #The initial text for the entry.
+                                              #An empty string for none.
+
                   :term          => nil,      #Filled in by raw_term.rb
                                               #MiniReadline::RawTerm
 

data/lib/mini_readline/raw_term/windows.rb

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

data/lib/mini_readline/read_line/edit.rb

@@ -39,8 +39,8 @@ module MiniReadline
       @options     = options
       @history     = history
       @term        = @options[:term]
-      @edit_posn   = 0
-      @edit_buffer = ""
+      @edit_buffer = @options[:initial]
+      @edit_posn   = @edit_buffer.length
       @working     = true
 
       @edit_window = EditWindow.new(@options)

data/lib/mini_readline/version.rb

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

data/tests/mini_readline_tests.rb

@@ -73,16 +73,29 @@ class MiniReadlineTester < Minitest::Test
     assert_equal("quit", result)
   end
 
+  def test_reading_with_a_default
+    puts
+    puts "To finish this test, enter the word: quit"
+
+    result = ''
+
+    loop do
+      result = MiniReadline.readline(">", false, initial: "qui").chomp
+      puts result.inspect
+      break unless result != "quit"
+    end
+
+    assert_equal("quit", result)
+  end
+
   def test_reading_a_password
     puts
     puts "To finish this test, enter the word: password"
 
-    edit = MiniReadline::Readline.new
-
     result = ''
 
     loop do
-      result = edit.readline(prompt: ">", secret_mask: "*").chomp
+      result = MiniReadline.readline(">", false, secret_mask: "*").chomp
       puts result.inspect
       break unless result != "password"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest