mini_readline 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c4b59c3ed5eef086cdc8d84721c915aff9245a9
-  data.tar.gz: 59cd9ed8d1551f35eff77d4741c0d929840adf29
+  metadata.gz: 677e16d732f1de6aaab8fe7a37c41e1abb18364c
+  data.tar.gz: f42cd241844d9810a030317fcd9f9ae4efaeeb58
 SHA512:
-  metadata.gz: 01bbf868f58fd910b4b98bbc6a07847250ebb45ffa03aed55cb7e044d79d1a0844350f8d942850d56872e42fc8e14d8889e6252103b610b18ce9a2c8f0304a9c
-  data.tar.gz: 80c1d3a44427f21da3f44b70253af0fa62856aad01aa63a23b50fb2090f5f108e9c36b2d11e4c8483b215d791281b658112d3c1d09c770e353c93286bd65cc16
+  metadata.gz: e2f9de63c86714f2e338c361477c020d0d38ad9f9f1082eee28a358b0391f9eac9f0dff12b51df75c194294c7d721051518984f2d3d3148831e3f6cd08f06f7d
+  data.tar.gz: fc33371d82f378538db0ef0df28e40615b977729a5fbb6526ca43b3f1db6477d6d08758b0c22e4c5e058389a78bc85bc15f0cdabbfdb66496e8904faffdee7b1

data/README.md

@@ -282,15 +282,31 @@ the environment and plugs in the needed object. This can be overridden where
 special io needs exist.
 
 ### Auto-Complete
-The mini readline gem comes with three auto-complete engines. These are:
-* MiniReadline::ArraySource - Make a selection from an array of choices. That
-array is found in the option :array_src. This can either be an array of
-strings or a proc (or lambda) that returns an array of strings.
-* MiniReadline::FileFolderSource - A simple, in-line auto-complete for files
-and folders that do **not** contain embedded spaces.
-* MiniReadline::QuotedFileFolderSource - A simple, in-line auto-complete for
-files and folders embedded in quotes. For example "foo bar.rb". Note that the
-file names may contain spaces. This is the default auto-complete data source.
+The mini readline gem comes with four auto-complete engines. These are:
+
+###### MiniReadline::ArraySource
+Make a selection from an array of choices. That array is found in the
+option :array_src. This can either be an array of strings or a proc (or lambda)
+that returns an array of strings. This is an excellent choice for choosing
+from a list or program generated selection of choices.
+
+###### MiniReadline::FileFolderSource
+A simple, in-line auto-complete for files and folders. This is an excellent
+choice for cases where file names are to be used by a ruby program or passed
+to a Linux/Other command line shell.
+
+###### MiniReadline::QuotedFileFolderSource
+A simple, in-line auto-complete for files and folders embedded in quotes.
+This is a good choice where the returned string is to be evaluated as ruby
+code. The enclosing quotes will ensure that file names are evaluated as
+strings. NOTE: This is the default auto-complete data source.
+
+###### MiniReadline::AutoFileSource
+This auto-complete for files and folders is designed to automatically select
+the appropriate folder separator character and use quotes when files contain
+embedded spaces. This is a good choice when building commands with files that
+will be passed to the command line processor in multi-platform, portable
+environments.
 
 ### Adding Custom Auto-Completers
 It is possible, and fairly straightforward to add application specific
@@ -344,6 +360,13 @@ options.
 statement to permit the use of clearer, easier to read access to regular
 expression results.
 
+### Important Security Note
+
+It must be remembered that any time strings are passed to the command line
+processor, there are serious security concerns. Passing such strings should
+only be done in cases where the user would be trusted with access to the
+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:

data/lib/mini_readline/read_line.rb

@@ -37,10 +37,12 @@ module MiniReadline
     #* prompt - A string used to prompt the user. '>' is popular.
     #* options - A hash of options; Typically symbol: value
     def readline(options = {})
+      suppress_warnings
       initialize_parms(options)
       @edit.edit_process
     ensure
       @term.conclude
+      restore_warnings
     end
 
     #Initialize the read line process. This basically process the arguments
@@ -78,5 +80,18 @@ module MiniReadline
         fail "Too long: #{prompt.inspect}"
       end
     end
