sentinel 0.5.0 → 0.6.0

data/README.textile

@@ -18,6 +18,13 @@ $ [sudo] gem install sentinel
 
 Then, add it as a dependency in your code using your favorite way (a simple require or mechanisms like the Bundler gem).
 
+On Rails, you can install as a plugin:
+
+<pre>
+$ cd your_rails_app
+$ ./script/plugin install http://github.com/lucashugaro/sentinel.git
+</pre>
+
 To use it, first you'll need an observer class with the Sentinel mixin. This class contains the methods to be notified and the configuration specifying what subject methods will be observed. See an example below:
 
 <pre>
@@ -28,11 +35,11 @@ class MyObserver
   observe MyClass, :class_method, :method_to_notify => :notify_class_method, :class_method => true #to observe a class method
 
   def self.notify(options, *args)
-    puts "Do your thing!"
+    puts "Do your thing! Called from #{options[:subject]}"
   end
 
   def self.notify_class_method(options, *args)
-    puts "Called class_method!"
+    puts "Called class_method! Returned #{options[:result]}"
   end
 end
 </pre>
@@ -51,20 +58,20 @@ class MyClass
 end
 </pre>
 
-And... that's it! Every time the subject (in this case, MyClass) method is called, the specified observer method will be called too. By default, the observer method is called *before* the subject method, but you can call it *after* the execution (will see it in the next example).
+And... that's it! Every time the subject (in this case, MyClass) method is called, the specified observer method will be called too. By default, the observer method is called *after* the subject method execution, but you can call it *before* it too (we'll see that in the next example).
 
-The parameters passed to the subject method are passed to the observer method via the *args array. The options hash contains the key :subject, which contains the actual subject object and the key :result, which contains the return of the observed method in case you intercepted the call after its execution.
+The parameters passed to the subject method are passed to the observer method via the *args array. The observer method also receives an options hash with the key :subject, which contains the actual subject object and the key :result, which contains the return of the observed method in case you intercepted the call after its execution.
 
-Below is a more "advanced" use of the observers:
+Below is an example showing the interception before the execution:
 
 <pre>
 class MyObserver
   include Sentinel
 
-  observe MyClass, :instance_method, :intercept => :after
+  observe MyClass, :instance_method, :intercept => :before
 
   def self.notify(options, *args)
-    puts "Called from #{options[:subject]} with arguments #{args.inspect} and returned #{options[:result]}"
+    puts "Called from #{options[:subject]} with arguments #{args.inspect}"
   end
 end
 </pre>
@@ -79,6 +86,10 @@ h2. Note on Patches/Pull Requests
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+h2. Contributors
+
+* "Celestino Gomes":http://twitter.com/tinogomes
+
 h3. Copyright
 
 Copyright (c) 2010 Lucas Húngaro. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/sentinel.rb

@@ -11,7 +11,7 @@ module Sentinel
 
       options = {
         :method_to_notify => :notify,
-        :intercept => :before
+        :intercept => :after
       }.merge(options)
 
       if options[:intercept] == :before

data/rails/init.rb

@@ -0,0 +1 @@
+require 'sentinel'

data/spec/sentinel_spec.rb

@@ -13,24 +13,28 @@ describe Sentinel do
   end
 
   context "basic premises" do
-    it "should not modify the subject method output when called before it" do
+    it "should not modify the subject method output when called after it" do
       MyObserver.send(:observe, SentinelSubject, :class_method, :class_method => true)
       MyObserver.send(:observe, SentinelSubject, :instance_method)
+      subject = SentinelSubject.new
 
-      MyObserver.expects(:notify).twice
+      MyObserver.expects(:notify).once.with({:result => 42, :subject => subject})
+      MyObserver.expects(:notify).once.with({:result => 42, :subject => SentinelSubject})
 
       SentinelSubject.class_method.should == 42
-      SentinelSubject.new.instance_method.should == 42
+      subject.instance_method.should == 42
     end
     
-    it "should not modify the subject method output when called after it" do
-      MyObserver.send(:observe, SentinelSubject, :class_method, :class_method => true, :intercept => :after)
-      MyObserver.send(:observe, SentinelSubject, :instance_method, :intercept => :after)
+    it "should not modify the subject method output when called before it" do
+      MyObserver.send(:observe, SentinelSubject, :class_method, :class_method => true, :intercept => :before)
+      MyObserver.send(:observe, SentinelSubject, :instance_method, :intercept => :before)
+      subject = SentinelSubject.new
 
-      MyObserver.expects(:notify).twice
+      MyObserver.expects(:notify).once.with({:subject => SentinelSubject})
+      MyObserver.expects(:notify).once.with({:subject => subject})
 
       SentinelSubject.class_method.should == 42
-      SentinelSubject.new.instance_method.should == 42
+      subject.instance_method.should == 42
     end
     
     it "should pass all parameters of the observed methods to the observer" do
@@ -39,8 +43,8 @@ describe Sentinel do
 
       subject = SentinelSubject.new
 
-      MyObserver.expects(:notify).once.with({:subject => SentinelSubject}, "texto", 1)
-      MyObserver.expects(:notify).once.with({:subject => subject}, "texto", 1)
+      MyObserver.expects(:notify).once.with({:result => 'hi from class method with params!', :subject => SentinelSubject}, "texto", 1)
+      MyObserver.expects(:notify).once.with({:result => 'hi from instance method with params!', :subject => subject}, "texto", 1)
 
       SentinelSubject.class_method_with_params("texto", 1)
       subject.instance_method_with_params("texto", 1)
@@ -62,11 +66,11 @@ describe Sentinel do
       SentinelSubject.class_method
     end
     
-    it "should be called before the method execution" do
+    it "should be called after the method execution" do
       MyObserver.send(:observe, SentinelSubject, :instance_method)
       subject = SentinelSubject.new
       
-      MyObserver.expects(:notify).once.with({:subject => subject})
+      MyObserver.expects(:notify).once.with({:result => 42, :subject => subject})
 
       subject.instance_method
     end
@@ -87,8 +91,8 @@ describe Sentinel do
     
     context "when intercepting the call after the method execution" do
       it "should pass the result of the execution to the observer" do
-        MyObserver.send(:observe, SentinelSubject, :instance_method, :intercept => :after)
-        MyObserver.send(:observe, SentinelSubject, :class_method, :intercept => :after, :class_method => true)
+        MyObserver.send(:observe, SentinelSubject, :instance_method)
+        MyObserver.send(:observe, SentinelSubject, :class_method, :class_method => true)
         
         subject = SentinelSubject.new
         

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sentinel
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - "Lucas H\xC3\xBAngaro"
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-26 00:00:00 -03:00
+date: 2010-06-10 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -35,9 +38,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
         - 9
@@ -63,6 +68,7 @@ files:
 - VERSION
 - lib/metaid.rb
 - lib/sentinel.rb
+- rails/init.rb
 - spec/fixtures/my_observer.rb
 - spec/fixtures/sentinel_subject.rb
 - spec/sentinel_spec.rb
@@ -78,23 +84,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Transparent (unobtrusive) Observers for your Ruby code