sentinel 0.3.0 → 0.4.0

data/README.textile

@@ -14,34 +14,28 @@ First, install the gem:
 $ [sudo] gem install sentinel
 </pre>
 
-Then, add it as a dependency in your code using your favorite way (a simple require or mechanisms like the bundler gem).
+Then, add it as a dependency in your code using your favorite way (a simple require or mechanisms like the Bundler gem).
 
-To use it, first you'll need an observer class that responds to a class method called *_notify_* by default. All the observed method's arguments will be passed to this method, hence the _args_ splat.
-
-<pre>
-class MyObserver
-  def self.notify(*args)
-    puts "Do your thing!"
-  end
-end
-</pre>
-
-Then, simply include the _Sentinel_ module in the observer, setting up the desired class (or classes) and method (or methods) to be observed.
+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>
 class MyObserver
   include Sentinel
 
   observe MyClass, :instance_method
-  observe MyClass, :class_method, :class_method => true #to observe a class method
+  observe MyClass, :class_method, :method_to_notify => :notify_class_method, :class_method => true #to observe a class method
 
-  def self.notify(*args)
+  def self.notify(options, *args)
     puts "Do your thing!"
   end
+
+  def self.notify_class_method(options, *args)
+    puts "Called class_method!"
+  end
 end
 </pre>
 
-As you can see, Sentinel can observe both class and instance methods. Now, our actual class:
+As you can see, Sentinel can observe both class and instance methods. The _notify_ method is the default one if you don't specify the :method_to_notify option. Now, our actual class:
 
 <pre>
 class MyClass
@@ -55,18 +49,16 @@ class MyClass
 end
 </pre>
 
-And... that's it! Every time the observed method is called, by default the _notify_ method from the defined _observer class_ will be called *before* it, then it will run normally.
-
-You can also choose another method to call when the observed method is called, instead of the default _notify_ method:
+And... that's it! Every time the subject (in this case, MyClass) method is called, the specified observer method will be called *before* it, then it will run normally. 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 in case you want to use it, like below:
 
 <pre>
 class MyObserver
   include Sentinel
 
-  observe MyClass, :instance_method, :method_to_notify => :my_notifier
+  observe MyClass, :instance_method
 
-  def self.my_notifier(*args)
-    puts "Do your thing!"
+  def self.notify(options, *args)
+    puts "Called from #{options[:subject]} with arguments #{args.inspect}"
   end
 end
 </pre>

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/sentinel.rb

@@ -15,7 +15,8 @@ module Sentinel
 
       body = <<-CODE
         define_method "#{method_name}_with_observer" do |*args|
-          sentinel.send("#{options[:method_to_notify]}", *args)
+          observer_opt = {:subject => self}
+          sentinel.send("#{options[:method_to_notify]}", observer_opt, *args)
           self.send("#{method_name}_without_observer", *args)
         end
 

data/spec/fixtures/my_observer.rb

@@ -1,9 +1,9 @@
 class MyObserver
-  def self.notify(*args)
+  def self.notify(options, *args)
     "Observing!"
   end
 
-  def self.another_method(*args)
+  def self.another_method(options, *args)
     "Observing!"
   end
 end

data/spec/sentinel_spec.rb

@@ -37,10 +37,13 @@ describe Sentinel, "defining an observer for a method" do
         MyObserver.send(:observe, SentinelSubject, :class_method_with_params, :class_method => true)
         MyObserver.send(:observe, SentinelSubject, :instance_method_with_params)
 
-        MyObserver.expects(:notify).twice.with("texto", 1)
+        subject = SentinelSubject.new
+
+        MyObserver.expects(:notify).once.with({:subject => SentinelSubject}, "texto", 1)
+        MyObserver.expects(:notify).once.with({:subject => subject}, "texto", 1)
 
         SentinelSubject.class_method_with_params("texto", 1)
-        SentinelSubject.new.instance_method_with_params("texto", 1)
+        subject.instance_method_with_params("texto", 1)
       end
     end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - "Lucas H\xC3\xBAngaro"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-26 00:00:00 -03:00
+date: 2010-04-19 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,7 +63,6 @@ files:
 - VERSION
 - lib/metaid.rb
 - lib/sentinel.rb
-- sentinel.gemspec
 - spec/fixtures/my_observer.rb
 - spec/fixtures/sentinel_subject.rb
 - spec/sentinel_spec.rb

data/sentinel.gemspec

@@ -1,63 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{sentinel}
-  s.version = "0.3.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Lucas H\303\272ngaro"]
-  s.date = %q{2010-03-26}
-  s.description = %q{Transparent (unobtrusive) Observers for your Ruby code}
-  s.email = %q{lucashungaro@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.textile"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.textile",
-     "Rakefile",
-     "VERSION",
-     "lib/metaid.rb",
-     "lib/sentinel.rb",
-     "sentinel.gemspec",
-     "spec/fixtures/my_observer.rb",
-     "spec/fixtures/sentinel_subject.rb",
-     "spec/sentinel_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/lucashungaro/sentinel}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Transparent (unobtrusive) Observers for your Ruby code}
-  s.test_files = [
-    "spec/fixtures/my_observer.rb",
-     "spec/fixtures/sentinel_subject.rb",
-     "spec/sentinel_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
-    else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<mocha>, [">= 0.9.8"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<mocha>, [">= 0.9.8"])
-  end
-end
-