moorage-moorage-enlightened_observers 1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 ThriveSmart, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,49 @@
+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:
+"Garry Dolley's Let ActiveRecord Observers see controller context":http://scie.nti.st/2007/2/1/let-activerecord-observers-see-controller-context
+
+
+h2. Usage
+
+<pre>
+class MyController < ActionController::Base
+  include EnlightenedObservers
+
+  observer :my_observer
+end
+</pre>
+
+Now my_observer has access to a controller instance variable, which can be used to access the session.
+e.g. 
+
+
+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', :source => 'http://gems.github.com'
+end
+</pre>
+
+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>
+
+
+=======
+Copyright (c) 2008 ThriveSmart, LLC, based on code by Garry Dolley, released under the MIT license.

data/Rakefile

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rubygems/specification'
+# require 'spec/rake/spectask'
+require 'date'
+ 
+GEM = "enlightened_observers"
+HUMANIZED_GEM = "EnlightenedObservers"
+GEM_VERSION = "1.0.20080915"
+AUTHOR = "ThriveSmart, LLC"
+EMAIL = "developers@thrivesmart.com"
+HOMEPAGE = "http://www.github.com/moorage/enlightened_observers"
+SUMMARY = "Quick and easily share the controller information with observers, including session information."
+ 
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.rubyforge_project = GEM
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.textile', 'LICENSE']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.textile Rakefile) + Dir.glob("{lib,spec}/**/*")
+end
+ 
+desc "Run Specs"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "Generate Documentation"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = HUMANIZED_GEM
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << HUMANIZED_GEM
+  rdoc.rdoc_files.include(FileList[ 'lib/**/*.rb', 'README.textile', 'LICENSE'])
+end
+ 
+task :default => :spec
+task :specs => :spec
+ 
+# desc "Run all examples"
+# Spec::Rake::SpecTask.new('spec') do |t|
+#   t.spec_opts = ['--options','spec/spec.opts']
+#   t.spec_files = FileList['spec/**/*.rb']
+#   t.rcov = true
+# end
+ 
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+ 
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+ 
+task :bugs do
+  sh %{ditz html ; open html/index.html}
+end

data/lib/enlightened_observers.rb

@@ -0,0 +1,37 @@
+module EnlightenedObservers
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def observer(*observers)
+      super
+
+      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
+        end
+
+        around_filter(observer_instance, :only => configuration[:only])
+      end
+    end
+  end
+
+  module Enlightenment
+    def self.included(base)
+      base.module_eval do
+        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

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: moorage-moorage-enlightened_observers
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- ThriveSmart, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Quick and easily share the controller information with observers, including session information.
+email: developers@thrivesmart.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- lib/enlightened_observers.rb
+has_rdoc: false
+homepage: http://www.github.com/moorage/enlightened_observers
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Quick and easily share the controller information with observers, including session information.
+test_files: []
+