activerecord 2.3.18 → 3.2.22

data/lib/active_record/scoping/named.rb

@@ -0,0 +1,200 @@
+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
+  module Scoping
+    module Named
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Returns an anonymous \scope.
+        #
+        #   posts = Post.scoped
+        #   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 = 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)
+          else
+            if current_scope
+              current_scope.clone
+            else
+              scope = relation
+              scope.default_scoped = true
+              scope
+            end
+          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:
+          if current_scope
+            current_scope.scope_for_create
+          else
+            scope = relation
+            scope.default_scoped = true
+            scope.scope_for_create
+          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>.
+        #
+        #   class Shirt < ActiveRecord::Base
+        #     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>.
+        #
+        # Note that this is simply 'syntactic sugar' for defining an actual class method:
+        #
+        #   class Shirt < ActiveRecord::Base
+        #     def self.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,
+        #
+        #   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
+        #
+        # Named \scopes can also have extensions, just as with <tt>has_many</tt> declarations:
+        #
+        #   class Shirt < ActiveRecord::Base
+        #     scope :red, where(:color => 'red') do
+        #       def dom_id
+        #         'red_shirts'
+        #       end
+        #     end
+        #   end
+        #
+        # Scopes can also be used while creating/building a record.
+        #
+        #   class Article < ActiveRecord::Base
+        #     scope :published, where(:published => true)
+        #   end
+        #
+        #   Article.published.new.published    # => true
+        #   Article.published.create.published # => true
+        #
+        # 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)
+        #
+        #     def self.latest_article
+        #       order('published_at desc').first
+        #     end
+        #
+        #     def self.titles
+        #       pluck(:title)
+        #     end
+        #   end
+        #
+        # We are able to call the methods like this:
+        #
+        #   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?
+
+          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
+          end
+
+          singleton_class.send(:redefine_method, name, &scope_proc)
+        end
+
+      protected
+
+        def valid_scope_name?(name)
+          if logger && respond_to?(name, true)
+            logger.warn "Creating scope :#{name}. " \
+                        "Overwriting existing method #{self.name}.#{name}."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/scoping.rb

@@ -0,0 +1,152 @@
+require 'active_support/concern'
+
+module ActiveRecord
+  module Scoping
+    extend ActiveSupport::Concern
+
+    included do
+      include Default
+      include Named
+    end
+
+    module ClassMethods
+      # with_scope lets you apply options to inner block incrementally. It takes a hash and the keys must be
+      # <tt>:find</tt> or <tt>:create</tt>. <tt>:find</tt> parameter is <tt>Relation</tt> while
+      # <tt>:create</tt> parameters are an attributes hash.
+      #
+      #   class Article < ActiveRecord::Base
+      #     def self.create_with_scope
+      #       with_scope(:find => where(:blog_id => 1), :create => { :blog_id => 1 }) do
+      #         find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
+      #         a = create(1)
+      #         a.blog_id # => 1
+      #       end
+      #     end
+      #   end
+      #
+      # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
+      # <tt>where</tt>, <tt>includes</tt>, and <tt>joins</tt> operations in <tt>Relation</tt>, which are merged.
+      #
+      # <tt>joins</tt> operations are uniqued so multiple scopes can join in the same table without table aliasing
+      # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
+      # array of strings format for your joins.
+      #
+      #   class Article < ActiveRecord::Base
+      #     def self.find_with_scope
+      #       with_scope(:find => where(:blog_id => 1).limit(1), :create => { :blog_id => 1 }) do
+      #         with_scope(:find => limit(10)) do
+      #           all # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
+      #         end
+      #         with_scope(:find => where(:author_id => 3)) do
+      #           all # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
+      #         end
+      #       end
+      #     end
+      #   end
+      #
+      # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
+      #
+      #   class Article < ActiveRecord::Base
+      #     def self.find_with_exclusive_scope
+      #       with_scope(:find => where(:blog_id => 1).limit(1)) do
+      #         with_exclusive_scope(:find => limit(10)) do
+      #           all # => SELECT * from articles LIMIT 10
+      #         end
+      #       end
+      #     end
+      #   end
+      #
+      # *Note*: the +:find+ scope also has effect on update and deletion methods, like +update_all+ and +delete_all+.
+      def with_scope(scope = {}, action = :merge, &block)
+        # If another Active Record class has been passed in, get its current scope
+        scope = scope.current_scope if !scope.is_a?(Relation) && scope.respond_to?(:current_scope)
+
+        previous_scope = self.current_scope
+
+        if scope.is_a?(Hash)
+          # Dup first and second level of hash (method and params).
+          scope = scope.dup
+          scope.each do |method, params|
+            scope[method] = params.dup unless params == true
+          end
+
+          scope.assert_valid_keys([ :find, :create ])
+          relation = construct_finder_arel(scope[:find] || {})
+          relation.default_scoped = true unless action == :overwrite
+
+          if previous_scope && previous_scope.create_with_value && scope[:create]
+            scope_for_create = if action == :merge
+              previous_scope.create_with_value.merge(scope[:create])
+            else
+              scope[:create]
+            end
+
+            relation = relation.create_with(scope_for_create)
+          else
+            scope_for_create = scope[:create]
+            scope_for_create ||= previous_scope.create_with_value if previous_scope
+            relation = relation.create_with(scope_for_create) if scope_for_create
+          end
+
+          scope = relation
+        end
+
+        scope = previous_scope.merge(scope) if previous_scope && action == :merge
+
+        self.current_scope = scope
+        begin
+          yield
+        ensure
+          self.current_scope = previous_scope
+        end
+      end
+
+      protected
+
+      # Works like with_scope, but discards any nested properties.
+      def with_exclusive_scope(method_scoping = {}, &block)
+        if method_scoping.values.any? { |e| e.is_a?(ActiveRecord::Relation) }
+          raise ArgumentError, <<-MSG
+  New finder API can not be used with_exclusive_scope. You can either call unscoped to get an anonymous scope not bound to the default_scope:
+
+  User.unscoped.where(:active => true)
+
+  Or call unscoped with a block:
+
+  User.unscoped do
+  User.where(:active => true).all
+  end
+
+  MSG
+        end
+        with_scope(method_scoping, :overwrite, &block)
+      end
+
+      def current_scope #:nodoc:
+        Thread.current["#{self}_current_scope"]
+      end
+
+      def current_scope=(scope) #:nodoc:
+        Thread.current["#{self}_current_scope"] = scope
+      end
+
+      private
+
+      def construct_finder_arel(options = {}, scope = nil)
+        relation = options.is_a?(Hash) ? unscoped.apply_finder_options(options) : options
+        relation = scope.merge(relation) if scope
+        relation
+      end
+
+    end
+
+    def populate_with_current_scope_attributes
+      return unless self.class.scope_attributes?
+
+      self.class.scope_attributes.each do |att,value|
+        send("#{att}=", value) if respond_to?("#{att}=")
+      end
+    end
+
+  end
+end

data/lib/active_record/serialization.rb

@@ -1,101 +1,18 @@
-require 'active_support/json'
-
 module ActiveRecord #:nodoc:
+  # = Active Record Serialization
   module Serialization
-    class Serializer #:nodoc:
-      attr_reader :options
-
-      def initialize(record, options = nil)
-        @record = record
-        @options = options ? options.dup : {}
-      end
-
-      # To replicate the behavior in ActiveRecord#attributes,
-      # <tt>:except</tt> takes precedence over <tt>:only</tt>.  If <tt>:only</tt> is not set
-      # for a N level model but is set for the N+1 level models,
-      # then because <tt>:except</tt> is set to a default value, the second
-      # level model can have both <tt>:except</tt> and <tt>:only</tt> set.  So if
-      # <tt>:only</tt> is set, always delete <tt>:except</tt>.
-      def serializable_attribute_names
-        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
-      end
-
-      def serializable_method_names
-        Array(options[:methods]).inject([]) do |method_attributes, name|
-          method_attributes << name if @record.respond_to?(name.to_s)
-          method_attributes
-        end
-      end
-
-      def serializable_names
-        serializable_attribute_names + serializable_method_names
-      end
-
-      # Add associations specified via the <tt>:includes</tt> option.
-      # Expects a block that takes as arguments:
-      #   +association+ - name of the association
-      #   +records+     - the association record(s) to be serialized
-      #   +opts+        - options for the association records
-      def add_includes(&block)
-        if include_associations = options.delete(:include)
-          base_only_or_except = { :except => options[:except],
-                                  :only => options[:only] }
-
-          include_has_options = include_associations.is_a?(Hash)
-          associations = include_has_options ? include_associations.keys : Array(include_associations)
-
-          for association in associations
-            records = case @record.class.reflect_on_association(association).macro
-            when :has_many, :has_and_belongs_to_many
-              @record.send(association).to_a
-            when :has_one, :belongs_to
-              @record.send(association)
-            end
-
-            unless records.nil?
-              association_options = include_has_options ? include_associations[association] : base_only_or_except
-              opts = options.merge(association_options)
-              yield(association, records, opts)
-            end
-          end
-
-          options[:include] = include_associations
-        end
-      end
+    extend ActiveSupport::Concern
+    include ActiveModel::Serializers::JSON
 
-      def serializable_record
-        {}.tap do |serializable_record|
-          serializable_names.each { |name| serializable_record[name] = @record.send(name) }
-          add_includes do |association, records, opts|
-            if records.is_a?(Enumerable)
-              serializable_record[association] = records.collect { |r| self.class.new(r, opts).serializable_record }
-            else
-              serializable_record[association] = self.class.new(records, opts).serializable_record
-            end
-          end
-        end
-      end
+    def serializable_hash(options = nil)
+      options = options.try(:clone) || {}
 
-      def serialize
-        # overwrite to implement
-      end
+      options[:except] = Array.wrap(options[:except]).map { |n| n.to_s }
+      options[:except] |= Array.wrap(self.class.inheritance_column)
 
-      def to_s(&block)
-        serialize(&block)
-      end
+      super(options)
     end
   end
 end
 
 require 'active_record/serializers/xml_serializer'
-require 'active_record/serializers/json_serializer'