gabrielg-contexted_observers 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1.0. Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [Gabriel Gironda]
+
+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/Manifest

@@ -0,0 +1,17 @@
+CHANGELOG
+contexted_observers.gemspec
+lib/contexted_observers.rb
+lib/thumblemonks/contexted_observers/context.rb
+lib/thumblemonks/contexted_observers/modules.rb
+lib/thumblemonks/contexted_observers/shortcuts.rb
+LICENSE
+Manifest
+rails/action_controller_extensions.rb
+rails/active_record_observer_extensions.rb
+rails/init.rb
+Rakefile
+README.markdown
+test/action_controller_macro_test.rb
+test/active_record_observer_test.rb
+test/context_test.rb
+test/test_helper.rb

data/README.markdown

@@ -0,0 +1,22 @@
+# Contexted Observers
+
+I needed my Rails observers to have some context, and didn't want them to be aware of an entire controller or something equally jacked up. So here's something slightly less jacked up. At its basis, it provides a simple Context handler which has a stack of objects providing context. An example from the tests:
+
+    should "set the current context to be the last context hash" do
+      context, current_context = {:ashes => :ashes}, nil
+      ContextedObservers::Context.push_new(context) do
+        current_context = ContextedObservers::Context.current
+      end
+      assert_equal context, current_context
+    end
+    
+Current context becomes the hash {:ashes => :ashes}. Nesting another `push_new` will add another context to the stack and make it current. When combined with ActionController / ActiveRecord::Observer, it allows for things such as:
+
+    class BlockContextController < ActionController::Base
+      before_filter :load_community
+      contextualize :except => :bar do
+        {:community => @community}
+      end
+    end
+    
+This provides a hash with the current community, in this example, as the current context. There's a shortcut method on ActiveRecord::Observer to access this context. This is because sometimes traversing the associations to get a piece of context isn't always possible / doesn't always make sense.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'echoe'  
+Echoe.new('contexted_observers') do |p|
+  p.author = "Gabriel Gironda"
+  p.summary = "A library that gives observers some context."
+  p.url = "http://github.com/gabrielg/contexted_observers"
+  p.install_message = "CHOOSY MOMS CHOOSE THUMBLE MONKS"
+  p.development_dependencies = ["thoughtbot-shoulda >= 2.0.6"]
+end

data/contexted_observers.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{contexted_observers}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabriel Gironda"]
+  s.date = %q{2008-12-24}
+  s.description = %q{A library that gives observers some context.}
+  s.email = %q{}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/contexted_observers.rb", "lib/thumblemonks/contexted_observers/context.rb", "lib/thumblemonks/contexted_observers/modules.rb", "lib/thumblemonks/contexted_observers/shortcuts.rb", "LICENSE", "README.markdown"]
+  s.files = ["CHANGELOG", "contexted_observers.gemspec", "lib/contexted_observers.rb", "lib/thumblemonks/contexted_observers/context.rb", "lib/thumblemonks/contexted_observers/modules.rb", "lib/thumblemonks/contexted_observers/shortcuts.rb", "LICENSE", "Manifest", "rails/action_controller_extensions.rb", "rails/active_record_observer_extensions.rb", "rails/init.rb", "Rakefile", "README.markdown", "test/action_controller_macro_test.rb", "test/active_record_observer_test.rb", "test/context_test.rb", "test/test_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/gabrielg/contexted_observers}
+  s.post_install_message = %q{CHOOSY MOMS CHOOSE THUMBLE MONKS}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Contexted_observers", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{contexted_observers}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A library that gives observers some context.}
+  s.test_files = ["test/action_controller_macro_test.rb", "test/active_record_observer_test.rb", "test/context_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0", "= 2.0.6"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0", "= 2.0.6"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0", "= 2.0.6"])
+  end
+end

data/lib/contexted_observers.rb

@@ -0,0 +1,3 @@
+require 'thumblemonks/contexted_observers/modules'
+require 'thumblemonks/contexted_observers/context'
+require 'thumblemonks/contexted_observers/shortcuts'

data/lib/thumblemonks/contexted_observers/context.rb

@@ -0,0 +1,19 @@
+module Thumblemonks::ContextedObservers::Context
+  @@context_stack = []
+
+  def self.push_new(context = {})
+    @@context_stack.push(context.freeze)
+    yield
+  ensure
+    @@context_stack.pop
+  end
+  
+  def self.current
+    stack.last
+  end
+  
+  def self.stack
+    @@context_stack
+  end
+  
+end

data/lib/thumblemonks/contexted_observers/modules.rb

@@ -0,0 +1,3 @@
+module Thumblemonks
+  module ContextedObservers; end
+end

data/lib/thumblemonks/contexted_observers/shortcuts.rb

@@ -0,0 +1,15 @@
+module Thumblemonks
+  module ContextedObservers
+    module Shortcuts
+      
+      def self.included(base)
+        extend(Shortcuts)
+      end
+      
+      def context
+        Thumblemonks::ContextedObservers::Context.current
+      end
+      
+    end
+  end
+end

data/rails/action_controller_extensions.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+require 'action_controller'
+
+module Thumblemonks
+  module ContextedObservers    
+    module ActionControllerExtensions
+    
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        
+        def contextualize(options = {}, &block)
+          around_filter(options) do |controller, action|
+            context_val = controller.instance_eval(&block)
+            Thumblemonks::ContextedObservers::Context.push_new(context_val) { action.call }
+          end
+        end
+        
+      end # ClassMethods
+      
+    end   # ActionControllerExtensions
+  end     # ContextedObservers
+end       # Thumblemonks
+  
+ActionController::Base.send(:include, Thumblemonks::ContextedObservers::ActionControllerExtensions)

