activerecord 3.2.22.5 → 4.0.0.beta1

data/lib/active_record/scoping/named.rb

@@ -1,47 +1,36 @@
 require 'active_support/core_ext/array'
 require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/kernel/singleton_class'
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/class/attribute'
 
 module ActiveRecord
-  # = Active Record Named \Scopes
+  # = Active Record \Named \Scopes
   module Scoping
     module Named
       extend ActiveSupport::Concern
 
       module ClassMethods
-        # Returns an anonymous \scope.
+        # Returns an <tt>ActiveRecord::Relation</tt> scope object.
         #
-        #   posts = Post.scoped
+        #   posts = Post.all
         #   posts.size # Fires "select count(*) from  posts" and returns the count
         #   posts.each {|p| puts p.name } # Fires "select * from posts" and loads post objects
         #
-        #   fruits = Fruit.scoped
-        #   fruits = fruits.where(:color => 'red') if options[:red_only]
+        #   fruits = Fruit.all
+        #   fruits = fruits.where(color: 'red') if options[:red_only]
         #   fruits = fruits.limit(10) if limited?
         #
-        # Anonymous \scopes tend to be useful when procedurally generating complex
-        # queries, where passing intermediate values (\scopes) around as first-class
-        # objects is convenient.
-        #
-        # You can define a \scope that applies to all finders using
-        # ActiveRecord::Base.default_scope.
-        def scoped(options = nil)
-          if options
-            scoped.apply_finder_options(options)
+        # You can define a scope that applies to all finders using
+        # <tt>ActiveRecord::Base.default_scope</tt>.
+        def all
+          if current_scope
+            current_scope.clone
           else
-            if current_scope
-              current_scope.clone
-            else
-              scope = relation
-              scope.default_scoped = true
-              scope
-            end
+            scope = relation
+            scope.default_scoped = true
+            scope
           end
         end
 
-        ##
         # Collects attributes from scopes that should be applied when creating
         # an AR instance for the particular class this is called on.
         def scope_attributes # :nodoc:
@@ -54,86 +43,70 @@ module ActiveRecord
           end
         end
 
-        ##
         # Are there default attributes associated with this scope?
         def scope_attributes? # :nodoc:
           current_scope || default_scopes.any?
         end
 
-        # Adds a class method for retrieving and querying objects. A \scope represents a narrowing of a database query,
-        # such as <tt>where(:color => :red).select('shirts.*').includes(:washing_instructions)</tt>.
+        # Adds a class method for retrieving and querying objects. A \scope
+        # represents a narrowing of a database query, such as
+        # <tt>where(color: :red).select('shirts.*').includes(:washing_instructions)</tt>.
         #
         #   class Shirt < ActiveRecord::Base
-        #     scope :red, where(:color => 'red')
-        #     scope :dry_clean_only, joins(:washing_instructions).where('washing_instructions.dry_clean_only = ?', true)
+        #     scope :red, -> { where(color: 'red') }
+        #     scope :dry_clean_only, -> { joins(:washing_instructions).where('washing_instructions.dry_clean_only = ?', true) }
         #   end
         #
-        # The above calls to <tt>scope</tt> define class methods Shirt.red and Shirt.dry_clean_only. Shirt.red,
-        # in effect, represents the query <tt>Shirt.where(:color => 'red')</tt>.
+        # The above calls to +scope+ define class methods <tt>Shirt.red</tt> and
+        # <tt>Shirt.dry_clean_only</tt>. <tt>Shirt.red</tt>, in effect,
+        # represents the query <tt>Shirt.where(color: 'red')</tt>.
         #
-        # Note that this is simply 'syntactic sugar' for defining an actual class method:
+        # You should always pass a callable object to the scopes defined
+        # with +scope+. This ensures that the scope is re-evaluated each
+        # time it is called.
+        #
+        # Note that this is simply 'syntactic sugar' for defining an actual
+        # class method:
         #
         #   class Shirt < ActiveRecord::Base
         #     def self.red
-        #       where(:color => 'red')
+        #       where(color: 'red')
         #     end
         #   end
         #
