Fix rediraffecheckdiff when using a dict for rediraffe_redirects (#64)

Co-authored-by: Adam Turner <[email protected]>

Author: nedbat

sphinxext/rediraffe.py

@@ -399,39 +399,41 @@ def abs_path_in_src_dir_w_src_suffix(filename: str) -> Path | None:
                 logger.error(err_msg)
                 self.app.statuscode = 1
 
-        with redirects_path.open('a', encoding='utf-8') as redirects_file:
-            for renamed_file in rename_hints:
-                hint_to, perc = rename_hints[renamed_file]
+        for renamed_file in rename_hints:
+            hint_to, perc = rename_hints[renamed_file]
 
-                if renamed_file in absolute_redirects:
+            if renamed_file in absolute_redirects:
+                logger.info(
+                    'renamed file %s redirects to %s.',
+                    renamed_file,
+                    absolute_redirects[renamed_file],
+                )
+                continue
+
+            if self.name == 'rediraffewritediff':
+                if perc >= self.app.config.rediraffe_auto_redirect_perc:
+                    rel_rename_from = (
+                        f'"{str(PurePosixPath(renamed_file.relative_to(src_path)))}"'
+                    )
+                    rel_rename_to = (
+                        f'"{str(PurePosixPath(hint_to.relative_to(src_path)))}"'
+                    )
+                    with redirects_path.open('a', encoding='utf-8') as redirects_file:
+                        redirects_file.write(f'{rel_rename_from} {rel_rename_to}\n')
                     logger.info(
-                        'renamed file %s redirects to %s.',
-                        renamed_file,
-                        absolute_redirects[renamed_file],
+                        '%s Renamed file %s has been redirected to %s in your redirects file!',
+                        green('(okay)'),
+                        rel_rename_from,
+                        rel_rename_to,
                     )
                     continue
 
-                if self.name == 'rediraffewritediff':
-                    if perc >= self.app.config.rediraffe_auto_redirect_perc:
-                        rel_rename_from = f'"{str(PurePosixPath(renamed_file.relative_to(src_path)))}"'
-                        rel_rename_to = (
-                            f'"{str(PurePosixPath(hint_to.relative_to(src_path)))}"'
-                        )
-                        redirects_file.write(f'{rel_rename_from} {rel_rename_to}\n')
-                        logger.info(
-                            '%s Renamed file %s has been redirected to %s in your redirects file!',
-                            green('(okay)'),
-                            rel_rename_from,
-                            rel_rename_to,
-                        )
-                        continue
-
-                err_msg = (
-                    f'{red("(broken)")} {renamed_file} was deleted but is not redirected!'
-                    f' Hint: This file was renamed to {hint_to} with a similarity of {perc}%.'
-                )
-                logger.error(err_msg)
-                self.app.statuscode = 1
+            err_msg = (
+                f'{red("(broken)")} {renamed_file} was deleted but is not redirected!'
+                f' Hint: This file was renamed to {hint_to} with a similarity of {perc}%.'
+            )
+            logger.error(err_msg)
+            self.app.statuscode = 1
 
     def get_outdated_docs(self):
         return []

tests/roots/builder/test-deleted_file_redirected_dict/HEAD/conf.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+extensions = ['sphinxext.rediraffe']
+
+master_doc = 'index'
+exclude_patterns = ['_build']
+
+html_theme = 'basic'
+
+rediraffe_branch = 'HEAD~1'
+rediraffe_redirects = {
+    'another.rst': 'index.rst',
+}

tests/roots/builder/test-deleted_file_redirected_dict/HEAD/index.rst

@@ -0,0 +1 @@
+index file

tests/roots/builder/test-deleted_file_redirected_dict/HEAD~1/another.rst

@@ -0,0 +1 @@
+another file

tests/roots/builder/test-deleted_file_redirected_dict/HEAD~1/conf.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+extensions = ['sphinxext.rediraffe']
+
+master_doc = 'index'
+exclude_patterns = ['_build']
+
+html_theme = 'basic'
+
+rediraffe_branch = 'HEAD~1'
+rediraffe_redirects = {}

tests/roots/builder/test-deleted_file_redirected_dict/HEAD~1/index.rst

@@ -0,0 +1 @@
+index file

tests/test_builder.py

@@ -85,3 +85,9 @@ def test_builder_deleted_file_redirected_commit(app_init_repo):
 def test_builder_deleted_file_not_redirected_commit(app_init_repo):
     app_init_repo.build()
     assert app_init_repo.statuscode == 1
+
+
+@pytest.mark.sphinx('rediraffecheckdiff', testroot='deleted_file_redirected_dict')
+def test_builder_deleted_file_redirected_dict(app_init_repo):
+    app_init_repo.build()
+    assert app_init_repo.statuscode == 0