Ransack の履歴(No.13)

• 履歴一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• Ransack へ行く。
  • 1 (2013-07-09 (火) 14:21:33)
  • 2 (2013-07-23 (火) 17:22:41)
  • 3 (2013-10-01 (火) 14:40:56)
  • 4 (2013-10-01 (火) 17:51:26)
  • 5 (2013-10-23 (水) 05:37:35)
  • 6 (2015-06-18 (木) 15:17:04)
  • 7 (2015-07-23 (木) 15:24:41)
  • 8 (2015-07-24 (金) 16:25:02)
  • 9 (2016-04-13 (水) 16:47:12)
  • 10 (2016-09-29 (木) 16:03:58)
  • 11 (2017-06-21 (水) 00:34:55)
  • 12 (2020-09-12 (土) 23:50:28)
  • 13 (2020-09-14 (月) 23:01:26)

---

&tag(Ransack);

目次†[edit]

関連ページ†[edit]

• ./ransack_demo

参考情報†[edit]

• activerecord-hackery/ransack // 公式サイト
• #370 Ransack - RailsCasts
• Ruby - Ransackのススメ - Qiita [キータ]

概要†[edit]

• Railsで検索画面を作るための(?)gem。
• Kaminariと組み合わせ、カラムクリックでソートすることもできる。

簡単な使い方†[edit]

インストール†[edit]

• Gemfileにransackを追加。

  gem "ransack"

コントローラ†[edit]

• コントローラーのaction。例えばindexで検索する場合次のようになる。

  def index
    @search = Item.ransack(params[:q])
    @items = @search.result
  end
  

※searchじゃなくてransackメソッドのほうが推奨になったらしい(公式サイト)

ビュー†[edit]

• 検索条件を指定するフォームの作成

  <%= search_form_for @search do |f| %>
          <%= f.text_field :title_cont %>
          <%= f.submit '検索' %>
  <% end %>
  
  <% @items.each do |item| %>
  (省略)
  <% end %>
  
  

述語の指定†[edit]

• ビューでは、フィールド名の後ろに特定のワードを追加して条件を指定する。
• 例えばtitle_contならばtitleに指定した文字が含まれるもの、age_gtならば指定した年齢以上の年齢のように。

eq†[edit]

• 指定条件に一致するもの

lt†[edit]

• 指定条件より小さいもの。age_ltは「age <」。

lteq†[edit]

• 指定条件以下のもの。age_lteqは「age <= 」。

gt†[edit]

• 指定条件より大きいもの。age_gtは「age > 」。

gteq†[edit]

• 指定条件より大きいもの。age_gteqは「age >=」。

複雑な使い方†[edit]

2つのフィールドのどちらかに含まれるものを検索†[edit]

• Basic Searching · activerecord-hackery/ransack Wikiより。
• 単に2つのフィールドのどちらかに含まれるものを検索したい場合「first_name_or_last_name_cont」のように接続できる。

  >> User.ransack(first_name_or_last_name_cont: 'Rya').result.to_sql
  => SELECT "users".* FROM "users"  WHERE ("users"."first_name" LIKE '%Rya%' 
     OR "users"."last_name" LIKE '%Rya%')
  

ANDとORを組み合わせる(グルーピング)†[edit]

• how to?: search with condition OR 'is null' · Issue #290 · activerecord-hackery/ransack
• Ransackでグループ間OR検索が分からない件 - エンジニアリングにはほど遠い…最後の追記を確認すること。
• パラメータで指定する倍、「g」と「m」を使い、ハッシュを入れ子にする。

  User.search(
    g: {
      '0' => { m: 'or', power_gteq: 100, magic_gteq: 30 },
      '1' => { m: 'and', level_gteq: 20, hp_lteq: 30 }
    }
  ).result
  

• @q.build_groupingや、grouping_fieldsも覚えておくと良い。Ransackで A and (B or C) - Qiita

ビュー†[edit]

search_form_for†[edit]

• search_form_forの定義は次のようになっている

        def search_form_for(record, options = {}, &proc)
  

• 最も単純

  <%= search_form_for(@search) do |f| %>

• クラスとurlを指定

  <%= search_form_for(@search, url: items_path, html: {class: 'form-inline'}) do |f| %>

Tips†[edit]

or条件で検索†[edit]

• activerecord-hackery/ransack: Object-based searching.

orderを手動で指定したい場合†[edit]

• Sorting in the Controller · activerecord-hackery/ransack Wikiに方法が書いてある

  @search = Post.ransack(params[:q])
  @search.sorts = 'name asc' if @search.sorts.empty? #一つの場合
  @search.sorts = ['name asc', 'created_at desc'] if @search.sorts.empty? # 複数の場合
  @posts = @search.result.paginate(page: params[:page], per_page: 20)
  

• params[:q][:s]に無理やり突っ込む方法は古い。

orderを手動で指定したい場合(古い方法)†[edit]

• params[:q][:s]にORDER BYの値を渡してやる。

   params[:q][:s] = "rating desc"

• もしくはresult.orderでソート。

  @search.result.order("rating desc")

カラムクリックしたときの初回のソートの向きを指定したい†[edit]

• sort_linkのdefault_orderを指定する。

  <%= sort_link(@q, :name, 'Last Name', default_order: :desc) %>

カラムクリックしたとき、セカンドキーを指定したい(2番目以降は固定)†[edit]

• カラムのシンボルの後に、ソートに使う配列を指定する。以下の場合:last_nameと'first_name asc'でソートすることになる。 　<%= sort_link(@q, :last_name, [:last_name, 'first_name asc'], 'Last Name') %>
• カラムをクリックすると、「last_name asc」「last_name desc」のあと「first_name asc」が組み合わさってソートされる。
• first_nameの方向は入れ替わらないことに注意。

カラムクリックしたとき、セカンドキーを指定したい(2番目以降もトグル)†[edit]

• ソート配列はシンボルにして、default_orderで初期ソート方向を指定する。

  <%= sort_link(@q, :last_name, %i(last_name first_name),
    default_order: { last_name: 'asc', first_name: 'desc' }) %>
  

テーブルカラムと対応しない列で並べ替える場合†[edit]

• 上の応用となる。sort_orderにリストで選択された"ソート順"が入っているとする。そのソート順からORDER BYの文字列を作ってやりセットする。

  params[:q][:s] = build_sql(params[:sort_order])

• view側で、params[:sort_order]を初期値としてセットしてやれば条件も引き回せる。

検索条件の引き回し†[edit]

• 検索フォームとページングのナビゲーションを組み合わせて使う場合、検索ボタンを押して検索したパラメータが、ページングのナビゲーションに追加されて検索条件が引き回されることになる。
• 検索条件を変えたら、いったん検索しないといけない。

検索パラメータの書き換え†[edit]

• 検索対象のカラムに直接該当しない値を画面から渡したい場合。
• ビュー側でf.selectを使うとransackのモデルにカラムが存在するかどうかのチェックが働く。select_tagのようにtagを使う。

        <%= select_tag("q[complex_cond]", options_for_select()..) %>
  

• コントローラーがわでparams[:q]のチェックを行い、ransackが認識可能なパラメータに置き換える

  if complex_cond == '1'
     @search.title_eq ='あああ'
  end