bond 0.3.5 → 0.4.0

data/.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = "gabriel.horner@gmail.com"
   s.homepage    = "http://tagaholic.me/bond/"
   s.summary = "Mission: Easy custom autocompletion for arguments, methods and beyond. Accomplished for irb and any other readline-like console environments."
-  s.description = "Bond is on a mission to improve autocompletion in ruby, especially for ripl/irb. Aside from doing everything irb's can do and fixing its quirks, Bond can autocomplete argument(s) to methods, uniquely completing per module, per method and per argument. Bond brings irb's completion closer to bash/zsh as it provides a configuration system and a DSL for creating custom completions and completion rules. With this configuration system, users can customize their irb autocompletions and share it with others. Bond can also load completions that ship with gems.  Bond is able to offer more than irb's completion since it uses a Readline C extension to get the full line of input when completing as opposed to irb's last-word approach."
+  s.description = "Bond is on a mission to improve autocompletion in ruby, especially for irb/ripl. Aside from doing everything irb's can do and fixing its quirks, Bond can autocomplete argument(s) to methods, uniquely completing per module, per method and per argument. Bond brings ruby autocompletion closer to bash/zsh as it provides a configuration system and a DSL for creating custom completions and completion rules. With this configuration system, users can customize their autocompletions and share it with others. Bond can also load completions that ship with gems.  Bond is able to offer more than irb's completion since it uses the full line of input when completing as opposed to irb's last-word approach."
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = 'tagaholic'
   s.has_rdoc = 'yard'

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 0.4.0
+* Improve extconf.rb: support --without-readline, fail hard, detect windows
+* Add rb-readline support for windows and non-readline users
+* Rename :readline_plugin option to :readline
+* Allow :readline option to take a symbol
+
 == 0.3.5
 * Move yard-related functionality to bond-yard gem
   

data/README.rdoc

