mini_readline 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8482183c12c0303a39f18bc9618078108f9c223
-  data.tar.gz: 09d16bd02e569d657acad881922a10f5ffb5f196
+  metadata.gz: 2485e678176d166843920e6f17956c7b839d90e3
+  data.tar.gz: 16afd9de803f9b3d3aae4c8f32318edef88ffbd2
 SHA512:
-  metadata.gz: 09d3ed8de2584e5637f3b6fc832b0ee74971fca0d215bc1c108aa14cb6af6e450afda6e67773cafeac2f688f93b56745e42eaba3e77923ce4baecd7bd98d0893
-  data.tar.gz: ed8ef74313404c8e253ee2ff773d487d79f724427d826bdc23f656772766a70dd41b5f6b0335519c494bed483ca90f10987b028e2cfe44b6f074480ba5480b09
+  metadata.gz: 48fb1ac610d575f4b622f45531842a2ead3b493b7261b4f376181c763dea76942a8058e8594386b02bb1df4835fb8931c21d40e4fa10cddbca7818f915ca7f4c
+  data.tar.gz: e7f170a4f2404366bb00db4d5482ada1e6fa927cd044707ed9e6d0a44b517fd62ac1f6c675e4791d3c5c8b1b2e9e3fa5b66fc6b636f32d279385d182976cc2b1

data/README.md

@@ -4,24 +4,13 @@ This gem is used to get console style input from the user, with support for
 inline editing and command history.
 
 The mini readline gem is an experiment in replacing the standard readline gem
-that is part of Ruby. The reasons for doing this are somewhat shaky, but here
-is a list of what is hoped to be accomplished here.
-
-* The standard readline gem works poorly under Windows.
-<br>- The keypad arrow keys do not work.
-<br>- If the program attempts to send data to a subprocess, it breaks.
-* The code is so convoluted that it is difficult to fix or re-factor.
-* The code is just plain UGLY! With all we've learned about object oriented
-design, there just HAD to be a better way!
-* Finally, since this code will borrow a lot from the original, it is hoped
-that I will see the same bugs and fix them. Then perhaps it can be seen how
-the original code can also be fixed. In the long run, this is perhaps the
-most important goal.
-
-<br>The mini_readline gem is designed for use with MRI version 1.9.3 or later.
+that is part of Ruby. The mini readline will focus on the needs of Ruby programs
+as opposed to a UN*X shell program.
 
-## Installation
+The mini_readline gem is designed for use with MRI version 1.9.3 or later.
+The original readline which tries to support older versions of Ruby.
 
+## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -30,7 +19,6 @@ gem 'mini_readline'
 And then execute:
 
     $ bundle
-
 Or install it yourself as:
 
     $ gem install mini_readline
@@ -119,13 +107,13 @@ as instance level options.
 <br>Once an instance is created it may be used as follows:
 
 ```ruby
-edit.readline(options)
+user_entry = edit.readline(options)
 ```
-Where an optional hash of options settings. For example, to specify a prompt,
-use the following:
+Where an optional hash of options settings. For example, to specify a
+non-default prompt with history enabled, use the following:
 
 ```ruby
-edit.readline(prompt: '>')
+user_entry = edit.readline(prompt: '? ', history: true)
 ```
 
 
