activerecord 3.0.0

data/lib/active_record/session_store.rb

@@ -0,0 +1,340 @@
+module ActiveRecord
+  # = Active Record Session Store
+  #
+  # A session store backed by an Active Record class.  A default class is
+  # provided, but any object duck-typing to an Active Record Session class
+  # with text +session_id+ and +data+ attributes is sufficient.
+  #
+  # The default assumes a +sessions+ tables with columns:
+  #   +id+ (numeric primary key),
+  #   +session_id+ (text, or longtext if your session data exceeds 65K), and
+  #   +data+ (text or longtext; 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.
+  # If the data you write is larger than the column's size limit,
+  # ActionController::SessionOverflowError will be raised.
+  #
+  # You may configure the table name, primary key, and data column.
+  # For example, at the end of <tt>config/application.rb</tt>:
+  #
+  #   ActiveRecord::SessionStore::Session.table_name = 'legacy_session_table'
+  #   ActiveRecord::SessionStore::Session.primary_key = 'session_id'
+  #   ActiveRecord::SessionStore::Session.data_column_name = 'legacy_session_data'
+  #
+  # Note that setting the primary key to the +session_id+ frees you from
+  # having a separate +id+ column if you don't want it.  However, you must
+  # set <tt>session.model.id = session.session_id</tt> by hand!  A before filter
+  # on ApplicationController is a good place.
+  #
+  # 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
+  # the +sessions+ table, making periodic session expiration a snap.
+  #
+  # You may provide your own session class implementation, whether a
+  # feature-packed Active Record or a bare-metal high-performance SQL
+  # store, by setting
+  #
+  #   ActiveRecord::SessionStore.session_class = MySessionClass
+  #
+  # You must implement these methods:
+  #
+  #   self.find_by_session_id(session_id)
+  #   initialize(hash_of_session_id_and_data)
+  #   attr_reader :session_id
+  #   attr_accessor :data
+  #   save
+  #   destroy
+  #
+  # The example SqlBypass class is a generic SQL session store.  You may
+  # use it as a basis for high-performance database-specific stores.
+  class SessionStore < ActionDispatch::Session::AbstractStore
+    module ClassMethods # :nodoc:
+      def marshal(data)
+        ActiveSupport::Base64.encode64(Marshal.dump(data)) if data
+      end
+
+      def unmarshal(data)
+        Marshal.load(ActiveSupport::Base64.decode64(data)) if data
+      end
+
+      def drop_table!
+        connection.drop_table table_name
+      end
+
+      def create_table!
+        connection.create_table(table_name) do |t|
+          t.string session_id_column, :limit => 255
+          t.text data_column_name
+        end
+        connection.add_index table_name, session_id_column, :unique => true
+      end
+    end
+
+    # The default Active Record class.
+    class Session < ActiveRecord::Base
+      extend ClassMethods
+
+      ##
+      # :singleton-method:
+      # Customizable data column name.  Defaults to 'data'.
+      cattr_accessor :data_column_name
+      self.data_column_name = 'data'
+
+      before_save :marshal_data!
+      before_save :raise_on_session_data_overflow!
+
+      class << self
+        def data_column_size_limit
+          @data_column_size_limit ||= columns_hash[data_column_name].limit
+        end
+
+        # Hook to set up sessid compatibility.
+        def find_by_session_id(session_id)
+          setup_sessid_compatibility!
+          find_by_session_id(session_id)
+        end
+
+        private
+          def session_id_column
+            'session_id'
+          end
+
+          # Compatibility with tables using sessid instead of session_id.
+          def setup_sessid_compatibility!
+            # Reset column info since it may be stale.
+            reset_column_information
+            if columns_hash['sessid']
+              def self.find_by_session_id(*args)
+                find_by_sessid(*args)
+              end
+
+              define_method(:session_id)  { sessid }
+              define_method(:session_id=) { |session_id| self.sessid = session_id }
+            else
+              class << self; remove_method :find_by_session_id; end
+
+              def self.find_by_session_id(session_id)
+                find :first, :conditions => {:session_id=>session_id}
+              end
+            end
+          end
+      end
+
+      def initialize(attributes = nil)
+        @data = nil
+        super
+      end
+
+      # Lazy-unmarshal session state.
+      def data
+        @data ||= self.class.unmarshal(read_attribute(@@data_column_name)) || {}
+      end
+
+      attr_writer :data
+
+      # Has the session been loaded yet?
+      def loaded?
+        @data
+      end
+
+      private
+        def marshal_data!
+          return false unless loaded?
+          write_attribute(@@data_column_name, self.class.marshal(data))
+        end
+
+        # Ensures that the data about to be stored in the database is not
+        # larger than the data storage column. Raises
+        # ActionController::SessionOverflowError.
+        def raise_on_session_data_overflow!
+          return false unless loaded?
+          limit = self.class.data_column_size_limit
+          if limit and read_attribute(@@data_column_name).size > limit
+            raise ActionController::SessionOverflowError
+          end
+        end
+    end
+
+    # A barebones session store which duck-types with the default session
+    # store but bypasses Active Record and issues SQL directly.  This is
+    # an example session model class meant as a basis for your own classes.
+    #
+    # The database connection, table name, and session id and data columns
+    # are configurable class attributes.  Marshaling and unmarshaling
+    # are implemented as class methods that you may override.  By default,
+    # marshaling data is
+    #
+    #   ActiveSupport::Base64.encode64(Marshal.dump(data))
+    #
+    # and unmarshaling data is
+    #
+    #   Marshal.load(ActiveSupport::Base64.decode64(data))
+    #
+    # This marshaling behavior is intended to store the widest range of
+    # binary session data in a +text+ column.  For higher performance,
+    # store in a +blob+ column instead and forgo the Base64 encoding.
+    class SqlBypass
+      extend ClassMethods
+
+      ##
+      # :singleton-method:
+      # Use the ActiveRecord::Base.connection by default.
+      cattr_accessor :connection
+
+      ##
+      # :singleton-method:
+      # The table name defaults to 'sessions'.
+      cattr_accessor :table_name
+      @@table_name = 'sessions'
+
+      ##
+      # :singleton-method:
+      # The session id field defaults to 'session_id'.
+      cattr_accessor :session_id_column
+      @@session_id_column = 'session_id'
+
+      ##
+      # :singleton-method:
+      # The data field defaults to 'data'.
+      cattr_accessor :data_column
+      @@data_column = 'data'
+
+      class << self
+        alias :data_column_name :data_column
+
+        remove_method :connection
+        def connection
+          @@connection ||= ActiveRecord::Base.connection
+        end
+
+        # Look up a session by id and unmarshal its data if found.
+        def find_by_session_id(session_id)
+          if record = connection.select_one("SELECT * FROM #{@@table_name} WHERE #{@@session_id_column}=#{connection.quote(session_id)}")
+            new(:session_id => session_id, :marshaled_data => record['data'])
+          end
+        end
+      end
+
+      attr_reader :session_id, :new_record
+      alias :new_record? :new_record
+
+      attr_writer :data
+
+      # Look for normal and marshaled data, self.find_by_session_id's way of
+      # telling us to postpone unmarshaling until the data is requested.
+      # We need to handle a normal data attribute in case of a new record.
+      def initialize(attributes)
+        @session_id     = attributes[:session_id]
+        @data           = attributes[:data]
+        @marshaled_data = attributes[:marshaled_data]
+        @new_record     = @marshaled_data.nil?
+      end
+
+      # Lazy-unmarshal session state.
+      def data
+        unless @data
+          if @marshaled_data
+            @data, @marshaled_data = self.class.unmarshal(@marshaled_data) || {}, nil
+          else
+            @data = {}
+          end
+        end
+        @data
+      end
+
+      def loaded?
+        @data
+      end
+
+      def save
+        return false unless loaded?
+        marshaled_data = self.class.marshal(data)
+        connect        = connection
+
+        if @new_record
+          @new_record = false
+          connect.update <<-end_sql, 'Create session'
+            INSERT INTO #{table_name} (
+              #{connect.quote_column_name(session_id_column)},
+              #{connect.quote_column_name(data_column)} )
+            VALUES (
+              #{connect.quote(session_id)},
+              #{connect.quote(marshaled_data)} )
+          end_sql
+        else
+          connect.update <<-end_sql, 'Update session'
+            UPDATE #{table_name}
+            SET #{connect.quote_column_name(data_column)}=#{connect.quote(marshaled_data)}
+            WHERE #{connect.quote_column_name(session_id_column)}=#{connect.quote(session_id)}
+          end_sql
+        end
+      end
+
+      def destroy
+        return if @new_record
+
+        connect = connection
+        connect.delete <<-end_sql, 'Destroy session'
+          DELETE FROM #{table_name}
+          WHERE #{connect.quote_column_name(session_id_column)}=#{connect.quote(session_id)}
+        end_sql
+      end
+    end
+
+    # The class used for session storage.  Defaults to
+    # ActiveRecord::SessionStore::Session
+    cattr_accessor :session_class
+    self.session_class = Session
+
+    SESSION_RECORD_KEY = 'rack.session.record'
+
+    private
+      def get_session(env, sid)
+        Base.silence do
+          sid ||= generate_sid
+          session = find_session(sid)
+          env[SESSION_RECORD_KEY] = session
+          [sid, session.data]
+        end
+      end
+
+      def set_session(env, sid, session_data)
+        Base.silence do
+          record = get_session_model(env, 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
+          end
+        end
+
+        sid
+      end
+
+      def destroy(env)
+        if sid = current_session_id(env)
+          Base.silence do
+            get_session_model(env, sid).destroy
+          end
+        end
+      end
+
+      def get_session_model(env, sid)
+        if env[ENV_SESSION_OPTIONS_KEY][:id].nil?
+          env[SESSION_RECORD_KEY] = find_session(sid)
+        else
+          env[SESSION_RECORD_KEY] ||= find_session(sid)
+        end
+      end
+
+      def find_session(id)
+        @@session_class.find_by_session_id(id) ||
+          @@session_class.new(:session_id => id, :data => {})
+      end
+  end
+end

data/lib/active_record/test_case.rb

@@ -0,0 +1,67 @@
+module ActiveRecord
+  # = Active Record Test Case
+  #
+  # Defines some test assertions to test against SQL queries.
+  class TestCase < ActiveSupport::TestCase #:nodoc:
+    def assert_date_from_db(expected, actual, message = nil)
+      # SybaseAdapter doesn't have a separate column type just for dates,
+      # so the time is in the string and incorrectly formatted
+      if current_adapter?(:SybaseAdapter)
+        assert_equal expected.to_s, actual.to_date.to_s, message
+      else
+        assert_equal expected.to_s, actual.to_s, message
+      end
+    end
+
+    def assert_sql(*patterns_to_match)
+      $queries_executed = []
+      yield
+    ensure
+      failed_patterns = []
+      patterns_to_match.each do |pattern|
+        failed_patterns << pattern unless $queries_executed.any?{ |sql| pattern === sql }
+      end
+      assert failed_patterns.empty?, "Query pattern(s) #{failed_patterns.map{ |p| p.inspect }.join(', ')} not found.#{$queries_executed.size == 0 ? '' : "\nQueries:\n#{$queries_executed.join("\n")}"}"
+    end
+
+    def assert_queries(num = 1)
+      $queries_executed = []
+      yield
+    ensure
+      %w{ BEGIN COMMIT }.each { |x| $queries_executed.delete(x) }
+      assert_equal num, $queries_executed.size, "#{$queries_executed.size} instead of #{num} queries were executed.#{$queries_executed.size == 0 ? '' : "\nQueries:\n#{$queries_executed.join("\n")}"}"
+    end
+
+    def assert_no_queries(&block)
+      assert_queries(0, &block)
+    end
+
+    def self.use_concurrent_connections
+      setup :connection_allow_concurrency_setup
+      teardown :connection_allow_concurrency_teardown
+    end
+
+    def connection_allow_concurrency_setup
+      @connection = ActiveRecord::Base.remove_connection
+      ActiveRecord::Base.establish_connection(@connection.merge({:allow_concurrency => true}))
+    end
+
+    def connection_allow_concurrency_teardown
+      ActiveRecord::Base.clear_all_connections!
+      ActiveRecord::Base.establish_connection(@connection)
+    end
+
+    def with_kcode(kcode)
+      if RUBY_VERSION < '1.9'
+        orig_kcode, $KCODE = $KCODE, kcode
+        begin
+          yield
+        ensure
+          $KCODE = orig_kcode
+        end
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/active_record/timestamp.rb

@@ -0,0 +1,88 @@
+module ActiveRecord
+  # = Active Record Timestamp
+  #
+  # Active Record automatically timestamps create and update operations if the
+  # table has fields named <tt>created_at/created_on</tt> or
+  # <tt>updated_at/updated_on</tt>.
+  #
+  # Timestamping can be turned off by setting:
+  #
+  #   <tt>ActiveRecord::Base.record_timestamps = false</tt>
+  #
+  # Timestamps are in the local timezone by default but you can use UTC by setting:
+  #
+  #   <tt>ActiveRecord::Base.default_timezone = :utc</tt>
+  #
+  # == Time Zone aware attributes
+  #
+  # By default, ActiveRecord::Base keeps all the datetime columns time zone aware by executing following code.
+  #
+  #   ActiveRecord::Base.time_zone_aware_attributes = true
+  #
+  # This feature can easily be turned off by assigning value <tt>false</tt> .
+  #
+  # If your attributes are time zone aware and you desire to skip time zone conversion for certain
+  # attributes then you can do following:
+  #
+  #   Topic.skip_time_zone_conversion_for_attributes = [:written_on]
+  module Timestamp
+    extend ActiveSupport::Concern
+
+    included do
+      class_inheritable_accessor :record_timestamps, :instance_writer => false
+      self.record_timestamps = true
+    end
+
+  private
+
+    def create #:nodoc:
+      if record_timestamps
+        current_time = current_time_from_proper_timezone
+
+        all_timestamp_attributes.each do |column|
+          write_attribute(column.to_s, current_time) if respond_to?(column) && self.send(column).nil?
+        end
+      end
+
+      super
+    end
+
+    def update(*args) #:nodoc:
+      if should_record_timestamps?
+        current_time = current_time_from_proper_timezone
+
+        timestamp_attributes_for_update_in_model.each do |column|
+          column = column.to_s
+          next if attribute_changed?(column)
+          write_attribute(column, current_time)
+        end
+      end
+      super
+    end
+
+    def should_record_timestamps?
+      record_timestamps && (!partial_updates? || changed?)
+    end
+
+    def timestamp_attributes_for_update_in_model
+      timestamp_attributes_for_update.select { |c| respond_to?(c) }
+    end
+
+    def timestamp_attributes_for_update #:nodoc:
+      [:updated_at, :updated_on]
+    end
+
+    def timestamp_attributes_for_create #:nodoc:
+      [:created_at, :created_on]
+    end
+
+    def all_timestamp_attributes #:nodoc:
+      timestamp_attributes_for_create + timestamp_attributes_for_update
+    end
+
+    def current_time_from_proper_timezone #:nodoc:
+      self.class.default_timezone == :utc ? Time.now.utc : Time.now
+    end
+  end
+end
+