+
+    #No warnings please!
+    def suppress_warnings
+      @old_stderr = $stderr
+      $stderr = File.open(File::NULL, 'w')
+    end
+
+    #Restore warnings to their typical ugliness.
+    def restore_warnings
+      $stderr.close
+      $stderr = @old_stderr
+    end
+
   end
 end

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

@@ -2,6 +2,7 @@
 
 require_relative 'auto_complete/auto_manager'
 require_relative 'auto_complete/file_folder_source'
+require_relative 'auto_complete/auto_file_source'
 require_relative 'auto_complete/quoted_file_folder_source'
 require_relative 'auto_complete/array_source'
 

data/lib/mini_readline/read_line/edit/auto_complete/auto_file_source.rb

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+#* auto_file.rb - The data source for mysh file name auto-complete.
+module MiniReadline
+
+  #* auto_file_source.rb - A flexible file source for shell emulation.
+  class AutoFileSource
+
+    #Create a new file/folder auto-data source. NOP
+    def initialize(_options)
+      #Do nothing here!
+    end
+
+    #Construct a new data list for auto-complete
+    def rebuild(str)
+      extract_root_pivot(str)
+
+      list = Dir.glob(dress_down(@pivot) + '*')
+
+      @cycler = list.empty? ? nil : list.cycle
+    end
+
+    #The regex for extraction of the root and pivot.
+    EXTRACT = /("[^"\s][^"]*"?$)|(\S+$)/
+
+    #Parse the string into the two basic components.
+    def extract_root_pivot(str)
+      @root, @pivot = EXTRACT =~ str ? [$PREMATCH, $MATCH] : [str, ""]
+    end
+
+    #Get the next string for auto-complete
+    def next
+      @root + dress_up(@cycler.next)
+    end
+
+    #Prepare the file name for internal use.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def dress_down(name)
+      name.gsub("\\", "/").gsub('"', '')
+    end
+
+    #Prepare the file name for external use.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def dress_up(name)
+      dress_up_quotes(dress_up_slashes(name))
+    end
+
+    #Dress up slashes and backslashes.
+    def dress_up_slashes(name)
+      backslash? ? name.gsub("/", "\\") : name
+    end
+
+    #Dress up in quotes if needed.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def dress_up_quotes(name)
+      name[' '] ? "\"#{name}\"" : name
+    end
+
+    #Does this file name use backslashes?
+    def backslash?
+      if @pivot.end_with?("\\")
+        true
+      elsif @pivot.end_with?("/")
+        false
+      elsif @pivot["\\"]
+        true
+      elsif @pivot["/"]
+        false
+      else
+        MiniReadline::PLATFORM == :windows
+      end
+    end
+
+  end
+
+end

data/lib/mini_readline/version.rb

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

data/tests/mini_readline_tests.rb

@@ -119,7 +119,7 @@ class MiniReadlineTester < Minitest::Test
     assert(result.is_a?(String))
   end
 
-  def test_file_quoated
+  def test_file_quoted
     puts "\nPlease select an quoted file."
 
     edit = MiniReadline::Readline.new(auto_complete: true,
@@ -129,6 +129,16 @@ class MiniReadlineTester < Minitest::Test
     assert(result.is_a?(String))
   end
 
+  def test_file_shell
+    puts "\nPlease select an auto file."
+
+    edit = MiniReadline::Readline.new(auto_complete: true,
+                                      auto_source: MiniReadline::AutoFileSource)
+
+    result = edit.readline(prompt: "File: ")
+    assert(result.is_a?(String))
+  end
+
   def test_end_of_input_detection
     edit = MiniReadline::Readline.new()
     puts "Exit by signaling end of input"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-03 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -98,6 +98,7 @@ files:
 - lib/mini_readline/read_line/edit.rb
 - lib/mini_readline/read_line/edit/auto_complete.rb
 - lib/mini_readline/read_line/edit/auto_complete/array_source.rb
+- lib/mini_readline/read_line/edit/auto_complete/auto_file_source.rb
 - lib/mini_readline/read_line/edit/auto_complete/auto_manager.rb
 - lib/mini_readline/read_line/edit/auto_complete/file_folder_source.rb
 - lib/mini_readline/read_line/edit/auto_complete/quoted_file_folder_source.rb