Merge pull request #66 from Partyista/master

sikachu · sikachu · commit 1f1999c54970 · 2016-02-04T10:11:59.000-05:00
Fix compatibility issue with Rails 5.0
diff --git a/.travis.yml b/.travis.yml
@@ -1,34 +1,36 @@
 language: ruby
 sudo: false
-
+cache: bundler
 rvm:
-  - 1.9.3
+  - 1.9
   - 2.0
   - 2.1
-  - 2.2
+  - 2.2.4
+  - 2.3.0
   - ruby-head
-
 gemfile:
-  - gemfiles/4.0.gemfile
-  - gemfiles/4.1.gemfile
-  - gemfiles/4.2.gemfile
-  - gemfiles/edge.gemfile
-
-notifications:
-  email: false
-
-before_install:
-  - gem install bundler
-
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_edge.gemfile
 matrix:
   fast_finish: true
   exclude:
-    - rvm: 1.9.3
-      gemfile: gemfiles/edge.gemfile
+    - rvm: 1.9
+      gemfile: gemfiles/rails_5.0.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/rails_5.0.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails_5.0.gemfile
+    - rvm: 1.9
+      gemfile: gemfiles/rails_edge.gemfile
     - rvm: 2.0
-      gemfile: gemfiles/edge.gemfile
+      gemfile: gemfiles/rails_edge.gemfile
     - rvm: 2.1
-      gemfile: gemfiles/edge.gemfile
+      gemfile: gemfiles/rails_edge.gemfile
   allow_failures:
     - rvm: ruby-head
-    - gemfile: gemfiles/edge.gemfile
+    - gemfile: gemfiles/rails_edge.gemfile
+notifications:
+  email: false
diff --git a/Appraisals b/Appraisals
@@ -1,17 +1,26 @@
-%w(4.0 4.1 4.2).each do |version|
-  appraise version do
-    gem "actionpack", "~> #{version}.0"
-    gem "activerecord", "~> #{version}.0"
-    gem "railties", "~> #{version}.0"
+[ '4.0', '4.1', '4.2' ].each do |ver|
+  appraise "rails-#{ver}" do
+    gem 'actionpack',   "~> #{ver}.0"
+    gem 'activerecord', "~> #{ver}.0"
+    gem 'railties',     "~> #{ver}.0"
+    gem 'rack',         '~> 1.5'
   end
 end
 
-appraise "edge" do
-  git "https://github.com/rails/rails.git" do
-    gem "actionpack"
-    gem "activerecord"
-    gem "railties"
+appraise 'rails-5.0' do
+  gem 'actionpack',   '>= 5.0.0.alpha', '< 5.1'
+  gem 'activerecord', '>= 5.0.0.alpha', '< 5.1'
+  gem 'railties',     '>= 5.0.0.alpha', '< 5.1'
+  gem 'rack',         '>= 2.0.0.alpha', '< 3'
+end
+
+appraise "rails-edge" do
+  git 'https://github.com/rails/rails.git', :branch => 'master' do
+    gem 'actionpack'
+    gem 'activerecord'
+    gem 'railties'
   end
 
-  gem "arel", github: "rails/arel"
+  gem 'rack', :git => 'https://github.com/rack/rack.git', :branch => 'master'
+  gem 'arel', :git => 'https://github.com/rails/arel.git', :branch => 'master'
 end
diff --git a/activerecord-session_store.gemspec b/activerecord-session_store.gemspec
@@ -17,10 +17,11 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = %w( README.md )
   s.rdoc_options.concat ['--main',  'README.md']
 
-  s.add_dependency('activerecord', '>= 4.0.0', '< 5')
-  s.add_dependency('actionpack', '>= 4.0.0', '< 5')
-  s.add_dependency('railties', '>= 4.0.0', '< 5')
+  s.add_dependency('activerecord', '>= 4.0', '< 5.1')
+  s.add_dependency('actionpack', '>= 4.0', '< 5.1')
+  s.add_dependency('railties', '>= 4.0', '< 5.1')
+  s.add_dependency('rack', '>= 1.5.2', '< 3')
 
   s.add_development_dependency('sqlite3')
-  s.add_development_dependency('appraisal')
+  s.add_development_dependency('appraisal', '~> 2.1.0')
 end
diff --git a/gemfiles/edge.gemfile b/gemfiles/edge.gemfile
diff --git a/gemfiles/rails_4.0.gemfile b/gemfiles/rails_4.0.gemfile
@@ -5,5 +5,6 @@ source "https://rubygems.org"
 gem "actionpack", "~> 4.0.0"
 gem "activerecord", "~> 4.0.0"
 gem "railties", "~> 4.0.0"
+gem "rack", "~> 1.5"
 
 gemspec :path => "../"
