Adding SQLAlchemy models and alembic migrations

.gitignore

@@ -61,3 +61,6 @@ target/
 # Pycharm
 .idea
 .env
+
+# Sqlite db
+*.db

README.md

@@ -20,7 +20,7 @@ For a list of current utilities.
 - [x] Application factory
   - [x] View Blueprints
   - [x] Configuration with Pydantic
-    - [ ] dotenv support for local dev
+    - [x] dotenv support for local dev
 - [ ] Sqlalchemy integration
   - [ ] Model migrations using Alembic
 - [ ] User accounts

alembic.ini

@@ -0,0 +1,116 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# 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 migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# 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

htmx_contact/config.py

@@ -1,5 +1,9 @@
+from typing import Optional
+
+from pydantic import Field
 from pydantic_settings import BaseSettings
 
 
 class ContactSettings(BaseSettings):
-    SECRET_KEY: bytes
+    SECRET_KEY: Optional[bytes] = Field(None)
+    DATABASE_URI: str = Field("sqlite:///htmxcontact.db")

htmx_contact/models.py

@@ -0,0 +1,56 @@
+import re
+from typing import List
+
+from sqlalchemy import ForeignKey
+from sqlalchemy import String
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy.orm import Mapped
+from sqlalchemy.orm import mapped_column
+from sqlalchemy.orm import relationship
+
+# See https://en.wikipedia.org/wiki/North_American_Numbering_Plan
+PHONE_REGEX = "^(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:#|x\.?|ext\.?|extension)\s*(\d+))?$"  # noqa: E501
+
+
+def _is_valid_phone_number(phone_number):
+    return bool(re.match(PHONE_REGEX, phone_number))
+
+
+class Base(DeclarativeBase):
+    pass
+
+
+class User(Base):
+    __tablename__ = "user"
+    id: Mapped[int] = mapped_column(primary_key=True)
+    username: Mapped[str] = mapped_column(String(30), unique=True)
+    primary_email: Mapped[str] = mapped_column(String(120), unique=True)
+    contacts: Mapped[List["Contact"]] = relationship(back_populates="user", cascade="all, delete-orphan")
+
+    def __repr__(self) -> str:
+        return f"User(id={self.id!r}, username={self.username!r})"  # see format specifiers for !r
+
+
+class Contact(Base):
+    __tablename__ = "contact"
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+    user_id: Mapped[int] = mapped_column(ForeignKey("user.id"))
+    first_name: Mapped[str] = mapped_column(String(30))
+    last_name: Mapped[str] = mapped_column(String(30))
+    phone_contents: Mapped[str] = mapped_column(String(30))
+    email: Mapped[str] = mapped_column(String(120), unique=True)
+    user: Mapped["User"] = relationship(back_populates="contacts")
+
+    @property
+    def phone(self):
+        return self.phone_contents
+
+    @phone.setter
+    def phone(self, value):
+        if not _is_valid_phone_number(value):
+            raise ValueError(f"Invalid phone number {value}")
+        self.phone_contents = value
+
+    def __repr__(self) -> str:
+        return f"Contact(id={self.id!r}, first_name={self.first_name!r}, last_name={self.last_name!r}, phone={self.phone!r}, email={self.email!r})"  # noqa: E501

migrations/README

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

migrations/env.py

@@ -0,0 +1,80 @@
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+from htmx_contact.config import ContactSettings
+from htmx_contact.models import Base
+
+# 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.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+
+config.set_main_option("sqlalchemy.url", ContactSettings().DATABASE_URI)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = Base.metadata
+
+# 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.
+
+
+def run_migrations_offline() -> None:
+    """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,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """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)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migrations/script.py.mako

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

migrations/versions/d76ecaeb13db_.py

