Compare commits

..
Author SHA1 Message Date
Gustavo Henrique Santos Souza de Miranda 8bd03bcaca Add the tests to the command file 2025-07-21 19:36:37 -03:00
Gustavo Henrique Miranda 0ab1e38726 Merge pull request #74 from gmbrax/test/photoservice-unit-tests
Add the tests for the update on photo service
2025-07-21 19:01:23 -03:00
Gustavo Henrique Santos Souza de Miranda 668e2825d9 Add the tests for the update on photo service 2025-07-21 18:55:28 -03:00
Gustavo Henrique Miranda 5c50cad207 Merge pull request #73 from gmbrax/test/directory-manager-unit-tests
Add the tests for the directory manager
2025-07-21 18:07:18 -03:00
Gustavo Henrique Miranda 3212607f70 Merge pull request #72 from gmbrax/test/config-manager-unit-tests
Add the tests for the config manager
2025-07-21 18:07:01 -03:00
Gustavo Henrique Miranda eafd9b9522 Merge pull request #71 from gmbrax/test/service-manager-unit-tests
Add the tests for the service manager
2025-07-21 18:06:36 -03:00
Gustavo Henrique Miranda 3e644a415f Merge pull request #70 from gmbrax/test/photoservice-unit-tests
Test/photoservice unit tests
2025-07-21 18:05:52 -03:00
Gustavo Henrique Santos Souza de Miranda 27ff615d4a Add the tests for the directory manager 2025-07-21 18:03:01 -03:00
Gustavo Henrique Santos Souza de Miranda ec0c8a6f71 Add the tests for the config manager 2025-07-21 17:43:39 -03:00
Gustavo Henrique Santos Souza de Miranda bf64255fe2 Add the tests for the service manager 2025-07-21 16:58:27 -03:00
Gustavo Henrique Santos Souza de Miranda 32f363f15a Add the tests for the delete photo service and also fixed the missing import 2025-07-21 16:48:09 -03:00
Gustavo Henrique Santos Souza de Miranda 65cf7b04f3 Merge remote-tracking branch 'origin/test/photoservice-unit-tests' into test/photoservice-unit-tests
# Conflicts:
#	tests/conftest.py
#	tests/service/test_photo_service.py
2025-07-21 16:31:59 -03:00
Gustavo Henrique Santos Souza de Miranda 44824cd690 Add the tests for the update photo service and also improved the fixture 2025-07-21 16:30:54 -03:00
Gustavo Henrique Santos Souza de Miranda 32b1c24846 Add the tests for the read methods for the photo service 2025-07-21 16:19:10 -03:00
Gustavo Henrique Santos Souza de Miranda 5d0d4fc5ac Add the tests for the hash methods and the create methods 2025-07-21 16:19:09 -03:00
Gustavo Henrique Miranda 9d0bc50350 Merge pull request #69 from gmbrax/fix/traveldiary-model-back-relantioship
Fix the photo and travel diary relationship to properly work
2025-07-21 15:44:24 -03:00
Gustavo Henrique Santos Souza de Miranda 83e7db9ce1 Fix the photo and travel diary relationship to properly work 2025-07-21 15:27:51 -03:00
Gustavo Henrique Santos Souza de Miranda 5f20bd3624 Add the tests for the read methods for the photo service 2025-07-21 02:48:04 -03:00
Gustavo Henrique Santos Souza de Miranda 2f81e4ff06 Add the tests for the hash methods and the create methods 2025-07-21 02:28:04 -03:00
Gustavo Henrique Miranda d840299398 Merge pull request #68 from gmbrax/test/database-unit-test
Change the import to avoid importing by the folder
2025-07-21 01:23:10 -03:00
Gustavo Henrique Santos Souza de Miranda ca0b8c554c Change the import to avoid importing by the folder 2025-07-21 01:22:05 -03:00
Gustavo Henrique Miranda ed2dbee1a3 Merge pull request #67 from gmbrax/test/traveldiaryservice-unit-test
Test/traveldiaryservice unit test
2025-07-21 01:18:08 -03:00
Gustavo Henrique Miranda 6e17064ce6 Merge pull request #66 from gmbrax/test/entryservice-unit-test
Test/entryservice unit test
2025-07-21 01:08:46 -03:00
Gustavo Henrique Santos Souza de Miranda a18c621d5c Add the tests for delete the entries method 2025-07-21 01:07:11 -03:00
Gustavo Henrique Miranda 998fa3ce2f Merge pull request #65 from gmbrax/test/database-unit-test
Create the test for the database class
2025-07-21 00:58:04 -03:00
Gustavo Henrique Santos Souza de Miranda 66879b5a7d Add the tests for update the entries method 2025-07-21 00:53:04 -03:00
Gustavo Henrique Santos Souza de Miranda 240e4ae6c7 fix the sanitization directory method to remove accents and diacritics 2025-07-21 00:53:04 -03:00
Gustavo Henrique Santos Souza de Miranda df9101ccac Add unidecode dependency on pyproject.toml 2025-07-21 00:53:04 -03:00
Gustavo Henrique Miranda 2454f929c9 Merge pull request #64 from gmbrax/fix/sanitize-accent-bug
Fix/sanitize accent bug
2025-07-21 00:23:35 -03:00
Gustavo Henrique Santos Souza de Miranda 736c0f160f fix the sanitization directory method to remove accents and diacritics 2025-07-21 00:14:17 -03:00
Gustavo Henrique Santos Souza de Miranda de27485c98 Add unidecode dependency on pyproject.toml 2025-07-21 00:13:26 -03:00
Gustavo Henrique Santos Souza de Miranda 152bff85e5 Add the read entries unit tests 2025-07-20 23:53:53 -03:00
Gustavo Henrique Santos Souza de Miranda f374285e2a Add the fixture for the read entry tests 2025-07-20 23:52:45 -03:00
Gustavo Henrique Santos Souza de Miranda b020f8500b Add The tests for the filename sanitization function and the create travel diary 2025-07-20 23:38:36 -03:00
Gustavo Henrique Santos Souza de Miranda cc95ce669f Merge remote-tracking branch 'origin/test/entryservice-unit-test' into test/entryservice-unit-test
# Conflicts:
#	tests/service/test_entry_service.py
2025-07-20 23:16:48 -03:00
Gustavo Henrique Santos Souza de Miranda d36ff829db Remove the shared fixtures that are available on conftest.py 2025-07-20 23:15:08 -03:00
Gustavo Henrique Santos Souza de Miranda 0173465943 Add all tests to test the delete of entries 2025-07-20 23:13:46 -03:00
Gustavo Henrique Santos Souza de Miranda 5b9a5bfe24 Add all tests to test the read of entries 2025-07-20 23:13:46 -03:00
Gustavo Henrique Santos Souza de Miranda 95a3a13ee2 Add all tests to test the update of entries 2025-07-20 23:13:46 -03:00
Gustavo Henrique Santos Souza de Miranda f9fb660d7c Add a test to test the creation of entries with null on nullable fields 2025-07-20 23:13:45 -03:00
Gustavo Henrique Santos Souza de Miranda f7a7289b5e test(entry_service): add test for creating an entry without photos
This commit adds a unit test to ensure that the EntryService's
`create` method correctly handles cases where an empty list of photos
is provided.

It verifies that the entry is created successfully and that the
`photos` relationship is an empty list, confirming the feature's
flexibility.
2025-07-20 23:13:45 -03:00
Gustavo Henrique Santos Souza de Miranda 0227879bb3 test(entry_service): add a failure case test for create method
This commit adds a unit test for an important "unhappy path" in the
EntryService's `create` method.

It specifically verifies that the method gracefully returns `None`
when provided with a `travel_diary_id` that does not exist in the
database, ensuring the initial guard clause works as expected.
2025-07-20 23:13:45 -03:00
Gustavo Henrique Santos Souza de Miranda e46f02cc39 test(entry_service): add unit test for creating a new entry
This commit introduces the first unit test for the EntryService,
covering the "happy path" for the `create` method.

It verifies that a new entry is correctly persisted to the database,
including its relationship with associated Photo objects. The test
leverages fixtures to create an isolated, in-memory database
populated with the necessary dependencies.
2025-07-20 23:13:45 -03:00
Gustavo Henrique Miranda e9162ab25c Merge pull request #63 from gmbrax/refactor/shared-test-fixtures
Refactor to add conftest.py to share fixtures
2025-07-20 23:12:32 -03:00
Gustavo Henrique Santos Souza de Miranda 88a0b9cf80 Refactor to add conftest.py to share fixtures 2025-07-20 23:07:04 -03:00
Gustavo Henrique Santos Souza de Miranda 1629b9d52c Add all tests to test the delete of entries 2025-07-20 22:38:55 -03:00
Gustavo Henrique Santos Souza de Miranda 790a9ea3f0 Add all tests to test the read of entries 2025-07-20 22:26:40 -03:00
Gustavo Henrique Santos Souza de Miranda cec1827635 Add all tests to test the update of entries 2025-07-20 22:12:09 -03:00
Gustavo Henrique Santos Souza de Miranda 1c8026620c Add a test to test the creation of entries with null on nullable fields 2025-07-20 20:47:12 -03:00
Gustavo Henrique Santos Souza de Miranda fcbf465c43 Merge branch 'staging' into test/entryservice-unit-test 2025-07-20 18:08:11 -03:00
Gustavo Henrique Miranda 4dda85d8a3 Merge pull request #62 from gmbrax/fix/model-entry-nullable-fields
fix the entry model to not allow the title nor the date to be null
2025-07-20 17:53:27 -03:00
Gustavo Henrique Santos Souza de Miranda 5a28afc540 fix the entry model to not allow the title nor the date to be null 2025-07-20 17:34:57 -03:00
Gustavo Henrique Santos Souza de Miranda 77e191f480 test(entry_service): add test for creating an entry without photos
This commit adds a unit test to ensure that the EntryService's
`create` method correctly handles cases where an empty list of photos
is provided.