@@ -1,32 +1,42 @@
-Note: To read a linked version of this README, {click here}[http://tagaholic.me/bond/doc/]
-
 == Description
 
-Bond is on a mission to improve autocompletion in ruby, especially for ripl/irb. Aside from doing
+Bond is on a mission to improve autocompletion in ruby, especially for irb/ripl. Aside from doing
 everything irb's can do and fixing its quirks, Bond can autocomplete argument(s) to methods,
-uniquely completing per module, per method and per argument. Bond brings irb's completion closer to
-bash/zsh as it provides a configuration system and a DSL for creating custom completions and
-completion rules. With this configuration system, users can customize their irb autocompletions and
+uniquely completing per module, per method and per argument. Bond brings ruby autocompletion closer
+to bash/zsh as it provides a configuration system and a DSL for creating custom completions and
+completion rules. With this configuration system, users can customize their autocompletions and
 share it with others. Bond can also load completions that ship with gems.  Bond is able to offer
-more than irb's completion since it uses a Readline C extension to get the full line of input when
-completing as opposed to irb's last-word approach.
+more than irb's completion since it uses the full line of input when completing as opposed to irb's
+last-word approach.
 
 == Install
 
-Install the gem with:
+To use bond with {Readline}[http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html] (version >=
+5.6 recommended) or JLine for JRuby users, install the gem with:
+
+    gem install bond
+
+To use bond with {a pure ruby readline}[https://github.com/luislavena/rb-readline] i.e. Windows
+users or users without Readline:
+
+    gem install bond rb-readline -- --without-readline
 
-    sudo gem install bond
+To use bond without readline support (and presumably use your own readline plugin):
+
+    gem install bond -- --without-readline
 
 == Setup
 
-To start off, replace irb's completion (require 'irb/completion') with Bond's enhanced version in your irbrc :
+If you're using {ripl}[http://github.com/cldwalker/ripl] instead of irb, bond is already setup.
+
+To start off, replace irb's completion (require 'irb/completion') with Bond's enhanced version in your irbrc:
 
   require 'bond'
   Bond.start
+  # For users using a pure ruby readline
+  Bond.start :readline => :ruby
 
-If you're using {ripl}[http://github.com/cldwalker/ripl], bond is used by default.
-
-This gives you more consistent method completion on any object, customizable completions
+This setup gives you more consistent method completion on any object, customizable completions
 and argument completion of some 80+ methods including Hash#[], Kernel#system, Kernel#require and some Rails methods.
 
 == Method Argument Completion

data/ext/readline_line_buffer/extconf.rb

@@ -7,16 +7,17 @@ def dummy_makefile
   }
 end
 
-if RUBY_VERSION < '1.9.2' && RUBY_PLATFORM !~ /java/
+if RUBY_VERSION >= '1.9.2' || RUBY_PLATFORM[/java|mswin|mingw|bccwin|wince/i] ||
+  ARGV.include?('--without-readline')
+  dummy_makefile
+else
   dir_config("readline")
   have_library('readline')
   if !have_header('readline/readline.h')
-    puts "Bond was built without readline. To use it with readline: gem install bond" +
-      " -- --with-readline-dir=/path/to/readline"
-    dummy_makefile
+    abort "\n** Bond Install Error: Unable to find readline.h. Please try again. **\n"+
+    "To install with your readline: gem install bond -- --with-readline-dir=/path/to/readline\n"+
+    "To install without readline: gem install bond -- --without-readline"
   else
     create_makefile 'readline_line_buffer'
   end
-else
-  dummy_makefile
 end

data/lib/bond.rb

@@ -1,7 +1,9 @@
 require 'bond/m'
 require 'bond/version'
 require 'bond/readline'
-require 'bond/rawline'
+require 'bond/readlines/rawline'
+require 'bond/readlines/ruby'
+require 'bond/readlines/jruby'
 require 'bond/agent'
 require 'bond/search'
 require 'bond/input'
@@ -24,11 +26,11 @@ module Bond
   # or turned off per mission with :search. If turned off, the action must also handle searching.
   #
   # ==== Examples:
-  #  Bond.complete(:method=>'shoot') {|input| %w{to kill} }
-  #  Bond.complete(:on=>/^((([a-z][^:.\(]*)+):)+/, :search=>false) {|input| Object.constants.grep(/#{input.matched[1]}/) }
-  #  Bond.complete(:object=>ActiveRecord::Base, :search=>:underscore, :place=>:last)
-  #  Bond.complete(:method=>'you', :search=>proc {|input, list| list.grep(/#{input}/i)} ) {|input| %w{Only Live Twice} }
-  #  Bond.complete(:method=>'system', :action=>:shell_commands)
+  #  Bond.complete(:method => 'shoot') {|input| %w{to kill} }
+  #  Bond.complete(:on => /^((([a-z][^:.\(]*)+):)+/, :search => false) {|input| Object.constants.grep(/#{input.matched[1]}/) }
+  #  Bond.complete(:object => ActiveRecord::Base, :search => :underscore, :place => :last)
+  #  Bond.complete(:method => 'you', :search => proc {|input, list| list.grep(/#{input}/i)} ) {|input| %w{Only Live Twice} }
+  #  Bond.complete(:method => 'system', :action => :shell_commands)
   #
   # @param [Hash] options When using :method(s) or :object, some hash keys may have different behavior. See
   #   Bond.complete sections of {MethodMission} and {ObjectMission} respectively.
@@ -61,7 +63,7 @@ module Bond
   # Redefines an existing completion mission to have a different action. The condition can only be varied if :name is
   # used to identify and replace a mission. Takes same options as {#complete}.
   # ==== Example:
-  #   Bond.recomplete(:on=>/man/, :name=>:count) { %w{4 5 6}}
+  #   Bond.recomplete(:on => /man/, :name => :count) { %w{4 5 6}}
   def recomplete(options={}, &block); M.recomplete(options, &block); end
 
   # Reports what completion mission matches for a given input. Helpful for debugging missions.
@@ -80,17 +82,18 @@ module Bond
   # {Rc} for the DSL to use in completion files and in the block.
   #
   # ==== Examples:
-  #   Bond.start :gems=>%w{hirb}
-  #   Bond.start(:default_search=>:ignore_case) do
-  #     complete(:method=>"Object#respond_to?") {|e| e.object.methods }
+  #   Bond.start :gems => %w{hirb}
+  #   Bond.start(:default_search => :ignore_case) do
+  #     complete(:method => "Object#respond_to?") {|e| e.object.methods }
   #   end
   #
   # @param [Hash] options Sets global keys in {#config}, some which specify what completions to load.
   # @option options [Array<String>] :gems Gems which have their completions loaded from
   #   @gem_source/lib/bond/completions/*.rb. If gem is a plugin gem i.e. ripl-plugin, completion will be loaded
   #   from @gem_source/lib/ripl/completions/plugin.rb.
-  # @option options [Module] :readline_plugin (Bond::Readline) Specifies a Bond plugin to interface with a Readline-like
-  #   library. Available plugins are Bond::Readline and Bond::Rawline.
+  # @option options [Module, Symbol] :readline (Bond::Readline) Specifies a Bond readline plugin.
+  #   A symbol points to a capitalized Bond constant i.e. :ruby -> Bond::Ruby.
+  #   Available plugins are Bond::Readline, Bond::Ruby, Bond::Jruby and Bond::Rawline.
   # @option options [Proc] :default_mission (DefaultMission) Sets default completion to use when no missions match.
   #  See {Agent#default_mission}.
   # @option options [Symbol] :default_search (:underscore) Name of a *_search method in Rc to use as the default

data/lib/bond/agent.rb

@@ -1,6 +1,7 @@
 module Bond
-  # Every time a completion is attempted, the Agent searches its missions for the first one that matches the user input.
-  # Using either the found mission or Agent.default_mission, the Agent executes the mission's action.
+  # Every time a completion is attempted, the Agent searches its missions for
+  # the first one that matches the user input.  Using either the found mission
+  # or Agent.default_mission, the Agent executes the mission's action.
   class Agent
     # The array of missions that will be searched when a completion occurs.
     attr_reader :missions
@@ -8,7 +9,7 @@ module Bond
     attr_reader :weapon
 
     def initialize(options={}) #@private
-      setup_readline_plugin(options[:readline_plugin])
+      setup_readline(options[:readline])
       @default_mission_action = options[:default_mission] if options[:default_mission]
       Mission.eval_binding = options[:eval_binding] if options[:eval_binding]
       Search.default_search = options[:default_search] || :normal
@@ -37,20 +38,21 @@ module Bond
       mission
     end
 
-    # This is where the action starts when a completion is initiated. Optional line_buffer
-    # overrides line buffer from readline plugin.
+    # This is where the action starts when a completion is initiated. Optional
+    # line_buffer overrides line buffer from readline plugin.
     def call(input, line_buffer=nil)
       mission_input = line_buffer || @weapon.line_buffer
       mission_input = $1 if mission_input !~ /#{Regexp.escape(input)}$/ && mission_input =~ /^(.*#{Regexp.escape(input)})/
       (mission = find_mission(mission_input)) ? mission.execute : default_mission.execute(Input.new(input))
-    rescue FailedMissionError=>e
+    rescue FailedMissionError => e
       completion_error(e.message, "Completion Info: #{e.mission.match_message}")
     rescue
       completion_error "Failed internally with '#{$!.message}'.",
         "Please report this issue with debug on: Bond.config[:debug] = true."
     end
 
-    # Given a hypothetical user input, reports back what mission it would have found and executed.
+    # Given a hypothetical user input, reports back what mission it would have
+    # found and executed.
     def spy(input)
       if (mission = find_mission(input))
         puts mission.match_message, "Possible completions: #{mission.execute.inspect}",
@@ -58,7 +60,7 @@ module Bond
       else
         puts "Doesn't match a completion."
       end
-    rescue FailedMissionError=>e
+    rescue FailedMissionError => e
       puts e.mission.match_message, e.message,
         "Matches for #{e.mission.condition.inspect} are #{e.mission.matched.to_a.inspect}"
     end
@@ -69,7 +71,7 @@ module Bond
 
     # Default mission used by agent. An instance of DefaultMission.
     def default_mission
-      @default_mission ||= DefaultMission.new(:action=>@default_mission_action)
+      @default_mission ||= DefaultMission.new(:action => @default_mission_action)
     end
 
     # Resets an agent's missions
@@ -78,16 +80,15 @@ module Bond
     end
 
     protected
-    def setup_readline_plugin(plugin)
-      raise ArgumentError unless plugin.is_a?(Module)
-      @weapon = plugin.extend(plugin)
+    def setup_readline(plugin)
+      @weapon = plugin
       @weapon.setup(self)
     rescue
       $stderr.puts "Bond Error: Failed #{plugin.to_s[/[^:]+$/]} setup with '#{$!.message}'"
     end
 
     def create_mission(options, &block)
-      Mission.create options.merge!(:action=>options[:action] || block)
+      Mission.create options.merge!(:action => options[:action] || block)
     rescue InvalidMissionError
       "Invalid #{$!.message} for completion with options: #{options.inspect}"
     rescue
@@ -104,4 +105,4 @@ module Bond
       arr
     end
   end
-end
+end

data/lib/bond/completions/bond.rb

@@ -2,5 +2,5 @@ complete(:methods=>%w{Bond.complete Bond.recomplete}) {
   ["on", "method", "methods", "class", "object", "anywhere", "prefix", "search", "action", "place", "name"]
 }
 complete(:methods=>['Bond.start', 'Bond.restart']) {
-  %w{gems readline_plugin default_mission default_search eval_binding debug eval_debug bare}
+  %w{gems readline default_mission default_search eval_binding debug eval_debug bare}
 }

data/lib/bond/m.rb

@@ -1,5 +1,6 @@
 module Bond
-  # Takes international quagmires (a user's completion setup) and passes them on as missions to an Agent.
+  # Takes international quagmires (a user's completion setup) and passes them on
+  # as missions to an Agent.
   module M
     extend self
 
@@ -30,7 +31,7 @@ module Bond
 
     # See {Bond#config}
     def config
-      @config ||= {:readline_plugin=>Bond::Readline, :debug=>false, :default_search=>:underscore}
+      @config ||= {:debug => false, :default_search => :underscore}
     end
 
     # Resets M's missions and config
@@ -47,10 +48,13 @@ module Bond
     # Validates and sets values in M.config.
     def debrief(options={})
       config.merge! options
-      plugin_methods = %w{setup line_buffer}
-      unless config[:readline_plugin].is_a?(Module) &&
-        plugin_methods.all? {|e| config[:readline_plugin].instance_methods.map {|f| f.to_s}.include?(e)}
-        $stderr.puts "Bond Error: Invalid readline plugin given."
+      config[:readline] ||= default_readline
+      if !config[:readline].is_a?(Module) &&
+        Bond.const_defined?(config[:readline].to_s.capitalize)
+        config[:readline] = Bond.const_get(config[:readline].to_s.capitalize)
+      end
+      unless %w{setup line_buffer}.all? {|e| config[:readline].respond_to?(e) }
+        $stderr.puts "Bond Error: Invalid readline plugin '#{config[:readline]}'."
       end
     end
 
@@ -74,7 +78,8 @@ module Bond
       !!@started
     end
 
-    # Finds the full path to a gem's file relative it's load path directory. Returns nil if not found.
+    # Finds the full path to a gem's file relative it's load path directory.
+    # Returns nil if not found.
     def find_gem_file(rubygem, file)
       begin gem(rubygem); rescue Exception; end
       (dir = $:.find {|e| File.exists?(File.join(e, file)) }) && File.join(dir, file)
@@ -110,6 +115,11 @@ module Bond
     end
 
     protected
+    def default_readline
+      RUBY_PLATFORM[/mswin|mingw|bccwin|wince/i] ? Ruby :
+        RUBY_PLATFORM[/java/i] ? Jruby : Bond::Readline
+    end
+
     def load_gem_completion(rubygem)
       (dir = find_gem_file(rubygem, File.join(rubygem, '..', 'bond'))) ? load_dir(dir) :
         rubygem[/\/|-/] ? load_plugin_file(rubygem) :

data/lib/bond/mission.rb

@@ -145,7 +145,7 @@ module Bond
     end
 
     def create_input(input, options={})
-      @input = Input.new(input, options.merge(:line=>@line, :matched=>@matched))
+      @input = Input.new(input, options.merge(:line => @line, :matched => @matched))
     end
   end
 end

data/lib/bond/missions/anywhere_mission.rb

@@ -1,6 +1,7 @@
-# A mission which completes anywhere i.e. even after non word break characters such as '[' or '}'.
-# With options :prefix and :anywhere, this mission matches on the following regexp condition
-# /:prefix?(:anywhere)$/ and passes the first capture group to the mission action.
+# A mission which completes anywhere i.e. even after non word break characters
+# such as '[' or '}'.  With options :prefix and :anywhere, this mission matches
+# on the following regexp condition /:prefix?(:anywhere)$/ and passes the first
+# capture group to the mission action.
 class Bond::AnywhereMission < Bond::Mission
   def initialize(options={}) #@private
     options[:on] = Regexp.new("#{options[:prefix]}(#{options[:anywhere]})$")

data/lib/bond/missions/method_mission.rb

@@ -13,13 +13,13 @@ module Bond
   #           Otherwise defaults to normal :search behavior.
   # [:name, :place] These options aren't supported by a MethodMission/OperatorMethodMission completion.
   # ==== Examples:
-  #   Bond.complete(:methods=>%w{delete index rindex}, :class=>"Array#") {|e| e.object }
-  #   Bond.complete(:method=>"Hash#index") {|e| e.object.values }
+  #   Bond.complete(:methods => %w{delete index rindex}, :class => "Array#") {|e| e.object }
+  #   Bond.complete(:method => "Hash#index") {|e| e.object.values }
   #
   # ==== Argument Format
   # All method arguments can autocomplete as symbols or strings and the first argument can be prefixed
   # with '(':
-  #   >> Bond.complete(:method=>'example') { %w{some example eh} }
+  #   >> Bond.complete(:method => 'example') { %w{some example eh} }
   #   => true
   #   >> example '[TAB]
   #   eh    example    some
@@ -33,7 +33,7 @@ module Bond
   # Every time a comma appears after a method, Bond starts a new completion. This allows a method to
   # complete multiple arguments as well as complete keys for a hash. *Each* argument can be have a unique
   # set of completions since a completion action is aware of what argument it is currently completing:
-  #   >> Bond.complete(:method=>'FileUtils.chown') {|e|
+  #   >> Bond.complete(:method => 'FileUtils.chown') {|e|
   #        e.argument > 3 ? %w{noop verbose} : %w{root admin me} }
   #   => true
   #   >> FileUtils.chown 'r[TAB]
@@ -42,7 +42,7 @@ module Bond
   #   >> FileUtils.chown 'root', 'admin'
   #   >> FileUtils.chown 'root', 'admin', 'some_file', :v[TAB]
   #   >> FileUtils.chown 'root', 'admin', 'some_file', :verbose
-  #   >> FileUtils.chown 'root', 'admin', 'some_file', :verbose=>true
+  #   >> FileUtils.chown 'root', 'admin', 'some_file', :verbose => true
   #
   # ==== Developer Notes
   # Unlike other missions, creating these missions with Bond.complete doesn't add more completion rules
@@ -183,8 +183,8 @@ module Bond
   def after_match(input)
     set_action_and_search
     @completion_prefix, typed = @matched[3], @matched[-1]
-    input_options = {:object=>@evaled_object, :argument=>1+typed.count(','),
-      :arguments=>(@completion_prefix.to_s+typed).split(/\s*,\s*/) }
+    input_options = {:object => @evaled_object, :argument => 1+typed.count(','),
+      :arguments => (@completion_prefix.to_s+typed).split(/\s*,\s*/) }
     if typed.to_s.include?(',') && (match = typed.match(/(.*?\s*)([^,]*)$/))
       typed = match[2]
       typed.sub!(/^(['":])/,'')
@@ -194,4 +194,4 @@ module Bond
   end
 
   end
-end
+end

data/lib/bond/missions/object_mission.rb

@@ -1,14 +1,14 @@
-# A mission which completes an object's methods. For this mission to match,
-# the condition must match and the current object must have an ancestor that matches :object.
-# Note: To access to the current object being completed on within an action, use the input's
-# object attribute.
+# A mission which completes an object's methods. For this mission to match, the
+# condition must match and the current object must have an ancestor that matches
+# :object.  Note: To access to the current object being completed on within an
+# action, use the input's object attribute.
 #
 # ==== Bond.complete Options:
-# [:action] If an action is not specified, the default action is to complete an object's
-#             non-operator methods.
+# [:action] If an action is not specified, the default action is to complete an
+#           object's non-operator methods.
 #
 # ===== Example:
-#   Bond.complete(:object=>'ActiveRecord::Base') {|input| input.object.class.instance_methods(false) }
+#   Bond.complete(:object => 'ActiveRecord::Base') {|input| input.object.class.instance_methods(false) }
 class Bond::ObjectMission < Bond::Mission
   OBJECTS = %w<\S+> + Bond::Mission::OBJECTS
   CONDITION = '(OBJECTS)\.(\w*(?:\?|!)?)$'
@@ -35,10 +35,10 @@ class Bond::ObjectMission < Bond::Mission
   def after_match(input)
     @completion_prefix = @matched[1] + "."
     @action ||= lambda {|e| default_action(e.object) }
-    create_input @matched[2], :object=>@evaled_object
+    create_input @matched[2], :object => @evaled_object
   end
 
   def default_action(obj)
     obj.methods.map {|e| e.to_s} - OPERATORS
   end
-end
+end

data/lib/bond/missions/operator_method_mission.rb

@@ -1,7 +1,9 @@
 module Bond
-  # A mission which completes arguments for any module/class method that is an operator i.e. '>' or '*'.
-  # Takes same Bond.complete options as MethodMission. The only operator method this mission doesn't
-  # complete is '[]='. The operator '[]' should cover the first argument completion of '[]=' anyways.
+  # A mission which completes arguments for any module/class method that is an
+  # operator i.e. '>' or '*'.  Takes same Bond.complete options as
+  # MethodMission. The only operator method this mission doesn't complete is
+  # '[]='. The operator '[]' should cover the first argument completion of '[]='
+  # anyways.
   class OperatorMethodMission < MethodMission
     OPERATORS = Mission::OPERATORS - ["[]", "[]="]
     OBJECTS = Mission::OBJECTS + %w{\S+}
@@ -19,7 +21,7 @@ module Bond
     def after_match(input)
       set_action_and_search
       @completion_prefix, typed = input.to_s.sub(/#{Regexp.quote(@matched[-1])}$/, ''), @matched[-1]
-      create_input typed, :object=>@evaled_object, :argument=>1
+      create_input typed, :object => @evaled_object, :argument => 1
     end
   end
-end
+end

data/lib/bond/rc.rb

@@ -4,13 +4,13 @@ module Bond
   #
   # === Example ~/.bondrc
   #   # complete arguments for any object's :respond_to?
-  #   complete(:method=>"Object#respond_to?") {|e| e.object.methods }
+  #   complete(:method => "Object#respond_to?") {|e| e.object.methods }
   #   # complete arguments for any module's :public
-  #   complete(:method=>"Module#public") {|e| e.object.instance_methods }
+  #   complete(:method => "Module#public") {|e| e.object.instance_methods }
   #
   #   # Share generate_tags action across completions
-  #   complete(:method=>"edit_tags", :action=>:generate_tags)
-  #   complete(:method=>"delete_tags", :search=>false) {|e| generate_tags(e).grep(/#{e}/i) }
+  #   complete(:method => "edit_tags", :action => :generate_tags)
+  #   complete(:method => "delete_tags", :search => false) {|e| generate_tags(e).grep(/#{e}/i) }
   #
   #   def generate_tags(input)
   #    ...
@@ -45,4 +45,4 @@ module Bond
       raise if Bond.config[:debug]
     end
   end
-end
+end

data/lib/bond/readline.rb

@@ -1,48 +1,38 @@
-module Bond
-  # This is the default readline plugin for Bond. A valid plugin must be a module that defines methods setup
-  # and line_buffer as described below.
-  module Readline
-    DefaultBreakCharacters = " \t\n\"\\'`><=;|&{("
+# This is the default readline plugin for Bond. A valid plugin must be an object
+# that responds to methods setup and line_buffer as described below.
+class Bond::Readline
+  DefaultBreakCharacters = " \t\n\"\\'`><=;|&{("
 
-    # Loads the readline-like library and sets the completion_proc to the given agent.
-    def setup(agent)
-      require 'readline'
-      unless ::Readline.respond_to?(:line_buffer)
-        RUBY_PLATFORM =~ /java/ ? load_jruby_extension : load_extension
-      end
+  # Loads the readline-like library and sets the completion_proc to the given agent.
+  def self.setup(agent)
+    readline_setup
 
-      # Reinforcing irb defaults
-      ::Readline.completion_append_character = nil
-      if ::Readline.respond_to?("basic_word_break_characters=")
-        ::Readline.basic_word_break_characters = DefaultBreakCharacters
-      end
-
-      ::Readline.completion_proc = agent
-      if (::Readline::VERSION rescue nil).to_s[/editline/i]
-        puts "Bond has detected EditLine and may not work with it. See the README's Limitations section."
-      end
+    # Reinforcing irb defaults
+    Readline.completion_append_character = nil
+    if Readline.respond_to?("basic_word_break_characters=")
+      Readline.basic_word_break_characters = DefaultBreakCharacters
     end
 
-    def load_jruby_extension
-      require 'jruby'
+    Readline.completion_proc = agent
+  end
 
-      class << Readline
-        ReadlineExt = org.jruby.ext.Readline
-        def line_buffer
-          ReadlineExt.s_get_line_buffer(JRuby.runtime.current_context, JRuby.reference(self))
-        end
-      end
+  def self.readline_setup
+    require 'readline'
+    load_extension unless Readline.respond_to?(:line_buffer)
+    if (Readline::VERSION rescue nil).to_s[/editline/i]
+      puts "Bond has detected EditLine and may not work with it." +
+        " See the README's Limitations section."
     end
+  end
 
-    def load_extension
-      require 'readline_line_buffer'
-    rescue LoadError
-      $stderr.puts "Bond Error: Failed to load readline_line_buffer. Ensure that it exists and was built correctly."
-    end
+  def self.load_extension
+    require 'readline_line_buffer'
+  rescue LoadError
+    $stderr.puts "Bond Error: Failed to load readline_line_buffer. Ensure that it exists and was built correctly."
+  end
 
-    # Returns full line of what the user has typed.
-    def line_buffer
-      ::Readline.line_buffer
-    end
+  # Returns full line of what the user has typed.
+  def self.line_buffer
+    Readline.line_buffer
   end
 end

data/lib/bond/readlines/jruby.rb

@@ -0,0 +1,13 @@
+# Readline for Jruby
+class Bond::Jruby < Bond::Readline
+  def self.readline_setup
+    require 'readline'
+    require 'jruby'
+    class << Readline
+      ReadlineExt = org.jruby.ext.Readline
+      def line_buffer
+        ReadlineExt.s_get_line_buffer(JRuby.runtime.current_context, JRuby.reference(self))
+      end
+    end
+  end
+end

data/lib/bond/readlines/rawline.rb

@@ -0,0 +1,15 @@
+# A pure ruby readline which requires {rawline}[http://github.com/h3rald/rawline].
+class Bond::Rawline < Bond::Readline
+  def self.setup(agent)
+    require 'rawline'
+    Rawline.completion_append_character = nil
+    Rawline.basic_word_break_characters= " \t\n\"\\'`><;|&{("
+    Rawline.completion_proc = agent
+  rescue LoadError
+    abort "Bond Error: rawline gem is required for this readline plugin -> gem install rawline"
+  end
+
+  def self.line_buffer
+    Rawline.editor.line.text
+  end
+end

data/lib/bond/readlines/ruby.rb

@@ -0,0 +1,9 @@
+# A pure ruby readline which requires {rb-readline}[https://github.com/luislavena/rb-readline].
+class Bond::Ruby < Bond::Readline
+  def self.readline_setup
+    require 'rb-readline'
+  rescue LoadError
+    abort "Bond Error: rb-readline gem is required for this readline plugin" +
+      " -> gem install rb-readline"
+  end
+end

data/lib/bond/search.rb

@@ -10,7 +10,7 @@ module Bond
   #     normal_search(input, list.select {|e| e !~ /-/ })
   #   end
   #
-  # Now you can pass this custom search to any complete() as :search=>:ignore_hyphen
+  # Now you can pass this custom search to any complete() as :search => :ignore_hyphen
   module Search
     class<<self
       # Default search used across missions, set by Bond.config[:default_search]
@@ -71,4 +71,4 @@ module Bond
       (current_matches + future_matches.map {|e| e[/^(([^#{delim_chars}]*#{delim}){0,#{i+1}})/, 1] }).uniq
     end
   end
-end
+end

data/lib/bond/version.rb

@@ -1,3 +1,3 @@
 module Bond
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

data/test/agent_test.rb

@@ -210,7 +210,8 @@ describe "Agent" do
 
   describe "spy" do
     before_all {
-      M.reset; complete(:on=>/end$/) { [] };
+      reset
+      complete(:on=>/end$/) { [] };
       complete(:all_methods=>true); complete(:method=>'the') { %w{spy who loved me} }
       complete(:object=>"Symbol")
     }

data/test/bond_test.rb

@@ -3,22 +3,31 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 describe "Bond" do
   describe "start" do
     def start(options={}, &block)
-      Bond.start({:readline_plugin=>valid_readline_plugin}.merge(options), &block)
+      Bond.start({:readline=>valid_readline}.merge(options), &block)
     end
 
     before { M.instance_eval("@started = @agent = @config = nil"); M.expects(:load_completions) }
-    it "prints error if readline_plugin is not a module" do
-      capture_stderr { start :readline_plugin=>false }.should =~ /Invalid/
+    it "prints error if readline doesn't have all required methods" do
+      capture_stderr {
+        start :readline=>Module.new{ def self.setup(arg); end }
+      }.should =~ /Invalid/
     end
-    
-    it "prints error if readline_plugin doesn't have all required methods" do
-      capture_stderr {start :readline_plugin=>Module.new{ def setup(arg); end } }.should =~ /Invalid/
+
+    it "prints error if readline symbol is invalid" do
+      capture_stderr {
+        start :readline => :blah
+      }.should =~ /Invalid.*'blah'/
     end
 
-    it "prints no error if valid readline_plugin" do
+    it "prints no error if valid readline" do
       capture_stderr { start }.should == ''
     end
 
+    it 'prints no error if valid readline symbol' do
+      capture_stderr { start :readline => :ruby }.should == ''
+      Bond.config[:readline].should == Bond::Ruby
+    end
+
     it "sets default mission" do
       start :default_mission=>lambda {|e| %w{1 2 3}}
       tab('1').should == ['1']
@@ -48,7 +57,7 @@ describe "Bond" do
       Bond.started?.should == true
     end
 
-    after_all { M.debrief :readline_plugin=>valid_readline_plugin; M.reset }
+    after_all { reset }
   end
 
   describe "start with :gems" do
@@ -88,13 +97,13 @@ describe "Bond" do
       M.expects(:gem)
       start(:gems=>%w{awesome})
     end
-    after_all { M.debrief :readline_plugin=>valid_readline_plugin; M.reset }
+    after_all { reset }
   end
 
   it "prints error if Readline setup fails" do
     Bond::Readline.expects(:setup).raises('WTF')
-    capture_stderr { Bond.start(:readline_plugin=>Bond::Readline) }.should =~ /Error.*Failed Readline.*'WTF'/
-    M.debrief :readline_plugin=>valid_readline_plugin
+    capture_stderr { Bond.start(:readline=>Bond::Readline) }.should =~ /Error.*Failed Readline.*'WTF'/
+    M.debrief :readline=>valid_readline
   end
 
   it "start prints error for failed completion file" do
@@ -105,19 +114,19 @@ describe "Bond" do
   it "reset clears existing missions" do
     complete(:on=>/blah/) {[]}
     Bond.agent.missions.size.should.not == 0
-    M.reset
+    reset
     Bond.agent.missions.size.should == 0
   end
 
   describe "restart" do
     def start(options={}, &block)
-      Bond.start({:readline_plugin=>valid_readline_plugin}.merge(options), &block)
+      Bond.start({:readline=>valid_readline}.merge(options), &block)
     end
 
     it "deletes previous config" do
       start :blah=>''
       Bond.config[:blah].should.not == nil
-      Bond.restart({:readline_plugin=>valid_readline_plugin})
+      Bond.restart({:readline=>valid_readline})
       Bond.config[:blah].should == nil
     end
 
@@ -125,7 +134,7 @@ describe "Bond" do
       start
       complete(:method=>'blah') { [] }
       MethodMission.actions['blah'].should.not == nil
-      Bond.restart({:readline_plugin=>valid_readline_plugin})
+      Bond.restart({:readline=>valid_readline})
       MethodMission.actions['blah'].should == nil
     end
   end

data/test/completion_test.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe "Completion" do
   before_all {
-    M.reset
+    reset
     M.load_file File.dirname(__FILE__) + '/../lib/bond/completion.rb'
     M.load_dir File.dirname(__FILE__) + '/../lib/bond'
   }
@@ -48,7 +48,7 @@ describe "Completion" do
   end
 
   it "completes hash coming from a method" do
-    tab('Bond.config[:r').should == ["Bond.config[:readline_plugin"]
+    tab('Bond.config[:r').should == ["Bond.config[:readline"]
   end
 
   it "methods don't swallow up default completion" do

data/test/completions_test.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe "completions for" do
   before_all {
-    M.reset
+    reset
     complete(:all_methods=>true)
     complete(:all_operator_methods=>true)
     M.load_file File.dirname(__FILE__) + '/../lib/bond/completion.rb'

data/test/test_helper.rb

@@ -15,7 +15,7 @@ module TestHelpers
           module InputCompletor; CompletionProc = lambda {|e| [] }; end
         end
       ]
-      ::IRB.CurrentContext = stub(:workspace=>stub(:binding=>binding))
+      ::IRB.CurrentContext = stub(:workspace => stub(:binding => binding))
     end
   end
 
@@ -50,8 +50,13 @@ module TestHelpers
     Bond.complete(*args, &block)
   end
 
-  def valid_readline_plugin
-    Module.new{ def setup(arg); end; def line_buffer; end }
+  def valid_readline
+    Class.new { def self.setup(arg); end; def self.line_buffer; end }
+  end
+
+  def reset
+    M.reset
+    M.debrief :readline => TestHelpers.valid_readline
   end
 end
 
@@ -60,5 +65,5 @@ class Bacon::Context
 end
 
 # Default settings
-Bond::M.debrief(:readline_plugin=>TestHelpers.valid_readline_plugin, :debug=>true)
+Bond::M.debrief(:readline => TestHelpers.valid_readline, :debug => true)
 include Bond

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bond
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 5
-  version: 0.3.5
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-07 00:00:00 -05:00
+date: 2011-01-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,7 +78,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: Bond is on a mission to improve autocompletion in ruby, especially for ripl/irb. Aside from doing everything irb's can do and fixing its quirks, Bond can autocomplete argument(s) to methods, uniquely completing per module, per method and per argument. Bond brings irb's completion closer to bash/zsh as it provides a configuration system and a DSL for creating custom completions and completion rules. With this configuration system, users can customize their irb autocompletions and share it with others. Bond can also load completions that ship with gems.  Bond is able to offer more than irb's completion since it uses a Readline C extension to get the full line of input when completing as opposed to irb's last-word approach.
+description: Bond is on a mission to improve autocompletion in ruby, especially for irb/ripl. Aside from doing everything irb's can do and fixing its quirks, Bond can autocomplete argument(s) to methods, uniquely completing per module, per method and per argument. Bond brings ruby autocompletion closer to bash/zsh as it provides a configuration system and a DSL for creating custom completions and completion rules. With this configuration system, users can customize their autocompletions and share it with others. Bond can also load completions that ship with gems.  Bond is able to offer more than irb's completion since it uses the full line of input when completing as opposed to irb's last-word approach.
 email: gabriel.horner@gmail.com
 executables: []
 
@@ -106,9 +106,11 @@ files:
 - lib/bond/missions/method_mission.rb
 - lib/bond/missions/object_mission.rb
 - lib/bond/missions/operator_method_mission.rb
-- lib/bond/rawline.rb
 - lib/bond/rc.rb
 - lib/bond/readline.rb
+- lib/bond/readlines/jruby.rb
+- lib/bond/readlines/rawline.rb
+- lib/bond/readlines/ruby.rb
 - lib/bond/search.rb
 - lib/bond/version.rb
 - lib/bond.rb
@@ -132,14 +134,14 @@ files:
 - test/deps.rip
 - Rakefile
 - .gemspec
-has_rdoc: yard
+has_rdoc: true
 homepage: http://tagaholic.me/bond/
 licenses: 
 - MIT
 post_install_message: 
 rdoc_options: 
 - --title
-- Bond 0.3.5 Documentation
+- Bond 0.4.0 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/lib/bond/rawline.rb

@@ -1,16 +0,0 @@
-module Bond
-  # A readline plugin for use with {Rawline}[http://github.com/h3rald/rawline]. This plugin
-  # should be used in conjunction with {a Rawline shell}[http://www.h3rald.com/articles/real-world-rawline-usage].
-  module Rawline
-    def setup(agent)
-      require 'rawline'
-      ::Rawline.completion_append_character = nil
-      ::Rawline.basic_word_break_characters= " \t\n\"\\'`><;|&{(" 
-      ::Rawline.completion_proc = agent
-    end
-
-    def line_buffer
-      ::Rawline.editor.line.text
-    end
-  end
-end