activerecord 1.15.6 → 2.0.0

data/lib/active_record/serializers/json_serializer.rb

@@ -0,0 +1,71 @@
+module ActiveRecord #:nodoc:
+  module Serialization
+    # Returns a JSON string representing the model. Some configuration is
+    # available through +options+.
+    #
+    # Without any +options+, the returned JSON string will include all
+    # the model's attributes. For example:
+    #
+    #   konata = User.find(1)
+    #   konata.to_json
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true}
+    #
+    # The :only and :except options can be used to limit the attributes
+    # included, and work similar to the #attributes method. For example:
+    #
+    #   konata.to_json(:only => [ :id, :name ])
+    #
+    #   {"id": 1, "name": "Konata Izumi"}
+    #
+    #   konata.to_json(:except => [ :id, :created_at, :age ])
+    #
+    #   {"name": "Konata Izumi", "awesome": true}
+    #
+    # To include any methods on the model, use :methods.
+    #
+    #   konata.to_json(:methods => :permalink)
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true,
+    #    "permalink": "1-konata-izumi"}
+    #
+    # To include associations, use :include.
+    #
+    #   konata.to_json(:include => :posts)
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true,
+    #    "posts": [{"id": 1, "author_id": 1, "title": "Welcome to the weblog"},
+    #              {"id": 2, author_id: 1, "title": "So I was thinking"}]}
+    #
+    # 2nd level and higher order associations work as well:
+    #
+    #   konata.to_json(:include => { :posts => {
+    #                                  :include => { :comments => {
+    #                                                :only => :body } },
+    #                                  :only => :title } })
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true,
+    #    "posts": [{"comments": [{"body": "1st post!"}, {"body": "Second!"}],
+    #               "title": "Welcome to the weblog"},
+    #              {"comments": [{"body": "Don't think too hard"}],
+    #               "title": "So I was thinking"}]}
+    def to_json(options = {})
+      JsonSerializer.new(self, options).to_s
+    end
+
+    def from_json(json)
+      self.attributes = ActiveSupport::JSON.decode(json)
+      self
+    end
+
+    class JsonSerializer < ActiveRecord::Serialization::Serializer #:nodoc:
+      def serialize
+        serializable_record.to_json
+      end
+    end
+  end
+end

data/lib/active_record/{xml_serialization.rb → serializers/xml_serializer.rb}

@@ -1,12 +1,12 @@
 module ActiveRecord #:nodoc:
-  module XmlSerialization
+  module Serialization
     # Builds an XML document to represent the model.   Some configuration is
-    # availble through +options+, however more complicated cases should use 
+    # available through +options+, however more complicated cases should
     # override ActiveRecord's to_xml.
     #
-    # By default the generated XML document will include the processing 
+    # By default the generated XML document will include the processing
     # instruction and all object's attributes.  For example:
-    #    
+    #
     #   <?xml version="1.0" encoding="UTF-8"?>
     #   <topic>
     #     <title>The First Topic</title>
@@ -27,7 +27,7 @@ module ActiveRecord #:nodoc:
     # :except options are the same as for the #attributes method.
     # The default is to dasherize all column names, to disable this,
     # set :dasherize to false.  To not have the column type included
-    # in the XML output, set :skip_types to false.
+    # in the XML output, set :skip_types to true.
     #
     # For instance:
     #
@@ -42,7 +42,7 @@ module ActiveRecord #:nodoc:
     #     <parent-id></parent-id>
     #     <last-read type="date">2004-04-15</last-read>
     #   </topic>
-    # 
+    #
     # To include first level associations use :include
     #
     #   firm.to_xml :include => [ :account, :clients ]
@@ -52,7 +52,7 @@ module ActiveRecord #:nodoc:
     #     <id type="integer">1</id>
     #     <rating type="integer">1</rating>
     #     <name>37signals</name>
-    #     <clients>
+    #     <clients type="array">
     #       <client>
     #         <rating type="integer">1</rating>
     #         <name>Summit</name>
@@ -90,7 +90,24 @@ module ActiveRecord #:nodoc:
     #     <abc>def</abc>
     #   </firm>
     #
-    # You may override the to_xml method in your ActiveRecord::Base
+    # Alternatively, you can also just yield the builder object as part of the to_xml call:
+    #
+    #   firm.to_xml do |xml|
+    #     xml.creator do
+    #       xml.first_name "David"
+    #       xml.last_name "Heinemeier Hansson"
+    #     end
+    #   end
+    #
+    #   <firm>
+    #     # ... normal attributes as shown above ...
+    #     <creator>
+    #       <first_name>David</first_name>
+    #       <last_name>Heinemeier Hansson</last_name>
+    #     </creator>
+    #   </firm>
+    #
+    # You can override the to_xml method in your ActiveRecord::Base
     # subclasses if you need to.  The general form of doing this is
     #
     #   class IHaveMyOwnXML < ActiveRecord::Base
@@ -103,18 +120,18 @@ module ActiveRecord #:nodoc:
     #       end
     #     end
     #   end
-    def to_xml(options = {})
-      XmlSerializer.new(self, options).to_s
+    def to_xml(options = {}, &block)
+      serializer = XmlSerializer.new(self, options)
+      block_given? ? serializer.to_s(&block) : serializer.to_s
     end
-  end
 
-  class XmlSerializer #:nodoc:
-    attr_reader :options
-    
-    def initialize(record, options = {})
-      @record, @options = record, options.dup
+    def from_xml(xml)
+      self.attributes = Hash.from_xml(xml).values.first
+      self
     end
-    
+  end
+
+  class XmlSerializer < ActiveRecord::Serialization::Serializer #:nodoc:
     def builder
       @builder ||= begin
         options[:indent] ||= 2
@@ -124,7 +141,7 @@ module ActiveRecord #:nodoc:
           builder.instruct!
           options[:skip_instruct] = true
         end
-        
+
         builder
       end
     end
@@ -133,7 +150,7 @@ module ActiveRecord #:nodoc:
       root = (options[:root] || @record.class.to_s.underscore).to_s
       dasherize? ? root.dasherize : root
     end
-    
+
     def dasherize?
       !options.has_key?(:dasherize) || options[:dasherize]
     end
@@ -146,64 +163,22 @@ module ActiveRecord #:nodoc:
     # level model can have both :except and :only set.  So if
     # :only is set, always delete :except.
     def serializable_attributes
-      attribute_names = @record.attribute_names
-
-      if options[:only]
-        options.delete(:except)
-        attribute_names = attribute_names & Array(options[:only]).collect { |n| n.to_s }
-      else
-        options[:except] = Array(options[:except]) | Array(@record.class.inheritance_column)
-        attribute_names = attribute_names - options[:except].collect { |n| n.to_s }
-      end
-      
-      attribute_names.collect { |name| Attribute.new(name, @record) }
+      serializable_attribute_names.collect { |name| Attribute.new(name, @record) }
     end
 
     def serializable_method_attributes
-      Array(options[:methods]).collect { |name| MethodAttribute.new(name.to_s, @record) }
+      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_includes
-      if include_associations = options.delete(:include)
-        root_only_or_except = { :except => options[:except],
-                                :only => options[:only] }
-
-        include_has_options = include_associations.is_a?(Hash)
-
-        for association in include_has_options ? include_associations.keys : Array(include_associations)
-          association_options = include_has_options ? include_associations[association] : root_only_or_except
-
-          opts = options.merge(association_options)
-
-          case @record.class.reflect_on_association(association).macro
-          when :has_many, :has_and_belongs_to_many
-            records = @record.send(association).to_a
-            unless records.empty?
-              tag = records.first.class.to_s.underscore.pluralize
-              tag = tag.dasherize if dasherize?
-
-              builder.tag!(tag) do
-                records.each { |r| r.to_xml(opts.merge(:root => association.to_s.singularize)) }
-              end
-            end
-          when :has_one, :belongs_to
-            if record = @record.send(association)
-              record.to_xml(opts.merge(:root => association))
-            end
-          end
-        end
-
-        options[:include] = include_associations
-      end
-    end
-
     def add_procs
       if procs = options.delete(:procs)
         [ *procs ].each do |proc|
@@ -212,36 +187,64 @@ module ActiveRecord #:nodoc:
       end
     end
 
-
     def add_tag(attribute)
       builder.tag!(
-        dasherize? ? attribute.name.dasherize : attribute.name, 
-        attribute.value.to_s, 
+        dasherize? ? attribute.name.dasherize : attribute.name,
+        attribute.value.to_s,
         attribute.decorations(!options[:skip_types])
       )
     end
 
