Overhaul admin views to support searching and browsing #3345

joemull · 2023-01-11T10:38:41Z

This overhaul of the admin views addresses navigation issues related to bad search fields, filters that populate thousands of items as choices, and a lack of connections between related models. Closes #3256.

Design goals:

Display the most relevant fields in list views
Search support for visible fields
Always filter by journal or repository, if possible, using custom filters
Add other filters that narrow down the content, based on likely lookups when providing tech support
Use inlines on article and preprint models to represent metadata elements
Use inlines to connect related models where relevant, but not when the inline could ever load hundreds of lines
Add an admin_utils file to hold custom filter and inline classes
Add unit tests via a meta-class to run a search query against every admin view, to make sure all prescribed fields are actually searchable

joemull · 2023-01-24T16:08:35Z

This is ready for review, or, if we want to fix the underlying failing tests first, I can rebase it.

mauromsl

I know this was a lot of work, and I really appreciate the classes under utils/admin_utils.py which make the entire processes so much more DRY.

Well done @joemull

mauromsl · 2023-02-28T09:59:07Z

src/utils/admin_utils.py

+def truncate(value, limit=80):
+
+    """
+    Truncates strings keeping whole words.
+
+    Safe to use with HTML strings, because it does not mark them as safe.
+
+    Some lines of templatetags.truncate.py are duplicated to avoid circular imports.
+    """
+
+    if not value:
+        return ''
+
+    try:
+        limit = int(limit)
+    except ValueError:
+        return value
+
+    if len(value) <= limit:
+        return value
+
+    value = value[:limit]
+    words = value.split(' ')[:-1]
+
+    return ' '.join(words) + ' [...]'


You can make use of django's Truncator functions under django.template.defaultfilters

* #3256 Brush up CMS admin * #3256 More on CMS admin * #3256 Brush up comms admin * #3256 Brush up copyediting admin * #3256 Wrap line * #3256 Add inline view for author reviews on assignment page * #3256 Use better syntax for Inline option * #3256 Brush up core models * Fix typo * Brush up cron models * #3256 Brush up discussion admin * #3256 Brush up identifier models * #3256 Brush up journal admin views * #3256 Brush up metrics admin views * #3224 #3256 Brush up log entry admin * #3256 Brush up admin views * Edits to comments * #3256 Brush up review admin * #3256 Make core changes on admin not models * #3256 Improve workflow element log list view * #3256 Add comments about verbose names * #3256 Raw ID fields for workflow log inline * #3256 Consolidate admin utils in own file * #3256 Brush up submission models * #3256 Truncate long article titles in __str__ * #3256 Brush up repository admin views * #3256 Brush up carousel admin view * #3256 Better CMS admin filtering * #3256 Better filtering on news item admin * #3256 Typo in search field * #3256 Better filtering of copyediting admin views * #3256 Better filtering on core admin views * #3256 Improve cron admin filters * #3256 Improve discussion admin filters * #3256 Fill out featured article admin * #3256 Better identifier admin filters * #3256 Improve journal admin filters * #3256 Better filters for metrics admin * #3256 Use base class for most journal list display functions * #3256 Minor adjustments to review admin * #3256 Only use date_hierarchy for models with one date * #3256 Only use inlines when they won't return long lists * Remove enum34 from requirements.txt * #3256 Remove deprecated field * #3256 Improve date filters in article admin * #3256 Add unit tests for search with metaclass * #3256 Fix bugs in search_fields attributes * #3256: Small abstraction for the admin test metaclass * #3256 Clean up fields and methods after browsing checks * Fix bug that occurred when no crossref statuses in database * Add verbose name plural for fixed pub check items * #3256 Use Django's built-in truncation filters * #3256 Add a list display and inline for comms tags * #3256 Add missing migration --------- Co-authored-by: mauromsl <mauro.msl@outlook.com>

This was referenced Jan 11, 2023

Overhaul admin views BirkbeckCTP/typesetting#180

