merb_sequel 0.9.5 → 0.9.6

data/Rakefile

@@ -18,7 +18,7 @@ GEM_EMAIL  = "wayneeseguin@gmail.com, lancecarlson@gmail.com"
 
 GEM_NAME    = "merb_sequel"
 PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-GEM_VERSION = (Merb::MORE_VERSION rescue "0.9.5") + PKG_BUILD
+GEM_VERSION = (Merb::MORE_VERSION rescue "0.9.6") + PKG_BUILD
 
 RELEASE_NAME    = "REL #{GEM_VERSION}"
 
@@ -36,7 +36,7 @@ spec = Gem::Specification.new do |s|
   s.author = GEM_AUTHOR
   s.email = GEM_EMAIL
   s.homepage = PROJECT_URL
-  s.add_dependency("merb-core", ">= 0.9.5")
+  s.add_dependency("merb-core", ">= 0.9.6")
   s.add_dependency("sequel",    ">= 1.4.0")
   s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs,sequel_generators}/**/*")
 end
@@ -50,13 +50,13 @@ end
 ##############################################################################
 desc "Install the gem"
 task :install => [:package] do
-  sh %{#{sudo} gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}
+  sh install_command(GEM_NAME, GEM_VERSION)
 end
 
 namespace :jruby do
   desc "Run :package and install the resulting .gem with jruby"
   task :install => :package do
-    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+    sh jinstall_command(GEM_NAME, GEM_VERSION)
   end
 end
 

data/lib/merb/orms/sequel/connection.rb

@@ -1,4 +1,5 @@
 require "fileutils"
+require "sequel"
 
 module Merb
   module Orms
@@ -15,9 +16,7 @@ module Merb
         end
       
         def config
-
-          @config ||=
-          begin
+          @config ||= begin
             # Convert string keys to symbols
             full_config = Erubis.load_yaml_file(config_file)
             config = (Merb::Plugins.config[:merb_sequel] = {})
@@ -26,14 +25,10 @@ module Merb
             end
             config
           end
-
         end
       
         # Database connects as soon as the gem is loaded
         def connect
-          
-          require "sequel"
-
           if File.exists?(config_file)
             Merb.logger.info!("Connecting to the '#{config[:database]}' database on '#{config[:host]}' using '#{config[:adapter]}' ...")
             connection = ::Sequel.connect(config_options(config))
@@ -46,11 +41,9 @@ module Merb
             Merb.logger.error! "A sample file was created called config/database.yml.sample for you to copy and edit."
             exit(1)
           end
-          
         end
         
         def config_options(config = {})
-          
           options = {}
           options[:adapter]  = (config[:adapter]  || "sqlite")
           options[:host]     = (config[:host]     || "localhost")
@@ -63,16 +56,6 @@ module Merb
           options[:logger]   = Merb.logger
           options
         end
-        
-        # Registering this ORM lets the user choose sequel as a session store
-        # in merb.yml's session_store: option.
-        def register_session_type
-          Merb.register_session_type(
-          "sequel",
-          "merb/session/sequel_session",
-          "Using Sequel database sessions"
-          )
-        end
 
       end
       

data/lib/merb/session/sequel_session.rb

@@ -1,156 +1,106 @@
-require "base64"
+require 'sequel'
+require 'merb-core/dispatch/session'
+require 'base64'
 
 module Merb
 
-  module SessionMixin
-    def setup_session
-      before = cookies[_session_id_key]
-      request.session, cookies[_session_id_key] = Merb::SequelSession.persist(cookies[_session_id_key])
-      @_fingerprint = Marshal.dump(request.session.data).hash
-      @_new_cookie = cookies[_session_id_key] != before
-    end
-
-    def finalize_session
-      request.session.save if @_fingerprint != Marshal.dump(request.session.data).hash
-      set_cookie(_session_id_key, request.session.values[:session_id], Time.now + _session_expiry) if (@_new_cookie || request.session.needs_new_cookie)
-    end
-    
-    def session_store_type
-      "sequel"
-    end
-
-  end
-
   table_name = (Merb::Plugins.config[:merb_sequel][:session_table_name] || "sessions")
 
-  class SequelSession < Sequel::Model(table_name.to_sym)
+  # Sessions stored in Sequel model.
+  #
+  # To use Sequel based sessions add the following to config/init.rb:
+  #
+  # Merb::Config[:session_store] = 'sequel'
+
+  class SequelSessionStore < Sequel::Model(table_name.to_sym)
     
     set_schema do
       primary_key :id
       varchar :session_id
-      varchar :data
+      text :data
       timestamp :created_at
     end
 
-    attr_accessor :needs_new_cookie
-
     class << self
-      # Generates a new session ID and creates a row for the new session in the database.
-      def generate
-        create(:session_id => Merb::SessionMixin::rand_uuid,
-        :data => marshal({}), :created_at => Time.now)
+      
+      # ==== Parameters
+      # session_id<String>:: ID of the session to retrieve.
+      #
+      # ==== Returns
+      # ContainerSession:: The session corresponding to the ID.
+      def retrieve_session(session_id)
+        if item = find(:session_id => session_id)
+          item.data
+        end
       end
 
-      # Gets the existing session based on the <tt>session_id</tt> available in cookies.
-      # If none is found, generates a new session.
-      def persist(session_id)
-        if session_id
-          session = find(:session_id => session_id)
+      # ==== Parameters
+      # session_id<String>:: ID of the session to set.
+      # data<ContainerSession>:: The session to set.
+      def store_session(session_id, data)
+        if item = find(:session_id => session_id)
+          item.update(:data => data)
+        else
+          create(:session_id => session_id, :data => data, :created_at => Time.now)
         end
-        unless session
-          session = generate
-        end
-        [session, session.values[:session_id]]
       end
 
-      # Don't try to reload ARStore::Session in dev mode.
-      def reloadable?
-        false
+      # ==== Parameters
+      # session_id<String>:: ID of the session to delete.
+      def delete_session(session_id)
+        if item = find(:session_id => session_id)
+          item.delete
+        end
       end
-
+    
+      # ==== Returns
+      # Integer:: The maximum length of the 'data' column.
       def data_column_size_limit
-        255
-      end
-
-      def marshal(data)
-        Base64.encode64(Marshal.dump(data)) if data
-      end
-
-      def unmarshal(data)
-        Marshal.load(Base64.decode64(data)) if data
+        512 # TODO - figure out how much space we actually have
       end
 
       alias :create_table! :create_table
       alias :drop_table! :drop_table
     end
 
-    # Regenerate the Session ID
-    def regenerate
-      update_attributes(:session_id => Merb::SessionMixin::rand_uuid)
-      self.needs_new_cookie = true
-    end 
-
-    # Recreates the cookie with the default expiration time 
-    # Useful during log in for pushing back the expiration date 
-    def refresh_expiration
-      self.needs_new_cookie = true
-    end
-
-    # Lazy-delete of session data 
-    def delete(key = nil)
-      key ? self.data.delete(key) : self.data.clear
-    end
-
-    def [](key)
-      data[key]
-    end
-
-    def []=(key, val)
-      data[key] = val
-    end
-
-    def empty?
-      data.empty?
-    end
-
-    def each(&b)
-      data.each(&b)
+    # Lazy-unserialize session state.
+    def data
+      @data ||= (@values[:data] ? Marshal.load(@values[:data]) : {})
     end
     
-    def each_with_index(&b)
-      data.each_with_index(&b)
-    end
-
-    # Lazy-unmarshal session state.
-    def data
-      @data ||= self.class.unmarshal(@values[:data]) || {}
+    # Virtual attribute writer - override.
+    def data=(hsh)
+      @data = hsh if hsh.is_a?(Hash)
     end
 
     # Has the session been loaded yet?
     def loaded?
-      !! @data
+      !!@data
     end
 
-    private
-
-    attr_writer :data
-
-    before_save do # marshal_data!
-      # return false if !loaded?
-      @values[:data] = self.class.marshal(self.data)
+    before_save do 
+      @values[:data] = Marshal.dump(self.data)
+      if @values[:data].size > self.class.data_column_size_limit
+        raise Merb::SessionMixin::SessionOverflow
+      end    
     end
-
-    # Ensures that the data about to be stored in the database is not
-    # larger than the data storage column. Raises
-    # ActionController::SessionOverflowError.
-    # before_save do # raise_on_session_data_overflow!
-    # return false if !loaded?
-    # limit = self.class.data_column_size_limit
-    # if loaded? and limit and read_attribute(@@data_column_name).size > limit
-    # raise MerbController::SessionOverflowError
-    # end
-    # end
     
   end
 
   unless Sequel::Model.db.table_exists?(table_name.to_sym)
     puts "Warning: The database did not contain a '#{table_name}' table for sessions."
-
-    SequelSession.class_eval do
-      create_table unless table_exists?
-    end
-
+    SequelSessionStore.class_eval { create_table unless table_exists? }
     puts "Created sessions table."
   end
+  
+  class SequelSession < SessionStoreContainer
+    
+    # The session store type
+    self.session_store_type = :sequel
+    
+    # The store object is the model class itself
+    self.store = SequelSessionStore
+    
+  end
 
 end

data/lib/merb_sequel.rb

@@ -9,7 +9,10 @@ if defined?(Merb::Plugins)
 
     def self.run
       Merb::Orms::Sequel.connect
-      Merb::Orms::Sequel.register_session_type
+      if Merb::Config.session_stores.include?(:sequel)
+        Merb.logger.debug "Using Sequel sessions"
+        require File.join(File.dirname(__FILE__) / "merb" / "session" / "sequel_session")
+      end
     end
 
   end

data/specs/merb_sequel_session_spec.rb

@@ -0,0 +1,46 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'merb-core'
+require 'merb-core/test'
+require 'merb-core/test/helpers'
+
+Merb::BootLoader.before_app_loads do
+  require 'sequel'
+  DB = Sequel.sqlite
+  require "merb/session/sequel_session"
+end
+
+Merb.start :environment => 'test', :adapter => 'runner', :session_store => 'sequel'
+
+Spec::Runner.configure do |config|
+  config.include Merb::Test::RequestHelper
+end
+
+# Load up the shared specs from merb-core
+if (gem_spec = Gem.source_index.search('merb-core').last) && 
+  gem_spec.files.include?('spec/public/session/controllers/sessions.rb')
+  require gem_spec.full_gem_path / 'spec/public/session/controllers/sessions.rb'
+  require gem_spec.full_gem_path / 'spec/public/session/session_spec.rb' 
+end
+
+describe Merb::SequelSession do
+
+  before do 
+    @session_class = Merb::SequelSession
+    @session = @session_class.generate
+  end
+
+  it_should_behave_like "All session-store backends"
+
+  it "should have a session_store_type class attribute" do
+    @session.class.session_store_type.should == :sequel
+  end
+
+end
+
+describe Merb::SequelSession, "mixed into Merb::Controller" do
+
+  before(:all) { @session_class = Merb::SequelSession }
+
+  it_should_behave_like "All session-stores mixed into Merb::Controller"
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: merb_sequel
 version: !ruby/object:Gem::Version 
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors: 
 - Wayne E. Seguin, Lance Carlson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-21 00:00:00 +03:00
+date: 2008-09-08 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.5
+        version: 0.9.6
     version: 
 - !ruby/object:Gem::Dependency 
   name: sequel
@@ -85,6 +85,7 @@ files:
 - lib/merb_sequel
 - lib/merb_sequel/merbtasks.rb
 - lib/merb_sequel.rb
+- specs/merb_sequel_session_spec.rb
 - specs/merb_sequel_spec.rb
 - specs/spec_helper.rb
 has_rdoc: true