activerecord-session_store 1.0.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0920d7a8356d636009b0ab31c27a96cbaad5f1b
-  data.tar.gz: f395a9a6b74ed0c90120e971f91ea1bc5087b62f
+SHA256:
+  metadata.gz: af08a0134b3e5a615c2d9f400c30c9d0b4f5327e21c1254f49cfec775ef73732
+  data.tar.gz: f6dd6871a3df37d22cc652b54b3f76f41746d9f0c5e01920984a3bcc6d516cf6
 SHA512:
-  metadata.gz: e5c6788589a3c53391308c31718e1c8bf181b2bf7180ad70a1720cd9129815e5f77043ad4b51efec0b3ebbc404c4132fab404bb8a76880570c89d1948e76958d
-  data.tar.gz: b7f0155f5446dbadf8a5c9dca98a42f24615015035991402810908b28d7fce21257eb7264c046c7596902b8a5f55f2501820541d269358c8f62d7da97067affc
+  metadata.gz: 300394f621b26e545ba842e3d8c4a78f733cd34768ede33ab07f7f4abfc168fc1fa60c4b10ea47a7046db896395206201e3a0b0aa1680418bd219998ebbd5b46
+  data.tar.gz: f4fd30af09711cc74e0a7365c6c529c99a1cd47a4aa91f8c0314deb4eb0cd552d8b3824e497e5d9af86ac110c98f3b9d5865b771af1db12993401774bdfd7422

data/README.md

@@ -18,12 +18,23 @@ Run the migration generator:
 
     rails generate active_record:session_migration
 
+Run the migration:
+
+    rake db:migrate
+
 Then, set your session store in `config/initializers/session_store.rb`:
 
 ```ruby
 Rails.application.config.session_store :active_record_store, :key => '_my_app_session'
 ```
 
+To avoid your sessions table expanding without limit as it will store expired and
+potentially sensitive session data, it is strongly recommended in production
+environments to schedule the `db:sessions:trim` rake task to run daily.
+Running `bin/rake db:sessions:trim` will delete all sessions that have not
+been updated in the last 30 days. The 30 days cutoff can be changed using the
+`SESSION_DAYS_TRIM_THRESHOLD` environment variable.
+
 Configuration
 --------------
 
@@ -31,7 +42,8 @@ The default assumes a `sessions` tables with columns:
 
 *  `id` (numeric primary key),
 *  `session_id` (string, usually varchar; maximum length is 255), and
-*  `data` (text or longtext; careful if your session data exceeds 65KB).
+*  `data` (text, longtext, json or jsonb); careful if your session data exceeds
+65KB).
 
 The `session_id` column should always be indexed for speedy lookups.
 Session data is marshaled to the `data` column in Base64 format.
@@ -53,11 +65,14 @@ having a separate `id` column if you don't want it. However, you must
 set `session.model.id = session.session_id` by hand!  A before filter
 on ApplicationController is a good place.
 
-The serializer may be one of `marshal`, `json`, or `hybrid`.  `marshal` is
-the default and uses the built-in Marshal methods coupled with Base64
-encoding.  `json` does what it says on the tin, using the `parse()` and
-`generate()` methods of the JSON module.  `hybrid` will read either type
-but write as JSON.
+The serializer may be class responding to `#load(value)` and `#dump(value)`, or
+a symbol of `marshal`, `json`, `hybrid` or `null`. `marshal` is the default and
+uses the built-in Marshal methods coupled with Base64 encoding. `json` does
+what it says on the tin, using the `parse()` and `generate()` methods of the
+JSON module. `hybrid` will read either type but write as JSON. `null` will
+not perform serialization, leaving that up to the ActiveRecord database
+adapter. This allows you to take advantage of the native JSON capabilities of
+your database.
 
 Since the default class is a simple Active Record, you get timestamps
 for free if you add `created_at` and `updated_at` datetime columns to

data/lib/action_dispatch/session/active_record_store.rb

@@ -98,7 +98,7 @@ module ActionDispatch
       def delete_session(request, session_id, options)
         logger.silence_logger do
           if sid = current_session_id(request)
-            if model = get_session_model(request, sid)
+            if model = @@session_class.find_by_session_id(sid)
               data = model.data
               model.destroy
             end

data/lib/active_record/session_store.rb

@@ -1,3 +1,4 @@
+require 'active_record'
 require 'active_record/session_store/version'
 require 'action_dispatch/session/active_record_store'
 require "active_record/session_store/extension/logger_silencer"
