【Rails】 scopeについて

Railsにおけるscopeの定義方法

scopeは、よく使うクエリを簡単に定義し、再利用可能にするための機能です。この記事では、scopeの定義方法や使い方について、通常のメソッドとの違いを交えて説明します。また、scopeの使用に対する現場での考え方の違いについても触れます。

scopeの基本構文

scopeは通常のメソッドと少し異なりますが、シンプルに定義できます。基本構文は以下の通りです。

scope :スコープ名, -> { 処理 }

:スコープ名

scopeの名前を指定します。メソッドのように呼び出し時に使います。

-> { 処理 }

無名関数（ラムダ）を使って、処理内容を記述します。whereやorderなどのActiveRecordメソッドを組み込むことができます。

無名関数（ラムダ）の詳細については、こちらを参照してください。
https://qiita.com/Yaaaaa_meat/items/a7a5502b890ab4c5e181

以下の例では、価格が500円以下の本を取得するscopeを定義しています。

例1: 単純なscope

class Book < ApplicationRecord
  # 価格が500円以下の本を取得するスコープ
  scope :cheap, -> { where('price <= ?', 500) }
end

# 使用例
books = Book.cheap  # 価格が500円以下の本を取得

例2: 引数を取るscope

引数を取るscopeを定義すると、動的に条件を変更できます。

class Book < ApplicationRecord
  # 指定した価格以下の本を取得するスコープ
  scope :under_price, ->(price) { where('price <= ?', price) }
end

# 使用例
books = Book.under_price(1000)  # 価格が1000円以下の本を取得

通常のメソッドとの違い

scopeを使うメリット

1.	宣言的でわかりやすい
•	scopeを使うと、クエリの定義がよりシンプルで宣言的に書けます。これは、コードの読みやすさにおいてメリットです。
•	scopeを使用することで、「これはクエリメソッドである」と明確に示すことができ、他の開発者にも理解しやすくなります。
2.	読みやすくて短い
•	scopeは、無名関数（ラムダ）で定義するため、短くシンプルに書けます。クラスメソッドに比べてコードの量が減り、メンテナンス性が高まります。
3.	コードの整合性
•	scopeは、ActiveRecord::Relationを返すことが前提になっているため、データベース関連の処理に関しては意図が明確です。一方、通常のメソッドは配列やその他のオブジェクトも返せるため、意図しない結果を返す可能性があります。
•	クエリだけを扱うならscopeを使うことで、余計な操作が入らず堅牢になります。

通常のメソッドとの比較

通常のメソッド

class Book < ApplicationRecord
  def self.cheap_books
    where('price <= ?', 500)
  end
end

# 使用例
books = Book.cheap_books
books.order(:title)  # 実際にはエラーにはならないが、チェーンできるとは限らない

scope

class Book < ApplicationRecord
  scope :cheap, -> { where('price <= ?', 500) }
end

# 使用例
books = Book.cheap
books = books.order(:title)  # チェーン可能

通常のメソッドは結果として配列が返されることがあり、その場合はクエリメソッド（order, whereなど）をチェーンすることができません。しかし、scopeは常にActiveRecord::Relationを返すため、クエリメソッドをチェーンして追加することが可能です。

scopeの使用に関する考え方の違い

開発の現場では、scopeを使うか通常のメソッドを使うかについて意見が分かれることがあります。

scopeはシンプルでわかりやすく、宣言的に書けるため、クエリの再利用やメンテナンスがしやすいです。特にクエリメソッドを多用するようなコードでは、scopeを使うことでコードの意図を明確にしやすくなります。

プロジェクトによっては、通常のクラスメソッドの方が柔軟で読みやすいと感じる場合もあります。また、scopeはあくまでActiveRecord::Relationを返すことを前提としているため、別のオブジェクトや配列を返したい場合には通常のメソッドの方が適しています。

結論として、scopeの使用を強制せず、状況やプロジェクトの規模、チームの文化に合わせて選択することが重要です。

まとめ

scopeを使うことで、Railsのモデルでクエリを簡単に定義・再利用できるようになります。コードの可読性も向上し、複雑なクエリをシンプルに記述することが可能です。特に大規模なアプリケーションでの開発においては、scopeを上手に活用することで、メンテナンス性が大きく向上します。一方で、通常のメソッドの方が適している場面もあるため、適材適所で使い分けることが大切です。