mirror of
https://github.com/pacnpal/thrillwiki_django_no_react.git
synced 2025-12-20 04:31:09 -05:00
- Added comprehensive documentation for hybrid filtering implementation, including architecture, API endpoints, performance characteristics, and usage examples. - Developed a hybrid pagination and client-side filtering recommendation, detailing server-side responsibilities and client-side logic. - Created a test script for hybrid filtering endpoints, covering various test cases including basic filtering, search functionality, pagination, and edge cases.
377 lines
14 KiB
Python
377 lines
14 KiB
Python
from django.db import models
|
|
from django.urls import reverse
|
|
from django.utils.text import slugify
|
|
from django.core.exceptions import ValidationError
|
|
from config.django import base as settings
|
|
from typing import Optional, Any, TYPE_CHECKING, List
|
|
import pghistory
|
|
from apps.core.history import TrackedModel
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
from apps.rides.models import Ride
|
|
from . import ParkArea
|
|
|
|
|
|
@pghistory.track()
|
|
class Park(TrackedModel):
|
|
# Import managers
|
|
from ..managers import ParkManager
|
|
|
|
objects = ParkManager()
|
|
id: int # Type hint for Django's automatic id field
|
|
STATUS_CHOICES = [
|
|
("OPERATING", "Operating"),
|
|
("CLOSED_TEMP", "Temporarily Closed"),
|
|
("CLOSED_PERM", "Permanently Closed"),
|
|
("UNDER_CONSTRUCTION", "Under Construction"),
|
|
("DEMOLISHED", "Demolished"),
|
|
("RELOCATED", "Relocated"),
|
|
]
|
|
|
|
name = models.CharField(max_length=255)
|
|
slug = models.SlugField(max_length=255, unique=True)
|
|
description = models.TextField(blank=True)
|
|
status = models.CharField(
|
|
max_length=20, choices=STATUS_CHOICES, default="OPERATING"
|
|
)
|
|
|
|
PARK_TYPE_CHOICES = [
|
|
("THEME_PARK", "Theme Park"),
|
|
("AMUSEMENT_PARK", "Amusement Park"),
|
|
("WATER_PARK", "Water Park"),
|
|
("FAMILY_ENTERTAINMENT_CENTER", "Family Entertainment Center"),
|
|
("CARNIVAL", "Carnival"),
|
|
("FAIR", "Fair"),
|
|
("PIER", "Pier"),
|
|
("BOARDWALK", "Boardwalk"),
|
|
("SAFARI_PARK", "Safari Park"),
|
|
("ZOO", "Zoo"),
|
|
("OTHER", "Other"),
|
|
]
|
|
|
|
park_type = models.CharField(
|
|
max_length=30,
|
|
choices=PARK_TYPE_CHOICES,
|
|
default="THEME_PARK",
|
|
db_index=True,
|
|
help_text="Type/category of the park"
|
|
)
|
|
|
|
# Location relationship - reverse relation from ParkLocation
|
|
# location will be available via the 'location' related_name on
|
|
# ParkLocation
|
|
|
|
# Details
|
|
opening_date = models.DateField(null=True, blank=True)
|
|
closing_date = models.DateField(null=True, blank=True)
|
|
operating_season = models.CharField(max_length=255, blank=True)
|
|
size_acres = models.DecimalField(
|
|
max_digits=10, decimal_places=2, null=True, blank=True
|
|
)
|
|
website = models.URLField(blank=True)
|
|
|
|
# Statistics
|
|
average_rating = models.DecimalField(
|
|
max_digits=3, decimal_places=2, null=True, blank=True
|
|
)
|
|
ride_count = models.IntegerField(null=True, blank=True)
|
|
coaster_count = models.IntegerField(null=True, blank=True)
|
|
|
|
# Image settings - references to existing photos
|
|
banner_image = models.ForeignKey(
|
|
"ParkPhoto",
|
|
on_delete=models.SET_NULL,
|
|
null=True,
|
|
blank=True,
|
|
related_name="parks_using_as_banner",
|
|
help_text="Photo to use as banner image for this park",
|
|
)
|
|
card_image = models.ForeignKey(
|
|
"ParkPhoto",
|
|
on_delete=models.SET_NULL,
|
|
null=True,
|
|
blank=True,
|
|
related_name="parks_using_as_card",
|
|
help_text="Photo to use as card image for this park",
|
|
)
|
|
|
|
# Relationships
|
|
operator = models.ForeignKey(
|
|
"Company",
|
|
on_delete=models.PROTECT,
|
|
related_name="operated_parks",
|
|
help_text="Company that operates this park",
|
|
limit_choices_to={"roles__contains": ["OPERATOR"]},
|
|
)
|
|
property_owner = models.ForeignKey(
|
|
"Company",
|
|
on_delete=models.PROTECT,
|
|
related_name="owned_parks",
|
|
null=True,
|
|
blank=True,
|
|
help_text="Company that owns the property (if different from operator)",
|
|
limit_choices_to={"roles__contains": ["PROPERTY_OWNER"]},
|
|
)
|
|
areas: models.Manager["ParkArea"] # Type hint for reverse relation
|
|
# Type hint for reverse relation from rides app
|
|
rides: models.Manager["Ride"]
|
|
|
|
# Metadata
|
|
created_at = models.DateTimeField(auto_now_add=True, null=True)
|
|
updated_at = models.DateTimeField(auto_now=True)
|
|
|
|
# Frontend URL
|
|
url = models.URLField(blank=True, help_text="Frontend URL for this park")
|
|
|
|
# Computed fields for hybrid filtering
|
|
opening_year = models.IntegerField(
|
|
null=True,
|
|
blank=True,
|
|
db_index=True,
|
|
help_text="Year the park opened (computed from opening_date)"
|
|
)
|
|
search_text = models.TextField(
|
|
blank=True,
|
|
db_index=True,
|
|
help_text="Searchable text combining name, description, location, and operator"
|
|
)
|
|
|
|
# Timezone for park operations
|
|
timezone = models.CharField(
|
|
max_length=50,
|
|
help_text="Timezone identifier for park operations (e.g., 'America/New_York')"
|
|
)
|
|
|
|
class Meta:
|
|
ordering = ["name"]
|
|
constraints = [
|
|
# Business rule: Closing date must be after opening date
|
|
models.CheckConstraint(
|
|
name="park_closing_after_opening",
|
|
check=models.Q(closing_date__isnull=True)
|
|
| models.Q(opening_date__isnull=True)
|
|
| models.Q(closing_date__gte=models.F("opening_date")),
|
|
violation_error_message="Closing date must be after opening date",
|
|
),
|
|
# Business rule: Size must be positive
|
|
models.CheckConstraint(
|
|
name="park_size_positive",
|
|
check=models.Q(size_acres__isnull=True) | models.Q(size_acres__gt=0),
|
|
violation_error_message="Park size must be positive",
|
|
),
|
|
# Business rule: Rating must be between 1 and 10
|
|
models.CheckConstraint(
|
|
name="park_rating_range",
|
|
check=models.Q(average_rating__isnull=True)
|
|
| (models.Q(average_rating__gte=1) & models.Q(average_rating__lte=10)),
|
|
violation_error_message="Average rating must be between 1 and 10",
|
|
),
|
|
# Business rule: Counts must be non-negative
|
|
models.CheckConstraint(
|
|
name="park_ride_count_non_negative",
|
|
check=models.Q(ride_count__isnull=True) | models.Q(ride_count__gte=0),
|
|
violation_error_message="Ride count must be non-negative",
|
|
),
|
|
models.CheckConstraint(
|
|
name="park_coaster_count_non_negative",
|
|
check=models.Q(coaster_count__isnull=True)
|
|
| models.Q(coaster_count__gte=0),
|
|
violation_error_message="Coaster count must be non-negative",
|
|
),
|
|
# Business rule: Coaster count cannot exceed ride count
|
|
models.CheckConstraint(
|
|
name="park_coaster_count_lte_ride_count",
|
|
check=models.Q(coaster_count__isnull=True)
|
|
| models.Q(ride_count__isnull=True)
|
|
| models.Q(coaster_count__lte=models.F("ride_count")),
|
|
violation_error_message="Coaster count cannot exceed total ride count",
|
|
),
|
|
]
|
|
|
|
def __str__(self) -> str:
|
|
return self.name
|
|
|
|
def save(self, *args: Any, **kwargs: Any) -> None:
|
|
from django.contrib.contenttypes.models import ContentType
|
|
from apps.core.history import HistoricalSlug
|
|
|
|
# Get old instance if it exists
|
|
if self.pk:
|
|
try:
|
|
old_instance = type(self).objects.get(pk=self.pk)
|
|
old_name = old_instance.name
|
|
old_slug = old_instance.slug
|
|
except type(self).DoesNotExist:
|
|
old_name = None
|
|
old_slug = None
|
|
else:
|
|
old_name = None
|
|
old_slug = None
|
|
|
|
# Generate new slug if name has changed or slug is missing
|
|
if not self.slug or (old_name and old_name != self.name):
|
|
self.slug = slugify(self.name)
|
|
|
|
# Generate frontend URL
|
|
frontend_domain = getattr(settings, "FRONTEND_DOMAIN", "https://thrillwiki.com")
|
|
self.url = f"{frontend_domain}/parks/{self.slug}/"
|
|
|
|
# Populate computed fields for hybrid filtering
|
|
self._populate_computed_fields()
|
|
|
|
# Save the model
|
|
super().save(*args, **kwargs)
|
|
|
|
# If slug has changed, save historical record
|
|
if old_slug and old_slug != self.slug:
|
|
HistoricalSlug.objects.create(
|
|
content_type=ContentType.objects.get_for_model(self),
|
|
object_id=self.pk,
|
|
slug=old_slug,
|
|
)
|
|
|
|
def _populate_computed_fields(self) -> None:
|
|
"""Populate computed fields for hybrid filtering"""
|
|
# Populate opening_year from opening_date
|
|
if self.opening_date:
|
|
self.opening_year = self.opening_date.year
|
|
else:
|
|
self.opening_year = None
|
|
|
|
# Populate search_text for client-side filtering
|
|
search_parts = [self.name]
|
|
|
|
if self.description:
|
|
search_parts.append(self.description)
|
|
|
|
# Add location information if available
|
|
try:
|
|
if hasattr(self, 'location') and self.location:
|
|
if self.location.city:
|
|
search_parts.append(self.location.city)
|
|
if self.location.state:
|
|
search_parts.append(self.location.state)
|
|
if self.location.country:
|
|
search_parts.append(self.location.country)
|
|
except Exception:
|
|
# Handle case where location relationship doesn't exist yet
|
|
pass
|
|
|
|
# Add operator information
|
|
if self.operator:
|
|
search_parts.append(self.operator.name)
|
|
|
|
# Add property owner information if different
|
|
if self.property_owner and self.property_owner != self.operator:
|
|
search_parts.append(self.property_owner.name)
|
|
|
|
# Combine all parts into searchable text
|
|
self.search_text = ' '.join(filter(None, search_parts)).lower()
|
|
|
|
def clean(self):
|
|
super().clean()
|
|
if self.operator and "OPERATOR" not in self.operator.roles:
|
|
raise ValidationError({"operator": "Company must have the OPERATOR role."})
|
|
if self.property_owner and "PROPERTY_OWNER" not in self.property_owner.roles:
|
|
raise ValidationError(
|
|
{"property_owner": "Company must have the PROPERTY_OWNER role."}
|
|
)
|
|
|
|
def get_absolute_url(self) -> str:
|
|
return reverse("parks:park_detail", kwargs={"slug": self.slug})
|
|
|
|
def get_status_color(self) -> str:
|
|
"""Get Tailwind color classes for park status"""
|
|
status_colors = {
|
|
"OPERATING": "bg-green-100 text-green-800",
|
|
"CLOSED_TEMP": "bg-yellow-100 text-yellow-800",
|
|
"CLOSED_PERM": "bg-red-100 text-red-800",
|
|
"UNDER_CONSTRUCTION": "bg-blue-100 text-blue-800",
|
|
"DEMOLISHED": "bg-gray-100 text-gray-800",
|
|
"RELOCATED": "bg-purple-100 text-purple-800",
|
|
}
|
|
return status_colors.get(self.status, "bg-gray-100 text-gray-500")
|
|
|
|
@property
|
|
def formatted_location(self) -> str:
|
|
"""Get formatted address from ParkLocation if it exists"""
|
|
if hasattr(self, "location") and self.location:
|
|
return self.location.formatted_address
|
|
return ""
|
|
|
|
@property
|
|
def coordinates(self) -> Optional[List[float]]:
|
|
"""Returns coordinates as a list [latitude, longitude]"""
|
|
if hasattr(self, "location") and self.location:
|
|
coords = self.location.coordinates
|
|
if coords and isinstance(coords, (tuple, list)):
|
|
return list(coords)
|
|
return None
|
|
|
|
@classmethod
|
|
def get_by_slug(cls, slug: str) -> tuple["Park", bool]:
|
|
"""Get park by current or historical slug"""
|
|
from django.contrib.contenttypes.models import ContentType
|
|
from apps.core.history import HistoricalSlug
|
|
|
|
print(f"\nLooking up slug: {slug}")
|
|
|
|
try:
|
|
park = cls.objects.get(slug=slug)
|
|
print(f"Found current park with slug: {slug}")
|
|
return park, False
|
|
except cls.DoesNotExist:
|
|
print(f"No current park found with slug: {slug}")
|
|
|
|
# Try historical slugs in HistoricalSlug model
|
|
content_type = ContentType.objects.get_for_model(cls)
|
|
print(f"Searching HistoricalSlug with content_type: {content_type}")
|
|
historical = (
|
|
HistoricalSlug.objects.filter(content_type=content_type, slug=slug)
|
|
.order_by("-created_at")
|
|
.first()
|
|
)
|
|
|
|
if historical:
|
|
print(
|
|
f"Found historical slug record for object_id: {
|
|
historical.object_id
|
|
}"
|
|
)
|
|
try:
|
|
park = cls.objects.get(pk=historical.object_id)
|
|
print(f"Found park from historical slug: {park.name}")
|
|
return park, True
|
|
except cls.DoesNotExist:
|
|
print("Park not found for historical slug record")
|
|
else:
|
|
print("No historical slug record found")
|
|
|
|
# Try pghistory events
|
|
print("Searching pghistory events")
|
|
event_model = getattr(cls, "event_model", None)
|
|
if event_model:
|
|
historical_event = (
|
|
event_model.objects.filter(slug=slug)
|
|
.order_by("-pgh_created_at")
|
|
.first()
|
|
)
|
|
|
|
if historical_event:
|
|
print(
|
|
f"Found pghistory event for pgh_obj_id: {
|
|
historical_event.pgh_obj_id
|
|
}"
|
|
)
|
|
try:
|
|
park = cls.objects.get(pk=historical_event.pgh_obj_id)
|
|
print(f"Found park from pghistory: {park.name}")
|
|
return park, True
|
|
except cls.DoesNotExist:
|
|
print("Park not found for pghistory event")
|
|
else:
|
|
print("No pghistory event found")
|
|
|
|
raise cls.DoesNotExist("No park found with this slug")
|