moorage-enlightened_observers 1.0.20080915 → 1.1

data/README.textile

@@ -2,27 +2,71 @@ h1. EnlightenedObservers
 
 This plugin makes it quick and easy to share the controller information with observers, including session information.  This is useful when observers need to report the current_user that made a certain action happen.
 
-The code and idea for this plugin comes from:
-http://scie.nti.st/2007/2/1/let-activerecord-observers-see-controller-context
+A sizable amount of the code and idea for this plugin comes from:
+"Garry Dolley's Let ActiveRecord Observers see controller context":http://scie.nti.st/2007/2/1/let-activerecord-observers-see-controller-context
 
 
 h2. Usage
 
-<code>
+<pre>
 class MyController < ActionController::Base
-  include EnlightenedObservers
+  enlighten_observer :my_observer<i>[, :my_second_observer]</i>
+end
+</pre>
+
+In your observers, also <code>include EnlightenedObservers::Enlightenment</code>:
 
-  observer :my_observer
+<pre>
+class MyObserver < ActiveRecord::Observer
+  include EnlightenedObservers::Enlightenment
+  
+<i>  def after_create(my)
+    ...
+  end</i>
 end
-</code>
+</pre>
 
-Now my_observer has access to a controller instance variable, which can be used to access the session.
-e.g. 
+Of course, you still have to initialize any observer the normal way in <code>config/environment.rb</code>
+
+<pre>
+  config.active_record.observers = :my_observer<i>[, :my_second_observer]</i>
+</pre>
 
 
 h2. Installation 
 
+To enable the library your Rails 2.1 (or greater) project, use the gem configuration method in "<code>config/environment.rb</code>"
+
+<pre>
+Rails::Initializer.run do |config|
+  config.gem 'moorage-enlightened_observers', :lib => 'enlightened_observers', :source => 'http://gems.github.com'
+end
+</pre>
+
+The <code>:lib</code> is important, because rails gets confused when the name of the gem is different from the library.
+
+And of course, run 
+
+<pre>
+  rake gems:install
+</pre>
+
+To get them installed on your system.
+
+Optionally, to unpack it into your application, just run:
+
+<pre>
+  rake gems:unpack GEM=moorage-enlightened_observers
+</pre>
+
+
+h2. How it Works
+
+By adding <code>include EnlightenedObservers::Enlightenment</code> to your Observer, an <code>attr_accessor</code> for <code>controllers</code> is added, which you can access any time from your Observer.  Depending on how your oberserver has been called, this variable might have been set, with the controller that was used to access and change the model this observer has been observing.
+
+By calling <code>enlighten_observer :my_observer<i>[, :my_second_observer]</i></code> in your controllers, you're adding an around_filter to the controller that sets and unsets the observers' controller accessor.  Each time a controller action is called, this around filter finds the currently running instance of the observer (using code copied from module <code>ActiveModel::Observing::ClassMethods</code>).
 
+NOTE: we could have had the <code>enlighten_observer</code> call actually do the <code>include EnlightenedObservers::Enlightenment</code> in the Observer - however, since your observer can be run even if the model was changed through something OTHER than a controller action, we chose to decouple the two calls.
 
 
 =======

data/Rakefile

@@ -7,7 +7,7 @@ require 'date'
  
 GEM = "enlightened_observers"
 HUMANIZED_GEM = "EnlightenedObservers"
-GEM_VERSION = "1.0.20080915"
+GEM_VERSION = "1.1"
 AUTHOR = "ThriveSmart, LLC"
 EMAIL = "developers@thrivesmart.com"
 HOMEPAGE = "http://www.github.com/moorage/enlightened_observers"

data/lib/enlightened_observers.rb

@@ -4,17 +4,15 @@ module EnlightenedObservers
   end
 
   module ClassMethods
-    def observer(*observers)
-      super
-
+    def enlighten_observer(*observers)
       configuration = observers.last.is_a?(Hash) ? observers.pop : {}
       observers.each do |observer|
-        observer_instance = Object.const_get(Inflector.classify(observer)).instance
-        class <<observer_instance
-          include Enlightenment
+        observer_instance = observer.to_s.camelize.constantize.instance
+        around_filter do |controller, action|
+          observer_instance.controller = controller
+          action.call
+          observer_instance.controller = controller # Other controllers can call this too!
         end
-
-        around_filter(observer_instance, :only => configuration[:only])
       end
     end
   end
@@ -25,13 +23,5 @@ module EnlightenedObservers
         attr_accessor :controller
       end
     end
-
-    def before(controller)
-      self.controller = controller
-    end
-
-    def after(controller)
-      self.controller = nil # Clean up for GC
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: moorage-enlightened_observers
 version: !ruby/object:Gem::Version 
-  version: 1.0.20080915
+  version: "1.1"
 platform: ruby
 authors: 
 - ThriveSmart, LLC