+    def add_associations(association, records, opts)
+      if records.is_a?(Enumerable)
+        tag = association.to_s
+        tag = tag.dasherize if dasherize?
+        if records.empty?
+          builder.tag!(tag, :type => :array)
+        else
+          builder.tag!(tag, :type => :array) do
+            association_name = association.to_s.singularize
+            records.each do |record|
+              record.to_xml opts.merge(
+                :root => association_name,
+                :type => (record.class.to_s.underscore == association_name ? nil : record.class.name)
+              )
+            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
-        add_includes
+        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        
-    
-    alias_method :to_s, :serialize
+    end
 
     class Attribute #:nodoc:
       attr_reader :name, :value, :type
-    
+
       def initialize(name, record)
         @name, @record = name, record
-      
+
         @type  = compute_type
         @value = compute_value
       end
@@ -258,24 +261,28 @@ module ActiveRecord #:nodoc:
       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 = @record.class.columns_hash[name].type
+          type = @record.class.serialized_attributes.has_key?(name) ? :yaml : @record.class.columns_hash[name].type
 
           case type
             when :text
@@ -286,10 +293,10 @@ module ActiveRecord #:nodoc:
               type
           end
         end
-    
+
         def compute_value
           value = @record.send(name)
-        
+
           if formatter = Hash::XML_FORMATTING[type.to_s]
             value ? formatter.call(value) : nil
           else

data/lib/active_record/timestamp.rb

@@ -1,6 +1,6 @@
 module ActiveRecord
-  # Active Record automatically timestamps create and update if the table has fields
-  # created_at/created_on or updated_at/updated_on.
+  # Active Record automatically timestamps create and update operations if the table has fields
+  # named created_at/created_on or updated_at/updated_on.
   #
   # Timestamping can be turned off by setting
   #   <tt>ActiveRecord::Base.record_timestamps = false</tt>
@@ -9,34 +9,33 @@ module ActiveRecord
   #   <tt>ActiveRecord::Base.default_timezone = :utc</tt>
   module Timestamp
     def self.included(base) #:nodoc:
-      super
-
       base.alias_method_chain :create, :timestamps
       base.alias_method_chain :update, :timestamps
 
-      base.cattr_accessor :record_timestamps, :instance_writer => false
+      base.class_inheritable_accessor :record_timestamps, :instance_writer => false
       base.record_timestamps = true
     end
 
-    def create_with_timestamps #:nodoc:
-      if record_timestamps
-        t = self.class.default_timezone == :utc ? Time.now.utc : Time.now
-        write_attribute('created_at', t) if respond_to?(:created_at) && created_at.nil?
-        write_attribute('created_on', t) if respond_to?(:created_on) && created_on.nil?
+    private
+      def create_with_timestamps #:nodoc:
+        if record_timestamps
+          t = self.class.default_timezone == :utc ? Time.now.utc : Time.now
+          write_attribute('created_at', t) if respond_to?(:created_at) && created_at.nil?
+          write_attribute('created_on', t) if respond_to?(:created_on) && created_on.nil?
 
-        write_attribute('updated_at', t) if respond_to?(:updated_at)
-        write_attribute('updated_on', t) if respond_to?(:updated_on)
+          write_attribute('updated_at', t) if respond_to?(:updated_at)
+          write_attribute('updated_on', t) if respond_to?(:updated_on)
+        end
+        create_without_timestamps
       end
-      create_without_timestamps
-    end
 
-    def update_with_timestamps #:nodoc:
-      if record_timestamps
-        t = self.class.default_timezone == :utc ? Time.now.utc : Time.now
-        write_attribute('updated_at', t) if respond_to?(:updated_at)
-        write_attribute('updated_on', t) if respond_to?(:updated_on)
+      def update_with_timestamps #:nodoc:
+        if record_timestamps
+          t = self.class.default_timezone == :utc ? Time.now.utc : Time.now
+          write_attribute('updated_at', t) if respond_to?(:updated_at)
+          write_attribute('updated_on', t) if respond_to?(:updated_on)
+        end
+        update_without_timestamps
       end
-      update_without_timestamps
-    end
   end
 end

data/lib/active_record/transactions.rb

@@ -1,5 +1,3 @@
-require 'active_record/vendor/simple.rb'
-Transaction::Simple.send(:remove_method, :transaction)
 require 'thread'
 
 module ActiveRecord
@@ -32,6 +30,19 @@ module ActiveRecord
     # Exceptions will force a ROLLBACK that returns the database to the state before the transaction was begun. Be aware, though,
     # that the objects by default will _not_ have their instance data returned to their pre-transactional state.
     #
