1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

ransackで、パラメータに空白が含まれていても許可するよう設定する

Posted at

はじめに

Rails の gem で、ransack を使用時に、現状の仕様(v4.0.0)だと、パラメータの中に空白があったら自動的に削除されてしまいます。
それを空白があった場合でも許可するように設定する必要がありました。対処法を以下にまとめましたので、良ければご覧ください。

結論

config/initializers/ransack.rbに、c.strip_whitespace = falseを追加すれば、空白も許可してくれるようになります。

config/initializers/ransack.rb
Ransack.configure do |c|
  # Change whitespace stripping behaviour.
  # Default is true
  c.strip_whitespace = false ## 追加
end

ディレクトリ構成は違う可能性がありますので、ご自身の構成に合わせて修正をお願いいたします。

なぜ c.strip_whitespace = false を設定する必要があるのか

ransack の以前の仕様

ransack のバージョンが2.3.2までは、パラメータの中に空白が含まれていても、空白を含む文字列として検索されていました。

[2] pry(#<Api::AbcController>)> Abc.ransack(encrypted_sanitized_tel_or_encrypted_tel_eq: Abc.encrypt(:tel, params[:abcde]))
=> Ransack::Search<class: Abc, base: Grouping <conditions: [Condition <attributes: ["encrypted_sanitized_tel", "encrypted_tel"], predicate: eq, combinator: or, values: ["abcdefg12345678==\n"]>], combinator: and>>
values: ["abcdefg12345678==\n"]

Controller 名やカラム名などは、適当に記載しております。ご自身の実装に合わせて考えていただけたらと思います。

ただ、2.4.0から2.4.2の間は、パラメータの中に空白が含まれていたら、自動的に削除されるよう修正が入っていました。

[2] pry(#<Api::AbcController>)> Abc.ransack(encrypted_sanitized_tel_or_encrypted_tel_eq: Abc.encrypt(:tel, params[:abcde]))
=> Ransack::Search<class: Abc, base: Grouping <conditions: [Condition <attributes: ["encrypted_sanitized_tel", "encrypted_tel"], predicate: eq, combinator: or, values: ["abcdefg12345678=="]>], combinator: and>>
values: ["abcdefg12345678=="]

なので、もともと ransack のバージョンが 2.3.2 以前で、2.4.0 にバージョンアップすると、仮に実装で、空白も含めた文字列の検索処理をしているところがあると、不具合が起きると思います。(自分はこれでテストでエラーが多発しました、、、)

2.5.0 以降の仕様

自動で空白が削除されるようになったのはいいですが、それを回避するためのオプションが用意されていなかったため、ransack を使用している実装を大幅に変更する必要があったと思います。

そこで、2.5.0で空白を含んでもいいようなオプションが追加されました。それがc.strip_whitespace = falseです。

この実装があったおかげで、ransack のバージョンをあげても、実装で空白も含む文字列で検索している場合は、オプションを追加すれば問題なくなりました。

これで無事解決ですね 👍

上記の内容は、現在(2023/07)での README には記載がありません。
GitHub で確認したい場合は、main > Tags > v2.5.0 にすると、README で確認することができます。

https://github.com/activerecord-hackery/ransack
https://github.com/activerecord-hackery/ransack/tree/v2.5.0

まとめ

上記にも記載しましたが、現状の README に記載がなかったため、CHANGELOG を一から追ってようやく見つけることができました。CHAGELOG は、リリースされた内容が全て記載されているので、該当のバージョンの仕様を知るには、最適な資料でした。

CHANGELOG を読むのは大変だとは思いますが、何かのバージョンをあげる際には、必ず使う資料ですので、一緒に頑張っていきましょう!

最後までご視聴いただき、ありがとうございました。
この記事が、少しでも皆さんのお役に立てれたら幸いです。

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?