-        # Unlike <tt>Shirt.find(...)</tt>, however, the object returned by Shirt.red is not an Array; it
-        # resembles the association object constructed by a <tt>has_many</tt> declaration. For instance,
-        # you can invoke <tt>Shirt.red.first</tt>, <tt>Shirt.red.count</tt>, <tt>Shirt.red.where(:size => 'small')</tt>.
-        # Also, just as with the association objects, named \scopes act like an Array, implementing Enumerable;
-        # <tt>Shirt.red.each(&block)</tt>, <tt>Shirt.red.first</tt>, and <tt>Shirt.red.inject(memo, &block)</tt>
-        # all behave as if Shirt.red really was an Array.
-        #
-        # These named \scopes are composable. For instance, <tt>Shirt.red.dry_clean_only</tt> will produce
-        # all shirts that are both red and dry clean only.
-        # Nested finds and calculations also work with these compositions: <tt>Shirt.red.dry_clean_only.count</tt>
-        # returns the number of garments for which these criteria obtain. Similarly with
-        # <tt>Shirt.red.dry_clean_only.average(:thread_count)</tt>.
-        #
-        # All \scopes are available as class methods on the ActiveRecord::Base descendant upon which
-        # the \scopes were defined. But they are also available to <tt>has_many</tt> associations. If,
+        # Unlike <tt>Shirt.find(...)</tt>, however, the object returned by
+        # <tt>Shirt.red</tt> is not an Array; it resembles the association object
+        # constructed by a +has_many+ declaration. For instance, you can invoke
+        # <tt>Shirt.red.first</tt>, <tt>Shirt.red.count</tt>,
+        # <tt>Shirt.red.where(size: 'small')</tt>. Also, just as with the
+        # association objects, named \scopes act like an Array, implementing
+        # Enumerable; <tt>Shirt.red.each(&block)</tt>, <tt>Shirt.red.first</tt>,
+        # and <tt>Shirt.red.inject(memo, &block)</tt> all behave as if
+        # <tt>Shirt.red</tt> really was an Array.
+        #
+        # These named \scopes are composable. For instance,
+        # <tt>Shirt.red.dry_clean_only</tt> will produce all shirts that are
+        # both red and dry clean only. Nested finds and calculations also work
+        # with these compositions: <tt>Shirt.red.dry_clean_only.count</tt>
+        # returns the number of garments for which these criteria obtain.
+        # Similarly with <tt>Shirt.red.dry_clean_only.average(:thread_count)</tt>.
+        #
+        # All scopes are available as class methods on the ActiveRecord::Base
+        # descendant upon which the \scopes were defined. But they are also
+        # available to +has_many+ associations. If,
         #
         #   class Person < ActiveRecord::Base
         #     has_many :shirts
         #   end
         #
-        # then <tt>elton.shirts.red.dry_clean_only</tt> will return all of Elton's red, dry clean
-        # only shirts.
-        #
-        # Named \scopes can also be procedural:
-        #
-        #   class Shirt < ActiveRecord::Base
-        #     scope :colored, lambda { |color| where(:color => color) }
-        #   end
-        #
-        # In this example, <tt>Shirt.colored('puce')</tt> finds all puce shirts.
-        #
-        # On Ruby 1.9 you can use the 'stabby lambda' syntax:
-        #
-        #   scope :colored, ->(color) { where(:color => color) }
-        #
-        # Note that scopes defined with \scope will be evaluated when they are defined, rather than
-        # when they are used. For example, the following would be incorrect:
-        #
-        #   class Post < ActiveRecord::Base
-        #     scope :recent, where('published_at >= ?', Time.current - 1.week)
-        #   end
-        #
-        # The example above would be 'frozen' to the <tt>Time.current</tt> value when the <tt>Post</tt>
-        # class was defined, and so the resultant SQL query would always be the same. The correct
-        # way to do this would be via a lambda, which will re-evaluate the scope each time
-        # it is called:
-        #
-        #   class Post < ActiveRecord::Base
-        #     scope :recent, lambda { where('published_at >= ?', Time.current - 1.week) }
-        #   end
+        # then <tt>elton.shirts.red.dry_clean_only</tt> will return all of
+        # Elton's red, dry clean only shirts.
         #
-        # Named \scopes can also have extensions, just as with <tt>has_many</tt> declarations:
+        # \Named scopes can also have extensions, just as with +has_many+
+        # declarations:
         #
         #   class Shirt < ActiveRecord::Base
