Railsのscopeの使い方を現役エンジニアが解説【初心者向け】

初心者向けにRailsのscopeの使い方について解説しています。スコープを使うことで検索条件をまとめて定義し再利用することができるようになります。ぜひ活用してみましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Railsのscopeの使い方について解説します。

Rubyについてそもそもよく分からないという方は、Rubyとは何なのか解説した記事をまずご覧ください。

 

なお本記事は、TechAcademyのWebアプリケーションオンラを現役エンジニアが解説【初心者向け】インブートキャンプの内容をもとに紹介しています。

 

田島悠介

今回は、Rubyに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

scopeの使い方について詳しく説明していくね!

大石ゆかり

お願いします!

 

scopeとは

コントローラーのメソッドにはレコードの検索など長々と書くような場合に、クラスメソッドのようにレコードの検索するメソッドをモデルに定義し、そのメソッドをコントローラーで使う方法がRailsにあります。これがscopeです。

 

scopeを使うとコントローラで長々と書いたコードがスッキリして可読性が上がるので、筆者も積極的に使っております。

 

scopeの使い方

例えばコントローラーで以下のような実装をする場合を考えてみましょう。

ユーザーの中で、男性であり、年齢は30歳以上、居住地は東京の人の一覧画面を出すためのインスタンス変数を、indexアクションで定義する場合はどうでしょうか?

 

# app/contrpllers/users_controller.rb

class UsersController < ApplicationController

  def index

    @users = User.order(id: "DESC").where(gender:  1).where("age > 30")
      where(location: "Tokyo")

  end

end

 

長々とあり可読性がよくないです。そんな場合に

 

order(id: "DESC").where(gender:  1).where("age > 30").where(location: "Tokyo")

 

の部分をモデルでmale_tokyoというメソッド定義すれば、コントローラーでは以下のように定義することができます。

 

# app/contrpllers/users_controller.rb

class UsersController < ApplicationController

  def index

    @users = User.male_tokyo

  end

end

 

コントローラのindexアクションの中がスッキリして可読性が上がりましたね。クラスメソッドのようにscope はこのように使います。

 

[PR] Rubyのプログラミングで挫折しない学習方法を動画で公開中

実際に書いてみよう

それでは実際に書いてみましょう。

上記のmale_tokyoメソッドをモデルで定義してみます。integer型のgenderカラム、integer型のageカラム、string型のlocationカラムがusersテーブルには作成済みという前提で書いていきます。

 

# app/models/user.rb

class User < ApplicationRecord

  scope :male_tokyo, -> do

    order(id: "DESC").where(gender:  1).where("age > 30").where(location: "Tokyo")

  end
end

 

コードが長くない場合は do ~ endで囲わなくても大丈夫です。これでmale_tokyoというレコード検索メソッドが定義されました。

あとはコントローラーでこのscopeを使えば良いというわけですね。

 

筆者プロフィール

町田 耕

学生時代は会計学専攻。塾講師勤務を経て、企業のCFOとして会社経営に携わる。

会社経営から一線を退いた後、インフラエンジニアの妻の勧めでプログラミングを独学で始め、プログラミングセミナーなど転々としながら、開発案件に携わるようになる。

現在、フリーランスとして活動しながらテックアカデミーのメンターも勤めている。

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

TechAcademyでは初心者でも最短4週間でエンジニアになれるRuby on Railsオンラインブートキャンプを開催しています。

現役エンジニアがパーソナルメンターとして受講生に1人ずつつき、マンツーマンのメンタリングで学習をサポートし、最短4週間でオリジナルWebサービスを開発することが可能です。

また、現役エンジニアから学べる無料のプログラミング体験会も実施しているので、ぜひ参加してみてください。