Spec-Zone.ru › Ruby on Rails 6.1

модуль ActiveRecord::Scoping::Default::ClassMethods

Общедоступные методы экземпляра

unscoped() { || ... } Показать исходный код
# File activerecord/lib/active_record/scoping/default.rb, line 33
def unscoped
  block_given? ? relation.scoping { yield } : relation
end

Возвращает область поиска для модели без ранее установленных областей поиска.

class Post < ActiveRecord::Base
  def self.default_scope
    where(published: true)
  end
end

Post.all                                  # Fires "SELECT * FROM posts WHERE published = true"
Post.unscoped.all                         # Fires "SELECT * FROM posts"
Post.where(published: false).unscoped.all # Fires "SELECT * FROM posts"

Этот метод также принимает блок. Все запросы внутри блока не будут использовать ранее установленные области поиска.

Post.unscoped {
  Post.limit(10) # Fires "SELECT * FROM posts LIMIT 10"
}

Приватные методы экземпляра

default_scope(scope = nil, &block) Показать исходный код
# File activerecord/lib/active_record/scoping/default.rb, line 88
def default_scope(scope = nil, &block) # :doc:
  scope = block if block_given?

  if scope.is_a?(Relation) || !scope.respond_to?(:call)
    raise ArgumentError,
      "Support for calling #default_scope without a block is removed. For example instead " \
      "of `default_scope where(color: 'red')`, please use " \
      "`default_scope { where(color: 'red') }`. (Alternatively you can just redefine " \
      "self.default_scope.)"
  end

  self.default_scopes += [scope]
end

Используйте эту макрокоманду в вашей модели для установки области поиска по умолчанию для всех операций с моделью.

class Article < ActiveRecord::Base
  default_scope { where(published: true) }
end

Article.all # => SELECT * FROM articles WHERE published = true

Область поиска по умолчанию (default_scope) также применяется при создании/создании записи. Она не применяется при обновлении записи.

Article.new.published    # => true
Article.create.published # => true

(Вы также можете передать любой объект, который отвечает на call методу, макрокоманде default_scope, и он будет вызван при построении области поиска по умолчанию.)

Если вы используете несколько объявлений default_scope в вашей модели, они будут объединены:

class Article < ActiveRecord::Base
  default_scope { where(published: true) }
  default_scope { where(rating: 'G') }
end

Article.all # => SELECT * FROM articles WHERE published = true AND rating = 'G'

Это также относится к наследованию и включению модулей, где родительский класс или модуль определяет default_scope, а дочерний класс или включаемый класс определяет вторую.

Если вам нужно выполнить более сложные действия с областью поиска по умолчанию, вы можете альтернативно определить её как метод класса:

class Article < ActiveRecord::Base
  def self.default_scope
    # Should return a scope, you can call 'super' here etc.
  end
end

© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API