-        #     scope :red, where(:color => 'red') do
+        #     scope :red, -> { where(color: 'red') } do
         #       def dom_id
         #         'red_shirts'
         #       end
@@ -143,18 +116,18 @@ module ActiveRecord
         # Scopes can also be used while creating/building a record.
         #
         #   class Article < ActiveRecord::Base
-        #     scope :published, where(:published => true)
+        #     scope :published, -> { where(published: true) }
         #   end
         #
         #   Article.published.new.published    # => true
         #   Article.published.create.published # => true
         #
-        # Class methods on your model are automatically available
+        # \Class methods on your model are automatically available
         # on scopes. Assuming the following setup:
         #
         #   class Article < ActiveRecord::Base
-        #     scope :published, where(:published => true)
-        #     scope :featured, where(:featured => true)
+        #     scope :published, -> { where(published: true) }
+        #     scope :featured, -> { where(featured: true) }
         #
         #     def self.latest_article
         #       order('published_at desc').first
@@ -169,29 +142,27 @@ module ActiveRecord
         #
         #   Article.published.featured.latest_article
         #   Article.featured.titles
-        def scope(name, scope_options = {})
-          name = name.to_sym
-          valid_scope_name?(name)
-          extension = Module.new(&Proc.new) if block_given?
+        def scope(name, body, &block)
+          extension = Module.new(&block) if block
 
-          scope_proc = lambda do |*args|
-            options = scope_options.respond_to?(:call) ? unscoped { scope_options.call(*args) } : scope_options
-            options = scoped.apply_finder_options(options) if options.is_a?(Hash)
-
-            relation = scoped.merge(options)
-
-            extension ? relation.extending(extension) : relation
+          # Check body.is_a?(Relation) to prevent the relation actually being
+          # loaded by respond_to?
+          if body.is_a?(Relation) || !body.respond_to?(:call)
+            ActiveSupport::Deprecation.warn(
+              "Using #scope without passing a callable object is deprecated. For " \
+              "example `scope :red, where(color: 'red')` should be changed to " \
+              "`scope :red, -> { where(color: 'red') }`. There are numerous gotchas " \
+              "in the former usage and it makes the implementation more complicated " \
+              "and buggy. (If you prefer, you can just define a class method named " \
+              "`self.red`.)"
+            )
           end
 
-          singleton_class.send(:redefine_method, name, &scope_proc)
-        end
-
-      protected
+          singleton_class.send(:define_method, name) do |*args|
+            options  = body.respond_to?(:call) ? unscoped { body.call(*args) } : body
+            relation = all.merge(options)
 
-        def valid_scope_name?(name)
-          if logger && respond_to?(name, true)
-            logger.warn "Creating scope :#{name}. " \
-                        "Overwriting existing method #{self.name}.#{name}."
+            extension ? relation.extending(extension) : relation
           end
         end
       end

data/lib/active_record/serialization.rb

@@ -4,11 +4,15 @@ module ActiveRecord #:nodoc:
     extend ActiveSupport::Concern
     include ActiveModel::Serializers::JSON
 
+    included do
+      self.include_root_in_json = true
+    end
+
     def serializable_hash(options = nil)
       options = options.try(:clone) || {}
 
-      options[:except] = Array.wrap(options[:except]).map { |n| n.to_s }
-      options[:except] |= Array.wrap(self.class.inheritance_column)
+      options[:except] = Array(options[:except]).map { |n| n.to_s }
+      options[:except] |= Array(self.class.inheritance_column)
 
       super(options)
     end

data/lib/active_record/serializers/xml_serializer.rb

@@ -1,4 +1,3 @@
-require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/hash/conversions'
 
 module ActiveRecord #:nodoc:
@@ -19,8 +18,8 @@ module ActiveRecord #:nodoc:
     #     <id type="integer">1</id>
     #     <approved type="boolean">false</approved>
     #     <replies-count type="integer">0</replies-count>
-    #     <bonus-time type="datetime">2000-01-01T08:28:00+12:00</bonus-time>
-    #     <written-on type="datetime">2003-07-16T09:28:00+1200</written-on>
+    #     <bonus-time type="dateTime">2000-01-01T08:28:00+12:00</bonus-time>
+    #     <written-on type="dateTime">2003-07-16T09:28:00+1200</written-on>
     #     <content>Have a nice day</content>
     #     <author-email-address>david@loudthinking.com</author-email-address>
     #     <parent-id></parent-id>
