Collection filters #947

koppen · 2017-07-22T19:59:08Z

This adds the option to define a set of filters that can be triggered in order to reduce the number of resources listed on the index page of a dashboard. Currently the only way to trigger the filters is via the search field, using a syntax similar to the one used here on GitHub.

Why

Often we need to expose more detailed/involved queries than those currently capable via simple searches. Previously we'd have to add special actions that query the database correctly and customize the views with links to trigger those actions.

Example

For example, if we want to be able to find "inactive" customers (for some definition of inactive), we can add

COLLECTION_FILTERS = {
  inactive: ->(resources) { resources.where("login_at < ?", 1.week.ago) }
}

to a dashboard. This way, we can query the resources of that dashboard by typing bob inactive: in the search field to find users named "bob" who hasn't logged in the last week.

Credits

This is basically a reimplementation of @nando's work from #276, I merely took some of his thoughts and ideas and repackaged them in a way that makes sense for Administrate anno 2017.

Also in an effort to keep an otherwise huge pull request as small as possible, I haven't gone all the way that he did in the original pull request, so we're missing automatic filtering setup and exposing available filters in the UI.

Nor are the filters implemented here as flexible or powerful as those proposed in #276.

Further details

If you already had the inactive scope you could define the filter like the following to take advantage of existing ActiveRecord scopes (and other class methods on the resource class).

COLLECTION_FILTERS = {
  inactive: ->(resources) { resources.inactive }
}

While the chosen hash-based syntax is a bit more verbose than simply exposing already defined scopes like so:

# app/dashboards/customer_dashboard.rb
COLLECTION_FILTERS = [:inactive]

it allows us to define filters for use in Administrate without having to clutter the resource classes with scopes.

Future proofing

The chosen syntax should allow us to add the above mentioned simpler syntax in a backwards compatible way at some point down the line if we feel the need. For example it could end up looking like:

COLLECTION_FILTERS = {
  vip: :vip, # This could call the method `vip` on resources
  inactive: ->(resources) { resources.where("login_at < ?", 1.week.ago) }
}

but that's a step I am not ready to take just yet.

It also opens up for a way to have filters that take arguments, ie we could define:

COLLECTION_FILTERS = {
  before: ->(resources, args) {
            resources.where("created_at < ?", args)
          }
}

and query it as before:2016-01-12 which, again, is a step I am not ready to take here and now.

nickcharlton · 2017-07-30T19:14:34Z

This is going to be a great feature, I like the direction it’s going in and I appreciate the work you’ve put in to pick up a previous PR.

I’ve been starting to think about what the 1.0 version of administrate should be and I think I’d like to hold off this until then. Would you be okay with keeping this alive until then? I imagine it might be a few rebases, but I’m expecting the features we add to slow down and it only be bug fixes.

I’m going to tag this with “post-1.0”, so it’s easy to pick up soon.

koppen · 2017-07-30T19:50:19Z

I'll definitely keep it up to date, not least because I very much want this feature in Administrate proper, so I can get back to deploying the main line.

If I have to wait, so be it, but I'd obviously prefer seeing it merged sooner than later - you know what they say about long-running feature branches ;)

I might want to add a bit more features on top of this (somehow exposing the filters in the UI for starters), although I'd prefer keeping those in separate branches. I guess I can hold off on creating new PRs for those and still keep this one lean and mergeable.

nickcharlton · 2017-07-31T12:57:36Z

You could open more PRs, but based upon this one. As long as we keep this one updated it won't be too bad.

I'm hoping we'll not be too long until we get this merged, regardless!

spec/lib/administrate/search_query_spec.rb

coletivo · 2018-01-09T06:30:17Z

What is the status on this?

koppen · 2018-01-11T10:03:34Z

Rebased on the latest master, still applies cleanly and should be usable from our fork. Still awaiting that 1.0 release 🤞

macouella · 2018-01-29T00:11:49Z

Please release...

svenaas · 2018-02-11T17:31:19Z

We need a way to do this now too. Here's another plea for a release!

koppen · 2018-02-12T09:19:34Z

Rebased on a fresh master, fixing a few conflicts, and I have added backwards compatibility with Ruby versions < 2.4 (Administrate::Search::Query used String#match? which wasn't added until Ruby 2.4).

The current build failures are all because of the gemfiles are locked to a version of nokogiri with known vulnerabilities. Fixing this seems out of scope of this pull request:

ruby-advisory-db: 298 advisories
Name: nokogiri
Version: 1.8.1
Advisory: CVE-2017-15412
Criticality: Unknown
URL: https://github.com/sparklemotion/nokogiri/issues/1714
Title: Nokogiri gem, via libxml, is affected by DoS vulnerabilities
Solution: upgrade to >= 1.8.2

Vulnerabilities found!
Exited with code 1

jproctor · 2018-02-20T15:48:18Z

Version 0.9.0 updates Nokogiri. Can we try rebuilding?

koppen · 2018-02-20T15:53:54Z

Rebased on master, awaiting CI judgement 🤞

nickcharlton · 2018-03-02T20:09:31Z

This is looking great, and thanks for keeping it up to date!

I'm still planning on this for post-1.0, but we're moving close to that now. FWIW, my plan is to not merge too much in between now and then and this will go out in 1.1.0.

lib/administrate/search.rb

nando · 2018-06-28T17:35:47Z

Thanks a lot Jacob!!

I haven't seen your work until now while I was looking for my old PR :(

Nice to had inspired your branch!! :D

Cheers!!
<3<3<3

koppen · 2018-06-29T06:34:10Z

@nando Now we just need to make sure this branch doesn't fall by the wayside as well - here's hoping for a soonish merge 🤞

koppen · 2018-06-29T06:38:18Z

Rebased on the most recent master, still squeaky clean, ready for an easy merge :hint hint: 😇

hadees · 2018-09-28T05:39:17Z

@koppen nice job, hopefully @Graysonwright, @nickcharlton, or @tysongach can merge it in soon. Otherwise I'd love to see a fork run by you. I'd love to keep this going and add my own changes eventually.

koppen · 2018-09-28T08:08:27Z

And just like that, this branch is now up to date with the master branch and both CI and Hound are showing green checkmarks. And there was much rejoicing!

@hadees Thanks :) Not sure about the whole fork-business, but the branch at https://github.com/substancelab/administrate/tree/276-collection_filters should be perfectly functional. I can't promise to keep it up to date, but you should be able to work off it, though, I guess.

houndci-bot · 2019-01-03T10:41:14Z

spec/lib/administrate/search_spec.rb

@@ -149,5 +156,26 @@ class User < ActiveRecord::Base; end
        search.run
      end
    end
+
+    it "searches using a filter" do
+      begin


Style/RedundantBegin: Redundant begin block detected.

Agreed, however if we want to maintain compatibility with rubies before 2.5, this begin block needs to be here.

Tashows · 2019-06-20T16:13:30Z

Merge this pretty please? :D

ACPK · 2019-08-03T02:30:42Z

@nickcharlton - How long until v1 as I'm really looking forward to this feature in master.

If we add: COLLECTION_FILTERS = { inactive: ->(resources) { resources.where("login_at < ?", 1.week.ago) } } to a dashboard, we can query the resources of that dashboard with bob inactive: to find users named "bob" who hasn't logged in the last week. If you already had the `inactive` scope you could define the filter like so to take advantage of existing ActiveRecord scopes (and other class methods on the resource class). COLLECTION_FILTERS = { inactive: ->(resources) { resources.inactive } } While the chosen hash-based syntax is a bit more verbose than simply exposing already defined scopes like so: # app/dashboards/customer_dashboard.rb COLLECTION_FILTERS = [:inactive] it allows us to define filters for use in Administrate without having to clutter the resource classes with scopes. It still allows us to add the simpler syntax in a backwards compatible way at some point down the line if we feel the need. For example it could end up looking like: COLLECTION_FILTERS = { vip: :vip, # This could call the method `vip` on resources inactive: ->(resources) { resources.where("login_at < ?", 1.week.ago) } } * Allow search_spec to be run on its own, * Introduce the concept of a search query - adding collection scopes/filters means we need to add more involved search query parsing; this gives us a place for that,

