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

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

 
そもそもRubyについてよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。

なお本記事は、TechAcademyのオンラインブートキャンプRuby講座の内容をもとに紹介しています。

 

 

scopeとは

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

 

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

 

scopeの使い方

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

ユーザーの中で、男性であり、年齢は３０歳以上、居住地は東京の人の一覧画面を出すためのインスタンス変数を、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では、初心者でもRuby on Railsを使ったプログラミングを習得できるオンラインブートキャンプRuby講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。