@@ -37,7 +36,7 @@ module ActiveRecord #:nodoc:
     #
     # For instance:
     #
-    #   topic.to_xml(:skip_instruct => true, :except => [ :id, :bonus_time, :written_on, :replies_count ])
+    #   topic.to_xml(skip_instruct: true, except: [ :id, :bonus_time, :written_on, :replies_count ])
     #
     #   <topic>
     #     <title>The First Topic</title>
@@ -51,7 +50,7 @@ module ActiveRecord #:nodoc:
     #
     # To include first level associations use <tt>:include</tt>:
     #
-    #   firm.to_xml :include => [ :account, :clients ]
+    #   firm.to_xml include: [ :account, :clients ]
     #
     #   <?xml version="1.0" encoding="UTF-8"?>
     #   <firm>
@@ -82,7 +81,7 @@ module ActiveRecord #:nodoc:
     # associated with models.
     #
     #   proc = Proc.new { |options, record| options[:builder].tag!('name-reverse', record.name.reverse) }
-    #   firm.to_xml :procs => [ proc ]
+    #   firm.to_xml procs: [ proc ]
     #
     #   <firm>
     #     # ... normal attributes as shown above ...
@@ -91,7 +90,7 @@ module ActiveRecord #:nodoc:
     #
     # To include deeper levels of associations pass a hash like this:
     #
-    #   firm.to_xml :include => {:account => {}, :clients => {:include => :address}}
+    #   firm.to_xml include: {account: {}, clients: {include: :address}}
     #   <?xml version="1.0" encoding="UTF-8"?>
     #   <firm>
     #     <id type="integer">1</id>
@@ -121,7 +120,7 @@ module ActiveRecord #:nodoc:
     #
     # To include any methods on the model being called use <tt>:methods</tt>:
     #
-    #   firm.to_xml :methods => [ :calculated_earnings, :real_earnings ]
+    #   firm.to_xml methods: [ :calculated_earnings, :real_earnings ]
     #
     #   <firm>
     #     # ... normal attributes as shown above ...
@@ -133,7 +132,7 @@ module ActiveRecord #:nodoc:
     # modified version of the options hash that was given to +to_xml+:
     #
     #   proc = Proc.new { |options| options[:builder].tag!('abc', 'def') }
-    #   firm.to_xml :procs => [ proc ]
+    #   firm.to_xml procs: [ proc ]
     #
     #   <firm>
     #     # ... normal attributes as shown above ...
@@ -165,7 +164,7 @@ module ActiveRecord #:nodoc:
     #     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')
@@ -178,11 +177,6 @@ module ActiveRecord #:nodoc:
   end
 
   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

data/lib/active_record/store.rb

@@ -1,6 +1,8 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
 module ActiveRecord
   # Store gives you a thin wrapper around serialize for the purpose of storing hashes in a single column.
-  # It's like a simple key/value store backed into your record when you don't care about being able to
+  # It's like a simple key/value store baked into your record when you don't care about being able to
   # query that store outside the context of a single record.
   #
   # You can then declare accessors to this store that are then accessible just like any other attribute
@@ -10,43 +12,145 @@ module ActiveRecord
   # Make sure that you declare the database column used for the serialized store as a text, so there's
   # plenty of room.
   #
+  # You can set custom coder to encode/decode your serialized attributes to/from different formats.
+  # JSON, YAML, Marshal are supported out of the box. Generally it can be any wrapper that provides +load+ and +dump+.
+  #
   # Examples:
   #
   #   class User < ActiveRecord::Base
-  #     store :settings, accessors: [ :color, :homepage ]
+  #     store :settings, accessors: [ :color, :homepage ], coder: JSON
   #   end
-  #   
+  #
   #   u = User.new(color: 'black', homepage: '37signals.com')
   #   u.color                          # Accessor stored attribute
   #   u.settings[:country] = 'Denmark' # Any attribute, even if not specified with an accessor
   #
