mini_readline 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5ddc6a871c38d411642616cbac4de44c9a1c70f
-  data.tar.gz: 56493ba01fa93eb825956fcfb9618d002da8b676
+  metadata.gz: 4cfcf3f362557c6f4ab5ec93418b4ca44ae54a07
+  data.tar.gz: cf0b61fd89ff2bb18d1b8b9a3d06d343e8e2d896
 SHA512:
-  metadata.gz: 57fa6ee1baa1af25e8730abb94495c7f2493e731b1f1f8ee1293c7e0d6e601e26b067be321b1bd6414ebe375416fad72f9ab59e48f208ac4645a60abd50fbfb6
-  data.tar.gz: 6fa28ed47391a1d295db390b82b1c8adf9610b28cf58d0778a79004d52f9b9459f8756f71d2fc0a054d1429da3d979e7979f5d9162e672c7dacf8ad27ebae666
+  metadata.gz: 709d6bac30409e21669602e21cc55d0caa9ff198b9599ddfdcc73cbe45f6b6acb4ccc4655e894314af175fc01679b57fa2ca299b4cdf149a3eb11080654952b8
+  data.tar.gz: 6cb9c33a15db38317a2a7d933cc61acf4f01d83d996d739316821ac21de9eb6eaf3b9865d0701be63971756c69629f9860e1179757cec830001b8966b93e955f

data/README.md

@@ -126,7 +126,7 @@ MiniReadline.readline('>', false)
 ```
 While it does require some small changes, the latter form is the preferred one.
 
-##### Module Aliasing
+##### 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
@@ -173,6 +173,10 @@ porting to switch to the mini_readline gem.
 For the most part, compatible mode exists to make that porting process an
 easier one.
 
+**IMPORTANT NOTE: The module aliasing feature is now deprecated. For now there
+will be no change, soon warnings will ensue, then errors. Look for this
+feature to go away by version 0.7.0 unless some feedback is received.**
+
 ### Native Mode
 
 In native mode, instances of the Readline class are used to get user input.
@@ -251,6 +255,10 @@ BASE_OPTIONS = {
   :no_blanks     => true,     #No empty lines in history.
   :no_dups       => true,     #No duplicate lines in history.
 
+  :secret_mask   => nil,      #No secret password mask. Use the
+                              #string "*" to use stars or " "
+                              #for invisible secrets.
+
   :term          => nil,      #Filled in by raw_term.rb
                               #MiniReadline::RawTerm
 
@@ -278,6 +286,9 @@ more details.
 * :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.
+* :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 " ".
 * :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

@@ -20,12 +20,14 @@ module MiniReadline
   private_constant :History
   private_constant :NoHistory
 
-  #The shared instance of Readline.
-  @reader = MiniReadline::Readline.new()
+  #Get the shared instance of Readline.
+  def self.get_reader
+    @reader ||= Readline.new()
+  end
 
   #The (limited) compatibility module function.
   def self.readline(prompt = "", history = nil)
-    @reader.readline(prompt: prompt, history: history)
+    get_reader.readline(prompt: prompt, history: history)
   end
 
 end

data/lib/mini_readline/options.rb

@@ -22,6 +22,10 @@ module MiniReadline
                   :no_blanks     => true,     #No empty lines in history.
                   :no_dups       => true,     #No duplicate lines in history.
 
+                  :secret_mask   => nil,      #No secret password mask. Use the
+                                              #string "*" to use stars or " "
+                                              #for invisible secrets.
+
                   :term          => nil,      #Filled in by raw_term.rb
                                               #MiniReadline::RawTerm
 

data/lib/mini_readline/read_line.rb

@@ -62,6 +62,7 @@ module MiniReadline
       @options.merge!(options)
       (@term = @options[:term]).initialize_parms
       set_prompt(@options[:prompt])
+      verify_mask(@options[:secret_mask])
     end
 
     #Set up the prompt.
@@ -81,6 +82,13 @@ module MiniReadline
       end
     end
 
+    #Verify the secret mask
+    def verify_mask(secret)
+      if secret && secret.length != 1
+        fail "Secret mask must be nil or a single character string."
+      end
+    end
+
     #No warnings please!
     def suppress_warnings
       @old_stderr = $stderr

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

@@ -35,7 +35,13 @@ module MiniReadline
 
     #Compute what should be on the screen.
     def build_screen_image(edit_buffer)
-      edit_buffer[left_margin..right_margin].ljust(active_width)
+      working_region = edit_buffer[left_margin..right_margin]
+
+      if (mask = @options[:secret_mask])
+        mask[0] * working_region.length
+      else
+        working_region
+      end.ljust(active_width)
     end
 
     #Bring the screen into agreement with the image.

data/lib/mini_readline/version.rb

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

data/tests/mini_readline_tests.rb

@@ -73,6 +73,40 @@ class MiniReadlineTester < Minitest::Test
     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
+      puts result.inspect
+      break unless result != "password"
+    end
+
+    assert_equal("password", result)
+  end
+
+  def test_reading_blanked
+    puts
+    puts "To finish this test, enter the word: password"
+
+    edit = MiniReadline::Readline.new
+
+    result = ''
+
+    loop do
+      result = edit.readline(prompt: ">", secret_mask: " ").chomp
+      puts result.inspect
+      break unless result != "password"
+    end
+
+    assert_equal("password", result)
+  end
+
   def test_array_complete
     puts "\nPlease select an approved fruit."
 
@@ -151,6 +185,14 @@ class MiniReadlineTester < Minitest::Test
     assert_raises(RuntimeError) {edit.readline(opts)}
   end
 
+  def test_mask_verification
+    opts = {prompt: ">", secret_mask: ""}
+    edit = MiniReadline::Readline.new()
+    assert_raises(RuntimeError) {edit.readline(opts)}
 
+    opts = {prompt: ">", secret_mask: "xx"}
+    edit = MiniReadline::Readline.new()
+    assert_raises(RuntimeError) {edit.readline(opts)}
+  end
 
 end

metadata

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