bond 0.3.4 → 0.3.5

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 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.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.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = 'tagaholic'
   s.has_rdoc = 'yard'

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 0.3.5
+* Move yard-related functionality to bond-yard gem
+  
 == 0.3.4
 * Add gem plugin completion
 * Add jruby support thanks to @headius

data/README.rdoc

@@ -2,13 +2,14 @@ Note: To read a linked version of this README, {click here}[http://tagaholic.me/
 
 == 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.
+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.
 
 == Install
 
@@ -23,6 +24,8 @@ To start off, replace irb's completion (require 'irb/completion') with Bond's en
   require 'bond'
   Bond.start
 
+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
 and argument completion of some 80+ methods including Hash#[], Kernel#system, Kernel#require and some Rails methods.
 
@@ -30,7 +33,7 @@ and argument completion of some 80+ methods including Hash#[], Kernel#system, Ke
 
 By default, Bond autocompletes arguments for a number of core methods:
 
-  $ irb
+  $ ripl
   # require completes gems and anything in $LOAD_PATH
   >> require 'rb[TAB]
   rbconfig.rb          rbconfig/
@@ -151,6 +154,7 @@ There are a number of incorrect completions irb gives for object methods. Bond f
 
 Irb completes anything surrounded with '{}' the same:
 
+  $ irb
   >> proc {}.c[TAB]
   }.call     }.class    }.clear    }.clone    }.collect
   >> %w{ab bc}.c[TAB]
@@ -216,7 +220,6 @@ has good instructions for reinstalling ruby with the official Readline.
 * http://tagaholic.me/2009/07/23/mini-irb-and-mini-script-console.html
 
 == Todo
-* 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/lib/bond.rb

@@ -12,7 +12,6 @@ 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
@@ -77,7 +76,7 @@ module Bond
 
   # 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
+  # completions from :gems, ~/.bondrc, ~/.bond/completions/*.rb and from block. See
   # {Rc} for the DSL to use in completion files and in the block.
   #
   # ==== Examples:
@@ -90,7 +89,6 @@ module Bond
   # @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 [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.
@@ -118,12 +116,6 @@ module Bond
   # 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.
-  # @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.
   def agent; M.agent; end
 

data/lib/bond/completions/bond.rb

@@ -2,8 +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 yard_gems readline_plugin default_mission default_search eval_binding debug eval_debug bare}
-}
-complete(:method=>'Bond.load_yard_gems') {
-  ["verbose", "reload"]
+  %w{gems readline_plugin default_mission default_search eval_binding debug eval_debug bare}
 }

data/lib/bond/m.rb

@@ -129,7 +129,6 @@ module Bond
       load_file File.join(File.dirname(__FILE__), 'completion.rb') unless config[:bare]
       load_dir File.dirname(__FILE__) unless config[:bare]
       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')) && !config[:bare]
       load_dir File.join(home, '.bond') unless config[:bare]
     end

data/lib/bond/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bond
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-23 00:00:00 -05:00
+date: 2011-01-07 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 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.
+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.
 email: gabriel.horner@gmail.com
 executables: []
 
@@ -111,7 +111,6 @@ 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
@@ -125,7 +124,6 @@ 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
@@ -134,14 +132,14 @@ files:
 - test/deps.rip
 - Rakefile
 - .gemspec
-has_rdoc: true
+has_rdoc: yard
 homepage: http://tagaholic.me/bond/
 licenses: 
 - MIT
 post_install_message: 
 rdoc_options: 
 - --title
-- Bond 0.3.4 Documentation
+- Bond 0.3.5 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/lib/bond/yard.rb

@@ -1,73 +0,0 @@
-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
-
-    # Loads completions for yard gem(s)
-    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
-
-    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')
-      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
-  end
-end

data/test/yard_test.rb

@@ -1,117 +0,0 @@
-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)
-    }
-
-    # rubinius implements Kernel#require with File.exists? which is different than MRI
-    unless Config::CONFIG["RUBY_SO_NAME"].to_s[/rubinius/i]
-    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
-    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