mongo_session_store-rails3 4.1.1 → 5.0.0

data/.travis.yml

@@ -1,17 +1,16 @@
 language: ruby
 script: "rake"
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
+  - 2.1.1
   - ruby-head
-  - rbx-19mode
   - jruby-19mode
   - jruby-head
 matrix:
   allow_failures:
     - rvm: jruby-head
-    - rvm: rbx-19mode
     - rvm: ruby-head
+    - rvm: rbx
 services:
   - mongodb

data/Gemfile

@@ -1,39 +1,41 @@
-source :rubygems
-
-MONGO_VERS = '1.8.0' unless defined? MONGO_VERS
+source 'https://rubygems.org'
 
 RAILS_VERS = case ENV['RAILS_VERS']
              when '3.1'
-               '~>3.1.0'
+               '~>3.1'
              when '3.2'
-               '~>3.2.0'
+               '~>3.2'
+             when '4.0'
+               '~>4.0'
+             when '4.1'
+               '~>4.1.0.rc1'
              when nil
                nil
              else
-               raise "Invalid RAILS_VERS.  Available versions are 3.1, and 3.2."
+               raise "Invalid RAILS_VERS.  Available versions are 3.2 and 4.0."
              end
 
-gemspec
+gemspec :name => 'mongo_session_store-rails4'
 
 group :development, :test do
   gem 'rake'
-  if !ENV['MONGO_SESSION_STORE_ORM'] || ENV['MONGO_SESSION_STORE_ORM'] == 'mongo_mapper'
-    gem 'mongo_mapper', '>= 0.10.1'
+  if ENV['MONGO_SESSION_STORE_ORM'] == 'mongo_mapper'
+    gem 'mongo_mapper', '>= 0.13.0.beta2'
   end
 
-  if !ENV['MONGO_SESSION_STORE_ORM'] || ENV['MONGO_SESSION_STORE_ORM'] == 'mongoid'
-    gem 'mongoid', '~> 3.0', :platforms => [:ruby_19, :jruby, :ruby_20]
+  if ENV['MONGO_SESSION_STORE_ORM'] == 'mongoid'
+    if ENV['RAILS_VERS'] =~ /4\.\d/
+      gem 'mongoid', '>= 4.0.0.beta1'
+    else
+      gem 'mongoid', '>= 3.1.0'
+    end
   end
 
-  if !ENV['MONGO_SESSION_STORE_ORM'] || ENV['MONGO_SESSION_STORE_ORM'] == 'mongo'
-    gem 'mongo',         MONGO_VERS
+  if ENV['MONGO_SESSION_STORE_ORM'] == 'mongo'
+    gem 'mongo'
   end
-  gem 'bson_ext',      MONGO_VERS, :platforms => :ruby
 
-  gem 'system_timer', :platforms => :ruby_18
-  gem 'rbx-require-relative', '0.0.5', :platforms => :ruby_18
-  gem 'ruby-debug',   :platforms => :ruby_18 unless ENV['TRAVIS']
-  gem 'debugger',     :platforms => :ruby_19 unless ENV['TRAVIS']
+  gem 'debugger', :platforms => [:ruby_19, :ruby_20, :ruby_21] unless ENV['TRAVIS']
 
   if RUBY_PLATFORM == 'java'
     gem 'jdbc-sqlite3'
@@ -45,6 +47,7 @@ group :development, :test do
     gem 'sqlite3' # for devise User storage
   end
   RAILS_VERS ? gem('rails', RAILS_VERS) : gem('rails')
+  gem 'minitest' if ENV['RAILS_VERS'] == '4.1'
 
   gem 'rspec-rails', '2.12.0'
   gem 'devise'

data/README.md

@@ -4,13 +4,17 @@
 
 MongoSessionStore is a collection of Rails-compatible session stores for MongoMapper and Mongoid, but also included is a generic Mongo store that works with any (or no!) Mongo ODM.
 
-MongoSessionStore is tested [on Travis CI](https://travis-ci.org/brianhempel/mongo_session_store) against Ruby 1.8.7, 1.9.3, 2.0.0, and JRuby. As of this writing, it also works on Rubinius in 1.9.
+MongoSessionStore is tested [on Travis CI](https://travis-ci.org/brianhempel/mongo_session_store) against Ruby 1.9.3, 2.0.0, 2.1.1, and JRuby with Rails 3.1 through 4.1.
+
+Mongoid users: This gem is compatible with both Mongoid 3 and 4.
 
 If this gem doesn't work for you, you might next try [mongo_sessions](https://github.com/biilmann/mongo_sessions).
 
+See the [Changelog](#changelog) if you need support for an older version of Ruby, Rails, or Mongoid.
+
 ## Usage
 
-MongoSessionStore is compatible with Rails 3.1 and 3.2. (Use [version 3.0.6](https://rubygems.org/gems/mongo_session_store-rails3/versions/3.0.6) if you need Rails 3.0 support.)
+MongoSessionStore is compatible with Rails 3.1 through 4.1.
 
 In your Gemfile:
 
@@ -18,7 +22,8 @@ In your Gemfile:
 gem "mongo_mapper"
 # or gem "mongoid"
 # or gem "mongo"
-gem "mongo_session_store-rails3"
+gem "mongo_session_store-rails4"
+# or gem "mongo_session_store-rails3"
 ```
 
 In the session_store initializer (config/initializers/session_store.rb):
@@ -35,8 +40,6 @@ MyApp::Application.config.session_store :mongo_store
 MongoStore::Session.database = Mongo::Connection.new.db('my_app_development')
 ```
 
-Note: If you choose to use `:mongo_store` you only need to set its database if you aren't using MongoMapper or Mongoid in your project.
-
 By default, the sessions will be stored in the "sessions" collection in MongoDB.  If you want to use a different collection, you can set that in the initializer:
 
 ```ruby
@@ -56,34 +59,13 @@ MongoidStore::Session.where(:updated_at.gt => 2.days.ago)
 MongoStore::Session.where('updated_at' => { '$gt' => 2.days.ago })
 ```
 
-Note that Mongoid 2 is no longer supported. Use [version 3.0.6](https://rubygems.org/gems/mongo_session_store-rails3/versions/3.0.6) if you use Mongoid and cannot upgrade to Mongoid 3.
-
-## Performance
-
-The following is the benchmark run with bson_ext installed.  Without bson_ext, speeds are about 10x slower.  The benchmark saves 2000 sessions (~12kb each) and then finds/reloads each one.
-
-    $ ruby perf/benchmark.rb
-    MongoMapperStore...
-    3.65ms per session save
-    2.25ms per session load
-               Total Size: 23648924
-             Object count: 2000
-      Average object size: 11824.462
-              Index sizes: {"_id_"=>172032}
-    MongoidStore...
-    2.59ms per session save
-    1.33ms per session load
-               Total Size: 23648924
-             Object count: 2000
-      Average object size: 11824.462
-              Index sizes: {"_id_"=>172032}
-    MongoStore...
-    1.42ms per session save
-    1.11ms per session load
-               Total Size: 23648924
-             Object count: 2000
-      Average object size: 11824.462
-              Index sizes: {"_id_"=>204800}
+## Changelog
+
+5.0.0 introduces Rails 4.0 and 4.1 support and Mongoid 4 support alongside the existing Rails 3.1, 3.2, and Mongoid 3 support. Ruby 1.8.7 support is dropped. The database is no longer set automatically for the MongoStore when MongoMapper or Mongoid is present. You have to set the database manually whenever you choose to use the vanilla MongoStore.
+
+The last version to support Ruby 1.8.7 is [version 4.1.1](https://rubygems.org/gems/mongo_session_store-rails3/versions/4.1.1).
+
+The last version to support Rails 3.0 or Mongoid 2 is [version 3.0.6](https://rubygems.org/gems/mongo_session_store-rails3/versions/3.0.6).
 
 ## Development
 
@@ -91,16 +73,16 @@ To run all the tests:
 
     rake
 
-To switch to the Gemfile.lock for a certain Rails version:
+To run the tests for a specific store (examples):
 
-    rake use_rails_31
-    rake use_rails_32
+    rake test_31_mongo
+    rake test_32_mongoid
+    rake test_40_mongoid
+    rake test_41_mongo_mapper
 
-To run the tests for a specific store:
+To see a list of all options for running tests, run
 
-    MONGO_SESSION_STORE_ORM=mongo_mapper bundle exec rspec spec
-    MONGO_SESSION_STORE_ORM=mongoid bundle exec rspec spec
-    MONGO_SESSION_STORE_ORM=mongo bundle exec rspec spec    
+    rake -T
     
 ## Previous contributors
 
@@ -115,7 +97,7 @@ MongoSessionStore started as a fork of the DataMapper session store, modified to
 
 ## License
 
-Copyright (c) 2011-2012 Brian Hempel
+Copyright (c) 2011-2014 Brian Hempel
 Copyright (c) 2010 Nicolas Mérouze
 Copyright (c) 2009 Chris Brickley
 Copyright (c) 2009 Tony Pitale

data/Rakefile

@@ -1,42 +1,42 @@
 require 'rubygems'
 require 'rake'
 require 'bundler'
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks :name => 'mongo_session_store-rails3'
 
 def run_with_output(command)
   puts "Running: #{command}"
   system(command)
 end
 
-def set_rails_version(rails_vers)
-  unless File.exists?("Gemfile_Rails_#{rails_vers}.lock")
-    run_with_output "export RAILS_VERS=#{rails_vers}; bundle update"
-    run_with_output "cp Gemfile.lock Gemfile_Rails_#{rails_vers}.lock"
+def set_versions(rails_vers, orm)
+  success = true
+  unless File.exists?("Gemfile_Rails_#{rails_vers}_#{orm}_#{RUBY_VERSION}.lock")
+    success &&= run_with_output("export RAILS_VERS=#{rails_vers}; export MONGO_SESSION_STORE_ORM=#{orm}; bundle update")
+    success &&= run_with_output("cp Gemfile.lock Gemfile_Rails_#{rails_vers}_#{orm}_#{RUBY_VERSION}.lock")
   else
-    run_with_output "rm Gemfile.lock"
-    run_with_output "cp Gemfile_Rails_#{rails_vers}.lock Gemfile.lock"    
+    success &&= run_with_output("rm Gemfile.lock")
+    success &&= run_with_output("cp Gemfile_Rails_#{rails_vers}_#{orm}_#{RUBY_VERSION}.lock Gemfile.lock")
   end
+  success
 end
 
-@rails_versions = ['3.1', '3.2']
+@rails_versions = ['3.1', '3.2', '4.0', '4.1']
+@orms = ['mongo_mapper', 'mongoid', 'mongo']
 
 task :default => :test_all
 
-desc 'Test each session store against Rails 3.1 and Rails 3.2'
+desc 'Test each session store against Rails 3.1, 3.2, 4.0, and 4.1'
 task :test_all do
   # inspired by http://pivotallabs.com/users/jdean/blog/articles/1728-testing-your-gem-against-multiple-rubies-and-rails-versions-with-rvm
 
-  orms = ['mongo_mapper', 'mongoid', 'mongo']
-  orms.delete('mongoid') if RUBY_VERSION < "1.9"
 
   @failed_suites = []
 
   @rails_versions.each do |rails_version|
+    @orms.each do |orm|
+      success = set_versions(rails_version, orm)
 
-    set_rails_version(rails_version)
-  
-    orms.each do |orm|
-      unless run_with_output "export MONGO_SESSION_STORE_ORM=#{orm}; bundle exec rspec spec"
+      unless success && run_with_output("export RAILS_VERS=#{rails_version}; export MONGO_SESSION_STORE_ORM=#{orm}; bundle exec rspec spec")
         @failed_suites << "Rails #{rails_version} / #{orm}"
       end
     end
@@ -54,13 +54,24 @@ task :test_all do
   end
 end
 
-
-
 @rails_versions.each do |rails_version|
+  @orms.each do |orm|
+    desc "Set Gemfile.lock to #{rails_version} with #{orm}"
+    task :"use_#{rails_version.gsub('.', '')}_#{orm}" do
+      set_versions(rails_version, orm)
+    end
 
-  desc "Set Rails version to #{rails_version}"
-  task :"use_rails_#{rails_version.gsub('.', '')}" do
-    set_rails_version(rails_version)
-  end
+    desc "Test against #{rails_version} with #{orm}"
+    task :"test_#{rails_version.gsub('.', '')}_#{orm}" do
+      set_versions(rails_version, orm)
+      success = run_with_output("export RAILS_VERS=#{rails_version}; export MONGO_SESSION_STORE_ORM=#{orm}; bundle exec rspec spec")
+      exit(1) unless success
+    end
 
+    desc "Rebundle for #{rails_version} with #{orm}"
+    task :"rebundle_#{rails_version.gsub('.', '')}_#{orm}" do
+      run_with_output "rm Gemfile_Rails_#{rails_version}_#{orm}_#{RUBY_VERSION}.lock Gemfile.lock"
+      set_versions(rails_version, orm)
+    end
+  end
 end

data/lib/mongo_session_store-rails3.rb

@@ -1,50 +1 @@
-require 'securerandom'
-
-$:.unshift File.dirname(__FILE__)
-
-module MongoSessionStore
-  autoload :VERSION, 'mongo_session_store/version'
-
-  def self.collection_name=(name)
-    @collection_name = name
-    
-    if defined?(MongoStore::Session)
-      MongoStore::Session.reset_collection
-    end
-
-    if defined?(MongoMapperStore::Session)
-      MongoMapperStore::Session.set_collection_name(name)
-    end
-
-    if defined?(MongoidStore::Session)
-
-      MongoidStore::Session.store_in :collection => MongoSessionStore.collection_name
-    end
-
-    @collection_name
-  end
-
-  def self.collection_name
-    @collection_name 
-  end
-  
-  # default collection name for all the stores
-  self.collection_name = "sessions"
-end
-
-# we don't use autoloading because of thread concerns
-# hence, this mess
-load_errors = []
-
-%w(mongo_mapper_store mongoid_store mongo_store).each do |store_name|
-  begin
-    require "mongo_session_store/#{store_name}"
-  rescue LoadError => e
-    load_errors << e
-  end
-end
-
-if load_errors.count == 3
-  message = "Could not load any session store!\n" + load_errors.map(&:message).join("\n")
-  raise LoadError, message
-end
+require 'mongo_session_store'

data/lib/mongo_session_store-rails4.rb

@@ -0,0 +1 @@
+require 'mongo_session_store'

data/lib/mongo_session_store.rb

@@ -0,0 +1,49 @@
+require 'securerandom'
+
+$:.unshift File.dirname(__FILE__)
+
+module MongoSessionStore
+  autoload :VERSION, 'mongo_session_store/version'
+
+  def self.collection_name=(name)
+    @collection_name = name
+    
+    if defined?(MongoStore::Session)
+      MongoStore::Session.reset_collection
+    end
+
+    if defined?(MongoMapperStore::Session)
+      MongoMapperStore::Session.set_collection_name(name)
+    end
+
+    if defined?(MongoidStore::Session)
+      MongoidStore::Session.store_in :collection => MongoSessionStore.collection_name
+    end
+
+    @collection_name
+  end
+
+  def self.collection_name
+    @collection_name 
+  end
+  
+  # default collection name for all the stores
+  self.collection_name = "sessions"
+end
+
+# we don't use autoloading because of thread concerns
+# hence, this mess
+load_errors = []
+
+%w(mongo_mapper_store mongoid_store mongo_store).each do |store_name|
+  begin
+    require "mongo_session_store/#{store_name}"
+  rescue LoadError => e
+    load_errors << e
+  end
+end
+
+if load_errors.count == 3
+  message = "Could not load any session store!\n" + load_errors.map(&:message).join("\n")
+  raise LoadError, message
+end

data/lib/mongo_session_store/mongo_store.rb

@@ -50,10 +50,6 @@ module ActionDispatch
         def self.database
           if @database
             @database
-          elsif defined?(MongoMapper)
-            MongoMapper.database
-          elsif defined?(Mongoid)
-            Mongoid.database
           else
             raise "MongoStore needs a database, e.g. MongoStore::Session.database = Mongo::Connection.new.db('my_app_development')"
           end

data/lib/mongo_session_store/mongoid_store.rb

@@ -4,6 +4,7 @@ require 'mongo_session_store/mongo_store_base'
 module ActionDispatch
   module Session
     class MongoidStore < MongoStoreBase
+      BINARY_CLASS = defined?(Moped::BSON::Binary) ? Moped::BSON::Binary : BSON::Binary
 
       class Session
         include Mongoid::Document
@@ -12,15 +13,38 @@ module ActionDispatch
         store_in :collection => MongoSessionStore.collection_name
 
         field :_id, :type => String
-
-        field :data, :type => Moped::BSON::Binary, :default => Moped::BSON::Binary.new(:generic, Marshal.dump({}))
-
-        attr_accessible :_id, :data
+        field :data, :type => BINARY_CLASS, :default => -> { marshaled_binary({}) }
+        attr_accessible :_id, :data if respond_to?(:attr_accessible)
+
+        def marshaled_binary(data)
+          self.class.marshaled_binary(data)
+        end
+
+        def self.marshaled_binary(data)
+          if BINARY_CLASS.to_s == 'BSON::Binary'
+            BSON::Binary.new(Marshal.dump(data), :generic)
+          else
+            Moped::BSON::Binary.new(:generic, Marshal.dump(data))
+          end
+        end
       end
 
       private
       def pack(data)
-        Moped::BSON::Binary.new(:generic, Marshal.dump(data))
+        session_class.marshaled_binary(data)
+      end
+
+      def unpack(packed)
+        return nil unless packed
+        Marshal.load(extract_data(packed))
+      end
+
+      def extract_data(packed)
+        if packed.class.to_s == 'BSON::Binary'
+          packed.data
+        else
+          packed.to_s
+        end
       end
     end
   end