tpitale-dm_session_store 0.1.0 → 0.2.0

data/README.textile

@@ -2,45 +2,51 @@ h1. DmSessionStore
 
 h2. Description
 
-  For those using DataMapper with Rails there was no option for storing sessions
-  in a database (most people remove ActiveRecord). This little gem adds the
-  required classes to use DataMapper to store sessions in the database.
+For those using DataMapper with Rails there was no option for storing sessions
+in a database (most people remove ActiveRecord). This little gem adds the
+required classes to use DataMapper to store sessions in the database.
+
+Now supports Rails >= 2.3.0 in version 0.2.0. If you need support before that,
+try version 0.1.0.
 
 h2. Installation
 
-    sudo gem install tpitale-dm_session_store
+  sudo gem install tpitale-dm_session_store
 
 h2. Usage
 
-  In Rails config/environment.rb
+In Rails config/environment.rb
+
+  config.gem 'tpitale-dm_session_store, :lib => 'dm_session_store'
+
+In the session_store initializer:
 
-    config.gem 'tpitale-dm_session_store, :lib => 'dm_session_store'
-    config.action_controller.session_store = CGI::Session::DMSessionStore
+  ActionController::Base.session_store = DataMapper::SessionStore
 
-  Obviously, for this to work, you had better follow one of the many online
-  resources for using DataMapper with Rails.
+Obviously, for this to work, you had better follow one of the many online
+resources for using DataMapper with Rails.
 
 h2. License
 
-  Copyright (c) 2009 Tony Pitale
-
-  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.
+Copyright (c) 2009 Tony Pitale
+
+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

@@ -17,6 +17,7 @@ spec = Gem::Specification.new do |s|
   s.test_files      = Dir.glob("test/**/*_test.rb")
   
   s.add_dependency('dm-core', '~> 0.9.11')
+  s.add_dependency('actionpack', '~> 2.3.0')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/lib/dm_session_store/session_store.rb

@@ -0,0 +1,37 @@
+require 'dm-core'
+
+module DataMapper
+  class SessionStore < ActionController::Session::AbstractStore
+    class Session
+      include DataMapper::Resource
+
+      property :session_id, String, :size => 32, :nullable => false, :key => true
+      property :data, Object, :default => {}, :lazy => false
+      property :created_at, DateTime, :default => Proc.new { |r, p| DateTime.now }
+    end
+
+    # The class used for session storage.
+    cattr_accessor :session_class
+    self.session_class = Session
+
+    SESSION_RECORD_KEY = 'rack.session.record'.freeze
+
+    private
+    def get_session(env, sid)
+      session = find_session(sid)
+      env[SESSION_RECORD_KEY] = session
+      [sid, session.data]
+    end
+
+    def set_session(env, sid, session_data)
+      record = env[SESSION_RECORD_KEY] ||= find_session(sid)
+      record.data = session_data
+      record.save
+    end
+
+    def find_session(id)
+      @@session_class.first(:session_id => id) ||
+        @@session_class.new(:session_id => id, :data => {})
+    end
+  end
+end

data/lib/dm_session_store/version.rb

@@ -2,7 +2,7 @@ module DmSessionStore
   module Version
     
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
     
     def self.to_s # :nodoc:

data/lib/dm_session_store.rb

@@ -1,3 +1,3 @@
 $:.unshift File.dirname(__FILE__)
 
-require 'dm_session_store/session_ext'
+require 'dm_session_store/session_store'

data/test/unit/dm_session_store_test.rb

@@ -1,61 +1,35 @@
 require File.join(File.dirname(__FILE__), "..", "test_helper")
-require 'cgi'
-require 'cgi/session'
 
-class CGI
-  class Session
-
-    class DMSessionStoreTest < Test::Unit::TestCase
-      context "The DMSessionStore initialize method" do
-        should "raise CGI:Session::NoSession if session is not a new_session" do
-          DMSessionStore::DMSession.stubs(:find_by_session_id).with("1").returns(nil)
-          session = DMSessionStore::DMSession.new(:session_id => "1")
-          session.stubs(:new_session).with().returns(false)
-          assert_raise CGI::Session::NoSession, "uninitialized session" do
-            DMSessionStore.new(session)
-          end
-        end
+module DataMapper
+  class SessionStoreTest < Test::Unit::TestCase
+    context "An instance of the SessionStore class" do
+      setup do
+        @session_klass = SessionStore::Session
+        @session_store = SessionStore.new('app')
       end
 
