DQB-27 create weekly menu

.dockerignore

@@ -1,7 +1,6 @@
 .github
 .mypy_cache
 .pytest_cache
-alembic
-alembic.ini
-logs
+logsd
 local.env
+.gitignore

.github/workflows/python-app.yml

@@ -26,7 +26,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3
         with:
-          python-version: '3.10'
+          python-version: '3.11'
       - name: Build Docker images
         run: |
           docker-compose build test-pipeline

.gitignore

@@ -6,3 +6,4 @@ coverage.xml
 local.env
 docker-compose.override.yml
 .env
+.dmypy.json

.gitlint

@@ -0,0 +1,77 @@
+### GENERAL CONFIG  ###
+[general]
+# Ignore rules, reference them by id or name (comma-separated)
+ignore=title-trailing-punctuation, T3
+
+# verbosity should be a value between 1 and 3
+verbosity = 2
+
+# By default gitlint will ignore certain commits
+ignore-merge-commits=true
+ignore-revert-commits=true
+ignore-fixup-commits=true
+ignore-fixup-amend-commits=true
+ignore-squash-commits=true
+
+# Ignore any data sent to gitlint via stdin
+ignore-stdin=true
+
+# Fetch additional meta-data from the local repository when manually passing a
+# commit message to gitlint via stdin or --commit-msg. Disabled by default.
+staged=true
+
+# Hard fail when the target commit range is empty.
+fail-without-commits=true
+
+# Whether to use Python `search` instead of `match` semantics in rules
+regex-style-search=true
+
+### RULE CONFIGURATION ###
+[title-max-length]
+line-length=100
+
+[title-min-length]
+min-length=5
+
+[title-must-not-contain-word]
+# Comma-separated list of words that should not occur in
+# the commit message title (case-insensitive).
+words=wip,foobar
+
+[title-match-regex]
+regex=^DQB-\d+\s.*
+
+[body-max-line-length]
+line-length=120
+
+[body-min-length]
+min-length=5
+
+[body-changed-file-mention]
+# Files that need to be explicitly mentioned in the body when they change
+files=gitlint-core/gitlint/rules.py,README.md,pyproject.toml,pre-commit-config.yaml,Dockerfile,docker-compose.yaml
+
+
+### NAMED RULES ###
+[title-must-not-contain-word:Additional-Words]
+words=foo,bar
+
+
+### IGNORE RULES CONFIGURATION ###
+[ignore-by-title]
+# Ignore rules for commits of which the title matches a regex
+regex=^Release(.*) #
+ignore=T1,body-min-length #
+
+[ignore-by-body]
+# Ignore rules for commits of which the body has a line that matches a regex
+regex=(.*)release(.*) #
+ignore=T1,body-min-length
+
+[ignore-body-lines]
+# Ignore all lines that start with 'Co-Authored-By'
+regex=^Co-Authored-By #
+
+[ignore-by-author-name]
+regex=(.*)dependabot(.*) #
+ignore=T1,body-min-length

.pre-commit-config.yaml

@@ -1,5 +1,6 @@
 default_install_hook_types:
   - pre-commit
+  - prepare-commit-msg
   - commit-msg
 default_stages:
   - pre-commit
@@ -14,7 +15,7 @@ repos:
         args: [ --line-length=120 ]
 
   - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-    rev: v2.10.0
+    rev: v2.12.0
     hooks:
       - id: pretty-format-toml
         args: [--autofix]
@@ -25,7 +26,7 @@ repos:
       - id: check-poetry
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: check-merge-conflict
@@ -66,9 +67,16 @@ repos:
         exclude: alembic|test_.*|conftest.py
         args: [ -c, pyproject.toml ]
 
-  - repo: https://github.com/milin/giticket
-    rev: v1.4
+  - repo: https://github.com/radix-ai/auto-smart-commit
+    rev: v1.0.3
     hooks:
-      - id: giticket
+      - id: auto-smart-commit
+        stages:
+          - prepare-commit-msg
+
+  - repo: https://github.com/jorisroovers/gitlint
+    rev: v0.19.1
+    hooks:
+      - id: gitlint
         stages:
           - commit-msg

