Collections Django Admin + soft delete, hard delete, and restore (#229)

* feat: adds delete_collection and restore_collection to api
* feat: adds Django Admin for Collection model
* feat: adds get_collection_components to the authoring api
* chore: bumps version to 0.11.0
* chore: adds import-lint to quality make target

Makefile

@@ -55,6 +55,7 @@ upgrade: ## update the pip requirements files to use the latest releases satisf
 
 quality: ## check coding style with pycodestyle and pylint
  tox -e quality
+ lint-imports
 
 pii_check: ## check for PII annotations on all Django models
  tox -e pii_check

openedx_learning/__init__.py

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

openedx_learning/apps/authoring/collections/admin.py

@@ -0,0 +1,27 @@
+"""
+Django Admin pages for Collection models.
+"""
+from django.contrib import admin
+
+from .models import Collection
+
+
+class CollectionAdmin(admin.ModelAdmin):
+ """
+ The Collection model admin.
+
+ Allows users to easily disable/enable (aka soft delete and restore) or bulk delete Collections.
+ """
+ readonly_fields = ["key", "learning_package"]
+ list_filter = ["enabled"]
+ list_display = ["key", "title", "enabled", "modified"]
+ list_editable = ["enabled"]
+
+ def has_add_permission(self, request, *args, **kwargs):
+ """
+ Disallow adding new collections via Django Admin.
+ """
+ return False # pragma: no cover
+
+
+admin.site.register(Collection, CollectionAdmin)

openedx_learning/apps/authoring/collections/api.py

@@ -20,10 +20,12 @@
 __all__ = [
  "add_to_collection",
  "create_collection",
+ "delete_collection",
  "get_collection",
  "get_collections",
  "get_entity_collections",
  "remove_from_collection",
+ "restore_collection",
  "update_collection",
 ]
 
@@ -84,6 +86,42 @@ def update_collection(
  return collection
 
 
+def delete_collection(
+ learning_package_id: int,
+ key: str,
+ *,
+ hard_delete=False,
+) -> Collection:
+ """
+ Disables or deletes a collection identified by the given learning_package + key.
+
+ By default (hard_delete=False), the collection is "soft deleted", i.e disabled.
+ Soft-deleted collections can be re-enabled using restore_collection.
+ """
+ collection = get_collection(learning_package_id, key)
+
+ if hard_delete:
+ collection.delete()
+ else:
+ collection.enabled = False
+ collection.save()
+ return collection
+
+
+def restore_collection(
+ learning_package_id: int,
+ key: str,
+) -> Collection:
+ """
+ Undo a "soft delete" by re-enabling a Collection.
+ """
+ collection = get_collection(learning_package_id, key)
+
+ collection.enabled = True
+ collection.save()
+ return collection
+
+
 def add_to_collection(
  learning_package_id: int,
  key: str,

openedx_learning/apps/authoring/components/api.py

@@ -42,6 +42,7 @@
  "get_component_by_uuid",
  "get_component_version_by_uuid",
  "component_exists_by_key",
+ "get_collection_components",
  "get_components",
  "create_component_version_content",
  "look_up_component_version_content",
@@ -339,6 +340,21 @@ def get_components(
  return qset
 
 
+def get_collection_components(
+ learning_package_id: int,
+ collection_key: str,
+) -> QuerySet[Component]:
+ """
+ Returns a QuerySet of Components relating to the PublishableEntities in a Collection.
+
+ Components have a one-to-one relationship with PublishableEntity, but the reverse may not always be true.
+ """
+ return Component.objects.filter(
+ learning_package_id=learning_package_id,
+ publishable_entity__collections__key=collection_key,
+ ).order_by('pk')
+
+
 def look_up_component_version_content(
  learning_package_key: str,
  component_key: str,