It verifies that the entry is created successfully and that the
`photos` relationship is an empty list, confirming the feature's
flexibility.
2025-07-20 16:03:45 -03:00
Gustavo Henrique Santos Souza de Miranda 3c7925cb1c test(entry_service): add a failure case test for create method
This commit adds a unit test for an important "unhappy path" in the
EntryService's `create` method.

It specifically verifies that the method gracefully returns `None`
when provided with a `travel_diary_id` that does not exist in the
database, ensuring the initial guard clause works as expected.
2025-07-20 15:21:49 -03:00
Gustavo Henrique Santos Souza de Miranda c4dceda942 test(entry_service): add unit test for creating a new entry
This commit introduces the first unit test for the EntryService,
covering the "happy path" for the `create` method.

It verifies that a new entry is correctly persisted to the database,
including its relationship with associated Photo objects. The test
leverages fixtures to create an isolated, in-memory database
populated with the necessary dependencies.
2025-07-20 03:35:22 -03:00
Gustavo Henrique Miranda 4d87ae1b90 Merge pull request #61 from gmbrax/fix/relative-imports
Fix/relative imports
2025-07-20 03:27:31 -03:00
Gustavo Henrique Mirandaandcoderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> e1add84537 Update src/pilgrim/database.py
Remove Debug message

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2025-07-20 03:23:37 -03:00
Gustavo Henrique Santos Souza de Miranda 2ba1cbd0a6 Fix the declarative_base import to the newer way 2025-07-20 03:10:13 -03:00
Gustavo Henrique Santos Souza de Miranda eed16f34c1 Simplify the pyproject.toml 2025-07-20 02:47:05 -03:00
Gustavo Henrique Santos Souza de Miranda 06ee08b201 Fix all imports to be absolute and not relative 2025-07-20 02:46:46 -03:00
Gustavo Henrique Santos Souza de Miranda 8119ae74f6 Create the test for the database class 2025-07-20 01:50:12 -03:00
Gustavo Henrique Miranda 78e45e26fd Update pylint_sonarqube.yml
Fix the ruff error on the sonarcloud scan
2025-07-19 19:06:53 -03:00
Gustavo Henrique Miranda cc68bbcf2e Update pylint_sonarqube.yml
Add the missing parameters for SonarQube
2025-07-19 18:56:19 -03:00
Gustavo Henrique Miranda 9a698596b1 Update and rename pylint.yml to pylint_sonarqube.yml
Add RUFF and SonarQube scanning
2025-07-19 18:52:53 -03:00
Gustavo Henrique Miranda 0cbcbd3a8d Update CHANGELOG.md
Revert the markdown format missing from the last update
2025-07-19 17:40:01 -03:00
Gustavo Henrique Miranda a1e718c1fc Update CHANGELOG.md
Added info for the next alpha version 0.0.4
2025-07-19 17:34:05 -03:00
Gustavo Henrique Miranda 8919e158bc Merge pull request #60 from gmbrax/fix/Importing-duplicate-images
Fix the bug that collides the hash if identical images
2025-07-19 03:23:54 -03:00
Gustavo Henrique Santos Souza de Miranda 9e4b08234f Fix the bug that collides the hash if identical images 2025-07-19 00:16:29 -03:00
Gustavo Henrique Miranda 44ff390695 Merge pull request #59 from gmbrax/fix/remove-stale-hashing-methods
Refactor the edit and add photo modal and remove the hashing methods out of the modals
2025-07-18 02:41:29 -03:00
Gustavo Henrique Santos Souza de Miranda ca53ac7778 Remove the unused import and unused variable 2025-07-18 02:37:07 -03:00
Gustavo Henrique Santos Souza de Miranda 0567495ff9 Refactor the edit and add photo modal and remove the hashing methods out of the modals 2025-07-18 02:27:16 -03:00
Gustavo Henrique Miranda 18ff157eb7 Merge pull request #58 from gmbrax/fix/edit-photo-not-working
Fix the photo edit to properly pass the original photo hash that was missing
2025-07-18 01:39:13 -03:00
Gustavo Henrique Santos Souza de Miranda a9d39f415a Fix the photo edit to properly pass the original photo hash that was missing 2025-07-18 00:03:13 -03:00
Gustavo Henrique Miranda b14d775d87 Merge pull request #56 from gmbrax/fix/sidebar-layout
Improve the CSS and the code for the photo sidebar
2025-07-17 21:43:31 -03:00
Gustavo Henrique Santos Souza de Miranda 1d08f4e40d Change the CSS to better distribute the elements of the sidebar 2025-07-17 21:39:05 -03:00
Gustavo Henrique Santos Souza de Miranda 165bc10a63 Change the CSS to fit the text better and also limited the width of the sidebar 2025-07-17 20:48:59 -03:00
Gustavo Henrique Santos Souza de Miranda 71d5491233 Improve the CSS and the code for the photo sidebar 2025-07-17 20:32:54 -03:00
Gustavo Henrique Miranda a59af26c9d Merge pull request #55 from gmbrax/feat/use-a-toml-for-config
Feat/use a toml for config
2025-07-16 22:50:30 -03:00
Gustavo Henrique Santos Souza de Miranda 23ef60b55a Improve exception handling, remove debug print statements 2025-07-16 18:28:42 -03:00
Gustavo Henrique Mirandaandcoderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> 4436d5e081 Update src/pilgrim/utils/directory_manager.py
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2025-07-16 18:12:32 -03:00
Gustavo Henrique Santos Souza de Miranda a13c56a3a3 Fix the NewDiaryModal not accessing the toml file properly to set the auto_open flag 2025-07-16 17:24:45 -03:00
Gustavo Henrique Santos Souza de Miranda 967c7e4ce6 Fix the Database no being put on the right path according with the config.toml 2025-07-16 16:39:31 -03:00
Gustavo Henrique Santos Souza de Miranda bdaa37e355 Add the database file path now is read by the configuration file 2025-07-16 16:01:34 -03:00
Gustavo Henrique Santos Souza de Miranda a540347127 Add Tomli_w library to pyproject.toml 2025-07-16 15:31:19 -03:00
Gustavo Henrique Santos Souza de Miranda fe35cb93bd Move get_database_path from database.py to directory_manager.py 2025-07-16 15:30:47 -03:00
Gustavo Henrique Santos Souza de Miranda 3843be6e13 Add the tomli library and create the config_manager.py to manage the configuration file and also add the dependency injection on the ui.py via the Application class 2025-07-16 02:55:52 -03:00
Gustavo Henrique Miranda 0adb230dd7 Merge pull request #52 from gmbrax/fix/move-create-diary-to-modal
Change to call the method in the super class on the _on_screen_resume  method
2025-07-16 01:30:35 -03:00
Gustavo Henrique Santos Souza de Miranda 167c2d8928 Change to call the method in the super class on the _on_screen_resume method 2025-07-16 00:50:07 -03:00
Gustavo Henrique Miranda 5b0f894c88 Merge pull request #50 from gmbrax/fix/bump-version
Bump the version to 0.0.4 on about_screen.py and pyproject.toml
2025-07-16 00:42:42 -03:00
Gustavo Henrique Santos Souza de Miranda 2b851fc7c7 Add the use of importlib.metadata.version to keep the version string in sync with the pyproject.toml 2025-07-16 00:39:28 -03:00
Gustavo Henrique Santos Souza de Miranda a3123fe322 Bump the version to 0.0.4 on about_screen.py and pyproject.toml 2025-07-16 00:25:37 -03:00
Gustavo Henrique Miranda 1beeb39b95 Merge pull request #47 from gmbrax/fix/move-create-diary-to-modal
Fix/move create diary to modal
2025-07-15 18:14:09 -03:00
Gustavo Henrique Miranda 4f153c5a5b Merge branch 'development' into fix/move-create-diary-to-modal 2025-07-15 17:25:06 -03:00
Gustavo Henrique Santos Souza de Miranda f838a5b421 Add the auto-open option to the new_diary_modal.py 2025-07-15 15:51:30 -03:00
Gustavo Henrique Santos Souza de Miranda 18760e174c Add a functionality that automatically opens the diary after creation, Change the responsibility of diary creation to the new_diary_modal.py instead of the diary_list_screen.py 2025-07-15 02:14:53 -03:00
Gustavo Henrique Miranda 3bef353939 Merge pull request #42
Fixed the edit diary modal to accept the key "enter" and automatically the function
2025-07-14 18:24:14 -03:00
Gustavo Henrique Miranda a80ecc24f5 Merge pull request #43
Fixed the new diary modal to accept the key "enter" and automatically the function
2025-07-14 18:23:58 -03:00
Gustavo Henrique Miranda 7f193d0fbb Merge pull request #44 from gmbrax/dependabot/pip/textual-approx-eq-4.0.0
origin/dependabot/pip/textual-approx-eq-4.0.0
2025-07-14 18:17:49 -03:00
Gustavo Henrique Miranda 7dfeec20f1 Merge pull request #45 from gmbrax/dependabot/pip/typing-extensions-4.14.1
origin/dependabot/pip/typing-extensions-4.14.1
2025-07-14 18:17:32 -03:00
Gustavo Henrique Miranda d1545ad2e2 Merge branch 'staging' into dependabot/pip/typing-extensions-4.14.1 2025-07-14 18:17:15 -03:00
Gustavo Henrique Miranda 7dbb89b692 Merge pull request #40 from gmbrax/fix/add-enter-binding-edit-diary
Fix/add enter binding edit diary
2025-07-14 16:11:29 -03:00
Gustavo Henrique Miranda 33987507ac Merge pull request #41 from gmbrax/fix/add-enter-binding-on-create-diary
Fix/add enter binding on create diary
2025-07-14 16:11:17 -03:00
Gustavo Henrique Miranda ff97929dc0 Merge pull request #39 from gmbrax/dependabot/pip/textual-approx-eq-4.0.0
Dependabot/pip/textual approx eq 4.0.0
2025-07-14 16:02:45 -03:00
Gustavo Henrique Miranda 5d26c5394d Merge branch 'development' into dependabot/pip/textual-approx-eq-4.0.0 2025-07-14 16:02:35 -03:00
dependabot[bot] a867744d45 Update textual requirement from ~=3.3.0 to ~=4.0.0
---
updated-dependencies:
- dependency-name: textual
  dependency-version: 4.0.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-14 18:29:28 +00:00
dependabot[bot] d2e69ae770 Bump typing-extensions from 4.14.0 to 4.14.1
Bumps [typing-extensions](https://github.com/python/typing_extensions) from 4.14.0 to 4.14.1.
- [Release notes](https://github.com/python/typing_extensions/releases)
- [Changelog](https://github.com/python/typing_extensions/blob/main/CHANGELOG.md)
- [Commits](https://github.com/python/typing_extensions/compare/4.14.0...4.14.1)

---
updated-dependencies:
- dependency-name: typing-extensions
  dependency-version: 4.14.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-14 17:45:35 +00:00
Gustavo Henrique Santos Souza de Miranda f174fd1d8a Fixed the edit diary modal to accept the key "enter" and automatically the function 2025-07-14 02:23:29 -03:00
Gustavo Henrique Santos Souza de Miranda c98a106d97 Fixed the new diary modal to accept the key "enter" and automatically the function 2025-07-14 02:06:25 -03:00
Gustavo Henrique Miranda 417bc0d3e5 Merge pull request #36
Fixed the bindings to properly work and changed some bindings to avoid conflicts with the system
2025-07-14 00:46:23 -03:00
Gustavo Henrique Miranda 1312674186 Merge pull request #35 from gmbrax/fix/bindings-not-properly-working
Fixed the bindings to properly work and changed some bindings to avoid conflicts with the system
2025-07-13 23:06:14 -03:00
Gustavo Henrique Santos Souza de Miranda afc6908f37 Fixed the bindings to properly work and changed some bindings to avoid conflicts with the system 2025-07-13 22:53:39 -03:00
Gustavo Henrique Miranda 2983be09b6 Merge pull request #33 from gmbrax/fix/force-rename-entry
Fixed the new entry creation flow by prompting for a title if none is  set.
2025-07-12 19:29:55 -03:00
Gustavo Henrique Miranda 8129ae77a6 Merge branch 'staging' into fix/force-rename-entry 2025-07-12 19:11:56 -03:00
Gustavo Henrique Miranda 8e04c5b3c7 Merge pull request #32 from gmbrax/fix/create-a-new-entry-on-open
Corrected the behavior to create a new entry upon opening a diary
2025-07-12 13:31:25 -03:00
Gustavo Henrique Santos Souza de Miranda b704a524c8 Fixed the new entry creation flow by prompting for a title if none is set. 2025-07-12 02:55:39 -03:00
Gustavo Henrique Santos Souza de Miranda 63db2517f3 Corrected the behavior to create a new entry upon opening a diary 2025-07-11 17:46:00 -03:00
Gustavo Henrique Miranda fcaf17b593 Update README.md 2025-07-08 19:01:26 -03:00
Gustavo Henrique Miranda 1e07ea49df Update README.md 2025-07-08 19:01:11 -03:00
Gustavo Henrique Miranda 60311bc714 Update README.md
changed the pip install to point to testpypi instead of the pypi and also added a way to get the dependencies from pypi
2025-07-08 18:59:33 -03:00
36 changed files with 1479 additions and 292 deletions
-24
View File
@@ -1,24 +0,0 @@
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')
+63
View File
@@ -0,0 +1,63 @@
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
+47 -30
View File
@@ -1,51 +1,68 @@
# 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.
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).
## Unreleased
## [Unreleased]
## Planned
* Installation Method 1 (repository compilation)
* Organization of trips by date, location, or theme
* Enhanced photo management features
* Search functionality
* Export features
* Testing implementation
### Planned
## [0.0.4] - 2025-07-19
- Installation Method 1 (repository compilation)
- Organization of trips by date, location, or theme
- Enhanced photo management features
- Search functionality
- Export features
- Testing implementation
### Added
* 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
* Automatic diary list refresh when returning to the diary screen
* Application configuration management with a new centralized config system
* Database location and initialization now configurable via the new config manager
* 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
- Create and edit diary entries
- Photo ingestion system
- Photo addition and reference via sidebar
- Text User Interface (TUI) built with Textual framework
- Pre-compiled binary installation method (Method 2)
- Support for Linux operating systems
- Basic project documentation (README)
* Initial alpha release of Pilgrim travel diary application
* Create and edit travel diaries
* Create and edit diary entries
* Photo ingestion system
* Photo addition and reference via sidebar
* Text User Interface (TUI) built with Textual framework
* Pre-compiled binary installation method (Method 2)
* Support for Linux operating systems
* Basic project documentation (README)
### Known Issues
- Installation Method 1 not yet implemented
- 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
* Installation Method 1 not yet implemented
* No testing suite implemented yet
* Some features may be unstable in an alpha version
+1 -1
View File
@@ -25,7 +25,7 @@ structured and accessible format.
To install the application you must issue the command:
```bash
pip install pilgrim
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple Pilgrim
```
## Usage
+29 -30
View File
@@ -1,33 +1,32 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[build-system]
requires = ["hatchling"]
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",
"unidecode"
]
[project]
name = "Pilgrim"
version = "0.0.3"
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",
[project.urls]
Homepage = "https://github.com/gmbrax/Pilgrim/"
Issues = "https://github.com/gmbrax/Pilgrim/issues"
]
[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"
[project.scripts]
pilgrim = "pilgrim.command:main"
+1 -1
View File
@@ -3,4 +3,4 @@ SQLAlchemy==2.0.41
typing_extensions==4.14.1
textual~=3.6.0
textual~=4.0.0
+6 -4
View File
@@ -1,19 +1,21 @@
from pilgrim.database import Database
from pilgrim.service.servicemanager import ServiceManager
from pilgrim.ui.ui import UIApp
from pilgrim.utils import DirectoryManager
from pilgrim.utils import ConfigManager
class Application:
def __init__(self):
self.config_dir = DirectoryManager.get_config_directory()
self.database = Database()
self.config_manager = ConfigManager()
self.config_manager.read_config() # Chamar antes de criar o Database
self.database = Database(self.config_manager)
session = self.database.session()
session_manager = ServiceManager()
session_manager.set_session(session)
self.ui = UIApp(session_manager)
self.ui = UIApp(session_manager, self.config_manager)
def run(self):
print(f"URL do banco: {self.config_manager.database_url}")
self.database.create()
self.ui.run()
+13 -27
View File
@@ -1,42 +1,28 @@
from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import declarative_base
from sqlalchemy.orm import sessionmaker
from pathlib import Path
import os
import shutil
from pilgrim.utils import ConfigManager
Base = declarative_base()
def get_database_path() -> Path:
"""
Get the database file path following XDG Base Directory specification.
Creates the directory if it doesn't exist.
"""
# Get home directory
home = Path.home()
# Create .pilgrim directory if it doesn't exist
pilgrim_dir = home / ".pilgrim"
pilgrim_dir.mkdir(exist_ok=True)
# Database file path
db_path = pilgrim_dir / "database.db"
# If database doesn't exist in new location but exists in current directory,
# migrate it
if not db_path.exists():
current_db = Path("database.db")
if current_db.exists():
shutil.copy2(current_db, db_path)
print(f"Database migrated from {current_db} to {db_path}")
return db_path
class Database:
def __init__(self):
db_path = get_database_path()
def __init__(self, config_manager: ConfigManager):
self.db_path = config_manager.database_url
# Garantir que o diretório existe
db_dir = os.path.dirname(self.db_path)
if not os.path.exists(db_dir):
os.makedirs(db_dir, exist_ok=True)
self.engine = create_engine(
f"sqlite:///{db_path}",
f"sqlite:///{self.db_path}",
echo=False,
connect_args={"check_same_thread": False},
)
+4 -3
View File
@@ -4,15 +4,16 @@ from pilgrim.models.photo_in_entry import photo_entry_association
from sqlalchemy import Column, Integer, String, ForeignKey, DateTime
from sqlalchemy.orm import relationship
from ..database import Base
from pilgrim.database import Base
class Entry(Base):
__tablename__ = "entries"
id = Column(Integer, primary_key=True)
title = Column(String)
title = Column(String,nullable=False)
text = Column(String)
date = Column(DateTime)
date = Column(DateTime,nullable=False)
photos = relationship(
"Photo",
secondary=photo_entry_association,
+8 -2
View File
@@ -4,9 +4,11 @@ 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
from pilgrim.database import Base
class Photo(Base):
@@ -23,7 +25,11 @@ class Photo(Base):
back_populates="photos"
)
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="photos")
__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)
+1 -1
View File
@@ -1,6 +1,6 @@
from sqlalchemy import Table, Column, Integer, ForeignKey
from ..database import Base
from pilgrim.database import Base
photo_entry_association = Table('photo_entry_association', Base.metadata,
Column('id', Integer, primary_key=True, autoincrement=True),
+4 -2
View File
@@ -3,15 +3,17 @@ from typing import Any
from sqlalchemy import Column, Integer, String, UniqueConstraint
from sqlalchemy.orm import relationship
from .. import database
from pilgrim.database import Base
class TravelDiary(database.Base):
class TravelDiary(Base):
__tablename__ = "travel_diaries"
id = Column(Integer, primary_key=True)
name = Column(String, nullable=False)
directory_name = Column(String, nullable=False, unique=True)
entries = relationship("Entry", back_populates="travel_diary", cascade="all, delete-orphan")
photos = relationship("Photo", back_populates="travel_diary", cascade="all, delete-orphan")
__table_args__ = (
UniqueConstraint('directory_name', name='uq_travel_diary_directory_name'),
+3 -3
View File
@@ -1,9 +1,9 @@
from datetime import datetime
from typing import List
from ..models.entry import Entry
from ..models.travel_diary import TravelDiary
from ..models.photo import Photo # ✨ Importe o modelo Photo
from pilgrim.models.entry import Entry
from pilgrim.models.travel_diary import TravelDiary
from pilgrim.models.photo import Photo # ✨ Importe o modelo Photo
class EntryService:
+12 -5
View File
@@ -14,8 +14,9 @@ class PhotoService:
def __init__(self, session):
self.session = session
def _hash_file(self, filepath: Path) -> str:
"""Calculate hash of a file using SHA3-384."""
@staticmethod
def hash_file(filepath: Path) -> str:
"""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):
@@ -64,10 +65,18 @@ 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)
@@ -79,8 +88,6 @@ 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
@@ -118,7 +125,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
+5 -3
View File
@@ -6,8 +6,8 @@ from pathlib import Path
from pilgrim.utils import DirectoryManager
from sqlalchemy.exc import IntegrityError
from ..models.travel_diary import TravelDiary
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
+2 -2
View File
@@ -3,7 +3,7 @@ from textual.binding import Binding
from textual.screen import Screen
from textual.widgets import Header, Footer, Button, Label, TextArea
from textual.containers import Container
from importlib.metadata import version
class AboutScreen(Screen[bool]):
"""Screen to display application information."""
@@ -20,7 +20,7 @@ class AboutScreen(Screen[bool]):
self.app_title = Label("Pilgrim", id="AboutScreen_AboutTitle",classes="AboutScreen_AboutTitle")
self.content = Label("A TUI Based Travel Diary Application", id="AboutScreen_AboutContent",
classes="AboutScreen_AboutContent")
self.version = Label("Version: 0.0.1", id="AboutScreen_AboutVersion",
self.version = Label(f"Version: {version('Pilgrim')}", id="AboutScreen_AboutVersion",
classes="AboutScreen_AboutVersion")
self.developer = Label("Developed By: Gustavo Henrique Miranda ", id="AboutScreen_AboutAuthor")
self.contact = Label("git.gustavomiranda.xyz", id="AboutScreen_AboutContact",
+10 -21
View File
@@ -206,29 +206,18 @@ class DiaryListScreen(Screen):
"""Action to create new diary"""
self.app.push_screen(NewDiaryModal(),self._on_new_diary_submitted)
def _on_new_diary_submitted(self,result):
self.notify(str(result))
if result:
self.notify(f"Creating Diary:{result}'...")
self.call_later(self._async_create_diary,result)
def _on_new_diary_submitted(self, result):
"""Callback after diary creation"""
if result: # Se result não é string vazia, o diário foi criado
self.notify(f"Returning to diary list...")
# Atualiza a lista de diários
self.refresh_diaries()
else:
self.notify(f"Canceled...")
async def _async_create_diary(self,name: str):
try:
service = self.app.service_manager.get_travel_diary_service()
created_diary = await service.async_create(name)
if created_diary:
self.diary_id_map[created_diary.id] = created_diary.id
await self.async_refresh_diaries()
self.notify(f"Diary: '{name}' created!")
else:
self.notify("Error Creating the diary")
except Exception as e:
self.notify(f"Exception on creating the diary: {str(e)}")
self.notify(f"Creation canceled...")
def _on_screen_resume(self) -> None:
super()._on_screen_resume()
self.refresh_diaries()
def action_edit_selected_diary(self):
"""Action to edit selected diary"""
+21 -9
View File
@@ -8,6 +8,7 @@ from textual.widgets import Label, Input, Button
class EditDiaryModal(ModalScreen[tuple[int,str]]):
BINDINGS = [
Binding("escape", "cancel", "Cancel"),
Binding("enter", "edit_diary", "Save",priority=True),
]
def __init__(self, diary_id: int):
@@ -32,17 +33,28 @@ class EditDiaryModal(ModalScreen[tuple[int,str]]):
def on_button_pressed(self, event: Button.Pressed) -> None:
if event.button.id == "save_diary_button":
new_diary_name = self.name_input.value.strip()
if new_diary_name and new_diary_name != self.current_diary_name:
self.dismiss((self.diary_id, new_diary_name))
elif new_diary_name == self.current_diary_name:
self.notify("No changes made.", severity="warning")
self.dismiss(None)
else:
self.notify("Diary name cannot be empty.", severity="warning")
self.name_input.focus()
self.action_edit_diary()
elif event.button.id == "cancel_button":
self.dismiss(None)
def on_key(self, event):
if event.key == "enter":
self.action_edit_diary()
event.prevent_default()
def action_edit_diary(self) -> None:
new_diary_name = self.name_input.value.strip()
if new_diary_name and new_diary_name != self.current_diary_name:
self.dismiss((self.diary_id, new_diary_name))
elif new_diary_name == self.current_diary_name:
self.notify("No changes made.", severity="warning")
self.dismiss(None)
else:
self.notify("Diary name cannot be empty.", severity="warning")
self.name_input.focus()
def on_input_submitted(self, event: Input.Submitted) -> None:
if event.input.id == "edit_diary_name_input":
self.action_edit_diary()
def action_cancel(self) -> None:
self.dismiss(None)
+92 -69
View File
@@ -24,26 +24,33 @@ class EditEntryScreen(Screen):
BINDINGS = [
Binding("ctrl+q", "quit", "Quit"),
Binding("ctrl+s", "save", "Save"),
Binding("ctrl+n", "new_entry", "New Entry"),
Binding("ctrl+shift+n", "next_entry", "Next Entry"),
Binding("ctrl+shift+p", "prev_entry", "Previous Entry"),
Binding("shift+f5", "new_entry", "New Entry"),
Binding("f5", "next_entry", "Next Entry"),
Binding("f4", "prev_entry", "Previous Entry"),
Binding("ctrl+r", "rename_entry", "Rename Entry"),
Binding("f8", "toggle_sidebar", "Toggle Photos"),
Binding("f9", "toggle_focus", "Toggle Focus"),
Binding("escape", "back_to_list", "Back to List"),
]
def __init__(self, diary_id: int = 1):
def __init__(self, diary_id: int = 1,create_new: bool = True):
super().__init__()
if create_new:
self.current_entry_index = -1
self.is_new_entry = True
self.next_entry_id = None
else:
self.is_new_entry = False
self.current_entry_index = 0
self.next_entry_id = 1
self.new_entry_title = ""
self.new_entry_content = ""
self.diary_id = diary_id
self.diary_name = f"Diary {diary_id}"
self.current_entry_index = 0
self.entries: List[Entry] = []
self.is_new_entry = False
self.has_unsaved_changes = False
self.new_entry_content = ""
self.new_entry_title = "New Entry"
self.next_entry_id = 1
self._updating_display = False
self._original_content = ""
self.is_refreshing = False
@@ -80,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")
@@ -289,30 +296,28 @@ 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"
"Use: \\[\\[photo:name:hash\\]\\]\n"
"Or: \\[\\[photo::hash\\]\\]"
"\\[\\[photo::hash\\]\\]"
)
self.help_text.update(help_text)
except Exception as e:
@@ -422,9 +427,7 @@ 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)
@@ -608,7 +611,8 @@ 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)
@@ -735,15 +739,15 @@ class EditEntryScreen(Screen):
self.notify(f"Selected photo: {selected_photo.name} \\[{photo_hash}\\]")
# Update photo info with details including hash
photo_details = f"📷 {selected_photo.name}\n"
photo_details += f"🔗 {photo_hash}\n"
photo_details += f"📅 {selected_photo.addition_date}\n"
photo_details = f"Name: {selected_photo.name}\n"
photo_details += f"Hash: {photo_hash}\n"
photo_details += f"Date: {selected_photo.addition_date}\n"
if selected_photo.caption:
photo_details += f"💬 {selected_photo.caption}\n"
photo_details += f"📁 {selected_photo.filepath}\n\n"
photo_details += f"Caption: {selected_photo.caption}\n"
else:
photo_details += f"Caption: No Caption\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}\\]\\]"
photo_details += f"\\[\\[photo::{photo_hash}]]"
self.photo_info.update(photo_details)
@@ -906,11 +910,22 @@ class EditEntryScreen(Screen):
self.notify("Empty entry cannot be saved")
return
# Passe a lista de fotos para o método de criação
self.call_later(self._async_create_entry, content, photos_to_link)
if self.new_entry_title == "":
self.app.push_screen(RenameEntryModal(current_name=""), lambda result: self._handle_save_after_rename(result,content,
photos_to_link))
else:
self.call_later(self._async_create_entry, content, photos_to_link)
else:
# Passe a lista de fotos para o método de atualização
self.call_later(self._async_update_entry, content, photos_to_link)
def _handle_save_after_rename(self, result: str | None, content: str, photos_to_link: List[Photo]) -> None:
if result is None:
self.notify("Save cancelled")
return
self.new_entry_title = result
self.call_later(self._async_create_entry, content, photos_to_link)
async def _async_create_entry(self, content: str, photos_to_link: List[Photo]):
"""Creates a new entry and links the referenced photos."""
try:
@@ -937,7 +952,7 @@ class EditEntryScreen(Screen):
self.is_new_entry = False
self.has_unsaved_changes = False
self._original_content = new_entry.text
self.new_entry_title = "New Entry"
self.new_entry_title = ""
self.next_entry_id = max(entry.id for entry in self.entries) + 1
self._update_entry_display()
@@ -982,52 +997,60 @@ class EditEntryScreen(Screen):
except Exception as e:
self.notify(f"Error updating entry: {str(e)}")
def on_key(self, event):
# Sidebar contextual shortcuts
def check_key(self, event):
"""Check for custom key handling before bindings are processed"""
# Sidebar shortcuts
if self.sidebar_focused and self.sidebar_visible:
sidebar_keys = ["i", "n", "d", "e"]
if event.key in sidebar_keys:
if event.key == "i":
self.action_insert_photo()
elif event.key == "n":
self.action_ingest_new_photo()
elif event.key == "d":
self.action_delete_photo()
elif event.key == "e":
self.action_edit_photo()
return True # Indica que o evento foi processado
if event.key == "i":
# Text area shortcuts
elif self.focused is self.text_entry:
if event.key in ["tab", "shift+tab"]:
if event.key == "shift+tab":
self._handle_shift_tab()
elif event.key == "tab":
self.text_entry.insert('\t')
return True # Indica que o evento foi processado
self.action_insert_photo()
event.stop()
elif event.key == "n":
return False # Não foi processado, continuar com bindings
self.action_ingest_new_photo()
event.stop()
elif event.key == "d":
def _handle_shift_tab(self):
"""Handle shift+tab for removing indentation"""
textarea = self.text_entry
row, col = textarea.cursor_location
lines = textarea.text.splitlines()
if row < len(lines):
line = lines[row]
if line.startswith('\t'):
lines[row] = line[1:]
textarea.text = '\n'.join(lines)
textarea.cursor_location = (row, max(col - 1, 0))
elif line.startswith(' '): # 4 spaces
lines[row] = line[4:]
textarea.text = '\n'.join(lines)
textarea.cursor_location = (row, max(col - 4, 0))
elif line.startswith(' '):
n = len(line) - len(line.lstrip(' '))
to_remove = min(n, 4)
lines[row] = line[to_remove:]
textarea.text = '\n'.join(lines)
textarea.cursor_location = (row, max(col - to_remove, 0))
self.action_delete_photo()
event.stop()
elif event.key == "e":
self.action_edit_photo()
event.stop()
# Shift+Tab: remove indent
elif self.focused is self.text_entry and event.key == "shift+tab":
textarea = self.text_entry
row, col = textarea.cursor_location
lines = textarea.text.splitlines()
if row < len(lines):
line = lines[row]
if line.startswith('\t'):
lines[row] = line[1:]
textarea.text = '\n'.join(lines)
textarea.cursor_location = (row, max(col - 1, 0))
elif line.startswith(' '): # 4 spaces
lines[row] = line[4:]
textarea.text = '\n'.join(lines)
textarea.cursor_location = (row, max(col - 4, 0))
elif line.startswith(' '):
n = len(line) - len(line.lstrip(' '))
to_remove = min(n, 4)
lines[row] = line[to_remove:]
textarea.text = '\n'.join(lines)
textarea.cursor_location = (row, max(col - to_remove, 0))
event.stop()
# Tab: insert tab
elif self.focused is self.text_entry and event.key == "tab":
self.text_entry.insert('\t')
def on_key(self, event):
if self.check_key(event):
event.stop()
return
def on_footer_action(self, event) -> None:
"""Handle clicks on footer actions (Textual 3.x)."""
@@ -15,12 +15,6 @@ 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(
@@ -69,10 +63,16 @@ 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,13 +82,9 @@ 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
@@ -97,7 +93,7 @@ class AddPhotoModal(Screen):
"name": photo_data["name"],
"caption": photo_data["caption"],
"photo_id": new_photo.id,
"hash": photo_hash
"hash": new_photo.photo_hash
}
self.dismiss(self.result)
else:
@@ -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,15 +12,11 @@ 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"),
@@ -45,10 +41,9 @@ class EditPhotoModal(Screen):
id="caption-input",
classes="EditPhotoModal-Input"
),
Static(f"🔗 Photo Hash: {photo_hash}", classes="EditPhotoModal-Hash"),
Static(f"🔗 Photo Hash: {self.photo.photo_hash[:8]}", classes="EditPhotoModal-Hash"),
Static("Reference formats:", classes="EditPhotoModal-Label"),
Static(f"\\[\\[photo:{self.photo.name}:{photo_hash}\\]\\]", classes="EditPhotoModal-Reference"),
Static(f"\\[\\[photo::{photo_hash}\\]\\]", classes="EditPhotoModal-Reference"),
Static(f"\\[\\[photo::{self.photo.photo_hash[:8]}\\]\\]", classes="EditPhotoModal-Reference"),
Horizontal(
Button("Save Changes", id="save-button", classes="EditPhotoModal-Button"),
Button("Cancel", id="cancel-button", classes="EditPhotoModal-Button"),
+42 -7
View File
@@ -4,13 +4,17 @@ from textual.containers import Vertical, Horizontal
from textual.screen import ModalScreen
from textual.widgets import Label, Input, Button
from pilgrim.ui.screens.edit_entry_screen import EditEntryScreen
class NewDiaryModal(ModalScreen[str]):
BINDINGS = [
Binding("escape", "cancel", "Cancel"),
Binding("enter", "create_diary", "Create",priority=True),
]
def __init__(self):
super().__init__()
self.auto_open = self.app.config_manager.auto_open_new_diary
self.name_input = Input(id="NewDiaryModal-NameInput",classes="NewDiaryModal-NameInput") # This ID is fine, it's specific to the input
def compose(self) -> ComposeResult:
@@ -31,15 +35,46 @@ class NewDiaryModal(ModalScreen[str]):
def on_button_pressed(self, event: Button.Pressed) -> None:
"""Handles button clicks."""
if event.button.id == "create_diary_button":
diary_name = self.name_input.value.strip()
if diary_name:
self.dismiss(diary_name)
else:
self.notify("Diary name cannot be empty.", severity="warning")
self.name_input.focus()
self.action_create_diary()
elif event.button.id == "cancel_button":
self.dismiss("")
self.dismiss()
def action_cancel(self) -> None:
"""Action to cancel the modal."""
self.dismiss("")
def action_create_diary(self) -> None:
diary_name = self.name_input.value.strip()
if diary_name:
self.call_later(self._async_create_diary, diary_name)
else:
self.notify("Diary name cannot be empty.", severity="warning")
self.name_input.focus()
def on_input_submitted(self, event: Input.Submitted) -> None:
if event.input.id == "NewDiaryModal-NameInput":
self.action_create_diary()
async def _async_create_diary(self, name: str):
try:
service = self.app.service_manager.get_travel_diary_service()
created_diary = await service.async_create(name)
if created_diary:
self.dismiss(name)
if self.auto_open:
self.app.push_screen(EditEntryScreen(diary_id=created_diary.id))
self.notify(f"Diary: '{name}' created!")
else:
self.notify("Error Creating the diary")
except Exception as e:
self.notify(f"Exception on creating the diary: {str(e)}")
+18 -21
View File
@@ -389,22 +389,10 @@ Screen.-modal {
width: 1fr;
}
.EditEntryScreen-sidebar {
width: 40;
min-height: 10;
border-left: solid green;
padding: 1;
background: $surface-darken-2;
color: $primary;
text-style: bold;
content-align: left top;
.EditEntryScreen-sidebar{
background: $primary-darken-1;
width: 45%;
}
.EditEntryScreen-content-container {
layout: horizontal;
height: 1fr;
}
.EditEntryScreen-sidebar-title {
text-align: center;
text-style: bold;
@@ -417,30 +405,39 @@ Screen.-modal {
.EditEntryScreen-sidebar-content {
height: 1fr;
layout: vertical;
margin-left: 1;
margin-right: 1;
}
.EditEntryScreen-sidebar-photo-list {
height: 1fr;
height: 2fr; /* Pega o espaço restante disponível */
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: auto;
min-height: 3;
border: solid $warning;
height: 1fr;
max-height: 15; /* Limita altura máxima */
min-height: 13;
padding: 1;
border: solid $warning;
margin-bottom: 1;
background: $surface-darken-1;
overflow-y: auto; /* Adiciona scroll se exceder max-height */
}
.EditEntryScreen-sidebar-help {
height: auto;
min-height: 8;
height: 1fr;
max-height: 10; /* Altura máxima menor que info */
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 */
+3 -1
View File
@@ -9,6 +9,7 @@ from pilgrim.service.servicemanager import ServiceManager
from pilgrim.ui.screens.about_screen import AboutScreen
from pilgrim.ui.screens.diary_list_screen import DiaryListScreen
from pilgrim.ui.screens.edit_entry_screen import EditEntryScreen
from pilgrim.utils import ConfigManager
CSS_FILE_PATH = Path(__file__).parent / "styles" / "pilgrim.css"
@@ -16,9 +17,10 @@ CSS_FILE_PATH = Path(__file__).parent / "styles" / "pilgrim.css"
class UIApp(App):
CSS_PATH = CSS_FILE_PATH
def __init__(self,service_manager: ServiceManager, **kwargs):
def __init__(self,service_manager: ServiceManager, config_manager: ConfigManager, **kwargs):
super().__init__(**kwargs)
self.service_manager = service_manager
self.config_manager = config_manager
def on_mount(self) -> None:
+2 -1
View File
@@ -1,3 +1,4 @@
from .directory_manager import DirectoryManager
from .config_manager import ConfigManager
__all__ = ['DirectoryManager']
__all__ = ['DirectoryManager', 'ConfigManager']
+107
View File
@@ -0,0 +1,107 @@
import os.path
from os import PathLike
from threading import Lock
import tomli
import tomli_w
from pilgrim.utils import DirectoryManager
class SingletonMeta(type):
_instances = {}
_lock: Lock = Lock()
def __call__(cls, *args, **kwargs):
with cls._lock:
if cls not in cls._instances:
instance = super().__call__(*args, **kwargs)
cls._instances[cls] = instance
return cls._instances[cls]
class ConfigManager(metaclass=SingletonMeta):
def __init__(self):
self.database_url = None
self.database_type = None
self.auto_open_diary = None
self.auto_open_new_diary = None
self.config_dir = DirectoryManager.get_config_directory()
self.__data = None
def read_config(self):
if os.path.exists(f"{DirectoryManager.get_config_directory()}/config.toml"):
try:
with open(f"{DirectoryManager.get_config_directory()}/config.toml", "rb") as f:
data = tomli.load(f)
except tomli.TOMLDecodeError as e:
raise ValueError(f"Invalid TOML configuration: {e}")
except Exception as e:
raise RuntimeError(f"Error reading configuration: {e}")
self.__data = data
self.database_url = self.__data["database"]["url"]
self.database_type = self.__data["database"]["type"]
if self.__data["settings"]["diary"]["auto_open_diary_on_startup"] == "":
self.auto_open_diary = None
self.auto_open_new_diary = self.__data["settings"]["diary"]["auto_open_on_creation"]
else:
print("Error: config.toml not found.")
self.create_config()
self.read_config()
def create_config(self, config: dict = None):
# Garantir que o diretório de configuração existe
config_dir = DirectoryManager.get_config_directory()
if not os.path.exists(config_dir):
os.makedirs(config_dir, exist_ok=True)
default = {
"database": {
"url": f"{config_dir}/database.db",
"type": "sqlite"
},
"settings": {
"diary": {
"auto_open_diary_on_startup": "",
"auto_open_on_creation": False
}
}
}
if config is None:
config = default
try:
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}")
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
def set_database_url(self, value: str):
self.database_url = value
def set_auto_open_diary(self, value: str):
self.auto_open_diary = value
def set_auto_open_new_diary(self, value: bool):
self.auto_open_new_diary = value
+24
View File
@@ -1,4 +1,5 @@
import os
import shutil
from pathlib import Path
@@ -37,3 +38,26 @@ class DirectoryManager:
def get_diary_images_directory(directory_name: str) -> Path:
"""Returns the images directory path for a specific diary."""
return DirectoryManager.get_diary_data_directory(directory_name) / "images"
@staticmethod
def get_database_path() -> Path:
"""
Get the database file path following XDG Base Directory specification.
Creates the directory if it doesn't exist.
"""
pilgrim_dir = DirectoryManager.get_config_directory()
db_path = pilgrim_dir / "database.db"
# If database doesn't exist in new location but exists in current directory,
# migrate it
if not db_path.exists():
current_db = Path("database.db")
if current_db.exists():
try:
shutil.copy2(current_db, db_path)
# Consider using logging instead of print
print(f"Database migrated from {current_db} to {db_path}")
except (OSError, shutil.Error) as e:
raise RuntimeError(f"Failed to migrate database: {e}")
return db_path
+64
View File
@@ -0,0 +1,64 @@
import pytest
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
from pilgrim.database import Base
from pilgrim.models.travel_diary import TravelDiary
from pilgrim.models.photo import Photo
# Todos os imports necessários para as fixtures devem estar aqui
# ...
@pytest.fixture(scope="function")
def db_session():
"""Esta fixture agora está disponível para TODOS os testes."""
engine = create_engine("sqlite:///:memory:")
Base.metadata.create_all(engine)
Session = sessionmaker(bind=engine)
session = Session()
yield session
session.close()
Base.metadata.drop_all(engine)
@pytest.fixture
def populated_db_session(db_session):
"""Esta também fica disponível para todos."""
travel_diary = TravelDiary(name="My Travel Diary", directory_name="viagem-teste")
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
@pytest.fixture
def session_with_photos(session_with_one_diary):
session, diary = session_with_one_diary
# Usamos a mesma raiz de diretório que o mock do teste espera
diaries_root = "/fake/diaries_root"
photo1 = Photo(
# CORREÇÃO: O caminho agora inclui a raiz e a subpasta 'images'
filepath=f"{diaries_root}/{diary.directory_name}/images/p1.jpg",
name="Foto 1",
photo_hash="hash1",
fk_travel_diary_id=diary.id
)
photo2 = Photo(
filepath=f"{diaries_root}/{diary.directory_name}/images/p2.jpg",
name="Foto 2",
photo_hash="hash2",
fk_travel_diary_id=diary.id
)
session.add_all([photo1, photo2])
session.commit()
return session, [photo1, photo2]
+269
View File
@@ -0,0 +1,269 @@
from re import search
import pytest
from datetime import datetime
from unittest.mock import Mock
from sqlalchemy import create_engine
from sqlalchemy.exc import IntegrityError
from sqlalchemy.orm import sessionmaker
from pilgrim.database import Base
from pilgrim.models.travel_diary import TravelDiary
from pilgrim.models.entry import Entry
from pilgrim.models.photo import Photo
from pilgrim.service.entry_service import EntryService
@pytest.fixture
def session_with_an_entry(populated_db_session):
session = populated_db_session
initial_entry = Entry(
title="Título Original",
text="Texto original.",
date=datetime(2025, 1, 1),
travel_diary_id=1
)
session.add(initial_entry)
session.commit()
return session, initial_entry.id
@pytest.fixture
def session_with_multiple_entries(populated_db_session):
"""Fixture que cria um diário e duas entradas para ele."""
session = populated_db_session
entry1 = Entry(title="Entrada 1", text="Texto 1", date=datetime(2025, 1, 1), travel_diary_id=1)
entry2 = Entry(title="Entrada 2", text="Texto 2", date=datetime(2025, 1, 2), travel_diary_id=1)
session.add_all([entry1, entry2])
session.commit()
return session
def test_create_entry_successfully(populated_db_session):
session = populated_db_session
service = EntryService(session)
diary_id = 1 # Sabemos que o ID é 1 por causa da nossa fixture
title = "Primeiro Dia na Praia"
text = "O dia foi ensolarado e o mar estava ótimo."
date = datetime(2025, 7, 20)
photos = [Photo(filepath="/path/to/photo1.jpg",name="Photo 1",photo_hash="hash_12345678",fk_travel_diary_id=diary_id), Photo(filepath="/path/to/photo2.jpg",name="Photo 1",photo_hash="hash_87654321",fk_travel_diary_id=diary_id)]
created_entry = service.create(
travel_diary_id=diary_id,
title=title,
text=text,
date=date,
photos=photos
)
assert created_entry is not None
assert created_entry.id is not None # Garante que foi salvo no BD e tem um ID
assert created_entry.title == title
assert created_entry.text == text
assert len(created_entry.photos) == 2
assert created_entry.photos[0].filepath == "/path/to/photo1.jpg"
entry_in_db = session.query(Entry).filter_by(id=created_entry.id).one()
assert entry_in_db.title == "Primeiro Dia na Praia"
def test_create_entry_fails_when_diary_id_is_invalid(db_session):
session = db_session
service = EntryService(session)
invalid_id = 666
result = service.create(
travel_diary_id=invalid_id,
title="Título de Teste",
text="Texto de Teste",
date=datetime(2025, 7, 20),
photos=[]
)
assert result is None
def test_create_entry_successfully_without_photo(populated_db_session):
session = populated_db_session
service = EntryService(session)
diary_id = 1 # Sabemos que o ID é 1 por causa da nossa fixture
title = "Primeiro Dia na Praia"
text = "O dia foi ensolarado e o mar estava ótimo."
date = datetime(2025, 7, 20)
photos = []
created_entry = service.create(
travel_diary_id=diary_id,
title=title,
text=text,
date=date,
photos=photos
)
assert created_entry is not None
assert created_entry.id is not None # Garante que foi salvo no BD e tem um ID
assert created_entry.title == title
assert created_entry.text == text
assert len(created_entry.photos) == 0
entry_in_db = session.query(Entry).filter_by(id=created_entry.id).one()
assert entry_in_db.title == "Primeiro Dia na Praia"
def test_create_entry_fails_with_null_title(populated_db_session):
session = populated_db_session
service = EntryService(session)
diary_id = 1
with pytest.raises(IntegrityError):
service.create(
travel_diary_id=diary_id,
title=None,
text="Um texto qualquer.",
date=datetime.now(),
photos=[]
)
def test_create_entry_fails_with_null_date(populated_db_session):
session = populated_db_session
service = EntryService(session)
diary_id = 1
with pytest.raises(IntegrityError):
service.create(
travel_diary_id=diary_id,
title="Sabado de sol",
text="Um texto qualquer.",
date=None,
photos=[]
)
def test_create_entry_fails_with_null_diary_id(populated_db_session):
session = populated_db_session
service = EntryService(session)
diary_id = 1
result = service.create(
travel_diary_id=None,
title="Sabado de sol",
text="Um texto qualquer.",
date=datetime.now(),
photos=[]
)
assert result is None
def test_ready_by_id_successfully(session_with_an_entry):
session,_ = session_with_an_entry
service = EntryService(session)
search_id = 1
result = service.read_by_id(search_id)
assert result is not None
def test_ready_by_id_fails_when_id_is_invalid(db_session):
session = db_session
service = EntryService(session)
invalid_id = 666
result = service.read_by_id(invalid_id)
assert result is None
def test_read_all_returns_all_entries(session_with_multiple_entries):
session = session_with_multiple_entries
service = EntryService(session)
all_entries = service.read_all()
assert isinstance(all_entries, list)
assert len(all_entries) == 2
assert all_entries[0].title == "Entrada 1"
assert all_entries[1].title == "Entrada 2"
def test_read_all_returns_empty_list_on_empty_db(db_session):
session = db_session
service = EntryService(session)
all_entries = service.read_all()
assert isinstance(all_entries, list)
assert len(all_entries) == 0
def test_update_entry_successfully(session_with_an_entry):
session, entry_id = session_with_an_entry
service = EntryService(session)
entry_src = session.query(Entry).filter_by(id=entry_id).one()
new_date = datetime(2025, 1, 2)
entry_dst = Entry(
title="Título Atualizado",
text="Texto atualizado.",
date=new_date,
travel_diary_id=1, # Mantemos o mesmo travel_diary_id
photos=[]
)
updated_entry = service.update(entry_src, entry_dst)
assert updated_entry is not None
assert updated_entry.id == entry_id
assert updated_entry.title == "Título Atualizado"
assert updated_entry.text == "Texto atualizado."
entry_in_db = session.query(Entry).filter_by(id=entry_id).one()
assert entry_in_db.title == "Título Atualizado"
def test_update_entry_fails_if_entry_does_not_exist(db_session):
service = EntryService(db_session)
non_existent_entry = Entry(
title="dummy",
text="dummy",
date=datetime.now(),
travel_diary_id=1)
non_existent_entry.id = 999
entry_with_new_data = Entry(title="Novo Título", text="Novo Texto", date=datetime.now(), travel_diary_id=1)
result = service.update(non_existent_entry, entry_with_new_data)
assert result is None
def test_update_fails_with_null_title(session_with_an_entry):
session, entry_id = session_with_an_entry
service = EntryService(session)
entry_src = session.query(Entry).filter_by(id=entry_id).one()
entry_dst = Entry(
title=None,
text="Texto atualizado.",
date=datetime.now(),
travel_diary_id=1,
photos=[]
)
with pytest.raises(IntegrityError):
service.update(entry_src, entry_dst)
def test_update_fails_with_null_date(session_with_an_entry):
session, entry_id = session_with_an_entry
service = EntryService(session)
entry_src = session.query(Entry).filter_by(id=entry_id).one()
entry_dst = Entry(
title=entry_src.title,
text="Texto atualizado.",
date=None,
travel_diary_id=1,
photos=[]
)
with pytest.raises(IntegrityError):
service.update(entry_src, entry_dst)
def test_update_fails_with_null_diary_id(session_with_an_entry):
session, entry_id = session_with_an_entry
service = EntryService(session)
entry_src = session.query(Entry).filter_by(id=entry_id).one()
entry_dst = Entry(
title=entry_src.title,
text="Texto atualizado.",
date=datetime.now(),
travel_diary_id=None,
photos=[]
)
with pytest.raises(IntegrityError):
service.update(entry_src, entry_dst)
def test_delete_successfully_removes_entry(session_with_an_entry):
session, entry_id = session_with_an_entry
service = EntryService(session)
entry_to_delete = service.read_by_id(entry_id)
assert entry_to_delete is not None
deleted_entry = service.delete(entry_to_delete)
assert deleted_entry is not None
assert deleted_entry.id == entry_id
entry_in_db = service.read_by_id(entry_id)
assert entry_in_db is None
def test_delete_returns_none_if_entry_does_not_exist(db_session):
service = EntryService(db_session)
non_existent_entry = Entry(
title="dummy",
text="dummy",
date=datetime.now(),
travel_diary_id=1)
non_existent_entry.id = 999
result = service.delete(non_existent_entry)
assert result is None
+249
View File
@@ -0,0 +1,249 @@
import pytest
from pathlib import Path
from pilgrim import TravelDiary
from pilgrim.service.photo_service import PhotoService
import hashlib
from unittest.mock import patch
from pilgrim.models.photo import Photo
from pilgrim.utils import DirectoryManager
@patch.object(PhotoService, '_copy_photo_to_diary')
@patch.object(PhotoService, 'hash_file', return_value="fake_hash_123")
def test_create_photo_successfully(mock_hash, mock_copy, session_with_one_diary):
session, diary = session_with_one_diary
service = PhotoService(session)
fake_source_path = Path("/path/original/imagem.jpg")
fake_copied_path = Path(f"~/.pilgrim/diaries/{diary.directory_name}/images/imagem.jpg")
mock_copy.return_value = fake_copied_path
new_photo = service.create(
filepath=fake_source_path,
name="Foto da Praia",
travel_diary_id=diary.id,
caption="Pôr do sol")
mock_hash.assert_called_once_with(fake_source_path)
mock_copy.assert_called_once_with(fake_source_path, diary)
assert new_photo is not None
assert new_photo.name == "Foto da Praia"
assert new_photo.photo_hash == "fake_hash_123"
assert new_photo.filepath == str(fake_copied_path)
def test_hash_file_generates_correct_hash(tmp_path: Path):
original_content_bytes = b"um conteudo de teste para o hash"
file_on_disk = tmp_path / "test.jpg"
file_on_disk.write_bytes(original_content_bytes)
hash_from_file = PhotoService.hash_file(file_on_disk)
expected_hash_func = hashlib.new('sha3_384')
expected_hash_func.update(original_content_bytes)
hash_from_memory = expected_hash_func.hexdigest()
assert hash_from_file == hash_from_memory
@patch.object(PhotoService, '_copy_photo_to_diary')
@patch.object(PhotoService, 'hash_file', return_value="hash_ja_existente")
def test_create_photo_returns_none_if_hash_exists(mock_hash, mock_copy, session_with_one_diary):
session, diary = session_with_one_diary
existing_photo = Photo(
filepath="/path/existente.jpg", name="Foto Antiga",
photo_hash="hash_ja_existente", fk_travel_diary_id=diary.id
)
session.add(existing_photo)
session.commit()
service = PhotoService(session)
new_photo = service.create(
filepath=Path("/path/novo/arquivo.jpg"),
name="Foto Nova",
travel_diary_id=diary.id
)
assert new_photo is None
mock_copy.assert_not_called()
def test_read_by_id_successfully(session_with_photos):
session, photos = session_with_photos
service = PhotoService(session)
photo_to_find_id = photos[0].id
found_photo = service.read_by_id(photo_to_find_id)
assert found_photo is not None
assert found_photo.id == photo_to_find_id
assert found_photo.name == "Foto 1"
def test_read_by_id_returns_none_for_invalid_id(db_session):
service = PhotoService(db_session)
result = service.read_by_id(999)
assert result is None
def test_read_all_returns_all_photos(session_with_photos):
session, _ = session_with_photos
service = PhotoService(session)
all_photos = service.read_all()
assert isinstance(all_photos, list)
assert len(all_photos) == 2
assert all_photos[0].name == "Foto 1"
assert all_photos[1].name == "Foto 2"
def test_read_all_returns_empty_list_for_empty_db(db_session):
service = PhotoService(db_session)
all_photos = service.read_all()
assert isinstance(all_photos, list)
assert len(all_photos) == 0
def test_check_photo_by_hash_finds_existing_photo(session_with_photos):
session, photos = session_with_photos
service = PhotoService(session)
existing_photo = photos[0]
hash_to_find = existing_photo.photo_hash # "hash1"
diary_id = existing_photo.fk_travel_diary_id # 1
found_photo = service.check_photo_by_hash(hash_to_find, diary_id)
assert found_photo is not None
assert found_photo.id == existing_photo.id
assert found_photo.photo_hash == hash_to_find
def test_check_photo_by_hash_returns_none_when_not_found(session_with_photos):
session, photos = session_with_photos
service = PhotoService(session)
existing_hash = photos[0].photo_hash # "hash1"
existing_diary_id = photos[0].fk_travel_diary_id # 1
result1 = service.check_photo_by_hash("hash_inexistente", existing_diary_id)
assert result1 is None
invalid_diary_id = 999
result2 = service.check_photo_by_hash(existing_hash, invalid_diary_id)
assert result2 is None
def test_update_photo_metadata_successfully(session_with_photos):
session, photos = session_with_photos
service = PhotoService(session)
photo_to_update = photos[0]
photo_with_new_data = Photo(
filepath=photo_to_update.filepath,
name="Novo Nome da Foto",
caption="Nova legenda para a foto.",
photo_hash=photo_to_update.photo_hash, # O hash não muda
addition_date=photo_to_update.addition_date,
fk_travel_diary_id=photo_to_update.fk_travel_diary_id
)
updated_photo = service.update(photo_to_update, photo_with_new_data)
assert updated_photo is not None
assert updated_photo.name == "Novo Nome da Foto"
assert updated_photo.caption == "Nova legenda para a foto."
assert updated_photo.photo_hash == photo_to_update.photo_hash
photo_in_db = session.query(Photo).get(photo_to_update.id)
assert photo_in_db.name == "Novo Nome da Foto"
@patch.object(PhotoService, 'hash_file')
@patch('pathlib.Path.unlink')
@patch('pathlib.Path.exists')
@patch.object(PhotoService, '_copy_photo_to_diary')
@patch.object(DirectoryManager, 'get_diaries_root', return_value="/fake/diaries_root")
def test_update_photo_with_new_file_successfully(
mock_get_root, mock_copy, mock_exists, mock_unlink, mock_hash, session_with_photos
):
session, photos = session_with_photos
service = PhotoService(session)
photo_to_update = photos[0]
new_source_path = Path("/path/para/nova_imagem.jpg")
new_copied_path = Path(f"/fake/diaries_root/{photo_to_update.travel_diary.directory_name}/images/nova_imagem.jpg")
mock_copy.return_value = new_copied_path
mock_exists.return_value = True
mock_hash.return_value = "novo_hash_calculado"
photo_with_new_file = Photo(
filepath=new_source_path,
name=photo_to_update.name,
photo_hash="hash_antigo",
fk_travel_diary_id=photo_to_update.fk_travel_diary_id
)
updated_photo = service.update(photo_to_update, photo_with_new_file)
mock_copy.assert_called_once_with(new_source_path, photo_to_update.travel_diary)
mock_unlink.assert_called_once()
mock_hash.assert_called_once_with(new_copied_path)
assert updated_photo.filepath == str(new_copied_path)
assert updated_photo.photo_hash == "novo_hash_calculado"
def test_update_photo_returns_none_if_photo_does_not_exist(db_session):
service = PhotoService(db_session)
non_existent_photo_src = Photo(
filepath="/fake/path.jpg", name="dummy",
photo_hash="dummy", fk_travel_diary_id=1
)
non_existent_photo_src.id = 999
photo_with_new_data = Photo(
filepath="/fake/new.jpg", name="new dummy",
photo_hash="new_dummy", fk_travel_diary_id=1
)
result = service.update(non_existent_photo_src, photo_with_new_data)
assert result is None
@patch.object(PhotoService, 'hash_file')
@patch('pathlib.Path.unlink')
@patch('pathlib.Path.exists')
@patch.object(PhotoService, '_copy_photo_to_diary')
@patch.object(DirectoryManager, 'get_diaries_root', return_value="/fake/diaries_root")
def test_update_photo_with_new_file_successfully(
mock_get_root, mock_copy, mock_exists, mock_unlink, mock_hash, session_with_photos
):
session, photos = session_with_photos
service = PhotoService(session)
photo_to_update = photos[0]
new_source_path = Path("/path/para/nova_imagem.jpg")
new_copied_path = Path(f"/fake/diaries_root/{photo_to_update.travel_diary.directory_name}/images/nova_imagem.jpg")
mock_copy.return_value = new_copied_path
mock_exists.return_value = True
mock_hash.return_value = "novo_hash_calculado"
photo_with_new_file = Photo(
filepath=new_source_path, name=photo_to_update.name,
photo_hash="hash_antigo", fk_travel_diary_id=photo_to_update.fk_travel_diary_id
)
updated_photo = service.update(photo_to_update, photo_with_new_file)
mock_copy.assert_called_once_with(new_source_path, photo_to_update.travel_diary)
mock_unlink.assert_called_once()
mock_hash.assert_called_once_with(new_copied_path)
assert updated_photo.filepath == str(new_copied_path)
assert updated_photo.photo_hash == "novo_hash_calculado"
@patch.object(DirectoryManager, 'get_diary_images_directory')
def test_copy_photo_to_diary_handles_name_collision_with_patch(mock_get_images_dir, db_session, tmp_path: Path):
images_dir = tmp_path / "images"
images_dir.mkdir()
mock_get_images_dir.return_value = images_dir
source_file = tmp_path / "foto.jpg"
source_file.touch()
(images_dir / "foto.jpg").touch()
service = PhotoService(db_session)
fake_diary = TravelDiary(name="test",directory_name="fake_diary")
copied_path = service._copy_photo_to_diary(source_file, fake_diary)
assert copied_path.name == "foto_1.jpg"
assert copied_path.exists()
@patch('pathlib.Path.unlink')
@patch('pathlib.Path.exists')
@patch.object(DirectoryManager, 'get_diaries_root', return_value="/fake/diaries_root")
def test_delete_photo_successfully(mock_get_root, mock_exists, mock_unlink, session_with_photos):
session, photos = session_with_photos
service = PhotoService(session)
photo_to_delete = photos[0]
photo_id = photo_to_delete.id
mock_exists.return_value = True
deleted_photo_data = service.delete(photo_to_delete)
mock_unlink.assert_called_once()
assert deleted_photo_data is not None
assert deleted_photo_data.id == photo_id
photo_in_db = service.read_by_id(photo_id)
assert photo_in_db is None
@patch('pathlib.Path.unlink')
def test_delete_returns_none_for_non_existent_photo(mock_unlink, db_session):
service = PhotoService(db_session)
non_existent_photo = Photo(
filepath="/fake/path.jpg", name="dummy",
photo_hash="dummy_hash", fk_travel_diary_id=1
)
non_existent_photo.id = 999
result = service.delete(non_existent_photo)
assert result is None
mock_unlink.assert_not_called()
+33
View File
@@ -0,0 +1,33 @@
from pilgrim.service.servicemanager import ServiceManager
from unittest.mock import patch, MagicMock
def test_initial_state_is_none():
manager = ServiceManager()
assert manager.get_session() is None
assert manager.get_entry_service() is None
assert manager.get_photo_service() is None
assert manager.get_travel_diary_service() is None
@patch('pilgrim.service.servicemanager.TravelDiaryService')
@patch('pilgrim.service.servicemanager.PhotoService')
@patch('pilgrim.service.servicemanager.EntryService')
def test_get_services_instantiates_with_correct_session(
mock_entry_service, mock_photo_service, mock_travel_diary_service
):
manager = ServiceManager()
mock_session = MagicMock()
manager.set_session(mock_session)
entry_service_instance = manager.get_entry_service()
photo_service_instance = manager.get_photo_service()
travel_diary_service_instance = manager.get_travel_diary_service()
mock_entry_service.assert_called_once()
mock_photo_service.assert_called_once()
mock_travel_diary_service.assert_called_once()
mock_entry_service.assert_called_once_with(mock_session)
mock_photo_service.assert_called_once_with(mock_session)
mock_travel_diary_service.assert_called_once_with(mock_session)
assert entry_service_instance == mock_entry_service.return_value
assert photo_service_instance == mock_photo_service.return_value
assert travel_diary_service_instance == mock_travel_diary_service.return_value
+143
View File
@@ -0,0 +1,143 @@
from unittest.mock import patch, MagicMock
from pathlib import Path
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()
@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()
@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, '_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):
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"
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) == "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")
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"
+9
View File
@@ -0,0 +1,9 @@
from unittest.mock import patch
from pilgrim.command import main
@patch('pilgrim.command.Application')
def test_main_function_runs_application(MockApplication):
mock_app_instance = MockApplication.return_value
main()
MockApplication.assert_called_once()
mock_app_instance.run.assert_called_once()
+40
View File
@@ -0,0 +1,40 @@
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()
+67
View File
@@ -0,0 +1,67 @@
import pytest
import tomli
from pathlib import Path
from unittest.mock import patch
from pilgrim.utils.config_manager import ConfigManager, SingletonMeta
from pilgrim.utils.directory_manager import DirectoryManager
@pytest.fixture
def clean_singleton():
SingletonMeta._instances = {}
@patch('pilgrim.utils.config_manager.DirectoryManager.get_config_directory')
def test_create_default_config_if_not_exists_with_decorator(mock_get_config_dir, tmp_path: Path, clean_singleton):
mock_get_config_dir.return_value = str(tmp_path)
manager = ConfigManager()
config_file = tmp_path / "config.toml"
assert not config_file.exists()
manager.read_config()
assert config_file.exists()
assert manager.database_type == "sqlite"
@patch('pilgrim.utils.config_manager.DirectoryManager.get_config_directory')
def test_read_existing_config_with_decorator(mock_get_config_dir, tmp_path: Path, clean_singleton):
mock_get_config_dir.return_value = str(tmp_path)
custom_config_content = """
[database]
url = "/custom/path/to/db.sqlite"
type = "custom_sqlite"
[settings.diary]
auto_open_diary_on_startup = "MyCustomDiary"
auto_open_on_creation = true
"""
config_file = tmp_path / "config.toml"
config_file.write_text(custom_config_content)
manager = ConfigManager()
manager.read_config()
assert manager.database_url == "/custom/path/to/db.sqlite"
assert manager.database_type == "custom_sqlite"
@patch('pilgrim.utils.config_manager.DirectoryManager.get_config_directory')
def test_save_config_writes_changes_to_file_with_decorator(mock_get_config_dir, tmp_path: Path, clean_singleton):
mock_get_config_dir.return_value = str(tmp_path)
manager = ConfigManager()
manager.read_config()
manager.set_database_url("/novo/caminho.db")
manager.set_auto_open_new_diary(True)
manager.save_config()
config_file = tmp_path / "config.toml"
with open(config_file, "rb") as f:
data = tomli.load(f)
assert data["database"]["url"] == "/novo/caminho.db"
assert data["settings"]["diary"]["auto_open_on_creation"] is True
@patch('pilgrim.utils.config_manager.DirectoryManager.get_config_directory')
def test_read_config_raises_error_on_malformed_toml(mock_get_config_dir, tmp_path: Path, clean_singleton):
mock_get_config_dir.return_value = str(tmp_path)
invalid_toml_content = """
[database]
url = /caminho/sem/aspas
"""
config_file = tmp_path / "config.toml"
config_file.write_text(invalid_toml_content)
manager = ConfigManager()
with pytest.raises(ValueError, match="Invalid TOML configuration"):
manager.read_config()
+71
View File
@@ -0,0 +1,71 @@
import shutil
from pathlib import Path
from unittest.mock import patch
import pytest
from pilgrim.utils.directory_manager import DirectoryManager
@patch('os.chmod')
@patch('pathlib.Path.home')
def test_get_config_directory_creates_dir_in_fake_home(mock_home, mock_chmod, tmp_path: Path):
mock_home.return_value = tmp_path
expected_config_dir = tmp_path / ".pilgrim"
assert not expected_config_dir.exists()
result_path = DirectoryManager.get_config_directory()
assert result_path == expected_config_dir
assert expected_config_dir.exists()
mock_chmod.assert_called_once_with(expected_config_dir, 0o700)
@patch('shutil.copy2')
@patch('pathlib.Path.home')
def test_get_database_path_no_migration(mock_home, mock_copy, tmp_path: Path):
mock_home.return_value = tmp_path
expected_db_path = tmp_path / ".pilgrim" / "database.db"
result_path = DirectoryManager.get_database_path()
assert result_path == expected_db_path
mock_copy.assert_not_called()
@patch('shutil.copy2')
@patch('pathlib.Path.home')
def test_get_database_path_with_migration(mock_home, mock_copy, tmp_path: Path, monkeypatch):
fake_home_dir = tmp_path / "home"
fake_project_dir = tmp_path / "project"
fake_home_dir.mkdir()
fake_project_dir.mkdir()
(fake_project_dir / "database.db").touch()
mock_home.return_value = fake_home_dir
monkeypatch.chdir(fake_project_dir)
result_path = DirectoryManager.get_database_path()
expected_db_path = fake_home_dir / ".pilgrim" / "database.db"
assert result_path == expected_db_path
mock_copy.assert_called_once_with(
Path("database.db"),
expected_db_path
)
@patch('os.chmod')
@patch('pathlib.Path.home')
def test_diary_path_methods_construct_correctly(mock_home, mock_chmod, tmp_path: Path):
mock_home.return_value = tmp_path
images_path = DirectoryManager.get_diary_images_directory("minha-viagem")
expected_path = tmp_path / ".pilgrim" / "diaries" / "minha-viagem" / "data" / "images"
assert images_path == expected_path
assert (tmp_path / ".pilgrim" / "diaries").exists()
@patch('shutil.copy2')
@patch('pathlib.Path.home')
def test_get_database_path_handles_migration_error(mock_home, mock_copy, tmp_path: Path, monkeypatch):
fake_home_dir = tmp_path / "home"
fake_project_dir = tmp_path / "project"
fake_home_dir.mkdir()
fake_project_dir.mkdir()
(fake_project_dir / "database.db").touch()
mock_home.return_value = fake_home_dir
mock_copy.side_effect = shutil.Error("O disco está cheio!")
monkeypatch.chdir(fake_project_dir)
with pytest.raises(RuntimeError, match="Failed to migrate database"):
DirectoryManager.get_database_path()
mock_copy.assert_called_once()