Test updates

Author: zenbuffy

.github/workflows/generate.yml

@@ -18,10 +18,10 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: Install Python dependencies
-      run: pip install pyyaml
+      run: pip install pyyaml Pillow
 
     - name: Run Python tests
-      run: python -m unittest test_insert_quote test_yaml_to_formats -v
+      run: python -m unittest test_insert_quote test_yaml_to_formats test_quote_to_image -v
 
   generate-data:
     runs-on: ubuntu-latest
@@ -61,6 +61,6 @@ jobs:
 
     - uses: stefanzweifel/git-auto-commit-action@v4
       with:
-        file_pattern: 'images/*'
+        file_pattern: 'images/**'
         skip_dirty_check: true
         commit_message: Update images dir

.github/workflows/main.yml

@@ -14,8 +14,8 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: Install Python dependencies
-      run: pip install pyyaml
+      run: pip install pyyaml Pillow
 
     - name: Run Python tests
-      run: python -m unittest test_insert_quote test_yaml_to_formats -v
+      run: python -m unittest test_insert_quote test_yaml_to_formats test_quote_to_image -v
 

quote_to_image.py

@@ -109,22 +109,24 @@ def render_image(words, width, height, font_size, time_start, time_count, margin
     return img
 
 
-def fit_text(words, width, height, font_size, time_start, time_count, margin,
+def fit_text(words, width, height, time_start, time_count, margin,
              regular_path, bold_path):
     """
     Find the largest font size where text fits within height - 100.
     Returns a rendered PIL Image, or None if the minimum size doesn't fit.
     """
+    low, high = 18, 300
     best = None
-    size = font_size
 
-    while True:
-        h = measure_layout(words, width, size, time_start, time_count, margin,
+    while low <= high:
+        mid = (low + high) // 2
+        h = measure_layout(words, width, mid, time_start, time_count, margin,
                            regular_path, bold_path)
-        if h is None or h >= height - 100:
-            break
-        best = size
-        size += 1
+        if h is not None and h < height - 100:
+            best = mid
+            low = mid + 1
+        else:
+            high = mid - 1
 
     if best is None:
         return None
@@ -168,7 +170,7 @@ def _draw_credits(img, width, height, margin, credit_path, source, author):
                   full_text, font=credit_font, fill=0, anchor='ls')
 
 
-def render_entry(entry, width, height, font_paths):
+def render_entry(entry, width, height, font_paths, save_without_credits=False):
     """
     Render quote and credits images for one entry.
     Top-level function (required for multiprocessing pickling).
@@ -181,7 +183,9 @@ def render_entry(entry, width, height, font_paths):
     quote_out   = os.path.join('images', f'quote_{time_key}_{idx}.png')
     credits_out = os.path.join('images', 'metadata', f'quote_{time_key}_{idx}_credits.png')
 
-    if os.path.exists(quote_out) and os.path.exists(credits_out):
+    credits_done = os.path.exists(credits_out)
+    quote_done   = os.path.exists(quote_out) if save_without_credits else True
+    if credits_done and quote_done:
         return
 
     margin     = 26
@@ -207,14 +211,15 @@ def render_entry(entry, width, height, font_paths):
 
     print(f'Making image for {time_key}_{idx}')
 
-    img = fit_text(words, width, height, 18, time_start, time_count, margin,
+    img = fit_text(words, width, height, time_start, time_count, margin,
                    regular_path, bold_path)
     if img is None:
         print(f'WARNING: could not fit text for {time_key}_{idx}, skipping',
               file=sys.stderr)
         return
 
-    img.save(quote_out)
+    if save_without_credits:
+        img.save(quote_out)
 
     _draw_credits(img, width, height, margin, credit_path,
                   entry['source'].strip(), entry['author'].strip())
@@ -234,6 +239,8 @@ def main():
                         help='Include NSFW quotes (omitted by default)')
     parser.add_argument('--workers', type=int, default=cpu_count(),
                         help='Parallel worker processes (default: CPU count)')
+    parser.add_argument('--without-credits', action='store_true', dest='save_without_credits',
+                        help='Also save quote images without credits')
     args = parser.parse_args()
 
     device = args.device.lower()
@@ -275,7 +282,8 @@ def main():
         tasks.append({**entry, 'idx': idx})
 
     font_paths = (regular_path, bold_path, credit_path)
-    worker     = partial(render_entry, width=width, height=height, font_paths=font_paths)
+    worker     = partial(render_entry, width=width, height=height, font_paths=font_paths,
+                         save_without_credits=args.save_without_credits)
 
     with Pool(args.workers) as pool:
         pool.map(worker, tasks)

test_quote_to_image.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+import os
+import tempfile
+import unittest
+
+from quote_to_image import fit_text, measure_layout, render_entry
+
+_HERE   = os.path.dirname(os.path.abspath(__file__))
+REGULAR = os.path.join(_HERE, 'LinLibertine_RZ.ttf')
+BOLD    = os.path.join(_HERE, 'LinLibertine_RB.ttf')
+CREDIT  = os.path.join(_HERE, 'LinLibertine_RZI.ttf')
+
+FONTS_AVAILABLE = all(os.path.exists(p) for p in (REGULAR, BOLD, CREDIT))
+
+SHORT_QUOTE  = "It was half past three in the afternoon."
+TIME_NAME    = "half past three"
+TIME_START   = 3   # word index of "half"
+TIME_COUNT   = 2   # "half past three" = 3 words → count = 2
+
+SAMPLE_ENTRY = {
+    'time':      '15:30',
+    'time_name': TIME_NAME,
+    'quote':     SHORT_QUOTE,
+    'source':    'Test Book',
+    'author':    'Test Author',
+    'idx':       0,
+}
+
+
+@unittest.skipUnless(FONTS_AVAILABLE, 'LinLibertine fonts not found')
+class TestMeasureLayout(unittest.TestCase):
+
+    def test_returns_positive_height_for_short_quote(self):
+        h = measure_layout(SHORT_QUOTE.split(), 600, 40,
+                           TIME_START, TIME_COUNT, 26, REGULAR, BOLD)
+        self.assertIsNotNone(h)
+        self.assertGreater(h, 0)
+
+    def test_returns_none_when_font_too_large_for_narrow_width(self):
+        # Width of 10px — any word at size 300 won't fit
+        h = measure_layout(SHORT_QUOTE.split(), 10, 300,
+                           TIME_START, TIME_COUNT, 0, REGULAR, BOLD)
+        self.assertIsNone(h)
+
+    def test_larger_font_produces_greater_height(self):
+        words  = SHORT_QUOTE.split()
+        kwargs = dict(time_start=TIME_START, time_count=TIME_COUNT,
+                      margin=26, regular_path=REGULAR, bold_path=BOLD)
+        h_small = measure_layout(words, 600, 20, **kwargs)
+        h_large = measure_layout(words, 600, 60, **kwargs)
+        self.assertIsNotNone(h_small)
+        self.assertIsNotNone(h_large)
+        self.assertGreater(h_large, h_small)
+
+
+@unittest.skipUnless(FONTS_AVAILABLE, 'LinLibertine fonts not found')
+class TestFitText(unittest.TestCase):
+
+    def test_returns_image_for_normal_quote(self):
+        img = fit_text(SHORT_QUOTE.split(), 600, 800,
+                       TIME_START, TIME_COUNT, 26, REGULAR, BOLD)
+        self.assertIsNotNone(img)
+
+    def test_returned_image_has_correct_dimensions(self):
+        img = fit_text(SHORT_QUOTE.split(), 600, 800,
+                       TIME_START, TIME_COUNT, 26, REGULAR, BOLD)
+        self.assertEqual(img.size, (600, 800))
+
+    def test_returns_none_for_unrenderable_quote(self):
+        # A single extremely long word that can never fit at size 18
+        words = ['A' * 500]
+        img = fit_text(words, 100, 100, 0, 0, 0, REGULAR, BOLD)
+        self.assertIsNone(img)
+
+    def test_chosen_size_fits_within_height(self):
+        """The rendered image should require height < height - 100."""
+        words  = SHORT_QUOTE.split()
+        margin = 26
+        width, height = 600, 800
+
+        img = fit_text(words, width, height, TIME_START, TIME_COUNT,
+                       margin, REGULAR, BOLD)
+        self.assertIsNotNone(img)
+
+        # Verify the winning size actually fits
+        from quote_to_image import measure_layout as ml
+        # Find what size fit_text chose by checking sizes around the result
+        # We trust binary search is correct if size+1 overflows
+        for size in range(18, 301):
+            h = ml(words, width, size, TIME_START, TIME_COUNT, margin, REGULAR, BOLD)
+            if h is None or h >= height - 100:
+                winning_size = size - 1
+                break
+        else:
+            winning_size = 300
+
+        h_winner = ml(words, width, winning_size, TIME_START, TIME_COUNT,
+                      margin, REGULAR, BOLD)
+        self.assertIsNotNone(h_winner)
+        self.assertLess(h_winner, height - 100)
+
+
+@unittest.skipUnless(FONTS_AVAILABLE, 'LinLibertine fonts not found')
+class TestRenderEntrySaveWithoutCredits(unittest.TestCase):
+
+    def setUp(self):
+        self.tmpdir = tempfile.TemporaryDirectory()
+        self._orig_dir = os.getcwd()
+        os.chdir(self.tmpdir.name)
+        os.makedirs(os.path.join('images', 'metadata'), exist_ok=True)
+
+    def tearDown(self):
+        os.chdir(self._orig_dir)
+        self.tmpdir.cleanup()
+
+    def _credits_path(self):
+        return os.path.join('images', 'metadata', 'quote_1530_0_credits.png')
+
+    def _quote_path(self):
+        return os.path.join('images', 'quote_1530_0.png')
+
+    def test_default_only_writes_credits(self):
+        render_entry(SAMPLE_ENTRY, 600, 800,
+                     (REGULAR, BOLD, CREDIT), save_without_credits=False)
+        self.assertTrue(os.path.exists(self._credits_path()))
+        self.assertFalse(os.path.exists(self._quote_path()))
+
+    def test_flag_writes_both_files(self):
+        render_entry(SAMPLE_ENTRY, 600, 800,
+                     (REGULAR, BOLD, CREDIT), save_without_credits=True)
+        self.assertTrue(os.path.exists(self._credits_path()))
+        self.assertTrue(os.path.exists(self._quote_path()))
+
+    def test_skip_if_credits_already_exists(self):
+        # Pre-create the credits file
+        credits_path = self._credits_path()
+        with open(credits_path, 'wb') as f:
+            f.write(b'placeholder')
+
+        render_entry(SAMPLE_ENTRY, 600, 800,
+                     (REGULAR, BOLD, CREDIT), save_without_credits=False)
+
+        # File should be unchanged (still our placeholder)
+        with open(credits_path, 'rb') as f:
+            self.assertEqual(f.read(), b'placeholder')
+
+    def test_skip_if_both_files_exist_with_flag(self):
+        quote_path   = self._quote_path()
+        credits_path = self._credits_path()
+
+        for path in (quote_path, credits_path):
+            with open(path, 'wb') as f:
+                f.write(b'placeholder')
+
+        render_entry(SAMPLE_ENTRY, 600, 800,
+                     (REGULAR, BOLD, CREDIT), save_without_credits=True)
+
+        for path in (quote_path, credits_path):
+            with open(path, 'rb') as f:
+                self.assertEqual(f.read(), b'placeholder')
+
+
+if __name__ == '__main__':
+    unittest.main()