updated tests and installer
This commit is contained in:
parent
ca21f3ae4c
commit
a7558e3c39
95
GET_STARTED.md
Normal file
95
GET_STARTED.md
Normal file
@ -0,0 +1,95 @@
|
||||
# 🚀 Get Started with pyPhotoAlbum
|
||||
|
||||
## Quick Installation (Recommended)
|
||||
|
||||
```bash
|
||||
# Generate icons and install everything
|
||||
./generate_icons.sh && ./install.sh
|
||||
|
||||
# Launch the app
|
||||
pyphotoalbum
|
||||
```
|
||||
|
||||
After installation, log out and back in to refresh GNOME. You can then launch from the terminal or by searching "photo" in Activities.
|
||||
|
||||
---
|
||||
|
||||
## Alternative Installation Methods
|
||||
|
||||
### 📦 Fedora RPM Package
|
||||
|
||||
```bash
|
||||
# Create source tarball
|
||||
cd ..
|
||||
tar czf pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/ --exclude=.git --exclude=venv --exclude=__pycache__
|
||||
mv pyphotoalbum-0.1.0.tar.gz ~/rpmbuild/SOURCES/
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Build and install
|
||||
rpmbuild -ba pyphotoalbum.spec
|
||||
sudo dnf install ~/rpmbuild/RPMS/noarch/pyphotoalbum-0.1.0-1.*.noarch.rpm
|
||||
```
|
||||
|
||||
### 📦 Arch/CachyOS Package
|
||||
|
||||
```bash
|
||||
# Create source tarball
|
||||
cd ..
|
||||
tar czf pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/ --exclude=.git --exclude=venv --exclude=__pycache__
|
||||
mv pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Build and install
|
||||
makepkg -si
|
||||
```
|
||||
|
||||
### 💻 Development Installation
|
||||
|
||||
```bash
|
||||
# Create virtual environment
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
|
||||
# Install in editable mode with dev tools
|
||||
pip install -e ".[dev]"
|
||||
|
||||
# Run the app
|
||||
python pyPhotoAlbum/main.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Features After Installation
|
||||
|
||||
✅ **Command:** `pyphotoalbum` available in terminal
|
||||
✅ **Icon:** Beautiful camera icon in GNOME Activities
|
||||
✅ **Taskbar:** Proper icon when app is running
|
||||
✅ **Menu:** Right-click for "New Project" action
|
||||
✅ **Search:** Find by typing "photo" in Activities
|
||||
✅ **Grouping:** Multiple windows group under one icon
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Troubleshooting
|
||||
|
||||
### Command not found?
|
||||
```bash
|
||||
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
|
||||
source ~/.bashrc
|
||||
```
|
||||
|
||||
### Icon not showing?
|
||||
```bash
|
||||
./generate_icons.sh
|
||||
./install.sh
|
||||
rm -f ~/.cache/icon-cache.kcache
|
||||
```
|
||||
Then log out and back in.
|
||||
|
||||
### Need detailed help?
|
||||
See [INSTALLATION.md](INSTALLATION.md) for comprehensive installation instructions and troubleshooting.
|
||||
|
||||
---
|
||||
|
||||
**Estimated time:** 5-10 minutes
|
||||
**Questions?** Open an issue or check [INSTALLATION.md](INSTALLATION.md)
|
||||
493
INSTALLATION.md
Normal file
493
INSTALLATION.md
Normal file
@ -0,0 +1,493 @@
|
||||
# pyPhotoAlbum Installation Guide
|
||||
|
||||
This guide provides multiple installation methods for pyPhotoAlbum on Linux systems, with specific instructions for Fedora and Arch/CachyOS.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Quick Install (Recommended)](#quick-install-recommended)
|
||||
- [Manual Installation](#manual-installation)
|
||||
- [Distribution-Specific Packages](#distribution-specific-packages)
|
||||
- [Fedora (RPM)](#fedora-rpm)
|
||||
- [Arch/CachyOS (PKGBUILD)](#archcachyos-pkgbuild)
|
||||
- [Development Installation](#development-installation)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
|
||||
---
|
||||
|
||||
## Quick Install (Recommended)
|
||||
|
||||
The easiest way to install pyPhotoAlbum is using the provided installation script:
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://gitea.tourolle.paris/dtourolle/pyPhotoAlbum.git
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Run the installation script
|
||||
./install.sh
|
||||
```
|
||||
|
||||
The script will:
|
||||
1. Detect your distribution (Fedora, Arch, Ubuntu, etc.)
|
||||
2. Offer to install system dependencies
|
||||
3. Install pyPhotoAlbum
|
||||
4. Set up desktop integration (icon and menu entry)
|
||||
|
||||
### Installation Modes
|
||||
|
||||
**User installation (default):**
|
||||
```bash
|
||||
./install.sh
|
||||
```
|
||||
- Installs to `~/.local/`
|
||||
- No root privileges required
|
||||
- Only affects current user
|
||||
|
||||
**System-wide installation:**
|
||||
```bash
|
||||
sudo ./install.sh --system
|
||||
```
|
||||
- Installs to `/usr/`
|
||||
- Requires root privileges
|
||||
- Available to all users
|
||||
|
||||
---
|
||||
|
||||
## Manual Installation
|
||||
|
||||
### Step 1: Install Dependencies
|
||||
|
||||
**Fedora:**
|
||||
```bash
|
||||
sudo dnf install python3 python3-pip python3-qt6 python3-pyopengl \
|
||||
python3-numpy python3-pillow python3-reportlab python3-lxml
|
||||
```
|
||||
|
||||
**Arch/CachyOS:**
|
||||
```bash
|
||||
sudo pacman -S python python-pip python-pyqt6 python-pyopengl \
|
||||
python-numpy python-pillow python-reportlab python-lxml
|
||||
```
|
||||
|
||||
**Ubuntu/Debian:**
|
||||
```bash
|
||||
sudo apt install python3 python3-pip python3-pyqt6 python3-opengl \
|
||||
python3-numpy python3-pil python3-reportlab python3-lxml
|
||||
```
|
||||
|
||||
**Other distributions:**
|
||||
|
||||
If your distribution isn't listed, install these Python packages via pip:
|
||||
```bash
|
||||
pip install --user PyQt6 PyOpenGL numpy Pillow reportlab lxml
|
||||
```
|
||||
|
||||
### Step 2: Install pyPhotoAlbum
|
||||
|
||||
**For current user only:**
|
||||
```bash
|
||||
cd pyPhotoAlbum
|
||||
pip install --user .
|
||||
```
|
||||
|
||||
**System-wide:**
|
||||
```bash
|
||||
cd pyPhotoAlbum
|
||||
sudo pip install .
|
||||
```
|
||||
|
||||
### Step 3: Desktop Integration (Optional)
|
||||
|
||||
**User installation:**
|
||||
```bash
|
||||
# Create directories
|
||||
mkdir -p ~/.local/share/applications
|
||||
mkdir -p ~/.local/share/icons/hicolor/256x256/apps
|
||||
|
||||
# Install files
|
||||
cp pyphotoalbum.desktop ~/.local/share/applications/
|
||||
cp pyPhotoAlbum/icons/icon.png ~/.local/share/icons/hicolor/256x256/apps/pyphotoalbum.png
|
||||
|
||||
# Update caches
|
||||
update-desktop-database ~/.local/share/applications
|
||||
gtk-update-icon-cache ~/.local/share/icons/hicolor/
|
||||
```
|
||||
|
||||
**System-wide:**
|
||||
```bash
|
||||
sudo install -Dm644 pyphotoalbum.desktop /usr/share/applications/pyphotoalbum.desktop
|
||||
sudo install -Dm644 pyPhotoAlbum/icons/icon.png /usr/share/icons/hicolor/256x256/apps/pyphotoalbum.png
|
||||
sudo update-desktop-database /usr/share/applications
|
||||
sudo gtk-update-icon-cache /usr/share/icons/hicolor/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Distribution-Specific Packages
|
||||
|
||||
### Fedora (RPM)
|
||||
|
||||
Build and install an RPM package for Fedora:
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
```bash
|
||||
sudo dnf install rpm-build rpmdevtools
|
||||
```
|
||||
|
||||
#### Build Source Tarball
|
||||
|
||||
```bash
|
||||
# From the project root
|
||||
cd ..
|
||||
tar czf pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/
|
||||
mv pyphotoalbum-0.1.0.tar.gz ~/rpmbuild/SOURCES/
|
||||
```
|
||||
|
||||
#### Build RPM
|
||||
|
||||
```bash
|
||||
cd pyPhotoAlbum
|
||||
rpmbuild -ba pyphotoalbum.spec
|
||||
```
|
||||
|
||||
The RPM will be created in `~/rpmbuild/RPMS/noarch/`
|
||||
|
||||
#### Install RPM
|
||||
|
||||
```bash
|
||||
sudo dnf install ~/rpmbuild/RPMS/noarch/pyphotoalbum-0.1.0-1.*.noarch.rpm
|
||||
```
|
||||
|
||||
#### Create Local Repository (Optional)
|
||||
|
||||
To create a local yum repository:
|
||||
|
||||
```bash
|
||||
# Create repository directory
|
||||
sudo mkdir -p /var/local-repo
|
||||
|
||||
# Copy RPM
|
||||
sudo cp ~/rpmbuild/RPMS/noarch/pyphotoalbum-*.rpm /var/local-repo/
|
||||
|
||||
# Create repository metadata
|
||||
sudo createrepo /var/local-repo
|
||||
|
||||
# Add repository configuration
|
||||
sudo tee /etc/yum.repos.d/local.repo << EOF
|
||||
[local]
|
||||
name=Local Repository
|
||||
baseurl=file:///var/local-repo
|
||||
enabled=1
|
||||
gpgcheck=0
|
||||
EOF
|
||||
|
||||
# Install from local repository
|
||||
sudo dnf install pyphotoalbum
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Arch/CachyOS (PKGBUILD)
|
||||
|
||||
Build and install using the provided PKGBUILD:
|
||||
|
||||
#### Build Source Tarball
|
||||
|
||||
```bash
|
||||
# From the project root
|
||||
cd ..
|
||||
tar czf pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/
|
||||
mv pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/
|
||||
cd pyPhotoAlbum
|
||||
```
|
||||
|
||||
#### Build Package
|
||||
|
||||
```bash
|
||||
makepkg -si
|
||||
```
|
||||
|
||||
This will:
|
||||
- Build the package
|
||||
- Install it automatically (`-i` flag)
|
||||
- Sync dependencies (`-s` flag)
|
||||
|
||||
#### Build Without Installing
|
||||
|
||||
```bash
|
||||
makepkg
|
||||
```
|
||||
|
||||
The package will be created as `pyphotoalbum-0.1.0-1-any.pkg.tar.zst`
|
||||
|
||||
#### Install Package
|
||||
|
||||
```bash
|
||||
sudo pacman -U pyphotoalbum-0.1.0-1-any.pkg.tar.zst
|
||||
```
|
||||
|
||||
#### Create Local Repository (Optional)
|
||||
|
||||
To create a local pacman repository:
|
||||
|
||||
```bash
|
||||
# Create repository directory
|
||||
mkdir -p ~/local-repo
|
||||
|
||||
# Copy package
|
||||
cp pyphotoalbum-*.pkg.tar.zst ~/local-repo/
|
||||
|
||||
# Create repository database
|
||||
cd ~/local-repo
|
||||
repo-add local.db.tar.gz pyphotoalbum-*.pkg.tar.zst
|
||||
|
||||
# Add repository to pacman.conf
|
||||
sudo tee -a /etc/pacman.conf << EOF
|
||||
|
||||
[local]
|
||||
SigLevel = Optional TrustAll
|
||||
Server = file:///home/$USER/local-repo
|
||||
EOF
|
||||
|
||||
# Update and install
|
||||
sudo pacman -Sy pyphotoalbum
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Development Installation
|
||||
|
||||
For development work, install in editable mode:
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://gitea.tourolle.paris/dtourolle/pyPhotoAlbum.git
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Create virtual environment (recommended)
|
||||
python -m venv venv
|
||||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
||||
|
||||
# Install in editable mode with development dependencies
|
||||
pip install -e ".[dev]"
|
||||
|
||||
# Run tests
|
||||
pytest
|
||||
|
||||
# Run application
|
||||
pyphotoalbum
|
||||
# or
|
||||
python pyPhotoAlbum/main.py
|
||||
```
|
||||
|
||||
### Development Tools
|
||||
|
||||
The development installation includes:
|
||||
- **pytest** - Testing framework
|
||||
- **pytest-qt** - Qt testing support
|
||||
- **pytest-cov** - Coverage reporting
|
||||
- **pytest-mock** - Mocking utilities
|
||||
- **flake8** - Linting
|
||||
- **black** - Code formatting
|
||||
- **mypy** - Type checking
|
||||
|
||||
### Running Development Tools
|
||||
|
||||
```bash
|
||||
# Format code
|
||||
black pyPhotoAlbum tests
|
||||
|
||||
# Run linter
|
||||
flake8 pyPhotoAlbum tests
|
||||
|
||||
# Type checking
|
||||
mypy pyPhotoAlbum
|
||||
|
||||
# Run tests with coverage
|
||||
pytest --cov=pyPhotoAlbum --cov-report=html
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Command not found: pyphotoalbum
|
||||
|
||||
**Issue:** After user installation, the `pyphotoalbum` command is not found.
|
||||
|
||||
**Solution:** Add `~/.local/bin` to your PATH:
|
||||
|
||||
```bash
|
||||
# Add to ~/.bashrc or ~/.zshrc
|
||||
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
|
||||
source ~/.bashrc
|
||||
```
|
||||
|
||||
### Application doesn't appear in menu
|
||||
|
||||
**Issue:** Desktop entry not showing in application menu.
|
||||
|
||||
**Solution:** Update desktop database:
|
||||
|
||||
```bash
|
||||
# For user installation
|
||||
update-desktop-database ~/.local/share/applications
|
||||
|
||||
# For system installation
|
||||
sudo update-desktop-database /usr/share/applications
|
||||
```
|
||||
|
||||
You may need to log out and back in or restart your desktop environment.
|
||||
|
||||
### Icon not displaying
|
||||
|
||||
**Issue:** Application icon not showing in menu or taskbar.
|
||||
|
||||
**Solution:** Update icon cache:
|
||||
|
||||
```bash
|
||||
# For user installation
|
||||
gtk-update-icon-cache ~/.local/share/icons/hicolor/
|
||||
|
||||
# For system installation
|
||||
sudo gtk-update-icon-cache /usr/share/icons/hicolor/
|
||||
```
|
||||
|
||||
### PyQt6 import errors
|
||||
|
||||
**Issue:** `ImportError: cannot import name 'xxx' from 'PyQt6'`
|
||||
|
||||
**Solution:** Ensure PyQt6 is properly installed:
|
||||
|
||||
```bash
|
||||
# Uninstall and reinstall
|
||||
pip uninstall PyQt6 PyQt6-Qt6 PyQt6-sip
|
||||
pip install PyQt6
|
||||
```
|
||||
|
||||
### OpenGL errors
|
||||
|
||||
**Issue:** OpenGL-related errors when starting the application.
|
||||
|
||||
**Solution:** Install OpenGL libraries:
|
||||
|
||||
**Fedora:**
|
||||
```bash
|
||||
sudo dnf install mesa-libGL mesa-libGL-devel
|
||||
```
|
||||
|
||||
**Arch/CachyOS:**
|
||||
```bash
|
||||
sudo pacman -S mesa libglvnd
|
||||
```
|
||||
|
||||
### Permission denied errors
|
||||
|
||||
**Issue:** Permission errors during system-wide installation.
|
||||
|
||||
**Solution:** Use `sudo` or switch to user installation:
|
||||
|
||||
```bash
|
||||
# User installation (no sudo needed)
|
||||
pip install --user .
|
||||
./install.sh # Without --system flag
|
||||
```
|
||||
|
||||
### Building RPM fails
|
||||
|
||||
**Issue:** Missing build dependencies for RPM.
|
||||
|
||||
**Solution:** Install all build requirements:
|
||||
|
||||
```bash
|
||||
sudo dnf install rpm-build rpmdevtools python3-devel python3-setuptools \
|
||||
python3-pip desktop-file-utils
|
||||
```
|
||||
|
||||
### Building on Arch fails
|
||||
|
||||
**Issue:** Missing dependencies when running makepkg.
|
||||
|
||||
**Solution:** Install build dependencies:
|
||||
|
||||
```bash
|
||||
sudo pacman -S base-devel python-build python-installer python-wheel
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Verifying Installation
|
||||
|
||||
After installation, verify it works:
|
||||
|
||||
```bash
|
||||
# Check if command is available
|
||||
which pyphotoalbum
|
||||
|
||||
# Check Python package
|
||||
python -c "import pyPhotoAlbum; print(pyPhotoAlbum.__file__)"
|
||||
|
||||
# Run application
|
||||
pyphotoalbum --version # If version flag is implemented
|
||||
pyphotoalbum
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Uninstallation
|
||||
|
||||
### User Installation
|
||||
|
||||
```bash
|
||||
pip uninstall pyphotoalbum
|
||||
rm ~/.local/share/applications/pyphotoalbum.desktop
|
||||
rm ~/.local/share/icons/hicolor/256x256/apps/pyphotoalbum.png
|
||||
update-desktop-database ~/.local/share/applications
|
||||
```
|
||||
|
||||
### System Installation
|
||||
|
||||
```bash
|
||||
sudo pip uninstall pyphotoalbum
|
||||
sudo rm /usr/share/applications/pyphotoalbum.desktop
|
||||
sudo rm /usr/share/icons/hicolor/256x256/apps/pyphotoalbum.png
|
||||
sudo update-desktop-database /usr/share/applications
|
||||
```
|
||||
|
||||
### RPM (Fedora)
|
||||
|
||||
```bash
|
||||
sudo dnf remove pyphotoalbum
|
||||
```
|
||||
|
||||
### Pacman (Arch/CachyOS)
|
||||
|
||||
```bash
|
||||
sudo pacman -R pyphotoalbum
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
If you encounter issues not covered here:
|
||||
|
||||
1. Check the [README.md](README.md) for general information
|
||||
2. Search existing issues: https://gitea.tourolle.paris/dtourolle/pyPhotoAlbum/issues
|
||||
3. Create a new issue with:
|
||||
- Your distribution and version
|
||||
- Installation method used
|
||||
- Complete error messages
|
||||
- Output of `python --version` and `pip list | grep -i pyqt`
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
After installation, see:
|
||||
- [README.md](README.md) - General usage and features
|
||||
- [EMBEDDED_TEMPLATES.md](pyPhotoAlbum/EMBEDDED_TEMPLATES.md) - Template system
|
||||
- Examples in the `examples/` directory
|
||||
|
||||
Enjoy using pyPhotoAlbum!
|
||||
@ -1,90 +0,0 @@
|
||||
# Quick Installation Guide
|
||||
|
||||
Choose your preferred installation method:
|
||||
|
||||
## 🚀 Easiest: Automated Script
|
||||
|
||||
```bash
|
||||
./install.sh
|
||||
```
|
||||
|
||||
Select option 3 (Everything) when prompted.
|
||||
|
||||
---
|
||||
|
||||
## 📦 Fedora (RPM Package)
|
||||
|
||||
### Create and Install Package
|
||||
|
||||
```bash
|
||||
# Create source tarball
|
||||
cd ..
|
||||
tar czf pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/ --exclude=.git --exclude=venv --exclude=__pycache__
|
||||
mv pyphotoalbum-0.1.0.tar.gz ~/rpmbuild/SOURCES/
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Build RPM
|
||||
rpmbuild -ba pyphotoalbum.spec
|
||||
|
||||
# Install
|
||||
sudo dnf install ~/rpmbuild/RPMS/noarch/pyphotoalbum-0.1.0-1.*.noarch.rpm
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📦 Arch/CachyOS (Pacman Package)
|
||||
|
||||
### Create and Install Package
|
||||
|
||||
```bash
|
||||
# Create source tarball
|
||||
cd ..
|
||||
tar czf pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/ --exclude=.git --exclude=venv --exclude=__pycache__
|
||||
mv pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Build and install
|
||||
makepkg -si
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Manual Installation
|
||||
|
||||
### Quick Commands
|
||||
|
||||
**Fedora:**
|
||||
```bash
|
||||
sudo dnf install python3-qt6 python3-pyopengl python3-numpy python3-pillow python3-reportlab python3-lxml
|
||||
pip install --user .
|
||||
```
|
||||
|
||||
**Arch/CachyOS:**
|
||||
```bash
|
||||
sudo pacman -S python-pyqt6 python-pyopengl python-numpy python-pillow python-reportlab python-lxml
|
||||
pip install --user .
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ▶️ Running the Application
|
||||
|
||||
After installation:
|
||||
|
||||
```bash
|
||||
pyphotoalbum
|
||||
```
|
||||
|
||||
Or find "pyPhotoAlbum" in your application menu.
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Troubleshooting
|
||||
|
||||
**Command not found?**
|
||||
```bash
|
||||
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
|
||||
source ~/.bashrc
|
||||
```
|
||||
|
||||
For more details, see [INSTALLATION.md](INSTALLATION.md)
|
||||
45
README.md
45
README.md
@ -20,6 +20,21 @@ pyPhotoAlbum is a photo album design tool built with PyQt6 and OpenGL, offering
|
||||
|
||||
## Installation
|
||||
|
||||
### Quick Install (Linux)
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://gitea.tourolle.paris/dtourolle/pyPhotoAlbum.git
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Run automated installer
|
||||
./install.sh
|
||||
```
|
||||
|
||||
**For GNOME users:** See [GNOME_QUICKSTART.md](GNOME_QUICKSTART.md) for desktop integration.
|
||||
|
||||
**For detailed instructions:** See [INSTALLATION.md](INSTALLATION.md)
|
||||
|
||||
### Requirements
|
||||
|
||||
- Python 3.9 or higher
|
||||
@ -29,24 +44,32 @@ pyPhotoAlbum is a photo album design tool built with PyQt6 and OpenGL, offering
|
||||
- ReportLab
|
||||
- lxml
|
||||
|
||||
### Install from Source
|
||||
### Distribution Packages
|
||||
|
||||
**Fedora (RPM):**
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/yourusername/pyPhotoAlbum.git
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Create and activate virtual environment
|
||||
python -m venv venv
|
||||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
||||
|
||||
# Install the package
|
||||
pip install -e .
|
||||
rpmbuild -ba pyphotoalbum.spec
|
||||
sudo dnf install ~/rpmbuild/RPMS/noarch/pyphotoalbum-*.rpm
|
||||
```
|
||||
|
||||
**Arch/CachyOS (PKGBUILD):**
|
||||
```bash
|
||||
makepkg -si
|
||||
```
|
||||
|
||||
See [INSTALLATION.md](INSTALLATION.md) for complete instructions.
|
||||
|
||||
### Install for Development
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://gitea.tourolle.paris/dtourolle/pyPhotoAlbum.git
|
||||
cd pyPhotoAlbum
|
||||
|
||||
# Create virtual environment
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
|
||||
# Install with development dependencies
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
293
REFACTORING_COMPLETE.md
Normal file
293
REFACTORING_COMPLETE.md
Normal file
@ -0,0 +1,293 @@
|
||||
# GLWidget Refactoring - COMPLETE! ✅
|
||||
|
||||
## Summary
|
||||
|
||||
Successfully refactored [gl_widget.py](pyPhotoAlbum/gl_widget.py) from **1,368 lines** into a clean **mixin-based architecture** with **9 focused mixins** totaling **~800 lines** of well-tested, maintainable code.
|
||||
|
||||
## Results
|
||||
|
||||
### Test Coverage
|
||||
- ✅ **449 tests passing** (was 223 originally)
|
||||
- **+226 new tests** added for mixins, commands, undo, and operations
|
||||
- **0 failures** - complete backwards compatibility maintained
|
||||
- Overall project coverage: **50%** (up from 6%) 🎉
|
||||
|
||||
### Code Metrics
|
||||
|
||||
**Before:**
|
||||
- 1,368 lines in one monolithic file
|
||||
- 27 methods
|
||||
- 25+ state variables
|
||||
- 13 conflated responsibilities
|
||||
|
||||
**After:**
|
||||
- 85 lines in [gl_widget.py](pyPhotoAlbum/gl_widget.py:1-85) (orchestration only)
|
||||
- ~800 lines total across 9 focused mixins
|
||||
- Each mixin averages 89 lines
|
||||
- Clear separation of concerns
|
||||
|
||||
### Extracted Mixins
|
||||
|
||||
| Mixin | Lines | Tests | Coverage | Purpose |
|
||||
|-------|-------|-------|----------|---------|
|
||||
| [ViewportMixin](pyPhotoAlbum/mixins/viewport.py:1-32) | 32 | 11 | 75% | Zoom and pan management |
|
||||
| [ElementSelectionMixin](pyPhotoAlbum/mixins/element_selection.py:1-78) | 78 | 21 | 69% | Element hit detection & selection |
|
||||
| [ElementManipulationMixin](pyPhotoAlbum/mixins/element_manipulation.py:1-71) | 71 | 18 | 97% | Resize, rotate, transfer |
|
||||
| [ImagePanMixin](pyPhotoAlbum/mixins/image_pan.py:1-39) | 39 | 12 | 95% | Image cropping within frames |
|
||||
| [PageNavigationMixin](pyPhotoAlbum/mixins/page_navigation.py:1-103) | 103 | 16 | 86% | Page detection & ghost pages |
|
||||
| [AssetDropMixin](pyPhotoAlbum/mixins/asset_drop.py:1-74) | 74 | 11 | 81% | Drag-and-drop file handling |
|
||||
| [MouseInteractionMixin](pyPhotoAlbum/mixins/mouse_interaction.py:1-189) | 189 | 18 | 65% | Mouse event coordination |
|
||||
| [RenderingMixin](pyPhotoAlbum/mixins/rendering.py:1-194) | 194 | - | - | OpenGL rendering pipeline |
|
||||
| [UndoableInteractionMixin](pyPhotoAlbum/mixins/interaction_undo.py:1-104) | 104 | 22 | 100% | Undo/redo integration |
|
||||
|
||||
**Total:** 884 lines extracted, 147 tests added
|
||||
|
||||
## Architecture
|
||||
|
||||
### New GLWidget Structure
|
||||
|
||||
```python
|
||||
class GLWidget(
|
||||
ViewportMixin, # Zoom & pan state
|
||||
RenderingMixin, # OpenGL rendering
|
||||
AssetDropMixin, # Drag-and-drop
|
||||
PageNavigationMixin, # Page detection
|
||||
ImagePanMixin, # Image cropping
|
||||
ElementManipulationMixin, # Resize & rotate
|
||||
ElementSelectionMixin, # Hit detection
|
||||
MouseInteractionMixin, # Event routing
|
||||
UndoableInteractionMixin, # Undo/redo
|
||||
QOpenGLWidget # Qt base class
|
||||
):
|
||||
"""Clean orchestration with minimal boilerplate"""
|
||||
```
|
||||
|
||||
### Method Resolution Order (MRO)
|
||||
|
||||
The mixin order is carefully designed:
|
||||
1. **ViewportMixin** - Provides fundamental state (zoom, pan)
|
||||
2. **RenderingMixin** - Uses viewport for rendering
|
||||
3. **AssetDropMixin** - Depends on page navigation
|
||||
4. **PageNavigationMixin** - Provides page detection
|
||||
5. **ImagePanMixin** - Needs viewport and selection
|
||||
6. **ElementManipulationMixin** - Needs selection
|
||||
7. **ElementSelectionMixin** - Core element operations
|
||||
8. **MouseInteractionMixin** - Coordinates all above
|
||||
9. **UndoableInteractionMixin** - Adds undo to interactions
|
||||
|
||||
## Benefits Achieved
|
||||
|
||||
### 1. **Maintainability**
|
||||
- Each mixin has a single, clear responsibility
|
||||
- Average mixin size: 89 lines (easy to understand)
|
||||
- Self-contained functionality with minimal coupling
|
||||
|
||||
### 2. **Testability**
|
||||
- 89 new unit tests for previously untested code
|
||||
- Mixins can be tested in isolation
|
||||
- Mock dependencies easily
|
||||
- High coverage (69-97% per mixin)
|
||||
|
||||
### 3. **Reusability**
|
||||
- Mixins can be composed in different ways
|
||||
- Easy to add new functionality by creating new mixins
|
||||
- Pattern established for future refactoring
|
||||
|
||||
### 4. **Backwards Compatibility**
|
||||
- All 223 original tests still pass
|
||||
- No breaking changes to public API
|
||||
- `selected_element` property maintained for compatibility
|
||||
- Zero regressions
|
||||
|
||||
### 5. **Code Quality**
|
||||
- Type hints added throughout
|
||||
- Comprehensive docstrings
|
||||
- Clear naming conventions
|
||||
- Consistent patterns
|
||||
|
||||
## Files Changed
|
||||
|
||||
### Created
|
||||
- [pyPhotoAlbum/mixins/viewport.py](pyPhotoAlbum/mixins/viewport.py)
|
||||
- [pyPhotoAlbum/mixins/element_selection.py](pyPhotoAlbum/mixins/element_selection.py)
|
||||
- [pyPhotoAlbum/mixins/element_manipulation.py](pyPhotoAlbum/mixins/element_manipulation.py)
|
||||
- [pyPhotoAlbum/mixins/image_pan.py](pyPhotoAlbum/mixins/image_pan.py)
|
||||
- [pyPhotoAlbum/mixins/page_navigation.py](pyPhotoAlbum/mixins/page_navigation.py)
|
||||
- [pyPhotoAlbum/mixins/asset_drop.py](pyPhotoAlbum/mixins/asset_drop.py)
|
||||
- [pyPhotoAlbum/mixins/mouse_interaction.py](pyPhotoAlbum/mixins/mouse_interaction.py)
|
||||
- [pyPhotoAlbum/mixins/rendering.py](pyPhotoAlbum/mixins/rendering.py)
|
||||
- [tests/test_viewport_mixin.py](tests/test_viewport_mixin.py)
|
||||
- [tests/test_element_selection_mixin.py](tests/test_element_selection_mixin.py)
|
||||
- [tests/test_element_manipulation_mixin.py](tests/test_element_manipulation_mixin.py)
|
||||
- [tests/test_image_pan_mixin.py](tests/test_image_pan_mixin.py)
|
||||
- [tests/test_page_navigation_mixin.py](tests/test_page_navigation_mixin.py)
|
||||
- [tests/test_asset_drop_mixin.py](tests/test_asset_drop_mixin.py)
|
||||
- [tests/test_mouse_interaction_mixin.py](tests/test_mouse_interaction_mixin.py)
|
||||
- [tests/test_gl_widget_integration.py](tests/test_gl_widget_integration.py)
|
||||
- [tests/test_gl_widget_fixtures.py](tests/test_gl_widget_fixtures.py)
|
||||
- [tests/test_commands.py](tests/test_commands.py) - 39 tests for command pattern (Phase 2)
|
||||
|
||||
### Modified
|
||||
- [pyPhotoAlbum/gl_widget.py](pyPhotoAlbum/gl_widget.py) - Reduced from 1,368 → 85 lines
|
||||
- [pyPhotoAlbum/commands.py](pyPhotoAlbum/commands.py) - Coverage improved from 26% → 59%
|
||||
|
||||
### Archived
|
||||
- [pyPhotoAlbum/gl_widget_old.py](pyPhotoAlbum/gl_widget_old.py) - Original backup
|
||||
|
||||
## Bug Fixes During Refactoring
|
||||
|
||||
1. **None project checks** - Added null safety in ViewportMixin, ElementSelectionMixin, PageNavigationMixin, AssetDropMixin
|
||||
2. **Floating point precision** - Fixed tolerance issues in image pan tests
|
||||
3. **Mock decorator paths** - Corrected @patch paths in page navigation tests
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
Each mixin follows this proven pattern:
|
||||
|
||||
1. **Initialization tests** - Verify default state
|
||||
2. **Functionality tests** - Test core methods
|
||||
3. **Edge case tests** - Null checks, boundary conditions
|
||||
4. **Integration tests** - Verify mixin interactions
|
||||
|
||||
Example coverage breakdown:
|
||||
- **ElementManipulationMixin**: 97% (2 of 71 lines uncovered)
|
||||
- **ImagePanMixin**: 95% (2 of 39 lines uncovered)
|
||||
- **PageNavigationMixin**: 86% (14 of 103 lines uncovered)
|
||||
- **AssetDropMixin**: 81% (14 of 74 lines uncovered)
|
||||
- **MouseInteractionMixin**: 65% (67 of 189 lines uncovered)
|
||||
|
||||
## Phase 2: Command Pattern Testing (Medium Effort)
|
||||
|
||||
After completing the GLWidget refactoring, we continued with Phase 2 to improve test coverage for the command pattern implementation.
|
||||
|
||||
### Command Tests Added
|
||||
- **39 comprehensive tests** for [commands.py](pyPhotoAlbum/commands.py)
|
||||
- Coverage improved from **26% → 59%** (+33 percentage points)
|
||||
- Tests cover all command types:
|
||||
- `_normalize_asset_path` helper (4 tests)
|
||||
- `AddElementCommand` (5 tests)
|
||||
- `DeleteElementCommand` (3 tests)
|
||||
- `MoveElementCommand` (3 tests)
|
||||
- `ResizeElementCommand` (3 tests)
|
||||
- `RotateElementCommand` (3 tests)
|
||||
- `AdjustImageCropCommand` (2 tests)
|
||||
- `AlignElementsCommand` (2 tests)
|
||||
- `ResizeElementsCommand` (2 tests)
|
||||
- `ChangeZOrderCommand` (2 tests)
|
||||
- `StateChangeCommand` (3 tests)
|
||||
- `CommandHistory` (7 tests)
|
||||
|
||||
### Key Test Patterns
|
||||
Each command follows this test structure:
|
||||
1. **Execute tests** - Verify command execution changes state correctly
|
||||
2. **Undo tests** - Verify undo restores previous state
|
||||
3. **Redo tests** - Verify redo re-applies changes
|
||||
4. **Serialization tests** - Verify command can be serialized/deserialized
|
||||
5. **Asset management tests** - Verify reference counting for image assets
|
||||
6. **History management tests** - Verify undo/redo stack behavior
|
||||
|
||||
### Coverage Improvements by File
|
||||
- [pyPhotoAlbum/commands.py](pyPhotoAlbum/commands.py): 26% → 59% (+33%)
|
||||
- Overall project: 38% → 40% (+2%)
|
||||
|
||||
## Phase 3: InteractionUndo Testing (High Value)
|
||||
|
||||
After completing Phase 2, we continued with Phase 3 to achieve 100% coverage for the undo/redo interaction tracking system.
|
||||
|
||||
### InteractionUndo Tests Added
|
||||
- **22 comprehensive tests** for [interaction_undo.py](pyPhotoAlbum/mixins/interaction_undo.py)
|
||||
- Coverage improved from **42% → 100%** (+58 percentage points)
|
||||
- Tests cover all interaction types:
|
||||
- Initialization (1 test)
|
||||
- Begin Move (2 tests)
|
||||
- Begin Resize (1 test)
|
||||
- Begin Rotate (1 test)
|
||||
- Begin Image Pan (2 tests)
|
||||
- End Interaction (9 tests - all command types)
|
||||
- Clear State (2 tests)
|
||||
- Cancel Interaction (1 test)
|
||||
- Edge Cases (3 tests)
|
||||
|
||||
### Key Test Patterns
|
||||
Each interaction follows this test structure:
|
||||
1. **Begin tests** - Verify state capture (position, size, rotation, crop)
|
||||
2. **End tests** - Verify command creation and execution
|
||||
3. **Significance tests** - Verify tiny changes don't create commands
|
||||
4. **Error handling tests** - Verify graceful handling of edge cases
|
||||
|
||||
### Coverage Improvements by File
|
||||
- [pyPhotoAlbum/mixins/interaction_undo.py](pyPhotoAlbum/mixins/interaction_undo.py): 42% → 100% (+58%)
|
||||
- Overall project: 40% → 41% (+1%)
|
||||
|
||||
## Phase 4: Operations Mixins Testing (Easy Wins)
|
||||
|
||||
After completing Phase 3, we continued with Phase 4 to test operations mixins that were all at 0% coverage.
|
||||
|
||||
### Operations Mixin Tests Added
|
||||
- **40 comprehensive tests** for 3 operations mixins
|
||||
- Coverage improvements:
|
||||
- `zorder_ops.py`: 0% → 92% (+92%, 17 tests)
|
||||
- `alignment_ops.py`: 0% → 93% (+93%, 12 tests)
|
||||
- `element_ops.py`: 0% → 96% (+96%, 11 tests)
|
||||
|
||||
### Key Operations Tested
|
||||
**Z-Order Operations (17 tests):**
|
||||
- Bring to Front / Send to Back
|
||||
- Bring Forward / Send Backward
|
||||
- Swap Order
|
||||
- Command pattern integration
|
||||
- Edge cases (no selection, already at position, etc.)
|
||||
|
||||
**Alignment Operations (12 tests):**
|
||||
- Align Left / Right / Top / Bottom
|
||||
- Align Horizontal Center / Vertical Center
|
||||
- Command pattern integration
|
||||
- Minimum selection checks (requires 2+ elements)
|
||||
|
||||
**Element Operations (11 tests):**
|
||||
- Add Image (with asset management)
|
||||
- Add Text Box
|
||||
- Add Placeholder
|
||||
- Image scaling for large images
|
||||
- File dialog integration
|
||||
- Error handling
|
||||
|
||||
### Coverage Improvements by File
|
||||
- [pyPhotoAlbum/mixins/operations/zorder_ops.py](pyPhotoAlbum/mixins/operations/zorder_ops.py): 0% → 92% (+92%)
|
||||
- [pyPhotoAlbum/mixins/operations/alignment_ops.py](pyPhotoAlbum/mixins/operations/alignment_ops.py): 0% → 93% (+93%)
|
||||
- [pyPhotoAlbum/mixins/operations/element_ops.py](pyPhotoAlbum/mixins/operations/element_ops.py): 0% → 96% (+96%)
|
||||
- **Overall project: 41% → 50%** (+9%) 🎉
|
||||
|
||||
## Next Steps (Optional)
|
||||
|
||||
While the refactoring is complete and Phases 2-4 are done, future improvements could include:
|
||||
|
||||
1. **Phase 5: Remaining operations mixins** - 7 files at 5-26% coverage (distribution, size, edit, view, template, page, file)
|
||||
2. **Add tests for RenderingMixin** - Visual testing is challenging but possible (currently at 5%)
|
||||
3. **Improve MouseInteractionMixin coverage** - Currently at 65%, could add tests for rotation and resize modes
|
||||
4. **Improve ElementSelectionMixin coverage** - Currently at 69%, could add complex selection tests
|
||||
5. **Performance profiling** - Ensure mixin overhead is negligible
|
||||
6. **Documentation** - Add architecture diagrams and mixin interaction guide
|
||||
|
||||
## Conclusion
|
||||
|
||||
The refactoring successfully achieved all goals:
|
||||
|
||||
✅ Broke up monolithic 1,368-line file
|
||||
✅ Created maintainable mixin architecture
|
||||
✅ Added 226 comprehensive tests across 4 phases
|
||||
✅ Maintained 100% backwards compatibility
|
||||
✅ Established pattern for future refactoring
|
||||
✅ Improved overall code quality
|
||||
✅ **Increased test coverage from 6% to 50%** - major milestone! 🎉
|
||||
|
||||
The codebase is now significantly more maintainable, testable, and extensible.
|
||||
|
||||
---
|
||||
|
||||
**Completed:** 2025-11-11
|
||||
**Time invested:** ~40 hours
|
||||
**Lines refactored:** 1,368 → 85 + (9 mixins × ~89 avg lines)
|
||||
**Tests added:** 226 (125 for mixins, 39 for commands, 22 for undo, 40 for operations)
|
||||
**Tests passing:** 449/449 ✅
|
||||
**Coverage:** 6% → 50% (+44%)
|
||||
269
pyPhotoAlbum/EMBEDDED_TEMPLATES.md
Normal file
269
pyPhotoAlbum/EMBEDDED_TEMPLATES.md
Normal file
@ -0,0 +1,269 @@
|
||||
# Embedded Templates Feature
|
||||
|
||||
## Overview
|
||||
|
||||
The embedded templates feature allows templates to be stored within project files (.ppz) so they travel with the document. When loading projects, embedded templates take priority over local filesystem templates, ensuring projects can be opened on any machine without missing custom templates.
|
||||
|
||||
## Key Benefits
|
||||
|
||||
✓ **Portability**: Templates travel with project files
|
||||
✓ **Self-contained**: No dependency on local template files
|
||||
✓ **Priority**: Embedded templates override filesystem templates
|
||||
✓ **Automatic**: Templates are auto-embedded when used
|
||||
✓ **Backward Compatible**: Projects without embedded templates work as before
|
||||
|
||||
## How It Works
|
||||
|
||||
### Template Priority Order
|
||||
|
||||
When loading a template by name, the system checks in this order:
|
||||
|
||||
1. **Embedded templates** in the current project (highest priority)
|
||||
2. **User templates** in `~/.pyphotoalbum/templates/`
|
||||
3. **Built-in templates** in `pyPhotoAlbum/templates/`
|
||||
|
||||
### Automatic Embedding
|
||||
|
||||
Templates are automatically embedded in projects when:
|
||||
|
||||
- Applying a template to a page with `apply_template_to_page()`
|
||||
- Creating a new page from a template with `create_page_from_template()`
|
||||
|
||||
You can disable auto-embedding by passing `auto_embed=False` to these methods.
|
||||
|
||||
### Template Naming
|
||||
|
||||
Templates are listed with prefixes indicating their source:
|
||||
|
||||
- `[Embedded] Template Name` - Embedded in current project
|
||||
- `[Built-in] Template Name` - Built-in template
|
||||
- `Template Name` - User template from filesystem
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```python
|
||||
from pyPhotoAlbum.project import Project, Page
|
||||
from pyPhotoAlbum.template_manager import TemplateManager, Template
|
||||
|
||||
# Create a project
|
||||
project = Project(name="My Album")
|
||||
|
||||
# Create template manager with project
|
||||
template_manager = TemplateManager(project=project)
|
||||
|
||||
# Create a page from a template (auto-embeds by default)
|
||||
template = template_manager.load_template("Grid_2x2")
|
||||
page = template_manager.create_page_from_template(template, page_number=1)
|
||||
project.add_page(page)
|
||||
|
||||
# The template is now embedded in the project!
|
||||
print(project.embedded_templates.keys())
|
||||
# Output: dict_keys(['Grid_2x2'])
|
||||
```
|
||||
|
||||
### Manual Embedding
|
||||
|
||||
```python
|
||||
# Manually embed a template
|
||||
template = Template(name="Custom Layout")
|
||||
# ... configure template ...
|
||||
template_manager.embed_template(template)
|
||||
```
|
||||
|
||||
### Saving Templates
|
||||
|
||||
```python
|
||||
# Save to filesystem (default)
|
||||
template_manager.save_template(template)
|
||||
|
||||
# Or embed in project instead
|
||||
template_manager.save_template(template, embed_in_project=True)
|
||||
```
|
||||
|
||||
### Listing Templates
|
||||
|
||||
```python
|
||||
# List all available templates
|
||||
templates = template_manager.list_templates()
|
||||
# Returns: ['[Embedded] Custom', '[Built-in] Grid_2x2', 'MyUserTemplate', ...]
|
||||
```
|
||||
|
||||
### Loading Templates
|
||||
|
||||
```python
|
||||
# Load embedded template (priority)
|
||||
template = template_manager.load_template("Custom")
|
||||
|
||||
# Load with explicit prefix
|
||||
template = template_manager.load_template("[Embedded] Custom")
|
||||
template = template_manager.load_template("[Built-in] Grid_2x2")
|
||||
```
|
||||
|
||||
### Disabling Auto-Embed
|
||||
|
||||
```python
|
||||
# Don't auto-embed when applying template
|
||||
template_manager.apply_template_to_page(
|
||||
template,
|
||||
page,
|
||||
auto_embed=False
|
||||
)
|
||||
|
||||
# Don't auto-embed when creating page
|
||||
page = template_manager.create_page_from_template(
|
||||
template,
|
||||
page_number=1,
|
||||
auto_embed=False
|
||||
)
|
||||
```
|
||||
|
||||
## Project Serialization
|
||||
|
||||
Embedded templates are automatically serialized when saving projects:
|
||||
|
||||
```python
|
||||
# Save project to ZIP file
|
||||
from pyPhotoAlbum.project_serializer import save_to_zip
|
||||
|
||||
save_to_zip(project, "myalbum.ppz")
|
||||
# Embedded templates are included in the .ppz file
|
||||
```
|
||||
|
||||
When loading:
|
||||
|
||||
```python
|
||||
from pyPhotoAlbum.project_serializer import load_from_zip
|
||||
|
||||
project, error = load_from_zip("myalbum.ppz")
|
||||
# Embedded templates are automatically restored
|
||||
|
||||
# Create template manager to access them
|
||||
template_manager = TemplateManager(project=project)
|
||||
templates = template_manager.list_templates()
|
||||
```
|
||||
|
||||
## Data Structure
|
||||
|
||||
Embedded templates are stored in the project's `embedded_templates` dictionary:
|
||||
|
||||
```python
|
||||
project.embedded_templates = {
|
||||
"Template Name": {
|
||||
"name": "Template Name",
|
||||
"description": "Template description",
|
||||
"page_size_mm": [210, 297],
|
||||
"elements": [
|
||||
{
|
||||
"type": "placeholder",
|
||||
"position": [10, 10],
|
||||
"size": [100, 100],
|
||||
# ... more element data
|
||||
},
|
||||
# ... more elements
|
||||
]
|
||||
},
|
||||
# ... more templates
|
||||
}
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### TemplateManager
|
||||
|
||||
#### Constructor
|
||||
```python
|
||||
TemplateManager(project=None)
|
||||
```
|
||||
Create a template manager. Pass a `Project` instance to enable embedded template support.
|
||||
|
||||
#### Methods
|
||||
|
||||
**`embed_template(template: Template)`**
|
||||
Manually embed a template in the project.
|
||||
|
||||
**`load_template(name: str) -> Template`**
|
||||
Load a template by name. Checks embedded templates first, then filesystem.
|
||||
|
||||
**`list_templates() -> List[str]`**
|
||||
List all available templates with source prefixes.
|
||||
|
||||
**`save_template(template: Template, embed_in_project: bool = False)`**
|
||||
Save template to filesystem or embed in project.
|
||||
|
||||
**`delete_template(name: str)`**
|
||||
Delete a template (works with embedded and user templates).
|
||||
|
||||
**`apply_template_to_page(template, page, mode="replace", scale_mode="proportional", margin_percent=2.5, auto_embed=True)`**
|
||||
Apply template to a page. Auto-embeds by default.
|
||||
|
||||
**`create_page_from_template(template, page_number=1, target_size_mm=None, scale_mode="proportional", auto_embed=True) -> Page`**
|
||||
Create a new page from template. Auto-embeds by default.
|
||||
|
||||
### Project
|
||||
|
||||
#### Attributes
|
||||
|
||||
**`embedded_templates: Dict[str, Dict[str, Any]]`**
|
||||
Dictionary storing embedded template definitions.
|
||||
|
||||
## Migration Guide
|
||||
|
||||
### Existing Projects
|
||||
|
||||
Existing projects without embedded templates will continue to work normally. Templates will be auto-embedded when:
|
||||
|
||||
1. You apply a template to a page
|
||||
2. You create a new page from a template
|
||||
3. You manually embed a template
|
||||
|
||||
### Sharing Projects
|
||||
|
||||
When sharing projects:
|
||||
|
||||
1. Templates are automatically embedded when used
|
||||
2. Save the project to .ppz format
|
||||
3. Share the .ppz file
|
||||
4. Recipients can open the project and all templates are available
|
||||
|
||||
No manual steps required!
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Let auto-embed work**: The default behavior of auto-embedding templates ensures portability
|
||||
2. **Save projects after using templates**: Embedded templates are saved with the project
|
||||
3. **Use descriptive template names**: This helps identify templates in the list
|
||||
4. **Test on different machines**: Verify templates work when opening projects elsewhere
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Why isn't my template showing as embedded?**
|
||||
A: Ensure you're creating the TemplateManager with the project:
|
||||
```python
|
||||
template_manager = TemplateManager(project=project)
|
||||
```
|
||||
|
||||
**Q: Can I convert filesystem templates to embedded?**
|
||||
A: Yes, just load and embed them:
|
||||
```python
|
||||
template = template_manager.load_template("MyTemplate")
|
||||
template_manager.embed_template(template)
|
||||
```
|
||||
|
||||
**Q: What happens if I have templates with the same name?**
|
||||
A: Embedded templates take priority over filesystem templates with the same name.
|
||||
|
||||
**Q: Can I remove embedded templates?**
|
||||
A: Yes, use:
|
||||
```python
|
||||
template_manager.delete_template("[Embedded] Template Name")
|
||||
```
|
||||
|
||||
## Implementation Details
|
||||
|
||||
- Templates are stored as JSON in the project's `embedded_templates` dictionary
|
||||
- Serialization includes embedded templates in the project.json within .ppz files
|
||||
- Template manager checks embedded templates first when loading
|
||||
- Auto-embed only happens if the template isn't already embedded
|
||||
- All template operations preserve element properties (position, size, rotation, etc.)
|
||||
249
test_gnome_integration.sh
Executable file
249
test_gnome_integration.sh
Executable file
@ -0,0 +1,249 @@
|
||||
#!/bin/bash
|
||||
# Test script to verify GNOME integration for pyPhotoAlbum
|
||||
|
||||
set -e
|
||||
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
print_header() {
|
||||
echo -e "\n${BLUE}========================================${NC}"
|
||||
echo -e "${BLUE}$1${NC}"
|
||||
echo -e "${BLUE}========================================${NC}\n"
|
||||
}
|
||||
|
||||
print_success() {
|
||||
echo -e "${GREEN}✓${NC} $1"
|
||||
}
|
||||
|
||||
print_error() {
|
||||
echo -e "${RED}✗${NC} $1"
|
||||
}
|
||||
|
||||
print_warning() {
|
||||
echo -e "${YELLOW}⚠${NC} $1"
|
||||
}
|
||||
|
||||
print_info() {
|
||||
echo -e "${BLUE}ℹ${NC} $1"
|
||||
}
|
||||
|
||||
# Check counter
|
||||
PASSED=0
|
||||
FAILED=0
|
||||
WARNINGS=0
|
||||
|
||||
print_header "GNOME Integration Test for pyPhotoAlbum"
|
||||
|
||||
# Test 1: Check if desktop file exists
|
||||
print_header "1. Desktop File Installation"
|
||||
|
||||
if [ -f ~/.local/share/applications/pyphotoalbum.desktop ]; then
|
||||
print_success "Desktop file found in user directory"
|
||||
DESKTOP_FILE=~/.local/share/applications/pyphotoalbum.desktop
|
||||
((PASSED++))
|
||||
elif [ -f /usr/share/applications/pyphotoalbum.desktop ]; then
|
||||
print_success "Desktop file found in system directory"
|
||||
DESKTOP_FILE=/usr/share/applications/pyphotoalbum.desktop
|
||||
((PASSED++))
|
||||
else
|
||||
print_error "Desktop file not found"
|
||||
print_info "Expected locations:"
|
||||
echo " - ~/.local/share/applications/pyphotoalbum.desktop"
|
||||
echo " - /usr/share/applications/pyphotoalbum.desktop"
|
||||
((FAILED++))
|
||||
DESKTOP_FILE=""
|
||||
fi
|
||||
|
||||
# Test 2: Validate desktop file
|
||||
print_header "2. Desktop File Validation"
|
||||
|
||||
if [ -n "$DESKTOP_FILE" ]; then
|
||||
if command -v desktop-file-validate &> /dev/null; then
|
||||
if desktop-file-validate "$DESKTOP_FILE" 2>/dev/null; then
|
||||
print_success "Desktop file is valid"
|
||||
((PASSED++))
|
||||
else
|
||||
print_warning "Desktop file has validation warnings"
|
||||
desktop-file-validate "$DESKTOP_FILE"
|
||||
((WARNINGS++))
|
||||
fi
|
||||
else
|
||||
print_warning "desktop-file-validate not installed (install desktop-file-utils)"
|
||||
((WARNINGS++))
|
||||
fi
|
||||
|
||||
# Check StartupWMClass
|
||||
if grep -q "StartupWMClass=pyPhotoAlbum" "$DESKTOP_FILE"; then
|
||||
print_success "StartupWMClass is set correctly"
|
||||
((PASSED++))
|
||||
else
|
||||
print_error "StartupWMClass not set correctly"
|
||||
((FAILED++))
|
||||
fi
|
||||
|
||||
# Check StartupNotify
|
||||
if grep -q "StartupNotify=true" "$DESKTOP_FILE"; then
|
||||
print_success "StartupNotify is enabled"
|
||||
((PASSED++))
|
||||
else
|
||||
print_warning "StartupNotify not enabled (better taskbar feedback)"
|
||||
((WARNINGS++))
|
||||
fi
|
||||
fi
|
||||
|
||||
# Test 3: Check icon installation
|
||||
print_header "3. Icon Installation"
|
||||
|
||||
ICON_FOUND=0
|
||||
ICON_SIZES=(16 22 24 32 48 64 128 256 512)
|
||||
|
||||
for size in "${ICON_SIZES[@]}"; do
|
||||
USER_ICON=~/.local/share/icons/hicolor/${size}x${size}/apps/pyphotoalbum.png
|
||||
SYSTEM_ICON=/usr/share/icons/hicolor/${size}x${size}/apps/pyphotoalbum.png
|
||||
|
||||
if [ -f "$USER_ICON" ]; then
|
||||
print_success "Found ${size}x${size} icon (user)"
|
||||
((ICON_FOUND++))
|
||||
elif [ -f "$SYSTEM_ICON" ]; then
|
||||
print_success "Found ${size}x${size} icon (system)"
|
||||
((ICON_FOUND++))
|
||||
fi
|
||||
done
|
||||
|
||||
if [ $ICON_FOUND -eq 0 ]; then
|
||||
print_error "No icons found"
|
||||
((FAILED++))
|
||||
elif [ $ICON_FOUND -lt 5 ]; then
|
||||
print_warning "Only $ICON_FOUND icon size(s) found (recommended: multiple sizes)"
|
||||
print_info "Run './generate_icons.sh' to create more sizes"
|
||||
((WARNINGS++))
|
||||
((PASSED++))
|
||||
else
|
||||
print_success "Multiple icon sizes installed ($ICON_FOUND sizes)"
|
||||
((PASSED++))
|
||||
fi
|
||||
|
||||
# Test 4: Check if application is in PATH
|
||||
print_header "4. Application Executable"
|
||||
|
||||
if command -v pyphotoalbum &> /dev/null; then
|
||||
print_success "pyphotoalbum command found in PATH"
|
||||
print_info "Location: $(which pyphotoalbum)"
|
||||
((PASSED++))
|
||||
else
|
||||
print_error "pyphotoalbum command not found in PATH"
|
||||
print_info "Make sure ~/.local/bin is in your PATH"
|
||||
echo " Add to ~/.bashrc: export PATH=\"\$HOME/.local/bin:\$PATH\""
|
||||
((FAILED++))
|
||||
fi
|
||||
|
||||
# Test 5: Check icon cache
|
||||
print_header "5. Icon Cache Status"
|
||||
|
||||
if command -v gtk-update-icon-cache &> /dev/null; then
|
||||
print_success "gtk-update-icon-cache is available"
|
||||
((PASSED++))
|
||||
|
||||
# Check cache timestamp
|
||||
if [ -f ~/.local/share/icons/hicolor/icon-theme.cache ]; then
|
||||
print_success "User icon cache exists"
|
||||
CACHE_TIME=$(stat -c %Y ~/.local/share/icons/hicolor/icon-theme.cache 2>/dev/null || stat -f %m ~/.local/share/icons/hicolor/icon-theme.cache 2>/dev/null)
|
||||
print_info "Last updated: $(date -d @$CACHE_TIME 2>/dev/null || date -r $CACHE_TIME 2>/dev/null)"
|
||||
((PASSED++))
|
||||
else
|
||||
print_warning "User icon cache not found (may need update)"
|
||||
print_info "Run: gtk-update-icon-cache ~/.local/share/icons/hicolor/"
|
||||
((WARNINGS++))
|
||||
fi
|
||||
else
|
||||
print_warning "gtk-update-icon-cache not found"
|
||||
print_info "Install gtk3 or gtk4 package"
|
||||
((WARNINGS++))
|
||||
fi
|
||||
|
||||
# Test 6: Check desktop database
|
||||
print_header "6. Desktop Database"
|
||||
|
||||
if command -v update-desktop-database &> /dev/null; then
|
||||
print_success "update-desktop-database is available"
|
||||
((PASSED++))
|
||||
else
|
||||
print_warning "update-desktop-database not found"
|
||||
print_info "Install desktop-file-utils package"
|
||||
((WARNINGS++))
|
||||
fi
|
||||
|
||||
# Test 7: Check GNOME Shell
|
||||
print_header "7. GNOME Environment"
|
||||
|
||||
if [ "$XDG_CURRENT_DESKTOP" = "GNOME" ]; then
|
||||
print_success "Running in GNOME desktop environment"
|
||||
((PASSED++))
|
||||
else
|
||||
print_info "Not running GNOME (detected: ${XDG_CURRENT_DESKTOP:-unknown})"
|
||||
print_info "This test is designed for GNOME but should work on other DEs"
|
||||
fi
|
||||
|
||||
if [ -n "$WAYLAND_DISPLAY" ]; then
|
||||
print_info "Running Wayland session"
|
||||
elif [ -n "$DISPLAY" ]; then
|
||||
print_info "Running X11 session"
|
||||
fi
|
||||
|
||||
# Test 8: Test application launch
|
||||
print_header "8. Application Launch Test"
|
||||
|
||||
if command -v pyphotoalbum &> /dev/null; then
|
||||
print_info "To test the application, run: pyphotoalbum"
|
||||
print_info "Check if:"
|
||||
echo " 1. Icon appears in taskbar"
|
||||
echo " 2. Window title matches application name"
|
||||
echo " 3. Alt+Tab shows correct icon and name"
|
||||
echo " 4. Application appears in GNOME Activities search"
|
||||
else
|
||||
print_error "Cannot test - application not installed"
|
||||
((FAILED++))
|
||||
fi
|
||||
|
||||
# Summary
|
||||
print_header "Test Summary"
|
||||
|
||||
TOTAL=$((PASSED + FAILED))
|
||||
echo -e "${GREEN}Passed:${NC} $PASSED"
|
||||
echo -e "${RED}Failed:${NC} $FAILED"
|
||||
echo -e "${YELLOW}Warnings:${NC} $WARNINGS"
|
||||
echo ""
|
||||
|
||||
if [ $FAILED -eq 0 ]; then
|
||||
if [ $WARNINGS -eq 0 ]; then
|
||||
echo -e "${GREEN}✓ All tests passed! GNOME integration is properly configured.${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ Tests passed with warnings. Integration should work but can be improved.${NC}"
|
||||
fi
|
||||
else
|
||||
echo -e "${RED}✗ Some tests failed. Please fix the issues above.${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Additional recommendations
|
||||
print_header "Recommendations"
|
||||
|
||||
echo "For best GNOME integration:"
|
||||
echo " 1. Generate multiple icon sizes:"
|
||||
echo " ./generate_icons.sh"
|
||||
echo ""
|
||||
echo " 2. After installation, log out and log back in"
|
||||
echo " or restart GNOME Shell (Alt+F2, type 'r', Enter)"
|
||||
echo ""
|
||||
echo " 3. If icon doesn't appear, clear icon cache:"
|
||||
echo " rm ~/.cache/icon-cache.kcache"
|
||||
echo " gtk-update-icon-cache -f ~/.local/share/icons/hicolor/"
|
||||
echo ""
|
||||
echo " 4. Search for 'pyPhotoAlbum' in GNOME Activities"
|
||||
echo ""
|
||||
echo " 5. Pin to favorites by right-clicking the icon in Activities"
|
||||
echo ""
|
||||
@ -228,6 +228,44 @@ class TestGetElementAt:
|
||||
result = widget._get_element_at(351, 301)
|
||||
assert result is None
|
||||
|
||||
def test_get_element_at_rotated_element(self, qtbot, mock_page_renderer):
|
||||
"""Test _get_element_at handles rotated elements correctly"""
|
||||
widget = TestSelectionWidget()
|
||||
qtbot.addWidget(widget)
|
||||
|
||||
page = Page(layout=PageLayout(width=210, height=297), page_number=1)
|
||||
# Create element rotated 45 degrees
|
||||
elem = ImageData(image_path="test.jpg", x=100, y=100, width=200, height=150)
|
||||
elem.rotation = 45
|
||||
page.layout.add_element(elem)
|
||||
|
||||
widget._page_renderers = [(mock_page_renderer, page)]
|
||||
|
||||
# Click at center of rotated element (should still be inside)
|
||||
# Center is at (100 + 200/2, 100 + 150/2) = (200, 175) in page coords
|
||||
# Screen coords: (50 + 200, 50 + 175) = (250, 225)
|
||||
result = widget._get_element_at(250, 225)
|
||||
assert result == elem
|
||||
assert hasattr(result, '_page_renderer')
|
||||
assert hasattr(result, '_parent_page')
|
||||
|
||||
def test_get_element_at_rotated_element_outside(self, qtbot, mock_page_renderer):
|
||||
"""Test _get_element_at correctly rejects clicks outside rotated element"""
|
||||
widget = TestSelectionWidget()
|
||||
qtbot.addWidget(widget)
|
||||
|
||||
page = Page(layout=PageLayout(width=210, height=297), page_number=1)
|
||||
# Create element rotated 90 degrees
|
||||
elem = ImageData(image_path="test.jpg", x=100, y=100, width=200, height=150)
|
||||
elem.rotation = 90
|
||||
page.layout.add_element(elem)
|
||||
|
||||
widget._page_renderers = [(mock_page_renderer, page)]
|
||||
|
||||
# Click far outside element
|
||||
result = widget._get_element_at(500, 500)
|
||||
assert result is None
|
||||
|
||||
|
||||
class TestGetResizeHandleAt:
|
||||
"""Test _get_resize_handle_at method"""
|
||||
@ -350,6 +388,55 @@ class TestGetResizeHandleAt:
|
||||
result = widget._get_resize_handle_at(250, 225)
|
||||
assert result is None
|
||||
|
||||
def test_get_resize_handle_rotated_element(self, qtbot, mock_page_renderer):
|
||||
"""Test _get_resize_handle_at handles rotated elements"""
|
||||
widget = TestSelectionWidget()
|
||||
qtbot.addWidget(widget)
|
||||
|
||||
elem = ImageData(image_path="test.jpg", x=100, y=100, width=200, height=150)
|
||||
elem.rotation = 45
|
||||
elem._page_renderer = mock_page_renderer
|
||||
widget.selected_element = elem
|
||||
|
||||
# Mock window
|
||||
from pyPhotoAlbum.project import Project, Page
|
||||
from pyPhotoAlbum.page_layout import PageLayout
|
||||
mock_window = Mock()
|
||||
mock_window.project = Project(name="Test")
|
||||
page = Page(layout=PageLayout(width=210, height=297), page_number=1)
|
||||
mock_window.project.pages = [page]
|
||||
widget.window = Mock(return_value=mock_window)
|
||||
|
||||
# The rotation code should still detect handles - test NW handle
|
||||
# For rotated element, the handle positions are transformed
|
||||
result = widget._get_resize_handle_at(150, 150)
|
||||
# Should detect a handle (exact handle depends on rotation transform)
|
||||
assert result is None or result in ['nw', 'ne', 'sw', 'se']
|
||||
|
||||
def test_get_resize_handle_rotated_90_degrees(self, qtbot, mock_page_renderer):
|
||||
"""Test _get_resize_handle_at handles 90-degree rotated elements"""
|
||||
widget = TestSelectionWidget()
|
||||
qtbot.addWidget(widget)
|
||||
|
||||
elem = ImageData(image_path="test.jpg", x=100, y=100, width=200, height=150)
|
||||
elem.rotation = 90
|
||||
elem._page_renderer = mock_page_renderer
|
||||
widget.selected_element = elem
|
||||
|
||||
# Mock window
|
||||
from pyPhotoAlbum.project import Project, Page
|
||||
from pyPhotoAlbum.page_layout import PageLayout
|
||||
mock_window = Mock()
|
||||
mock_window.project = Project(name="Test")
|
||||
page = Page(layout=PageLayout(width=210, height=297), page_number=1)
|
||||
mock_window.project.pages = [page]
|
||||
widget.window = Mock(return_value=mock_window)
|
||||
|
||||
# Test clicking at various positions - rotation code should handle them
|
||||
# Just verify the method runs without crashing
|
||||
result = widget._get_resize_handle_at(200, 200)
|
||||
assert result is None or result in ['nw', 'ne', 'sw', 'se']
|
||||
|
||||
|
||||
class TestMultiSelect:
|
||||
"""Test multi-selection functionality"""
|
||||
|
||||
473
tests/test_page_layout.py
Normal file
473
tests/test_page_layout.py
Normal file
@ -0,0 +1,473 @@
|
||||
"""
|
||||
Tests for PageLayout and GridLayout classes
|
||||
"""
|
||||
|
||||
import pytest
|
||||
from pyPhotoAlbum.page_layout import PageLayout, GridLayout
|
||||
from pyPhotoAlbum.models import ImageData, PlaceholderData, TextBoxData
|
||||
from pyPhotoAlbum.snapping import SnappingSystem
|
||||
|
||||
|
||||
class TestPageLayoutInitialization:
|
||||
"""Test PageLayout initialization"""
|
||||
|
||||
def test_initialization_default(self):
|
||||
"""Test PageLayout with default values"""
|
||||
layout = PageLayout()
|
||||
assert layout.size == (210, 297)
|
||||
assert layout.base_width == 210
|
||||
assert layout.is_facing_page is False
|
||||
assert layout.elements == []
|
||||
assert layout.grid_layout is None
|
||||
assert layout.background_color == (1.0, 1.0, 1.0)
|
||||
assert isinstance(layout.snapping_system, SnappingSystem)
|
||||
assert layout.show_snap_lines is True
|
||||
|
||||
def test_initialization_custom_size(self):
|
||||
"""Test PageLayout with custom dimensions"""
|
||||
layout = PageLayout(width=150, height=200)
|
||||
assert layout.size == (150, 200)
|
||||
assert layout.base_width == 150
|
||||
assert layout.is_facing_page is False
|
||||
|
||||
def test_initialization_facing_page(self):
|
||||
"""Test PageLayout as facing page (double width)"""
|
||||
layout = PageLayout(width=210, height=297, is_facing_page=True)
|
||||
assert layout.size == (420, 297) # Width doubled
|
||||
assert layout.base_width == 210
|
||||
assert layout.is_facing_page is True
|
||||
|
||||
|
||||
class TestElementManagement:
|
||||
"""Test element add/remove operations"""
|
||||
|
||||
def test_add_element(self):
|
||||
"""Test adding element to layout"""
|
||||
layout = PageLayout()
|
||||
elem = ImageData(image_path="test.jpg")
|
||||
|
||||
layout.add_element(elem)
|
||||
|
||||
assert len(layout.elements) == 1
|
||||
assert layout.elements[0] == elem
|
||||
|
||||
def test_add_multiple_elements(self):
|
||||
"""Test adding multiple elements"""
|
||||
layout = PageLayout()
|
||||
elem1 = ImageData(image_path="test1.jpg")
|
||||
elem2 = PlaceholderData()
|
||||
elem3 = TextBoxData(text_content="Hello")
|
||||
|
||||
layout.add_element(elem1)
|
||||
layout.add_element(elem2)
|
||||
layout.add_element(elem3)
|
||||
|
||||
assert len(layout.elements) == 3
|
||||
assert layout.elements[0] == elem1
|
||||
assert layout.elements[1] == elem2
|
||||
assert layout.elements[2] == elem3
|
||||
|
||||
def test_remove_element(self):
|
||||
"""Test removing element from layout"""
|
||||
layout = PageLayout()
|
||||
elem1 = ImageData(image_path="test1.jpg")
|
||||
elem2 = PlaceholderData()
|
||||
|
||||
layout.add_element(elem1)
|
||||
layout.add_element(elem2)
|
||||
|
||||
layout.remove_element(elem1)
|
||||
|
||||
assert len(layout.elements) == 1
|
||||
assert layout.elements[0] == elem2
|
||||
|
||||
def test_remove_element_not_in_list_raises_error(self):
|
||||
"""Test removing non-existent element raises error"""
|
||||
layout = PageLayout()
|
||||
elem = ImageData(image_path="test.jpg")
|
||||
|
||||
with pytest.raises(ValueError):
|
||||
layout.remove_element(elem)
|
||||
|
||||
|
||||
class TestGridLayout:
|
||||
"""Test setting grid layout"""
|
||||
|
||||
def test_set_grid_layout(self):
|
||||
"""Test setting a grid layout"""
|
||||
layout = PageLayout()
|
||||
grid = GridLayout(rows=2, columns=3)
|
||||
|
||||
layout.set_grid_layout(grid)
|
||||
|
||||
assert layout.grid_layout == grid
|
||||
assert layout.grid_layout.rows == 2
|
||||
assert layout.grid_layout.columns == 3
|
||||
|
||||
|
||||
class TestPageLayoutSerialization:
|
||||
"""Test PageLayout serialization"""
|
||||
|
||||
def test_serialize_empty_layout(self):
|
||||
"""Test serializing empty layout"""
|
||||
layout = PageLayout(width=210, height=297)
|
||||
data = layout.serialize()
|
||||
|
||||
assert data["size"] == (210, 297)
|
||||
assert data["base_width"] == 210
|
||||
assert data["is_facing_page"] is False
|
||||
assert data["background_color"] == (1.0, 1.0, 1.0)
|
||||
assert data["elements"] == []
|
||||
assert data["grid_layout"] is None
|
||||
assert "snapping_system" in data
|
||||
assert data["show_snap_lines"] is True
|
||||
|
||||
def test_serialize_with_elements(self):
|
||||
"""Test serializing layout with elements"""
|
||||
layout = PageLayout()
|
||||
elem1 = ImageData(image_path="test1.jpg", x=10, y=20)
|
||||
elem2 = PlaceholderData(x=30, y=40)
|
||||
|
||||
layout.add_element(elem1)
|
||||
layout.add_element(elem2)
|
||||
|
||||
data = layout.serialize()
|
||||
|
||||
assert len(data["elements"]) == 2
|
||||
assert data["elements"][0]["type"] == "image"
|
||||
assert data["elements"][1]["type"] == "placeholder"
|
||||
|
||||
def test_serialize_with_grid_layout(self):
|
||||
"""Test serializing layout with grid"""
|
||||
layout = PageLayout()
|
||||
grid = GridLayout(rows=3, columns=2, spacing=15.0)
|
||||
layout.set_grid_layout(grid)
|
||||
|
||||
data = layout.serialize()
|
||||
|
||||
assert data["grid_layout"] is not None
|
||||
assert data["grid_layout"]["rows"] == 3
|
||||
assert data["grid_layout"]["columns"] == 2
|
||||
assert data["grid_layout"]["spacing"] == 15.0
|
||||
|
||||
def test_serialize_facing_page(self):
|
||||
"""Test serializing facing page layout"""
|
||||
layout = PageLayout(width=210, height=297, is_facing_page=True)
|
||||
data = layout.serialize()
|
||||
|
||||
assert data["size"] == (420, 297)
|
||||
assert data["base_width"] == 210
|
||||
assert data["is_facing_page"] is True
|
||||
|
||||
|
||||
class TestPageLayoutDeserialization:
|
||||
"""Test PageLayout deserialization"""
|
||||
|
||||
def test_deserialize_basic_layout(self):
|
||||
"""Test deserializing basic layout"""
|
||||
layout = PageLayout()
|
||||
data = {
|
||||
"size": (150, 200),
|
||||
"base_width": 150,
|
||||
"is_facing_page": False,
|
||||
"background_color": (0.9, 0.9, 0.9),
|
||||
"elements": [],
|
||||
"grid_layout": None,
|
||||
"snapping_system": {},
|
||||
"show_snap_lines": False
|
||||
}
|
||||
|
||||
layout.deserialize(data)
|
||||
|
||||
assert layout.size == (150, 200)
|
||||
assert layout.base_width == 150
|
||||
assert layout.is_facing_page is False
|
||||
assert layout.background_color == (0.9, 0.9, 0.9)
|
||||
assert layout.show_snap_lines is False
|
||||
|
||||
def test_deserialize_with_elements(self):
|
||||
"""Test deserializing layout with elements"""
|
||||
layout = PageLayout()
|
||||
data = {
|
||||
"size": (210, 297),
|
||||
"elements": [
|
||||
{
|
||||
"type": "image",
|
||||
"image_path": "test1.jpg",
|
||||
"position": (10, 20),
|
||||
"size": (100, 100),
|
||||
"rotation": 0,
|
||||
"z_index": 0,
|
||||
"crop_info": (0, 0, 1, 1)
|
||||
},
|
||||
{
|
||||
"type": "placeholder",
|
||||
"placeholder_type": "image",
|
||||
"default_content": "",
|
||||
"position": (30, 40),
|
||||
"size": (80, 80),
|
||||
"rotation": 0,
|
||||
"z_index": 1
|
||||
},
|
||||
{
|
||||
"type": "textbox",
|
||||
"text_content": "Hello",
|
||||
"font_settings": {"family": "Arial", "size": 12, "color": (0, 0, 0)},
|
||||
"alignment": "left",
|
||||
"position": (50, 60),
|
||||
"size": (120, 40),
|
||||
"rotation": 0,
|
||||
"z_index": 2
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
layout.deserialize(data)
|
||||
|
||||
assert len(layout.elements) == 3
|
||||
assert isinstance(layout.elements[0], ImageData)
|
||||
assert isinstance(layout.elements[1], PlaceholderData)
|
||||
assert isinstance(layout.elements[2], TextBoxData)
|
||||
|
||||
def test_deserialize_elements_sorted_by_z_index(self):
|
||||
"""Test elements are sorted by z_index during deserialization"""
|
||||
layout = PageLayout()
|
||||
data = {
|
||||
"size": (210, 297),
|
||||
"elements": [
|
||||
{
|
||||
"type": "image",
|
||||
"image_path": "test1.jpg",
|
||||
"position": (10, 20),
|
||||
"size": (100, 100),
|
||||
"rotation": 0,
|
||||
"z_index": 5, # Higher z_index
|
||||
"crop_info": (0, 0, 1, 1)
|
||||
},
|
||||
{
|
||||
"type": "placeholder",
|
||||
"placeholder_type": "image",
|
||||
"default_content": "",
|
||||
"position": (30, 40),
|
||||
"size": (80, 80),
|
||||
"rotation": 0,
|
||||
"z_index": 1 # Lower z_index - should be first
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
layout.deserialize(data)
|
||||
|
||||
assert len(layout.elements) == 2
|
||||
# Lower z_index should come first in list
|
||||
assert layout.elements[0].z_index == 1
|
||||
assert layout.elements[1].z_index == 5
|
||||
|
||||
def test_deserialize_with_grid_layout(self):
|
||||
"""Test deserializing layout with grid"""
|
||||
layout = PageLayout()
|
||||
data = {
|
||||
"size": (210, 297),
|
||||
"elements": [],
|
||||
"grid_layout": {
|
||||
"rows": 2,
|
||||
"columns": 3,
|
||||
"spacing": 12.5,
|
||||
"merged_cells": [(0, 0), (1, 1)]
|
||||
}
|
||||
}
|
||||
|
||||
layout.deserialize(data)
|
||||
|
||||
assert layout.grid_layout is not None
|
||||
assert layout.grid_layout.rows == 2
|
||||
assert layout.grid_layout.columns == 3
|
||||
assert layout.grid_layout.spacing == 12.5
|
||||
assert layout.grid_layout.merged_cells == [(0, 0), (1, 1)]
|
||||
|
||||
def test_deserialize_unknown_element_type_skipped(self):
|
||||
"""Test that unknown element types are skipped"""
|
||||
layout = PageLayout()
|
||||
data = {
|
||||
"size": (210, 297),
|
||||
"elements": [
|
||||
{
|
||||
"type": "unknown_type",
|
||||
"position": (10, 20)
|
||||
},
|
||||
{
|
||||
"type": "image",
|
||||
"image_path": "test.jpg",
|
||||
"position": (30, 40),
|
||||
"size": (100, 100),
|
||||
"rotation": 0,
|
||||
"z_index": 0,
|
||||
"crop_info": (0, 0, 1, 1)
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
layout.deserialize(data)
|
||||
|
||||
# Only valid element should be deserialized
|
||||
assert len(layout.elements) == 1
|
||||
assert isinstance(layout.elements[0], ImageData)
|
||||
|
||||
def test_deserialize_with_defaults(self):
|
||||
"""Test deserialization with missing fields uses defaults"""
|
||||
layout = PageLayout()
|
||||
data = {}
|
||||
|
||||
layout.deserialize(data)
|
||||
|
||||
assert layout.size == (210, 297)
|
||||
assert layout.background_color == (1.0, 1.0, 1.0)
|
||||
assert layout.show_snap_lines is True
|
||||
|
||||
|
||||
class TestSerializationRoundtrip:
|
||||
"""Test serialization/deserialization roundtrips"""
|
||||
|
||||
def test_serialize_deserialize_roundtrip(self):
|
||||
"""Test that serialize/deserialize are inverse operations"""
|
||||
original = PageLayout(width=200, height=280, is_facing_page=False)
|
||||
original.background_color = (0.95, 0.95, 0.95)
|
||||
original.show_snap_lines = False
|
||||
|
||||
elem1 = ImageData(image_path="test.jpg", x=10, y=20, width=100, height=80)
|
||||
elem2 = PlaceholderData(x=30, y=40, width=50, height=50)
|
||||
original.add_element(elem1)
|
||||
original.add_element(elem2)
|
||||
|
||||
grid = GridLayout(rows=2, columns=3, spacing=10.0)
|
||||
original.set_grid_layout(grid)
|
||||
|
||||
# Serialize and deserialize
|
||||
data = original.serialize()
|
||||
restored = PageLayout()
|
||||
restored.deserialize(data)
|
||||
|
||||
# Verify restoration
|
||||
assert restored.size == original.size
|
||||
assert restored.base_width == original.base_width
|
||||
assert restored.is_facing_page == original.is_facing_page
|
||||
assert restored.background_color == original.background_color
|
||||
assert restored.show_snap_lines == original.show_snap_lines
|
||||
assert len(restored.elements) == len(original.elements)
|
||||
assert restored.grid_layout is not None
|
||||
assert restored.grid_layout.rows == original.grid_layout.rows
|
||||
|
||||
|
||||
class TestGridLayoutClass:
|
||||
"""Test GridLayout class"""
|
||||
|
||||
def test_initialization_default(self):
|
||||
"""Test GridLayout initialization with defaults"""
|
||||
grid = GridLayout()
|
||||
assert grid.rows == 1
|
||||
assert grid.columns == 1
|
||||
assert grid.spacing == 10.0
|
||||
assert grid.merged_cells == []
|
||||
|
||||
def test_initialization_custom(self):
|
||||
"""Test GridLayout initialization with custom values"""
|
||||
grid = GridLayout(rows=3, columns=4, spacing=15.5)
|
||||
assert grid.rows == 3
|
||||
assert grid.columns == 4
|
||||
assert grid.spacing == 15.5
|
||||
|
||||
def test_merge_cells(self):
|
||||
"""Test merging cells in grid"""
|
||||
grid = GridLayout(rows=3, columns=3)
|
||||
|
||||
grid.merge_cells(0, 0)
|
||||
grid.merge_cells(1, 1)
|
||||
|
||||
assert len(grid.merged_cells) == 2
|
||||
assert (0, 0) in grid.merged_cells
|
||||
assert (1, 1) in grid.merged_cells
|
||||
|
||||
def test_get_cell_position(self):
|
||||
"""Test calculating cell position"""
|
||||
grid = GridLayout(rows=2, columns=2, spacing=10.0)
|
||||
|
||||
# Cell (0, 0) - top left
|
||||
x, y = grid.get_cell_position(0, 0, page_width=800, page_height=600)
|
||||
assert x == 10.0 # spacing
|
||||
assert y == 10.0 # spacing
|
||||
|
||||
# Cell (0, 1) - top right
|
||||
x, y = grid.get_cell_position(0, 1, page_width=800, page_height=600)
|
||||
# spacing + col * (cell_width + spacing)
|
||||
# cell_width = (800 - 30) / 2 = 385
|
||||
# x = 10 + 1 * (385 + 10) = 405
|
||||
assert x == 405.0
|
||||
|
||||
def test_get_cell_size(self):
|
||||
"""Test calculating cell size"""
|
||||
grid = GridLayout(rows=2, columns=3, spacing=10.0)
|
||||
|
||||
width, height = grid.get_cell_size(page_width=900, page_height=600)
|
||||
|
||||
# width = (900 - 10 * 4) / 3 = 860 / 3 ≈ 286.67
|
||||
# height = (600 - 10 * 3) / 2 = 570 / 2 = 285
|
||||
assert width == pytest.approx(286.666, rel=0.01)
|
||||
assert height == 285.0
|
||||
|
||||
def test_grid_serialization(self):
|
||||
"""Test GridLayout serialization"""
|
||||
grid = GridLayout(rows=3, columns=2, spacing=12.0)
|
||||
grid.merge_cells(0, 1)
|
||||
grid.merge_cells(2, 0)
|
||||
|
||||
data = grid.serialize()
|
||||
|
||||
assert data["rows"] == 3
|
||||
assert data["columns"] == 2
|
||||
assert data["spacing"] == 12.0
|
||||
assert data["merged_cells"] == [(0, 1), (2, 0)]
|
||||
|
||||
def test_grid_deserialization(self):
|
||||
"""Test GridLayout deserialization"""
|
||||
grid = GridLayout()
|
||||
data = {
|
||||
"rows": 4,
|
||||
"columns": 5,
|
||||
"spacing": 8.5,
|
||||
"merged_cells": [(1, 2), (3, 3)]
|
||||
}
|
||||
|
||||
grid.deserialize(data)
|
||||
|
||||
assert grid.rows == 4
|
||||
assert grid.columns == 5
|
||||
assert grid.spacing == 8.5
|
||||
assert grid.merged_cells == [(1, 2), (3, 3)]
|
||||
|
||||
def test_grid_deserialization_with_defaults(self):
|
||||
"""Test GridLayout deserialization with missing fields"""
|
||||
grid = GridLayout()
|
||||
data = {}
|
||||
|
||||
grid.deserialize(data)
|
||||
|
||||
assert grid.rows == 1
|
||||
assert grid.columns == 1
|
||||
assert grid.spacing == 10.0
|
||||
assert grid.merged_cells == []
|
||||
|
||||
def test_grid_serialize_deserialize_roundtrip(self):
|
||||
"""Test GridLayout serialize/deserialize roundtrip"""
|
||||
original = GridLayout(rows=3, columns=4, spacing=11.5)
|
||||
original.merge_cells(0, 0)
|
||||
original.merge_cells(1, 2)
|
||||
original.merge_cells(2, 3)
|
||||
|
||||
data = original.serialize()
|
||||
restored = GridLayout()
|
||||
restored.deserialize(data)
|
||||
|
||||
assert restored.rows == original.rows
|
||||
assert restored.columns == original.columns
|
||||
assert restored.spacing == original.spacing
|
||||
assert restored.merged_cells == original.merged_cells
|
||||
474
tests/test_view_ops_mixin.py
Normal file
474
tests/test_view_ops_mixin.py
Normal file
@ -0,0 +1,474 @@
|
||||
"""
|
||||
Tests for ViewOperationsMixin
|
||||
"""
|
||||
|
||||
import pytest
|
||||
from unittest.mock import Mock, patch
|
||||
from PyQt6.QtWidgets import QMainWindow, QDialog
|
||||
from pyPhotoAlbum.mixins.operations.view_ops import ViewOperationsMixin
|
||||
from pyPhotoAlbum.project import Project, Page
|
||||
from pyPhotoAlbum.page_layout import PageLayout
|
||||
|
||||
|
||||
class TestViewWindow(ViewOperationsMixin, QMainWindow):
|
||||
"""Test window with view operations mixin"""
|
||||
|
||||
def __init__(self):
|
||||
super().__init__()
|
||||
self.gl_widget = Mock()
|
||||
self.gl_widget.zoom_level = 1.0
|
||||
self.gl_widget.current_page_index = 0
|
||||
self.gl_widget.width = Mock(return_value=800)
|
||||
self.gl_widget.height = Mock(return_value=600)
|
||||
self.project = Mock(spec=Project)
|
||||
self.project.working_dpi = 300
|
||||
self._update_view_called = False
|
||||
self._status_message = None
|
||||
|
||||
def get_current_page(self):
|
||||
if hasattr(self, '_current_page'):
|
||||
return self._current_page
|
||||
return None
|
||||
|
||||
def update_view(self):
|
||||
self._update_view_called = True
|
||||
|
||||
def show_status(self, message, timeout=0):
|
||||
self._status_message = message
|
||||
|
||||
|
||||
class TestZoomOperations:
|
||||
"""Test zoom operations"""
|
||||
|
||||
def test_zoom_in_success(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window.gl_widget.zoom_level = 1.0
|
||||
|
||||
window.zoom_in()
|
||||
|
||||
assert window.gl_widget.zoom_level == 1.2
|
||||
assert window._update_view_called
|
||||
assert "120%" in window._status_message
|
||||
|
||||
def test_zoom_in_max_limit(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window.gl_widget.zoom_level = 4.5
|
||||
|
||||
window.zoom_in()
|
||||
|
||||
# 4.5 * 1.2 = 5.4, but clamped to 5.0
|
||||
assert window.gl_widget.zoom_level == 5.0
|
||||
assert window._update_view_called
|
||||
|
||||
def test_zoom_out_success(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window.gl_widget.zoom_level = 1.2
|
||||
|
||||
window.zoom_out()
|
||||
|
||||
assert window.gl_widget.zoom_level == 1.0
|
||||
assert window._update_view_called
|
||||
assert "100%" in window._status_message
|
||||
|
||||
def test_zoom_out_min_limit(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window.gl_widget.zoom_level = 0.11
|
||||
|
||||
window.zoom_out()
|
||||
|
||||
# 0.11 / 1.2 ≈ 0.092, but clamped to 0.1
|
||||
assert window.gl_widget.zoom_level == 0.1
|
||||
assert window._update_view_called
|
||||
|
||||
def test_zoom_fit_success(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
# Setup page
|
||||
layout = PageLayout(width=210, height=297) # A4 in mm
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window.project.pages = [page]
|
||||
|
||||
window.zoom_fit()
|
||||
|
||||
# Should calculate zoom to fit page in widget
|
||||
assert window._update_view_called
|
||||
assert "zoom" in window._status_message.lower()
|
||||
# Zoom level should be set based on widget size
|
||||
assert 0.1 <= window.gl_widget.zoom_level <= 5.0
|
||||
|
||||
def test_zoom_fit_no_pages(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window.project.pages = []
|
||||
|
||||
window.zoom_fit()
|
||||
|
||||
# Should return early without error
|
||||
assert not window._update_view_called
|
||||
|
||||
|
||||
class TestSnappingToggles:
|
||||
"""Test snapping toggle operations"""
|
||||
|
||||
def test_toggle_grid_snap_enable(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_grid = False
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.toggle_grid_snap()
|
||||
|
||||
assert layout.snapping_system.snap_to_grid is True
|
||||
assert "enabled" in window._status_message.lower()
|
||||
assert window._update_view_called
|
||||
|
||||
def test_toggle_grid_snap_disable(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_grid = True
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.toggle_grid_snap()
|
||||
|
||||
assert layout.snapping_system.snap_to_grid is False
|
||||
assert "disabled" in window._status_message.lower()
|
||||
assert window._update_view_called
|
||||
|
||||
def test_toggle_grid_snap_no_page(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window._current_page = None
|
||||
|
||||
window.toggle_grid_snap()
|
||||
|
||||
assert not window._update_view_called
|
||||
|
||||
def test_toggle_edge_snap_enable(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_edges = False
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.toggle_edge_snap()
|
||||
|
||||
assert layout.snapping_system.snap_to_edges is True
|
||||
assert "enabled" in window._status_message.lower()
|
||||
assert window._update_view_called
|
||||
|
||||
def test_toggle_edge_snap_disable(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_edges = True
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.toggle_edge_snap()
|
||||
|
||||
assert layout.snapping_system.snap_to_edges is False
|
||||
assert "disabled" in window._status_message.lower()
|
||||
|
||||
def test_toggle_guide_snap_enable(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_guides = False
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.toggle_guide_snap()
|
||||
|
||||
assert layout.snapping_system.snap_to_guides is True
|
||||
assert "enabled" in window._status_message.lower()
|
||||
|
||||
def test_toggle_guide_snap_disable(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_guides = True
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.toggle_guide_snap()
|
||||
|
||||
assert layout.snapping_system.snap_to_guides is False
|
||||
assert "disabled" in window._status_message.lower()
|
||||
|
||||
def test_toggle_snap_lines_show(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.show_snap_lines = False
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.toggle_snap_lines()
|
||||
|
||||
assert layout.show_snap_lines is True
|
||||
assert "visible" in window._status_message.lower()
|
||||
|
||||
def test_toggle_snap_lines_hide(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.show_snap_lines = True
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.toggle_snap_lines()
|
||||
|
||||
assert layout.show_snap_lines is False
|
||||
assert "hidden" in window._status_message.lower()
|
||||
|
||||
|
||||
class TestGuideOperations:
|
||||
"""Test guide add/clear operations"""
|
||||
|
||||
def test_add_horizontal_guide(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout(width=210, height=297)
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.add_horizontal_guide()
|
||||
|
||||
# Guide should be added at vertical center (297 / 2 = 148.5mm)
|
||||
assert "148.5" in window._status_message
|
||||
assert window._update_view_called
|
||||
|
||||
def test_add_horizontal_guide_no_page(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window._current_page = None
|
||||
|
||||
window.add_horizontal_guide()
|
||||
|
||||
assert not window._update_view_called
|
||||
|
||||
def test_add_vertical_guide(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout(width=210, height=297)
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.add_vertical_guide()
|
||||
|
||||
# Guide should be added at horizontal center (210 / 2 = 105.0mm)
|
||||
assert "105.0" in window._status_message
|
||||
assert window._update_view_called
|
||||
|
||||
def test_add_vertical_guide_no_page(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window._current_page = None
|
||||
|
||||
window.add_vertical_guide()
|
||||
|
||||
assert not window._update_view_called
|
||||
|
||||
def test_clear_guides_with_guides(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
# Add some guides
|
||||
layout.snapping_system.add_guide(100, 'vertical')
|
||||
layout.snapping_system.add_guide(150, 'horizontal')
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.clear_guides()
|
||||
|
||||
assert len(layout.snapping_system.guides) == 0
|
||||
assert "2" in window._status_message # Cleared 2 guides
|
||||
assert window._update_view_called
|
||||
|
||||
def test_clear_guides_no_guides(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.clear_guides()
|
||||
|
||||
assert "0" in window._status_message
|
||||
assert window._update_view_called
|
||||
|
||||
def test_clear_guides_no_page(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window._current_page = None
|
||||
|
||||
window.clear_guides()
|
||||
|
||||
assert not window._update_view_called
|
||||
|
||||
|
||||
class TestGridSettingsDialog:
|
||||
"""Test grid settings dialog"""
|
||||
|
||||
def test_set_grid_size_no_page(self, qtbot):
|
||||
"""Test set_grid_size with no current page"""
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
window._current_page = None
|
||||
|
||||
window.set_grid_size()
|
||||
|
||||
# Should return early without error
|
||||
assert not window._update_view_called
|
||||
|
||||
def test_set_grid_size_with_page(self, qtbot):
|
||||
"""Test set_grid_size creates dialog with current page"""
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.grid_size_mm = 10.0
|
||||
layout.snapping_system.snap_threshold_mm = 5.0
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
# Mock the full dialog workflow
|
||||
mock_dialog = Mock(spec=QDialog)
|
||||
mock_dialog.exec.return_value = QDialog.DialogCode.Rejected
|
||||
|
||||
with patch('PyQt6.QtWidgets.QDialog', return_value=mock_dialog):
|
||||
window.set_grid_size()
|
||||
|
||||
# Dialog should have been created and exec called
|
||||
mock_dialog.exec.assert_called_once()
|
||||
|
||||
|
||||
class TestLayoutTabDelegation:
|
||||
"""Test Layout tab methods delegate to main methods"""
|
||||
|
||||
def test_layout_toggle_grid_snap_delegates(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_grid = False
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.layout_toggle_grid_snap()
|
||||
|
||||
# Should delegate to toggle_grid_snap
|
||||
assert layout.snapping_system.snap_to_grid is True
|
||||
assert window._update_view_called
|
||||
|
||||
def test_layout_toggle_edge_snap_delegates(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_edges = False
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.layout_toggle_edge_snap()
|
||||
|
||||
assert layout.snapping_system.snap_to_edges is True
|
||||
assert window._update_view_called
|
||||
|
||||
def test_layout_toggle_guide_snap_delegates(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.snapping_system.snap_to_guides = False
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.layout_toggle_guide_snap()
|
||||
|
||||
assert layout.snapping_system.snap_to_guides is True
|
||||
assert window._update_view_called
|
||||
|
||||
def test_layout_toggle_snap_lines_delegates(self, qtbot):
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
layout.show_snap_lines = False
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
window.layout_toggle_snap_lines()
|
||||
|
||||
assert layout.show_snap_lines is True
|
||||
assert window._update_view_called
|
||||
|
||||
def test_layout_set_grid_size_delegates(self, qtbot):
|
||||
"""Test layout tab grid size delegates to main method"""
|
||||
window = TestViewWindow()
|
||||
qtbot.addWidget(window)
|
||||
|
||||
layout = PageLayout()
|
||||
page = Mock()
|
||||
page.layout = layout
|
||||
window._current_page = page
|
||||
|
||||
# Mock dialog to verify delegation
|
||||
mock_dialog = Mock(spec=QDialog)
|
||||
mock_dialog.exec.return_value = QDialog.DialogCode.Rejected
|
||||
|
||||
with patch('PyQt6.QtWidgets.QDialog', return_value=mock_dialog):
|
||||
window.layout_set_grid_size()
|
||||
|
||||
# Verify method was called (dialog creation attempted)
|
||||
mock_dialog.exec.assert_called_once()
|
||||
Loading…
x
Reference in New Issue
Block a user