Don't include static files twice (#80)

Only include the type that was requested.

Author: stsewd

sphinx_search/extension.py

@@ -3,7 +3,6 @@
 from sphinx.errors import ExtensionError
 from sphinx.util.fileutil import copy_asset
 
-
 ASSETS_FILES = {
     'minified': [
         os.path.join('js', 'rtd_sphinx_search.min.js'),
@@ -16,26 +15,24 @@
 }
 
 
+def _get_static_files(config):
+    file_type = config.rtd_sphinx_search_file_type
+    if file_type not in ASSETS_FILES:
+        raise ExtensionError(f'"{file_type}" file type is not supported')
+
+    return ASSETS_FILES[file_type]
+
+
 def copy_asset_files(app, exception):
     if exception is None:  # build succeeded
-        files = ASSETS_FILES['minified'] + ASSETS_FILES['un-minified']
-        for file in files:
+        for file in _get_static_files(app.config):
             path = os.path.join(os.path.dirname(__file__), 'static', file)
             copy_asset(path, os.path.join(app.outdir, '_static', file.split('.')[-1]))
 
 
 def inject_static_files(app):
     """Inject correct CSS and JS files based on the value of ``rtd_sphinx_search_file_type``."""
-
-    file_type = app.config.rtd_sphinx_search_file_type
-    expected_file_type = ASSETS_FILES.keys()
-
-    if file_type not in expected_file_type:
-        raise ExtensionError(f'"{file_type}" file type is not supported')
-
-    files = ASSETS_FILES[file_type]
-
-    for file in files:
+    for file in _get_static_files(app.config):
         if file.endswith('.js'):
             app.add_js_file(file)
         elif file.endswith('.css'):

tests/test_extension.py

@@ -1,25 +1,11 @@
 """Test working of extension."""
 
 import os
+
 import pytest
 
-from tests import TEST_DOCS_SRC
 from sphinx_search.extension import ASSETS_FILES
-
-
-@pytest.mark.sphinx(srcdir=TEST_DOCS_SRC)
-def test_static_files_exists(app, status, warning):
-    """Test if the static files are present in the _build folder."""
-    app.build()
-    path = app.outdir
-
-    static_files = ASSETS_FILES['minified'] + ASSETS_FILES['un-minified']
-
-    for file in static_files:
-        file_path = os.path.join(path, '_static', file)
-        assert (
-            os.path.exists(file_path)
-        ), f'{file_path} should be present in the _build folder'
+from tests import TEST_DOCS_SRC
 
 
 @pytest.mark.sphinx(
@@ -36,12 +22,15 @@ def test_minified_static_files_injected_in_html(selenium, app, status, warning):
     selenium.get(f'file://{path}')
     page_source = selenium.page_source
 
-    assert app.config.rtd_sphinx_search_file_type == 'minified'
-
     file_type = app.config.rtd_sphinx_search_file_type
-    files = ASSETS_FILES[file_type]
+    assert file_type == 'minified'
+
+    for file in ASSETS_FILES[file_type]:
+        file_path = os.path.join(app.outdir, '_static', file)
+        assert (
+            os.path.exists(file_path)
+        ), f'{file_path} should be present in the _build folder'
 
-    for file in files:
         file_name = file.split('/')[-1]
         assert (
             page_source.count(file_name) == 1
@@ -62,13 +51,16 @@ def test_un_minified_static_files_injected_in_html(selenium, app, status, warnin
     selenium.get(f'file://{path}')
     page_source = selenium.page_source
 
-    assert app.config.rtd_sphinx_search_file_type == 'un-minified'
-
     file_type = app.config.rtd_sphinx_search_file_type
-    files = ASSETS_FILES[file_type]
+    assert file_type == 'un-minified'
+
+    for file in ASSETS_FILES[file_type]:
+        file_path = os.path.join(app.outdir, '_static', file)
+        assert (
+            os.path.exists(file_path)
+        ), f'{file_path} should be present in the _build folder'
 
-    for file in files:
         file_name = file.split('/')[-1]
         assert (
             page_source.count(file_name) == 1
-        ), f'{file_name} should be present in the page source'
+        ), f'{file} should be present in the page source'