sentinel 0.1.0 → 0.2.0

data/README.textile

@@ -14,9 +14,9 @@ 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 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 method called *_notify_* (which can be a class or instance method). All the observed method's arguments will be passed to this method, hence the _args_ splat.
+To use it, first you'll need an observer class that responds to a class method called *_notify_*. All the observed method's arguments will be passed to this method, hence the _args_ splat.
 
 <pre>
 class MyObserver
@@ -26,12 +26,25 @@ class MyObserver
 end
 </pre>
 
-Then, simple include the _Sentinel_ module in the class and declare the observer. Sentinel can observe both class and instance methods:
+Then, simply include the _Sentinel_ module in the observer, setting up the desired class (or classes) and method (or methods) to be observed.
 
 <pre>
-class MyClass
+class MyObserver
   include Sentinel
 
+  observe MyClass, :instance_method
+  observe MyClass, :class_method, :class_method => true #to observe a class method
+
+  def self.notify(*args)
+    puts "Do your thing!"
+  end
+end
+</pre>
+
+As you can see, Sentinel can observe both class and instance methods. Now, our actual class:
+
+<pre>
+class MyClass
   def instance_method
     puts "Hi from the instance method!"
   end
@@ -39,25 +52,13 @@ class MyClass
   def self.class_method
     puts "Hi from the class method!"
   end
-
-  observe :instance_method, :notify => MyObserver
-  observe :class_method, :notify => MyObserver, :class_method => true #to observe a class method
 end
 </pre>
 
-If we wanted to use instances of the Observer instead of the class itself, the declarations would be:
-
-<pre>
-  observe :instance_method, :notify => MyObserver.new
-  observe :class_method, :notify => MyObserver.new, :class_method => true #to observe a class method
-</pre>
-  
-In summary, any object that responds to *_notify_* will be accepted.
-
-And... that's it! Every time the observed method is called, the _notify_ method from the defined Observer will be called *before* it, then it will run normally.
+And... that's it! Every time the observed method is called, the _notify_ method from the defined _observer class_ will be called *before* it, then it will run normally.
 
 h2. Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

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

data/lib/metaid.rb

@@ -0,0 +1,17 @@
+# Code by why_the_lucky_stiff
+
+class Object
+  # The hidden singleton lurks behind everyone
+  def metaclass; class << self; self; end; end
+  def meta_eval &blk; metaclass.instance_eval &blk; end
+
+  # Adds methods to a metaclass
+  def meta_def name, &blk
+    meta_eval { define_method name, &blk }
+  end
+
+  # Defines an instance method within a class
+  def class_def name, &blk
+    class_eval { define_method name, &blk }
+  end
+end

data/lib/sentinel.rb

@@ -1,33 +1,30 @@
+require "metaid"
+
 module Sentinel
   def self.included(base)
     base.extend(ClassMethods)
   end
-  
+
   module ClassMethods
-    def observe(method_name, options = {})
-      unless options[:notify]
-        raise ArgumentError.new("You should provide the :notify option")
-      end
+    def observe(class_name, method_name, options = {})
+      sentinel = self
+
       body = <<-CODE
         define_method "#{method_name}_with_observer" do |*args|
-          options[:notify].notify(*args)
+          sentinel.notify(*args)
           self.send("#{method_name}_without_observer", *args)
         end
 
         alias_method "#{method_name}_without_observer", method_name
         alias_method method_name, "#{method_name}_with_observer"
       CODE
-      
-      if options[:class_method]
-
-        metaclass = class << self; self; end
 
-        metaclass.instance_eval do
+      if options[:class_method]
+        class_name.meta_eval do
           eval body
         end
-        
       else
-        eval body
+        class_name.send(:class_eval, body)
       end
     end
   end

data/sentinel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sentinel}
-  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 = ["Lucas H\303\272ngaro"]
-  s.date = %q{2010-01-19}
+  s.date = %q{2010-03-02}
   s.description = %q{Transparent (unobtrusive) Observers for your Ruby code}
   s.email = %q{lucashungaro@gmail.com}
   s.extra_rdoc_files = [
@@ -23,10 +23,11 @@ Gem::Specification.new do |s|
      "README.textile",
      "Rakefile",
      "VERSION",
+     "lib/metaid.rb",
      "lib/sentinel.rb",
      "sentinel.gemspec",
      "spec/fixtures/my_observer.rb",
-     "spec/fixtures/subject.rb",
+     "spec/fixtures/sentinel_subject.rb",
      "spec/sentinel_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -34,11 +35,11 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/lucashungaro/sentinel}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  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/subject.rb",
+     "spec/fixtures/sentinel_subject.rb",
      "spec/sentinel_spec.rb",
      "spec/spec_helper.rb"
   ]

