administrate_filterable

カスタムフィルターの管理

インデックス ページにカスタム フィルターを追加する管理プラグイン。フィルターはキャンバス外のコンポーネントとしてレンダリングされるため、インデックス ページ上で多くのスペースを占有することはありません。 ActiveAdmin のフィルターから大きな影響を受けています。

なぜこれが必要なのでしょうか?

管理チームがデフォルトの検索またはフィルター機能で素晴らしい仕事をしたことに同意しましょう。すでに複数の検索フィールドとリレーショナル テーブル検索をサポートしています。カスタマイズは簡単です (検索の有効化/無効化、カスタム検索フィールドの定義など)。

しかし、私が見つけたいくつかの欠点があります。

1. 単一の検索ボックスを使用するため、その背後での検索プロセスは非常に重いです。モデルのすべての属性が検索され、データが多い場合は速度が遅くなります。
2. 繰り返しになりますが、すべての属性を検索するため、特定の属性を検索するのは困難になります。たとえば、 registration_statusとemployment_statusがあり、「アクティブ」な登録ステータスのみを検索したい場合は、雇用ステータスを含むすべての「アクティブ」レコードが取得されます。
3. 定義された検索リスト (ドロップダウン リストなど) に関しては、ユーザーフレンドリーではありません。ユーザーは値を手動で入力する必要があり、ユーザー エクスペリエンスにとっては良くありません。

他に理由がある場合は、ご意見をお聞かせください。

要件

• Ruby on Rails バージョン >= 5.0
• バージョン >= 0.2.2 を管理する

インストール

administrate_filterable Gemfile に追加します。

 gem 'administrate_filterable'

そして、以下を実行します。

 $ bundle install

または、単に実行するだけです:

 $ bundle add administrate_filterable

使用法

フィルターを有効にする

カスタム フィルターを追加するリソースごとに、それぞれの管理コントローラーに次の行を追加します。

 include AdministrateFilterable :: Filterer

例：

 class UsersController < Administrate :: ApplicationController
  include AdministrateFilterable :: Filterer

  # ...
end

フィルターフィールドのカスタマイズ

デフォルトでは、 COLLECTION_ATTRIBUTESのすべての属性がフィルター フィールドとしてレンダリングされます。 FILTER_ATTRIBUTES管理者のダッシュボード ファイルに追加することで、これをオーバーライドできます。

例 ( app/dashboards/user_dashboard.rb ):

 class UserDashboard < Administrate :: BaseDashboard
  # ..
  FILTER_ATTRIBUTES = [
    :first_name ,
    :last_name ,
    :email ,
    :created_at
  ] . freeze
  # ..
end

フィルターテンプレートのカスタマイズ

フィルター テンプレートをカスタマイズすることができます (フィルター ボタン アイコンの変更など)。これを行うには、アプリケーションのデフォルトのテンプレートをオーバーライドし、目的のリソース フォルダーに_index_filter.html.erbという新しいファイルを作成するだけです。

たとえば、 usersリソースのフィルター テンプレートをオーバーライドする場合は、 app/views/admin/users/_index_filter.html.erbにファイルを作成する必要があります。次に、ここのデフォルトのテンプレートからコンテンツをコピーして貼り付け、ニーズに合わせて変更します。

アセットパイプライン

アセット パイプラインを使用する場合は、この gem のアセットをapp/assets/config/manifest.jsファイルに含める必要があります。

 // ... other code here ...

//= link administrate_filterable/application.css
//= link administrate_filterable/application.js

アセットがロードされていない場合は、 rails assets:precompileを実行します。

トラブルシューティング

オーバーライドされたデフォルトの検索テンプレート

デフォルトでは、この gem はフィルター ボタンをviews/admin/application/_search.html.erb部分に追加します。ただし、アプリケーションでその部分をオーバーライドした場合は、次の行を追加することでボタンを手動で追加できます。

 <%= render 'index_filter' %>

例 ( app/views/admin/users/_search.html.erb ):

 < form class =" search " role =" search " >
  ... other code here ...
</ form >

<%= render 'index_filter' %>

オーバーライドされたscoped_resourceメソッド

この gem は、 scoped_resourceメソッドを利用して、デフォルトの動作をオーバーライドすることでリソースをフィルターします。万が一、アプリケーション コントローラーでこのメソッドもオーバーライドすると、フィルター機能もオーバーライドされることになり、機能しなくなります。

これを修正するには、オーバーライドされたscoped_resourceメソッドの最後の行に次のコードを追加する必要があります。

 filtered_resources ( your_scoped_resource )

例えば：

 def scoped_resource
  # Your custom filter logic here
  resources = super . where ( status : 'active' )
  # Add this line to make the filter work
  filtered_resources ( resources )
end

フィルターボタンが表示されない

_search.html.erbパーシャルを使用してフィルター ボタンを追加しているため、モデル ダッシュボードですべての検索可能な属性を false にするとフィルター ボタンが表示されなくなる可能性があります。したがって、フィルター ボタンを表示するには、検索可能な属性が少なくとも 1 つあることを確認してください。

私がパーシャルを使用する理由は次のとおりです。

1. ユーザーによってオーバーライドされることはほとんどないため、ほとんどの場合、ボタンを手動で追加する必要はありません。
2. 以前は、 _index_header.html.erb部分を使用していましたが、administrate_exportable のエクスポート ボタンと競合します。両方の gem を使用すると、部分的なオーバーライドにより 1 つのボタンが失われます。

やるべきこと

この宝石をより良くするためにやるべきことはまだたくさんあります。以下にその一部を示します (優先度の高い順に並べています)。

• リレーショナル フィルターのサポートを追加します (たとえば、 belongs_to関連付けによるフィルターなど)
• ドロップダウン リストをカスタマイズするためのサポートを追加します ( promptオプションの追加、 include_blankオプションの追加など)。
• アクションが実行されない場合は、フィルター パラメーターからチェックボックス、ラジオ、または選択値を除外します。
• フィルタ機能を実装するより良い方法を考え出す (現在はscoped_resourceメソッドをオーバーライドしている)
• フィルター属性をフォームに渡すより良い方法を考え出します (現在、オーバーライドされたscoped_resourceメソッドでインスタンス変数を使用しています)。
• フィルターの動作をカスタマイズする機能を追加します (例: ActiveAdmin フィルターと同様に、完全一致による検索、部分一致による検索など)
• トグル ボタンのユーザー エクスペリエンスを改善します (例: 開閉アニメーションの追加、動的な開閉タイトルの追加など)。

アイデアや提案がある場合は、問題またはプルリクエストを作成してお知らせください。

貢献する

このプロジェクトに貢献することで、この gem の改善に協力していただけます。ご協力をよろしくお願いいたします。

1. このリポジトリをフォークしてプル リクエストを作成します
2. コードをテストしてください: bundle exec rspec
3. 必要に応じてコードを文書化してください

ライセンス

MITライセンス

クレジット

この gem の作成に大いに役立った次のリソースに感謝します。

• administrate_exportable: この gem からコードをコピーして貼り付け、ニーズに合わせて変更するだけです。Administrate からデータをエクスポートする必要がある場合は、これを強くお勧めします。
• オフキャンバス メニュー: オフキャンバス フィルター コンポーネントを作成する方法を探していたときに、Google 画像からこのコードを見つけました。ニーズに合わせて少し修正しました。ただし、CodePen はもう入手できないようなので、アーカイブ版をここに置きます。原作者をご存知の方がいらっしゃいましたら、正確なクレジットを記載できるよう、お知らせください。