bond 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -1,2 +1,7 @@
+== 0.1.1
+* Added Bond.spy to debug completions
+* Fixed object completion failing in irbrc
+* Allow regex characters in completions
+
 == 0.1.0
 * Intial release. Whoop!

data/README.rdoc

@@ -186,6 +186,5 @@ character typed.
 == Todo
 * Allow Bond to easily get its completion missions from a module.
 * Provide a set of Bond completions which can serve as a drop-in replacement for irb/completion.
-* Bond.spy for easily viewing/debugging what completion mission matches a given input.
 * Argument autocompletion by object class.
 * Make replacement of existing completions not require doing a Bond.reset.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 0
+:patch: 1

data/lib/bond.rb

@@ -65,7 +65,7 @@ module Bond
     @agent = nil
   end
 
-  # Debriefs Bond to set global defaults.
+  # Debriefs Bond to set global defaults. Call before defining completions.
   # ==== Options:
   # [:readline_plugin] Specifies a Bond plugin to interface with a Readline-like library. Available plugins are Bond::Readline and Bond::Rawline.
   #                    Defaults to Bond::Readline. Note that a plugin doesn't imply use with irb. Irb is joined to the hip with Readline.
@@ -77,11 +77,18 @@ module Bond
   def debrief(options={})
     config.merge! options
     plugin_methods = %w{setup line_buffer}
-    unless config[:readline_plugin].is_a?(Module) && plugin_methods.all? {|e| config[:readline_plugin].instance_methods.include?(e)}
+    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."
     end
   end
 
+  # Reports what completion mission and possible completions would happen for a given input. Helpful for debugging
+  # your completion missions.
+  def spy(input)
+    agent.spy(input)
+  end
+
   def agent #:nodoc:
     @agent ||= Agent.new(config)
   end

data/lib/bond/agent.rb

@@ -19,7 +19,8 @@ module Bond
 
     # This is where the action starts when a completion is initiated.
     def call(input)
-      (mission = find_mission(input)) ? mission.execute : default_mission.execute(input)
+      # Use line_buffer instead of input since it's more info
+      (mission = find_mission(line_buffer)) ? mission.execute : default_mission.execute(input)
     rescue FailedExecutionError
       $stderr.puts "", $!.message
     rescue
@@ -30,10 +31,23 @@ module Bond
       default_mission.execute(input)
     end
 
-    # No need to use what's passed to the completion proc when we can get the full line.
+    def spy(input)
+      if (mission = find_mission(input))
+        if mission.is_a?(Missions::ObjectMission)
+          puts "Matches completion mission for object with an ancestor matching #{mission.object_condition.inspect}."
+        elsif mission.is_a?(Missions::MethodMission)
+          puts "Matches completion mission for method matching #{mission.method_condition.inspect}."
+        else
+          puts "Matches completion mission with condition #{mission.condition.inspect}."
+        end
+        puts "Possible completions: #{mission.execute.inspect}"
+      else
+        puts "Doesn't match a completion mission."
+      end
+    end
+
     def find_mission(input) #:nodoc:
-      all_input = line_buffer
-      @missions.find {|mission| mission.matches?(all_input) }
+      @missions.find {|mission| mission.matches?(input) }
     end
 
     # Default mission used by agent.

data/lib/bond/mission.rb

@@ -21,7 +21,7 @@ module Bond
       end
     end
 
-    attr_reader :action
+    attr_reader :action, :condition
     OPERATORS = ["%", "&", "*", "**", "+",  "-",  "/", "<", "<<", "<=", "<=>", "==", "===", "=~", ">", ">=", ">>", "[]", "[]=", "^"]
 
     # Options are almost the same as those explained at Bond.complete. The only difference is that the action is passed
@@ -48,8 +48,8 @@ module Bond
     # Called when a mission has been chosen to autocomplete.
     def execute(*args)
       if args.empty?
-        list = @action.call(@input) || []
-        list = @search ? @search.call(@input, list) : list
+        list = (@action.call(@input) || []).map {|e| e.to_s }
+        list = @search ? @search.call(@input || '', list) : list
         @list_prefix ? list.map {|e| @list_prefix + e } : list
       else
         @action.call(*args)

data/lib/bond/missions/method_mission.rb

@@ -1,9 +1,10 @@
 # Represents a completion mission specified by :method in Bond.complete.
 class Bond::Missions::MethodMission < Bond::Mission
+  attr_reader :method_condition
   def initialize(options={}) #:nodoc:
-    @method = options.delete(:method)
-    @method = Regexp.quote(@method.to_s) unless @method.is_a?(Regexp)
-    options[:on] = /^\s*(#{@method})\s*['"]?(.*)$/    
+    @method_condition = options.delete(:method)
+    @method_condition = Regexp.quote(@method_condition.to_s) unless @method_condition.is_a?(Regexp)
+    options[:on] = /^\s*(#{@method_condition})\s*['"]?(.*)$/
     super
   end
 

data/lib/bond/missions/object_mission.rb

@@ -3,11 +3,13 @@
 # an ancestor specified by :object.
 class Bond::Missions::ObjectMission < Bond::Mission
   #:stopdoc:
+  attr_reader :object_condition
+
   def initialize(options={})
     @object_condition = options.delete(:object)
     @object_condition = /^#{Regexp.quote(@object_condition.to_s)}$/ unless @object_condition.is_a?(Regexp)
     options[:on] = /^((\.?[^.]+)+)\.([^.]*)$/
-    @eval_binding = options[:eval_binding] || default_eval_binding
+    @eval_binding = options[:eval_binding]
     super
   end
 
@@ -27,11 +29,15 @@ class Bond::Missions::ObjectMission < Bond::Mission
 
   def eval_object(match)
     @matched = match
-    @evaled_object = begin eval("#{match[1]}", @eval_binding); rescue Exception; nil end
+    @evaled_object = begin eval("#{match[1]}", eval_binding); rescue Exception; nil end
   end
 
   def default_action(obj)
-    obj.methods - OPERATORS
+    obj.methods.map {|e| e.to_s} - OPERATORS
+  end
+
+  def eval_binding
+    @eval_binding ||= default_eval_binding
   end
 
   def default_eval_binding

data/lib/bond/search.rb

@@ -3,17 +3,17 @@ module Bond
   module Search
     # Searches completions from the beginning of the string.
     def default_search(input, list)
-      list.grep(/^#{input}/)
+      list.grep(/^#{Regexp.escape(input)}/)
     end
 
     # Searches completions anywhere in the string.
     def anywhere_search(input, list)
-      list.grep(/#{input}/)
+      list.grep(/#{Regexp.escape(input)}/)
     end
 
     # Searches completions from the beginning and ignores case.
     def ignore_case_search(input, list)
-      list.grep(/^#{input}/i)
+      list.grep(/^#{Regexp.escape(input)}/i)
     end
 
     # Searches completions from the beginning but also provides aliasing of underscored words.
@@ -23,7 +23,7 @@ module Bond
     def underscore_search(input, list)
       split_input = input.split("-").join("")
       list.select {|c|
-        c.split("_").map {|g| g[0,1] }.join("") =~ /^#{split_input}/ || c =~ /^#{input}/
+        c.split("_").map {|g| g[0,1] }.join("") =~ /^#{Regexp.escape(split_input)}/ || c =~ /^#{Regexp.escape(input)}/
       }
     end
   end

data/test/agent_test.rb

@@ -44,21 +44,26 @@ class Bond::AgentTest < Test::Unit::TestCase
     end
   end
 
-  # TODO
-  # test "default_mission set to a valid mission if irb doesn't exist" do
-  #   old_default_action = Bond.agent.default_mission.action
-  #   Bond.agent.instance_eval("@default_mission = @default_mission_action = nil")
-  #   Object.expects(:const_defined?).with(:IRB).returns(false)
-  #   Bond.agent.default_mission.is_a?(Bond::Mission).should == true
-  #   Bond.agent.default_mission.action.respond_to?(:call).should == true
-  #   Bond.agent.default_mission.instance_variable_set(:@action, old_default_action)
-  # end
+  context "spy" do
+    before(:all) {
+      Bond.reset; Bond.complete(:on=>/end$/) { [] }; Bond.complete(:method=>'the') { %w{spy who loved me} }
+      Bond.complete(:object=>"Symbol")
+    }
 
-  # test "binding set to toplevel binding if irb doesn't exist" do
-  #   old_binding = Bond.agent.eval_binding
-  #   Object.expects(:const_defined?).with(:IRB).returns(false)
-  #   Bond.agent.instance_eval("@eval_binding = nil")
-  #   Bond.agent.eval_binding.should == ::TOPLEVEL_BINDING
-  #   Bond.agent.instance_variable_set(:@eval_binding, old_binding)
-  # end
+    test "detects basic mission" do
+      capture_stdout { Bond.spy('the end')}.should =~ /end/
+    end
+
+    test "detects object mission" do
+      capture_stdout { Bond.spy(':dude.i')}.should =~ /object.*Symbol.*dude\.id/m
+    end
+
+    test "detects method mission" do
+      capture_stdout { Bond.spy('the ')}.should =~ /method.*the.*loved/m
+    end
+
+    test "detects no mission" do
+      capture_stdout { Bond.spy('blah')}.should =~ /Doesn't match/
+    end
+  end
 end

data/test/mission_test.rb

@@ -8,25 +8,25 @@ class Bond::MissionTest < Test::Unit::TestCase
     test "completes" do
       Bond.complete(:on=>/bling/) {|e| %w{ab cd fg hi}}
       Bond.complete(:method=>'cool') {|e| [] }
-      complete('some bling f', 'f').should == %w{fg}
+      complete('some bling f').should == %w{fg}
     end
 
     test "with method completes" do
       Bond.complete(:on=>/bling/) {|e| [] }
       Bond.complete(:method=>'cool') {|e| %w{ab cd ef gd} }
-      complete('cool c', 'c').should == %w{cd}
+      complete('cool c').should == %w{cd}
     end
 
     test "with method and quoted argument completes" do
       Bond.complete(:on=>/bling/) {|e| [] }
       Bond.complete(:method=>'cool') {|e| %w{ab cd ef ad} }
-      complete('cool "a', 'a').should == %w{ab ad}
+      complete('cool "a').should == %w{ab ad}
     end
 
     test "with string method completes exact matches" do
       Bond.complete(:method=>'cool?') {|e| [] }
       Bond.complete(:method=>'cool') {|e| %w{ab cd ef gd} }
-      complete('cool c', 'c').should == %w{cd}
+      complete('cool c').should == %w{cd}
     end
 
     test "with regex method completes multiple methods" do
@@ -35,53 +35,20 @@ class Bond::MissionTest < Test::Unit::TestCase
       complete("ls c").should == %w{cd}
     end
 
-    test "with no search option and matching completes" do
+    test "with regexp condition completes" do
       Bond.complete(:on=>/\s*'([^']+)$/, :search=>false) {|e| %w{coco for puffs}.grep(/#{e.matched[1]}/) }
       complete("require 'ff").should == ['puffs']
     end
 
-    test "with search proc completes" do
-      Bond.complete(:method=>'blah', :search=>proc {|input, list| list.grep(/#{input}/)}) {|e| %w{coco for puffs} }
-      complete("blah 'ff").should == ['puffs']
-    end
-
-    test "with anywhere search completes" do
-      Bond.complete(:method=>'blah', :search=>:anywhere) {|e| %w{coco for puffs} }
-      complete("blah 'ff").should == ['puffs']
-    end
-
-    test "with ignore case search completes" do
-      Bond.complete(:method=>'blah', :search=>:ignore_case) {|e| %w{Coco For PufFs} }
-      complete("blah 'pu").should == ['PufFs']
-    end
-
-    test "with underscore search completes" do
-      Bond.complete(:on=>/blah/, :search=>:underscore) {|e| %w{and_one big_two can_three} }
-      complete("blah and").should == ['and_one']
-      complete("blah b-t").should == ['big_two']
-    end
-
-    test "with object and default action completes" do
-      Bond.complete(:object=>"String")
-      Bond.complete(:on=>/man/) { %w{upper upster upful}}
-      complete("'man'.u").should == ["'man'.upcase!", "'man'.unpack", "'man'.untaint", "'man'.upcase", "'man'.upto"]
-    end
-
-    test "with regex object completes" do
-      Bond.complete(:object=>/Str/) {|e| e.object.class.superclass.instance_methods(true) }
-      Bond.complete(:on=>/man/) { %w{upper upster upful}}
-      complete("'man'.u").should == ["'man'.untaint"]
-    end
-
-    test "with object and explicit action completes" do
-      Bond.complete(:object=>"String") {|e| e.object.class.superclass.instance_methods(true) }
-      Bond.complete(:on=>/man/) { %w{upper upster upful}}
-      complete("'man'.u").should == ["'man'.untaint"]
+    test "with non-string completions completes" do
+      Bond.complete(:on=>/.*/) { [:one,:two,:three] }
+      complete('ok ').should == %w{one two three}
     end
+  end
 
-    test "ignores invalid objects" do
-      Bond.complete(:object=>"String")
-      complete("blah.upt").should == []
-    end
+  test "default_mission set to a valid mission if irb doesn't exist" do
+    Object.expects(:const_defined?).with(:IRB).returns(false)
+    mission = Bond::Missions::DefaultMission.new
+    mission.action.respond_to?(:call).should == true
   end
 end

data/test/object_mission_test.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Bond::ObjectMissionTest < Test::Unit::TestCase
+  before(:all) {|e| Bond.debrief(:readline_plugin=>valid_readline_plugin) }
+  before(:each) {|e| Bond.agent.instance_eval("@missions = []") }
+  context "object mission" do
+    test "with default action completes" do
+      Bond.complete(:object=>"String")
+      Bond.complete(:on=>/man/) { %w{upper upster upful}}
+      complete("'man'.u").should == ["'man'.upcase!", "'man'.unpack", "'man'.untaint", "'man'.upcase", "'man'.upto"]
+    end
+
+    test "with regex condition completes" do
+      Bond.complete(:object=>/Str/) {|e| e.object.class.superclass.instance_methods(true) }
+      Bond.complete(:on=>/man/) { %w{upper upster upful}}
+      complete("'man'.u").should == ["'man'.untaint"]
+    end
+
+    test "with explicit action completes" do
+      Bond.complete(:object=>"String") {|e| e.object.class.superclass.instance_methods(true) }
+      Bond.complete(:on=>/man/) { %w{upper upster upful}}
+      complete("'man'.u").should == ["'man'.untaint"]
+    end
+
+    test "ignores invalid invalid ruby" do
+      Bond.complete(:object=>"String")
+      complete("blah.upt").should == []
+    end
+
+    # needed to ensure Bond works in irbrc
+    test "doesn't evaluate irb binding on definition" do
+      Object.expects(:const_defined?).never
+      Bond.complete(:object=>"String")
+    end
+
+    test "sets binding to toplevel binding when not in irb" do
+      Object.expects(:const_defined?).with(:IRB).returns(false)
+      mission = Bond::Mission.create(:object=>'Symbol')
+      mission.matches?(':ok.')
+      mission.eval_binding.should == ::TOPLEVEL_BINDING
+    end
+  end
+end

data/test/search_test.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Bond::SearchTest < Test::Unit::TestCase
+  before(:all) {|e| Bond.debrief(:readline_plugin=>valid_readline_plugin) }
+  before(:each) {|e| Bond.agent.instance_eval("@missions = []") }
+
+  context "mission with search" do
+    test "false completes" do
+      Bond.complete(:on=>/cool '(.*)/, :search=>false) {|e| %w{coco for puffs}.grep(/#{e.matched[1]}/) }
+      complete("cool 'ff").should == ['puffs']
+    end
+    
+    test "proc completes" do
+      Bond.complete(:method=>'blah', :search=>proc {|input, list| list.grep(/#{input}/)}) {|e| %w{coco for puffs} }
+      complete("blah 'ff").should == ['puffs']
+    end
+
+    test ":anywhere completes" do
+      Bond.complete(:method=>'blah', :search=>:anywhere) {|e| %w{coco for puffs} }
+      complete("blah 'ff").should == ['puffs']
+    end
+
+    test ":ignore_case completes" do
+      Bond.complete(:method=>'blah', :search=>:ignore_case) {|e| %w{Coco For PufFs} }
+      complete("blah 'pu").should == ['PufFs']
+    end
+
+    test ":underscore completes" do
+      Bond.complete(:on=>/blah/, :search=>:underscore) {|e| %w{and_one big_two can_three} }
+      complete("blah and").should == ['and_one']
+      complete("blah b-t").should == ['big_two']
+    end
+  end
+
+  test "search handles completions with regex characters" do
+    completions = ['[doh]', '.*a', '?ok']
+    Bond.complete(:on=>/blah/) { completions }
+    complete('blah .').should == ['.*a']
+    complete('blah [').should == ['[doh]']
+    complete('blah ?').should == ['?ok']
+  end
+end

data/test/test_helper.rb

@@ -31,6 +31,17 @@ class Test::Unit::TestCase
     fake.string
   end
 
+  def capture_stdout(&block)
+    original_stdout = $stdout
+    $stdout = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stdout = original_stdout
+    end
+    fake.string
+  end
+
   def complete(full_line, last_word=full_line)
     Bond.agent.stubs(:line_buffer).returns(full_line)
     Bond.agent.call(last_word)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bond
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-16 00:00:00 -04:00
+date: 2009-07-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -42,6 +42,8 @@ files:
 - test/agent_test.rb
 - test/bond_test.rb
 - test/mission_test.rb
+- test/object_mission_test.rb
+- test/search_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://tagaholic.me/bond/
@@ -75,4 +77,6 @@ test_files:
 - test/agent_test.rb
 - test/bond_test.rb
 - test/mission_test.rb
+- test/object_mission_test.rb
+- test/search_test.rb
 - test/test_helper.rb