+    # == Different ActiveRecord classes in a single transaction
+    #
+    # Though the transaction class method is called on some ActiveRecord class,
+    # the objects within the transaction block need not all be instances of
+    # that class.
+    # In this example a <tt>Balance</tt> record is transactionally saved even
+    # though <tt>transaction</tt> is called on the <tt>Account</tt> class:
+    #
+    #   Account.transaction do
+    #     balance.save!
+    #     account.save!
+    #   end
+    #
     # == Transactions are not distributed across database connections
     #
     # A transaction acts on a single database connection.  If you have
@@ -53,52 +64,20 @@ module ActiveRecord
     #
     # Both Base#save and Base#destroy come wrapped in a transaction that ensures that whatever you do in validations or callbacks
     # will happen under the protected cover of a transaction. So you can use validations to check for values that the transaction
-    # depend on or you can raise exceptions in the callbacks to rollback.
-    #
-    # == Object-level transactions (deprecated)
-    #
-    # You can enable object-level transactions for Active Record objects, though. You do this by naming each of the Active Records
-    # that you want to enable object-level transactions for, like this:
-    #
-    #   Account.transaction(david, mary) do
-    #     david.withdrawal(100)
-    #     mary.deposit(100)
-    #   end
-    #
-    # If the transaction fails, David and Mary will be returned to their
-    # pre-transactional state. No money will have changed hands in neither
-    # object nor database.
-    #
-    # However, useful state such as validation errors are also rolled back,
-    # limiting the usefulness of this feature. As such it is deprecated in
-    # Rails 1.2 and will be removed in the next release. Install the
-    # object_transactions plugin if you wish to continue using it.
+    # depends on or you can raise exceptions in the callbacks to rollback.
     #
     # == Exception handling
     #
     # Also have in mind that exceptions thrown within a transaction block will be propagated (after triggering the ROLLBACK), so you
-    # should be ready to catch those in your application code.
-    #
-    # Tribute: Object-level transactions are implemented by Transaction::Simple by Austin Ziegler.
+    # should be ready to catch those in your application code. One exception is the ActiveRecord::Rollback exception, which will
+    # trigger a ROLLBACK when raised, but not be re-raised by the transaction block.
     module ClassMethods
-      def transaction(*objects, &block)
+      def transaction(&block)
         previous_handler = trap('TERM') { raise TransactionError, "Transaction aborted" }
         increment_open_transactions
 
         begin
-          unless objects.empty?
-            ActiveSupport::Deprecation.warn "Object transactions are deprecated and will be removed from Rails 2.0.  See http://www.rubyonrails.org/deprecation for details.", caller
-            objects.each { |o| o.extend(Transaction::Simple) }
-            objects.each { |o| o.start_transaction }
-          end
-
-          result = connection.transaction(Thread.current['start_db_transaction'], &block)
-
-          objects.each { |o| o.commit_transaction }
-          return result
-        rescue Exception => object_transaction_rollback
-          objects.each { |o| o.abort_transaction }
-          raise
+          connection.transaction(Thread.current['start_db_transaction'], &block)
         ensure
           decrement_open_transactions
           trap('TERM', previous_handler)
@@ -117,8 +96,8 @@ module ActiveRecord
         end
     end
 
-    def transaction(*objects, &block)
-      self.class.transaction(*objects, &block)
+    def transaction(&block)
+      self.class.transaction(&block)
     end
 
     def destroy_with_transactions #:nodoc:
@@ -126,11 +105,28 @@ module ActiveRecord
     end
 
     def save_with_transactions(perform_validation = true) #:nodoc:
-      transaction { save_without_transactions(perform_validation) }
+      rollback_active_record_state! { transaction { save_without_transactions(perform_validation) } }
     end
 
     def save_with_transactions! #:nodoc:
-      transaction { save_without_transactions! }
+      rollback_active_record_state! { transaction { save_without_transactions! } }
+    end
+
+    # Reset id and @new_record if the transaction rolls back.
+    def rollback_active_record_state!
+      id_present = has_attribute?(self.class.primary_key)
+      previous_id = id
+      previous_new_record = @new_record
+      yield
+    rescue Exception
+      @new_record = previous_new_record
+      if id_present
+        self.id = previous_id
+      else
+        @attributes.delete(self.class.primary_key)
+        @attributes_cache.delete(self.class.primary_key)
+      end  
+      raise
     end
   end
 end