feat: allow to hide "music_room", "sports" and "moodle"

alembic/versions/_2024_02_13_05_37_music_room_sports_moodle_hidden.py

@@ -0,0 +1,37 @@
+"""music room sports moodle hidden
+
+Revision ID: 6f44af938cdf
+Revises: cba1388a6e8f
+Create Date: 2024-02-13 05:37:56.186458
+
+"""
+# ruff: noqa: E501
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "6f44af938cdf"
+down_revision: Union[str, None] = "cba1388a6e8f"
+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.add_column(
+        "users", sa.Column("music_room_hidden", sa.Boolean(), server_default=sa.text("false"), nullable=False)
+    )
+    op.add_column("users", sa.Column("sports_hidden", sa.Boolean(), server_default=sa.text("false"), nullable=False))
+    op.add_column("users", sa.Column("moodle_hidden", sa.Boolean(), server_default=sa.text("false"), nullable=False))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("users", "moodle_hidden")
+    op.drop_column("users", "sports_hidden")
+    op.drop_column("users", "music_room_hidden")
+    # ### end Alembic commands ###

src/api/users/routes.py

@@ -1,3 +1,5 @@
+from typing import Literal
+
 from fastapi import HTTPException
 from pydantic import BaseModel
 from sqlalchemy.exc import IntegrityError
@@ -57,10 +59,7 @@ async def delete_favorite(
     return updated_user
 
 
-@router.post(
-    "/me/favorites/hide",
-    responses={200: {"description": "Favorite hidden"}},
-)
+@router.post("/me/favorites/hide", responses={200: {"description": "Favorite hidden"}})
 async def hide_favorite(
     user_id: CURRENT_USER_ID_DEPENDENCY,
     group_id: int,
@@ -74,7 +73,19 @@ async def hide_favorite(
     if await event_group_repository.read(group_id) is None:
         raise UserNotFoundException()
     user_repository = Shared.f(SqlUserRepository)
-    updated_user = await user_repository.set_hidden(user_id=user_id, group_id=group_id, hide=hide)
+    updated_user = await user_repository.set_hidden_event_group(user_id=user_id, group_id=group_id, hide=hide)
+    return updated_user
+
+
+@router.post("/me/{target}/hide", responses={200: {"description": "Target hidden"}})
+async def hide_music_room(
+    user_id: CURRENT_USER_ID_DEPENDENCY, target: Literal["music-room", "sports", "moodle"], hide: bool = True
+) -> ViewUser:
+    """
+    Hide music room from current user
+    """
+    user_repository = Shared.f(SqlUserRepository)
+    updated_user = await user_repository.set_hidden(user_id=user_id, target=target, hide=hide)
     return updated_user
 
 

src/repositories/users/repository.py

@@ -2,8 +2,9 @@
 
 import random
 import string
+from typing import Literal
 
-from sqlalchemy import select, delete
+from sqlalchemy import select, delete, update
 from sqlalchemy.dialects.postgresql import insert
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import selectinload
@@ -154,7 +155,7 @@ async def remove_favorite(self, user_id: int, favorite_id: int) -> ViewUser:
             await session.commit()
             return ViewUser.model_validate(user)
 
-    async def set_hidden(self, user_id: int, group_id: int, hide: bool = True) -> "ViewUser":
+    async def set_hidden_event_group(self, user_id: int, group_id: int, hide: bool = True) -> "ViewUser":
         async with self._create_session() as session:
             # find favorite where user_id and group_id
             q = (
@@ -175,6 +176,25 @@ async def set_hidden(self, user_id: int, group_id: int, hide: bool = True) -> "V
             await session.commit()
             return ViewUser.model_validate(user)
 
+    async def set_hidden(self, user_id: int, target: Literal["music-room", "sports", "moodle"], hide: bool = True):
+        async with self._create_session() as session:
+            q = (
+                update(User)
+                .where(User.id == user_id)
+                .values(
+                    {
+                        "music_room_hidden": hide if target == "music-room" else User.music_room_hidden,
+                        "sports_hidden": hide if target == "sports" else User.sports_hidden,
+                        "moodle_hidden": hide if target == "moodle" else User.moodle_hidden,
+                    }
+                )
+                .returning(User)
+                .options(*_get_options)
+            )
+            user = await session.scalar(q)
+            await session.commit()
+            return ViewUser.model_validate(user)
+
     async def link_calendar(self, user_id: int, calendar: "LinkedCalendarCreate") -> "LinkedCalendarView":
         async with self._create_session() as session:
             q = (

src/schemas/users.py

@@ -27,6 +27,9 @@ class ViewUser(BaseModel):
     name: Optional[str] = None
     favorites_association: list["UserXFavoriteGroupView"] = Field(default_factory=list)
     linked_calendars: dict[str, "LinkedCalendarView"] = Field(default_factory=dict)
+    music_room_hidden: bool
+    sports_hidden: bool
+    moodle_hidden: bool
 
     @field_validator("favorites_association", mode="before")
     def groups_to_list(cls, v):

src/storages/sql/models/users.py

@@ -2,7 +2,7 @@
 
 from typing import TYPE_CHECKING
 
-from sqlalchemy import ForeignKey
+from sqlalchemy import ForeignKey, false
 from sqlalchemy.ext.associationproxy import association_proxy
 from sqlalchemy.orm import relationship, mapped_column, Mapped
 
@@ -44,6 +44,10 @@ class User(Base, IdMixin):
         passive_deletes=True,
     )
 
+    music_room_hidden: Mapped[bool] = mapped_column(nullable=False, default=False, server_default=false())
+    sports_hidden: Mapped[bool] = mapped_column(nullable=False, default=False, server_default=false())
+    moodle_hidden: Mapped[bool] = mapped_column(nullable=False, default=False, server_default=false())
+
 
 class UserScheduleKeys(Base, IdMixin):
     __tablename__ = "user_schedule_keys"

tests/repositories/test_integrations.py

@@ -62,7 +62,7 @@ async def test_set_hidden(event_group_repository, user_repository):
     assert user_x_group.event_group.id == event_group.id
     assert user_x_group.hidden is False
 
-    await user_repository.set_hidden(user.id, event_group.id, True)
+    await user_repository.set_hidden_event_group(user.id, event_group.id, True)
     updated_user = await user_repository.read(user.id)
     user_x_group = updated_user.favorites_association[0]
     assert user_x_group.hidden is True