@@ -174,6 +162,7 @@ BASE_OPTIONS = {
 
   :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?
 
@@ -183,6 +172,7 @@ BASE_OPTIONS = {
   :no_dups       => true,     #No duplicate lines in history.
 
   :term          => nil,      #Filled in by raw_term.rb
+                              #MiniReadline::RawTerm
 
   :debug         => false}    #Used during development only.
 ```
@@ -199,7 +189,7 @@ 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.
+data other than files and folders. See Auto-Compete below for 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.
@@ -214,6 +204,14 @@ from the user and control what is displayed. This gem automatically adapts to
 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 two auto-complete engines. These are:
+* 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 "foo bar.rb" that may contain spaces.
+This is the default auto-complete data source.
+
 ## 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.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 
+require          "English"
 require_relative "mini_readline/version"
 require_relative "mini_readline/exceptions"
 require_relative "mini_readline/options"

data/lib/mini_readline/options.rb

@@ -13,6 +13,7 @@ module MiniReadline
 
                   :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?
 
@@ -22,6 +23,7 @@ module MiniReadline
                   :no_dups       => true,     #No duplicate lines in history.
 
                   :term          => nil,      #Filled in by raw_term.rb
+                                              #MiniReadline::RawTerm
 
                   :debug         => false     #Used during development only.
                  }

data/lib/mini_readline/raw_term.rb

@@ -6,8 +6,6 @@ require_relative 'raw_term/mapper'
 module MiniReadline
 
   #The class used to manipulate console i/o on a low level.
-  #<br>Endemic Code Smells
-  # :reek:TooManyInstanceVariables
   class RawTerm
 
     #Create a mapper.

data/lib/mini_readline/raw_term/other.rb

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

data/lib/mini_readline/read_line.rb

@@ -11,8 +11,6 @@ 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.
-  #<br>Endemic Code Smells
-  # :reek:TooManyInstanceVariables
   class Readline
 
     #The options specifically associated with this instance.

data/lib/mini_readline/read_line/edit.rb

@@ -30,8 +30,6 @@ require_relative 'edit/unmapped'
 module MiniReadline
 
   #* read_line/edit.rb - The line editor.
-  #<br>Endemic Code Smells
-  # :reek:TooManyInstanceVariables
   class Edit
 
     #Set up the edit instance.

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

@@ -2,12 +2,13 @@
 
 require_relative 'auto_complete/auto_manager'
 require_relative 'auto_complete/file_folder_source'
+require_relative 'auto_complete/quoted_file_folder_source'
 
 #* read_line/window/edit/auto_complete.rb - Process :auto_complete
 module MiniReadline
 
   #Set up the default auto-complete data source.
-  BASE_OPTIONS[:auto_source] = FileFolderSource
+  BASE_OPTIONS[:auto_source] = QuotedFileFolderSource
 
   #* read_line/window/edit/auto_complete.rb - Process :auto_complete
   class Edit

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

@@ -7,14 +7,15 @@ module MiniReadline
   class FileFolderSource
 
     #Create a new file/folder auto-data source. NOP
-    def initialize(_options)
+    def initialize(options)
+      @options = options
     end
 
     #Construct a new data list for auto-complete
     def rebuild(str)
-      @root, pivot = /\S+$/ =~ str ? [$`.to_s, $~.to_s] : [str, ""]
+      extract_root_pivot(str)
 
-      list = Dir.glob(pivot + '*')
+      list = Dir.glob(@pivot + '*')
 
       unless list.empty?
         @cycler = list.cycle
@@ -23,6 +24,11 @@ module MiniReadline
       end
     end
 
