Add search, filter, order, and paginate capabilities to admin results view by jinjagit · Pull Request #7048 · decidim/decidim

jinjagit · 2020-12-18T16:46:07Z

🎩 What? Why?

Feature request (from: meta-decidim proposal #15783)

Summary: Make the admin results view searchable (by ID or title), filterable (by scope or category), orderable (by ascending or descending column values), and paginated (to 15, 50, or 100 results per page).

These features are implemented by this PR.

In addition, the results are now also filterable by status.

📌 Related Issues

This PR is related to issue #6988

📌 Related PRs

Testing

As an Admin, select 'Processes', 'Assemblies', or 'Conferences' from the left-hand sidebar, and then select an individual 'process', 'assembly', or 'conference', respectively. Click on 'Accountability'. Results should now be listed and can be searched (by ID or title), filtered (by scope, category, or status), ordered (by ascending or descending column values), and paginated (to 15, 50, or 100 results per page). Note: To check pagination, you may need to create a number of new results until the results list contains more than the pagination amount(s) you wish to test.

Also, run the tests in decidim-accountability/spec/controllers/decidim/accountability/admin/results_controller_spec.rb, decidim-accountability/spec/system/admin/admin_manages_results_spec.rb, and decidim-accountability/spec/system/admin/filter_results_spec.rb.

📋 Checklist

🚨 Please review the guidelines for contributing to this repository.

📷 Screen-captures

Search results by ID or title:
Filter results by scope, category, or status:
Order results by (ascending or descending) column values:
Paginate results to 15, 50, or 100 results per page:

♥️ Thank you!

This renders the search elements on the accountability components results page. We can action the elements but they don't have a filtering effect; so not broken but not doing anything. Co-authored-by: Simon Tharby <jinjamail@gmail.com>

Search box, Filters, Pagination work, but when we try to write our own `@collection` query, we get a broken SQL query. May need analogue to `ParticipatoryProcessesWithUserRole.for(current_user)`. Co-authored-by: Simon Tharby <jinjamail@gmail.com>

This is the way to sort the columns, and it does sort, but is not alpha-sorting on the translated titles (maybe on the translate key?)

Pushing what was left after our call; probably we'll ditch ResultsWithUserRole

To get the correct pre-search, filter, etc collection, we're reusing the `results` helper method. We confirmed it's the right subset, against `develop` and comparing the emitted SQL. We're talking about this action: # GET "/admin/participatory_processes/et-id/components/16/manage/" #Co-authored-by: Simon Tharby <jinjamail@gmail.com>

Not working yet, copied from elsewhere Co-authored-by: Simon Tharby <jinjamail@gmail.com>

…h field)

Add both the column, and make it sortable Co-authored-by: Simon Tharby <jinjamail@gmail.com>

This sorts, but not alpha on the values we see in the table -- same problem as Title

decidim-accountability/app/controllers/concerns/decidim/accountability/admin/filterable.rb

decidim-accountability/app/views/decidim/accountability/admin/results/index.html.erb

Add both the column, and make it sortable

This enables sorting by titles of results, in the different language versions of the title that can be supplied in json form in this field.

Following up the conversation on decidim#6988 where we clarified we're not adding publication but creation date, and it's worth adding status and progress as well.

virgile-dev · 2020-12-24T12:28:39Z

@jinjagit this is looking really good (judging by the gif screencasts) ! Congrats 👏
I was wondering do you think we could add a filter by status or would it add a lot of complexity ?

We're still trying to figure out where to build specs in the decidim project; will hang onto this file for the moment

decidim-accountability/spec/system/admin/admin_manages_results_spec.rb

Reworking our approach to specs for the new features. Now simply checking controller index action renders the index template, in results_controller_spec.rb. Basic format of some capybara tests developed in admin_manages_results_spec.rb. Custom context 'when managing results as an admin' created in shared_context.rb, but may not be necessary/desired.

decidim-accountability/spec/controllers/decidim/accountability/admin/results_controller_spec.rb

The fact that the development_app seeds use identical name values for the different language values was masking the lack of language specific ordering by scope.name. The setup for the relevant caypara test now includes scope values with different strings for different languages, to properly test ordering by translated scope.name.

Add initializer to Decidim::Accountability::AdminEngine to use overrides. Add scope.rb and category.rb overrides using class_eval in decidim-accountability/app/overrides/models/decidim/core dir. This avoids making changes to models outside of the Accountability context.

Rename files with more accurate and descriptive names. Test of all results being listed was redundant, since every test of ordering also implicitly tests this fact. Refactor string concatenation to string literal (linting).

Insert a needed '/' in path, where Rubocop autocorrect created a string literal from a concatenation. Also move override files to dir that mirrors parent file locations.

jinjagit · 2021-01-07T13:27:35Z

Documentation: We have created a new screenshot and edited the text description in the online documentation for accountability. Please see #34.

decidim-accountability/app/overrides/models/decidim/category.rb

decidim-accountability/app/overrides/models/decidim/scope.rb

Since this functionality will be useful in other contexts, the ransacker filters are now available globally, rather than only via overrides within the Accountability context.

jinjagit · 2021-01-14T14:42:36Z

@oriolgual Ransacker filtering moved into category.rb and scope.rb models, from overrides in Accountability, as discussed.

jinjagit · 2021-01-14T17:19:18Z

@oriolgual, @carolromero This PR code-instance is now staged @ https://decidim-staging.liquidvoting.io/

mrcasals · 2021-01-15T07:58:16Z

decidim-accountability/app/controllers/decidim/accountability/admin/results_controller.rb


+        def collection
+          parent_id = params[:parent_id].presence
+          @collection ||= Result.where(component: current_component, parent_id: parent_id).page(params[:page]).per(15)


@jinjagit the description says the user can change the amount of results per page (15, 50 100), but the number is hard-coded here to 15?

Did you forget about this? Or should the description be updated?

@mrcasals I believe this means it will, initially, display 15 results per page, but that the user can then select 50, 100 or return to 15 per page, and this can be seen in the screen-cast gif in this PR.

I will experiment with removing the hard-coded limit, to see if this improves the user experience, but I think the description is correct in either case (but could perhaps be more detailed).

@jinjagit sorry, you're absolutely right!

As a side note, GIFs are a little hard to deal with, but now GitHub allows uploading videos, which are easier to control from the viewer side 😄

mrcasals · 2021-01-15T08:04:55Z

Apart from that comment, code looks good!

davefrey and others added 12 commits December 10, 2020 19:44

Initial add of admin_filter_selector elements

13abe28

This renders the search elements on the accountability components results page. We can action the elements but they don't have a filtering effect; so not broken but not doing anything. Co-authored-by: Simon Tharby <jinjamail@gmail.com>

Add sortable column for accessibility titles WIP

f4e2c91

This is the way to sort the columns, and it does sort, but is not alpha-sorting on the translated titles (maybe on the translate key?)

Filter results WIP

1da4572

Pushing what was left after our call; probably we'll ditch ResultsWithUserRole

Refresh with latest decidim develop

de3d9f1

Add new controller spec for ResultsController#index WIP

ee36346

Not working yet, copied from elsewhere Co-authored-by: Simon Tharby <jinjamail@gmail.com>

Fix: json parsing of title and id for use when filtering (using searc…

0535565

…h field)

Fix translation for the category filter

806051d

Add scope field to filterable drop down.

2357255

Add a sorted ID column to results view

20366d5

Add both the column, and make it sortable Co-authored-by: Simon Tharby <jinjamail@gmail.com>

Add column sort for Scope to Results

83f8c85

This sorts, but not alpha on the values we see in the table -- same problem as Title

jinjagit marked this pull request as draft December 18, 2020 16:46

qlty-cloud-legacy bot reviewed Dec 18, 2020

View reviewed changes

decidim-accountability/app/controllers/concerns/decidim/accountability/admin/filterable.rb Outdated Show resolved Hide resolved

decidim-accountability/app/views/decidim/accountability/admin/results/index.html.erb Outdated Show resolved Hide resolved

[skip ci] Add a sorted Category column to Results view

db6496d

Add both the column, and make it sortable

jinjagit force-pushed the feature/add-search-capabilities-to-result-in-the-admin branch from ff48e79 to db6496d Compare December 18, 2020 16:57

Add ransacker locale based parsing on results title field.

df8dcfe

This enables sorting by titles of results, in the different language versions of the title that can be supplied in json form in this field.

jinjagit force-pushed the feature/add-search-capabilities-to-result-in-the-admin branch from a260579 to df8dcfe Compare December 20, 2020 13:47

davefrey and others added 5 commits December 20, 2020 14:51

Add sorted columns for status, progress, created

235d416

Following up the conversation on decidim#6988 where we clarified we're not adding publication but creation date, and it's worth adding status and progress as well.

Refresh feature with latest develop

ba5e2f7

remove trailing whitespace (codeclimate)

3e79929

Remove innacurate ransacker query for searching Results titles.

8d4d5f3

Sort Category column by name using ransacker.

2ed5391

jinjagit changed the title ~~Feature/add search capabilities to result in the admin~~ Add search, filter, order, and paginate capabilities to admin results view Dec 22, 2020

Refresh feature with latest decidim develop

de0a3d9

Maybe a useful spec file

d23133a

We're still trying to figure out where to build specs in the decidim project; will hang onto this file for the moment

qlty-cloud-legacy bot reviewed Dec 24, 2020

View reviewed changes

decidim-accountability/spec/system/admin/admin_manages_results_spec.rb Outdated Show resolved Hide resolved

qlty-cloud-legacy bot reviewed Dec 29, 2020

View reviewed changes

decidim-accountability/spec/controllers/decidim/accountability/admin/results_controller_spec.rb Outdated Show resolved Hide resolved

jinjagit added 7 commits January 5, 2021 14:23

Use simpler, single-line before block in capybara tests.

ec69c11

Add ransacker search to scope model.

4d3c5a6

Rename spec files and remove redundant test.

cad3f3c

Rename files with more accurate and descriptive names. Test of all results being listed was redundant, since every test of ordering also implicitly tests this fact. Refactor string concatenation to string literal (linting).

Remove comment.

e61a8db

Add forward-slash to string-literal path.

912f6cc

Insert a needed '/' in path, where Rubocop autocorrect created a string literal from a concatenation. Also move override files to dir that mirrors parent file locations.

jinjagit mentioned this pull request Jan 7, 2021

Add updated screenshot and description to accountability doc. decidim/documentation#34

Merged

armandfardeau previously approved these changes Jan 8, 2021

View reviewed changes

jinjagit marked this pull request as ready for review January 9, 2021 12:39

oriolgual requested review from andreslucena and carolromero January 14, 2021 09:03

oriolgual reviewed Jan 14, 2021

View reviewed changes

decidim-accountability/app/overrides/models/decidim/category.rb Outdated Show resolved Hide resolved

oriolgual reviewed Jan 14, 2021

View reviewed changes

decidim-accountability/app/overrides/models/decidim/scope.rb Outdated Show resolved Hide resolved

oliverbarnes mentioned this pull request Jan 14, 2021

Staging deploy for "Add search capabilities to result in the admin" liquidvotingio/decidim#7

Closed

Move ransacker filters to category & scope models, from overrides.

3b4657b

Since this functionality will be useful in other contexts, the ransacker filters are now available globally, rather than only via overrides within the Accountability context.

jinjagit dismissed armandfardeau’s stale review via 3b4657b January 14, 2021 13:53

oriolgual mentioned this pull request Jan 14, 2021

Review app for feature/add-search-capabilities-to-result-in-the-admin by oriolgual codegram/decidim-staging#263

Closed

oriolgual self-requested a review January 14, 2021 17:02

carolromero approved these changes Jan 14, 2021

View reviewed changes

mrcasals reviewed Jan 15, 2021

View reviewed changes

mrcasals merged commit f23ef15 into decidim:develop Jan 15, 2021

mrcasals added module: accountability type: feature labels Feb 26, 2021

andreslucena mentioned this pull request Jun 15, 2021

Add search capabilities to result in the admin #6988

Closed

lahdeero mentioned this pull request Dec 7, 2021

Add search, filters and sorting to admin panel budget projects #8592

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add search, filter, order, and paginate capabilities to admin results view#7048

Add search, filter, order, and paginate capabilities to admin results view#7048
mrcasals merged 54 commits intodecidim:developfrom
liquidvotingio:feature/add-search-capabilities-to-result-in-the-admin

jinjagit commented Dec 18, 2020 •

edited by oliverbarnes

Loading

Uh oh!

Uh oh!

Uh oh!

virgile-dev commented Dec 24, 2020

Uh oh!

Uh oh!

Uh oh!

jinjagit commented Jan 7, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

jinjagit commented Jan 14, 2021 •

edited

Loading

Uh oh!

jinjagit commented Jan 14, 2021 •

edited by oliverbarnes

Loading

Uh oh!

mrcasals Jan 15, 2021

Uh oh!

jinjagit Jan 15, 2021 •

edited

Loading

Uh oh!

mrcasals Jan 15, 2021

Uh oh!

mrcasals commented Jan 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Uh oh!

Conversation

jinjagit commented Dec 18, 2020 • edited by oliverbarnes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎩 What? Why?

📌 Related Issues

📌 Related PRs

Testing

📋 Checklist

📷 Screen-captures

Uh oh!

Uh oh!

Uh oh!

virgile-dev commented Dec 24, 2020

Uh oh!

Uh oh!

Uh oh!

jinjagit commented Jan 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jinjagit commented Jan 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jinjagit commented Jan 14, 2021 • edited by oliverbarnes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrcasals Jan 15, 2021

Choose a reason for hiding this comment

Uh oh!

jinjagit Jan 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrcasals Jan 15, 2021

Choose a reason for hiding this comment

Uh oh!

mrcasals commented Jan 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

jinjagit commented Dec 18, 2020 •

edited by oliverbarnes

Loading

jinjagit commented Jan 7, 2021 •

edited

Loading

jinjagit commented Jan 14, 2021 •

edited

Loading

jinjagit commented Jan 14, 2021 •

edited by oliverbarnes

Loading

jinjagit Jan 15, 2021 •

edited

Loading