activerecord 2.3.18 → 3.2.22

data/lib/active_record/serializers/xml_serializer.rb

@@ -1,5 +1,10 @@
+require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/hash/conversions'
+
 module ActiveRecord #:nodoc:
   module Serialization
+    include ActiveModel::Serializers::Xml
+
     # Builds an XML document to represent the model. Some configuration is
     # available through +options+. However more complicated cases should
     # override ActiveRecord::Base#to_xml.
@@ -69,6 +74,21 @@ module ActiveRecord #:nodoc:
     #     </account>
     #   </firm>
     #
+    # Additionally, the record being serialized will be passed to a Proc's second
+    # parameter. This allows for ad hoc additions to the resultant document that
+    # incorporate the context of the record being serialized. And by leveraging the
+    # closure created by a Proc, to_xml can be used to add elements that normally fall
+    # outside of the scope of the model -- for example, generating and appending URLs
+    # associated with models.
+    #
+    #   proc = Proc.new { |options, record| options[:builder].tag!('name-reverse', record.name.reverse) }
+    #   firm.to_xml :procs => [ proc ]
+    #
+    #   <firm>
+    #     # ... normal attributes as shown above ...
+    #     <name-reverse>slangis73</name-reverse>
+    #   </firm>
+    #
     # To include deeper levels of associations pass a hash like this:
     #
     #   firm.to_xml :include => {:account => {}, :clients => {:include => :address}}
@@ -143,8 +163,9 @@ module ActiveRecord #:nodoc:
     #
     #   class IHaveMyOwnXML < ActiveRecord::Base
     #     def to_xml(options = {})
+    #       require 'builder'
     #       options[:indent] ||= 2
-    #       xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
+    #       xml = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent])
     #       xml.instruct! unless options[:skip_instruct]
     #       xml.level_one do
     #         xml.tag!(:second_level, 'content')
@@ -152,206 +173,31 @@ module ActiveRecord #:nodoc:
     #     end
     #   end
     def to_xml(options = {}, &block)
-      serializer = XmlSerializer.new(self, options)
-      block_given? ? serializer.to_s(&block) : serializer.to_s
-    end
-
-    def from_xml(xml)
-      self.attributes = Hash.from_xml(xml).values.first
-      self
+      XmlSerializer.new(self, options).serialize(&block)
     end
   end
 
-  class XmlSerializer < ActiveRecord::Serialization::Serializer #:nodoc:
-    def builder
-      @builder ||= begin
-        options[:indent] ||= 2
-        builder = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
-
-        unless options[:skip_instruct]
-          builder.instruct!
-          options[:skip_instruct] = true
-        end
-
-        builder
+  class XmlSerializer < ActiveModel::Serializers::Xml::Serializer #:nodoc:
+    def initialize(*args)
+      super
+      options[:except] = Array.wrap(options[:except]) | Array.wrap(@serializable.class.inheritance_column)
+    end
+
+    class Attribute < ActiveModel::Serializers::Xml::Serializer::Attribute #:nodoc:
+      def compute_type
+        klass = @serializable.class
+        type = if klass.serialized_attributes.key?(name)
+                 super
+               elsif klass.columns_hash.key?(name)
+                 klass.columns_hash[name].type
+               else
+                 NilClass
+               end
+
+        { :text => :string,
+          :time => :datetime }[type] || type
       end
