bond 0.2.0 → 0.2.1

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== 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.
+* Added compatibility within emacs' inf-ruby mode (thanks to @pd).
+* Added :eval_debug to Bond.config for debugging completions.
+* Doesn't build or load c extension for ruby 1.9.2.
+* Fixed argument completion of object containing method names bug.
+* Fixed nested constants completion bug.
+* Updated completions for Kernel#system, Module#public, Module#protected and Module#private.
+
 == 0.2.0
 * Added comprehensive argument completion per module, method and argument.
 * Added 60+ default method argument completions.

data/README.rdoc

@@ -6,7 +6,8 @@ Bond is on a mission to improve irb's autocompletion. Aside from doing everythin
 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 is able to offer more than irb's completion since it uses a Readline C extension to get the full
+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.
 
 == Install
@@ -202,18 +203,18 @@ If on a Mac and using Editline as a Readline replacement (Readline::VERSION =~ /
 has good instructions for reinstalling ruby with the official Readline.
 
 == Credits
-Thanks to 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. Thanks also goes out to Takao Kouji for {recently
-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.
+* 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.
 
 == Links
+* http://tagaholic.me/2010/05/07/screencast-of-argument-autocompletion-for-methods-in-irb.html
 * http://tagaholic.me/2009/07/16/bond-from-irb-with-completion-love.html
 * http://tagaholic.me/2009/07/22/better-irb-completion-with-bond.html
 * http://tagaholic.me/2009/07/23/mini-irb-and-mini-script-console.html
 
 == Todo
-* Load completions that come with a gem easily.
+* Generate method autocompletions for any arguments based on yardoc documentation.
 * Make completion actions more synonymous with argument types.
 * Cache expensive completion actions.
 * Ensure completions work when there is additional, unrelated text to the right of a completion.

data/Rakefile

@@ -1,41 +1,35 @@
 require 'rake'
-begin
-  require 'rcov/rcovtask'
+require 'fileutils'
 
-  Rcov::RcovTask.new do |t|
-    t.libs << 'test'
-    t.test_files = FileList['test/**/*_test.rb']
-    t.rcov_opts = ["-T -x '/Library/Ruby/*'"]
-    t.verbose = true
-  end
-rescue LoadError
+def gemspec
+  @gemspec ||= eval(File.read('gemspec'), binding, 'gemspec')
 end
 
-begin
-  require 'jeweler'
-  require File.dirname(__FILE__) + "/lib/bond/version"
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
 
-  Jeweler::Tasks.new do |s|
-    s.name = "bond"
-    s.version = Bond::VERSION
-    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 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 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.email = "gabriel.horner@gmail.com"
-    s.homepage = "http://tagaholic.me/bond/"
-    s.authors = ["Gabriel Horner"]
-    s.rubyforge_project = 'tagaholic'
-    s.has_rdoc = true
-    s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
-    s.extensions = ["ext/readline_line_buffer/extconf.rb"]
-    s.files = FileList["CHANGELOG.rdoc", "Rakefile", "README.rdoc", "LICENSE.txt", "{bin,lib,test,ext}/**/*"]
-  end
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
 
-rescue LoadError
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
 end
 
-task :default => :test
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
 
-desc 'Run specs with unit test style output'
+desc 'Run tests'
 task :test do |t|
-  sh 'bacon -q -Ilib test/*_test.rb'
+  sh 'bacon -q -Ilib -I. test/*_test.rb'
 end
+
+task :default => :test

data/gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless Object.const_defined?(:Gem)
+require File.dirname(__FILE__) + "/lib/bond/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bond"
+  s.version     = Bond::VERSION
+  s.authors     = ["Gabriel Horner"]
+  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 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.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.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+  s.extensions = RUBY_VERSION < '1.9.2' ? ["ext/readline_line_buffer/extconf.rb"] : []
+end

data/lib/bond.rb

@@ -12,6 +12,7 @@ require 'bond/missions/method_mission'
 require 'bond/missions/object_mission'
 require 'bond/missions/anywhere_mission'
 require 'bond/missions/operator_method_mission'
+require 'bond/yard'
 
 module Bond
   extend self
@@ -70,18 +71,32 @@ module Bond
   #                   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.
   def config; M.config; end
 
-  # Starts Bond with a default set of completions that replace and improve irb's completion. Loads completion
-  # files in the following order: lib/bond/completion.rb, optional ~/.bondrc, lib/bond/completions/*.rb,
-  # optional ~/.bond/completions/*.rb and optional block. See Rc for the DSL to use in completion files and
-  # in the block. See Bond.config for valid options.
-  # ==== Example:
+  # 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.
+  # ==== Examples:
+  #   Bond.start :gems=>%w{hirb}
   #   Bond.start(:default_search=>:ignore_case) do
   #     complete(:method=>"Object#respond_to?") {|e| e.object.methods }
   #   end
   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.
+  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.
   def agent; M.agent; end
 

data/lib/bond/agent.rb

@@ -37,7 +37,7 @@ module Bond
     rescue InvalidMissionError
       "Invalid #{$!.message} for completion with options: #{options.inspect}"
     rescue
-      "Unexpected error while creating completion with options #{options.inspect}:\n#{$!}"
+      "Unexpected error while creating completion with options #{options.inspect} and message:\n#{$!}"
     end
 
     # Creates a mission and replaces the mission it matches if possible.
@@ -61,13 +61,14 @@ module Bond
       @missions = []
     end
 
-    # This is where the action starts when a completion is initiated.
-    def call(input)
-      mission_input = @weapon.line_buffer
+    # 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
-      completion_error($!.message[0], "Completion Info: #{$!.message[1]}")
+    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."
@@ -87,6 +88,9 @@ module Bond
       else
         puts "Doesn't match a completion."
       end
+    rescue FailedMissionError=>e
+      puts e.mission.match_message, e.message,
+        "Matches for #{e.mission.condition.inspect} are #{e.mission.matched.to_a.inspect}"
     end
 
     def find_mission(input) #:nodoc:

data/lib/bond/completion.rb

@@ -4,10 +4,10 @@ complete :object=>"Object"
 complete :all_methods=>true
 complete :all_operator_methods=>true
 # classes and constants
-complete(:name=>:constants, :anywhere=>'(((::)?[A-Z][^:.\(]*)+)::?([^:.]*)') {|e|
+complete(:name=>:constants, :anywhere=>'([A-Z][^. \(]*)::([^: .]*)') {|e|
   receiver = e.matched[2]
   candidates = eval("#{receiver}.constants | #{receiver}.methods") || []
-  normal_search(e.matched[5], candidates).map {|e| receiver + "::" + e}
+  normal_search(e.matched[3], candidates).map {|e| receiver + "::" + e}
 }
 # absolute constants
 complete(:prefix=>'::', :anywhere=>'[A-Z][^:\.\(]*') {|e| Object.constants }

data/lib/bond/completions/kernel.rb

@@ -1,6 +1,8 @@
 complete(:methods=>%w{Kernel#raise Kernel#fail}) { objects_of(Class).select {|e| e < StandardError } }
-complete(:method=>%w{Kernel#system Kernel#exec}) {|e|
-  ENV['PATH'].split(File::PATH_SEPARATOR).uniq.map {|e| Dir.entries(e) }.flatten.uniq - ['.', '..']
+complete(:methods=>%w{Kernel#system Kernel#exec}) {|e|
+  ENV['PATH'].split(File::PATH_SEPARATOR).uniq.map {|e|
+    File.directory?(e) ? Dir.entries(e) : []
+  }.flatten.uniq - ['.', '..']
 }
 complete(:method=>"Kernel#require", :search=>:files) {
   paths = $:.map {|e| Dir["#{e}/**/*.{rb,bundle,dll,so}"].map {|f| f.sub(e+'/', '') } }.flatten

data/lib/bond/completions/module.rb

@@ -1,7 +1,10 @@
 complete(:methods=>%w{const_get const_set const_defined? remove_const}, :class=>"Module#") {|e| e.object.constants }
 complete(:methods=>%w{class_variable_defined? class_variable_get class_variable_set remove_class_variable},
   :class=>"Module#") {|e| e.object.class_variables }
-complete(:methods=>%w{instance_method method_defined? module_function public private protected remove_method undef_method},
+complete(:methods=>%w{instance_method method_defined? module_function remove_method undef_method},
   :class=>"Module#") {|e| e.object.instance_methods }
+complete(:method=>"Module#public") {|e| e.object.private_instance_methods + e.object.protected_instance_methods }
+complete(:method=>"Module#private") {|e| e.object.instance_methods + e.object.protected_instance_methods }
+complete(:method=>"Module#protected") {|e| e.object.instance_methods + e.object.private_instance_methods }
 complete(:methods=>%w{< <= <=> > >= include? include}, :class=>"Module#", :search=>:modules) { objects_of(Module) }
 complete(:method=>'Module#alias_method') {|e| e.argument > 1 ? e.object.instance_methods : [] }

data/lib/bond/m.rb

@@ -6,7 +6,7 @@ module Bond
     # See Bond.complete
     def complete(options={}, &block)
       if (result = agent.complete(options, &block)).is_a?(String)
-        $stderr.puts result
+        $stderr.puts "Bond Error: "+result
         false
       else
         true
@@ -16,7 +16,7 @@ module Bond
     # See Bond.recomplete
     def recomplete(options={}, &block)
       if (result = agent.recomplete(options, &block)).is_a?(String)
-        $stderr.puts result
+        $stderr.puts "Bond Error: "+result
         false
       else
         true
@@ -50,7 +50,7 @@ module Bond
       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 "Invalid readline plugin set. Try again."
+        $stderr.puts "Bond Error: Invalid readline plugin given."
       end
     end
 
@@ -62,12 +62,28 @@ 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'))
-      [File.dirname(__FILE__), File.join(home, '.bond')].each do |base_dir|
-        load_dir(base_dir)
-      end
+      load_dir File.join(home, '.bond')
     end
 
     # Loads a completion file in Rc namespace.
@@ -77,7 +93,8 @@ module Bond
       $stderr.puts "Bond Error: Completion file '#{file}' failed to load with:", e.message
     end
 
-    def load_dir(base_dir) #:nodoc:
+    # Loads completion files in given directory.
+    def load_dir(base_dir)
       if File.exists?(dir = File.join(base_dir, 'completions'))
         Dir[dir + '/*.rb'].each {|file| load_file(file) }
       end

data/lib/bond/mission.rb

@@ -1,8 +1,12 @@
 module Bond
   # Occurs when a mission is incorrectly defined.
   class InvalidMissionError < StandardError; end
-  # Occurs when a mission or search action fails.
-  class FailedMissionError < StandardError; end
+  # Occurs when a mission fails.
+  class FailedMissionError < StandardError
+    # Mission that failed
+    attr_reader :mission
+    def initialize(mission); @mission = mission; end #:nodoc:
+  end
 
   # Represents a completion rule, given a condition (:on) on which to match and an action
   # (block or :action) with which to generate possible completions.
@@ -83,7 +87,7 @@ module Bond
       message = $!.is_a?(NoMethodError) && !Rc.respond_to?("#{search}_search") ?
         "Completion search '#{search}' doesn't exist." :
         "Failed during completion search with '#{$!.message}'."
-      raise FailedMissionError, [message, match_message]
+      raise FailedMissionError.new(self), message
     end
 
     # Calls the action to generate an array of possible completions.
@@ -93,7 +97,7 @@ module Bond
       message = $!.is_a?(NoMethodError) && !@action.respond_to?(:call) &&
         !Rc.respond_to?(@action) ? "Completion action '#{@action}' doesn't exist." :
         "Failed during completion action with '#{$!.message}'."
-      raise FailedMissionError, [message, match_message]
+      raise FailedMissionError.new(self), message
     end
 
     # A message used to explains under what conditions a mission matched the user input.
@@ -131,6 +135,7 @@ module Bond
       @evaled_object = self.class.current_eval(obj, eval_binding)
       true
     rescue Exception
+      raise FailedMissionError.new(self), "Match failed during eval of '#{obj}'." if Bond.config[:eval_debug]
       false
     end
 

data/lib/bond/missions/method_mission.rb

@@ -76,8 +76,9 @@ module Bond
         end
       end
 
+      raise InvalidMissionError, "array :method" if options[:method].is_a?(Array)
       meths = options[:methods] || Array(options[:method])
-      raise InvalidMissionError, ":method(s)" unless meths.all? {|e| e.is_a?(String) }
+      raise InvalidMissionError, "non-string :method(s)" unless meths.all? {|e| e.is_a?(String) }
       if options[:class].is_a?(String)
         options[:class] << '#' unless options[:class][/[#.]$/]
         meths.map! {|e| options[:class] + e }
@@ -148,7 +149,7 @@ module Bond
   end
 
   self.reset
-  OBJECTS = %w{\S*?} + Mission::OBJECTS
+  OBJECTS = Mission::OBJECTS + %w{\S*?}
   CONDITION = %q{(OBJECTS)\.?(METHODS)(?:\s+|\()(['":])?(.*)$}
 
   #:stopdoc:

data/lib/bond/readline.rb

@@ -7,28 +7,7 @@ module Bond
     # Loads the readline-like library and sets the completion_proc to the given agent.
     def setup(agent)
       require 'readline'
-      begin
-        require 'readline_line_buffer'
-      rescue LoadError
-        $stderr.puts "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
-        ]
-      end
+      load_extension unless ::Readline.respond_to?(:line_buffer)
 
       # Reinforcing irb defaults
       ::Readline.completion_append_character = nil
@@ -42,6 +21,29 @@ module Bond
       end
     end
 
+    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
+      ]
+    end
+
     # Returns full line of what the user has typed.
     def line_buffer
       ::Readline.line_buffer

data/lib/bond/version.rb

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

data/lib/bond/yard.rb

@@ -0,0 +1,73 @@
+module Bond
+  # Generates method autocompletions for gems that use {yard}[http://yardoc.org] documentation. Currently
+  # generates completions for methods that take a hash of options and have been documented with @option.
+  module Yard
+    extend self
+
+    # :stopdoc:
+    def load_yard_gems(*gems)
+      @options = gems[-1].is_a?(Hash) ? gems.pop : {}
+      require 'yard'
+      raise LoadError unless YARD::VERSION >= '0.5.2'
+      gems.select {|e| load_yard_gem(e) }
+    rescue LoadError
+      $stderr.puts "Bond Error: yard gem (version >= 0.5.2) not installed "
+    end
+
+    def load_yard_gem(rubygem)
+      raise("Unable to find gem.") unless (yardoc = find_yardoc(rubygem))
+      completion_file = File.join(dir('yard_completions'), rubygem+'.rb')
+      create_completion_file(yardoc, completion_file) if !File.exists?(completion_file) || @options[:reload]
+      M.load_file completion_file
+    rescue
+      $stderr.puts "Bond Error: Didn't load yard completions for gem '#{rubygem}'. #{$!.message}"
+    end
+
+    def create_completion_file(yardoc, completion_file)
+      YARD::Registry.load!(yardoc)
+      methods_hash = find_methods_with_options
+      body = generate_method_completions(methods_hash)
+      File.open(completion_file, 'w') {|e| e.write body }
+    end
+
+    def find_yardoc(rubygem)
+      (file = YARD::Registry.yardoc_file_for_gem(rubygem) rescue nil) and return(file)
+      if (file = M.find_gem_file(rubygem, rubygem+'.rb'))
+        output_dir = File.join(dir('.yardocs'), rubygem)
+        cmd = ['yardoc', '-n', '-b', output_dir]
+        cmd << '-q' unless @options[:verbose]
+        cmd += ['-c', output_dir] unless @options[:reload]
+        cmd += [file, File.expand_path(file+'/..')+"/#{rubygem}/**/*.rb"]
+        puts "Bond: "+cmd.join(' ') if @options[:verbose]
+        puts "Bond: Building/loading #{rubygem}'s .yardoc database ..."
+        system *cmd
+        output_dir
+      end
+    end
+
+    def dir(subdir)
+      (@dirs ||= {})[subdir] ||= begin
+        require 'fileutils'
+        FileUtils.mkdir_p File.join(M.home, '.bond', subdir)
+        File.join(M.home, '.bond', subdir)
+      end
+    end
+
+    def find_methods_with_options
+      YARD::Registry.all(:method).inject({}) {|a,m|
+        opts = m.tags.select {|e| e.is_a?(YARD::Tags::OptionTag) }.map {|e| e.pair.name }
+        a[m.path] = opts if !opts.empty? && m.path
+        a
+      }
+    end
+
+    def generate_method_completions(methods_hash)
+      methods_hash.map do |meth, options|
+        options.map! {|e| e.sub(/^:/, '') }
+        meth = meth.sub(/#initialize$/, '.new')
+        %Q[complete(:method=>'#{meth}') {\n  #{options.inspect}\n}]
+      end.join("\n")
+    end
+    #:startdoc:
+  end
+end

data/test/agent_test.rb

@@ -18,6 +18,11 @@ describe "Agent" do
       errors[1].should =~ /Please/
     end
 
+    it "allows the readline buffer to be provided as an argument" do
+      Bond.agent.weapon.stubs(:line_buffer).raises(Exception)
+      should.not.raise { Bond.agent.call('bl', 'bl foo') }
+    end
+
     def complete_error(msg)
       lambda {|e|
         e[0].should =~ msg
@@ -113,11 +118,15 @@ describe "Agent" do
     end
 
     it "with invalid :method prints error" do
-      complete_prints_error(/Invalid :method\(s\)/, :method=>true) {}
+      complete_prints_error(/Invalid.*:method\(s\)/, :method=>true) {}
+    end
+
+    it "with invalid array :method prints error" do
+      complete_prints_error(/Invalid array :method/, :method=>%w{one two}) {}
     end
 
     it "with invalid :methods prints error" do
-      complete_prints_error(/Invalid :method\(s\)/, :methods=>[:blah]) {}
+      complete_prints_error(/Invalid.*:method\(s\)/, :methods=>[:blah]) {}
     end
 
     it "with invalid :action for method completion prints error" do

data/test/anywhere_mission_test.rb

@@ -24,7 +24,7 @@ describe "anywhere mission" do
     complete(:anywhere=>'\$[^\s.]*', :search=>false) {|e|
       global_variables.grep(/^#{Regexp.escape(e.matched[1])}/)
     }
-    tab("$LO").should == ["$LOAD_PATH", "$LOADED_FEATURES"]
+    tab("$LO").sort.should == ["$LOADED_FEATURES", "$LOAD_PATH"]
   end
 
   it 'with :prefix completes' do

data/test/bond_test.rb

@@ -2,36 +2,79 @@ 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)
+    end
+
     before { M.instance_eval("@agent = @config = nil"); M.expects(:load_completions) }
     it "prints error if readline_plugin is not a module" do
-      capture_stderr { Bond.start :readline_plugin=>false }.should =~ /Invalid/
+      capture_stderr { start :readline_plugin=>false }.should =~ /Invalid/
     end
     
     it "prints error if readline_plugin doesn't have all required methods" do
-      capture_stderr {Bond.start :readline_plugin=>Module.new{ def setup(arg); end } }.should =~ /Invalid/
+      capture_stderr {start :readline_plugin=>Module.new{ def setup(arg); end } }.should =~ /Invalid/
     end
 
     it "prints no error if valid readline_plugin" do
-      capture_stderr {Bond.start :readline_plugin=>valid_readline_plugin }.should == ''
+      capture_stderr { start }.should == ''
     end
 
     it "sets default mission" do
-      Bond.start :default_mission=>lambda {|e| %w{1 2 3}}, :readline_plugin=>valid_readline_plugin
+      start :default_mission=>lambda {|e| %w{1 2 3}}
       tab('1').should == ['1']
     end
 
     it "sets default search" do
-      Bond.start :default_search=>:anywhere, :readline_plugin=>valid_readline_plugin
+      start :default_search=>:anywhere
       complete(:on=>/blah/) { %w{all_quiet on_the western_front}}
       tab('blah qu').should == ["all_quiet"]
     end
 
     it "defines completion in block" do
-      Bond.start do
-        complete(:on=>/blah/) { %w{all_quiet on_the western_front}}
-      end
+      start { complete(:on=>/blah/) { %w{all_quiet on_the western_front}} }
       tab('blah all').should == ["all_quiet"]
     end
+
+    after_all { M.debrief :readline_plugin=>valid_readline_plugin; M.reset }
+  end
+
+  describe "start with :gems" do
+    before {
+      File.stubs(:exists?).returns(true)
+      M.stubs(:load_file)
+    }
+
+    it "attempts to load gem" do
+      M.stubs(:load_dir)
+      M.expects(:gem).twice
+      start(:gems=>%w{one two})
+    end
+
+    it "rescues nonexistent gem" do
+      M.stubs(:load_dir)
+      M.expects(:gem).raises(LoadError)
+      should.not.raise { start(:gems=>%w{blah}) }
+    end
+
+    it "rescues nonexistent method 'gem'" do
+      M.stubs(:load_dir)
+      M.expects(:gem).raises(NoMethodError)
+      should.not.raise { start(:gems=>%w{blah}) }
+    end
+
+    it "prints error if gem completion not found" do
+      M.stubs(:load_dir)
+      M.expects(:find_gem_file).returns(nil)
+      capture_stderr { start(:gems=>%w{invalid}) }.should =~ /No completions.*'invalid'/
+    end
+
+    it "loads gem completion file" do
+      M.expects(:load_dir)
+      M.expects(:load_dir).with(File.join($:[0], 'awesome', '..', 'bond'))
+      M.expects(:load_dir)
+      M.expects(:gem)
+      start(:gems=>%w{awesome})
+    end
     after_all { M.debrief :readline_plugin=>valid_readline_plugin; M.reset }
   end
 

data/test/completion_test.rb

@@ -24,9 +24,13 @@ describe "Completion" do
     }.should == ''
   end
 
+  it "completes nested classes greater than 2 levels" do
+    eval %[module ::Foo; module Bar; module Baz; end; end; end]
+    tab("Foo::Bar::B").should == %w{Foo::Bar::Baz}
+  end
+
   it "completes nested classes anywhere" do
-    mock_irb
-    tab("blah IRB::In").should == ["IRB::InputCompletor"]
+    tab("module Blah; include Bond::Sea").should == ["Bond::Search"]
   end
 
   it "completes symbols anywhere" do
@@ -39,6 +43,10 @@ describe "Completion" do
     tab("%w{ab bc cd}.delete(").should == %w{ab bc cd}
   end
 
+  it "completes method arguments when object contains method names" do
+    tab("%w{find ab cd}.delete ").should == %w{find ab cd}
+  end
+
   it "completes hash coming from a method" do
     tab('Bond.config[:r').should == ["Bond.config[:readline_plugin"]
   end

data/test/yard_test.rb

@@ -0,0 +1,114 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+module YARD; VERSION = '0.5.2'; module Registry; end; end
+  
+describe 'Bond.load_yard_gems' do
+  def load_yard_gems(*args)
+    args = ['blah'] if args.empty?
+    Bond.load_yard_gems(*args)
+  end
+
+  it 'prints error if unable to require yard' do
+    Yard.expects(:require).with('yard').raises(LoadError)
+    capture_stderr { load_yard_gems }.should =~ /yard.*not installed/
+  end
+
+  it 'prints error if old version of yard' do
+    YARD.send :remove_const, :VERSION
+    YARD::VERSION = '0.5.0'
+    Yard.expects(:require).with('yard')
+    capture_stderr { load_yard_gems }.should =~ /yard.*not installed/
+    YARD.send :remove_const, :VERSION
+    YARD::VERSION = '0.5.2'
+  end
+
+  it 'prints error if no yardoc found' do
+    Yard.expects(:require).with('yard')
+    Yard.expects(:find_yardoc).returns(nil)
+    capture_stderr { load_yard_gems('bond') }.should =~ /Didn't.*'bond'.* Unable to find/
+  end
+
+  describe 'loads yardoc found by' do
+    before {
+      Yard.expects(:require).at_least(1).with { require 'fileutils'; true }
+      Yard.expects(:create_completion_file)
+      M.expects(:load_file)
+    }
+
+    it 'registry' do
+      YARD::Registry.expects(:yardoc_file_for_gem).returns('/dir/.yardoc')
+      load_yard_gems
+    end
+
+    describe 'find_gem_file and' do
+      before {
+        YARD::Registry.expects(:yardoc_file_for_gem).returns(nil)
+        M.expects(:find_gem_file).returns('/dir/blah.rb')
+      }
+
+      it 'prints building message' do
+        Yard.expects(:system)
+        capture_stdout { load_yard_gems('bond') }.should =~ /Building.*bond's/
+      end
+
+      it "caches yardoc by default" do
+        Yard.expects(:system).with {|*args| args.include?('-c') }
+        capture_stdout { load_yard_gems }
+      end
+
+      it "doesn't cache yardoc with :reload option" do
+        Yard.expects(:system).with {|*args| !args.include?('-c') }
+        capture_stdout { load_yard_gems('blah', :reload=>true) }
+      end
+
+      it "prints multiple messages with :verbose option" do
+        Yard.expects(:system).with {|*args| !args.include?('-q') }
+        capture_stdout { load_yard_gems('blah', :verbose=>true) }.should =~ /yardoc -n/
+      end
+    end
+  end
+
+  describe 'creates completion file' do
+    before {
+      Yard.expects(:require).at_least(1).with { require 'fileutils'; true }
+      Yard.expects(:find_yardoc).returns('/dir/.yardoc')
+      M.expects(:load_file)
+    }
+
+    it "with :reload option" do
+      File.expects(:exists?).returns(true)
+      Yard.expects(:create_completion_file)
+      load_yard_gems 'blah', :reload=>true
+    end
+
+    it "with new completion file" do
+      File.expects(:exists?).returns(false)
+      Yard.expects(:create_completion_file)
+      load_yard_gems
+    end
+
+    describe 'which has' do
+      before { YARD::Registry.expects(:load!) }
+
+      it 'methods' do
+        Yard.expects(:find_methods_with_options).returns({"Bond::M.start"=>[':one', 'two']})
+        expected_body = %[complete(:method=>'Bond::M.start') {\n  ["one", "two"]\n}]
+        File.expects(:open).yields mock('block') { expects(:write).with(expected_body) }
+        load_yard_gems
+      end
+
+      it 'no methods' do
+        Yard.expects(:find_methods_with_options).returns({})
+        File.expects(:open).yields mock('block') { expects(:write).with('') }        
+        load_yard_gems
+      end
+
+      it 'methods that map from #initialize to .new' do
+        Yard.expects(:find_methods_with_options).returns({"Bond::Agent#initialize"=>[':one', 'two']})
+        expected_body = %[complete(:method=>'Bond::Agent.new') {\n  ["one", "two"]\n}]
+        File.expects(:open).yields mock('block') { expects(:write).with(expected_body) }
+        load_yard_gems
+      end
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -14,27 +14,58 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 -04:00
+date: 2010-05-19 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
-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 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."
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha-on-bacon
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+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: []
 
 extensions: 
 - ext/readline_line_buffer/extconf.rb
 extra_rdoc_files: 
-- LICENSE.txt
 - README.rdoc
-files: 
-- CHANGELOG.rdoc
 - LICENSE.txt
-- README.rdoc
-- Rakefile
-- ext/readline_line_buffer/extconf.rb
-- ext/readline_line_buffer/readline_line_buffer.c
-- lib/bond.rb
+files: 
 - lib/bond/agent.rb
 - lib/bond/completion.rb
 - lib/bond/completions/activerecord.rb
@@ -58,6 +89,8 @@ files:
 - lib/bond/readline.rb
 - lib/bond/search.rb
 - lib/bond/version.rb
+- lib/bond/yard.rb
+- lib/bond.rb
 - test/agent_test.rb
 - test/anywhere_mission_test.rb
 - test/bacon_extensions.rb
@@ -70,16 +103,25 @@ files:
 - test/operator_method_mission_test.rb
 - test/search_test.rb
 - test/test_helper.rb
+- test/yard_test.rb
+- LICENSE.txt
+- CHANGELOG.rdoc
+- README.rdoc
+- ext/readline_line_buffer/extconf.rb
+- ext/readline_line_buffer/readline_line_buffer.c
+- Rakefile
+- gemspec
 has_rdoc: true
 homepage: http://tagaholic.me/bond/
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -87,29 +129,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: tagaholic
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: "Mission: Easy custom autocompletion for arguments, methods and beyond. Accomplished for irb and any other readline-like console environments."
-test_files: 
-- 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
-- test/method_mission_test.rb
-- test/mission_test.rb
-- test/object_mission_test.rb
-- test/operator_method_mission_test.rb
-- test/search_test.rb
-- test/test_helper.rb
+test_files: []
+