-      context "An instance of the DMSessionStore class" do
-        setup do
-          @session = DMSessionStore::DMSession.new(:session_id => "1", :data => {:hello => 'world'})
-          DMSessionStore::DMSession.stubs(:find_by_session_id).with("1").returns(nil)
-          old_session = DMSessionStore::DMSession.new(:session_id => "1")
-          old_session.stubs(:new_session).with().returns(true)
-          DMSessionStore::DMSession.stubs(:new).with(:session_id => "1", :data => {}).returns(@session)
-          @session_store = DMSessionStore.new(old_session)
-        end
-
-        should "have the session" do
-          assert_equal @session, @session_store.model
-        end
-
-        should "return the data from session" do
-          assert_equal({:hello => 'world'}, @session_store.restore)
-        end
-
-        should "save the session" do
-          @session.expects(:save).with().returns(true)
-          assert_equal true, @session_store.update
-        end
-
-        should "save and unreference the session" do
-          @session_store.expects(:update)
-          @session_store.close
-          assert_equal nil, @session_store.model
-        end
+      should "get a session" do
+        env = {}
+        session = stub(:data => 'data')
+        @session_store.expects(:find_session).with(1).returns(session)
+        assert_equal([1, 'data'], @session_store.send(:get_session, env, 1))
+        assert_equal({'rack.session.record' => session}, env)
+      end
 
-        should "destroy and unreference the session" do
-          @session.expects(:destroy)
-          @session_store.delete
-          assert_equal nil, @session_store.model
-        end
+      should "set a session" do
+        env = {}
+        session = stub
+        session.expects(:data=).with({:color => 'yellow'})
+        session.stubs(:save).returns(true)
+        @session_store.expects(:find_session).with(1).returns(session)
+        assert @session_store.send(:set_session, env, 1, {:color => 'yellow'})
+        assert_equal({'rack.session.record' => session}, env)
+      end
 
-        should "log with DataMapper" do
-          DataMapper::Logger.expects(:new).with(STDERR, :fatal).returns('logger')
-          assert_equal 'logger', @session_store.send(:logger)
-        end
+      should "find a session" do
+        @session_klass.expects(:first).with(:session_id => 1).returns(nil)
+        @session_klass.expects(:new).with(:session_id => 1, :data => {}).returns('session')
+        assert_equal 'session', @session_store.send(:find_session, 1)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tpitale-dm_session_store
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tony Pitale
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-02 00:00:00 -07:00
+date: 2009-05-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.11
     version: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+    version: 
 description: 
 email: tpitale@gmail.com
 executables: []
@@ -34,7 +44,7 @@ files:
 - README.textile
 - Rakefile
 - lib/dm_session_store
-- lib/dm_session_store/session_ext.rb
+- lib/dm_session_store/session_store.rb
 - lib/dm_session_store/version.rb
 - lib/dm_session_store.rb
 - test/unit/dm_session_store_test.rb

data/lib/dm_session_store/session_ext.rb

@@ -1,85 +0,0 @@
-require 'cgi'
-require 'cgi/session'
-require 'dm-core'
-
-class CGI
-  class Session
-    attr_reader :data
-
-    # Return this session's underlying Session instance. Useful for the DB-backed session stores.
-    def model
-      @dbman.model if @dbman
-    end
-
-    class DMSessionStore
-      class DMSession
-        include DataMapper::Resource
-
-        storage_names[:default] = 'sessions'
-
-        property :session_id, String, :size => 32, :nullable => false, :key => true
-        property :data, Object, :default => {}, :lazy => false
-        property :created_at, DateTime, :default => Proc.new { |r, p| DateTime.now }
-
-        def self.find_by_session_id(session_id)
-          first(:session_id => session_id)
-        end
-      end
-      
-      # The class used for session storage.
-      cattr_accessor :session_class
-      self.session_class = DMSession
-
-      # Find or instantiate a session given a CGI::Session.
-      def initialize(session, option = nil)
-        session_id = session.session_id
-        unless @session = @@session_class.find_by_session_id(session_id)
-          unless session.new_session
-            raise CGI::Session::NoSession, 'uninitialized session'
-          end
-          @session = @@session_class.new(:session_id => session_id, :data => {})
-        end
-      end
-
-      # Access the underlying session model.
-      def model
-        @session
-      end
-
-      # Restore session state.  The session model handles unmarshaling.
-      def restore
-        if @session
-          @session.data
-        end
-      end
-
-      # Save session store.
-      def update
-        if @session
-          @session.save
-        end
-      end
-
-      # Save and close the session store.
-      def close
-        if @session
-          update
-          @session = nil
-        end
-      end
-
-      # Delete and close the session store.
-      def delete
-        if @session
-          @session.destroy
-          @session = nil
-        end
-      end
-
-      protected
-        def logger
-          DataMapper::Logger.new(STDERR, :fatal) rescue nil
-        end
-    end
-  end
-end