-    end
-
-    def root
-      root = (options[:root] || @record.class.model_name.singular).to_s
-      reformat_name(root)
-    end
-
-    def dasherize?
-      !options.has_key?(:dasherize) || options[:dasherize]
-    end
-
-    def camelize?
-      options.has_key?(:camelize) && options[:camelize]
-    end
-
-    def reformat_name(name)
-      name = name.camelize if camelize?
-      dasherize? ? name.dasherize : name
-    end
-
-    def serializable_attributes
-      serializable_attribute_names.collect { |name| Attribute.new(name, @record) }
-    end
-
-    def serializable_method_attributes
-      Array(options[:methods]).inject([]) do |method_attributes, name|
-        method_attributes << MethodAttribute.new(name.to_s, @record) if @record.respond_to?(name.to_s)
-        method_attributes
-      end
-    end
-
-    def add_attributes
-      (serializable_attributes + serializable_method_attributes).each do |attribute|
-        add_tag(attribute)
-      end
-    end
-
-    def add_procs
-      if procs = options.delete(:procs)
-        [ *procs ].each do |proc|
-          proc.call(options)
-        end
-      end
-    end
-
-    def add_tag(attribute)
-      builder.tag!(
-        reformat_name(attribute.name),
-        attribute.value.to_s,
-        attribute.decorations(!options[:skip_types])
-      )
-    end
-
-    def add_associations(association, records, opts)
-      if records.is_a?(Enumerable)
-        tag = reformat_name(association.to_s)
-        type = options[:skip_types] ? {} : {:type => "array"}
-
-        if records.empty?
-          builder.tag!(tag, type)
-        else
-          builder.tag!(tag, type) do
-            association_name = association.to_s.singularize
-            records.each do |record|
-              if options[:skip_types]
-                record_type = {}
-              else
-                record_class = (record.class.to_s.underscore == association_name) ? nil : record.class.name
-                record_type = {:type => record_class}
-              end
-
-              record.to_xml opts.merge(:root => association_name).merge(record_type)
-            end
-          end
-        end
-      else
-        if record = @record.send(association)
-          record.to_xml(opts.merge(:root => association))
-        end
-      end
-    end
-
-    def serialize
-      args = [root]
-      if options[:namespace]
-        args << {:xmlns=>options[:namespace]}
-      end
-
-      if options[:type]
-        args << {:type=>options[:type]}
-      end
-
-      builder.tag!(*args) do
-        add_attributes
-        procs = options.delete(:procs)
-        add_includes { |association, records, opts| add_associations(association, records, opts) }
-        options[:procs] = procs
-        add_procs
-        yield builder if block_given?
-      end
-    end
-
-    class Attribute #:nodoc:
-      attr_reader :name, :value, :type
-
-      def initialize(name, record)
-        @name, @record = name, record
-
-        @type  = compute_type
-        @value = compute_value
-      end
-
-      # There is a significant speed improvement if the value
-      # does not need to be escaped, as <tt>tag!</tt> escapes all values
-      # to ensure that valid XML is generated. For known binary
-      # values, it is at least an order of magnitude faster to
-      # Base64 encode binary values and directly put them in the
-      # output XML than to pass the original value or the Base64
-      # encoded value to the <tt>tag!</tt> method. It definitely makes
-      # no sense to Base64 encode the value and then give it to
-      # <tt>tag!</tt>, since that just adds additional overhead.
-      def needs_encoding?
-        ![ :binary, :date, :datetime, :boolean, :float, :integer ].include?(type)
-      end
-
-      def decorations(include_types = true)
-        decorations = {}
-
-        if type == :binary
-          decorations[:encoding] = 'base64'
-        end
-
-        if include_types && type != :string
-          decorations[:type] = type
-        end
-
-        if value.nil?
-          decorations[:nil] = true
-        end
-
-        decorations
-      end
-
-      protected
-        def compute_type
-          type = if @record.class.serialized_attributes.has_key?(name)
-                   :yaml
-                 else
-                   @record.class.columns_hash[name].try(:type)
-                 end
-
-          case type
-            when :text
-              :string
-            when :time
-              :datetime
-            else
-              type
-          end
-        end
-
-        def compute_value
-          value = @record.send(name)
-
-          if formatter = Hash::XML_FORMATTING[type.to_s]
-            value ? formatter.call(value) : nil
-          else
-            value
-          end
-        end
-    end
-
-    class MethodAttribute < Attribute #:nodoc:
-      protected
-        def compute_type
-          Hash::XML_TYPE_NAMES[@record.send(name).class.name] || :string
-        end
+      protected :compute_type
     end
   end
 end

data/lib/active_record/session_store.rb

@@ -1,24 +1,31 @@
+require 'action_dispatch/middleware/session/abstract_store'
+
 module ActiveRecord