nickcharlton · 2019-08-16T14:19:41Z

Thanks for everyone's patience on this one! I've merged now and we'll cut a release shortly.

ACPK · 2019-08-21T21:08:12Z

@nickcharlton - What are your thoughts on having filters show up as a dropdown? This would be very similar to how active_admin works.

nickcharlton · 2019-09-10T15:31:31Z

@ACPK, could you open a new issue with that? Perhaps with an example? And then we can take it from there.

This was referenced Jul 22, 2017

Refactor: Extract Search::Query object #936

Closed

Search scopes #276

Closed

nickcharlton added the post-1.0 label Jul 30, 2017

houndci-bot reviewed Aug 9, 2017

View reviewed changes

spec/lib/administrate/search_query_spec.rb Show resolved Hide resolved

houndci-bot reviewed Aug 9, 2017

View reviewed changes

spec/lib/administrate/search_query_spec.rb Show resolved Hide resolved

nickcharlton mentioned this pull request Dec 4, 2017

Filters in search? #1024

Closed

houndci-bot reviewed May 10, 2018

View reviewed changes

lib/administrate/search.rb Outdated Show resolved Hide resolved

houndci-bot reviewed May 10, 2018

View reviewed changes

lib/administrate/search.rb Outdated Show resolved Hide resolved

houndci-bot reviewed Jan 3, 2019

View reviewed changes

c4lliope removed the post-1.0 label May 20, 2019

nickcharlton merged commit 56ede63 into thoughtbot:master Aug 16, 2019

thoughtbot locked as resolved and limited conversation to collaborators Sep 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Collection filters #947

Collection filters #947

koppen commented Jul 22, 2017 •

edited

Loading

nickcharlton commented Jul 30, 2017 •

edited by carlosramireziii

Loading

koppen commented Jul 30, 2017

nickcharlton commented Jul 31, 2017

coletivo commented Jan 9, 2018

koppen commented Jan 11, 2018

macouella commented Jan 29, 2018

svenaas commented Feb 11, 2018

koppen commented Feb 12, 2018

jproctor commented Feb 20, 2018

koppen commented Feb 20, 2018

nickcharlton commented Mar 2, 2018

nando commented Jun 28, 2018

koppen commented Jun 29, 2018

koppen commented Jun 29, 2018

hadees commented Sep 28, 2018 •

edited

Loading

koppen commented Sep 28, 2018

houndci-bot Jan 3, 2019

koppen Mar 1, 2019

Tashows commented Jun 20, 2019

ACPK commented Aug 3, 2019

nickcharlton commented Aug 16, 2019

ACPK commented Aug 21, 2019

nickcharlton commented Sep 10, 2019

Collection filters #947

Collection filters #947

Conversation

koppen commented Jul 22, 2017 • edited Loading

Why

Example

Credits

Further details

Future proofing

nickcharlton commented Jul 30, 2017 • edited by carlosramireziii Loading

koppen commented Jul 30, 2017

nickcharlton commented Jul 31, 2017

coletivo commented Jan 9, 2018

koppen commented Jan 11, 2018

macouella commented Jan 29, 2018

svenaas commented Feb 11, 2018

koppen commented Feb 12, 2018

jproctor commented Feb 20, 2018

koppen commented Feb 20, 2018

nickcharlton commented Mar 2, 2018

nando commented Jun 28, 2018

koppen commented Jun 29, 2018

koppen commented Jun 29, 2018

hadees commented Sep 28, 2018 • edited Loading

koppen commented Sep 28, 2018

houndci-bot Jan 3, 2019

Choose a reason for hiding this comment

koppen Mar 1, 2019

Choose a reason for hiding this comment

Tashows commented Jun 20, 2019

ACPK commented Aug 3, 2019

nickcharlton commented Aug 16, 2019

ACPK commented Aug 21, 2019

nickcharlton commented Sep 10, 2019

koppen commented Jul 22, 2017 •

edited

Loading

nickcharlton commented Jul 30, 2017 •

edited by carlosramireziii

Loading

hadees commented Sep 28, 2018 •

edited

Loading