+  #   # There is no difference between strings and symbols for accessing custom attributes
+  #   u.settings[:country]  # => 'Denmark'
+  #   u.settings['country'] # => 'Denmark'
+  #
   #   # Add additional accessors to an existing store through store_accessor
   #   class SuperUser < User
   #     store_accessor :settings, :privileges, :servants
   #   end
+  #
+  # The stored attribute names can be retrieved using +stored_attributes+.
+  #
+  #   User.stored_attributes[:settings] # [:color, :homepage]
+  #
+  # == Overwriting default accessors
+  #
+  # All stored values are automatically available through accessors on the Active Record
+  # object, but sometimes you want to specialize this behavior. This can be done by overwriting
+  # the default accessors (using the same name as the attribute) and calling <tt>super</tt>
+  # to actually change things.
+  #
+  #   class Song < ActiveRecord::Base
+  #     # Uses a stored integer to hold the volume adjustment of the song
+  #     store :settings, accessors: [:volume_adjustment]
+  #
+  #     def volume_adjustment=(decibels)
+  #       super(decibels.to_i)
+  #     end
+  #
+  #     def volume_adjustment
+  #       super.to_i
+  #     end
+  #   end
   module Store
     extend ActiveSupport::Concern
-  
+
+    included do
+      class_attribute :stored_attributes, instance_accessor: false
+      self.stored_attributes = {}
+    end
+
     module ClassMethods
       def store(store_attribute, options = {})
-        serialize store_attribute, Hash
+        serialize store_attribute, IndifferentCoder.new(options[:coder])
         store_accessor(store_attribute, options[:accessors]) if options.has_key? :accessors
       end
 
       def store_accessor(store_attribute, *keys)
-        Array(keys).flatten.each do |key|
-          define_method("#{key}=") do |value|
-            send("#{store_attribute}=", {}) unless send(store_attribute).is_a?(Hash)
-            send("#{store_attribute}_will_change!")
-            send(store_attribute)[key] = value
+        keys = keys.flatten
+
+        _store_accessors_module.module_eval do
+          keys.each do |key|
+            define_method("#{key}=") do |value|
+              write_store_attribute(store_attribute, key, value)
+            end
+
+            define_method(key) do
+              read_store_attribute(store_attribute, key)
+            end
           end
-    
-          define_method(key) do
-            send("#{store_attribute}=", {}) unless send(store_attribute).is_a?(Hash)
-            send(store_attribute)[key]
+        end
+
+        self.stored_attributes[store_attribute] ||= []
+        self.stored_attributes[store_attribute] |= keys
+      end
+
+      def _store_accessors_module
+        @_store_accessors_module ||= begin
+          mod = Module.new
+          include mod
+          mod
+        end
+      end
+    end
+
+    protected
+      def read_store_attribute(store_attribute, key)
+        attribute = initialize_store_attribute(store_attribute)
+        attribute[key]
+      end
+
+      def write_store_attribute(store_attribute, key, value)
+        attribute = initialize_store_attribute(store_attribute)
+        if value != attribute[key]
+          send :"#{store_attribute}_will_change!"
+          attribute[key] = value
+        end
+      end
+
+    private
+      def initialize_store_attribute(store_attribute)
+        attribute = send(store_attribute)
+        unless attribute.is_a?(ActiveSupport::HashWithIndifferentAccess)
+          attribute = IndifferentCoder.as_indifferent_hash(attribute)
+          send :"#{store_attribute}=", attribute
+        end
+        attribute
+      end
+
+    class IndifferentCoder # :nodoc:
+      def initialize(coder_or_class_name)
+        @coder =
+          if coder_or_class_name.respond_to?(:load) && coder_or_class_name.respond_to?(:dump)
+            coder_or_class_name
+          else
+            ActiveRecord::Coders::YAMLColumn.new(coder_or_class_name || Object)
           end
+      end
+
+      def dump(obj)
+        @coder.dump self.class.as_indifferent_hash(obj)
+      end
+
+      def load(yaml)
+        self.class.as_indifferent_hash @coder.load(yaml)
+      end
+
+      def self.as_indifferent_hash(obj)
+        case obj
+        when ActiveSupport::HashWithIndifferentAccess
+          obj
+        when Hash
+          obj.with_indifferent_access
+        else
+          ActiveSupport::HashWithIndifferentAccess.new
         end
       end
     end
   end
-end
+end