Refactor, localize, and enhance testing and build workflows

Refactored code to include English localization for comments and documentation. Updated testing strategy with better Docker integration and scripts for local and container-based test execution. Modularized requirements files for efficient Docker builds, improved database ORM handling, and streamlined PDF/JPEG generation. Version bump to 2.10.0.

Author: David Schowalter

.docker_source_hash

@@ -0,0 +1 @@
+5468c6364c9821270d6baf500b24b89e

Dockerfile

@@ -17,8 +17,8 @@ RUN apt-get update && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
-# Copy only the requirements file first to leverage Docker cache
-COPY requirements.txt .
+# Copy requirements files first to leverage Docker cache
+COPY requirements.txt requirements-base.txt ./
 RUN pip3 install --no-cache-dir -r requirements.txt
 
 # Start the final stage of the build

app/api/appointments.py

@@ -135,13 +135,15 @@ def handle_jpeg_generation(pdf_filename):
         jpeg_stream.seek(0)
         jpeg_files.append((f'page_{i + 1}.jpg', jpeg_stream))
 
-    zip_buffer = BytesIO()
-    with zipfile.ZipFile(zip_buffer, 'a', zipfile.ZIP_DEFLATED) as zip_file:
+    zip_filename = os.path.splitext(pdf_filename)[0] + ".zip"
+    zip_path = os.path.join(Config.FILE_DIRECTORY, zip_filename)
+    
+    with zipfile.ZipFile(zip_path, 'w', zipfile.ZIP_DEFLATED) as zip_file:
         for file_name, file_bytes in jpeg_files:
             zip_file.writestr(file_name, file_bytes.read())
