Compare commits

...
Author SHA1 Message Date
Gustavo Henrique Santos Souza de Miranda 819a2c7b6b Add the tests for the new methods of deleting 2025-07-24 23:36:02 -03:00
Gustavo Henrique Miranda 92ee47cff3 Merge pull request #83 from gmbrax/fix/add-photos-list-to-entry-model
Fix to add a photo list to the constructor of the entry model
2025-07-24 23:20:01 -03:00
Gustavo Henrique Mirandaandcoderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> 8d45b4361e Update src/pilgrim/models/entry.py
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2025-07-24 23:18:34 -03:00
Gustavo Henrique Santos Souza de Miranda 3db39eac71 Fix to add a photo list to the constructor of the entry model 2025-07-24 23:13:01 -03:00
Gustavo Henrique Miranda 7faab93dfe Update CHANGELOG.md
Add the 0.0.5 changes into the changelog
2025-07-24 21:52:28 -03:00
Gustavo Henrique Miranda 34821bfedb Merge pull request #82 from gmbrax/refactor/remove-mocks
Remove the unused mock services
2025-07-24 21:12:32 -03:00
4 changed files with 128 additions and 37 deletions
+55 -34
View File
@@ -6,63 +6,84 @@ The format is based on Keep a Changelog, and this project adheres to Semantic Ve
## Unreleased ## Unreleased
## Planned ## Planned
* Installation Method 1 (repository compilation) * Restore from backup functionality
* Organization of trips by date, location, or theme * Organization of trips by date, location, or theme
* Enhanced photo management features * Enhanced photo management features
* Search functionality * Search functionality
* Export features * Export features
* Testing implementation * UI Testing with Textual Pilot
## [0.0.5] - 2025-07-24
### Added
* **Backup Feature:** Introduced a full backup feature to export the database and all photos to a single ZIP file.
* **Diary Settings Screen:** Added a dedicated settings screen per diary, accessible with the 's' key from the diary list.
* **Advanced Deletion Options:** The new settings screen allows for deleting the entire diary, all of its entries, or all of its photos.
* **Confirmation Modals:** Added confirmation modals that require the user to type the diary's name to proceed with critical delete operations, preventing accidental data loss.
* **Comprehensive Test Suite:** Implemented a robust unit and integration test suite for the entire backend (services, models, utils, application), achieving high code coverage and ensuring stability.
### Changed
* **Architectural Refactor:** Service methods were refactored to be transactional, allowing for more complex operations to be executed safely and atomically.
* **Configuration:** The "auto-open diary on startup" setting is now managed and persisted via the `config.toml` file.
* **Project Structure:** Standardized project metadata and build configuration in `pyproject.toml` and converted all imports to use a consistent absolute path structure.
### Fixed
* **Directory Name Sanitization:** Fixed a bug where directory names were not correctly sanitized, now properly handling accented and special characters by using transliteration.
* **Data Integrity:** Enforced `NOT NULL` constraints on `title` and `date` fields for entries in the database, preventing the creation of entries with invalid data.
### Removed
* **Obsolete Mocks:** Removed old and unused mock service files from the production codebase.
## [0.0.4] - 2025-07-19 ## [0.0.4] - 2025-07-19
### Added ### Added
* Support for creating new diaries asynchronously, with an option to automatically open the newly created diary * Support for creating new diaries asynchronously, with an option to automatically open the newly created diary.
* Unified "Enter" key support for saving or creating diaries across relevant modals * Unified "Enter" key support for saving or creating diaries across relevant modals.
* Automatic diary list refresh when returning to the diary screen * Automatic diary list refresh when returning to the diary screen.
* Application configuration management with a new centralized config system * Application configuration management with a new centralized config system.
* Database location and initialization now configurable via the new config manager * Database location and initialization now configurable via the new config manager.
* Automatic migration of database file to the configuration directory * Automatic migration of database file to the configuration directory.
* Display of database URL on application startup for transparency * Display of database URL on application startup for transparency.
* Duplicate photo detection before photo creation to prevent redundant entries * Duplicate photo detection before photo creation to prevent redundant entries.
* Photo hash indexing to improve photo lookup performance * Photo hash indexing to improve photo lookup performance.
### Changed ### Changed
* Enhanced feedback and validation when editing or creating diary names * Enhanced feedback and validation when editing or creating diary names.
* Streamlined and unified save logic for diary modals, reducing duplicated behavior * Streamlined and unified save logic for diary modals, reducing duplicated behavior.
* About screen now displays the actual installed application version dynamically * About screen now displays the actual installed application version dynamically.
* Sidebar and photo-related UI text updated to remove emoji icons for a cleaner appearance * Sidebar and photo-related UI text updated to remove emoji icons for a cleaner appearance.
* Sidebar layout and scrolling behavior improved for better usability * Sidebar layout and scrolling behavior improved for better usability.
* Photo hash generation now relies on existing service-provided hashes instead of local computation * Photo hash generation now relies on existing service-provided hashes instead of local computation.
### Improved ### Improved
* Enhanced feedback and validation when editing or creating diary names * Enhanced feedback and validation when editing or creating diary names.
* Streamlined and unified save logic for diary modals, reducing duplicated behavior * Streamlined and unified save logic for diary modals, reducing duplicated behavior.
* Sidebar layout and scrolling behavior for better usability * Sidebar layout and scrolling behavior for better usability.
## [0.0.3] - 2025-07-07 ## [0.0.3] - 2025-07-07
### Changed ### Changed
* Removed the dependency on textual-dev from pyproject.toml * Removed the dependency on textual-dev from pyproject.toml.
## [0.0.2] - 2025-07-07 ## [0.0.2] - 2025-07-07
### Changed ### Changed
* Changed the license in pyproject.toml to BSD * Changed the license in pyproject.toml to BSD.
## [0.0.1] - 2025-07-06 ## [0.0.1] - 2025-07-06
### Added ### Added
* Initial alpha release of Pilgrim travel diary application * Initial alpha release of Pilgrim travel diary application.
* Create and edit travel diaries * Create and edit travel diaries.
* Create and edit diary entries * Create and edit diary entries.
* Photo ingestion system * Photo ingestion system.
* Photo addition and reference via sidebar * Photo addition and reference via sidebar.
* Text User Interface (TUI) built with Textual framework * Text User Interface (TUI) built with Textual framework.
* Pre-compiled binary installation method (Method 2) * Pre-compiled binary installation method (Method 2).
* Support for Linux operating systems * Support for Linux operating systems.
* Basic project documentation (README) * Basic project documentation (README).
### Known Issues ### Known Issues
* Installation Method 1 not yet implemented * Installation Method 1 not yet implemented.
* No testing suite implemented yet * No testing suite implemented yet.
* Some features may be unstable in an alpha version * Some features may be unstable in an alpha version.
+6 -2
View File
@@ -1,5 +1,6 @@
from typing import Any from typing import Any, List
from pilgrim.models.photo import Photo
from pilgrim.models.photo_in_entry import photo_entry_association from pilgrim.models.photo_in_entry import photo_entry_association
from sqlalchemy import Column, Integer, String, ForeignKey, DateTime from sqlalchemy import Column, Integer, String, ForeignKey, DateTime
from sqlalchemy.orm import relationship from sqlalchemy.orm import relationship
@@ -21,9 +22,12 @@ class Entry(Base):
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="entries") travel_diary = relationship("TravelDiary", back_populates="entries")
def __init__(self, title: str, text: str, date: str, travel_diary_id: int, **kw: Any): def __init__(self, title: str, text: str, date: Any, travel_diary_id: int, photos: List[Photo] = None, **kw: Any):
super().__init__(**kw) super().__init__(**kw)
self.title = title self.title = title
self.text = text self.text = text
self.date = date self.date = date
self.fk_travel_diary_id = travel_diary_id self.fk_travel_diary_id = travel_diary_id
if photos is not None:
self.photos = photos
+23
View File
@@ -1,7 +1,10 @@
from datetime import datetime
import pytest import pytest
from sqlalchemy import create_engine from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker from sqlalchemy.orm import sessionmaker
from pilgrim.models.entry import Entry
from pilgrim.database import Base from pilgrim.database import Base
from pilgrim.models.travel_diary import TravelDiary from pilgrim.models.travel_diary import TravelDiary
from pilgrim.models.photo import Photo from pilgrim.models.photo import Photo
@@ -62,3 +65,23 @@ def session_with_photos(session_with_one_diary):
session.commit() session.commit()
return session, [photo1, photo2] return session, [photo1, photo2]
@pytest.fixture
def entry_with_photo_references(session_with_one_diary):
session, diary = session_with_one_diary
photo1 = Photo(filepath="p1.jpg", name="P1", photo_hash="aaaaaaaa", fk_travel_diary_id=diary.id)
photo2 = Photo(filepath="p2.jpg", name="P2", photo_hash="bbbbbbbb", fk_travel_diary_id=diary.id)
session.add_all([photo1, photo2])
session.flush()
entry = Entry(
title="Entrada com Fotos",
text="Texto com a foto A [[photo::aaaaaaaa]] e também a foto B [[photo::bbbbbbbb]].",
date=datetime.now(),
travel_diary_id=diary.id,
photos=[photo1, photo2]
)
session.add(entry)
session.commit()
session.refresh(entry)
return session, entry
+43
View File
@@ -261,3 +261,46 @@ def test_delete_returns_none_if_entry_does_not_exist(db_session):
non_existent_entry.id = 999 non_existent_entry.id = 999
result = service.delete(non_existent_entry) result = service.delete(non_existent_entry)
assert result is None assert result is None
def test_delete_references_for_specific_photo(entry_with_photo_references):
session, entry = entry_with_photo_references
service = EntryService(session)
updated_entry = service.delete_references_for_specific_photo(entry, "aaaaaaaa")
assert "[[photo::aaaaaaaa]]" not in updated_entry.text
assert "[[photo::bbbbbbbb]]" in updated_entry.text
def test_delete_specific_photo_reference_does_nothing_if_no_match(entry_with_photo_references):
session, entry = entry_with_photo_references
service = EntryService(session)
original_text = entry.text
updated_entry = service.delete_references_for_specific_photo(entry, "cccccccc")
assert updated_entry.text == original_text
def test_delete_all_photo_references_removes_all_refs(entry_with_photo_references):
session, entry = entry_with_photo_references
service = EntryService(session)
updated_entry = service.delete_all_photo_references(entry)
assert "[[photo::aaaaaaaa]]" not in updated_entry.text
assert "[[photo::bbbbbbbb]]" not in updated_entry.text
def test_delete_all_photo_references_uses_truncated_hash(session_with_one_diary):
session, diary = session_with_one_diary
service = EntryService(session)
long_hash_photo = Photo(
filepath="long.jpg", name="Long",
photo_hash="1234567890abcdef", # Hash com 16 caracteres
fk_travel_diary_id=diary.id
)
entry = Entry(
title="Teste de Hash Curto",
text="Referência com hash truncado [[photo::12345678]].", # Texto usa só os 8 primeiros
date=datetime.now(),
travel_diary_id=diary.id
)
entry.photos.append(long_hash_photo)
session.add_all([long_hash_photo, entry])
session.commit()
updated_entry = service.delete_all_photo_references(entry)
expected_text = "Referência com hash truncado ."
assert "[[photo::12345678]]" not in updated_entry.text