data/spec/fixtures/{subject.rb → sentinel_subject.rb}

@@ -1,4 +1,4 @@
-class Subject
+class SentinelSubject
   def instance_method
     "hi from instance method!"
   end

data/spec/sentinel_spec.rb

@@ -1,46 +1,46 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require File.expand_path(File.dirname(__FILE__) + '/fixtures/my_observer')
-require File.expand_path(File.dirname(__FILE__) + '/fixtures/subject')
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/sentinel_subject')
 
 describe Sentinel, "defining an observer for a method" do
   before(:all) do
-    Subject.send(:include, Sentinel)
+    MyObserver.send(:include, Sentinel)
   end
   
   context "with the minimum required options" do
     it "should notify the specified Observer when calling a class method" do
-      Subject.send(:observe, :instance_method, :notify => MyObserver)
+      MyObserver.send(:observe, SentinelSubject, :instance_method)
       MyObserver.expects(:notify)
 
-      Subject.new.instance_method
+      SentinelSubject.new.instance_method
     end
     
     it "should notify the specified Observer when calling an instance method" do
-      Subject.send(:observe, :class_method, :notify => MyObserver, :class_method => true)
+      MyObserver.send(:observe, SentinelSubject, :class_method, :class_method => true)
       MyObserver.expects(:notify)
       
-      Subject.class_method
+      SentinelSubject.class_method
     end
     
     it "should not modify the observed methods output" do
-      Subject.send(:observe, :class_returning_something, :notify => MyObserver, :class_method => true)
-      Subject.send(:observe, :instance_returning_something, :notify => MyObserver)
+      MyObserver.send(:observe, SentinelSubject, :class_returning_something, :class_method => true)
+      MyObserver.send(:observe, SentinelSubject, :instance_returning_something)
       
       MyObserver.expects(:notify).twice
 
-      Subject.class_returning_something.should == 42
-      Subject.new.instance_returning_something.should == 42
+      SentinelSubject.class_returning_something.should == 42
+      SentinelSubject.new.instance_returning_something.should == 42
     end
     
     context "observing methods with parameters" do
       it "should pass all parameters of the observed methods to the Observer" do
-        Subject.send(:observe, :class_method_with_params, :notify => MyObserver, :class_method => true)
-        Subject.send(:observe, :instance_method_with_params, :notify => MyObserver)
+        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.class_method_with_params("texto", 1)
-        Subject.new.instance_method_with_params("texto", 1)
+        SentinelSubject.class_method_with_params("texto", 1)
+        SentinelSubject.new.instance_method_with_params("texto", 1)
       end
     end
   end
@@ -48,16 +48,16 @@ describe Sentinel, "defining an observer for a method" do
   context "without the minimum required options" do
     it "should raise ArgumentError when the observer of an instance method is not defined" do
       MyObserver.expects(:notify).never
-      Subject.expects(:observe).raises(ArgumentError)
+      SentinelSubject.expects(:observe).raises(ArgumentError)
       
-      Subject.send(:observe, :instance_method) rescue nil
+      SentinelSubject.send(:observe, :instance_method) rescue nil
     end
 
     it "should raise ArgumentError when the observer of a class method is not defined" do
       MyObserver.expects(:notify).never
-      Subject.expects(:observe).raises(ArgumentError)
+      SentinelSubject.expects(:observe).raises(ArgumentError)
       
-      Subject.send(:observe, :class_method, :class_method => true) rescue nil
+      SentinelSubject.send(:observe, :class_method, :class_method => true) rescue nil
     end
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sentinel
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Lucas H\xC3\xBAngaro"
@@ -9,29 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 -02:00
+date: 2010-03-02 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
         version: 0.9.8
-    version: 
+  type: :development
+  version_requirements: *id002
 description: Transparent (unobtrusive) Observers for your Ruby code
 email: lucashungaro@gmail.com
 executables: []
@@ -48,10 +61,11 @@ files:
 - README.textile
 - Rakefile
 - VERSION
+- lib/metaid.rb
 - lib/sentinel.rb
 - sentinel.gemspec
 - spec/fixtures/my_observer.rb
-- spec/fixtures/subject.rb
+- spec/fixtures/sentinel_subject.rb
 - spec/sentinel_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -68,23 +82,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Transparent (unobtrusive) Observers for your Ruby code
 test_files: 
 - spec/fixtures/my_observer.rb
-- spec/fixtures/subject.rb
+- spec/fixtures/sentinel_subject.rb
 - spec/sentinel_spec.rb
 - spec/spec_helper.rb