Tests added, Cleanup

Author: GitRon

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
       - id: blacken-docs
         additional_dependencies:
         - black==24.10.0
-        files: '(?:README\.md|docs\/.*\.(?:md|rst))'
+        files: '(?:README\.md|\.ambient-package-update\/templates\/snippets\/.*\.tpl|docs\/.*\.(?:md|rst))'
 
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.19.0

README.md

@@ -64,7 +64,7 @@ write me
 
 - Check coverage
   ````
-  coverage run -m pytest --ds settingstests
+  coverage run -m pytest --ds settings tests
   coverage report -m
   ````
 

manage.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(  # noqa: TRY003
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

queuebie/__init__.py

@@ -8,7 +8,7 @@
 # TODO: is this thread-safe? does it matter? -> prove with unit-tests
 message_registry = MessageRegistry()
 
-# todo:
+# TODO: tasks for v1.0
 #  -> docs with examples
 #  -> tests
 #  -> fix all code todos

queuebie/messages.py

@@ -1,12 +1,15 @@
-import inspect
+import abc
 import uuid
 from dataclasses import dataclass
 
 from queuebie.exceptions import MessageContextWrongTypeError
 
 
-# TODO: do we want to make it inherit from ABC?
-class Message:
+class Message(abc.ABC):
+    """
+    Base class for all commands and events.
+    """
+
     uuid = str
     Context: dataclass
 
@@ -15,17 +18,11 @@ class Context:
         def __init__(self, **kwargs):
             raise NotImplementedError
 
-    @classmethod
-    def _from_dict_to_dataclass(cls, *, context_data: dict) -> "Message.Context":
-        return cls.Context(
-            **{
-                key: (context_data[key] if val.default == val.empty else context_data.get(key, val.default))
-                for key, val in inspect.signature(cls.Context).parameters.items()
-            }
-        )
+    def __init__(self, context: "Message.Context") -> None:
+        super().__init__()
 
-    def __init__(self, context: "Message.Context"):
         self.uuid = str(uuid.uuid4())
+
         if type(context) is not self.Context:
             raise MessageContextWrongTypeError(class_name=self.__class__.__name__)
         self.Context = context
@@ -35,8 +32,14 @@ def __str__(self) -> str:
 
 
 class Command(Message):
-    pass
+    """
+    Commands are messages which prompt the system to do something.
+    Are always written in present tense: "CreateInvoice".
+    """
 
 
 class Event(Message):
-    pass
+    """
+    Events are the results of a command.
+    Are always written in past tense: "InvoiceCreated".
+    """

queuebie/registry.py

@@ -70,7 +70,7 @@ def autodiscover(self) -> None:
             return
 
         # Import all messages in all installed apps to trigger notification class registration via decorator
-        # todo: can we not do this on every request?
+        # TODO: can we not do this on every request?
         for app in settings.INSTALLED_APPS:
             if app[:5] != "apps.":
                 continue

settings.py

@@ -0,0 +1,62 @@
+from pathlib import Path
+
+BASE_PATH = Path(__file__).resolve(strict=True).parent
+
+INSTALLED_APPS = (
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "queuebie",
+    "testapp",
+)
+
+DEBUG = False
+
+ALLOWED_HOSTS = ["localhost:8000"]
+
+SECRET_KEY = "ASDFjklö123456890"
+
+# Routing
+ROOT_URLCONF = "testapp.urls"
+
+DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": "db.sqlite",
+    }
+}
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": ["templates"],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+            "debug": True,
+        },
+    },
+]
+
+MIDDLEWARE = (
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+)
+
+USE_TZ = True
+TIME_ZONE = "UTC"

testapp/__init__.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    # django Admin
+    path("admin/", admin.site.urls),
+]

testapp/urls.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig, apps
+
+
+def test_app_config():
+    app_config = apps.get_app_config("queuebie")
+
+    assert isinstance(app_config, AppConfig)
+    assert app_config.default_auto_field == "django.db.models.BigAutoField"
+    assert app_config.name == "queuebie"