From b020f8500bfa4a962cac90c76d99632405026e31 Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Sun, 20 Jul 2025 23:38:36 -0300 Subject: [PATCH 1/7] Add The tests for the filename sanitization function and the create travel diary --- tests/service/test_travel_diary_service.py | 51 ++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 tests/service/test_travel_diary_service.py diff --git a/tests/service/test_travel_diary_service.py b/tests/service/test_travel_diary_service.py new file mode 100644 index 0000000..33c8279 --- /dev/null +++ b/tests/service/test_travel_diary_service.py @@ -0,0 +1,51 @@ +from unittest.mock import patch + +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() + +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) == "mochilão_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" \ No newline at end of file From f374285e2acad295e2e77bf1215ded91db0ced06 Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Sun, 20 Jul 2025 23:52:45 -0300 Subject: [PATCH 2/7] Add the fixture for the read entry tests --- tests/conftest.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tests/conftest.py b/tests/conftest.py index 0bd63f9..0c1ce17 100644 --- a/tests/conftest.py +++ b/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 From 152bff85e5dc190549cd79c2389c9ffe38c70729 Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Sun, 20 Jul 2025 23:53:53 -0300 Subject: [PATCH 3/7] Add the read entries unit tests --- tests/service/test_travel_diary_service.py | 37 ++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/tests/service/test_travel_diary_service.py b/tests/service/test_travel_diary_service.py index 33c8279..b6a1f42 100644 --- a/tests/service/test_travel_diary_service.py +++ b/tests/service/test_travel_diary_service.py @@ -27,6 +27,43 @@ async def test_create_diary_handles_integrity_error(mock_sanitize, mock_ensure_d 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() + def test_sanitize_directory_name_formats_string_correctly(db_session): service = TravelDiaryService(db_session) name1 = "Minha Primeira Viagem" From df9101ccac4061402d3278c5cc7d4243e69bb6d1 Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Mon, 21 Jul 2025 00:13:26 -0300 Subject: [PATCH 4/7] Add unidecode dependency on pyproject.toml --- pyproject.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index e6b6187..124a6f3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -20,7 +20,8 @@ dependencies = [ "sqlalchemy", "textual", "tomli", - "tomli_w" + "tomli_w", + "unidecode" ] [project.urls] From 240e4ae6c7575f4032afbb42acc0ec6ca50c12d8 Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Mon, 21 Jul 2025 00:14:17 -0300 Subject: [PATCH 5/7] fix the sanitization directory method to remove accents and diacritics --- src/pilgrim/service/travel_diary_service.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/pilgrim/service/travel_diary_service.py b/src/pilgrim/service/travel_diary_service.py index e1aa6e6..8932b8c 100644 --- a/src/pilgrim/service/travel_diary_service.py +++ b/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 From 66879b5a7dc48682d64cbc4037ccf79c6227bd6e Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Mon, 21 Jul 2025 00:52:38 -0300 Subject: [PATCH 6/7] Add the tests for update the entries method --- tests/service/test_travel_diary_service.py | 39 ++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/tests/service/test_travel_diary_service.py b/tests/service/test_travel_diary_service.py index b6a1f42..17dfbbe 100644 --- a/tests/service/test_travel_diary_service.py +++ b/tests/service/test_travel_diary_service.py @@ -1,4 +1,5 @@ -from unittest.mock import patch +from unittest.mock import patch, MagicMock +from pathlib import Path import pytest @@ -64,6 +65,40 @@ def test_read_all_returns_empty_list_for_empty_db(mock_ensure_dir, db_session): 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, '_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" @@ -71,7 +106,7 @@ def test_sanitize_directory_name_formats_string_correctly(db_session): 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) == "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") From a18c621d5ce87afb12de3cd08c6427e21f6199cf Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Mon, 21 Jul 2025 01:07:11 -0300 Subject: [PATCH 7/7] Add the tests for delete the entries method --- tests/service/test_travel_diary_service.py | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/tests/service/test_travel_diary_service.py b/tests/service/test_travel_diary_service.py index 17dfbbe..efab0f9 100644 --- a/tests/service/test_travel_diary_service.py +++ b/tests/service/test_travel_diary_service.py @@ -86,6 +86,26 @@ def test_update_returns_none_for_invalid_id(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):