Respect use_directory_urls when generating redirects for an alias

Author: jimporter

mike/commands.py

@@ -1,5 +1,6 @@
 import http.server
 import os
+import posixpath
 from jinja2 import Template
 from pkg_resources import resource_stream
 
@@ -19,10 +20,13 @@ def _redirect_template(user_template=None):
         return Template(f.read().decode('utf-8'), autoescape=True)
 
 
-def _add_redirect_to_commit(commit, template, src, dst):
+def _add_redirect_to_commit(commit, template, src, dst,
+                            use_directory_urls=True):
     if os.path.splitext(src)[1] == '.html':
         reldst = os.path.relpath(dst, os.path.dirname(src))
         href = '/'.join(reldst.split(os.path.sep))
+        if use_directory_urls and posixpath.basename(href) == 'index.html':
+            href = posixpath.dirname(href) + '/'
         commit.add_file(git_utils.FileInfo(src, template.render(href=href)))
 
 
@@ -45,7 +49,7 @@ def make_nojekyll():
     return git_utils.FileInfo('.nojekyll', '')
 
 
-def deploy(site_dir, version, title=None, aliases=[], update_aliases=False,
+def deploy(cfg, version, title=None, aliases=[], update_aliases=False,
            redirect=True, template=None, *, branch='gh-pages', message=None,
            prefix=''):
     if message is None:
@@ -72,14 +76,16 @@ def deploy(site_dir, version, title=None, aliases=[], update_aliases=False,
     with git_utils.Commit(branch, message) as commit:
         commit.delete_files([version_str] + list(info.aliases))
 
-        for f in git_utils.walk_real_files(site_dir):
-            canonical_file = f.copy(destdir, site_dir)
+        for f in git_utils.walk_real_files(cfg.site_dir):
+            canonical_file = f.copy(destdir, cfg.site_dir)
             commit.add_file(canonical_file)
             for d in alias_destdirs:
-                alias_file = f.copy(d, site_dir)
+                alias_file = f.copy(d, cfg.site_dir)
                 if redirect:
-                    _add_redirect_to_commit(commit, t, alias_file.path,
-                                            canonical_file.path)
+                    _add_redirect_to_commit(
+                        commit, t, alias_file.path, canonical_file.path,
+                        cfg.use_directory_urls
+                    )
                 else:
                     commit.add_file(alias_file)
 
@@ -125,8 +131,8 @@ def delete(versions=None, all=False, *, branch='gh-pages', message=None,
             commit.add_file(versions_to_file_info(all_versions, prefix))
 
 
-def alias(version, aliases, redirect=True, template=None, *, branch='gh-pages',
-          message=None, prefix=''):
+def alias(cfg, version, aliases, redirect=True, template=None, *,
+          branch='gh-pages', message=None, prefix=''):
     all_versions = list_versions(branch, prefix)
     try:
         real_version = all_versions.find(version, strict=True)[0]
@@ -158,8 +164,10 @@ def alias(version, aliases, redirect=True, template=None, *, branch='gh-pages',
             for d in destdirs:
                 alias_file = canonical_file.copy(d, canonical_dir)
                 if redirect:
-                    _add_redirect_to_commit(commit, t, alias_file.path,
-                                            canonical_file.path)
+                    _add_redirect_to_commit(
+                        commit, t, alias_file.path, canonical_file.path,
+                        cfg.use_directory_urls
+                    )
                 else:
                     commit.add_file(alias_file)
         commit.add_file(versions_to_file_info(all_versions, prefix))

mike/driver.py

@@ -78,7 +78,7 @@ def deploy(args):
     check_remote_status(args, strict=True)
     with mkdocs_utils.inject_plugin(args.config_file) as config_file:
         mkdocs_utils.build(config_file, args.version)
-    commands.deploy(cfg.site_dir, args.version, args.title, args.alias,
+    commands.deploy(cfg, args.version, args.title, args.alias,
                     args.update_aliases, args.redirect, args.template,
                     branch=args.branch, message=args.message,
                     prefix=args.prefix)
@@ -96,9 +96,9 @@ def delete(args):
 
 
 def alias(args):
-    load_mkdocs_config(args)
+    cfg = load_mkdocs_config(args)
     check_remote_status(args, strict=True)
-    commands.alias(args.version, args.alias, args.redirect, args.template,
+    commands.alias(cfg, args.version, args.alias, args.redirect, args.template,
                    branch=args.branch, message=args.message,
                    prefix=args.prefix)
     if args.push:

mike/mkdocs_utils.py

@@ -16,6 +16,7 @@ def __init__(self, config_file):
                                      config.get('site_dir', 'site'))
         self.remote_name = config.get('remote_name', 'origin')
         self.remote_branch = config.get('remote_branch', 'gh-pages')
+        self.use_directory_urls = config.get('use_directory_urls', True)
 
 
 @contextmanager

test/__init__.py

@@ -68,6 +68,9 @@ def git_init():
 
 def commit_files(filenames, message='add file'):
     for f in filenames:
+        dirname = os.path.dirname(f)
+        if dirname:
+            os.makedirs(dirname, exist_ok=True)
         open(f, 'w').close()
         check_call_silent(['git', 'add', f])
     check_call_silent(['git', 'commit', '-m', message])

test/data/no_directory_urls/docs/index.md

@@ -0,0 +1 @@
+# MkDocs

test/data/no_directory_urls/docs/page.md

@@ -0,0 +1 @@
+# Page

test/data/no_directory_urls/mkdocs.yml

@@ -0,0 +1,7 @@
+site_name: test
+theme: mkdocs
+use_directory_urls: false
+
+nav:
+  - Home: index.md
+  - Page: page.md

test/integration/test_alias.py

@@ -1,11 +1,16 @@
 import os
+import re
 import unittest
 
 from . import assertPopen, assertOutput
 from .. import *
 from mike import git_utils, versions
 
 
+def match_redir(url):
+    return r'window\.location\.replace\("{}"\)'.format(re.escape(url))
+
+
 class AliasTestCase(unittest.TestCase):
     def _deploy(self, branch=None, versions=['1.0'], prefix=''):
         extra_args = ['-b', branch] if branch else []
@@ -57,6 +62,9 @@ def test_alias(self):
         check_call_silent(['git', 'checkout', 'gh-pages'])
         self._test_alias()
 
+        with open('latest/index.html') as f:
+            self.assertRegex(f.read(), match_redir('../1.0/'))
+
     def test_alias_copy(self):
         self._deploy()
         assertPopen(['mike', 'alias', '1.0', 'latest', '--no-redirect'])
@@ -69,9 +77,9 @@ def test_aliases_custom_template(self):
                      os.path.join(test_data_dir, 'template.html')])
         check_call_silent(['git', 'checkout', 'gh-pages'])
         self._test_alias()
+
         with open('latest/index.html') as f:
-            self.assertRegex(f.read(),
-                             r'^Redirecting to \.\./1\.0/index.html$')
+            self.assertEqual(f.read(), 'Redirecting to ../1.0/')
 
     def test_from_subdir(self):
         self._deploy()
@@ -83,15 +91,6 @@ def test_from_subdir(self):
         check_call_silent(['git', 'checkout', 'gh-pages'])
         self._test_alias()
 
-    def test_from_subdir_explicit_branch(self):
-        self._deploy()
-        os.mkdir('sub')
-        with pushd('sub'):
-            assertPopen(['mike', 'alias', '1.0', 'latest', '-b', 'gh-pages',
-                         '-r', 'origin'])
-        check_call_silent(['git', 'checkout', 'gh-pages'])
-        self._test_alias()
-
     def test_branch(self):
         self._deploy('branch')
         assertPopen(['mike', 'alias', '1.0', 'latest', '-b', 'branch'])
@@ -259,3 +258,22 @@ def test_explicit_remote(self):
         check_call_silent(['git', 'checkout', 'mybranch'])
         self._test_alias()
         self._test_rev('mybranch')
+
+
+class TestAliasNoDirectoryUrls(AliasTestCase):
+    def setUp(self):
+        self.stage = stage_dir('alias_no_directory_urls')
+        git_init()
+        copytree(os.path.join(test_data_dir, 'no_directory_urls'), self.stage)
+        check_call_silent(['git', 'add', 'mkdocs.yml', 'docs'])
+        check_call_silent(['git', 'commit', '-m', 'initial commit'])
+
+    def test_default(self):
+        self._deploy()
+        assertPopen(['mike', 'alias', '1.0', 'latest'])
+        check_call_silent(['git', 'checkout', 'gh-pages'])
+
+        with open('latest/index.html') as f:
+            self.assertRegex(f.read(), match_redir('../1.0/index.html'))
+        with open('latest/page.html') as f:
+            self.assertRegex(f.read(), match_redir('../1.0/page.html'))

test/integration/test_deploy.py

@@ -1,11 +1,16 @@
 import os
+import re
 import unittest
 
 from . import assertPopen, assertOutput
 from .. import *
 from mike import git_utils, versions
 
 
+def match_redir(url):
+    return r'window\.location\.replace\("{}"\)'.format(re.escape(url))
+
+
 class DeployTestCase(unittest.TestCase):
     def _test_deploy(self, expected_message=None,
                      expected_versions=[versions.VersionInfo('1.0')],
@@ -65,6 +70,8 @@ def test_aliases(self):
         self._test_deploy(expected_versions=[
             versions.VersionInfo('1.0', aliases=['latest'])
         ])
+        with open('latest/index.html') as f:
+            self.assertRegex(f.read(), match_redir('../1.0/'))
 
     def test_aliases_copy(self):
         assertPopen(['mike', 'deploy', '1.0', 'latest', '--no-redirect'])
@@ -73,17 +80,17 @@ def test_aliases_copy(self):
             versions.VersionInfo('1.0', aliases=['latest'])
         ], redirect=False)
 
-    def test_aliases_custom_template(self):
+    def test_aliases_custom_redirect(self):
         assertPopen(['mike', 'deploy', '1.0', 'latest', '-T',
                      os.path.join(test_data_dir, 'template.html')])
         check_call_silent(['git', 'checkout', 'gh-pages'])
         self._test_deploy(expected_versions=[
             versions.VersionInfo('1.0', aliases=['latest'])
         ])
         check_call_silent(['git', 'checkout', 'gh-pages'])
+
         with open('latest/index.html') as f:
-            self.assertRegex(f.read(),
-                             r'^Redirecting to \.\./1\.0/index.html$')
+            self.assertEqual(f.read(), 'Redirecting to ../1.0/')
 
     def test_update(self):
         assertPopen(['mike', 'deploy', '1.0', 'latest'])
@@ -320,3 +327,22 @@ def test_explicit_remote(self):
         check_call_silent(['git', 'checkout', 'mybranch'])
         self._test_deploy()
         self._test_rev('mybranch')
+
+
+class TestDeployNoDirectoryUrls(unittest.TestCase):
+    def setUp(self):
+        self.stage = stage_dir('deploy_no_directory_urls')
+        git_init()
+        copytree(os.path.join(test_data_dir, 'no_directory_urls'), self.stage)
+        check_call_silent(['git', 'add', 'mkdocs.yml', 'docs'])
+        check_call_silent(['git', 'commit', '-m', 'initial commit'])
+
+    def test_default(self):
+        assertPopen(['mike', 'deploy', '1.0', 'latest'])
+        check_call_silent(['git', 'checkout', 'gh-pages'])
+
+        with open('latest/index.html') as f:
+            self.assertRegex(f.read(), match_redir('../1.0/index.html'))
+        with open('latest/page.html') as f:
+            self.assertRegex(f.read(),
+                             match_redir('../1.0/page.html'))