Skip to content

Commit

Permalink
🧪 TESTS: Add tests for disable_css_loading option
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarcia360 authored and foster999 committed Jun 11, 2021
1 parent 54776a3 commit 5564197
Show file tree
Hide file tree
Showing 7 changed files with 112 additions and 7 deletions.
3 changes: 2 additions & 1 deletion sphinx_tabs/tabs.py
Expand Up @@ -299,12 +299,13 @@ def update_config(app, config):
app.add_css_file(path.as_posix())
else:
app.add_stylesheet(path.as_posix())
if path.suffix == ".js":
if path.suffix == ".js":
if "add_script_file" in dir(app):
app.add_script_file(path.as_posix())
else:
app.add_js_file(path.as_posix())


# pylint: disable=unused-argument
def update_context(app, pagename, templatename, context, doctree):
"""Remove sphinx-tabs CSS and JS asset files if not used in a page"""
Expand Down
16 changes: 12 additions & 4 deletions tests/conftest.py
Expand Up @@ -130,7 +130,12 @@ def check_asset_links(get_sphinx_app_output):
"""

def check(
app, buildername="html", filename="index.html", encoding="utf-8", present=True
app,
buildername="html",
filename="index.html",
encoding="utf-8",
cssPresent=True,
jsPresent=True,
):
content = get_sphinx_app_output(app, buildername, filename, encoding)

Expand All @@ -146,13 +151,16 @@ def check(

all_refs = css_refs + js_refs

if present:
if cssPresent:
css_present = all(any(a in ref for ref in all_refs) for a in css_assets)
js_present = all(any(a in ref for ref in js_refs) for a in js_assets)
assert css_present
else:
assert not "sphinx_tabs" in css_refs
if jsPresent:
js_present = all(any(a in ref for ref in js_refs) for a in js_assets)
assert js_present
else:
assert not "sphinx_tabs" in css_refs + js_refs
assert not "sphinx_tabs" in js_refs

return check

Expand Down
7 changes: 7 additions & 0 deletions tests/roots/test-disable-css-loading/conf.py
@@ -0,0 +1,7 @@
project = "sphinx-tabs test"
master_doc = "index"
source_suffix = ".rst"
extensions = ["sphinx_tabs.tabs"]
pygments_style = "sphinx"

sphinx_tabs_disable_css_loading = True
17 changes: 17 additions & 0 deletions tests/roots/test-disable-css-loading/index.rst
@@ -0,0 +1,17 @@
.. tabs::

.. tab:: Apples

Apples are green, or sometimes red.

.. tab:: Pears

Pears are green.

.. tab:: Oranges

Oranges are orange.

.. tab:: 404

A number in the name.
11 changes: 9 additions & 2 deletions tests/test_build.py
Expand Up @@ -10,7 +10,7 @@ def test_basic():

@pytest.mark.sphinx(testroot="notabs")
def test_no_tabs(app, check_asset_links):
check_asset_links(app, present=False)
check_asset_links(app, cssPresent=False, jsPresent=False)


@pytest.mark.parametrize("docname", ["index", "no_tabs1", "no_tabs2"])
Expand All @@ -19,7 +19,9 @@ def test_conditional_assets(app, docname, check_asset_links):
if docname == "index":
check_asset_links(app)
else:
check_asset_links(app, filename=docname + ".html", present=False)
check_asset_links(
app, filename=docname + ".html", cssPresent=False, jsPresent=False
)


@pytest.mark.sphinx(testroot="linenos")
Expand Down Expand Up @@ -62,3 +64,8 @@ def test_rinohtype_pdf(
@pytest.mark.sphinx(testroot="disable-closing")
def test_disable_closing(app, check_asset_links):
check_asset_links(app)


@pytest.mark.sphinx(testroot="disable-css-loading")
def test_disable_css_loading(app, check_asset_links):
check_asset_links(app, cssPresent=False)
42 changes: 42 additions & 0 deletions tests/test_build/test_disable_css_loading.html
@@ -0,0 +1,42 @@
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="sphinx-tabs docutils container">
<div aria-label="Tabbed content" class="closeable" role="tablist">
<button aria-controls="panel-0-0-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-0-0-0" name="0-0" role="tab" tabindex="0">
Apples
</button>
<button aria-controls="panel-0-0-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-1" name="0-1" role="tab" tabindex="-1">
Pears
</button>
<button aria-controls="panel-0-0-2" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-2" name="0-2" role="tab" tabindex="-1">
Oranges
</button>
<button aria-controls="panel-0-0-3" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-3" name="0-3" role="tab" tabindex="-1">
404
</button>
</div>
<div aria-labelledby="tab-0-0-0" class="sphinx-tabs-panel" id="panel-0-0-0" name="0-0" role="tabpanel" tabindex="0">
<p>
Apples are green, or sometimes red.
</p>
</div>
<div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0">
<p>
Pears are green.
</p>
</div>
<div aria-labelledby="tab-0-0-2" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-2" name="0-2" role="tabpanel" tabindex="0">
<p>
Oranges are orange.
</p>
</div>
<div aria-labelledby="tab-0-0-3" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-3" name="0-3" role="tabpanel" tabindex="0">
<p>
A number in the name.
</p>
</div>
</div>
</div>
</div>
</div>
23 changes: 23 additions & 0 deletions tests/test_build/test_disable_css_loading.xml
@@ -0,0 +1,23 @@
<document source="index.rst">
<container classes="sphinx-tabs" type="tab-element">
<div aria-label="Tabbed content" classes="closeable" role="tablist">
<button aria-controls="panel-0-0-0" aria-selected="true" classes="sphinx-tabs-tab" ids="tab-0-0-0" name="0-0" role="tab" tabindex="0">
Apples
<button aria-controls="panel-0-0-1" aria-selected="false" classes="sphinx-tabs-tab" ids="tab-0-0-1" name="0-1" role="tab" tabindex="-1">
Pears
<button aria-controls="panel-0-0-2" aria-selected="false" classes="sphinx-tabs-tab" ids="tab-0-0-2" name="0-2" role="tab" tabindex="-1">
Oranges
<button aria-controls="panel-0-0-3" aria-selected="false" classes="sphinx-tabs-tab" ids="tab-0-0-3" name="0-3" role="tab" tabindex="-1">
404
<div aria-labelledby="tab-0-0-0" classes="sphinx-tabs-panel" ids="panel-0-0-0" name="0-0" role="tabpanel" tabindex="0">
<paragraph>
Apples are green, or sometimes red.
<div aria-labelledby="tab-0-0-1" classes="sphinx-tabs-panel" hidden="true" ids="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0">
<paragraph>
Pears are green.
<div aria-labelledby="tab-0-0-2" classes="sphinx-tabs-panel" hidden="true" ids="panel-0-0-2" name="0-2" role="tabpanel" tabindex="0">
<paragraph>
Oranges are orange.
<div aria-labelledby="tab-0-0-3" classes="sphinx-tabs-panel" hidden="true" ids="panel-0-0-3" name="0-3" role="tabpanel" tabindex="0">
<paragraph>
A number in the name.

0 comments on commit 5564197

Please sign in to comment.