mini_readline 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d02c8500ead51f6717b792807c8ae1f30a96a89
-  data.tar.gz: 3b63e4704a3b10130e83a44724cf90ee1aaa00aa
+  metadata.gz: b99074b9e302cfad6d12453e21419394e8659d98
+  data.tar.gz: 8cdcf679fa4c2ae55420576aa45d885c3db7aabc
 SHA512:
-  metadata.gz: 7c1a11f6c6d153bc9dc6be134cf468137f2520fae462c72592bc4dbeed4dc454f0e9eabe121d82b596d59110704650630ac004f80f7778375e938ad754c36a16
-  data.tar.gz: eca8f72a58a7b61385828e2de85db43798f966194477dc60dfd3e5b60d2ab4d7a3d6a1201f664062ff8eaed6b3f9896c1ce6ec99674af4dca27f2274671406ae
+  metadata.gz: 568cb8c8337f78c7193e2792961cfa74a29e31432e1dfd54f3fa6daa569709b613512908990b4249f45ace3db009ae33abfd6991920e55f6e0d2fbf59b266060
+  data.tar.gz: da6334808b842adc057dd1a026738de4d33d9a2ec19f004911834c3d05a5efb4329b3b50aebb185692db75e815909f30e5432315e0738e60dc29b7132b6290c3

data/README.md

@@ -112,19 +112,20 @@ In native mode, instances of the Readline class are used to get user input.
 edit = MiniReadline::Readline.new()
 ```
 
-The constructor takes a single optional argument which is either:
+The constructor takes two optional arguments. The first is either:
 * An array of strings; A history buffer pre-loaded with commands.
 * An empty array; A history buffer with no pre-load.
-* The value **false**, to disable the history buffer.
+
+<br>The second is a hash of options that are used as instance level options.
 
 <br>Once an instance is created it may be used as follows:
 
 ```ruby
 edit.readline(prompt, options)
 ```
-Where prompt is a prompt string and options is a hash of options settings.
-More on options below. In addition, it is possible to get a hold of the
-history buffer of the edit object with:
+Where prompt is a prompt string and options is an optional hash of options
+settings. In addition, it is possible to get a hold
+of the history buffer of the edit object with:
 ```ruby
 hist = edit.history
 ```
@@ -134,6 +135,7 @@ menacing part of the history buffer.
 ```ruby
 hist << "launch --weapons:nuclear --all"
 ```
+<br>Maybe I should cut back on the Fallout/4?
 
 ### Options
 In mini_readline, options exist at three levels:
@@ -163,7 +165,7 @@ BASE_OPTIONS = {
   :alt_prompt    => "<< ",    #The prompt when scrolled.
                               #Set to nil for no alt prompt.
 
-  :auto_complete => true,     #Is auto complete enabled?
+  :auto_complete => false,    #Is auto complete enabled?
   :auto_source   => nil,      #Filled in by auto_complete.rb
 
   :history       => false,    #Is the history buffer enabled?
@@ -172,12 +174,24 @@ BASE_OPTIONS = {
 
   :term          => nil,      #Filled in by raw_term.rb
 
-  :debug         => false}    #Used during development.
+  :debug         => false}    #Used during development only.
 ```
 
-<br>The options in effect on any given call of the readline method are the
-module base options plus any options passed in as an argument. The passed in
-options override the base options for the duration of that method call.
+<br>While most of these options are self explanatory, a few could stand some
+further description:
+* :alt_prompt is the prompt used when the text must be scrolled to fit on the
+screen.
+* :auto_complete is disabled by default. Of course there are a number of ways
+to enable it, or to make auto-complete enabled the default use:
+```ruby
+require 'mini_readline'
+MiniReadline::BASE_OPTION[:auto_complete] = true
+```
+* :auto_source is the class of the source for auto-complete data. By default this
+is MiniReadline::FileFolderSource. This option can be changed up to get auto-complete
+data other than files and folders.
+* :term is the interactive source of data, the console by default. This can be
+changed to get data from another source (like a serial attached terminal).
 
 #### Notes
 * Since the compatibility mode does not accept an options hash, the only way to
@@ -239,7 +253,7 @@ To date this code has been tested under:
 * Windows 7 with ruby 2.1.6p336 (2015-04-13 revision 50298) [i386-mingw32]
 * Windows 7+Cygwin with ruby 2.2.3p173 (2015-08-18 revision 51636) [i386-cygwin]
 
-<br>**More testing is clearly called for.**
+<br>**More testing is clearly called for and suggestions/bug reports are most welcomed!!!**
 
 ## Contributing
 

data/lib/mini_readline/options.rb

@@ -18,6 +18,6 @@ module MiniReadline
 
                   :term          => nil,      #Filled in by raw_term.rb
 
-                  :debug         => false     #Used during development.
+                  :debug         => false     #Used during development only.
                  }
 end

data/lib/mini_readline/version.rb

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

data/mini_readline.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["peter.c.camilleri@gmail.com"]
 
   spec.summary       = "A simplified replacement for readline."
-  spec.description   = "[WIP] A gem for console command entry with line edit "+
+  spec.description   = "A gem for console command entry with line edit "+
                        "and history. This gem is like the standard readline " +
                        "gem except that it has been redesigned, simplified, " +
                        "and extensively cleaned up."

data/sire.rb

@@ -5,23 +5,23 @@ require 'pp'
 
 if ARGV[0] == 'old'
   require 'readline'
-  puts "\nOption(old). Loaded the standard readline gem."
+  puts "\nOption(old). Loaded 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."
+  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."
+  puts "\nThe mini_readline gem is already loaded. Version #{MiniReadline::VERSION}"
 else
   begin
     require 'mini_readline'
-    puts "\nLoaded mini_readline from the system gem."
+    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."
+      puts "\nLoaded mini_readline from the local code folder. Version #{MiniReadline::VERSION}"
     rescue LoadError
       require 'readline'
-      puts "\nLoaded the standard readline gem."
+      puts "\nLoaded the standard readline gem. Version #{Readline::VERSION}"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -66,9 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: "[WIP] A gem for console command entry with line edit and history. This
-  gem is like the standard readline gem except that it has been redesigned, simplified,
-  and extensively cleaned up."
+description: A gem for console command entry with line edit and history. This gem
+  is like the standard readline gem except that it has been redesigned, simplified,
+  and extensively cleaned up.
 email:
 - peter.c.camilleri@gmail.com
 executables: []