Merge 4436d5e081 into 10135b9cdc

Staging

.github/workflows/pylint.yml

@@ -0,0 +1,24 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        pylint --disable=C0114,C0115,C0116 --exit-zero $(git ls-files '*.py')

.github/workflows/pylint_sonarqube.yml

@@ -1,63 +0,0 @@
-name: Pylint and SonarCloud
-on: 
-  push:
-    branches: [ main, master, staging ]
-  pull_request:
-    branches: [ main, master, staging ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.10"]
-    
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0  # Necessário para SonarCloud
-    
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-        pip install pylint ruff coverage pytest
-    
-    - name: Analysing the code with pylint (console output)
-      run: |
-        pylint --disable=C0114,C0115,C0116 --exit-zero $(git ls-files '*.py') || true
-    
-    - name: Generate Pylint report for SonarCloud
-      run: |
-        pylint --disable=C0114,C0115,C0116 --output-format=json --exit-zero $(git ls-files '*.py') > pylint-report.json || true
-    
-    - name: Run Ruff
-      run: |
-        ruff check --output-format=json . > ruff-report.json || true
-    
-    - name: Run tests with coverage (if you have tests)
-      run: |
-        if [ -d "tests" ] || [ -f "test_*.py" ] || [ -f "*_test.py" ]; then
-          coverage run -m pytest || true
-          coverage xml || true
-        else
-          echo "No tests found, skipping coverage"
-        fi
-    
-    - name: SonarCloud Scan
-      uses: SonarSource/sonarqube-scan-action@v5.0.0
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-      with:
-        args: >
-          -Dsonar.projectKey=gmbrax_Pilgrim
-          -Dsonar.organization=gmbrax
-          -Dsonar.python.pylint.reportPaths=pylint-report.json
-          -Dsonar.python.ruff.reportPaths=ruff-report.json
-          -Dsonar.python.coverage.reportPaths=coverage.xml

CHANGELOG.md

@@ -1,68 +1,51 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
-The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
 
-## Unreleased
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Planned
+## [Unreleased]
-* Installation Method 1 (repository compilation)
-* Organization of trips by date, location, or theme
-* Enhanced photo management features
-* Search functionality
-* Export features
-* Testing implementation
 
-## [0.0.4] - 2025-07-19
+### Planned
 
-### Added
+- Installation Method 1 (repository compilation)
-* Support for creating new diaries asynchronously, with an option to automatically open the newly created diary
+- Organization of trips by date, location, or theme
-* Unified "Enter" key support for saving or creating diaries across relevant modals
+- Enhanced photo management features
-* Automatic diary list refresh when returning to the diary screen
+- Search functionality
-* Application configuration management with a new centralized config system
+- Export features
-* Database location and initialization now configurable via the new config manager
+- Testing implementation
-* Automatic migration of database file to the configuration directory
-* Display of database URL on application startup for transparency
-* Duplicate photo detection before photo creation to prevent redundant entries
-* Photo hash indexing to improve photo lookup performance
-
-### Changed
-* Enhanced feedback and validation when editing or creating diary names
-* Streamlined and unified save logic for diary modals, reducing duplicated behavior
-* 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 layout and scrolling behavior improved for better usability
-* Photo hash generation now relies on existing service-provided hashes instead of local computation
-
-### Improved
-* Enhanced feedback and validation when editing or creating diary names
-* Streamlined and unified save logic for diary modals, reducing duplicated behavior
-* Sidebar layout and scrolling behavior for better usability
 
 ## [0.0.3] - 2025-07-07
 
 ### 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
 
 ### Changed
-* Changed the license in pyproject.toml to BSD
+- Changed the license in pyproject.toml to BSD
 
 ## [0.0.1] - 2025-07-06
 
 ### Added
-* Initial alpha release of Pilgrim travel diary application
+
-* Create and edit travel diaries
+- Initial alpha release of Pilgrim travel diary application
-* Create and edit diary entries
+- Create and edit travel diaries
-* Photo ingestion system
+- Create and edit diary entries
-* Photo addition and reference via sidebar
+- Photo ingestion system
-* Text User Interface (TUI) built with Textual framework
+- Photo addition and reference via sidebar
-* Pre-compiled binary installation method (Method 2)
+- Text User Interface (TUI) built with Textual framework
-* Support for Linux operating systems
+- Pre-compiled binary installation method (Method 2)
-* Basic project documentation (README)
+- Support for Linux operating systems
+- Basic project documentation (README)
 
 ### Known Issues
-* Installation Method 1 not yet implemented
+
-* No testing suite implemented yet
+- Installation Method 1 not yet implemented
-* Some features may be unstable in an alpha version
+- No testing suite implemented yet
+- Some features may be unstable in an alpha version
+
+[Unreleased]: https://github.com/username/pilgrim/compare/v0.0.1...HEAD
+
+[0.0.1]: https://github.com/username/pilgrim/releases/tag/v0.0.1

src/pilgrim/models/photo.py

@@ -4,7 +4,6 @@ from pathlib import Path
 
 from sqlalchemy import Column, Integer, String, ForeignKey, DateTime
 from sqlalchemy.orm import relationship
-from sqlalchemy.sql.schema import Index
 
 from pilgrim.models.photo_in_entry import photo_entry_association
 from ..database import Base
@@ -25,9 +24,6 @@ class Photo(Base):
     )
 
     fk_travel_diary_id = Column(Integer, ForeignKey("travel_diaries.id"),nullable=False)
-    __table_args__ = (
-        Index('idx_photo_hash_diary', 'hash', 'fk_travel_diary_id'),
-    )
 
     def __init__(self, filepath, name, photo_hash, addition_date=None, caption=None, entries=None, fk_travel_diary_id=None, **kw: Any):
         super().__init__(**kw)

src/pilgrim/service/photo_service.py

@@ -14,9 +14,8 @@ class PhotoService:
     def __init__(self, session):
         self.session = session
 
-    @staticmethod
+    def _hash_file(self, filepath: Path) -> str:
-    def hash_file(filepath: Path) -> str:
+        """Calculate hash of a file using SHA3-384."""
-        """Calculate the hash of a file using SHA3-384."""
         hash_func = hashlib.new('sha3_384')
         with open(filepath, 'rb') as f:
             while chunk := f.read(8192):
@@ -65,18 +64,10 @@ class PhotoService:
 
         return dest_path
 
-    def check_photo_by_hash(self, photohash:str, traveldiaryid:int):
-        photo = (self.session.query(Photo).filter(Photo.photo_hash == photohash,Photo.fk_travel_diary_id == traveldiaryid)
-                 .first())
-        return photo
-
     def create(self, filepath: Path, name: str, travel_diary_id: int, caption=None, addition_date=None) -> Photo | None:
         travel_diary = self.session.query(TravelDiary).filter(TravelDiary.id == travel_diary_id).first()
         if not travel_diary:
             return None
-        photo_hash = self.hash_file(filepath)
-        if self.check_photo_by_hash(photo_hash, travel_diary_id):
-            return None
 
         # Copy photo to diary's images directory
         copied_path = self._copy_photo_to_diary(filepath, travel_diary)
@@ -88,6 +79,8 @@ class PhotoService:
             except ValueError:
                 addition_date = None
 
+        # Calculate hash from the copied file
+        photo_hash = self._hash_file(copied_path)
         
         new_photo = Photo(
             filepath=str(copied_path),  # Store the path to the copied file
@@ -125,7 +118,7 @@ class PhotoService:
                         old_path.unlink()
                     original.filepath = str(new_path)
                     # Update hash based on the new copied file
-                    original.photo_hash = self.hash_file(new_path)
+                    original.photo_hash = self._hash_file(new_path)
             
             original.name = photo_dst.name
             original.addition_date = photo_dst.addition_date

src/pilgrim/ui/screens/edit_entry_screen.py

@@ -87,7 +87,7 @@ class EditEntryScreen(Screen):
         self.text_entry = TextArea(id="text_entry", classes="EditEntryScreen-text-entry")
 
         # Sidebar widgets
-        self.sidebar_title = Static("Photos", classes="EditEntryScreen-sidebar-title")
+        self.sidebar_title = Static("📸 Photos", classes="EditEntryScreen-sidebar-title")
         self.photo_list = OptionList(id="photo_list", classes="EditEntryScreen-sidebar-photo-list")
         self.photo_info = Static("", classes="EditEntryScreen-sidebar-photo-info")
         self.help_text = Static("", classes="EditEntryScreen-sidebar-help")
@@ -296,28 +296,30 @@ class EditEntryScreen(Screen):
 
             if not self.cached_photos:
                 self.photo_info.update("No photos found for this diary")
-                self.help_text.update("No photos available\n\nUse Photo Manager to add photos")
+                self.help_text.update("📸 No photos available\n\nUse Photo Manager to add photos")
                 return
 
             # Add photos to the list with hash
             for photo in self.cached_photos:
                 # Show name and hash in the list
                 photo_hash = str(photo.photo_hash)[:8]
-                self.photo_list.add_option(f"{photo.name} \\[{photo_hash}\]")
+                self.photo_list.add_option(f"📷 {photo.name} \\[{photo_hash}\]")
 
-            self.photo_info.update(f"{len(self.cached_photos)} photos in diary")
+            self.photo_info.update(f"📸 {len(self.cached_photos)} photos in diary")
 
             # Updated help a text with hash information
             help_text = (
-                "[b]Sidebar Shortcuts[/b]\n"
+                "[b]⌨️  Sidebar Shortcuts[/b]\n"
                 "[b][green]i[/green][/b]: Insert photo into entry\n"
                 "[b][green]n[/green][/b]: Add new photo\n"
                 "[b][green]d[/green][/b]: Delete selected photo\n"
                 "[b][green]e[/green][/b]: Edit selected photo\n"
                 "[b][yellow]Tab[/yellow][/b]: Back to editor\n"
                 "[b][yellow]F8[/yellow][/b]: Show/hide sidebar\n"
+                "[b][yellow]F9[/yellow][/b]: Switch focus (if needed)\n\n"
                 "[b]📝 Photo References[/b]\n"
-                "\\[\\[photo::hash\\]\\]"
+                "Use: \\[\\[photo:name:hash\\]\\]\n"
+                "Or: \\[\\[photo::hash\\]\\]"
             )
             self.help_text.update(help_text)
         except Exception as e:
@@ -427,7 +429,9 @@ class EditEntryScreen(Screen):
         photo_details += f"🔗 {photo_hash}\n"
         photo_details += f"📅 {selected_photo.addition_date}\n"
         photo_details += f"💬 {selected_photo.caption or 'No caption'}\n"
+        photo_details += f"📁 {selected_photo.filepath}\n\n"
         photo_details += f"[b]Reference formats:[/b]\n"
+        photo_details += f"\\[\\[photo:{selected_photo.name}:{photo_hash}\\]\\]\n"
         photo_details += f"\\[\\[photo::{photo_hash}\\]\\]"
 
         self.photo_info.update(photo_details)
@@ -611,8 +615,7 @@ class EditEntryScreen(Screen):
                 addition_date=original_photo.addition_date,
                 caption=photo_data["caption"],
                 entries=original_photo.entries if original_photo.entries is not None else [],
-                id=original_photo.id,
+                id=original_photo.id
-                photo_hash=original_photo.photo_hash,
             )
 
             result = photo_service.update(original_photo, updated_photo)
@@ -739,15 +742,15 @@ class EditEntryScreen(Screen):
         self.notify(f"Selected photo: {selected_photo.name} \\[{photo_hash}\\]")
 
         # Update photo info with details including hash
-        photo_details = f"Name: {selected_photo.name}\n"
+        photo_details = f"📷 {selected_photo.name}\n"
-        photo_details += f"Hash: {photo_hash}\n"
+        photo_details += f"🔗 {photo_hash}\n"
-        photo_details += f"Date: {selected_photo.addition_date}\n"
+        photo_details += f"📅 {selected_photo.addition_date}\n"
         if selected_photo.caption:
-            photo_details += f"Caption: {selected_photo.caption}\n"
+            photo_details += f"💬 {selected_photo.caption}\n"
-        else:
+        photo_details += f"📁 {selected_photo.filepath}\n\n"
-            photo_details += f"Caption: No Caption\n"
         photo_details += f"[b]Reference formats:[/b]\n"
-        photo_details += f"\\[\\[photo::{photo_hash}]]"
+        photo_details += f"\\[\\[photo:{selected_photo.name}:{photo_hash}\\]\\]\n"
+        photo_details += f"\\[\\[photo::{photo_hash}\\]\\]"
 
         self.photo_info.update(photo_details)
 

src/pilgrim/ui/screens/modals/add_photo_modal.py

@@ -15,6 +15,12 @@ class AddPhotoModal(Screen):
         self.result = None
         self.created_photo = None
 
+    def _generate_photo_hash(self, photo_data: dict) -> str:
+        """Generate a short, unique hash for a photo"""
+        # Use temporary data for hash generation
+        unique_string = f"{photo_data['name']}_{photo_data.get('photo_id', 0)}_new"
+        hash_object = hashlib.md5(unique_string.encode())
+        return hash_object.hexdigest()[:8]
 
     def compose(self) -> ComposeResult:
         yield Container(
@@ -63,16 +69,10 @@ class AddPhotoModal(Screen):
 
     async def _async_create_photo(self, photo_data: dict):
         """Creates a new photo asynchronously using PhotoService"""
-
-
         try:
             service_manager = self.app.service_manager
             photo_service = service_manager.get_photo_service()
 
-            if photo_service.check_photo_by_hash(photo_service.hash_file(photo_data["filepath"]),self.diary_id):
-                self.notify("Photo already exists in database", severity="error")
-                return
-
             new_photo = photo_service.create(
                 filepath=Path(photo_data["filepath"]),
                 name=photo_data["name"],
@@ -82,9 +82,13 @@ class AddPhotoModal(Screen):
 
             if new_photo:
                 self.created_photo = new_photo
+                # Generate hash for the new photo
+                photo_hash = self._generate_photo_hash({
+                    "name": new_photo.name,
+                    "photo_id": new_photo.id
+                })
                 
-                
+                self.notify(f"Photo '{new_photo.name}' added successfully!\nHash: {photo_hash}\nReference: \\[\\[photo:{new_photo.name}:{photo_hash}\\]\\]", 
-                self.notify(f"Photo '{new_photo.name}' added successfully!\nHash: {new_photo.photo_hash[:8]}\nReference: \\[\\[photo:{new_photo.name}:{new_photo.photo_hash[:8]}\\]\\]",
                            severity="information", timeout=5)
                 
                 # Return the created photo data to the calling screen
@@ -93,7 +97,7 @@ class AddPhotoModal(Screen):
                     "name": photo_data["name"],
                     "caption": photo_data["caption"],
                     "photo_id": new_photo.id,
-                    "hash": new_photo.photo_hash
+                    "hash": photo_hash
                 }
                 self.dismiss(self.result)
             else:

src/pilgrim/ui/screens/modals/edit_photo_modal.py

@@ -3,7 +3,7 @@ from textual.screen import Screen
 from textual.widgets import Static, Input, Button
 from textual.containers import Container, Horizontal
 from pilgrim.models.photo import Photo
-
+import hashlib
 
 class EditPhotoModal(Screen):
     """Modal for editing an existing photo (name and caption only)"""
@@ -12,11 +12,15 @@ class EditPhotoModal(Screen):
         self.photo = photo
         self.result = None
 
-
+    def _generate_photo_hash(self, photo: Photo) -> str:
+        """Generate a short, unique hash for a photo"""
+        unique_string = f"{photo.name}_{photo.id}_{photo.addition_date}"
+        hash_object = hashlib.md5(unique_string.encode())
+        return hash_object.hexdigest()[:8]
 
     def compose(self) -> ComposeResult:
         # Generate hash for this photo
-
+        photo_hash = self._generate_photo_hash(self.photo)
         
         yield Container(
             Static("✏️ Edit Photo", classes="EditPhotoModal-Title"),
@@ -41,9 +45,10 @@ class EditPhotoModal(Screen):
                 id="caption-input", 
                 classes="EditPhotoModal-Input"
             ),
-            Static(f"🔗 Photo Hash: {self.photo.photo_hash[:8]}", classes="EditPhotoModal-Hash"),
+            Static(f"🔗 Photo Hash: {photo_hash}", classes="EditPhotoModal-Hash"),
             Static("Reference formats:", classes="EditPhotoModal-Label"),
-            Static(f"\\[\\[photo::{self.photo.photo_hash[:8]}\\]\\]", classes="EditPhotoModal-Reference"),
+            Static(f"\\[\\[photo:{self.photo.name}:{photo_hash}\\]\\]", classes="EditPhotoModal-Reference"),
+            Static(f"\\[\\[photo::{photo_hash}\\]\\]", classes="EditPhotoModal-Reference"),
             Horizontal(
                 Button("Save Changes", id="save-button", classes="EditPhotoModal-Button"),
                 Button("Cancel", id="cancel-button", classes="EditPhotoModal-Button"),

src/pilgrim/ui/styles/pilgrim.css

@@ -389,10 +389,22 @@ Screen.-modal {
     width: 1fr;
 }
 
-.EditEntryScreen-sidebar{
+.EditEntryScreen-sidebar {
-    background: $primary-darken-1;
+    width: 40;
-    width: 45%;
+    min-height: 10;
+    border-left: solid green;
+    padding: 1;
+    background: $surface-darken-2;
+    color: $primary;
+    text-style: bold;
+    content-align: left top;
 }
+
+.EditEntryScreen-content-container {
+    layout: horizontal;
+    height: 1fr;
+}
+
 .EditEntryScreen-sidebar-title {
     text-align: center;
     text-style: bold;
@@ -405,39 +417,30 @@ Screen.-modal {
 .EditEntryScreen-sidebar-content {
     height: 1fr;
     layout: vertical;
-    margin-left: 1;
-    margin-right: 1;
-
 }
 
 .EditEntryScreen-sidebar-photo-list {
-    height: 2fr; /* Pega o espaço restante disponível */
+    height: 1fr;
-    min-height: 5; /* Garante altura mínima para não sumir */
     border: solid $accent;
     margin-bottom: 1;
-    overflow-y: auto; /* Adiciona scroll vertical se necessário */
 }
 
 .EditEntryScreen-sidebar-photo-info {
-    height: 1fr;
+    height: auto;
-    max-height: 15; /* Limita altura máxima */
+    min-height: 3;
-    min-height: 13;
-    padding: 1;
     border: solid $warning;
+    padding: 1;
     margin-bottom: 1;
     background: $surface-darken-1;
-    overflow-y: auto; /* Adiciona scroll se exceder max-height */
 }
 
 .EditEntryScreen-sidebar-help {
-    height: 1fr;
+    height: auto;
-    max-height: 10; /* Altura máxima menor que info */
+    min-height: 8;
-    min-height: 8; /* Altura mínima menor */
     border: solid $success;
     padding: 1;
     background: $surface-darken-1;
     text-style: italic;
-    overflow-y: auto; /* Adiciona scroll se exceder max-height */
 }
 
 /* Photo Modal Styles */

src/pilgrim/utils/config_manager.py

@@ -34,11 +34,11 @@ class ConfigManager(metaclass=SingletonMeta):
             try:
                 with open(f"{DirectoryManager.get_config_directory()}/config.toml", "rb") as f:
                     data = tomli.load(f)
-
+                print(data)
+            except FileNotFoundError:
+                print("Error: config.toml not found.")
             except tomli.TOMLDecodeError as e:
-                raise ValueError(f"Invalid TOML configuration: {e}")
+                print(f"Error decoding TOML: {e}")
-            except Exception as e:
-                raise RuntimeError(f"Error reading configuration: {e}")
 
             self.__data = data
             self.database_url = self.__data["database"]["url"]
@@ -77,22 +77,17 @@ class ConfigManager(metaclass=SingletonMeta):
             with open(f"{config_dir}/config.toml", "wb") as f:
                 tomli_w.dump(config, f)
         except Exception as e:
-            raise RuntimeError(f"Error creating configuration: {e}")
+            print(f"Erro ao criar config: {e}")
 
     def save_config(self):
         if self.__data is None:
             self.read_config()
-        if self.__data is None:
-            raise RuntimeError("Error reading configuration.")
-
         self.__data["database"]["url"] = self.database_url
         self.__data["database"]["type"] = self.database_type
         self.__data["settings"]["diary"]["auto_open_diary_on_startup"] = self.auto_open_diary or ""
         self.__data["settings"]["diary"]["auto_open_on_creation"] = self.auto_open_new_diary
-        try:
+
         self.create_config(self.__data)
-        except Exception as e:
-            raise RuntimeError(f"Error saving configuration: {e}")
 
     def set_config_dir(self, value):
         self.config_dir = value

tests/test_database.py

@@ -1,40 +0,0 @@
-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()
-
-
-