diff --git a/gemfiles/rails_4.1.gemfile b/gemfiles/rails_4.1.gemfile
@@ -5,5 +5,6 @@ source "https://rubygems.org"
 gem "actionpack", "~> 4.1.0"
 gem "activerecord", "~> 4.1.0"
 gem "railties", "~> 4.1.0"
+gem "rack", "~> 1.5"
 
 gemspec :path => "../"
diff --git a/gemfiles/rails_4.2.gemfile b/gemfiles/rails_4.2.gemfile
@@ -5,5 +5,6 @@ source "https://rubygems.org"
 gem "actionpack", "~> 4.2.0"
 gem "activerecord", "~> 4.2.0"
 gem "railties", "~> 4.2.0"
+gem "rack", "~> 1.5"
 
 gemspec :path => "../"
diff --git a/gemfiles/rails_5.0.gemfile b/gemfiles/rails_5.0.gemfile
@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", ">= 5.0.0.alpha", "< 5.1"
+gem "activerecord", ">= 5.0.0.alpha", "< 5.1"
+gem "railties", ">= 5.0.0.alpha", "< 5.1"
+gem "rack", ">= 2.0.0.alpha", "< 3"
+
+gemspec :path => "../"
diff --git a/gemfiles/rails_edge.gemfile b/gemfiles/rails_edge.gemfile
@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+git "https://github.com/rails/rails.git", :branch => "master" do
+  gem "actionpack"
+  gem "activerecord"
+  gem "railties"
+end
+
+gem "rack", :git => "https://github.com/rack/rack.git", :branch => "master"
+gem "arel", :git => "https://github.com/rails/arel.git", :branch => "master"
+
+gemspec :path => "../"
diff --git a/lib/action_dispatch/session/active_record_store.rb b/lib/action_dispatch/session/active_record_store.rb
@@ -58,66 +58,83 @@ class ActiveRecordStore < ActionDispatch::Session::AbstractStore
       cattr_accessor :session_class
 
       SESSION_RECORD_KEY = 'rack.session.record'
-      ENV_SESSION_OPTIONS_KEY = Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY
+      if Rack.const_defined?(:RACK_SESSION_OPTIONS)
+        ENV_SESSION_OPTIONS_KEY = Rack::RACK_SESSION_OPTIONS
+      else
+        ENV_SESSION_OPTIONS_KEY = Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY
+      end
 
-      private
-        def get_session(env, sid)
-          logger.silence_logger do
-            unless sid and session = @@session_class.find_by_session_id(sid)
-              # If the sid was nil or if there is no pre-existing session under the sid,
-              # force the generation of a new sid and associate a new session associated with the new sid
-              sid = generate_sid
-              session = @@session_class.new(:session_id => sid, :data => {})
-            end
-            env[SESSION_RECORD_KEY] = session
-            [sid, session.data]
+    private
+      def get_session(request, sid)
+        logger.silence_logger do
+          unless sid and session = @@session_class.find_by_session_id(sid)
+            # If the sid was nil or if there is no pre-existing session under the sid,
+            # force the generation of a new sid and associate a new session associated with the new sid
+            sid = generate_sid
+            session = @@session_class.new(:session_id => sid, :data => {})
           end
+          request.env[SESSION_RECORD_KEY] = session
+          [sid, session.data]
         end
+      end
 
-        def set_session(env, sid, session_data, options)
-          logger.silence_logger do
-            record = get_session_model(env, sid)
-            record.data = session_data
-            return false unless record.save
+      def write_session(request, sid, session_data, options)
+        logger.silence_logger do
+          record = get_session_model(request, sid)
+          record.data = session_data
+          return false unless record.save
 
-            session_data = record.data
-            if session_data && session_data.respond_to?(:each_value)
-              session_data.each_value do |obj|
-                obj.clear_association_cache if obj.respond_to?(:clear_association_cache)
-              end
+          session_data = record.data
+          if session_data && session_data.respond_to?(:each_value)
+            session_data.each_value do |obj|
+              obj.clear_association_cache if obj.respond_to?(:clear_association_cache)
             end
-
-            sid
           end
-        end
 
-        def destroy_session(env, session_id, options)
-          logger.silence_logger do
-            if sid = current_session_id(env)
-              get_session_model(env, sid).destroy
-              env[SESSION_RECORD_KEY] = nil
-            end
+          sid
+        end
+      end
 
-            generate_sid unless options[:drop]
+      def delete_session(request, session_id, options)
+        logger.silence_logger do
+          if sid = current_session_id(request)
+            get_session_model(request, sid).destroy
+            request.env[SESSION_RECORD_KEY] = nil
           end
+          generate_sid unless options[:drop]
         end
+      end
 
