bond 0.2.1 → 0.2.2

data/{gemspec → .gemspec}

@@ -12,10 +12,15 @@ Gem::Specification.new do |s|
   s.description = "Bond is on a mission to improve irb’s autocompletion. 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 generate completions from yard documentation and 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.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = 'tagaholic'
-  s.add_development_dependency 'bacon'
-  s.add_development_dependency 'mocha'
+  s.has_rdoc = 'yard'
+  s.rdoc_options = ['--title', "Bond #{Bond::VERSION} Documentation"]
+  s.add_development_dependency 'bacon', '>= 1.1.0'
+  s.add_development_dependency 'mocha', '>= 0.9.8'
   s.add_development_dependency 'mocha-on-bacon'
-  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c}]) + %w{Rakefile gemspec}
+  s.add_development_dependency 'bacon-bits'
+  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c}]) + %w{Rakefile .gemspec}
+  s.files += Dir.glob('**/*.rip')
   s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
-  s.extensions = RUBY_VERSION < '1.9.2' ? ["ext/readline_line_buffer/extconf.rb"] : []
-end
+  s.extensions = ["ext/readline_line_buffer/extconf.rb"]
+  s.license = 'MIT'
+end

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 0.2.2
+* Moved documentation to yard.
+* Better extconf.rb thanks to @timcharper
+* Better error when failing to require extension.
+
 == 0.2.1
 * Added Bond.load_yard_gems which generates argument completions from yard documentation.
 * Added Bond.load_gems which loads completions from gem's directory.

data/README.rdoc

