【Rails】 default _scopeを解除する方法

Railsのモデルにdefault_scopeを適用しているプロジェクトはあると思います。

そして、例外的にdefault_scopeを解除したいときもあるはずです。

そんなときは、「unscoped」や「unscope」でdefault_scopeを解除することができます。

この記事ではその方法をご紹介します。

default_scopeとは

default_scopeを使うと、そのモデル全体に絞り込みやorderが適用されます。

下記の例ではArticleというモデルに対して、「published: true」なデータのみ取得します。

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

> Article.where(id: 1)
SELECT "articles".* FROM "articles" WHERE "articles"."published" = 1 AND "articles"."id" = 1
=> #<ActiveRecord::Relation []>

> Article.unscoped.where(id: 1)
SELECT "articles".* FROM "articles" WHERE "articles"."id" = 1
=> #<ActiveRecord::Relation [#<Article id: 1, content: "test", published: false...>]>

しかし、一点注意することがあります。

それはupscopedを使用すると、default_scopeだけでなく、他のクエリも解除されてしまう点です。

下記のようにunscopedの前に付与したwhereも取り除かれてしまいます。

> Article.where(id: 1).unscoped
SELECT "articles".* FROM "articles

unscopedの後のクエリは適用されます。

> Article.unscoped.where(id: 1)
SELECT "articles".* FROM "articles" WHERE "articles"."id" = 1

そのため、unscopedを使用するタイミングは注意しましょう。

> Article.unscope(where: :published)
SELECT "articles".* FROM "articles"
=> #<ActiveRecord::Relation [#<Article id: 1, content: "test", published: false...>]>

> Article.where(id: 1).unscope(where: :published)
SELECT "articles".* FROM "articles" WHERE "articles"."id" = 1
=> #<ActiveRecord::Relation [#<Article id: 1, content: "test", published: false...>]>