+    #Parse the string into the two basic components.
+    def extract_root_pivot(str)
+      @root, @pivot = /\S+$/ =~ str ? [$PREMATCH, $MATCH] : [str, ""]
+    end
+
     #Get the next string for auto-complete
     def next
       @root + @cycler.next

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

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+#* quoted_file_folder_source.rb - The data source for auto-complete.
+module MiniReadline
+
+  #* quoted_file_folder_source.rb - The data source for auto-complete.
+  class QuotedFileFolderSource
+
+    #Create a new file/folder auto-data source. NOP
+    def initialize(options)
+      @options = options
+    end
+
+    #Construct a new data list for auto-complete
+    def rebuild(str)
+      extract_root_pivot(str)
+
+      list = Dir.glob(@pivot + '*')
+
+      unless list.empty?
+        @cycler = list.cycle
+      else
+        @cycler = nil
+      end
+    end
+
+    #Parse the string into the two basic components.
+    def extract_root_pivot(str)
+      @root, @pivot = /(?<=\")([^\"\s][^\"]*)?(?=\"?$)/ =~ str ? [$PREMATCH, $MATCH] : [str + '"', ""]
+    end
+
+    #Get the next string for auto-complete
+    def next
+      "#{@root}#{@cycler.next}\""
+    end
+
+  end
+
+end

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

@@ -7,8 +7,6 @@ require_relative 'edit_window/sync_cursor'
 module MiniReadline
 
   #* read_line/edit_window.rb - Support for the edit window.
-  #<br>Endemic Code Smells
-  # :reek:TooManyInstanceVariables
   class EditWindow
 
     #Determine the edit window limits.
@@ -29,14 +27,6 @@ module MiniReadline
       left_margin + active_width - 1
     end
 
-    #Set the right margin
-    #<br>Notes
-    #* If the right_margin is being set, then we must be scrolling. That is
-    #  why the scroll_width is used instead of active_width here.
-    def right_margin=(value)
-      @left_margin = value - scroll_width + 1
-    end
-
     #Is the window currently in the scrolled state?
     def window_scrolled?
       left_margin > 0

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

@@ -19,11 +19,11 @@ module MiniReadline
       old_margins = [left_margin, right_margin]
 
       if length < base_width
-        @left_margin = 0
+        set_left_margin(0)
       elsif edit_posn < left_margin
-        @left_margin = [edit_posn - scroll_step, 0].max
+        set_left_margin([edit_posn - scroll_step, 0].max)
       elsif edit_posn > right_margin
-        self.right_margin = edit_posn + scroll_step
+        set_right_margin(edit_posn + scroll_step)
       end
 
       old_margins == [left_margin, right_margin]
@@ -44,5 +44,19 @@ module MiniReadline
       end
     end
 
+    private
+
+    #Set the left margin
+    def set_left_margin(value)
+      @left_margin = value
+    end
+
+    #Set the right margin
+    #<br>Notes
+    #* If the right_margin is being set, then we must be scrolling. That is
+    #  why the scroll_width is used instead of active_width here.
+    def set_right_margin(value)
+      @left_margin = value - scroll_width + 1
+    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.2.0"
+  VERSION = "0.3.0"
 end

data/mini_readline.reek

@@ -0,0 +1,109 @@
+---
+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: []
+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: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 1

data/sire.rb

@@ -54,7 +54,7 @@ class SIRE
   def q
     @_done = true
     puts
-    "Bye bye for now!"
+    "Quit command."
   end
 
   #Get a mapped keystroke.
@@ -71,69 +71,6 @@ class SIRE
     end
   end
 
-  #Strict Windows Regex.
-  # a File name character, no spaces.
-  # b File name character, with spaces.
-  # c Drive specification.
-  # x Non-quoted file spec.
-  # y Quoted file spec.
-  WRE = %r{
-    (?<a> [^\/\\\:\*\?\<\>\"\s]){0}
-    (?<b> [^\/\\\:\*\?\<\>\"]){0}
-    (?<c> ([a-zA-z]\:)?\\){0}
-    (?<x> \g<c>?(\g<a>*\\?)*){0}
-    (?<y> \"\g<c>?(\g<a>(\g<b>*\g<a>)?\\?)*\"){0}
-
-    (\g<x>|\g<y>)$
-  }x
-
-  #Test the WRE
-  def wre(str)
-    WRE.match str
-  end
-
-  #Rubified Windows Regex.
-  # a File name character, no spaces.
-  # b File name character, with spaces.
-  # c Drive specification.
-  # x Non-quoted file spec.
-  # y Quoted file spec.
-  RRE = %r{
-    (?<a> [^\/\\\:\*\?\<\>\"\s]){0}
-    (?<b> [^\/\\\:\*\?\<\>\"]){0}
-    (?<c> ([a-zA-z]\:)?\/){0}
-    (?<x> \g<c>?(\g<a>*\/?)*){0}
-    (?<y> \"\g<c>?(\g<a>(\g<b>*\g<a>)?\/?)*\"){0}
-
-    (\g<x>|\g<y>)$
-  }x
-
-  #Test the RRE
-  def rre(str)
-    RRE.match str
-  end
-
-  #Other Platforms Regex.
-  # a File name character, no spaces.
-  # b File name character, with spaces.
-  # c Root specification.
-  # x Non-quoted file spec.
-  # y Quoted file spec.
-  ORE = %r{
-    (?<a> [^\/\\\:\*\?\<\>\"\s]){0}
-    (?<b> [^\/\\\:\*\?\<\>\"]){0}
-    (?<c> \/){0}
-    (?<x> \g<c>?(\g<a>*\/?)*){0}
-    (?<y> \"\g<c>?(\g<a>(\g<b>*\g<a>)?\/?)*\"){0}
-
-    (\g<x>|\g<y>)$
-  }x
-
-  #Test the ORE
-  def ore(str)
-    ORE.match str
-  end
-
   #Execute a single line.
   def exec_line(line)
     result = eval line
@@ -153,17 +90,22 @@ class SIRE
 
   #Run the interactive session.
   def run_sire
+    edit = MiniReadline::Readline.new(prompt: 'SIRE>',
+                                      auto_complete: true,
+                                      history: true,
+                                      eoi_detect: true)
+
     puts
     puts "Welcome to a Simple Interactive Ruby Environment\n"
     puts "Use the command 'q' to quit.\n\n"
 
     until @_done
-      exec_line(Readline.readline('SIRE>', true))
+      exec_line(edit.readline)
     end
 
     puts "\n\n"
 
-  rescue Interrupt => e
+  rescue MiniReadlineEOI, Interrupt => e
     puts "\n"
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -97,6 +97,7 @@ files:
 - lib/mini_readline/read_line/edit/auto_complete.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
 - lib/mini_readline/read_line/edit/cancel.rb
 - lib/mini_readline/read_line/edit/delete_left.rb
 - lib/mini_readline/read_line/edit/delete_right.rb
@@ -119,6 +120,7 @@ files:
 - lib/mini_readline/read_line/no_history.rb
 - lib/mini_readline/version.rb
 - mini_readline.gemspec
+- mini_readline.reek
 - reek.txt
 - sire.rb
 - tests/mini_readline_tests.rb