@@ -6,6 +7,8 @@ require 'multi_json'
 
 module ActiveRecord
   module SessionStore
+    autoload :Session, 'active_record/session_store/session'
+
     module ClassMethods # :nodoc:
       mattr_accessor :serializer
 
@@ -47,6 +50,8 @@ module ActiveRecord
             JsonSerializer
           when :hybrid then
             HybridSerializer
+          when :null then
+            NullSerializer
           else
             self.serializer
         end
@@ -91,15 +96,28 @@ module ActiveRecord
           value.start_with?(MARSHAL_SIGNATURE)
         end
       end
+
+      # Defer serialization to the ActiveRecord database adapter
+      class NullSerializer
+        def self.load(value)
+          value
+        end
+
+        def self.dump(value)
+          value
+        end
+      end
     end
   end
 end
 
-require 'active_record/session_store/session'
+ActiveSupport.on_load(:active_record) do
+  require 'active_record/session_store/session'
+end
+
 require 'active_record/session_store/sql_bypass'
 require 'active_record/session_store/railtie' if defined?(Rails)
 
-ActionDispatch::Session::ActiveRecordStore.session_class = ActiveRecord::SessionStore::Session
 Logger.send :include, ActiveRecord::SessionStore::Extension::LoggerSilencer
 
 begin

data/lib/active_record/session_store/session.rb

@@ -80,7 +80,10 @@ module ActiveRecord
 
       private
         def serialize_data!
-          return false unless loaded?
+          unless loaded?
+            return false if Rails::VERSION::MAJOR < 5
+            throw :abort
+          end
           write_attribute(@@data_column_name, self.class.serialize(data))
         end
 
@@ -88,7 +91,10 @@ module ActiveRecord
         # larger than the data storage column. Raises
         # ActionController::SessionOverflowError.
         def raise_on_session_data_overflow!
-          return false unless loaded?
+          unless loaded?
+            return false if Rails::VERSION::MAJOR < 5
+            throw :abort
+          end
           limit = self.class.data_column_size_limit
           if limit and read_attribute(@@data_column_name).size > limit
             raise ActionController::SessionOverflowError
@@ -97,3 +103,5 @@ module ActiveRecord
     end
   end
 end
+
+ActionDispatch::Session::ActiveRecordStore.session_class = ActiveRecord::SessionStore::Session

data/lib/active_record/session_store/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module SessionStore
-    VERSION = '1.0.0'
+    VERSION = "1.1.3".freeze
   end
 end

data/lib/generators/active_record/session_migration_generator.rb

@@ -19,6 +19,10 @@ module ActiveRecord
           end
           current_table_name
         end
+
+        def migration_version
+          "[#{ActiveRecord::Migration.current_version}]" if ActiveRecord::Migration.respond_to?(:current_version)
+        end
     end
   end
 end

data/lib/generators/active_record/templates/migration.rb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :<%= session_table_name %> do |t|
       t.string :session_id, :null => false

data/lib/tasks/database.rake

@@ -1,15 +1,14 @@
 namespace 'db:sessions' do
   desc "Creates a sessions migration for use with ActiveRecord::SessionStore"
   task :create => [:environment, 'db:load_config'] do
-    raise 'Task unavailable to this database (no migration support)' unless ActiveRecord::Base.connection.supports_migrations?
     Rails.application.load_generators
-    require 'rails/generators/rails/session_migration/session_migration_generator'
-    Rails::Generators::SessionMigrationGenerator.start [ ENV['MIGRATION'] || 'add_sessions_table' ]
+    require 'generators/active_record/session_migration_generator'
+    ActiveRecord::Generators::SessionMigrationGenerator.start [ ENV['MIGRATION'] || 'add_sessions_table' ]
   end
 
   desc "Clear the sessions table"
   task :clear => [:environment, 'db:load_config'] do
-    ActiveRecord::Base.connection.execute "DELETE FROM #{ActiveRecord::SessionStore::Session.table_name}"
+    ActiveRecord::Base.connection.execute "TRUNCATE TABLE #{ActiveRecord::SessionStore::Session.table_name}"
   end
 
   desc "Trim old sessions from the table (default: > 30 days)"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-session_store
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.3
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +31,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -57,9 +45,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -67,9 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -124,20 +106,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
 description: 
 email: david@loudthinking.com
 executables: []
@@ -180,8 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An Action Dispatch session store backed by an Active Record class.