Merged

Brush up admin views BirkbeckCTP/imports#78

Merged

joemull linked an issue Jan 24, 2023 that may be closed by this pull request

Brush up admin views #3256

Closed

joemull marked this pull request as ready for review January 24, 2023 16:08

joemull requested review from ajrbyers and mauromsl and removed request for ajrbyers January 24, 2023 16:08

joemull linked an issue Jan 24, 2023 that may be closed by this pull request

Logs should be able to be filtered by source, type, actor #3224

Closed

ajrbyers assigned mauromsl Feb 8, 2023

joemull added 19 commits February 28, 2023 17:32

#3256 Brush up CMS admin

ce50387

#3256 More on CMS admin

d3d1e46

#3256 Brush up comms admin

4b73a34

#3256 Brush up copyediting admin

305e370

#3256 Wrap line

38628d2

#3256 Add inline view for author reviews on assignment page

2fe66ea

#3256 Use better syntax for Inline option

b76b11c

#3256 Brush up core models

c0d66ff

Fix typo

16beab9

Brush up cron models

0452d19

#3256 Brush up discussion admin

390cf57

#3256 Brush up identifier models

107ae1d

#3256 Brush up journal admin views

ab90ef8

#3256 Brush up metrics admin views

06cc8d5

#3224 #3256 Brush up log entry admin

8ce417f

#3256 Brush up admin views

71bc60d

Edits to comments

d697f33

#3256 Brush up review admin

38a1f71

#3256 Make core changes on admin not models

c25dd66

joemull and others added 23 commits February 28, 2023 17:32

#3256 Better filtering of copyediting admin views

fac1105

#3256 Better filtering on core admin views

02baee7

#3256 Improve cron admin filters

8fc0442

#3256 Improve discussion admin filters

584005e

#3256 Fill out featured article admin

6a457ac

#3256 Better identifier admin filters

8067027

#3256 Improve journal admin filters

2a0bc83

#3256 Better filters for metrics admin

d8e8f08

#3256 Use base class for most journal list display functions

d9505b9

#3256 Minor adjustments to review admin

a1e464e

#3256 Only use date_hierarchy for models with one date

a8b0620

#3256 Only use inlines when they won't return long lists

0fda9de

Remove enum34 from requirements.txt

576f8f8

#3256 Remove deprecated field

71a9fa2

#3256 Improve date filters in article admin

b833dd9

#3256 Add unit tests for search with metaclass

19decf5

#3256 Fix bugs in search_fields attributes

062faa0

#3256: Small abstraction for the admin test metaclass

91c6bef

#3256 Clean up fields and methods after browsing checks

1795336

Fix bug that occurred when no crossref statuses in database

01754b1

Add verbose name plural for fixed pub check items

39d2a27

#3256 Use Django's built-in truncation filters

1dda819

#3256 Add a list display and inline for comms tags

55cb9c8

mauromsl force-pushed the 3256-brush-up-admin-views branch from d501d47 to 55cb9c8 Compare February 28, 2023 16:34

#3256 Add missing migration

4846d2c

mauromsl approved these changes Mar 16, 2023

View reviewed changes

mauromsl merged commit 506e401 into django_three_two Mar 16, 2023

mauromsl deleted the 3256-brush-up-admin-views branch March 16, 2023 09:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Overhaul admin views to support searching and browsing #3345

Overhaul admin views to support searching and browsing #3345

joemull commented Jan 11, 2023 •

edited

joemull commented Jan 24, 2023

mauromsl left a comment

mauromsl Feb 28, 2023

Overhaul admin views to support searching and browsing #3345

Overhaul admin views to support searching and browsing #3345

Conversation

joemull commented Jan 11, 2023 • edited

joemull commented Jan 24, 2023

mauromsl left a comment

Choose a reason for hiding this comment

mauromsl Feb 28, 2023

Choose a reason for hiding this comment

joemull commented Jan 11, 2023 •

edited