Suggestion list

bookwyrm/activitypub/__init__.py

@@ -15,7 +15,7 @@
 from .note import Tombstone
 from .ordered_collection import OrderedCollection, OrderedCollectionPage
 from .ordered_collection import CollectionItem, ListItem, ShelfItem
-from .ordered_collection import BookList, Shelf
+from .ordered_collection import BookList, SuggestionList, Shelf
 from .person import Person, PublicKey
 from .response import ActivitypubResponse
 from .book import Edition, Work, Author

bookwyrm/activitypub/ordered_collection.py

@@ -42,6 +42,15 @@ class BookList(OrderedCollectionPrivate):
     type: str = "BookList"
 
 
+@dataclass(init=False)
+class SuggestionList(OrderedCollectionPrivate):
+    """structure of an ordered collection activity"""
+
+    summary: str = None
+    book: str = None
+    type: str = "SuggestionList"
+
+
 # pylint: disable=invalid-name
 @dataclass(init=False)
 class OrderedCollectionPage(ActivityObject):

bookwyrm/forms/lists.py

@@ -20,6 +20,18 @@ class Meta:
         fields = ["user", "book", "book_list", "notes"]
 
 
+class SuggestionListForm(CustomForm):
+    class Meta:
+        model = models.SuggestionList
+        fields = ["suggests_for"]
+
+
+class SuggestionListItemForm(CustomForm):
+    class Meta:
+        model = models.SuggestionListItem
+        fields = ["user", "book", "book_list", "notes"]
+
+
 class SortListForm(forms.Form):
     sort_by = ChoiceField(
         choices=(

bookwyrm/migrations/0210_suggestionlist_alter_listitem_options_and_more.py

@@ -0,0 +1,153 @@
+# Generated by Django 4.2.15 on 2024-08-27 17:27
+
+import bookwyrm.models.activitypub_mixin
+import bookwyrm.models.fields
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookwyrm", "0209_user_show_ratings"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="SuggestionList",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_date", models.DateTimeField(auto_now_add=True)),
+                ("updated_date", models.DateTimeField(auto_now=True)),
+                (
+                    "remote_id",
+                    bookwyrm.models.fields.RemoteIdField(
+                        max_length=255,
+                        null=True,
+                        validators=[bookwyrm.models.fields.validate_remote_id],
+                    ),
+                ),
+                ("embed_key", models.UUIDField(editable=False, null=True, unique=True)),
+                (
+                    "privacy",
+                    bookwyrm.models.fields.PrivacyField(
+                        choices=[
+                            ("public", "Public"),
+                            ("unlisted", "Unlisted"),
+                            ("followers", "Followers"),
+                            ("direct", "Private"),
+                        ],
+                        default="public",
+                        max_length=255,
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("-updated_date",),
+                "abstract": False,
+            },
+            bases=(
+                bookwyrm.models.activitypub_mixin.OrderedCollectionMixin,
+                models.Model,
+            ),
+        ),
+        migrations.AlterModelOptions(
+            name="listitem",
+            options={},
+        ),
+        migrations.CreateModel(
+            name="SuggestionListItem",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_date", models.DateTimeField(auto_now_add=True)),
+                ("updated_date", models.DateTimeField(auto_now=True)),
+                (
+                    "remote_id",
+                    bookwyrm.models.fields.RemoteIdField(
+                        max_length=255,
+                        null=True,
+                        validators=[bookwyrm.models.fields.validate_remote_id],
+                    ),
+                ),
+                (
+                    "notes",
+                    bookwyrm.models.fields.HtmlField(
+                        blank=True, max_length=300, null=True
+                    ),
+                ),
+                (
+                    "book",
+                    bookwyrm.models.fields.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        to="bookwyrm.edition",
+                    ),
+                ),
+                (
+                    "book_list",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="bookwyrm.suggestionlist",
+                    ),
+                ),
+                (
+                    "endorsement",
+                    models.ManyToManyField(
+                        related_name="suggestion_endorsers", to=settings.AUTH_USER_MODEL
+                    ),
+                ),
+                (
+                    "user",
+                    bookwyrm.models.fields.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("-created_date",),
+                "abstract": False,
+                "unique_together": {("book", "book_list")},
+            },
+            bases=(bookwyrm.models.activitypub_mixin.CollectionItemMixin, models.Model),
+        ),
+        migrations.AddField(
+            model_name="suggestionlist",
+            name="books",
+            field=models.ManyToManyField(
+                through="bookwyrm.SuggestionListItem", to="bookwyrm.edition"
+            ),
+        ),
+        migrations.AddField(
+            model_name="suggestionlist",
+            name="suggests_for",
+            field=bookwyrm.models.fields.OneToOneField(
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="suggestion_list",
+                to="bookwyrm.work",
+            ),
+        ),
+        migrations.AddField(
+            model_name="suggestionlist",
+            name="user",
+            field=bookwyrm.models.fields.ForeignKey(
+                on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL
+            ),
+        ),
+    ]

bookwyrm/models/__init__.py

@@ -9,6 +9,7 @@
 
 from .shelf import Shelf, ShelfBook
 from .list import List, ListItem
+from .list import SuggestionList, SuggestionListItem
 
 from .status import Status, GeneratedNote, Comment, Quotation
 from .status import Review, ReviewRating

bookwyrm/models/fields.py

@@ -299,7 +299,7 @@ def field_to_activity(self, value):
 
 
 class OneToOneField(ActivitypubRelatedFieldMixin, models.OneToOneField):
-    """activitypub-aware foreign key field"""
+    """activitypub-aware one to one field"""
 
     def field_to_activity(self, value):
         if not value:
@@ -621,11 +621,11 @@ class BooleanField(ActivitypubFieldMixin, models.BooleanField):
 
 
 class IntegerField(ActivitypubFieldMixin, models.IntegerField):
-    """activitypub-aware boolean field"""
+    """activitypub-aware integer field"""
 
 
 class DecimalField(ActivitypubFieldMixin, models.DecimalField):
-    """activitypub-aware boolean field"""
+    """activitypub-aware decimal field"""
 
     def field_to_activity(self, value):
         if not value: