From aaa83ea2c0ce1725307d80386c111d1680c947c5 Mon Sep 17 00:00:00 2001 From: Sean Morley Date: Tue, 9 Jul 2024 13:43:32 -0400 Subject: [PATCH 1/2] feat: Add validation for adventure type matching trip type --- backend/server/adventures/models.py | 11 ++++++----- backend/server/adventures/serializers.py | 7 +++++-- backend/server/adventures/views.py | 15 ++++++++------- 3 files changed, 19 insertions(+), 14 deletions(-) diff --git a/backend/server/adventures/models.py b/backend/server/adventures/models.py index af10e673..49552b00 100644 --- a/backend/server/adventures/models.py +++ b/backend/server/adventures/models.py @@ -44,6 +44,8 @@ def clean(self): raise ValidationError('Adventures must be associated with trips owned by the same user. Trip owner: ' + self.trip.user_id.username + ' Adventure owner: ' + self.user_id.username) if self.type != self.trip.type: raise ValidationError('Adventure type must match trip type. Trip type: ' + self.trip.type + ' Adventure type: ' + self.type) + if self.type == 'featured' and not self.is_public: + raise ValidationError('Featured adventures must be public. Adventure: ' + self.name) def __str__(self): return self.name @@ -60,13 +62,12 @@ class Trip(models.Model): # if connected adventures are private and trip is public, raise an error def clean(self): - if self.is_public: + if self.is_public and self.pk: # Only check if the instance has a primary key for adventure in self.adventure_set.all(): if not adventure.is_public: raise ValidationError('Public trips cannot be associated with private adventures. Trip: ' + self.name + ' Adventure: ' + adventure.name) - - + if self.type == 'featured' and not self.is_public: + raise ValidationError('Featured trips must be public. Trip: ' + self.name) def __str__(self): - return self.name - + return self.name \ No newline at end of file diff --git a/backend/server/adventures/serializers.py b/backend/server/adventures/serializers.py index 69daebdb..e1d7dc81 100644 --- a/backend/server/adventures/serializers.py +++ b/backend/server/adventures/serializers.py @@ -6,7 +6,7 @@ class AdventureSerializer(serializers.ModelSerializer): class Meta: model = Adventure - fields = '__all__' # Serialize all fields of the Adventure model + fields = '__all__' def to_representation(self, instance): representation = super().to_representation(instance) @@ -19,9 +19,12 @@ def to_representation(self, instance): return representation class TripSerializer(serializers.ModelSerializer): + adventures = AdventureSerializer(many=True, read_only=True, source='adventure_set') class Meta: model = Trip - fields = '__all__' # Serialize all fields of the Adventure model + # fields are all plus the adventures field + fields = ['id', 'user_id', 'name', 'type', 'location', 'date', 'is_public', 'adventures'] + \ No newline at end of file diff --git a/backend/server/adventures/views.py b/backend/server/adventures/views.py index b0f12826..2ccc5a6e 100644 --- a/backend/server/adventures/views.py +++ b/backend/server/adventures/views.py @@ -4,7 +4,7 @@ from .models import Adventure, Trip from .serializers import AdventureSerializer, TripSerializer from rest_framework.permissions import IsAuthenticated -from django.db.models import Q +from django.db.models import Q, Prefetch from .permissions import IsOwnerOrReadOnly class AdventureViewSet(viewsets.ModelViewSet): @@ -47,6 +47,10 @@ class TripViewSet(viewsets.ModelViewSet): def get_queryset(self): return Trip.objects.filter( Q(is_public=True) | Q(user_id=self.request.user.id) + ).prefetch_related( + Prefetch('adventure_set', queryset=Adventure.objects.filter( + Q(is_public=True) | Q(user_id=self.request.user.id) + )) ) def perform_create(self, serializer): @@ -54,21 +58,18 @@ def perform_create(self, serializer): @action(detail=False, methods=['get']) def visited(self, request): - trips = Trip.objects.filter( - type='visited', user_id=request.user.id) + trips = self.get_queryset().filter(type='visited', user_id=request.user.id) serializer = self.get_serializer(trips, many=True) return Response(serializer.data) @action(detail=False, methods=['get']) def planned(self, request): - trips = Trip.objects.filter( - type='planned', user_id=request.user.id) + trips = self.get_queryset().filter(type='planned', user_id=request.user.id) serializer = self.get_serializer(trips, many=True) return Response(serializer.data) @action(detail=False, methods=['get']) def featured(self, request): - trips = Trip.objects.filter( - type='featured', is_public=True) + trips = self.get_queryset().filter(type='featured', is_public=True) serializer = self.get_serializer(trips, many=True) return Response(serializer.data) \ No newline at end of file From d64abf22730a364df8315cc0534b0aba09e1232f Mon Sep 17 00:00:00 2001 From: Sean Morley Date: Tue, 9 Jul 2024 13:53:03 -0400 Subject: [PATCH 2/2] chore: Update documentation configuration and remove unused files --- .../docs/Installation/congratulations.md | 2 - .../docs/Usage/manage-docs-versions.md | 55 ------------ .../docs/Usage/translate-your-site.md | 88 ------------------- documentation/docusaurus.config.ts | 2 +- 4 files changed, 1 insertion(+), 146 deletions(-) diff --git a/documentation/docs/Installation/congratulations.md b/documentation/docs/Installation/congratulations.md index 0a69137e..eed0bd3f 100644 --- a/documentation/docs/Installation/congratulations.md +++ b/documentation/docs/Installation/congratulations.md @@ -8,8 +8,6 @@ You have just learned the **basics of Docusaurus** and made some changes to the Docusaurus has **much more to offer**! -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) ## What's next? diff --git a/documentation/docs/Usage/manage-docs-versions.md b/documentation/docs/Usage/manage-docs-versions.md index ccda0b90..e69de29b 100644 --- a/documentation/docs/Usage/manage-docs-versions.md +++ b/documentation/docs/Usage/manage-docs-versions.md @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/documentation/docs/Usage/translate-your-site.md b/documentation/docs/Usage/translate-your-site.md index b5a644ab..e69de29b 100644 --- a/documentation/docs/Usage/translate-your-site.md +++ b/documentation/docs/Usage/translate-your-site.md @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -export default { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/documentation/docusaurus.config.ts b/documentation/docusaurus.config.ts index 56184a47..1f092044 100644 --- a/documentation/docusaurus.config.ts +++ b/documentation/docusaurus.config.ts @@ -8,7 +8,7 @@ const config: Config = { favicon: "img/favicon.png", // Set the production url of your site here - url: "https://your-docusaurus-site.example.com", + url: "https://docs.adventurelog.app/", // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' baseUrl: "/",