Dockerfile

@@ -19,7 +19,6 @@ ENV PATH="$POETRY_VIRTUALENVS_PATH/bin:$PIPX_BIN_DIR:$PATH"
 RUN pip install --upgrade pip \
     && pip install pipx \
     && pipx install poetry==$POETRY_VERSION
-RUN apt-get update && apt-get install -y --no-install-recommends gcc
 
 # Install python dependencies
 RUN poetry install --no-root --no-ansi --no-interaction --only=main --no-directory

README.md

@@ -20,6 +20,7 @@ DISCORD_ACCOUNT_TOKEN="account token for you discord bot"
 DATABASE_NAME="Name for the database"
 DATABASE_USER="Name for user with access to the database"
 DATABASE_PASSWORD="Password to the database"
+DISCORD_OWNER_ID="The discord id of the owner of the channel you are using."
 ```
 
 Install all packages and start the server using `Docker` and `docker-compose`

alembic.ini

@@ -64,7 +64,7 @@ version_path_separator = os  # Use os.pathsep. Default configuration used for ne
 hooks = black
 black.type = console_scripts
 black.entrypoint = black
-black.options = -l 79 REVISION_SCRIPT_FILENAME
+black.options = -l 120 REVISION_SCRIPT_FILENAME
 
 # Logging configuration
 [loggers]

alembic/env.py

@@ -6,16 +6,18 @@
 
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.
-from src.config import DATABASE_URI
+from src.config import DBSettings
 from src.helpers.sqlalchemy_helpers import BaseModel
+from src import model_hub
 
 config = context.config
+db_settings = DBSettings()
 
 # Interpret the config file for Python logging.
 # This line sets up loggers basically.
 fileConfig(config.config_file_name)  # type: ignore
 
-config.set_main_option("sqlalchemy.url", DATABASE_URI)
+config.set_main_option("sqlalchemy.url", db_settings.database_uri)
 
 # add your model's MetaData object here
 # for 'autogenerate' support

alembic/script.py.mako

@@ -7,6 +7,7 @@ Create Date: ${create_date}
 """
 from alembic import op
 import sqlalchemy as sa
+import sqlmodel
 ${imports if imports else ""}
 
 # revision identifiers, used by Alembic.

alembic/versions/4232a8d67776_introduce_menu_tables.py

@@ -0,0 +1,59 @@
+"""Introduce menu tables
+
+Revision ID: 4232a8d67776
+Revises: 2f0c6e712786
+Create Date: 2024-02-06 02:34:23.627469
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel
+
+from src.constants import DayOfWeek
+from src.helpers.sqlalchemy_helpers import EnumColumn
+
+# revision identifiers, used by Alembic.
+revision = "4232a8d67776"
+down_revision = "2f0c6e712786"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "menu",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("datetime_created", sa.DateTime(), nullable=False),
+        sa.Column("datetime_edited", sa.DateTime(), nullable=False),
+        sa.Column("server_id", sa.Integer(), nullable=False),
+        sa.Column("start_date", sa.Date(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_table(
+        "menu_item",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("datetime_created", sa.DateTime(), nullable=False),
+        sa.Column("datetime_edited", sa.DateTime(), nullable=False),
+        sa.Column("food", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("day_of_the_week", EnumColumn(DayOfWeek), nullable=True),
+        sa.Column("menu_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["menu_id"],
+            ["menu.id"],
+        ),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.drop_constraint("user_quest_quest_id_fkey", "user_quest", type_="foreignkey")
+    op.create_foreign_key(None, "user_quest", "quest", ["quest_id"], ["id"])
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(None, "user_quest", type_="foreignkey")
+    op.create_foreign_key("user_quest_quest_id_fkey", "user_quest", "quest", ["quest_id"], ["id"], ondelete="CASCADE")
+    op.drop_table("menu_item")
+    op.drop_table("menu")
+    # ### end Alembic commands ###

alembic/versions/9deebb8552c0_update_server_id_to_big_int.py

@@ -0,0 +1,30 @@
+"""Update server id to big int
+
+Revision ID: 9deebb8552c0
+Revises: 4232a8d67776
+Create Date: 2024-02-06 06:16:05.689061
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel
+
+
+# revision identifiers, used by Alembic.
+revision = "9deebb8552c0"
+down_revision = "4232a8d67776"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column("menu", "server_id", existing_type=sa.INTEGER(), type_=sa.BigInteger(), existing_nullable=False)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column("menu", "server_id", existing_type=sa.BigInteger(), type_=sa.INTEGER(), existing_nullable=False)
+    # ### end Alembic commands ###

docker-compose.yml

@@ -1,13 +1,20 @@
 version: "3.7"
+x-common-variables: &common-variables
+  DATABASE_NAME: ${DATABASE_NAME}
+  DATABASE_USER: ${DATABASE_USER}
+  DATABASE_PASSWORD: ${DATABASE_PASSWORD}
+
+x-common-db-variables: &common-db-variables
+  POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
+  POSTGRES_USER: ${DATABASE_USER}
+
 services:
   backend:
     container_name: backend-${IMAGE_TAG-latest}
     image: discord_bot/backend:${IMAGE_TAG-latest}
     environment:
+      <<: *common-variables
       DISCORD_ACCOUNT_TOKEN: ${DISCORD_ACCOUNT_TOKEN}
-      DATABASE_NAME: ${DATABASE_NAME}
-      DATABASE_USER: ${DATABASE_USER}
-      DATABASE_PASSWORD: ${DATABASE_PASSWORD}
       DATABASE_HOST: 'postgres'
       DISCORD_OWNER_ID: ${DISCORD_OWNER_ID}
     volumes:
@@ -29,39 +36,40 @@ services:
     command: [ "postgres", "-c", "listen_addresses=*", "-c", "log_statement=all" ]
     restart: always
     environment:
-      POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
-      POSTGRES_USER: ${DATABASE_USER}
+      <<: *common-db-variables
       POSTGRES_DB: ${DATABASE_NAME}
       PGDATA: /var/lib/postgresql/data
     networks:
       - network
-    ports:
-      - "5432:5432"
-    expose:
-      - "5432"
     volumes:
       - db:/var/lib/postgresql/data
 
   test-db:
     image: postgres:14
+    hostname: "test_db"
     environment:
-      POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
-      POSTGRES_USER: ${DATABASE_USER}
+      <<: *common-db-variables
       POSTGRES_DB: ${TEST_DATABASE_NAME}
-    ports:
-      - "5433:5432"
+    networks:
+      - network
 
   test-pipeline:
     container_name: test-pipeline-${IMAGE_TAG-latest}
     image: discord_bot/test_pipeline:${IMAGE_TAG-latest}
     environment:
-      DATABASE_HOST: 'test-db'
-      TEST_DATABASE_NAME: ${TEST_DATABASE_NAME}
-      DATABASE_PASSWORD: ${DATABASE_PASSWORD}
-      TEST_DATABASE_PORT: '5432'
-      DATABASE_USER: ${DATABASE_USER}
+      <<: *common-variables
+      DATABASE_HOST: 'test_db'
+      DATABASE_NAME: ${TEST_DATABASE_NAME}
+      DATABASE_PORT: '5432'
+      DISCORD_ACCOUNT_TOKEN: "fake_token"
+      LOGGER__HANDLERS__BASIC_HANDLER__HANDLER_CLASS: 'logging.StreamHandler'
+      LOGGER__HANDLERS__BASIC_HANDLER__LEVEL: 20
+      LOGGER__HANDLERS__BASIC_HANDLER__FORMATTER: 'simple_formatter'
+      LOGGER__HANDLERS__BASIC_HANDLER__STREAM: 'ext://sys.stdout'
     volumes:
       - .:/app
+    networks:
+      - network
     build:
       context: .
       dockerfile: Dockerfile