soroban-abacus-flashcards/tests
Thomas Hallock 6c9553825a feat: improve visual appearance with dynamic rod bounds and better spacing
This commit enhances the visual quality of the soroban abacus cards with two key improvements:

1. Dynamic Rod Bounds:
   - Rod (gray column indicator) now dynamically calculates its bounds based on actual bead positions
   - No longer extends past outermost beads, creating a cleaner, more professional appearance
   - Accounts for hide-inactive option to only span visible beads
   - Handles edge cases like zero with hidden beads (rod spans just reckoning bar area)

2. Improved Inactive Bead Spacing:
   - Increased inactive bead separation from 5pt to 8pt for better visual distinction
   - Active beads maintain original 1pt spacing (close to reckoning bar)
   - Creates clearer visual separation between active and inactive states

Technical Changes:
- Complete rewrite of rod positioning logic with dynamic bounds calculation
- Pre-calculates all bead positions before drawing rod
- Rod spans from outermost heaven bead to outermost earth bead
- Maintains physical abacus logic while improving aesthetics

Visual Impact:
- Cleaner, more professional appearance
- Better distinction between active/inactive beads
- Rod perfectly fits within bead boundaries for each column
- Consistent across all formats (PDF, SVG, web)

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-09-10 09:20:11 -05:00
..
references feat: improve visual appearance with dynamic rod bounds and better spacing 2025-09-10 09:20:11 -05:00
README.md refactor: remove skipped test and unused reference update utility 2025-09-09 17:35:23 -05:00
__init__.py feat: add comprehensive test suite with visual regression testing 2025-09-09 17:29:09 -05:00
conftest.py refactor: remove skipped test and unused reference update utility 2025-09-09 17:35:23 -05:00
test_config.py fix: resolve test failures and improve test robustness 2025-09-09 17:33:44 -05:00
test_generation.py feat: add comprehensive test suite with visual regression testing 2025-09-09 17:29:09 -05:00
test_quiz_functionality.py test: add comprehensive quiz functionality tests 2025-09-09 20:51:59 -05:00
test_visual.py refactor: remove skipped test and unused reference update utility 2025-09-09 17:35:23 -05:00
test_web_generation.py feat: implement physical abacus logic and fix numeral coloring regression 2025-09-10 09:12:43 -05:00

README.md

Testing

This directory contains automated tests for the Soroban flashcard generator.

Test Structure

  • test_config.py - Configuration loading and parsing tests
  • test_generation.py - Core generation logic tests
  • test_visual.py - Visual regression tests using image comparison
  • conftest.py - Pytest fixtures and configuration
  • references/ - Reference images for visual regression tests

Running Tests

Quick Start

make pytest-fast    # Run unit tests (fast)
make pytest-visual  # Run visual regression tests
make pytest         # Run all tests
make pytest-cov     # Run with coverage report

Direct pytest usage

# All tests
python3 -m pytest tests/ -v

# Skip slow tests
python3 -m pytest tests/ -v -m "not slow" 

# Visual tests only
python3 -m pytest tests/test_visual.py -v

# With coverage
python3 -m pytest tests/ -v --cov=src

Visual Testing

The visual tests generate flashcard images and compare them against reference images using perceptual hashing. This catches visual regressions while allowing for minor differences.

Updating References

When you make intentional visual changes, manually delete the old reference images in tests/references/ and run the visual tests. They will automatically create new reference images on first run.

How Visual Tests Work

  1. Generate test images (PNG format, small size for speed)
  2. Compare against reference images using imagehash library
  3. Allow small differences (hash distance < 5) for anti-aliasing variations
  4. Fail if images differ significantly, indicating a regression

Test Philosophy

  • Fast unit tests for logic and configuration
  • Visual regression tests for output verification
  • Integration tests marked as @pytest.mark.slow
  • Meaningful failures with clear error messages
  • Easy maintenance when the app evolves

Adding Tests

When adding features:

  1. Add unit tests in relevant test_*.py file
  2. Add visual tests if output changes
  3. Update references if visual changes are intentional
  4. Use appropriate markers (@pytest.mark.slow, etc.)

CI Integration

Tests are designed to run in CI environments:

  • Skip tests requiring typst if not installed
  • Use smaller images and lower DPI for speed
  • Store reference images in version control
  • Clear pass/fail criteria