data/rails/active_record_observer_extensions.rb

@@ -0,0 +1,4 @@
+require 'active_record/observer'
+
+ActiveRecord::Observer.send(:include, Thumblemonks::ContextedObservers::Shortcuts)
+  

data/rails/init.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/active_record_observer_extensions'
+require File.dirname(__FILE__) + '/action_controller_extensions'

data/test/action_controller_macro_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+require 'active_record'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'action_controller/test_process'
+
+class BlockContextController < ActionController::Base
+  contextualize :except => :bar do
+    {:foo => :bar}
+  end
+  
+  def foo
+    render :text => Thumblemonks::ContextedObservers::Context.current.inspect
+  end
+  
+  def bar
+    render :text => Thumblemonks::ContextedObservers::Context.current.inspect
+  end
+  
+end
+
+class BlockContextControllerTest < ActionController::TestCase
+  
+  should "preload requested variable from block into the context" do
+    with_routing do |set|
+      set.draw do |map|
+        map.connect ':controller/:action/:id'
+        get :foo
+      end 
+    end
+    assert_equal({:foo => :bar}.inspect, @response.body)
+  end
+  
+  should "pass on the filter options to around_filter" do
+    with_routing do |set|
+      set.draw do |map|
+        map.connect ':controller/:action/:id'
+        get :bar
+      end 
+    end
+    assert_equal(nil.inspect, @response.body)
+  end
+  
+end
+
+# class ActiveRecordObserverTest < Test::Unit::TestCase
+#   include Thumblemonks
+#   class TestAR < ActiveRecord::Base; end
+#   class TestARObserver < ActiveRecord::Observer
+#   end
+#   
+#   context "active record observers" do
+#     setup { @instance = TestARObserver.instance }
+# 
+#     should "have an accessor for the current context" do
+#       context, last_context = {:you => :better}, nil
+#       ContextedObservers::Context.push_new(context) { last_context = @instance.context }
+#       assert_equal context, last_context
+#     end
+#     
+#   end # active record observers
+# end

data/test/active_record_observer_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+require 'active_record'
+
+class ActiveRecordObserverTest < Test::Unit::TestCase
+  include Thumblemonks
+  class TestAR < ActiveRecord::Base; end
+  class TestARObserver < ActiveRecord::Observer
+  end
+  
+  context "active record observers" do
+    setup { @instance = TestARObserver.instance }
+
+    should "have an accessor for the current context" do
+      context, last_context = {:you => :better}, nil
+      ContextedObservers::Context.push_new(context) { last_context = @instance.context }
+      assert_equal context, last_context
+    end
+    
+  end # active record observers
+end

data/test/context_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class ContextTest < Test::Unit::TestCase
+  include Thumblemonks
+
+  context "Context" do
+
+    should "have no contexts on the stack by default" do
+      assert ContextedObservers::Context.stack.empty?
+    end
+  
+    should "add a new context to the stack for every new context" do
+      context_count = 0
+      ContextedObservers::Context.push_new do
+        ContextedObservers::Context.push_new { context_count = ContextedObservers::Context.stack.size }
+      end
+      assert_equal 2, context_count
+    end
+  
+    should "set the current context to be the last context hash" do
+      context, current_context = {:ashes => :ashes}, nil
+      ContextedObservers::Context.push_new(context) do
+        current_context = ContextedObservers::Context.current
+      end
+      assert_equal context, current_context
+    end
+    
+    should "pop the last context off the stack after the block executes" do
+      context, deepest_context, last_context = {:fun => :funky}, {:we_know => :major_toms}, nil
+      ContextedObservers::Context.push_new(context) do
+        ContextedObservers::Context.push_new(deepest_context) { last_context = ContextedObservers::Context.current }
+        assert_equal context, ContextedObservers::Context.current
+      end
+      assert_equal last_context, deepest_context
+    end
+    
+    should "leave the context stack empty ocne all contexts have finished" do
+      ContextedObservers::Context.push_new({}) { }
+      assert ContextedObservers::Context.stack.empty?
+    end
+    
+    should "freeze contexts" do
+      ContextedObservers::Context.push_new({}) { assert ContextedObservers::Context.current.frozen? }
+    end
+    
+  end # Context contexts
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+$: << File.dirname(__FILE__) + "/.."
+$: << File.dirname(__FILE__) + "/../lib"
+require 'contexted_observers'
+require 'rails/init'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: gabrielg-contexted_observers
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabriel Gironda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.6
+    version: 
+description: A library that gives observers some context.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/contexted_observers.rb
+- lib/thumblemonks/contexted_observers/context.rb
+- lib/thumblemonks/contexted_observers/modules.rb
+- lib/thumblemonks/contexted_observers/shortcuts.rb
+- LICENSE
+- README.markdown
+files: 
+- CHANGELOG
+- contexted_observers.gemspec
+- lib/contexted_observers.rb
+- lib/thumblemonks/contexted_observers/context.rb
+- lib/thumblemonks/contexted_observers/modules.rb
+- lib/thumblemonks/contexted_observers/shortcuts.rb
+- LICENSE
+- Manifest
+- rails/action_controller_extensions.rb
+- rails/active_record_observer_extensions.rb
+- rails/init.rb
+- Rakefile
+- README.markdown
+- test/action_controller_macro_test.rb
+- test/active_record_observer_test.rb
+- test/context_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/gabrielg/contexted_observers
+post_install_message: CHOOSY MOMS CHOOSE THUMBLE MONKS
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Contexted_observers
+- --main
+- README.markdown
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: contexted_observers
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A library that gives observers some context.
+test_files: 
+- test/action_controller_macro_test.rb
+- test/active_record_observer_test.rb
+- test/context_test.rb
+- test/test_helper.rb