feat: add Collection model and api

openedx_learning/__init__.py

@@ -1,4 +1,4 @@
 """
 Open edX Learning ("Learning Core").
 """
-__version__ = "0.10.1"
+__version__ = "0.11.0"

openedx_learning/api/authoring.py

@@ -9,6 +9,7 @@
 """
 # These wildcard imports are okay because these api modules declare __all__.
 # pylint: disable=wildcard-import
+from ..apps.authoring.collections.api import *
 from ..apps.authoring.components.api import *
 from ..apps.authoring.contents.api import *
 from ..apps.authoring.publishing.api import *

openedx_learning/apps/authoring/collections/api.py

@@ -0,0 +1,80 @@
+"""
+Collections API (warning: UNSTABLE, in progress API)
+"""
+from __future__ import annotations
+
+from django.db.models import QuerySet
+
+from .models import Collection
+
+# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# is listed in the __all__ entries below. Internal helper functions that are
+# private to this module should start with an underscore. If a function does not
+# start with an underscore AND it is not in __all__, that function is considered
+# to be callable only by other apps in the authoring package.
+__all__ = [
+    "create_collection",
+    "get_collection",
+    "get_learning_package_collections",
+    "update_collection",
+]
+
+
+def create_collection(
+    learning_package_id: int,
+    name: str,
+    description: str = "",
+) -> Collection:
+    """
+    Create a new Collection
+    """
+    collection = Collection.objects.create(
+        learning_package_id=learning_package_id,
+        name=name,
+        description=description,
+    )
+    return collection
+
+
+def get_collection(collection_id: int) -> Collection:
+    """
+    Get a Collection by ID
+    """
+    return Collection.objects.get(id=collection_id)
+
+
+def update_collection(
+    collection_id: int,
+    name: str | None = None,
+    description: str | None = None,
+) -> Collection:
+    """
+    Update a Collection
+    """
+    lp = Collection.objects.get(id=collection_id)
+
+    # If no changes were requested, there's nothing to update, so just return
+    # the Collection as-is
+    if all(field is None for field in [name, description]):
+        return lp
+
+    if name is not None:
+        lp.name = name
+    if description is not None:
+        lp.description = description
+
+    lp.save()
+    return lp
+
+
+def get_learning_package_collections(learning_package_id: int) -> QuerySet[Collection]:
+    """
+    Get all collections for a given learning package
+
+    Only enabled collections are returned
+    """
+    return (
+        Collection.objects
+        .filter(learning_package_id=learning_package_id, enabled=True)
+        .select_related("learning_package")
+    )

openedx_learning/apps/authoring/collections/apps.py

@@ -0,0 +1,15 @@
+"""
+Django metadata for the Collections Django application.
+"""
+from django.apps import AppConfig
+
+
+class CollectionsConfig(AppConfig):
+    """
+    Configuration for the Collections Django application.
+    """
+
+    name = "openedx_learning.apps.authoring.collections"
+    verbose_name = "Learning Core > Authoring > Collections"
+    default_auto_field = "django.db.models.BigAutoField"
+    label = "oel_collections"

openedx_learning/apps/authoring/collections/migrations/0001_initial.py

@@ -0,0 +1,33 @@
+# Generated by Django 4.2.14 on 2024-08-05 20:42
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+import openedx_learning.lib.fields
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('oel_publishing', '0002_alter_learningpackage_key_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Collection',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('name', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, db_index=True, help_text='The name of the collection.', max_length=255)),
+                ('description', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, help_text='Provides extra information for the user about this collection.', max_length=10000)),
+                ('enabled', models.BooleanField(default=True, help_text='Whether the collection is enabled or not.')),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('modified', models.DateTimeField(auto_now=True)),
+                ('learning_package', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='oel_publishing.learningpackage')),
+            ],
+            options={
+                'verbose_name_plural': 'Collections',
+            },
+        ),
+    ]

openedx_learning/apps/authoring/collections/models.py

@@ -0,0 +1,63 @@
+"""
+Core models for Collections
+"""
+from __future__ import annotations
+
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from ....lib.fields import case_insensitive_char_field
+from ..publishing.models import LearningPackage
+
+
+class Collection(models.Model):
+    """
+    Represents a collection of library components
+    """
+
+    id = models.AutoField(primary_key=True)
+
+    # Each collection belongs to a learning package
+    learning_package = models.ForeignKey(LearningPackage, on_delete=models.CASCADE)
+
+    name = case_insensitive_char_field(
+        null=False,
+        max_length=255,
+        db_index=True,
+        help_text=_(
+            "The name of the collection."
+        ),
+    )
+    description = case_insensitive_char_field(
+        null=False,
+        blank=True,
+        max_length=10_000,
+        help_text=_(
+            "Provides extra information for the user about this collection."
+        ),
+    )
+    # We don't have api functions to handle the enabled field. This is a placeholder for future use and
+    # a way to "soft delete" collections.
+    enabled = models.BooleanField(
+        default=True,
+        help_text=_(
+            "Whether the collection is enabled or not."
+        ),
+    )
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        verbose_name_plural = "Collections"
+
+    def __repr__(self) -> str:
+        """
+        Developer-facing representation of a Collection.
+        """
+        return str(self)
+
+    def __str__(self) -> str:
+        """
+        User-facing string representation of a Collection.
+        """
+        return f"<{self.__class__.__name__}> ({self.id}:{self.name})"

openedx_learning/apps/authoring/collections/readme.rst

@@ -0,0 +1,14 @@
+Collections App
+==============
+
+The ``collections`` app will enable content authors to group content together for
+organizing and re-using content. Components can be part of several different collections.
+
+Motivation
+----------
+
+With the Legacy Libraries ("v1"), people didn't have any way to organize content in libraries, so they
+had to create many small libraries.
+
+For the Libraries Relaunch ("v2"), we want to encourage people to create large libraries with lots of content,
+and organize that content using tags and collections.

projects/dev.py

@@ -31,6 +31,7 @@
     "django.contrib.admin",
     "django.contrib.admindocs",
     # Learning Core Apps
+    "openedx_learning.apps.authoring.collections.apps.CollectionsConfig",
     "openedx_learning.apps.authoring.components.apps.ComponentsConfig",
     "openedx_learning.apps.authoring.contents.apps.ContentsConfig",
     "openedx_learning.apps.authoring.publishing.apps.PublishingConfig",

test_settings.py

@@ -40,6 +40,7 @@ def root(*args):
     # django-rules based authorization
     'rules.apps.AutodiscoverRulesConfig',
     # Our own apps
+    "openedx_learning.apps.authoring.collections.apps.CollectionsConfig",
     "openedx_learning.apps.authoring.components.apps.ComponentsConfig",
     "openedx_learning.apps.authoring.contents.apps.ContentsConfig",
     "openedx_learning.apps.authoring.publishing.apps.PublishingConfig",