-        def get_session_model(env, sid)
-          if env[ENV_SESSION_OPTIONS_KEY][:id].nil?
-            env[SESSION_RECORD_KEY] = find_session(sid)
+      def get_session_model(request, id)
+        logger.silence_logger do
+          model = @@session_class.find_by_session_id(id)
+          if !model
+            id = generate_sid
+            model = @@session_class.new(:session_id => id, :data => {})
+            model.save
+          end
+          if request.env[ENV_SESSION_OPTIONS_KEY][:id].nil?
+            request.env[SESSION_RECORD_KEY] = model
           else
-            env[SESSION_RECORD_KEY] ||= find_session(sid)
+            request.env[SESSION_RECORD_KEY] ||= model
           end
+          model
         end
+      end
 
-        def find_session(id)
-          @@session_class.find_by_session_id(id) ||
-            @@session_class.new(:session_id => id, :data => {})
-        end
+      def find_session(request, id)
+        model = get_session_model(request, id)
+        [model.session_id, model.data]
+      end
 
-        def logger
-          ActiveRecord::Base.logger || ActiveRecord::SessionStore::NilLogger
-        end
+      def logger
+        ActiveRecord::Base.logger || ActiveRecord::SessionStore::NilLogger
+      end
     end
   end
 end
+
+if ActiveRecord::VERSION::MAJOR == 4
+  require 'action_dispatch/session/legacy_support'
+  ActionDispatch::Session::ActiveRecordStore.send(:include, ActionDispatch::Session::LegacySupport)
+end
diff --git a/lib/action_dispatch/session/legacy_support.rb b/lib/action_dispatch/session/legacy_support.rb
@@ -0,0 +1,51 @@
+module ActionDispatch
+  module Session
+    module LegacySupport
+      EnvWrapper = Struct.new(:env)
+
+      def self.included(klass)
+        [
+          :get_session,
+          :get_session_model,
+          :write_session,
+          :delete_session,
+          :find_session
+        ].each do |m|
+          klass.send(:alias_method, "#{m}_rails5".to_sym, m)
+          klass.send(:remove_method, m)
+        end
+      end
+
+      def get_session(env, sid)
+        request = EnvWrapper.new(env)
+        get_session_rails5(request, sid)
+      end
+
+      def set_session(env, sid, session_data, options)
+        request = EnvWrapper.new(env)
+        write_session_rails5(request, sid, session_data, options)
+      end
+
+      def destroy_session(env, session_id, options)
+        request = EnvWrapper.new(env)
+        if sid = current_session_id(request.env)
+          get_session_model(request, sid).destroy
+          request.env[self.class::SESSION_RECORD_KEY] = nil
+        end
+        generate_sid unless options[:drop]
+      end
+
+      def get_session_model(request, sid)
+        if request.env[self.class::ENV_SESSION_OPTIONS_KEY][:id].nil?
+          request.env[self.class::SESSION_RECORD_KEY] = find_session(sid)
+        else
+          request.env[self.class::SESSION_RECORD_KEY] ||= find_session(sid)
+        end
+      end
+
+      def find_session(id)
+        self.class.session_class.find_by_session_id(id) || self.class.session_class.new(:session_id => id, :data => {})
+      end
+    end
+  end
+end
diff --git a/lib/active_record/session_store.rb b/lib/active_record/session_store.rb
@@ -13,12 +13,20 @@ def unmarshal(data)
       end
 
       def drop_table!
-        connection.schema_cache.clear_table_cache!(table_name)
+        if connection.schema_cache.respond_to?(:clear_data_source_cache!)
+          connection.schema_cache.clear_data_source_cache!(table_name)
+        else
+          connection.schema_cache.clear_table_cache!(table_name)
+        end
         connection.drop_table table_name
       end
 
       def create_table!
-        connection.schema_cache.clear_table_cache!(table_name)
+        if connection.schema_cache.respond_to?(:clear_data_source_cache!)
+          connection.schema_cache.clear_data_source_cache!(table_name)
+        else
+          connection.schema_cache.clear_table_cache!(table_name)
+        end
         connection.create_table(table_name) do |t|
           t.string session_id_column, :limit => 255
           t.text data_column_name
diff --git a/lib/active_record/session_store/extension/logger_silencer.rb b/lib/active_record/session_store/extension/logger_silencer.rb
@@ -13,8 +13,10 @@ module LoggerSilencer
         included do
           cattr_accessor :silencer
           self.silencer = true
-          alias_method_chain :level, :threadsafety
-          alias_method_chain :add, :threadsafety
+          alias_method :level_without_threadsafety, :level
+          alias_method :level, :level_with_threadsafety
+          alias_method :add_without_threadsafety, :add
+          alias_method :add, :add_with_threadsafety
         end
 
         def thread_level
diff --git a/lib/active_record/session_store/session.rb b/lib/active_record/session_store/session.rb
diff --git a/test/action_controller_test.rb b/test/action_controller_test.rb
diff --git a/test/helper.rb b/test/helper.rb
diff --git a/test/logger_silencer_test.rb b/test/logger_silencer_test.rb