@@ -0,0 +1,53 @@
+"""empty message
+
+Revision ID: d76ecaeb13db
+Revises:
+Create Date: 2023-09-20 15:18:51.616651
+
+"""
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = 'd76ecaeb13db'
+down_revision: Union[str, None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        'user',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('username', sa.String(length=30), nullable=False),
+        sa.Column('primary_email', sa.String(length=120), nullable=False),
+        sa.PrimaryKeyConstraint('id'),
+        sa.UniqueConstraint('primary_email'),
+        sa.UniqueConstraint('username'),
+    )
+    op.create_table(
+        'contact',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('user_id', sa.Integer(), nullable=False),
+        sa.Column('first_name', sa.String(length=30), nullable=False),
+        sa.Column('last_name', sa.String(length=30), nullable=False),
+        sa.Column('phone_contents', sa.String(length=30), nullable=False),
+        sa.Column('email', sa.String(length=120), nullable=False),
+        sa.ForeignKeyConstraint(
+            ['user_id'],
+            ['user.id'],
+        ),
+        sa.PrimaryKeyConstraint('id'),
+        sa.UniqueConstraint('email'),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('contact')
+    op.drop_table('user')
+    # ### end Alembic commands ###

pyproject.toml

@@ -3,12 +3,12 @@ profile = "black"
 line_length = 120
 force_single_line = true
 filter_files = true
-skip_glob = ["env/*"]
+skip_glob = ["env/*", "migrations/*"]
 
 [tool.black]
 line-length = 120
 skip-string-normalization = true
-exclude = "(^/\\.git|^/env/|^/venv/|^/node_modules/)"
+exclude = "(^/\\.git|^/env/|^/venv/|^/migrations/|^/node_modules/)"
 
 [tool.ruff]
 line-length = 120

requirements.in

@@ -1,3 +1,4 @@
+alembic
 flask
 pydantic
 pydantic-settings

requirements.txt

@@ -4,6 +4,8 @@
 #
 #    pip-compile requirements.in
 #
+alembic==1.12.0
+    # via -r requirements.in
 annotated-types==0.5.0
     # via pydantic
 blinker==1.6.2
@@ -18,9 +20,12 @@ itsdangerous==2.1.2
     # via flask
 jinja2==3.1.2
     # via flask
+mako==1.2.4
+    # via alembic
 markupsafe==2.1.3
     # via
     #   jinja2
+    #   mako
     #   werkzeug
 pydantic==2.3.0
     # via
@@ -33,9 +38,12 @@ pydantic-settings==2.0.3
 python-dotenv==1.0.0
     # via pydantic-settings
 sqlalchemy==2.0.20
-    # via -r requirements.in
+    # via
+    #   -r requirements.in
+    #   alembic
 typing-extensions==4.7.1
     # via
+    #   alembic
     #   pydantic
     #   pydantic-core
     #   sqlalchemy

tasks.py

@@ -7,7 +7,7 @@ from invoke import task
 @task
 def serve_dev(c, debugger=True, reload=True, threads=True, port=8888, host="0.0.0.0"):
     """Serves the htmx_contact.app locally"""
-    cmd = "flask --app ./htmx_contact/app.py run"
+    cmd = "flask --app=./ ./htmx_contact run"
     cmd += " --debug" if debugger else ""
     cmd += " --reload" if reload else ""
     cmd += " --with-threads" if threads else ""

tests/test_models.py

@@ -0,0 +1,30 @@
+import pytest
+
+from htmx_contact.models import Contact
+from htmx_contact.models import _is_valid_phone_number
+
+
+@pytest.mark.parametrize(
+    "phone,expected",
+    [
+        ("(555)555-5555", True),
+        ("+1(555)555-5555", True),
+        ("213-467-9085", True),
+        ("1-555-555-5555", True),
+        ("+15555555555", True),
+        # Too few digits
+        ("15555555", False),
+        ("not a phone number", False),
+        # Too many digits
+        ("(555) 555-555a", False),
+        ("+1555555555a", False),
+        ("(555) 555-5555 x123", True),
+    ],
+)
+def test_is_valid_phone_number(phone, expected):
+    assert _is_valid_phone_number(phone) == expected
+
+
+def test_setting_incorrect_phone_raises_error_in_contact():
+    with pytest.raises(ValueError):
+        Contact(first_name="Fake", last_name="Fake", phone="not a number")