Samir Boulahtit
7c43d6f4a2
Eliminate all 103 errors and 96 warnings from the architecture validator: Phase 1 - Validator rules & YAML: - Add NAM-001/NAM-002 exceptions for module-scoped router/service files - Fix API-004 to detect # public comments on decorator lines - Add module-specific exception bases to EXC-004 valid_bases - Exclude storefront files from AUTH-004 store context check - Add SVC-006 exceptions for loyalty service atomic commits - Fix _get_rule() to search naming_rules and auth_rules categories - Use plain # CODE comments instead of # noqa: CODE for custom rules Phase 2 - Billing module (5 route files): - Move _resolve_store_to_merchant to subscription_service - Move tier/feature queries to feature_service, admin_subscription_service - Extract 22 inline Pydantic schemas to billing/schemas/billing.py - Replace all HTTPException with domain exceptions Phase 3 - Loyalty module (4 routes + points_service): - Add 7 domain exceptions (Apple auth, enrollment, device registration) - Add service methods to card_service, program_service, apple_wallet_service - Move all db.query() from routes to service layer - Fix SVC-001: replace HTTPException in points_service with domain exception Phase 4 - Remaining modules: - tenancy: move store stats queries to admin_service - cms: move platform resolution to content_page_service, add NoPlatformSubscriptionException - messaging: move user/customer lookups to messaging_service - Add ConfigDict(from_attributes=True) to ContentPageResponse Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
65 lines
2.2 KiB
YAML
65 lines
2.2 KiB
YAML
# Architecture Rules - Model Rules
|
|
# Rules for models/database/*.py, models/schema/*.py, app/modules/*/models/**/*.py, and app/modules/*/schemas/**/*.py files
|
|
|
|
model_rules:
|
|
|
|
- id: "MDL-001"
|
|
name: "Database models must use SQLAlchemy Base"
|
|
severity: "error"
|
|
description: |
|
|
All database models must inherit from SQLAlchemy Base and use proper
|
|
column definitions with types and constraints.
|
|
pattern:
|
|
file_pattern:
|
|
- "models/database/**/*.py"
|
|
- "app/modules/*/models/**/*.py"
|
|
required_patterns:
|
|
- "class.*\\(Base\\):"
|
|
|
|
- id: "MDL-002"
|
|
name: "Use Pydantic models separately from SQLAlchemy models"
|
|
severity: "error"
|
|
description: |
|
|
Never mix SQLAlchemy and Pydantic in the same model.
|
|
SQLAlchemy = database schema, Pydantic = API validation/serialization.
|
|
pattern:
|
|
file_pattern:
|
|
- "models/**/*.py"
|
|
- "app/modules/*/models/**/*.py"
|
|
- "app/modules/*/schemas/**/*.py"
|
|
anti_patterns:
|
|
- "class.*\\(Base, BaseModel\\):"
|
|
|
|
- id: "MDL-003"
|
|
name: "Pydantic models must use from_attributes for ORM mode"
|
|
severity: "error"
|
|
description: |
|
|
Pydantic response models must enable from_attributes to work with SQLAlchemy models.
|
|
pattern:
|
|
file_pattern:
|
|
- "models/schema/**/*.py"
|
|
- "app/modules/*/schemas/**/*.py"
|
|
required_in_response_models:
|
|
- "from_attributes = True"
|
|
|
|
- id: "MDL-004"
|
|
name: "Database tables use plural names"
|
|
severity: "warning"
|
|
description: |
|
|
Database table names should be plural lowercase following industry standard
|
|
conventions (Rails, Django, Laravel, most ORMs). A table represents a
|
|
collection of entities, so plural names are natural: 'users', 'orders',
|
|
'products'. This reads naturally in SQL: SELECT * FROM users WHERE id = 1.
|
|
|
|
Examples:
|
|
- Good: users, vendors, products, orders, order_items, cart_items
|
|
- Bad: user, vendor, product, order
|
|
|
|
Junction/join tables use both entity names in plural:
|
|
- Good: vendor_users, order_items, product_translations
|
|
pattern:
|
|
file_pattern:
|
|
- "models/database/**/*.py"
|
|
- "app/modules/*/models/**/*.py"
|
|
check: "table_naming_plural"
|