@@ -206,6 +206,7 @@ has good instructions for reinstalling ruby with the official Readline.
 * Csaba Hank for {providing the C extension}[http://www.creo.hu/~csaba/ruby/irb-enhancements/doc/files/README.html] which Bond uses to read Readline's full buffer.
 * Takao Kouji for {commiting}[http://svn.ruby-lang.org/cgi-bin/viewvc.cgi/trunk/ext/readline/readline.c?view=diff&r1=24018&r2=24019] this Readline enhancement to ruby 1.9.2.
 * pd for compatibility with emacs' inf-ruby mode.
+* timcharper for improving extconf.rb.
 
 == Links
 * http://tagaholic.me/2010/05/07/screencast-of-argument-autocompletion-for-methods-in-irb.html

data/Rakefile

@@ -2,12 +2,12 @@ require 'rake'
 require 'fileutils'
 
 def gemspec
-  @gemspec ||= eval(File.read('gemspec'), binding, 'gemspec')
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
 end
 
 desc "Build the gem"
 task :gem=>:gemspec do
-  sh "gem build gemspec"
+  sh "gem build .gemspec"
   FileUtils.mkdir_p 'pkg'
   FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
 end
@@ -32,4 +32,4 @@ task :test do |t|
   sh 'bacon -q -Ilib -I. test/*_test.rb'
 end
 
-task :default => :test
+task :default => :test

data/ext/readline_line_buffer/extconf.rb

@@ -1,4 +1,19 @@
 require "mkmf"
-have_header 'readline/readline.h'
-dir_config 'readline_line_buffer'
-create_makefile 'readline_line_buffer'
+
+if RUBY_VERSION < '1.9.2'
+  dir_config("readline")
+  unless have_header('readline/readline.h')
+    $stderr.puts "-" * 80
+    $stderr.puts "Error! Cannot find readline/readline.h."
+    $stderr.puts "Readline was probably installed in a non-standard directory.",
+      "Try `gem install bond -- --with-readline-dir=/path/to/readline`."
+    $stderr.puts "-" * 80
+    exit 1
+  end
+  create_makefile 'readline_line_buffer'
+else
+  # Create dummy Makefile to placate rubygems when running `make install`.
+  File.open(File.join(File.dirname(__FILE__), "Makefile"), "w") {|f|
+    f.puts %[install:\n\techo "This is a dummy extension"]
+  }
+end

data/lib/bond.rb

@@ -17,38 +17,50 @@ require 'bond/yard'
 module Bond
   extend self
 
-  # Defines a completion rule (Mission). A valid Mission consists of a condition and an action. A
+  # Creates a completion rule (Mission). A valid Mission consists of a condition and an action. A
   # condition is specified with one of the following options: :on, :object, :anywhere or :method(s). Each
-  # of these options creates a different Mission class. An action is either this method's block or :action.
+  # of these options creates a different Mission class. An action is either the method's block or :action.
   # An action takes what the user has typed (Input) and returns an array of possible completions. Bond
   # searches these completions and returns matching completions. This searching behavior can be configured
   # or turned off per mission with :search. If turned off, the action must also handle searching.
-  # ====Options:
-  # [*:on*] Regular expression which matches the full line of input to create a Mission object.
-  # [*:method*, *:methods*, *:class*] See MethodMission.
-  # [*:anywhere*, *:prefix*] See AnywhereMission.
-  # [*:object*] See ObjectMission.
-  # [*:search*] A symbol or false which determines how completions are searched. Defaults to
-  #             Search.default_search. If false, search is turned off and assumed to be done in the action.
-  #             Possible symbols are :anywhere, :ignore_case, :underscore, :normal, :files and :modules.
-  #             See Search for more info.
-  # [*:action*] Rc method name that takes an Input and returns possible completions. See MethodMission for
-  #             specific behavior with :method(s).
-  # [*:place*] A number or :last which indicates where a mission is inserted amongst existing missions.
-  #            If the symbol :last, places the mission at the end regardless of missions defined after
-  #            it. Multiple declarations of :last are kept last in the order they are defined.
-  # [*:name*] A symbol or string that serves a unique id for a mission. This unique id can be passed by
-  #           Bond.recomplete to identify and replace the mission.
+  #
   # ==== 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)
+  #
+  # @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.
+  # @option options [Regexp] :on Matches the full line of input to create a {Mission} object.
+  # @option options [String] :method An instance (Class#method) or class method (Class.method). Creates
+  #   {MethodMission} object. A method's class can be set by :class or detected automatically if '#' or '.' is
+  #   present. If no class is detected, 'Kernel#' is assumed.
+  # @option options [Array<String>] :methods Instance or class method(s) in the format of :method. Creates
+  #   {MethodMission} objects.
+  # @option options [String] :class Optionally used with :method or :methods to represent module/class.
+  #   Must end in '#' or '.' to indicate instance/class method. Suggested for use with :methods.
+  # @option options [String] :object Module or class of an object whose methods are completed. Creates
+  #   {ObjectMission} object.
+  # @option options [String] :anywhere String representing a regular expression to match a mission. Creates
+  #   {AnywhereMission} object.
+  # @option options [String] :prefix Optional string to prefix :anywhere.
+  # @option options [Symbol,false] :search Determines how completions are searched. Defaults to
+  #   Search.default_search. If false, search is turned off and assumed to be done in the action.
+  #   Possible symbols are :anywhere, :ignore_case, :underscore, :normal, :files and :modules.
+  #   See {Search} for more info.
+  # @option options [String,Symbol] :action Rc method name that takes an Input and returns possible completions.
+  #   See {MethodMission} for specific behavior with :method(s).
+  # @option options [Integer,:last] :place Indicates where a mission is inserted amongst existing
+  #   missions. If the symbol :last, places the mission at the end regardless of missions defined
+  #   after it. Multiple declarations of :last are kept last in the order they are defined.
+  # @option options [Symbol,String] :name Unique id for a mission which can be passed by
+  #   Bond.recomplete to identify and replace the mission.
   def complete(options={}, &block); M.complete(options, &block); end
 
   # 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 Bond.complete.
+  # used to identify and replace a mission. Takes same options as {#complete}.
   # ==== Example:
   #   Bond.recomplete(:on=>/man/, :name=>:count) { %w{4 5 6}}
   def recomplete(options={}, &block); M.recomplete(options, &block); end
@@ -60,41 +72,45 @@ module Bond
   #   Possible completions: ["octopussy"]
   def spy(*args); M.spy(*args); end
 
-  # Global config with the following keys:
-  # [*:readline_plugin*] Specifies a Bond plugin to interface with a Readline-like library. Available
-  #                      plugins are Readline and Rawline. Defaults to Readline.
-  # [*:default_mission*] A proc or name of an Rc method to use as the default completion when no
-  #                      missions match.
-  # [*:default_search*] Name of a *_search method in Rc to use as the default search in completions.
-  #                     Default is :underscore. See Bond.complete's :search option for valid values.
-  # [*:eval_binding*] Specifies a binding to use when evaluating objects in ObjectMission and MethodMission.
-  #                   When in irb, defaults to irb's current binding. Otherwise defaults to TOPLEVEL_BINDING.
-  # [*:debug*]  Boolean to show the stacktrace when autocompletion fails and raise exceptions in Rc.eval.
-  #             Default is false.
-  # [*:eval_debug*] Boolean to raise eval errors occuring when finding a matching completion. Useful to debug
-  #                 an incorrect completion. Default is false.
+  # @return [Hash] Global config
   def config; M.config; end
 
   # Starts Bond with a default set of completions that replace and improve irb's completion. Loads completions
   # in this order: lib/bond/completion.rb, lib/bond/completions/*.rb and the following optional completions:
   # completions from :gems, completions from :yard_gems, ~/.bondrc, ~/.bond/completions/*.rb and from block. See
-  # Rc for the DSL to use in completion files and in the block. Valid options are Bond.config keys and the following:
-  # [*:gems*] Array of gems which have their completions loaded from lib/bond/completions/*.rb.
-  # [*:yard_gems*] Array of gems using yard documentation to generate completions. See Yard.
+  # {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 }
   #   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.
+  # @option options [Array<String>] :yard_gems Gems using yard documentation to generate completions. See {Yard}.
+  # @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 [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
+  #   search in completions. See {#complete}'s :search option for valid values.
+  # @option options [Binding] :eval_binding (TOPLEVEL_BINDING) Binding to use when evaluating objects in
+  #   ObjectMission and MethodMission. When in irb, defaults to irb's current binding.
+  # @option options [Boolean] :debug (false) Shows the stacktrace when autocompletion fails and raises exceptions
+  #   in Rc.eval.
+  # @option options [Boolean] :eval_debug (false) Raises eval errors occuring when finding a matching completion.
+  #   Useful to debug an incorrect completion.
   def start(options={}, &block); M.start(options, &block); end
 
   # Loads completions for gems that ship with them under lib/bond/completions/, relative to the gem's base directory.
   def load_gems(*gems); M.load_gems(*gems); end
 
   # Generates and loads completions for yardoc documented gems.
-  # ==== Options:
-  # [*:verbose*] Boolean which displays additional information when building yardoc. Default is false.
-  # [*:reload*] Rebuilds yard databases. Use when gems have changed versions. Default is false.
+  # @param *gems Gem(s) with optional options hash at the end
+  # @option *gems :verbose[Boolean] (false) Displays additional information when building yardoc.
+  # @option *gems :reload[Boolean] (false) Rebuilds yard databases. Use when gems have changed versions.
   def load_yard_gems(*gems); Yard.load_yard_gems(*gems); end
 
   # An Agent who saves all Bond.complete missions and executes the correct one when a completion is called.

data/lib/bond/agent.rb

@@ -7,7 +7,7 @@ module Bond
     # An agent's best friend a.k.a. the readline plugin.
     attr_reader :weapon
 
-    def initialize(options={}) #:nodoc:
+    def initialize(options={}) #@private
       setup_readline_plugin(options[:readline_plugin])
       @default_mission_action = options[:default_mission] if options[:default_mission]
       Mission.eval_binding = options[:eval_binding] if options[:eval_binding]
@@ -15,14 +15,6 @@ module Bond
       @missions = []
     end
 
-    def setup_readline_plugin(plugin) #:nodoc:
-      raise ArgumentError unless plugin.is_a?(Module)
-      @weapon = plugin.extend(plugin)
-      @weapon.setup(self)
-    rescue
-      $stderr.puts "Bond Error: Failed #{plugin.to_s[/[^:]+$/]} setup with '#{$!.message}'"
-    end
-
     # Creates a mission.
     def complete(options={}, &block)
       if (mission = create_mission(options, &block)).is_a?(Mission)
@@ -32,14 +24,6 @@ module Bond
       mission
     end
 
-    def create_mission(options, &block) #:nodoc:
-      Mission.create options.merge!(:action=>options[:action] || block)
-    rescue InvalidMissionError
-      "Invalid #{$!.message} for completion with options: #{options.inspect}"
-    rescue
-      "Unexpected error while creating completion with options #{options.inspect} and message:\n#{$!}"
-    end
-
     # Creates a mission and replaces the mission it matches if possible.
     def recomplete(options={}, &block)
       if (mission = create_mission(options, &block)).is_a?(Mission)
@@ -53,14 +37,6 @@ module Bond
       mission
     end
 
-    def sort_last_missions #:nodoc:
-      @missions.replace @missions.partition {|e| e.place != :last }.flatten
-    end
-
-    def reset #:nodoc:
-      @missions = []
-    end
-
     # 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)
@@ -74,12 +50,6 @@ module Bond
         "Please report this issue with debug on: Bond.config[:debug] = true."
     end
 
-    def completion_error(desc, message) #:nodoc:
-      arr = ["Bond Error: #{desc}", message]
-      arr << "Stack Trace: #{$!.backtrace.inspect}" if Bond.config[:debug]
-      arr
-    end
-
     # Given a hypothetical user input, reports back what mission it would have found and executed.
     def spy(input)
       if (mission = find_mission(input))
@@ -93,7 +63,7 @@ module Bond
         "Matches for #{e.mission.condition.inspect} are #{e.mission.matched.to_a.inspect}"
     end
 
-    def find_mission(input) #:nodoc:
+    def find_mission(input) #@private
       @missions.find {|mission| mission.matches?(input) }
     end
 
@@ -101,5 +71,37 @@ module Bond
     def default_mission
       @default_mission ||= DefaultMission.new(:action=>@default_mission_action)
     end
+
+    # Resets an agent's missions
+    def reset
+      @missions = []
+    end
+
+    protected
+    def setup_readline_plugin(plugin)
+      raise ArgumentError unless plugin.is_a?(Module)
+      @weapon = plugin.extend(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)
+    rescue InvalidMissionError
+      "Invalid #{$!.message} for completion with options: #{options.inspect}"
+    rescue
+      "Unexpected error while creating completion with options #{options.inspect} and message:\n#{$!}"
+    end
+
+    def sort_last_missions
+      @missions.replace @missions.partition {|e| e.place != :last }.flatten
+    end
+
+    def completion_error(desc, message)
+      arr = ["Bond Error: #{desc}", message]
+      arr << "Stack Trace: #{$!.backtrace.inspect}" if Bond.config[:debug]
+      arr
+    end
   end
 end

data/lib/bond/completions/bond.rb

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

data/lib/bond/input.rb

@@ -11,7 +11,7 @@ module Bond
     attr_accessor :argument, :arguments
     # The full line the user has typed.
     attr_reader :line
-    def initialize(str, options={}) #:nodoc:
+    def initialize(str, options={}) #@private
       super(str || '')
       @matched = options[:matched]
       @line = options[:line]
@@ -20,7 +20,7 @@ module Bond
       @arguments = options[:arguments] if options[:arguments]
     end
 
-    def inspect #:nodoc:
+    def inspect #@private
       "#<Bond::Input #{self.to_s.inspect} @matched=#{@matched.to_a.inspect} @line=#{@line.inspect} "+
       "@argument=#{@argument.inspect} @arguments=#{@arguments.inspect} @object=#{@object.inspect}>"
     end

data/lib/bond/m.rb

@@ -3,7 +3,7 @@ module Bond
   module M
     extend self
 
-    # See Bond.complete
+    # See {Bond#complete}
     def complete(options={}, &block)
       if (result = agent.complete(options, &block)).is_a?(String)
         $stderr.puts "Bond Error: "+result
@@ -13,7 +13,7 @@ module Bond
       end
     end
 
-    # See Bond.recomplete
+    # See {Bond#recomplete}
     def recomplete(options={}, &block)
       if (result = agent.recomplete(options, &block)).is_a?(String)
         $stderr.puts "Bond Error: "+result
@@ -23,12 +23,12 @@ module Bond
       end
     end
 
-    # See Bond.agent
+    # See {Bond#agent}
     def agent
       @agent ||= Agent.new(config)
     end
 
-    # See Bond.config
+    # See {Bond#config}
     def config
       @config ||= {:readline_plugin=>Bond::Readline, :debug=>false, :default_search=>:underscore}
     end
@@ -39,7 +39,7 @@ module Bond
       @agent = nil
     end
 
-    # See Bond.spy
+    # See {Bond#spy}
     def spy(input)
       agent.spy(input)
     end
@@ -54,7 +54,7 @@ module Bond
       end
     end
 
-    # See Bond.start
+    # See {Bond#start}
     def start(options={}, &block)
       debrief options
       load_completions
@@ -62,30 +62,12 @@ module Bond
       true
     end
 
-    def load_gem_completion(rubygem) #:nodoc:
-      (dir = find_gem_file(rubygem, File.join(rubygem, '..', 'bond'))) ?
-        load_dir(dir) : $stderr.puts("Bond Error: No completions found for gem '#{rubygem}'.")
-    end
-
     # 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)
     end
 
-    def load_gems(*gems) #:nodoc:
-      gems.select {|e| load_gem_completion(e) }
-    end
-
-    def load_completions #:nodoc:
-      load_file File.join(File.dirname(__FILE__), 'completion.rb')
-      load_dir File.dirname(__FILE__)
-      load_gems *config[:gems] if config[:gems]
-      Yard.load_yard_gems *config[:yard_gems] if config[:yard_gems]
-      load_file(File.join(home,'.bondrc')) if File.exists?(File.join(home, '.bondrc'))
-      load_dir File.join(home, '.bond')
-    end
-
     # Loads a completion file in Rc namespace.
     def load_file(file)
       Rc.module_eval File.read(file)
@@ -108,5 +90,24 @@ module Bond
     rescue
       File::ALT_SEPARATOR ? "C:/" : "/"
     end
+
+    protected
+    def load_gem_completion(rubygem)
+      (dir = find_gem_file(rubygem, File.join(rubygem, '..', 'bond'))) ?
+        load_dir(dir) : $stderr.puts("Bond Error: No completions found for gem '#{rubygem}'.")
+    end
+
+    def load_gems(*gems)
+      gems.select {|e| load_gem_completion(e) }
+    end
+
+    def load_completions
+      load_file File.join(File.dirname(__FILE__), 'completion.rb')
+      load_dir File.dirname(__FILE__)
+      load_gems *config[:gems] if config[:gems]
+      Yard.load_yard_gems *config[:yard_gems] if config[:yard_gems]
+      load_file(File.join(home,'.bondrc')) if File.exists?(File.join(home, '.bondrc'))
+      load_dir File.join(home, '.bond')
+    end
   end
 end

data/lib/bond/mission.rb

@@ -5,7 +5,7 @@ module Bond
   class FailedMissionError < StandardError
     # Mission that failed
     attr_reader :mission
-    def initialize(mission); @mission = mission; end #:nodoc:
+    def initialize(mission); @mission = mission; end #@private
   end
 
   # Represents a completion rule, given a condition (:on) on which to match and an action
@@ -30,7 +30,7 @@ module Bond
         eval(string, ebinding)
       end
 
-      def eval_binding #:nodoc:
+      def eval_binding #@private
         @eval_binding || IRB.CurrentContext.workspace.binding rescue ::TOPLEVEL_BINDING
       end
     end
@@ -44,13 +44,13 @@ module Bond
     # Generates array of possible completions and searches them if search is disabled. Any values
     # that aren't strings are automatically converted with to_s.
     attr_reader :action
-    # See Bond.complete's :place.
+    # See {Bond#complete}'s :place.
     attr_reader :place
     # A MatchData object generated from matching the user input with the condition.
     attr_reader :matched
     # Regexp condition
     attr_reader :on
-    # Takes same options as Bond.complete.
+    # Takes same options as {Bond#complete}.
     def initialize(options)
       raise InvalidMissionError, ":action" unless (options[:action] || respond_to?(:default_action))
       raise InvalidMissionError, ":on" unless (options[:on] && options[:on].is_a?(Regexp)) || respond_to?(:default_on)
@@ -126,7 +126,7 @@ module Bond
       create_input(input[/\S+$/])
     end
 
-    #:stopdoc:
+    private
     def condition_with_objects
       self.class.const_get(:CONDITION).sub('OBJECTS', self.class.const_get(:OBJECTS).join('|'))
     end
@@ -150,6 +150,5 @@ module Bond
     def create_input(input, options={})
       @input = Input.new(input, options.merge(:line=>@line, :matched=>@matched))
     end
-    #:startdoc:
   end
 end

data/lib/bond/missions/anywhere_mission.rb

@@ -1,17 +1,13 @@
 # A mission which completes anywhere i.e. even after non word break characters such as '[' or '}'.
-# It generates the following regexp condition /#{prefix}(#{anywhere})$/ and passes the first
-# capture group to the mission action.
-#
-# ==== Bond.complete Options:
-# [*:anywhere*] A regexp string which generates the first capture group in the above regexp.
-# [*:prefix*] An optional string which prefixes the first capture group in the above regexp.
+# 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={}) #:nodoc:
+  def initialize(options={}) #@private
     options[:on] = Regexp.new("#{options[:prefix]}(#{options[:anywhere]})$")
     super
   end
 
-  def after_match(input) #:nodoc:
+  def after_match(input) #@private
     @completion_prefix = input.to_s.sub(/#{Regexp.escape(@matched[1])}$/, '')
     create_input @matched[1]
   end

data/lib/bond/missions/default_mission.rb

@@ -6,13 +6,11 @@ class Bond::DefaultMission < Bond::Mission
     "then", "true", "undef", "unless", "until", "when", "while", "yield"
   ]
 
-  #:stopdoc:
-  def initialize(options={})
+  def initialize(options={}) #@private
     options[:action] ||= method(:default)
     super
   end
-  def default_on; end
-  #:startdoc:
+  def default_on; end #@private
 
   # Default action which generates methods, private methods, reserved words, local variables and constants.
   def default(input)

data/lib/bond/missions/method_mission.rb

@@ -5,24 +5,13 @@ module Bond
   # has two ancestors that have completions for the same method, the ancestor closer to the object is
   # picked. For example, if Array#collect and Enumerable#collect have completions, argument completion on
   # '[].collect ' would use Array#collect.
-  #--
-  # Unlike other missions, creating these missions with Bond.complete doesn't add more completion rules
-  # for an Agent to look through. Instead, all :method(s) completions are handled by one MethodMission
-  # object which looks them up with its own hashes. In the same way, all operator methods are
-  # handled by one OperatorMethodMission object.
-  #++
+  #
   # ==== Bond.complete Options:
-  # [*:method*] String representing an instance (Class#method) or class method (Class.method). Gets
-  #             its class from :class or from substring prefixing '#' or '.'. If no class is given,
-  #             'Kernel#' is assumed.
-  # [*:methods*] Array of instance and/or class methods in the format of :method.
-  # [*:class*] Optional string representing module/class of :method(s). Must end in '#' or '.' to
-  #            indicate instance/class method. Suggested for use with :methods.
-  # [*:action*] If a string, value is assumed to be a :method and that method's action is copied.
-  #             Otherwise defaults to normal :action behavior.
-  # [*:search*] If :action is a :method string, defaults to copying its search.
-  #             Otherwise defaults to normal :search behavior.
-  # [*:name*, *:place*] These options aren't supported by a MethodMission/OperatorMethodMission completion.
+  # [:action] If a string, value is assumed to be a :method and that method's action is copied.
+  #           Otherwise defaults to normal :action behavior.
+  # [:search] If :action is a :method string, defaults to copying its search.
+  #           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 }
@@ -54,6 +43,12 @@ module Bond
   #   >> FileUtils.chown 'root', 'admin', 'some_file', :v[TAB]
   #   >> FileUtils.chown 'root', 'admin', 'some_file', :verbose
   #   >> 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
+  # for an Agent to look through. Instead, all :method(s) completions are handled by one MethodMission
+  # object which looks them up with its own hashes. In the same way, all operator methods are
+  # handled by one OperatorMethodMission object.
   class MethodMission < Bond::Mission
   class<<self
     # Hash of instance method completions which maps methods to hashes of modules to arrays ([action, search])
@@ -97,25 +92,17 @@ module Bond
       @class_actions = {}
     end
 
-    def action_methods #:nodoc:
+    # Lists method names
+    def action_methods
       (actions.keys + class_actions.keys).uniq
     end
 
-    # Lists all methods that have argument completions.
+    # Lists full method names, prefixed with class/module
     def all_methods
       (class_actions.map {|m,h| h.map {|k,v| "#{k}.#{m}" } } +
         actions.map {|m,h| h.map {|k,v| "#{k}##{m}" } }).flatten.sort
     end
 
-    def current_actions(meth) #:nodoc:
-      meth.include?('.') ? @class_actions : @actions
-    end
-
-    def split_method(meth) #:nodoc:
-      meth = "Kernel##{meth}" if !meth.to_s[/[.#]/]
-      meth.split(/[.#]/,2)
-    end
-
     # Returns the first completion by looking up the object's ancestors and finding the closest
     # one that has a completion definition for the given method. Completion is returned
     # as an array containing action proc and optional search to go with it.
@@ -126,16 +113,6 @@ module Bond
       @last_find = last_find ? last_find[1] : last_find
     end
 
-    def find_with(obj, meth, find_meth, actions) #:nodoc:
-      (actions[meth] || {}).select {|k,v| get_class(k) }.
-        sort {|a,b| get_class(a[0]) <=> get_class(b[0]) || -1 }.
-        find {|k,v| obj.send(find_meth, get_class(k)) }
-    end
-
-    def get_class(klass) #:nodoc:
-      (@klasses ||= {})[klass] ||= any_const_get(klass)
-    end
-
     # Returns a constant like Module#const_get no matter what namespace it's nested in.
     # Returns nil if the constant is not found.
     def any_const_get(name)
@@ -146,13 +123,37 @@ module Bond
     rescue
        nil
     end
+
+    protected
+    def current_actions(meth)
+      meth.include?('.') ? @class_actions : @actions
+    end
+
+    def split_method(meth)
+      meth = "Kernel##{meth}" if !meth.to_s[/[.#]/]
+      meth.split(/[.#]/,2)
+    end
+
+    def find_with(obj, meth, find_meth, actions)
+      (actions[meth] || {}).select {|k,v| get_class(k) }.
+        sort {|a,b| get_class(a[0]) <=> get_class(b[0]) || -1 }.
+        find {|k,v| obj.send(find_meth, get_class(k)) }
+    end
+
+    def get_class(klass)
+      (@klasses ||= {})[klass] ||= any_const_get(klass)
+    end
   end
 
   self.reset
   OBJECTS = Mission::OBJECTS + %w{\S*?}
   CONDITION = %q{(OBJECTS)\.?(METHODS)(?:\s+|\()(['":])?(.*)$}
 
-  #:stopdoc:
+  def match_message #@private
+    "Matches completion for method '#{@meth}' in '#{MethodMission.last_class}'."
+  end
+
+  protected
   def do_match(input)
     (@on = default_on) && super && eval_object(@matched[1] ? @matched[1] : 'self') &&
       MethodMission.find(@evaled_object, @meth = matched_method)
@@ -192,9 +193,5 @@ module Bond
     create_input typed, input_options
   end
 
-  def match_message
-    "Matches completion for method '#{@meth}' in '#{MethodMission.last_class}'."
-  end
-  #:startdoc:
   end
 end

data/lib/bond/missions/object_mission.rb

@@ -4,22 +4,25 @@
 # object attribute.
 #
 # ==== Bond.complete Options:
-# [*:object*] String representing a module/class of object whose methods are completed.
-# [*:action*] If an action is not specified, the default action is to complete an object's
+# [: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
-  #:stopdoc:
   OBJECTS = %w<\S+> + Bond::Mission::OBJECTS
   CONDITION = '(OBJECTS)\.(\w*(?:\?|!)?)$'
-  def initialize(options={})
+  def initialize(options={}) #@private
     @object_condition = /^#{options[:object]}$/
     options[:on] ||= Regexp.new condition_with_objects
     super
   end
 
+  def match_message #@private
+    "Matches completion for object with ancestor matching #{@object_condition.inspect}."
+  end
+
+  protected
   def unique_id
     "#{@object_condition.inspect}+#{@on.inspect}"
   end
@@ -38,9 +41,4 @@ class Bond::ObjectMission < Bond::Mission
   def default_action(obj)
     obj.methods.map {|e| e.to_s} - OPERATORS
   end
-
-  def match_message
-    "Matches completion for object with ancestor matching #{@object_condition.inspect}."
-  end
-  #:startdoc:
 end

data/lib/bond/missions/operator_method_mission.rb

@@ -7,7 +7,7 @@ module Bond
     OBJECTS = Mission::OBJECTS + %w{\S+}
     CONDITION = %q{(OBJECTS)\s*(METHODS)\s*(['":])?(.*)$}
 
-    #:stopdoc:
+    protected
     def current_methods
       (OPERATORS & MethodMission.action_methods) + ['[']
     end
@@ -21,6 +21,5 @@ module Bond
       @completion_prefix, typed = input.to_s.sub(/#{Regexp.quote(@matched[-1])}$/, ''), @matched[-1]
       create_input typed, :object=>@evaled_object, :argument=>1
     end
-    #:startdoc:
   end
 end

data/lib/bond/rc.rb

@@ -18,9 +18,9 @@ module Bond
   module Rc
     extend self, Search
 
-    # See Bond.complete
+    # See {Bond#complete}
     def complete(*args, &block); M.complete(*args, &block); end
-    # See Bond.recomplete
+    # See {Bond#recomplete}
     def recomplete(*args, &block); M.recomplete(*args, &block); end
 
     # Action method with search which returns array of files that match current input.

data/lib/bond/readline.rb

@@ -24,24 +24,7 @@ module Bond
     def load_extension
       require 'readline_line_buffer'
     rescue LoadError
-      $stderr.puts "Bond Error: Failed to load readline_line_buffer extension. Falling back on RubyInline extension."
-      require 'inline'
-      eval %[
-        module ::Readline
-          inline do |builder|
-            %w(<errno.h> <stdio.h> <readline/readline.h>).each{|h| builder.include h }
-            builder.c_raw_singleton <<-EOC
-        static VALUE line_buffer(VALUE self)
-        {
-          rb_secure(4);
-          if (rl_line_buffer == NULL)
-        return Qnil;
-          return rb_tainted_str_new2(rl_line_buffer);
-        }
-        EOC
-          end
-        end
-      ]
+      $stderr.puts "Bond Error: Failed to load readline_line_buffer.bundle. Ensure that it exists and was built correctly."
     end
 
     # Returns full line of what the user has typed.

data/lib/bond/search.rb

@@ -37,7 +37,7 @@ module Bond
     # at the beginning of an underscored word. For example, to choose the first completion between 'so_long'
     # and 'so_larger', type 's_lo'.
     def underscore_search(input, list)
-      if input[/_(.+)$/]
+      if input[/_([^_]+)$/]
         regex = input.split('_').map {|e| Regexp.escape(e) }.join("([^_]+)?_")
         list.select {|e| e =~ /^#{regex}/ }
       else

data/lib/bond/version.rb

@@ -1,3 +1,3 @@
 module Bond
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/lib/bond/yard.rb

@@ -4,7 +4,7 @@ module Bond
   module Yard
     extend self
 
-    # :stopdoc:
+    # Loads completions for yard gem(s)
     def load_yard_gems(*gems)
       @options = gems[-1].is_a?(Hash) ? gems.pop : {}
       require 'yard'
@@ -14,6 +14,7 @@ module Bond
       $stderr.puts "Bond Error: yard gem (version >= 0.5.2) not installed "
     end
 
+    protected
     def load_yard_gem(rubygem)
       raise("Unable to find gem.") unless (yardoc = find_yardoc(rubygem))
       completion_file = File.join(dir('yard_completions'), rubygem+'.rb')
@@ -68,6 +69,5 @@ module Bond
         %Q[complete(:method=>'#{meth}') {\n  #{options.inspect}\n}]
       end.join("\n")
     end
-    #:startdoc:
   end
 end

data/test/deps.rip

@@ -0,0 +1,4 @@
+bacon >=1.1.0
+mocha >=0.9.8
+mocha-on-bacon >=0
+bacon-bits >=0

data/test/search_test.rb

@@ -38,6 +38,14 @@ describe "Search" do
     tab("blah i").should == ["include?", "instance_variable_defined?", "include_and_exclude?"]
   end
 
+  it "underscore search autocompletes strings starting with __" do
+    completions = ["include?", "__id__", "__send__"]
+    complete(:on=>/blah/, :search=>:underscore) { completions }
+    tab('blah _').should == ["__id__", "__send__"]
+    tab('blah __').should == ["__id__", "__send__"]
+    tab('blah __i').should == ["__id__"]
+  end
+
   it "underscore search can match first unique strings of each underscored word" do
     completions = %w{so_long so_larger so_louder}
     complete(:on=>/blah/, :search=>:underscore) { completions }

data/test/test_helper.rb

@@ -1,5 +1,5 @@
 require 'bacon'
-require File.dirname(__FILE__)+'/bacon_extensions'
+require 'bacon/bits'
 require 'mocha'
 require 'mocha-on-bacon'
 require 'bond'
@@ -56,9 +56,8 @@ end
 
 class Bacon::Context
   include TestHelpers
-  include BaconExtensions
 end
 
 # Default settings
 Bond::M.debrief(:readline_plugin=>TestHelpers.valid_readline_plugin, :debug=>true)
-include Bond
+include Bond

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bond
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-19 00:00:00 -04:00
+date: 2010-07-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,9 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
+        - 1
+        - 1
         - 0
-        version: "0"
+        version: 1.1.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -38,9 +42,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
-        version: "0"
+        - 9
+        - 8
+        version: 0.9.8
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -51,11 +58,26 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bacon-bits
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: "Bond is on a mission to improve irb\xE2\x80\x99s autocompletion. Aside from doing everything irb\xE2\x80\x99s 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\xE2\x80\x99s 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 generate completions from yard documentation and load completions that ship with gems. Bond is able to offer more than irb\xE2\x80\x99s completion since it uses a Readline C extension to get the full line of input when completing as opposed to irb\xE2\x80\x99s last-word approach."
 email: gabriel.horner@gmail.com
 executables: []
@@ -93,7 +115,6 @@ files:
 - lib/bond.rb
 - test/agent_test.rb
 - test/anywhere_mission_test.rb
-- test/bacon_extensions.rb
 - test/bond_test.rb
 - test/completion_test.rb
 - test/completions_test.rb
@@ -110,14 +131,16 @@ files:
 - ext/readline_line_buffer/extconf.rb
 - ext/readline_line_buffer/readline_line_buffer.c
 - Rakefile
-- gemspec
-has_rdoc: true
+- .gemspec
+- test/deps.rip
+has_rdoc: yard
 homepage: http://tagaholic.me/bond/
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --title
+- Bond 0.2.2 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -125,6 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -133,6 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3

data/test/bacon_extensions.rb

@@ -1,26 +0,0 @@
-module BaconExtensions
-  def self.included(mod)
-    mod.module_eval do
-      # nested context methods automatically inherit methods from parent contexts
-      def describe(*args, &block)
-        context = Bacon::Context.new(args.join(' '), &block)
-        (parent_context = self).methods(false).each {|e|
-          class<<context; self end.send(:define_method, e) {|*args| parent_context.send(e, *args)}
-        }
-        @before.each { |b| context.before(&b) }
-        @after.each { |b| context.after(&b) }
-        context.run
-      end
-    end
-  end
-
-  def xit(*args); end
-  def xdescribe(*args); end
-  def before_all; yield; end
-  def after_all; yield; end
-  def assert(description, &block)
-    it(description) do
-      block.call.should == true
-    end
-  end
-end