Implement Auto Redirect Builder (#10)

Daltz333 · TheTripleV · web-flow · commit 4026ec2df18e · 2020-08-29T23:37:59.000-04:00
Co-authored-by: TheTripleV &lt;vasistavovveti@gmail.com&gt;

Co-authored-by: TheTripleV &lt;vasistavovveti@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -31,6 +31,12 @@ To check that deleted/renamed files in your git repo are in your redirects,
 1. Make sure `rediraffe_branch` and `rediraffe_redirects` are set in conf.py.
 2. Run the `rediraffecheckdiff` builder.
 
+### Auto Redirect builder
+For convenience, the auto redirect builder can be used to automatically add renamed files to your redirects file. Simply run the `rediraffewritediff` builder.
+
+Note: The auto redirect builder only works with a configuration file.
+Note: Deleted files cannot be added to your redirects file automatically.
+
 ## Options
 These values are placed in the conf.py of your sphinx project.
 
@@ -49,6 +55,8 @@ These values are placed in the conf.py of your sphinx project.
         * `to_url` - the path to to_url's built html file relative to the outdir.
         * `rel_url` - the relative path from from_url to to_url.
 
+* `rediraffe_auto_redirect_perc`
+    * Optional. The percentage as an integer representing the accuracy required before auto redirecting with the `rediraffewritediff` builder. The default is 100.
 
 ## Example Config
 
diff --git a/sphinxext/rediraffe.py b/sphinxext/rediraffe.py
@@ -252,16 +252,17 @@ def init(self) -> None:
         src_path = Path(self.app.srcdir)
 
         rediraffe_redirects = self.app.config.rediraffe_redirects
+        redirects_path = None
         if isinstance(rediraffe_redirects, dict):
             pass
         elif isinstance(rediraffe_redirects, str):
-            path = Path(src_path) / rediraffe_redirects
-            if not path.is_file():
+            redirects_path = Path(src_path) / rediraffe_redirects
+            if not redirects_path.is_file():
                 logger.error(red("rediraffe: rediraffe_redirects file does not exist."))
                 self.app.statuscode = 1
                 return
             try:
-                rediraffe_redirects = create_graph(path)
+                rediraffe_redirects = create_graph(redirects_path)
             except ExtensionError as e:
                 self.app.statuscode = 1
                 return
@@ -309,7 +310,6 @@ def abs_path_in_src_dir_w_src_suffix(filename: str) -> Union[Path, None]:
                 continue
             if path_rename_to == None:
                 continue
-
             rename_hints[path_rename_from] = (path_rename_to, perc)
 
         # run git diff
@@ -338,13 +338,29 @@ def abs_path_in_src_dir_w_src_suffix(filename: str) -> Union[Path, None]:
                 logger.error(err_msg)
                 self.app.statuscode = 1
 
-        for renamed_file in rename_hints:
-            hint_to, perc = rename_hints[renamed_file]
-            if renamed_file in absolute_redirects:
-                logger.info(
-                    f"renamed file {renamed_file} redirects to {absolute_redirects[renamed_file]}."
-                )
-            else:
+        with redirects_path.open("a") as redirects_file:
+
+            for renamed_file in rename_hints:
+                hint_to, perc = rename_hints[renamed_file]
+
+                if renamed_file in absolute_redirects:
+                    logger.info(
+                        f"renamed file {renamed_file} redirects to {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)))}"'
+                        )
+                        redirects_file.write(f"{rel_rename_from} {rel_rename_to}\n")
+                        logger.info(
+                            f"{green('(okay)')} Renamed file {rel_rename_from} has been redirected to {rel_rename_to} in your redirects file!"
+                        )
+                        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}%."
@@ -368,12 +384,29 @@ def read(self):
         return []
 
 
+class WriteRedirectsDiffBuilder(CheckRedirectsDiffBuilder):
+    name = "rediraffewritediff"
+
+    def init(self) -> None:
+        rediraffe_redirects = self.app.config.rediraffe_redirects
+        if not isinstance(rediraffe_redirects, str):
+            logger.error(
+                f"{red('(broken)')} Automatic redirects is only available with a redirects file."
+            )
+            self.app.statuscode = 1
+            return
+
+        super().init()
+
+
 def setup(app: Sphinx) -> Dict[str, Any]:
     app.add_config_value("rediraffe_redirects", "", None)
     app.add_config_value("rediraffe_branch", "", None)
     app.add_config_value("rediraffe_template", None, None)
+    app.add_config_value("rediraffe_auto_redirect_perc", 100, None)
 
     app.add_builder(CheckRedirectsDiffBuilder)
+    app.add_builder(WriteRedirectsDiffBuilder)
     app.connect("build-finished", build_redirects)
 
     return {
diff --git a/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD/another2.rst b/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD/another2.rst
@@ -0,0 +1 @@
+another file
diff --git a/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD/index.rst b/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD/index.rst
@@ -0,0 +1 @@
+index file
diff --git a/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD/redirects.txt b/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD/redirects.txt
diff --git a/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD~1/another.rst b/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD~1/another.rst
@@ -0,0 +1 @@
+another file
diff --git a/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD~1/index.rst b/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD~1/index.rst
@@ -0,0 +1 @@
+index file
diff --git a/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD~1/redirects.txt b/tests/roots/builder/test-renamed_write_file_not_redirected/HEAD~1/redirects.txt
diff --git a/tests/roots/builder/test-renamed_write_file_not_redirected/conf.py b/tests/roots/builder/test-renamed_write_file_not_redirected/conf.py
@@ -0,0 +1,9 @@
+extensions = ["sphinxext.rediraffe"]
+
+master_doc = "index"
+exclude_patterns = ["_build"]
+
+html_theme = "basic"
+
+rediraffe_branch = "HEAD~1"
+rediraffe_redirects = "redirects.txt"
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD/another2.rst b/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD/another2.rst
@@ -0,0 +1,3 @@
+another file
+
+but more!
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD/index.rst b/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD/index.rst
@@ -0,0 +1 @@
+index file
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD/redirects.txt b/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD/redirects.txt
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD~1/another.rst b/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD~1/another.rst
@@ -0,0 +1 @@
+another file
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD~1/index.rst b/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD~1/index.rst
@@ -0,0 +1 @@
+index file
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD~1/redirects.txt b/tests/roots/builder/test-renamed_write_file_perc_low_fail/HEAD~1/redirects.txt
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_fail/conf.py b/tests/roots/builder/test-renamed_write_file_perc_low_fail/conf.py
@@ -0,0 +1,9 @@
+extensions = ["sphinxext.rediraffe"]
+
+master_doc = "index"
+exclude_patterns = ["_build"]
+
+html_theme = "basic"
+
+rediraffe_branch = "HEAD~1"
+rediraffe_redirects = "redirects.txt"
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD/another2.rst b/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD/another2.rst
@@ -0,0 +1,8 @@
+another
+file
+and
+this
+is
+some
+additional
+content
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD/index.rst b/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD/index.rst
@@ -0,0 +1 @@
+index file
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD/redirects.txt b/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD/redirects.txt
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD~1/another.rst b/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD~1/another.rst
@@ -0,0 +1,7 @@
+another
+file
+and
+this
+is
+some
+content
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD~1/index.rst b/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD~1/index.rst
@@ -0,0 +1 @@
+index file
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD~1/redirects.txt b/tests/roots/builder/test-renamed_write_file_perc_low_pass/HEAD~1/redirects.txt
diff --git a/tests/roots/builder/test-renamed_write_file_perc_low_pass/conf.py b/tests/roots/builder/test-renamed_write_file_perc_low_pass/conf.py
@@ -0,0 +1,10 @@
+extensions = ["sphinxext.rediraffe"]
+
+master_doc = "index"
+exclude_patterns = ["_build"]
+
+html_theme = "basic"
+
+rediraffe_branch = "HEAD~1"
+rediraffe_redirects = "redirects.txt"
+rediraffe_auto_redirect_perc = 50
diff --git a/tests/test_builder.py b/tests/test_builder.py
@@ -4,7 +4,7 @@
 
 @pytest.fixture(scope="module")
 def rootdir():
-    return path(__file__).parent.abspath() / "roots/builder"
+    return path(__file__).parent.abspath() / "roots" / "builder"
 
 
 @pytest.mark.sphinx("rediraffecheckdiff", testroot="file_changed")
diff --git a/tests/test_write_builder.py b/tests/test_write_builder.py
@@ -0,0 +1,31 @@
+import pytest
+from sphinx.testing.path import path
+
+
+@pytest.fixture(scope="module")
+def rootdir():
+    return path(__file__).parent.abspath() / "roots" / "builder"
+
+
+@pytest.mark.sphinx("rediraffewritediff", testroot="renamed_write_file_not_redirected")
+def test_builder_renamed_file_write_not_redirected(app_init_repo):
+    app_init_repo.build()
+    valid_string = '"another.rst" "another2.rst"'
+    with open(path(app_init_repo.srcdir).joinpath("redirects.txt"), "r") as file:
+        assert valid_string in file.readline()
+
+
+@pytest.mark.sphinx("rediraffewritediff", testroot="renamed_write_file_perc_low_fail")
+def test_builder_renamed_file_write_perc_low_fail(app_init_repo):
+    app_init_repo.build()
+    valid_string = '"another.rst" "another2.rst"'
+    with open(path(app_init_repo.srcdir).joinpath("redirects.txt"), "r") as file:
+        assert valid_string not in file.readline()
+
+
+@pytest.mark.sphinx("rediraffewritediff", testroot="renamed_write_file_perc_low_pass")
+def test_builder_renamed_file_write_perc_low_pass(app_init_repo):
+    app_init_repo.build()
+    valid_string = '"another.rst" "another2.rst"'
+    with open(path(app_init_repo.srcdir).joinpath("redirects.txt"), "r") as file:
+        assert valid_string in file.readline()
