refactor: move dashboard to a separate ext, part 2

ckanext/mailcraft/mailcraft/README

@@ -0,0 +1 @@
+Generic single-database configuration.

ckanext/mailcraft/mailcraft/alembic.ini

@@ -0,0 +1,74 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = %(here)s
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# timezone to use when rendering the date
+# within the migration file as well as the filename.
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+#truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; this defaults
+# to /home/berry/projects/master/ckanext-mailcraft/ckanext/mailcraft/migration/mailcraft/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat /home/berry/projects/master/ckanext-mailcraft/ckanext/mailcraft/migration/mailcraft/versions
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

ckanext/mailcraft/mailcraft/env.py

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import with_statement
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from logging.config import fileConfig
+
+import os
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = None
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+name = os.path.basename(os.path.dirname(__file__))
+
+
+def run_migrations_offline():
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        version_table="{}_alembic_version".format(name),
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            version_table="{}_alembic_version".format(name),
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

ckanext/mailcraft/mailcraft/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

ckanext/mailcraft/mailcraft/versions/9f83e5bfff72_add_mailcraft_mail_table.py

@@ -0,0 +1,40 @@
+"""Add mailcraft_mail table
+
+Revision ID: 9f83e5bfff72
+Revises:
+Create Date: 2023-09-14 11:53:58.371935
+
+"""
+import sqlalchemy as sa
+
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "9f83e5bfff72"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        "mailcraft_mail",
+        sa.Column("id", sa.Integer, primary_key=True, autoincrement=True),
+        sa.Column("subject", sa.Text),
+        sa.Column(
+            "timestamp",
+            sa.DateTime,
+            nullable=False,
+            server_default=sa.func.current_timestamp(),
+        ),
+        sa.Column("sender", sa.Text),
+        sa.Column("recipient", sa.Text),
+        sa.Column("message", sa.Text),
+        sa.Column("state", sa.Text, server_default="success"),
+        sa.Column("extras", postgresql.JSONB(astext_type=sa.Text()), nullable=True),
+    )
+
+
+def downgrade():
+    op.drop_table("mailcraft_mail")

ckanext/mailcraft/mailer.py

@@ -11,11 +11,12 @@
 from time import time
 from typing import Any, Iterable, Optional, cast
 
+import ckan.plugins as p
 import ckan.model as model
 import ckan.plugins.toolkit as tk
 
 import ckanext.mailcraft.config as mc_config
-import ckanext.mailcraft.model as mc_model
+import ckanext.mailcraft_dashboard.model as mc_model
 from ckanext.mailcraft.exception import MailerException
 from ckanext.mailcraft.types import (
     Attachment,
@@ -200,6 +201,9 @@ def _save_email(
         body_html: str,
         state: str = mc_model.Email.State.success,
     ) -> None:
+        if not p.plugin_loaded("mailcraft_dashboard"):
+            return
+
         mc_model.Email.save_mail(email_data, body_html, state)
 
     def _send_email(self, recipients, msg: EmailMessage):

ckanext/mailcraft_dashboard/logic/action.py

@@ -6,8 +6,8 @@
 import ckan.model as model
 from ckan.logic import validate
 
-import ckanext.mailcraft.model as mc_model
-from ckanext.mailcraft.logic import schema
+import ckanext.mailcraft_dashboard.model as mc_model
+from ckanext.mailcraft_dashboard.logic import schema
 
 
 @tk.side_effect_free

ckanext/mailcraft_dashboard/logic/validators.py

@@ -4,7 +4,7 @@
 
 import ckan.plugins.toolkit as tk
 
-import ckanext.mailcraft.model as mc_model
+import ckanext.mailcraft_dashboard.model as mc_model
 
 
 def mc_mail_exists(v: str, context) -> Any: