mirror of https://github.com/gmbrax/Pilgrim.git
Compare commits
1 Commits
1612aac00c
...
e7a7d0cd87
| Author | SHA1 | Date |
|---|---|---|
|
|
e7a7d0cd87 |
89
CHANGELOG.md
89
CHANGELOG.md
|
|
@ -6,84 +6,63 @@ The format is based on Keep a Changelog, and this project adheres to Semantic Ve
|
||||||
## Unreleased
|
## Unreleased
|
||||||
|
|
||||||
## Planned
|
## Planned
|
||||||
* Restore from backup functionality
|
* Installation Method 1 (repository compilation)
|
||||||
* 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
|
||||||
* UI Testing with Textual Pilot
|
* Testing implementation
|
||||||
|
|
||||||
## [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
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,123 @@
|
||||||
|
from typing import List, Tuple
|
||||||
|
import asyncio
|
||||||
|
from pilgrim.service.entry_service import EntryService
|
||||||
|
from pilgrim.models.entry import Entry
|
||||||
|
|
||||||
|
|
||||||
|
class EntryServiceMock(EntryService):
|
||||||
|
def __init__(self):
|
||||||
|
super().__init__(None)
|
||||||
|
|
||||||
|
self.mock_data = {
|
||||||
|
1: Entry(title="The Adventure Begins", text="I'm hopping in the Plane to finally visit canadian lands",
|
||||||
|
date="26/07/2025", travel_diary_id=1, id=1,
|
||||||
|
photos=[]),
|
||||||
|
2: Entry(title="The Landing", text="Finally on Canadian Soil", date="27/07/2025",
|
||||||
|
travel_diary_id=1, id=2,photos=[]),
|
||||||
|
3: Entry(title="The Mount Royal", text="The Mount Royal is fucking awesome", date="28/07/2025",
|
||||||
|
travel_diary_id=1, id=3, photos=[]),
|
||||||
|
4: Entry(title="Old Montreal", text="Exploring the historic district", date="29/07/2025",
|
||||||
|
travel_diary_id=1, id=4, photos=[]),
|
||||||
|
5: Entry(title="Notre-Dame Basilica", text="Beautiful architecture", date="30/07/2025",
|
||||||
|
travel_diary_id=1, id=5, photos=[]),
|
||||||
|
6: Entry(title="Parc Jean-Drapeau", text="Great views of the city", date="31/07/2025",
|
||||||
|
travel_diary_id=1, id=6, photos=[]),
|
||||||
|
7: Entry(title="La Ronde", text="Amusement park fun", date="01/08/2025",
|
||||||
|
travel_diary_id=1, id=7, photos=[]),
|
||||||
|
8: Entry(title="Biodome", text="Nature and science", date="02/08/2025",
|
||||||
|
travel_diary_id=1, id=8, photos=[]),
|
||||||
|
9: Entry(title="Botanical Gardens", text="Peaceful walk", date="03/08/2025",
|
||||||
|
travel_diary_id=1, id=9, photos=[]),
|
||||||
|
10: Entry(title="Olympic Stadium", text="Historic venue", date="04/08/2025",
|
||||||
|
travel_diary_id=1, id=10, photos=[]),
|
||||||
|
}
|
||||||
|
self._next_id = 11
|
||||||
|
|
||||||
|
# Synchronous methods (kept for compatibility)
|
||||||
|
def create(self, travel_diary_id: int, title: str, text: str, date: str) -> Entry:
|
||||||
|
"""Synchronous version"""
|
||||||
|
new_entry = Entry(title, text, date, travel_diary_id, id=self._next_id)
|
||||||
|
self.mock_data[self._next_id] = new_entry
|
||||||
|
self._next_id += 1
|
||||||
|
return new_entry
|
||||||
|
|
||||||
|
def read_by_id(self, entry_id: int) -> Entry | None:
|
||||||
|
"""Synchronous version"""
|
||||||
|
return self.mock_data.get(entry_id)
|
||||||
|
|
||||||
|
def read_all(self) -> List[Entry]:
|
||||||
|
"""Synchronous version"""
|
||||||
|
return list(self.mock_data.values())
|
||||||
|
|
||||||
|
def read_by_travel_diary_id(self, travel_diary_id: int) -> List[Entry]:
|
||||||
|
"""Synchronous version - reads entries by diary"""
|
||||||
|
return [entry for entry in self.mock_data.values() if entry.fk_travel_diary_id == travel_diary_id]
|
||||||
|
|
||||||
|
def read_paginated(self, travel_diary_id: int, page: int = 1, page_size: int = 5) -> Tuple[List[Entry], int, int]:
|
||||||
|
"""Synchronous version - reads paginated entries by diary"""
|
||||||
|
entries = self.read_by_travel_diary_id(travel_diary_id)
|
||||||
|
entries.sort(key=lambda x: x.id, reverse=True) # Most recent first
|
||||||
|
|
||||||
|
total_entries = len(entries)
|
||||||
|
total_pages = (total_entries + page_size - 1) // page_size
|
||||||
|
|
||||||
|
start_index = (page - 1) * page_size
|
||||||
|
end_index = start_index + page_size
|
||||||
|
|
||||||
|
page_entries = entries[start_index:end_index]
|
||||||
|
|
||||||
|
return page_entries, total_pages, total_entries
|
||||||
|
|
||||||
|
def update(self, entry_src: Entry, entry_dst: Entry) -> Entry | None:
|
||||||
|
"""Synchronous version"""
|
||||||
|
item_to_update = self.mock_data.get(entry_src.id)
|
||||||
|
if item_to_update:
|
||||||
|
item_to_update.title = entry_dst.title if entry_dst.title is not None else item_to_update.title
|
||||||
|
item_to_update.text = entry_dst.text if entry_dst.text is not None else item_to_update.text
|
||||||
|
item_to_update.date = entry_dst.date if entry_dst.date is not None else item_to_update.date
|
||||||
|
item_to_update.fk_travel_diary_id = entry_dst.fk_travel_diary_id if (entry_dst.fk_travel_diary_id
|
||||||
|
is not None) else entry_dst.id
|
||||||
|
item_to_update.photos.extend(entry_dst.photos)
|
||||||
|
|
||||||
|
return item_to_update
|
||||||
|
return None
|
||||||
|
|
||||||
|
def delete(self, entry_src: Entry) -> Entry | None:
|
||||||
|
"""Synchronous version"""
|
||||||
|
return self.mock_data.pop(entry_src.id, None)
|
||||||
|
|
||||||
|
# Async methods (main)
|
||||||
|
async def async_create(self, travel_diary_id: int, title: str, text: str, date: str) -> Entry:
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.create(travel_diary_id, title, text, date)
|
||||||
|
|
||||||
|
async def async_read_by_id(self, entry_id: int) -> Entry | None:
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.read_by_id(entry_id)
|
||||||
|
|
||||||
|
async def async_read_all(self) -> List[Entry]:
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.read_all()
|
||||||
|
|
||||||
|
async def async_read_by_travel_diary_id(self, travel_diary_id: int) -> List[Entry]:
|
||||||
|
"""Async version - reads entries by diary"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.read_by_travel_diary_id(travel_diary_id)
|
||||||
|
|
||||||
|
async def async_read_paginated(self, travel_diary_id: int, page: int = 1, page_size: int = 5) -> Tuple[List[Entry], int, int]:
|
||||||
|
"""Async version - reads paginated entries by diary"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.read_paginated(travel_diary_id, page, page_size)
|
||||||
|
|
||||||
|
async def async_update(self, entry_src: Entry, entry_dst: Entry) -> Entry | None:
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.update(entry_src, entry_dst)
|
||||||
|
|
||||||
|
async def async_delete(self, entry_src: Entry) -> Entry | None:
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.delete(entry_src)
|
||||||
|
|
@ -0,0 +1,48 @@
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
from pilgrim.models.photo import Photo
|
||||||
|
from pilgrim.service.photo_service import PhotoService
|
||||||
|
|
||||||
|
|
||||||
|
class PhotoServiceMock(PhotoService):
|
||||||
|
def __init__(self):
|
||||||
|
super().__init__(None)
|
||||||
|
self.mock_data = {}
|
||||||
|
self._next_id = 1
|
||||||
|
|
||||||
|
def create(self, filepath: Path, name: str, travel_diary_id, addition_date=None, caption=None) -> Photo | None:
|
||||||
|
new_photo = Photo(
|
||||||
|
filepath=filepath,
|
||||||
|
name=name,
|
||||||
|
addition_date=addition_date,
|
||||||
|
caption=caption,
|
||||||
|
fk_travel_diary_id=travel_diary_id
|
||||||
|
)
|
||||||
|
new_photo.id = self._next_id
|
||||||
|
self.mock_data[self._next_id] = new_photo
|
||||||
|
self._next_id += 1
|
||||||
|
return new_photo
|
||||||
|
|
||||||
|
|
||||||
|
def read_by_id(self, photo_id: int) -> Photo:
|
||||||
|
return self.mock_data.get(photo_id)
|
||||||
|
|
||||||
|
def read_all(self) -> List[Photo]:
|
||||||
|
return list(self.mock_data.values())
|
||||||
|
|
||||||
|
def update(self, photo_src: Photo, photo_dst: Photo) -> Photo | None:
|
||||||
|
item_to_update: Photo = self.mock_data.get(photo_src.id)
|
||||||
|
if item_to_update:
|
||||||
|
item_to_update.filepath = photo_dst.filepath if photo_dst.filepath else item_to_update.filepath
|
||||||
|
item_to_update.name = photo_dst.name if photo_dst.name else item_to_update.name
|
||||||
|
item_to_update.caption = photo_dst.caption if photo_dst.caption else item_to_update.caption
|
||||||
|
item_to_update.addition_date = photo_dst.addition_date if photo_dst.addition_date else item_to_update.addition_date
|
||||||
|
item_to_update.fk_travel_diary_id = photo_dst.fk_travel_diary_id if photo_dst.fk_travel_diary_id else item_to_update.fk_travel_diary_id
|
||||||
|
if photo_dst.entries:
|
||||||
|
item_to_update.entries = photo_dst.entries
|
||||||
|
return item_to_update
|
||||||
|
return None
|
||||||
|
|
||||||
|
def delete(self, photo_src: Photo) -> Photo | None:
|
||||||
|
return self.mock_data.pop(photo_src.id, None)
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
from pilgrim.service.mocks.entry_service_mock import EntryServiceMock
|
||||||
|
from pilgrim.service.mocks.photo_service_mock import PhotoServiceMock
|
||||||
|
from pilgrim.service.mocks.travel_diary_service_mock import TravelDiaryServiceMock
|
||||||
|
from pilgrim.service.servicemanager import ServiceManager
|
||||||
|
|
||||||
|
|
||||||
|
class ServiceManagerMock(ServiceManager):
|
||||||
|
def __init__(self):
|
||||||
|
super().__init__()
|
||||||
|
# Cria instâncias únicas para manter estado consistente
|
||||||
|
self._travel_diary_service = TravelDiaryServiceMock()
|
||||||
|
self._entry_service = EntryServiceMock()
|
||||||
|
self._photo_service = PhotoServiceMock()
|
||||||
|
|
||||||
|
def get_entry_service(self):
|
||||||
|
return self._entry_service
|
||||||
|
|
||||||
|
def get_travel_diary_service(self):
|
||||||
|
return self._travel_diary_service
|
||||||
|
|
||||||
|
def get_photo_service(self):
|
||||||
|
return self._photo_service
|
||||||
|
|
@ -0,0 +1,67 @@
|
||||||
|
from pilgrim.service.travel_diary_service import TravelDiaryService
|
||||||
|
from pilgrim.models.travel_diary import TravelDiary
|
||||||
|
import asyncio
|
||||||
|
|
||||||
|
|
||||||
|
class TravelDiaryServiceMock(TravelDiaryService):
|
||||||
|
def __init__(self):
|
||||||
|
super().__init__(None)
|
||||||
|
self.mock_data = {
|
||||||
|
1: TravelDiary(id=1, name="Montreal"),
|
||||||
|
2: TravelDiary(id=2, name="Rio de Janeiro"),
|
||||||
|
}
|
||||||
|
self._next_id = 3
|
||||||
|
|
||||||
|
# Synchronous methods (original)
|
||||||
|
def create(self, name: str):
|
||||||
|
"""Synchronous version"""
|
||||||
|
new_travel_diary = TravelDiary(id=self._next_id, name=name)
|
||||||
|
self.mock_data[self._next_id] = new_travel_diary
|
||||||
|
self._next_id += 1
|
||||||
|
return new_travel_diary
|
||||||
|
|
||||||
|
def read_by_id(self, travel_id: int):
|
||||||
|
"""Synchronous version"""
|
||||||
|
return self.mock_data.get(travel_id)
|
||||||
|
|
||||||
|
def read_all(self):
|
||||||
|
"""Synchronous version"""
|
||||||
|
return list(self.mock_data.values())
|
||||||
|
|
||||||
|
def update(self, travel_diary_id: int, name: str):
|
||||||
|
"""Synchronous version"""
|
||||||
|
item_to_update = self.mock_data.get(travel_diary_id)
|
||||||
|
if item_to_update:
|
||||||
|
item_to_update.name = name
|
||||||
|
return item_to_update
|
||||||
|
return None
|
||||||
|
|
||||||
|
def delete(self, travel_diary_id: int):
|
||||||
|
"""Synchronous version"""
|
||||||
|
return self.mock_data.pop(travel_diary_id, None)
|
||||||
|
|
||||||
|
# Async methods (new)
|
||||||
|
async def async_create(self, name: str):
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.create(name)
|
||||||
|
|
||||||
|
async def async_read_by_id(self, travel_id: int):
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.read_by_id(travel_id)
|
||||||
|
|
||||||
|
async def async_read_all(self):
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.read_all()
|
||||||
|
|
||||||
|
async def async_update(self, travel_diary_id: int, name: str):
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.update(travel_diary_id, name)
|
||||||
|
|
||||||
|
async def async_delete(self, travel_diary_id: int):
|
||||||
|
"""Async version"""
|
||||||
|
await asyncio.sleep(0.01) # Simulates I/O
|
||||||
|
return self.delete(travel_diary_id)
|
||||||
Loading…
Reference in New Issue