big_spoon 0.1.0 → 0.2.0

data/README.md

@@ -1,41 +1,18 @@
 # Big Spoon
-Like the big spoon, **Big Spoon** wraps around your own methods.
-It adds before and after callbacks to ANY method in any Ruby class.
-Basically, now you can add hooks and/or callback to **any** Ruby method without fear of reprisals.
+**Big Spoon** adds ActiveRecord::Base-style `before_*` and `after_*` callbacks around ANY Ruby method.
 
-There were those who wanted to call it "sandwich," but they were killed.
+It's like a sandwich, where your method is the meat and your callbacks are the bread.
 
 ## Basic Usage
 
-Use **Big Spoon** like you would any other callbacks! Of course there's, like, at least three ways to do that. So **Big Spoon** supports all of em. All
-three let you define before- and after-methods or blocks to any method your class could, like, ever call. The safest is block form:
+Out-of-the box, **Big Spoon** adds callbacks that are similar to ActiveRecord::Base. Of course there's, like, at least three ways to do that. So **Big
+Spoon** supports all of 'em. Whatever form you choose, it'll swaddle your methods in the warm of `before` and `after` hooks.
 
-```ruby
-class User
-  hooks do
-    before :get_your_hands_off_of_my_woman, :listen_to_the_darkness
-    after :get_your_hands_off_of_my_woman { listen_to_moar_darkness! }
-  end
+### ActiveRecord::Base-style
 
-  def get_your_hands_off_of_my_woman
-    puts "Get your hands off of my woman, motherf*cker!"
-  end
+The most straightforward way is to do it ActiveRecord::Base style, which is to define a callback in the top of your class like so:
 
-  protected
-  def listen_to_the_darkness!
-    `osascript "tell iTunes to play some awesome"`
-  end
-
-  def listen_to_moar_darkness
-    `osascript "tell iTuens to continue not to suck after that last rad song"`
-  end
-end
 ```
-
-This is designed not to conflict with Rails callbacks and their siblings. **But if'n
-you're a real scofflaw (_and you f*cking should be!_), you can just do it normal-like:**
-
-```ruby
 class User
   before_believe_in_a_thing_called_love :listen_to_the_rhythm_of_my_heart
 
@@ -46,12 +23,43 @@ class User
   def listen_to_the_rhythm_of_my_heart
     listen("127.0.0.1") do
       match /(lub|dub)/ do
-        puts "Edgar Allan F*cking Poe?!"
+        puts "Edgar Allan Poe!"
       end
     end
   end
 ````
 
+### DataMapper-style
+
+DataMapper has what I consider a slightly better API for doing this, specifically:
+
+```
+class User
+  after :save, :get_your_hands_off_of_my_woman
+ end
+```
+
+So **Big Spoon** supports that notation, too! This is in order to avoid conflicts with Rails callbacks and their siblings. But if'n you're a real scofflaw, you can just do it normal-like.
+
+
+### Block-style
+
+If you're STILL interested in avoiding any potential conflicts, you can isolate your hooks
+completely by wrapping them in a block:
+
+```
+class User
+  hooks do
+    before :get_your_hands_off_of_my_woman, :listen_to_the_darkness
+  end
+
+  protected
+  def listen_to_the_darkness!
+    `osascript "tell iTunes to play some awesome"`
+  end
+end
+```
+
 So. Add hooks. To any Ruby method. That's pretty damn awesome, where I come form. I SAID "FORM," son!
 
 But, as they say, "love is only a feeling." So spoon like there's no tomorrow.
@@ -60,7 +68,7 @@ But, as they say, "love is only a feeling." So spoon like there's no tomorrow.
 
 Because ActiveModel callbacks are just so damn delightful, I've added some fun conditional sugar to match their wonderful. So g'head and add some `:if` conditions to your callbacks:
 
-```ruby
+```
 class User
   before :love_on_the_rocks, :add_ice, :if => :no_ice?
 
@@ -81,36 +89,26 @@ end
 
 Conditional callbacks also support `:unless`, just like their ActiveModel ancestors. Or should I say "inspiritors?" Is that word? Shut up, of course it is. Anyway:
 
-```ruby
+```
 class User
-  before :love_on_the_rocks, :add_ice, :unless => :not_in_tys_mazada?
+  before :love_on_the_rocks, :add_ice, :unless => :in_tys_mazada?
 
   def not_in_tys_mazada?
-    !((mazda = User.find_by_slug("ty").car) && mazda.has_rad_bass?)
-  end
-
-  protected
-  def add_ice
-    Ice.create!
+    (mazda = User.find_by_name("Ty").car) && mazda.has_rad_bass?
   end
 end
 ```
 
