intercession 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+=== 1.0.0 (2009-02-24)
+
+* Birthday!

data/Manifest.txt

@@ -0,0 +1,9 @@
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+install.rb
+lib/intercession/lifecycle.rb
+lib/intercession/version.rb
+rails/init.rb
+session.template

data/README.rdoc

@@ -0,0 +1,66 @@
+= Intercession
+
+Treat your sessions like models, not hashes. Intercession mixes a module into
+the session on each request, allowing you to nicely encapsulate (and test!)
+lots of user and session-specific behavior.
+
+== Examples
+
+Check out [this gist](http://gist.github.com/44506).
+
+Unit tests for your session model! Mix it in to a Hash and go to town:
+
+    def setup
+      @session = Hash.new
+      @session.extend Transient::Session
+    end
+
+    def test_session_user_lazily_loads_from_user_id
+      assert_nil @session.user
+      @session[:user_id] = users(:default).id
+      assert_equal users(:default), @session.user
+    end
+
+== Installation
+
+Intercession works as a plugin or a gem. I've only used it as a plugin
+against Rails 2.2, though, so YMMV. If you install it as a plugin,
+it'll create you a stub session module in
+<tt>app/models/transient/session.rb</tt>. If you're using it as a gem,
+do it yourself. :)
+
+As a plugin:
+
+    $ script/plugin install git://github.com/jbarnette/intercession.git
+
+As a gem:
+
+    $ sudo gem install intercession
+
+If you're using Intercession as a gem, add it to the gem dependencies
+in one of your environment config files:
+
+    config.gem "intercession", :lib => "intercession/lifecycle"
+
+== License
+
+Copyright 2009 John Barnette <jbarnette@rubyforge.org>
+
+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/Rakefile

@@ -0,0 +1,18 @@
+require "rubygems"
+require "hoe"
+
+require "./lib/intercession/version.rb"
+
+Hoe::SUPPORTED_TEST_FRAMEWORKS[:helper] = "helper"
+
+Hoe.new "intercession", Intercession::VERSION do |p|
+  p.developer "John Barnette", "jbarnette@rubyforge.org"
+
+  p.url              = "http://github.com/jbarnette/intercession"
+  p.history_file     = "CHANGELOG.rdoc"
+  p.readme_file      = "README.rdoc"
+  p.extra_rdoc_files = [p.readme_file]
+  p.need_tar         = false
+  p.test_globs       = %w(test/**/*_test.rb)
+  p.testlib          = :helper
+end

data/install.rb

@@ -0,0 +1,11 @@
+source      = File.join File.dirname(__FILE__), "session.template"
+relative    = File.join "app", "models", "transient", "session.rb"
+destination = File.join Rails.root, relative
+
+if File.exist? destination
+  puts "#{relative} already exists, so I won't overwrite it."
+else
+  FileUtils.mkdir_p File.dirname(destination)
+  FileUtils.cp source, destination
+  puts "Installed an empty session module in #{destination}. Go edit it!"
+end

data/lib/intercession/lifecycle.rb

@@ -0,0 +1,23 @@
+module Intercession
+  module Lifecycle
+    def self.included klass
+      klass.prepend_before_filter :intercede_before
+      klass.append_after_filter :intercede_after
+    end
+
+    def intercede_before
+      session.extend Transient::Session
+
+      session.controller = self if session.respond_to?(:controller=)
+      session.request = request if session.respond_to?(:request=)
+      session.response = response if session.respond_to?(:response=)
+
+      session.after_initialize if session.respond_to? :after_initialize
+    end
+
+    def intercede_after
+      # FIXME: this obviously won't work with after filters in subclasses.
+      session.before_save if session.respond_to? :before_save
+    end
+  end
+end

data/lib/intercession/version.rb

@@ -0,0 +1,3 @@
+module Intercession
+  VERSION = "1.0.0"
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require "application"
+ApplicationController.send :include, Intercession::Lifecycle

data/session.template

@@ -0,0 +1,23 @@
+module Transient
+
+  # This module gets mixed in to the Rails session, and lets you
+  # treat the session more like a real object. Note that while most things
+  # this module is mixed in to are Hashlike, they vary in capabilitites.
+  # Safest to assume that the index[] op is the only thing that's available.
+
+  module Session
+    attr_accessor :controller, :request, :response
+
+    # Called by a before_filter in the application controller. A good place
+    # to eagerly populate member models from IDs, if you're not feeling lazy.
+
+    def after_initialize
+    end
+
+    # Called by an after_filter in the application controller. A good
+    # opportunity to turn heavy lists of stuff into IDs, etc.
+
+    def before_save
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: intercession
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- John Barnette
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.9.0
+    version: 
+description: ""
+email: 
+- jbarnette@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- install.rb
+- lib/intercession/lifecycle.rb
+- lib/intercession/version.rb
+- rails/init.rb
+- session.template
+has_rdoc: true
+homepage: http://github.com/jbarnette/intercession
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: intercession
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+