Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use the same style of URL filtering that Django uses #24

Merged
merged 3 commits into from
Sep 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
Changes
=======

Unreleased
----------
1.3.0
-----

- Use related_name (if present) when linking to reverse relations
- Update admin URL filters to be consistent with Django's defaults

1.2.2 (2021-09-15)
------------------
Expand Down
2 changes: 1 addition & 1 deletion relatives/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.2.2.post0'
__version__ = '1.3.0.a1'
8 changes: 7 additions & 1 deletion relatives/templatetags/relatives.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,14 @@ def related_objects(obj):
plural_name = related.related_name.replace("_", " ")
else:
plural_name = to_model._meta.verbose_name_plural
if hasattr(related.field, 'attname'):
field = related.field.attname
if hasattr(related.field, 'm2m_reverse_target_field_name'):
field += "__" + related.field.m2m_reverse_target_field_name()
else:
field = related.field.name
object_list.append({
'plural_name': plural_name,
'url': smart_text('%s?%s=%s' % (url, related.field.name, obj.pk)),
'url': smart_text(f"{url}?{field}__exact={obj.pk}"),
})
return object_list
43 changes: 27 additions & 16 deletions relatives/tests/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,18 +146,19 @@ def test_foreign_keys(self):
ship = Ship.objects.create(id=1, name="Star of India")
body = render_to_string('related_objects_fk_test.html', {'obj': ship})
self.assertEqual(body.strip(),
'<a href="/adm/tests/sailor/?ship=1">Sailors</a>')
'<a href="/adm/tests/sailor/?ship_id__exact=1">Sailors</a>')

def test_two_foreign_keys(self):
eater = Eater.objects.create(id=1, name="Cheryl")
body = render_to_string('related_objects_fk_test.html', {'obj': eater})
self.assertEqual(
body.strip(),
'<a href="/adm/tests/meal/?prepared=1">Meals prepared</a>'
'<a href="/adm/tests/meal/?reviewed=1">Meals reviewed</a>',
'<a href="/adm/tests/meal/?prepared_id__exact=1">'
'Meals prepared</a>'
'<a href="/adm/tests/meal/?reviewed_id__exact=1">'
'Meals reviewed</a>',
)


def test_no_admin_url(self):
thing = Something.objects.create()
NotInAdmin.objects.create(id=1, fk=thing)
Expand All @@ -170,8 +171,10 @@ def test_many_to_many(self):
actor.movies.add(movie)
body = render_to_string('related_objects_m2m_test.html',
{'obj': movie})
self.assertEqual(body.strip(),
'<a href="/adm/tests/actor/?movies=1">Actors</a>')
self.assertEqual(
body.strip(),
'<a href="/adm/tests/actor/?movies__id__exact=1">Actors</a>',
)

def test_reverse_many_to_many(self):
movie = Movie.objects.create(id=1, name="Yojimbo")
Expand All @@ -191,21 +194,29 @@ def test_generic_foreign_key_present(self):
book = Book.objects.create(name="Django")
Image.objects.create(content_object=book)
ct_pk = ContentType.objects.get_for_model(book).pk
exp = '<a href="/adm/tests/image/?ct={0}&amp;obj_id={1}">Images</a>'\
.format(ct_pk, book.pk)
body = render_to_string('related_objects_generic_test.html',
{'obj': book})
self.assertEqual(body.strip(), exp)
expected = (
'<a href="/adm/tests/image/'
f'?ct={ct_pk}&amp;obj_id__exact={book.pk}">Images</a>'
)
body = render_to_string(
'related_objects_generic_test.html',
{'obj': book},
)
self.assertEqual(body.strip(), expected)

def test_generic_relation_and_gfk_present(self):
journal = Journal.objects.create(name="Django")
Image.objects.create(content_object=journal)
ct_pk = ContentType.objects.get_for_model(journal).pk
exp = '<a href="/adm/tests/image/?ct={0}&amp;obj_id={1}">Images</a>'\
.format(ct_pk, journal.pk)
body = render_to_string('related_objects_generic_test.html',
{'obj': journal})
self.assertEqual(body.strip(), exp)
expected = (
'<a href="/adm/tests/image/'
f'?ct={ct_pk}&amp;obj_id__exact={journal.pk}">Images</a>'
)
body = render_to_string(
'related_objects_generic_test.html',
{'obj': journal},
)
self.assertEqual(body.strip(), expected)

def test_with_removed_model(self):
cache.clear()
Expand Down