-And to recap! Just as  with the believing-in-things-called-love example, both could be re-written as
+And to recap! Just as  with the believing-in-things-called-love example, both could be re-written along these lines:
 
-```ruby
-before_love_on_the_rocks :add_ice, :if => :no_ice?
 ```
-
-and
-
-```ruby
-before_love_on_the_rocks :add_ice, :unless => :not_in_tys_mazda?
+before_love_on_the_rocks :add_ice, :if => :no_ice?
+# or
+hooks do
+  before :love_on_the_rocks, :add_if, :if => :no_ice?
+end
 ```
 
-respectively.
-
 HAPPY **CALLING-OF-THE-BACK**, FRIENDS!
 
-
 Copyright © 2012 Delightful Widgets Inc. No warranty so don't sue me or my company THANKS!

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/big_spoon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "big_spoon"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Flip Sasser"]
-  s.date = "2012-08-12"
+  s.date = "2012-08-14"
   s.description = "\n      BigSpoon will add a hooks method to every class. Call that method with a block and add all kinds of fun hooks before and after your methods.\n    "
   s.email = "flip@x451.com"
   s.extra_rdoc_files = [

data/lib/big_spoon/hook.rb

@@ -48,7 +48,7 @@ module BigSpoon
       alias :#{original_method} :#{method_to_hook}
       def #{hooked_method}(*args)
         Hook.for(self.class).execute_before(:#{method_to_hook}, self)
-        result = #{original_method}
+        result = #{original_method}(*args)
         Hook.for(self.class).execute_after(:#{method_to_hook}, self)
         result
       end

data/lib/big_spoon.rb

@@ -19,12 +19,16 @@ module BigSpoon
       end
       @hooks
     end # `hooks` method
-    
+
     private
     def method_missing(method_name, *args)
       case method_name.to_s
+      when 'after'
+        hooks.after *args
       when /^after_(.+)$/
         hooks.after $1, *args
+      when 'before'
+        hooks.before *args
       when /^before_(.+)$/
         hooks.before $1, *args
       else

data/spec/lib/big_spoon_spec.rb

@@ -13,6 +13,22 @@ class BigSpoonTest
     :bar
   end
 
+  def i_accept_one(argument)
+    puts argument
+  end
+
+  def i_accept_many(*arguments)
+    puts arguments
+  end
+
+  def i_might_accept_one(argument = nil)
+    puts argument
+  end
+
+  def raise_sommat
+    raise "This method will never look the same! EVER!"
+  end
+
   private
   def by_all_means_hook
     true
@@ -22,7 +38,7 @@ class BigSpoonTest
     false
   end
 
-  (1..8).each do |index|
+  (1..20).each do |index|
     define_method("hook_#{index}") { "hook_#{index}"}
   end
 end
@@ -116,4 +132,31 @@ describe BigSpoon do
     BigSpoonTest.before_foo! :hook_8
     @big_spoon_test.foo!
   end
+
+  it "should handle a set number of arguments in methods" do
+    BigSpoonTest.before :i_accept_one, :hook_9
+    @big_spoon_test.should_receive(:puts).with("ohai")
+    @big_spoon_test.i_accept_one("ohai")
+  end
+
+  it "should handle an arbitrary number of arguments in methods" do
+    BigSpoonTest.before :i_accept_many, :hook_10
+    @big_spoon_test.should_receive(:puts).with(["ohai", "i'll be an array", "someday"])
+    @big_spoon_test.i_accept_many("ohai", "i'll be an array", "someday")
+  end
+
+  it "should handle an option argument" do
+    BigSpoonTest.after :i_might_accept_one, :hook_11
+    @big_spoon_test.should_receive(:puts).with(nil)
+    @big_spoon_test.i_might_accept_one
+  end
+
+  it "should debug clearly when a method throws an error" do
+    BigSpoonTest.after :raise_sommat, :hook_12
+    begin
+      @big_spoon_test.raise_sommat
+    rescue Exception => error
+      $!.backtrace.first.should =~ /:\d+\:in `raise_sommat'/
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: big_spoon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-12 00:00:00.000000000 Z
+date: 2012-08-14 00:00:00.000000000 Z
 dependencies: []
 description: ! "\n      BigSpoon will add a hooks method to every class. Call that
   method with a block and add all kinds of fun hooks before and after your methods.\n
@@ -49,7 +49,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3518133336514115333
+      hash: 2835356473338463026
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: