method

with_scope

v1.0.0 - Show latest stable - Class: ActiveRecord::Base

with_scope(method_scoping = {})

public

Scope parameters to method calls within the block. Takes a hash of method_name => parameters hash. method_name may be :find or :create. :find parameters may include the :conditions, :joins, :offset, :limit, and :readonly options. :create parameters are an attributes hash.

  Article.with_scope(:find => { :conditions => "blog_id = 1" }, :create => { :blog_id => 1 }) do
    Article.find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
    a = Article.create(1)
    a.blog_id == 1
  end

# File activerecord/lib/active_record/base.rb, line 847
      def with_scope(method_scoping = {})
        # Dup first and second level of hash (method and params).
        method_scoping = method_scoping.inject({}) do |hash, (method, params)|
          hash[method] = params.dup
          hash
        end

        method_scoping.assert_valid_keys [:find, :create]
        if f = method_scoping[:find]
          f.assert_valid_keys [:conditions, :joins, :offset, :limit, :readonly]
          f[:readonly] = true if !f[:joins].blank? && !f.has_key?(:readonly)
        end

        raise ArgumentError, "Nested scopes are not yet supported: #{scoped_methods.inspect}" unless scoped_methods.nil?

        self.scoped_methods = method_scoping
        yield
      ensure 
        self.scoped_methods = nil
      end

2Notes

:find takes more keys than written

Mange · Jan 14, 2010

The documentation says that the :find keywords "may include the :conditions, :joins, :include, :offset, :limit, and :readonly options". Note that this does not mean that only those options are supported. :sort also works like it should, for example.

Rails 3.2 / 4.x with_scope replacement

aossowski · Dec 29, 2014

If you're looking for with_scope replacement for newer versions, see http://apidock.com/rails/ActiveRecord/Relation/scoping

with_scope

2Notes

:find takes more keys than written

Rails 3.2 / 4.x with_scope replacement

Related methods