Merge b14d775d87 into 8f36e5a770

Bump typing-extensions from 4.14.0 to 4.14.1

.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

pyproject.toml

@@ -1,31 +1,36 @@
-[build-system]
+    [build-system]
-requires = ["hatchling"]
+    requires = ["hatchling"]
-build-backend = "hatchling.build"
+    build-backend = "hatchling.build"
 
-[project]
-name = "pilgrim"
-version = "0.0.4"
-authors = [
-  { name="Gustavo Henrique Santos Souza de Miranda", email="gustavohssmiranda@gmail.com" }
-]
-description = "Pilgrim's Travel Log"
-readme = "README.md"
-requires-python = ">=3.10"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: BSD License",
-    "Operating System :: OS Independent",
-]
-dependencies = [
-    "sqlalchemy",
-    "textual",
-    "tomli",
-    "tomli_w"
-]
 
-[project.urls]
+    [project]
-Homepage = "https://github.com/gmbrax/Pilgrim/"
+    name = "Pilgrim"
-Issues = "https://github.com/gmbrax/Pilgrim/issues"
+    version = "0.0.4"
+    authors = [
+      { name="Gustavo Henrique Santos Souza de Miranda", email="gustavohssmiranda@gmail.com" }
+    ]
+    description = "Pilgrim's Travel Log"
+    readme = "README.md"
+    requires-python = ">=3.10"
+    classifiers = [
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: BSD License",
+        "Operating System :: OS Independent",
+    ]
+    dependencies = [
+      "sqlalchemy",
+        "textual",
+        "tomli",
+        "tomli_w"
 
-[project.scripts]
+
-pilgrim = "pilgrim.command:main"
+    ]
+    [template.plugins.default]
+    src-layout = true
+    [project.urls]
+    Homepage = "https://github.com/gmbrax/Pilgrim/"
+    Issues = "https://github.com/gmbrax/Pilgrim/issues"
+    [tool.hatch.build.targets.wheel]
+    packages = ["src/pilgrim"]
+    [project.scripts]
+    pilgrim = "pilgrim:main"

src/pilgrim/database.py

@@ -1,5 +1,5 @@
 from sqlalchemy import create_engine
-from sqlalchemy.orm import declarative_base
+from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import sessionmaker
 from pathlib import Path
 import os

src/pilgrim/models/entry.py

@@ -4,16 +4,15 @@ from pilgrim.models.photo_in_entry import photo_entry_association
 from sqlalchemy import Column, Integer, String, ForeignKey, DateTime
 from sqlalchemy.orm import relationship
 
-from pilgrim.database import Base
+from ..database import Base
-
 
 
 class Entry(Base):
     __tablename__ = "entries"
     id = Column(Integer, primary_key=True)
-    title = Column(String,nullable=False)
+    title = Column(String)
     text = Column(String)
-    date = Column(DateTime,nullable=False)
+    date = Column(DateTime)
     photos = relationship(
         "Photo",
         secondary=photo_entry_association,

src/pilgrim/models/photo.py

@@ -4,11 +4,9 @@ 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 pilgrim.database import Base
+from ..database import Base
-
 
 
 class Photo(Base):
@@ -26,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/models/photo_in_entry.py

@@ -1,6 +1,6 @@
 from sqlalchemy import Table, Column, Integer, ForeignKey
 
-from pilgrim.database import Base
+from ..database import Base
 
 photo_entry_association = Table('photo_entry_association', Base.metadata,
 Column('id', Integer, primary_key=True, autoincrement=True),

src/pilgrim/models/travel_diary.py

@@ -3,11 +3,10 @@ from typing import Any
 from sqlalchemy import Column, Integer, String, UniqueConstraint
 from sqlalchemy.orm import relationship
 
-from pilgrim.database import Base
+from .. import database
 
 
-
+class TravelDiary(database.Base):
-class TravelDiary(Base):
     __tablename__ = "travel_diaries"
     id = Column(Integer, primary_key=True)
     name = Column(String, nullable=False)

src/pilgrim/service/entry_service.py

@@ -1,9 +1,9 @@
 from datetime import datetime
 from typing import List
 
-from pilgrim.models.entry import Entry
+from ..models.entry import Entry
-from pilgrim.models.travel_diary import TravelDiary
+from ..models.travel_diary import TravelDiary
-from pilgrim.models.photo import Photo  # ✨ Importe o modelo Photo
+from ..models.photo import Photo  # ✨ Importe o modelo Photo
 
 
 class EntryService:

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/service/travel_diary_service.py

@@ -6,7 +6,7 @@ from pathlib import Path
 from pilgrim.utils import DirectoryManager
 from sqlalchemy.exc import IntegrityError
 
-from pilgrim.models.travel_diary import TravelDiary
+from ..models.travel_diary import TravelDiary
 
 
 class TravelDiaryService:

src/pilgrim/ui/screens/edit_entry_screen.py

@@ -611,8 +611,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)

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"),