integrate with admin-panel, write models and migrations

ckanext/tour/logic/action.py

@@ -3,7 +3,7 @@
 
 
 @tk.side_effect_free
-def tour_get_sum(context, data_dict):
+def tour_list(context, data_dict):
     tk.check_access(
         "tour_get_sum", context, data_dict)
     data, errors = tk.navl_validate(
@@ -12,14 +12,4 @@ def tour_get_sum(context, data_dict):
     if errors:
         raise tk.ValidationError(errors)
 
-    return {
-        "left": data["left"],
-        "right": data["right"],
-        "sum": data["left"] + data["right"]
-    }
-
-
-def get_actions():
-    return {
-        'tour_get_sum': tour_get_sum,
-    }
+    return []

ckanext/tour/migration/tour/README

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

ckanext/tour/migration/tour/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-tour/ckanext/tour/migration/tour/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-tour/ckanext/tour/migration/tour/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/tour/migration/tour/env.py

@@ -0,0 +1,81 @@
+# -*- 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(u"sqlalchemy.url")
+    context.configure(
+        url=url, target_metadata=target_metadata, literal_binds=True,
+        version_table=u'{}_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=u'sqlalchemy.',
+        poolclass=pool.NullPool)
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            version_table=u'{}_alembic_version'.format(name)
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

ckanext/tour/migration/tour/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/tour/migration/tour/versions/c9e5d4235e58_create_tour_tourstep_tourstepimage_.py

@@ -0,0 +1,104 @@
+"""Create Tour, TourStep, TourStepImage tables
+
+Revision ID: c9e5d4235e58
+Revises:
+Create Date: 2023-07-23 13:20:58.129326
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = "c9e5d4235e58"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        "tour",
+        sa.Column("id", sa.Text, primary_key=True, unique=True),
+        sa.Column("state", sa.Text, nullable=False, server_default="active"),
+        sa.Column("anchor", sa.Text, nullable=False),
+        sa.Column("page", sa.Text, nullable=True),
+        sa.Column(
+            "created_at",
+            sa.DateTime,
+            nullable=False,
+            server_default=sa.func.current_timestamp(),
+        ),
+        sa.Column(
+            "modified_at",
+            sa.DateTime,
+            nullable=False,
+            server_default=sa.func.current_timestamp(),
+        ),
+        sa.Column(
+            "author_id",
+            sa.Text,
+            sa.ForeignKey("user.id", ondelete="CASCADE"),
+            primary_key=True,
+        ),
+    )
+
+    op.create_table(
+        "tour_step",
+        sa.Column("id", sa.Text, primary_key=True, unique=True),
+        sa.Column("title", sa.Text),
+        sa.Column("element", sa.Text),
+        sa.Column("intro", sa.Text),
+        sa.Column("position", sa.Text),
+        sa.Column(
+            "tour_id",
+            sa.Text,
+            sa.ForeignKey("tour.id", ondelete="CASCADE"),
+            primary_key=True,
+        ),
+    )
+
+    op.create_table(
+        "tour_step_image",
+        sa.Column("id", sa.Text, primary_key=True, unique=True),
+        sa.Column("file_id", sa.Text, unique=True),
+        sa.Column(
+            "uploaded_at",
+            sa.DateTime,
+            nullable=False,
+            server_default=sa.func.current_timestamp(),
+        ),
+        sa.Column(
+            "tour_step_id",
+            sa.Text,
+            sa.ForeignKey("tour_step.id", ondelete="CASCADE"),
+            primary_key=True,
+        ),
+    )
+
+    op.create_foreign_key(
+        "tour_step_fk",
+        "tour_step",
+        "tour",
+        ["tour_id"],
+        ["id"],
+        ondelete="CASCADE",
+    )
+
+    op.create_foreign_key(
+        "tour_step_image_fk",
+        "tour_step_image",
+        "tour_step",
+        ["tour_step_id"],
+        ["id"],
+        ondelete="CASCADE",
+    )
+
+
+def downgrade():
+    op.drop_constraint("tour_step_fk", "tour_step", type_="foreignkey")
+    op.drop_constraint("tour_step_image_fk", "tour_step_image", type_="foreignkey")
+
+    op.drop_table("tour_step_image")
+    op.drop_table("tour_step")
+    op.drop_table("tour")