More than 3 years have passed since last update.

【Rails6】検索機能の実装

Last updated at 2020-12-19Posted at 2020-12-19

#はじめに

記事の検索・閲覧ができるアプリケーションを作成しています。
今回は検索機能を'ransack'というgemを使用して実装したため、備忘録・復習のため記述します。

#環境

Ruby on Rails '6.0.0'
Ruby '2.6.5'

#前提

記事の投稿(articleテーブル）は作成済みで、ユーザーは記事の閲覧ができる状態。

#ransackとは

シンプルな検索フォームを実装できると共に、高度な検索フォームも作成することができるgemです。
このransackを導入することで、以下のメソッドが使用できるようになります。

_eqメソッド：条件にあった検索を行う
_contメソッド：部分一致
_iteqメソッド：「〜以下」という検索条件

他にも様々な検索に関するメソッドがありますが、今回は割愛します。

公式GitHubはこちらです。

#①gemの導入

Gemfile

gem 'ransack'

ターミナル

% bundle install

上記コマンドでgemを導入します。

#②ルーティングの記述

config/routes.rb

（中略）
get 'articles/search'

今回は、記事検索の機能を実装しているので、「articlesコントローラー」とします。
また検索機能は、「searchアクション」と命名しています。

#③コントローラー(articles)の記述

まず、全体を記載して、その後部分的に解説をしていきます。

app/controllers/articles_controller.rb

class ArticlesController < ApplicationController
  before_action :search_article, only: [:index, :search]
  def index
    @articles = Article.includes(:user).order('created_at DESC').limit(4)
    @ranks = Article.find(Like.group(:article_id).order('count(article_id) DESC').limit(4).pluck(:article_id))
  end

・・・(中略）・・・

  def search
    @results = @a.result(distinct: true).page(params[:page]).per(8).order('created_at DESC')
  end

  private

  def search_article
    @a = Article.ransack(params[:q])
  end
end

app/controllers/articles_controller.rb

  private

  def search_article
    @a = Article.ransack(params[:q])
  end

こちらの記述で、キー（：q）を使って、articlesテーブルから記事情報を探しています。そして、「@a」という名前の検索オブジェクトを生成しています。
この処理を行うメソッド名を「search_article」とし、index,searchアクションのみで使用するため、before_actionでの「only」で限定しています

app/controllers/articles_controller.rb

  def search
    @results = @a.result(distinct: true).page(params[:page]).per(8).order('created_at DESC')
  end

そして、この@aに対して、「.result」とすることで、検索結果を取得しています。

「distinct: true」：重複するデータは除外して取得できる
.page(params[:page]).per(8).order('created_at DESC')」：kaminariというgemのページネーションを使用し、1つのページで8つの記事が作成順に表示されるようにしています。

#④viewファイルの記述

#####検索フォーム編