-  # A session store backed by an Active Record class.  A default class is
+  # = 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
+  #   +session_id+ (string, :limit => 255), 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/environment.rb</tt>:
+  # 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
+  # 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.
   #
@@ -29,32 +36,63 @@ module ActiveRecord
   # 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)
+  #   initialize(hash_of_session_id_and_data, options_hash = {})
   #   attr_reader :session_id
   #   attr_accessor :data
   #   save
   #   destroy
   #
-  # The example SqlBypass class is a generic SQL session store.  You may
+  # 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 < ActionController::Session::AbstractStore
+  class SessionStore < ActionDispatch::Session::AbstractStore
+    module ClassMethods # :nodoc:
+      def marshal(data)
+        ::Base64.encode64(Marshal.dump(data)) if data
+      end
+
+      def unmarshal(data)
+        Marshal.load(::Base64.decode64(data)) if data
+      end
+
+      def drop_table!
+        connection.schema_cache.clear_table_cache!(table_name)
+        connection.drop_table table_name
+      end
+
+      def create_table!
+        connection.schema_cache.clear_table_cache!(table_name)
+        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'.
+      # Customizable data column name. Defaults to 'data'.
       cattr_accessor :data_column_name
       self.data_column_name = 'data'
 
+      attr_accessible :session_id, :data, :marshaled_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
+          @data_column_size_limit ||= columns_hash[data_column_name].limit
         end
 
         # Hook to set up sessid compatibility.
@@ -63,29 +101,11 @@ module ActiveRecord
           find_by_session_id(session_id)
         end
 
-        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 create_table!
-          connection.execute <<-end_sql
-            CREATE TABLE #{table_name} (
-              id INTEGER PRIMARY KEY,
-              #{connection.quote_column_name('session_id')} TEXT UNIQUE,
-              #{connection.quote_column_name(@@data_column_name)} TEXT(255)
-            )
-          end_sql
-        end
-
-        def drop_table!
-          connection.execute "DROP TABLE #{table_name}"
-        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.
@@ -98,6 +118,8 @@ module ActiveRecord
               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
@@ -105,6 +127,11 @@ module ActiveRecord
           end
       end
 
+      def initialize(attributes = nil, options = {})
+        @data = nil
+        super
+      end
+
       # Lazy-unmarshal session state.
       def data
         @data ||= self.class.unmarshal(read_attribute(@@data_column_name)) || {}
@@ -114,50 +141,47 @@ module ActiveRecord
 
       # Has the session been loaded yet?
       def loaded?
-        !!@data
+        @data
       end
 
       private
         def marshal_data!
