Add the tests for the directory manager

Fix the photo and travel diary relationship to properly work

pyproject.toml

@@ -20,7 +20,8 @@ dependencies = [
     "sqlalchemy",
     "textual",
     "tomli",
-    "tomli_w"
+    "tomli_w",
+    "unidecode"
 ]
 
 [project.urls]

src/pilgrim/models/photo.py

@@ -25,7 +25,8 @@ class Photo(Base):
         back_populates="photos"
     )
 
-    fk_travel_diary_id = Column(Integer, ForeignKey("travel_diaries.id"),nullable=False)
+    fk_travel_diary_id = Column(Integer, ForeignKey("travel_diaries.id"), nullable=False)
+    travel_diary = relationship("TravelDiary", back_populates="photos")
     __table_args__ = (
         Index('idx_photo_hash_diary', 'hash', 'fk_travel_diary_id'),
     )

src/pilgrim/models/travel_diary.py

@@ -13,6 +13,7 @@ class TravelDiary(Base):
     name = Column(String, nullable=False)
     directory_name = Column(String, nullable=False, unique=True)
     entries = relationship("Entry", back_populates="travel_diary", cascade="all, delete-orphan")
+    photos = relationship("Photo", back_populates="travel_diary", cascade="all, delete-orphan")
 
     __table_args__ = (
         UniqueConstraint('directory_name', name='uq_travel_diary_directory_name'),

src/pilgrim/service/travel_diary_service.py

@@ -7,7 +7,7 @@ from pilgrim.utils import DirectoryManager
 from sqlalchemy.exc import IntegrityError
 
 from pilgrim.models.travel_diary import TravelDiary
-
+from unidecode import unidecode
 
 class TravelDiaryService:
     def __init__(self, session):
@@ -20,8 +20,10 @@ class TravelDiaryService:
         - Replaces spaces with underscores
         - Ensures name is unique by adding a suffix if needed
         """
+        transliterated_name = unidecode(name)
+
         # Remove special characters and replace spaces
-        safe_name = re.sub(r'[^\w\s-]', '', name)
+        safe_name = re.sub(r'[^\w\s-]', '', transliterated_name)
         safe_name = safe_name.strip().replace(' ', '_').lower()
 
         # Ensure we have a valid name

tests/conftest.py

@@ -26,3 +26,11 @@ def populated_db_session(db_session):
     db_session.add(travel_diary)
     db_session.commit()
     return db_session
+
+@pytest.fixture
+def session_with_one_diary(db_session):
+    diary = TravelDiary(name="Diário de Teste", directory_name="diario_de_teste")
+    db_session.add(diary)
+    db_session.commit()
+    db_session.refresh(diary)
+    return db_session, diary

tests/service/test_travel_diary_service.py

@@ -0,0 +1,143 @@
+from unittest.mock import patch, MagicMock
+from pathlib import Path
+
+import pytest
+
+from pilgrim import TravelDiary
+from pilgrim.service.travel_diary_service import TravelDiaryService
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+@pytest.mark.asyncio # Marca o teste para rodar código assíncrono
+async def test_create_diary_successfully(mock_ensure_dir, db_session):
+    service = TravelDiaryService(db_session)
+    new_diary = await service.async_create("Viagem para a Serra")
+    assert new_diary is not None
+    assert new_diary.id is not None
+    assert new_diary.name == "Viagem para a Serra"
+    assert new_diary.directory_name == "viagem_para_a_serra"
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+@patch.object(TravelDiaryService, '_sanitize_directory_name', return_value="nome_existente")
+@pytest.mark.asyncio
+async def test_create_diary_handles_integrity_error(mock_sanitize, mock_ensure_dir, db_session):
+    existing_diary = TravelDiary(name="Diário Antigo", directory_name="nome_existente")
+    db_session.add(existing_diary)
+    db_session.commit()
+    service = TravelDiaryService(db_session)
+    with pytest.raises(ValueError, match="Could not create diary"):
+        await service.async_create("Qualquer Nome Novo")
+    mock_ensure_dir.assert_not_called()
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+def test_read_by_id_successfully(mock_ensure_dir, session_with_one_diary):
+    session, diary_to_find = session_with_one_diary
+    service = TravelDiaryService(session)
+    found_diary = service.read_by_id(diary_to_find.id)
+    assert found_diary is not None
+    assert found_diary.id == diary_to_find.id
+    assert found_diary.name == "Diário de Teste"
+    mock_ensure_dir.assert_called_once_with(found_diary)
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+def test_read_by_id_returns_none_for_invalid_id(mock_ensure_dir, db_session):
+    service = TravelDiaryService(db_session)
+    result = service.read_by_id(999)
+    assert result is None
+    mock_ensure_dir.assert_not_called()
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+def test_read_all_returns_all_diaries(mock_ensure_dir, db_session):
+    d1 = TravelDiary(name="Diário 1", directory_name="d1")
+    d2 = TravelDiary(name="Diário 2", directory_name="d2")
+    db_session.add_all([d1, d2])
+    db_session.commit()
+    service = TravelDiaryService(db_session)
+    diaries = service.read_all()
+    assert isinstance(diaries, list)
+    assert len(diaries) == 2
+    assert mock_ensure_dir.call_count == 2
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+def test_read_all_returns_empty_list_for_empty_db(mock_ensure_dir, db_session):
+    service = TravelDiaryService(db_session)
+    diaries = service.read_all()
+    assert isinstance(diaries, list)
+    assert len(diaries) == 0
+    mock_ensure_dir.assert_not_called()
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+@patch('pathlib.Path.rename')
+@patch.object(TravelDiaryService, '_get_diary_directory')
+def test_update_diary_successfully(mock_get_dir, mock_path_rename, mock_ensure, session_with_one_diary):
+    session, diary_to_update = session_with_one_diary
+    service = TravelDiaryService(session)
+    old_path = MagicMock(spec=Path)  # Um mock que se parece com um objeto Path
+    old_path.exists.return_value = True  # Dizemos que o diretório antigo "existe"
+    new_path = Path("/fake/path/diario_atualizado")
+    mock_get_dir.side_effect = [old_path, new_path]
+    updated_diary = service.update(diary_to_update.id, "Diário Atualizado")
+    assert updated_diary is not None
+    assert updated_diary.name == "Diário Atualizado"
+    assert updated_diary.directory_name == "diario_atualizado"
+    old_path.rename.assert_called_once_with(new_path)
+
+def test_update_returns_none_for_invalid_id(db_session):
+    service = TravelDiaryService(db_session)
+    result = service.update(travel_diary_id=999, name="Nome Novo")
+    assert result is None
+
+@patch.object(TravelDiaryService, '_cleanup_diary_directory')
+def test_delete_diary_successfully(mock_cleanup, session_with_one_diary):
+    session, diary_to_delete = session_with_one_diary
+    service = TravelDiaryService(session)
+    result = service.delete(diary_to_delete)
+    assert result is not None
+    assert result.id == diary_to_delete.id
+    mock_cleanup.assert_called_once_with(diary_to_delete)
+    diary_in_db = service.read_by_id(diary_to_delete.id)
+    assert diary_in_db is None
+
+@patch.object(TravelDiaryService, '_cleanup_diary_directory')
+def test_delete_returns_none_for_non_existent_diary(mock_cleanup, db_session):
+    service = TravelDiaryService(db_session)
+    non_existent_diary = TravelDiary(name="dummy", directory_name="dummy")
+    non_existent_diary.id = 999
+    result = service.delete(non_existent_diary)
+    assert result is None
+    mock_cleanup.assert_not_called()
+
+@patch.object(TravelDiaryService, '_sanitize_directory_name')
+def test_update_raises_value_error_on_name_collision(mock_sanitize, db_session):
+
+    d1 = TravelDiary(name="Diário A", directory_name="diario_a")
+    d2 = TravelDiary(name="Diário B", directory_name="diario_b")
+    db_session.add_all([d1, d2])
+    db_session.commit()
+    db_session.refresh(d1)
+    mock_sanitize.return_value = "diario_b"
+    service = TravelDiaryService(db_session)
+    with pytest.raises(ValueError, match="Could not update diary"):
+        service.update(d1.id, "Diário B")
+
+def test_sanitize_directory_name_formats_string_correctly(db_session):
+    service = TravelDiaryService(db_session)
+    name1 = "Minha Primeira Viagem"
+    assert service._sanitize_directory_name(name1) == "minha_primeira_viagem"
+    name2 = "Viagem para o #Rio de Janeiro! @2025"
+    assert service._sanitize_directory_name(name2) == "viagem_para_o_rio_de_janeiro_2025"
+    name3 = "  Mochilão na Europa   "
+    assert service._sanitize_directory_name(name3) == "mochilao_na_europa"
+
+def test_sanitize_directory_name_handles_uniqueness(db_session):
+    existing_diary = TravelDiary(name="Viagem para a Praia", directory_name="viagem_para_a_praia")
+    db_session.add(existing_diary)
+    db_session.commit()
+    service = TravelDiaryService(db_session)
+    new_sanitized_name = service._sanitize_directory_name("Viagem para a Praia")
+    assert new_sanitized_name == "viagem_para_a_praia_1"
+    another_diary = TravelDiary(name="Outra Viagem", directory_name="viagem_para_a_praia_1")
+    db_session.add(another_diary)
+    db_session.commit()
+
+    third_sanitized_name = service._sanitize_directory_name("Viagem para a Praia")
+    assert third_sanitized_name == "viagem_para_a_praia_2"

tests/test_database.py

@@ -0,0 +1,40 @@
+import pytest
+from unittest.mock import Mock  # A ferramenta para criar nosso "dublê"
+from pathlib import Path
+from sqlalchemy import inspect, Column, Integer, String
+from sqlalchemy.orm import Session
+
+from pilgrim.database import Database,Base
+
+class MockUser(Base):
+    __tablename__ = 'mock_users'
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+
+@pytest.fixture
+def db_instance(tmp_path: Path):
+    fake_db_path = tmp_path / "test_pilgrim.db"
+    mock_config_manager = Mock()
+    mock_config_manager.database_url = str(fake_db_path)
+    db = Database(mock_config_manager)
+    return db, fake_db_path
+
+def test_create_database(db_instance):
+    db, fake_db_path = db_instance
+    db.create()
+    assert fake_db_path.exists()
+
+def test_table_creation(db_instance):
+    db, _ = db_instance
+    db.create()
+    inspector = inspect(db.engine)
+    assert "mock_users" in inspector.get_table_names()
+
+def test_session_returned_corectly(db_instance):
+    db, _ = db_instance
+    session = db.session()
+    assert isinstance(session, Session)
+    session.close()
+
+
+

tests/utils/test_directory_manager.py

@@ -0,0 +1,71 @@
+import shutil
+from pathlib import Path
+from unittest.mock import patch
+import pytest
+
+from pilgrim.utils.directory_manager import DirectoryManager
+
+@patch('os.chmod')
+@patch('pathlib.Path.home')
+def test_get_config_directory_creates_dir_in_fake_home(mock_home, mock_chmod, tmp_path: Path):
+    mock_home.return_value = tmp_path
+
+    expected_config_dir = tmp_path / ".pilgrim"
+    assert not expected_config_dir.exists()
+    result_path = DirectoryManager.get_config_directory()
+    assert result_path == expected_config_dir
+    assert expected_config_dir.exists()
+    mock_chmod.assert_called_once_with(expected_config_dir, 0o700)
+
+@patch('shutil.copy2')
+@patch('pathlib.Path.home')
+def test_get_database_path_no_migration(mock_home, mock_copy, tmp_path: Path):
+    mock_home.return_value = tmp_path
+    expected_db_path = tmp_path / ".pilgrim" / "database.db"
+    result_path = DirectoryManager.get_database_path()
+    assert result_path == expected_db_path
+    mock_copy.assert_not_called()
+
+@patch('shutil.copy2')
+@patch('pathlib.Path.home')
+def test_get_database_path_with_migration(mock_home, mock_copy, tmp_path: Path, monkeypatch):
+    fake_home_dir = tmp_path / "home"
+    fake_project_dir = tmp_path / "project"
+    fake_home_dir.mkdir()
+    fake_project_dir.mkdir()
+
+    (fake_project_dir / "database.db").touch()
+    mock_home.return_value = fake_home_dir
+    monkeypatch.chdir(fake_project_dir)
+    result_path = DirectoryManager.get_database_path()
+    expected_db_path = fake_home_dir / ".pilgrim" / "database.db"
+    assert result_path == expected_db_path
+
+    mock_copy.assert_called_once_with(
+        Path("database.db"),
+        expected_db_path
+    )
+
+@patch('os.chmod')
+@patch('pathlib.Path.home')
+def test_diary_path_methods_construct_correctly(mock_home, mock_chmod, tmp_path: Path):
+    mock_home.return_value = tmp_path
+    images_path = DirectoryManager.get_diary_images_directory("minha-viagem")
+    expected_path = tmp_path / ".pilgrim" / "diaries" / "minha-viagem" / "data" / "images"
+    assert images_path == expected_path
+    assert (tmp_path / ".pilgrim" / "diaries").exists()
+
+@patch('shutil.copy2')
+@patch('pathlib.Path.home')
+def test_get_database_path_handles_migration_error(mock_home, mock_copy, tmp_path: Path, monkeypatch):
+    fake_home_dir = tmp_path / "home"
+    fake_project_dir = tmp_path / "project"
+    fake_home_dir.mkdir()
+    fake_project_dir.mkdir()
+    (fake_project_dir / "database.db").touch()
+    mock_home.return_value = fake_home_dir
+    mock_copy.side_effect = shutil.Error("O disco está cheio!")
+    monkeypatch.chdir(fake_project_dir)
+    with pytest.raises(RuntimeError, match="Failed to migrate database"):
+        DirectoryManager.get_database_path()
+    mock_copy.assert_called_once()