-    zip_buffer.seek(0)
-    logger.info(f"JPEG-Bilder erfolgreich erstellt und in ZIP-Datei gepackt")
-    return zip_buffer
+    
+    logger.info(f"JPEG-Bilder erfolgreich erstellt und in ZIP-Datei gepackt: {zip_filename}")
+    return zip_filename
 
 @router.get("/appointments")
 async def appointments_page(
@@ -196,7 +198,7 @@ async def process_appointments(
     if not login_token:
         return RedirectResponse(url="/", status_code=status.HTTP_303_SEE_OTHER)
 
-    # Standardwerte für Datumsbereich, falls nicht im Formular
+    # Default values for date range if not in the form
     if not start_date or not end_date:
         start_date_default, end_date_default = get_date_range_from_form()
         start_date = start_date or start_date_default
@@ -209,15 +211,15 @@ async def process_appointments(
     if calendar_ids:
         calendar_ids_int = [int(id) for id in calendar_ids if id.isdigit()]
 
-    # Wenn keine Kalender ausgewählt sind, alle verfügbaren Kalender verwenden
+    # If no calendars are selected, use all available calendars
     if not calendar_ids_int and calendars:
         calendar_ids_int = [calendar['id'] for calendar in calendars]
-        logger.info(f"Keine Kalender ausgewählt, verwende alle verfügbaren Kalender: {calendar_ids_int}")
+        logger.info(f"No calendars selected, using all available calendars: {calendar_ids_int}")
 
-    # Standardwerte für Farbeinstellungen
+    # Default values for color settings
     color_settings = load_color_settings(db, "default")
 
-    # Überschreibe mit Formulardaten, falls vorhanden
+    # Override with form data if available
     if background_color:
         color_settings['background_color'] = background_color
     if alpha is not None:
@@ -232,7 +234,7 @@ async def process_appointments(
         appointments_data = await fetch_appointments(login_token, start_date, end_date, calendar_ids_int)
         appointments = [appointment_to_dict(app) for app in appointments_data]
 
-        # Zusätzliche Informationen laden
+        # Load additional information
         additional_infos = get_additional_infos(db, [appointment['id'] for appointment in appointments])
         for appointment in appointments:
             appointment['additional_info'] = additional_infos.get(appointment['id'], "")
@@ -259,7 +261,7 @@ async def process_appointments(
 
     elif generate_pdf_btn:
         if not appointment_id:
-            # Wenn keine Termine ausgewählt wurden, zurück zur Terminübersicht
+            # If no appointments were selected, return to appointment overview
             return templates.TemplateResponse(
                 "appointments.html",
                 {
@@ -275,7 +277,7 @@ async def process_appointments(
                 }
             )
 
-        # Zusätzliche Informationen speichern
+        # Save additional information
         appointment_info_list = []
         form_data = await request.form()
         for app_id in appointment_id:
@@ -296,39 +298,39 @@ async def process_appointments(
             except Exception as e:
                 print(f"Fehler beim Lesen des Hintergrundbildes: {e}")
 
-        # Hole die tatsächlichen Termine von der API
-        logger.info(f"Ausgewählte Termin-IDs: {appointment_id}")
-        logger.info(f"Rufe Termine ab für Zeitraum {start_date} bis {end_date} und Kalender {calendar_ids_int}")
+        # Get the actual appointments from the API
+        logger.info(f"Selected appointment IDs: {appointment_id}")
+        logger.info(f"Retrieving appointments for period {start_date} to {end_date} and calendars {calendar_ids_int}")
 
-        # Hole alle Termine für den angegebenen Zeitraum
+        # Get all appointments for the specified time period
         appointments_data = await fetch_appointments(login_token, start_date, end_date, calendar_ids_int)
         logger.info(f"Anzahl abgerufener Termine: {len(appointments_data)}")
 
         # Konvertiere die Termine in das richtige Format
         appointments = [appointment_to_dict(app) for app in appointments_data]
 
-        # Füge zusätzliche Informationen aus dem Formular hinzu
+        # Add additional information from the form
         for appointment in appointments:
             app_id = appointment['id']
             additional_info = form_data.get(f'additional_info_{app_id}', "")
             appointment['additional_info'] = additional_info
 
-        logger.info(f"Anzahl der Termine für PDF: {len(appointments)}")
-        
-        # Debug-Logging für IDs
-        logger.info(f"Ausgewählte Termin-IDs: {appointment_id}")
-        logger.info(f"Verfügbare Termin-IDs: {[app['id'] for app in appointments]}")
+        logger.info(f"Number of appointments for PDF: {len(appointments)}")
+
+        # Debug logging for IDs
+        logger.info(f"Selected appointment IDs: {appointment_id}")
+        logger.info(f"Available appointment IDs: {[app['id'] for app in appointments]}")
 
-        # Nur ausgewählte Termine verwenden - mit Stringvergleich
+        # Use only selected appointments - with string comparison
         selected_appointments = []
         for app in appointments:
             for app_id in appointment_id:
                 if str(app['id']) == str(app_id):
                     selected_appointments.append(app)
                     break
 
-        # Logging für ausgewählte Termine
-        logger.info(f"Generiere PDF für {len(selected_appointments)} Termine:")
+        # Logging for selected appointments
+        logger.info(f"Generating PDF for {len(selected_appointments)} appointments:")
         for idx, app in enumerate(selected_appointments, 1):
             logger.info(f"  {idx}. {app['description']} am {app['startDateView']} ({app['startTimeView']}-{app['endTimeView']})")
 
@@ -343,7 +345,7 @@ async def process_appointments(
 
     elif generate_jpeg_btn:
         if not appointment_id:
-            # Wenn keine Termine ausgewählt wurden, zurück zur Terminübersicht
+            # If no appointments were selected, return to appointment overview
             return templates.TemplateResponse(
                 "appointments.html",
                 {
@@ -359,7 +361,7 @@ async def process_appointments(
                 }
             )
 
-        # Ähnlich wie bei PDF, aber mit JPEG-Konvertierung
+        # Similar to PDF, but with JPEG conversion
         appointment_info_list = []
         form_data = await request.form()
         for app_id in appointment_id:
@@ -380,39 +382,39 @@ async def process_appointments(
             except Exception as e:
                 print(f"Fehler beim Lesen des Hintergrundbildes: {e}")
 
-        # Hole die tatsächlichen Termine von der API
-        logger.info(f"Ausgewählte Termin-IDs: {appointment_id}")
-        logger.info(f"Rufe Termine ab für Zeitraum {start_date} bis {end_date} und Kalender {calendar_ids_int}")
+        # Get the actual appointments from the API
+        logger.info(f"Selected appointment IDs: {appointment_id}")
+        logger.info(f"Retrieving appointments for period {start_date} to {end_date} and calendars {calendar_ids_int}")
 
-        # Hole alle Termine für den angegebenen Zeitraum
+        # Get all appointments for the specified time period
         appointments_data = await fetch_appointments(login_token, start_date, end_date, calendar_ids_int)
         logger.info(f"Anzahl abgerufener Termine: {len(appointments_data)}")
 
         # Konvertiere die Termine in das richtige Format
         appointments = [appointment_to_dict(app) for app in appointments_data]
 
-        # Füge zusätzliche Informationen aus dem Formular hinzu
+        # Add additional information from the form
         for appointment in appointments:
             app_id = appointment['id']
             additional_info = form_data.get(f'additional_info_{app_id}', "")
             appointment['additional_info'] = additional_info
 
-        logger.info(f"Anzahl der Termine für JPEG: {len(appointments)}")
-        
-        # Debug-Logging für IDs
-        logger.info(f"Ausgewählte Termin-IDs: {appointment_id}")
-        logger.info(f"Verfügbare Termin-IDs: {[app['id'] for app in appointments]}")
+        logger.info(f"Number of appointments for JPEG: {len(appointments)}")
+
+        # Debug logging for IDs
+        logger.info(f"Selected appointment IDs: {appointment_id}")
+        logger.info(f"Available appointment IDs: {[app['id'] for app in appointments]}")
 
-        # Nur ausgewählte Termine verwenden - mit Stringvergleich
+        # Use only selected appointments - with string comparison
         selected_appointments = []
         for app in appointments:
             for app_id in appointment_id:
                 if str(app['id']) == str(app_id):
                     selected_appointments.append(app)
                     break
 
-        # Logging für ausgewählte Termine
-        logger.info(f"Generiere JPEG für {len(selected_appointments)} Termine:")
+        # Logging for selected appointments
+        logger.info(f"Generating JPEG for {len(selected_appointments)} appointments:")
         for idx, app in enumerate(selected_appointments, 1):
             logger.info(f"  {idx}. {app['description']} am {app['startDateView']} ({app['startTimeView']}-{app['endTimeView']})")
 
@@ -422,13 +424,13 @@ async def process_appointments(
                             background_image_stream)
 
         # JPEG generieren
-        zip_buffer = handle_jpeg_generation(filename)
+        zip_filename = handle_jpeg_generation(filename)
 
-        # Als Datei zurückgeben
+        # Return as file
         response = FileResponse(
-            zip_buffer,
+            os.path.join(Config.FILE_DIRECTORY, zip_filename),
             media_type="application/zip",
-            filename="images.zip"
+            filename=zip_filename
         )
         response.set_cookie(key="jpegGenerated", value="true", max_age=1, path='/')
         return response

app/database.py

@@ -1,6 +1,6 @@
 from sqlalchemy import create_engine, Column, String, Integer, Text
-from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import sessionmaker
+from sqlalchemy.orm import declarative_base
 from app.config import Config
 import os
 
@@ -15,7 +15,7 @@
 # Session-Factory erstellen
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 
-# Base-Klasse für Modelle
+# Base class for models
 Base = declarative_base()
 
 # Datenbankmodelle
@@ -34,7 +34,7 @@ class ColorSetting(Base):
     date_color = Column(String, nullable=False)
     description_color = Column(String, nullable=False)
 
-# Dependency für Datenbankzugriff
+# Dependency for database access
 def get_db():
     db = SessionLocal()
     try:
@@ -46,7 +46,7 @@ def get_db():
 def create_schema():
     Base.metadata.create_all(bind=engine)
 
-# CRUD-Operationen für Appointments
+# CRUD operations for Appointments
 def save_additional_infos(db, appointment_info_list):
     try:
         for appointment_id, additional_info in appointment_info_list:
@@ -68,7 +68,7 @@ def get_additional_infos(db, appointment_ids):
         print(f"Database error: {e}")
         return {}
 
-# CRUD-Operationen für ColorSettings
+# CRUD operations for ColorSettings
 def save_color_settings(db, settings):
     try:
         color_setting = db.query(ColorSetting).filter(ColorSetting.setting_name == settings['name']).first()

app/main.py

@@ -22,7 +22,7 @@
 # Templates einrichten
 templates = Jinja2Templates(directory="app/templates")
 
-# Stellen Sie sicher, dass das Verzeichnis für gespeicherte Dateien existiert
+# Make sure the directory for saved files exists
 Path(Config.FILE_DIRECTORY).mkdir(parents=True, exist_ok=True)
 
 # Routen einbinden

app/services/pdf_generator.py

@@ -164,7 +164,7 @@ def wrap_text(text, font_name, line_height, max_width):
 
 
 def create_pdf(appointments, date_color, background_color, description_color, alpha, image_stream=None):
-    # Versuche, die Schriftart zu registrieren und verwende Fallback, wenn nicht verfügbar
+    # Try to register the font and use fallback if not available
     try:
         # Versuche, Bahnschrift zu registrieren
         if 'Bahnschrift' not in pdfmetrics.getRegisteredFontNames():

app/static/css/appointments.css

@@ -629,7 +629,7 @@ textarea:focus {
 
 @media (max-width: 480px) {
     .format-options {
-        grid-template-columns: 1fr; /* Einspaltig auf sehr kleinen Geräten */
+        grid-template-columns: 1fr; /* Single column on very small devices */
     }
 }
 
@@ -695,7 +695,7 @@ textarea:focus {
     overflow: visible;
 }
 
-/* Container für Hintergrundbild */
+/* Container for background image */
 .format-option-full {
     margin-bottom: 10px;
     overflow: visible;
@@ -788,11 +788,11 @@ textarea:focus {
     transform: scale(1.1);
 }
 
-/* Zweispaltiges Layout für Termine und Formatierungsoptionen */
+/* Two-column layout for appointments and formatting options */
 .appointments-layout {
     display: grid;
-    grid-template-columns: 3fr 2fr; /* Mehr Platz für die rechte Spalte */
-    gap: var(--spacing-lg); /* Größerer Abstand zwischen den Spalten */
+    grid-template-columns: 3fr 2fr; /* More space for the right column */
+    gap: var(--spacing-lg); /* Larger gap between columns */
     margin-top: var(--spacing-md);
 }
 
@@ -815,10 +815,10 @@ textarea:focus {
     -webkit-overflow-scrolling: touch; /* Verbessert das Scrolling auf iOS */
 }
 
-/* Mobile Anpassungen für das Layout */
+/* Mobile adjustments for the layout */
 @media (max-width: 768px) {
     .appointments-layout {
-        grid-template-columns: 1fr; /* Einspaltiges Layout auf mobilen Geräten */
+        grid-template-columns: 1fr; /* Single column layout on mobile devices */
         gap: var(--spacing-md);
     }
 
@@ -828,7 +828,7 @@ textarea:focus {
     }
 
     .appointments-sidebar {
-        position: relative; /* Keine sticky Position auf mobilen Geräten */
+        position: relative; /* No sticky position on mobile devices */
         top: 0;
         max-height: none;
         margin-top: var(--spacing-md);

app/static/css/common.css

@@ -347,7 +347,7 @@ footer {
     input[type="submit"],
     button {
         width: 100%;
-        padding: 12px 16px; /* Größere Buttons für Touch-Geräte */
+        padding: 12px 16px; /* Larger buttons for touch devices */
         margin-top: 8px;
         margin-bottom: 8px;
     }

app/static/css/prefixed.css

@@ -272,27 +272,27 @@
   }
 }
 
-/* Allgemeine Hilfsmittel für bessere Browserkompatibilität */
+/* General utilities for better browser compatibility */
 
-/* Verhindert Textvergrößerung bei Orientierungsänderungen im iOS */
+/* Prevents text enlargement during orientation changes in iOS */
 html {
   -webkit-text-size-adjust: 100%;
   -ms-text-size-adjust: 100%;
   text-size-adjust: 100%;
 }
 
-/* Verbesserte Touch-Ziele für mobile Geräte */
+/* Improved touch targets for mobile devices */
 .touch-target {
   min-height: 44px;
   min-width: 44px;
 }
 
-/* Verhindert blaue Hervorhebung bei Tap auf mobilen Geräten */
+/* Prevents blue highlight on tap on mobile devices */
 .no-tap-highlight {
   -webkit-tap-highlight-color: transparent;
 }
 
-/* Verbesserte Schriftglättung */
+/* Improved font smoothing */
 .font-smoothing {
   -webkit-font-smoothing: antialiased;
   -moz-osx-font-smoothing: grayscale;