-          return false if !loaded?
-          write_attribute(@@data_column_name, self.class.marshal(self.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 if !loaded?
+          return false unless loaded?
           limit = self.class.data_column_size_limit
-          if loaded? and limit and read_attribute(@@data_column_name).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
+    # 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,
+    # 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))
+    #   ::Base64.encode64(Marshal.dump(data))
     #
     # and unmarshaling data is
     #
-    #   Marshal.load(ActiveSupport::Base64.decode64(data))
+    #   Marshal.load(::Base64.decode64(data))
     #
     # This marshaling behavior is intended to store the widest range of
-    # binary session data in a +text+ column.  For higher performance,
+    # binary session data in a +text+ column. For higher performance,
     # store in a +blob+ column instead and forgo the Base64 encoding.
     class SqlBypass
-      ##
-      # :singleton-method:
-      # Use the ActiveRecord::Base.connection by default.
-      cattr_accessor :connection
+      extend ClassMethods
 
       ##
       # :singleton-method:
@@ -178,8 +202,20 @@ module ActiveRecord
       @@data_column = 'data'
 
       class << self
+        alias :data_column_name :data_column
+        
+        # Use the ActiveRecord::Base.connection by default.
+        attr_writer :connection
+        
+        # Use the ActiveRecord::Base.connection_pool by default.
+        attr_writer :connection_pool
+
         def connection
-          @@connection ||= ActiveRecord::Base.connection
+          @connection ||= ActiveRecord::Base.connection
+        end
+
+        def connection_pool
+          @connection_pool ||= ActiveRecord::Base.connection_pool
         end
 
         # Look up a session by id and unmarshal its data if found.
@@ -188,43 +224,23 @@ module ActiveRecord
             new(:session_id => session_id, :marshaled_data => record['data'])
           end
         end
-
-        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 create_table!
-          @@connection.execute <<-end_sql
-            CREATE TABLE #{table_name} (
-              id INTEGER PRIMARY KEY,
-              #{@@connection.quote_column_name(session_id_column)} TEXT UNIQUE,
-              #{@@connection.quote_column_name(data_column)} TEXT
-            )
-          end_sql
-        end
-
-        def drop_table!
-          @@connection.execute "DROP TABLE #{table_name}"
-        end
       end
+      
+      delegate :connection, :connection=, :connection_pool, :connection_pool=, :to => self
+
+      attr_reader :session_id, :new_record
+      alias :new_record? :new_record
 
-      attr_reader :session_id
       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, @data, @marshaled_data = attributes[:session_id], attributes[:data], attributes[:marshaled_data]
-        @new_record = @marshaled_data.nil?
-      end
-
-      def new_record?
-        @new_record
+        @session_id     = attributes[:session_id]
+        @data           = attributes[:data]
+        @marshaled_data = attributes[:marshaled_data]
+        @new_record     = @marshaled_data.nil?
       end
 
       # Lazy-unmarshal session state.
@@ -240,60 +256,67 @@ module ActiveRecord
       end
 
       def loaded?
-        !!@data
+        @data
       end
 
       def save
-        return false if !loaded?
+        return false unless loaded?
         marshaled_data = self.class.marshal(data)
+        connect        = connection
 
         if @new_record
           @new_record = false
-          @@connection.update <<-end_sql, 'Create session'
-            INSERT INTO #{@@table_name} (
-              #{@@connection.quote_column_name(@@session_id_column)},
-              #{@@connection.quote_column_name(@@data_column)} )
+          connect.update <<-end_sql, 'Create session'
+            INSERT INTO #{table_name} (
+              #{connect.quote_column_name(session_id_column)},
+              #{connect.quote_column_name(data_column)} )
             VALUES (
-              #{@@connection.quote(session_id)},
-              #{@@connection.quote(marshaled_data)} )
+              #{connect.quote(session_id)},
+              #{connect.quote(marshaled_data)} )
           end_sql
         else
-          @@connection.update <<-end_sql, 'Update session'
-            UPDATE #{@@table_name}
-            SET #{@@connection.quote_column_name(@@data_column)}=#{@@connection.quote(marshaled_data)}
-            WHERE #{@@connection.quote_column_name(@@session_id_column)}=#{@@connection.quote(session_id)}
+          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
-        unless @new_record
-          @@connection.delete <<-end_sql, 'Destroy session'
-            DELETE FROM #{@@table_name}
-            WHERE #{@@connection.quote_column_name(@@session_id_column)}=#{@@connection.quote(session_id)}
-          end_sql
-        end
+        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
+    # 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'.freeze
+    SESSION_RECORD_KEY = 'rack.session.record'
+    ENV_SESSION_OPTIONS_KEY = Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY
 
     private
       def get_session(env, sid)
         Base.silence do
-          sid ||= generate_sid
-          session = find_session(sid)
+          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]
         end
       end
 
-      def set_session(env, sid, session_data)
+      def set_session(env, sid, session_data, options)
         Base.silence do
           record = get_session_model(env, sid)
           record.data = session_data
@@ -307,17 +330,20 @@ module ActiveRecord
           end
         end
 
-        return true
+        sid
       end
-      
-      def destroy(env)
+
+      def destroy_session(env, session_id, options)
         if sid = current_session_id(env)
           Base.silence do
             get_session_model(env, sid).destroy
+            env[SESSION_RECORD_KEY] = nil
           end
         end
+
+        generate_sid unless options[:drop]
       end
-      
+
       def get_session_model(env, sid)
         if env[ENV_SESSION_OPTIONS_KEY][:id].nil?
           env[SESSION_RECORD_KEY] = find_session(sid)