binder 0.0.1 → 0.0.2

data/README.rdoc

@@ -3,6 +3,13 @@
   # gem install binder
 
 = Use
+
+binder allows you to change the closure in which a proc is executed. This is helpful for anyone developing their own domain specific language in ruby. For more information about proc binding, check out this post I wrote which in turn inspired me to write this gem: http://moonmaster9000.tumblr.com/post/398991873/creating-cleaner-apis
+
+
+== Proc#bind_to
+
+The #bind_to method on a proc instance allows you to change the closure in which the proc is run:
   
   # irb
   >> require 'binder'
@@ -27,4 +34,97 @@
     ==> "why should i?"  
 
   >> command.bind_to(Dog.new).call
-    ==> "ruff!"
+    ==> "ruff!"
+  
+
+== Object##bind
+
+binder also provides the "#bind" object class method to DRY up your DSL instance methodsmethods: 
+
+  >> class Dog
+  >>     bind :do_trick, :self
+  >>     
+  ?>       def speak
+  >>         "ruff!"
+  >>       end
+  >>   end
+    ==> nil
+  
+  >> Dog.new.do_trick { speak }
+    ==> "ruff!"
+    
+  >> class Cat
+  >>   bind :do_trick, Cat
+  >>   
+  ?>   class << self
+  >>     def speak
+  >>       "screw you"
+  >>     end
+  >>   end
+  >>   
+  ?>   def speak
+  >>     "bugger off"
+  >>   end
+  >> end
+    ==> nil
+    
+  >> Cat.new.do_trick { speak }
+    ==> "screw you"
+  
+  >> class Kitten
+  >>   bind :do_trick, :mother
+  >>   
+  ?>   def initialize(mom)
+  >>     @mother = mom
+  >>   end
+  >> end 
+    ==> nil
+  
+  >> Kitten.new(Cat).do_trick { speak }
+    ==> "screw you"
+  
+  >> Kitten.new(Cat.new).do_trick { speak }
+    ==> "bugger off"
+  
+  >> Kitten.new(Dog.new).do_trick { speak }
+    ==> "ruff!"
+  
+== Object##bind_class_method
+  
+Whereas the Object##bind method created instance methods, Object##bind_class_method creates class methods:
+
+  >> class Cat
+  >>   bind :do_trick, Cat
+  >> 
+  ?>   class << self
+  >>     def speak
+  >>         "screw you"
+  >>       end
+  >>   end
+  >>   
+  ?>   def speak
+  >>     "bugger off"
+  >>   end
+  >> end
+    ==> nil
+  
+  >> class Lion
+  >>   bind_class_method :tame, :self
+  >>   bind_class_method :do_trick, :child
+  >>   class << self
+  >>     def down_kitty
+  >>       "meow"
+  >>     end
+  >>     
+  ?>     def child
+  >>       @child ||= Cat
+  >>     end
+  >>   end
+  >> end
+    ==> nil
+     
+  >> Lion.tame {down_kitty}
+    ==> "meow"
+    
+  >> Lion.do_trick { speak }
+    ==> "screw you"

data/lib/binder/object.rb

@@ -0,0 +1,43 @@
+class Object
+  class << self
+    def bind(method_name, closure)
+      if !closure.kind_of?(Symbol)
+        closure = closure.to_s
+      else   
+        closure = closure == :self ? "self" : "@#{closure}"
+      end
+      
+      self.class_eval do
+        eval(
+          "
+            def #{method_name}(&block)
+              raise ArgumentError, \"You must pass a block to ##{method_name}.\" unless block
+              block.bind_to(#{closure}).call
+            end
+          "
+        )
+      end
+    end
+    
+    def bind_class_method(method_name, closure)
+      if !closure.kind_of?(Symbol)
+        closure = closure.to_s
+      else   
+        closure = closure == :self ? "self" : "#{closure}"
+      end
+      
+      self.class_eval do
+        eval(
+          "
+            class << self
+              def #{method_name}(&block)
+                raise ArgumentError, \"You must pass a block to ##{method_name}.\" unless block
+                block.bind_to(#{closure}).call
+              end
+            end
+          "
+        )
+      end
+    end
+  end
+end

data/lib/binder.rb

@@ -1 +1,2 @@
 require 'binder/proc'
+require 'binder/object'

data/spec/binder/object_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Object do
+  describe "#bind" do
+    it "should create a new instance method that evaluates the block passed it within the requested closure" do
+      class Dog
+        bind :do_trick, :self
+      
+        def speak
+          "ruff!"
+        end
+      end
+    
+      Dog.new.do_trick { speak }.should == "ruff!"
+    
+      class Cat
+        bind :do_trick, Cat
+      
+        class << self
+          def speak
+            "screw you"
+          end
+        end
+      
+        def speak
+          "bugger off"
+        end
+      end
+    
+      Cat.new.do_trick { speak }.should == "screw you"
+    
+      class Kitten
+        bind :do_trick, :mother
+      
+        def initialize(mom)
+          @mother = mom
+        end
+      end 
+    
+      Kitten.new(Cat).do_trick { speak }.should == "screw you"
+      Kitten.new(Cat.new).do_trick { speak }.should == "bugger off"
+      Kitten.new(Dog.new).do_trick { speak }.should == "ruff!"
+    
+    end
+  
+    describe "#bind_class_method" do
+      it "should create a class method responder that binds to either a new class or the return value of a class method" do
+        class Cat
+          bind :do_trick, Cat
+
+          class << self
+            def speak
+              "screw you"
+            end
+          end
+
+          def speak
+            "bugger off"
+          end
+        end
+        
+        class Lion
+          bind_class_method :tame, :self
+          bind_class_method :do_trick, :child
+          class << self
+            def down_kitty
+              "meow"
+            end
+
+            def child
+              @child ||= Cat
+            end
+          end
+        end
+
+        Lion.tame {down_kitty}.should == "meow"
+        Lion.do_trick { speak }.should == "screw you"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: binder
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Matt Parker
@@ -13,7 +13,7 @@ date: 2010-02-20 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: Binder allows to evaluate a proc in a closure other than the one in which it was created. It also includes a method :bind to DRY up code for anyone creating a domain specific language.
+description: Binder allows you to evaluate a proc in a closure other than the one in which it was created. It also includes a method :bind to DRY up code for anyone creating a domain specific language.
 email: moonmaster9000@gmail.com
 executables: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - lib/binder.rb
+- lib/binder/object.rb
 - lib/binder/proc.rb
 has_rdoc: true
 homepage: http://github.com/moonmaster9000/binder
@@ -54,5 +55,6 @@ signing_key:
 specification_version: 3
 summary: A tool for rebinding your ruby procs, with a helper for DSL creaters.
 test_files: 
+- spec/binder/object_spec.rb
 - spec/binder/proc_spec.rb
 - spec/spec_helper.rb