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.

Sign up for GitHub

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

Jump to bottom

Add club diff feature #705

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Add club diff feature #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f56a70f
add club diff feature
Porcupine1 Jun 20, 2024
c89fc81
add YAML doc
Porcupine1 Jun 20, 2024
7dd0ad1
address nits + add tests
Porcupine1 Jul 6, 2024
d82c835
address yaml error
Porcupine1 Jul 6, 2024
01ccd5f
address requested changes
Porcupine1 Sep 2, 2024
2ec546e
add detail and list diff
Porcupine1 Oct 13, 2024
1c14e0a
small changes
Porcupine1 Oct 13, 2024
1724ec7
small changes
Porcupine1 Oct 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 199 additions & 0 deletions backend/clubs/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@
ExpressionWrapper,
F,
Max,
OuterRef,
Prefetch,
Q,
Subquery,
TextField,
Value,
When,
Expand Down Expand Up @@ -2058,6 +2060,203 @@ def perform_destroy(self, instance):
context=context,
)

@action(detail=True, methods=["GET"])
def club_detail_diff(self, request, *args, **kwargs):
"""
Return old and new data for a club that is pending approval.
---
responses:
"200":
content:
application/json:
schema:
type: object
properties:
club_code:
type: object
description: club code
properties:
name:
type: object
description: Changes in the name field
properties:
old:
type: string
description: >
Old name of the club
new:
type: string
description: >
New name of the club
description:
type: object
description: >
Changes in the club description
properties:
old:
type: string
description: >
Old description of the club
new:
type: string
description: >
New description of the club
image:
type: object
description: >
Changes in the image of the club
properties:
old:
type: string
description: >
Old image URL of the club
new:
type: string
description: >
New image URL of the club
---
"""
club = self.get_object()

latest_approved_version = (
club.history.filter(approved=True)
.only("name", "description", "image")
.order_by("-history_date")
.first()
)

latest_version = (
club.history.only("name", "description", "image")
.order_by("-history_date")
.first()
)

# if the current version is not approved, return a diff
# if the club has never be approved, for each field, it's old data is None
if not club.approved:
return Response(
{
club.code: {
field: {
"old": (
getattr(latest_approved_version, field)
if latest_approved_version
else None
),
"new": getattr(latest_version, field),
}
for field in ["name", "description", "image"]
}
}
)

# if the current version is approved, no diff is returned
return Response({})

@action(detail=False, methods=["GET"])
rm03 marked this conversation as resolved.
Show resolved Hide resolved
def club_list_diff(self, request, *args, **kwargs):
"""
Return old and new data for clubs that are pending approval.
---
responses:
"200":
content:
application/json:
schema:
type: object
properties:
club_code:
type: object
description: club code
properties:
name:
type: object
description: Changes in the name field
properties:
old:
type: string
description: >
Old name of the club
new:
type: string
description: >
New name of the club
description:
type: object
description: >
Changes in the club description
properties:
old:
type: string
description: >
Old description of the club
new:
type: string
description: >
New description of the club
image:
type: object
description: >
Changes in the image of the club
properties:
old:
type: string
description: >
Old image URL of the club
new:
type: string
description: >
New image URL of the club
---
"""
pending_clubs = Club.objects.filter(approved=None, active=True).only(
"code", "name", "description", "image"
)

# write subqueries
latest_versions_subquery = (
Club.history.filter(code=OuterRef("code"))
.order_by("-history_date")
.values("code")[:1]
)
latest_approved_versions_subquery = (
Club.history.filter(code=OuterRef("code"), approved=True)
.order_by("-history_date")
.values("code")[:1]
)

# get the latest versions of each club
latest_versions = Club.history.filter(
code__in=Subquery(latest_versions_subquery)
).only("code", "name", "description", "image")

# get the latest approved versions of each club
latest_approved_versions = Club.history.filter(
code__in=Subquery(latest_approved_versions_subquery), approved=True
).only("code", "name", "description", "image")

latest_versions_dict = {version.code: version for version in latest_versions}
latest_approved_versions_dict = {
version.code: version for version in latest_approved_versions
}

return Response(
{
club.code: {
field: {
"old": (
getattr(latest_approved_versions_dict[club.code], field)
if club.code in latest_approved_versions_dict
else None
),
"new": getattr(latest_versions_dict[club.code], field),
}
for field in ["name", "description", "image"]
}
for club in pending_clubs
}
)

@action(detail=False, methods=["GET"])
def fields(self, request, *args, **kwargs):
"""
Expand Down
Loading
Loading