pelican-linkclass 2.1.2__py3-none-any.whl → 2.1.4__py3-none-any.whl

pelican/plugins/linkclass/test_linkclass.py

@@ -0,0 +1,212 @@
+"""Unit testing suite for the Link Class Plugin."""
+
+# Copyright (C) 2015, 2017, 2019, 2021-2023  Rafael Laboissière <rafael@laboissiere.net>  # noqa: E501
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Affero Public License as published by
+# the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see http://www.gnu.org/licenses/.
+
+# For running this test in a standalone-way, run:
+#     (cd .. ; python3 -Wd -m unittest discover)
+
+from io import StringIO
+import os
+import re
+from shutil import rmtree
+import sys
+from tempfile import mkdtemp
+import unittest
+
+from pelican import Pelican
+from pelican.settings import read_settings
+
+from . import linkclass
+
+INTERNAL_CLASS = "internal"
+EXTERNAL_CLASS = "external"
+
+INTERNAL_INLINE_TEXT = "internal inline text"
+INTERNAL_INLINE_LINK = "internal inline link"
+
+INTERNAL_REFERENCE_TEXT = "internal reference text"
+INTERNAL_REFERENCE_LABEL = "internal reference label"
+INTERNAL_REFERENCE_LINK = "internal-reference-link"
+
+EXTERNAL_INLINE_TEXT_HTTP = "external inline text http"
+EXTERNAL_INLINE_LINK_HTTP = "https://inline.org"
+
+EXTERNAL_REFERENCE_TEXT_HTTP = "external reference text http"
+EXTERNAL_REFERENCE_LABEL_HTTP = "external reference label http"
+EXTERNAL_REFERENCE_LINK_HTTP = "https://reference.org"
+
+EXTERNAL_INLINE_TEXT_HTTPS = "external inline text https"
+EXTERNAL_INLINE_LINK_HTTPS = "https://inline.org"
+
+EXTERNAL_REFERENCE_TEXT_HTTPS = "external reference text https"
+EXTERNAL_REFERENCE_LABEL_HTTPS = "external reference label https"
+EXTERNAL_REFERENCE_LINK_HTTPS = "https://reference.org"
+
+LINK_PATTERN = '<a class="{}" href="{}">{}</a>'
+
+TEST_FILE_STEM = "test"
+TEST_DIR_PREFIX = "pelicantests."
+
+
+class TestLinkClass(unittest.TestCase):
+    """Class for testing the <a> output elements generated by the Link Class plugin."""
+
+    def setUp(self, override=None):
+        self.output_path = mkdtemp(prefix=TEST_DIR_PREFIX)
+        self.content_path = mkdtemp(prefix=TEST_DIR_PREFIX)
+        settings = {
+            "PATH": self.content_path,
+            "OUTPUT_PATH": self.output_path,
+            "PLUGINS": [linkclass],
+            "CACHE_CONTENT": False,
+            "SITEURL": "http://example.org",
+            "TIMEZONE": "UTC",
+            "LINKCLASS": (
+                ("INTERNAL_CLASS", INTERNAL_CLASS),
+                ("EXTERNAL_CLASS", EXTERNAL_CLASS),
+            ),
+        }
+        if override:
+            settings.update(override)
+
+        # Generate the test Markdown source file
+        with open(
+            os.path.join(self.content_path, f"{TEST_FILE_STEM}.md"),
+            "w",
+        ) as fid:
+            template = """Title: Test
+Date: 1970-01-01
+
+This is an [{}]({}), inline-style link.
+This is an [{}]({}), inline-style link (with http URL).
+This is an [{}]({}), inline-style link (with https URL).
+
+This is an [{}][{}], reference-style link.
+This is an [{}][{}], reference-style link (with http URL).
+This is an [{}][{}], reference-style link (with https URL).
+
+ [{}]: {}
+ [{}]: {}
+ [{}]: {}
+
+"""
+            fid.write(
+                template.format(
+                    INTERNAL_INLINE_TEXT,
+                    INTERNAL_INLINE_LINK,
+                    EXTERNAL_INLINE_TEXT_HTTP,
+                    EXTERNAL_INLINE_LINK_HTTP,
+                    EXTERNAL_INLINE_TEXT_HTTPS,
+                    EXTERNAL_INLINE_LINK_HTTP,
+                    INTERNAL_REFERENCE_TEXT,
+                    INTERNAL_REFERENCE_LABEL,
+                    EXTERNAL_REFERENCE_TEXT_HTTP,
+                    EXTERNAL_REFERENCE_LABEL_HTTP,
+                    EXTERNAL_REFERENCE_TEXT_HTTPS,
+                    EXTERNAL_REFERENCE_LABEL_HTTPS,
+                    INTERNAL_REFERENCE_LABEL,
+                    INTERNAL_REFERENCE_LINK,
+                    EXTERNAL_REFERENCE_LABEL_HTTP,
+                    EXTERNAL_REFERENCE_LINK_HTTP,
+                    EXTERNAL_REFERENCE_LABEL_HTTPS,
+                    EXTERNAL_REFERENCE_LINK_HTTPS,
+                )
+            )
+
+        # Run the Pelican instance
+        self.settings = read_settings(override=settings)
+        pelican = Pelican(settings=self.settings)
+        saved_stdout = sys.stdout
+        sys.stdout = StringIO()
+        pelican.run()
+        sys.stdout = saved_stdout
+
+    def tearDown(self):
+        """Remove the temporary directories."""
+        rmtree(self.output_path)
+        rmtree(self.content_path)
+
+    def search(self, string):
+        """Search for a string in the article output."""
+        with open(
+            os.path.join(self.output_path, f"{TEST_FILE_STEM}.html"),
+        ) as fid:
+            found = False
+            for line in fid.readlines():
+                if re.search(string, line):
+                    found = True
+                    break
+        return found
+
+    def test_internal_inline(self):
+        """Test for the internal inline link."""
+        assert self.search(
+            LINK_PATTERN.format(
+                INTERNAL_CLASS,
+                INTERNAL_INLINE_LINK,
+                INTERNAL_INLINE_TEXT,
+            )
+        )
+
+    def test_external_inline_http(self):
+        """Test for the external http inline link."""
+        assert self.search(
+            LINK_PATTERN.format(
+                EXTERNAL_CLASS,
+                EXTERNAL_INLINE_LINK_HTTP,
+                EXTERNAL_INLINE_TEXT_HTTP,
+            )
+        )
+
+    def test_external_inline_https(self):
+        """Test for the external https inline link."""
+        assert self.search(
+            LINK_PATTERN.format(
+                EXTERNAL_CLASS,
+                EXTERNAL_INLINE_LINK_HTTPS,
+                EXTERNAL_INLINE_TEXT_HTTPS,
+            )
+        )
+
+    def test_internal_reference(self):
+        """Test for the internal reference link."""
+        assert self.search(
+            LINK_PATTERN.format(
+                INTERNAL_CLASS,
+                INTERNAL_REFERENCE_LINK,
+                INTERNAL_REFERENCE_TEXT,
+            )
+        )
+
+    def test_external_reference_http(self):
+        """Test for the external http reference link."""
+        assert self.search(
+            LINK_PATTERN.format(
+                EXTERNAL_CLASS,
+                EXTERNAL_REFERENCE_LINK_HTTP,
+                EXTERNAL_REFERENCE_TEXT_HTTPS,
+            )
+        )
+
+    def test_external_reference_https(self):
+        """Test for the external https reference link."""
+        assert self.search(
+            LINK_PATTERN.format(
+                EXTERNAL_CLASS,
+                EXTERNAL_REFERENCE_LINK_HTTPS,
+                EXTERNAL_REFERENCE_TEXT_HTTPS,
+            )
+        )

{pelican_linkclass-2.1.2.dist-info → pelican_linkclass-2.1.4.dist-info}/METADATA

@@ -1,14 +1,10 @@
 Metadata-Version: 2.1
 Name: pelican-linkclass
-Version: 2.1.2
+Version: 2.1.4
 Summary: Pelican plugin to set anchor tag's class attribute to differentiate between internal and external links
-Project-URL: Homepage, https://github.com/pelican-plugins/linkclass
-Project-URL: Issue Tracker, https://github.com/pelican-plugins/linkclass/issues
-Project-URL: Funding, https://donate.getpelican.com/
-Author-email: Rafael Laboissière <rafael@laboissiere.net>
+Keywords: pelican,plugin,link class
+Author-Email: =?utf-8?q?Rafael_Laboissi=C3=A8re?= <rafael@laboissiere.net>
 License: AGPL-3.0
-License-File: LICENSE
-Keywords: link class,pelican,plugin
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Framework :: Pelican
@@ -21,13 +17,17 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: Homepage, https://github.com/pelican-plugins/linkclass
+Project-URL: Issue tracker, https://github.com/pelican-plugins/linkclass/issues
+Project-URL: Funding, https://donate.getpelican.com/
 Requires-Python: <4.0,>=3.8.1
 Requires-Dist: pelican>=4.5
 Requires-Dist: py3dns>=3.2
+Requires-Dist: markdown>=3.4; extra == "markdown"
 Provides-Extra: markdown
-Requires-Dist: markdown>=3.4; extra == 'markdown'
 Description-Content-Type: text/markdown
 
 Link Class: A Plugin for Pelican

pelican_linkclass-2.1.4.dist-info/RECORD

@@ -0,0 +1,8 @@
+pelican/plugins/linkclass/__init__.py,sha256=re7EWl6N43Ej9nzpMFA7ajrG5TBjlQAQmoYRK27mo28,39
+pelican/plugins/linkclass/linkclass.py,sha256=CtfkYJhNq9_g4hy40gvhfIk8f-CvI4QBLrhyHEbfVRg,1790
+pelican/plugins/linkclass/mdx_linkclass.py,sha256=bISYENA4fq1z-ZY5z0TH6qCA5HRbsc4M4oZTd1yIZ0Q,3978
+pelican/plugins/linkclass/test_linkclass.py,sha256=WssY-P0Ita2oQW5DObaof7JSCZZjypnbLwIK9NK9XsM,7013
+pelican_linkclass-2.1.4.dist-info/METADATA,sha256=QQIpZAwZhsojyWTrWVbtQY2_D0YJx0d4FkTPLHDnlhw,5384
+pelican_linkclass-2.1.4.dist-info/WHEEL,sha256=gZRWN_1fGFDwBnXrZ9N3dgvbKlKgo5AUcDIMajlGpKM,90
+pelican_linkclass-2.1.4.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+pelican_linkclass-2.1.4.dist-info/RECORD,,

{pelican_linkclass-2.1.2.dist-info → pelican_linkclass-2.1.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.18.0
+Generator: pdm-backend (2.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any

pelican_linkclass-2.1.2.dist-info/RECORD

@@ -1,8 +0,0 @@
-tasks.py,sha256=R4_NgphMhr2hskgNHL1nh9MACePHIqcwjEnDz6gAaJ4,3167
-pelican/plugins/linkclass/__init__.py,sha256=re7EWl6N43Ej9nzpMFA7ajrG5TBjlQAQmoYRK27mo28,39
-pelican/plugins/linkclass/linkclass.py,sha256=CtfkYJhNq9_g4hy40gvhfIk8f-CvI4QBLrhyHEbfVRg,1790
-pelican/plugins/linkclass/mdx_linkclass.py,sha256=bISYENA4fq1z-ZY5z0TH6qCA5HRbsc4M4oZTd1yIZ0Q,3978
-pelican_linkclass-2.1.2.dist-info/METADATA,sha256=qgC6-tyaD0e6D7eO6BQrOEnzWI-VuAlYQz1phl0VVg8,5339
-pelican_linkclass-2.1.2.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
-pelican_linkclass-2.1.2.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-pelican_linkclass-2.1.2.dist-info/RECORD,,

tasks.py

@@ -1,99 +0,0 @@
-from inspect import cleandoc
-import logging
-import os
-from pathlib import Path
-from shutil import which
-
-from invoke import task
-
-logger = logging.getLogger(__name__)
-
-PKG_NAME = "linkclass"
-PKG_PATH = Path(f"pelican/plugins/{PKG_NAME}")
-
-ACTIVE_VENV = os.environ.get("VIRTUAL_ENV", None)
-VENV_HOME = Path(os.environ.get("WORKON_HOME", "~/.local/share/virtualenvs"))
-VENV_PATH = Path(ACTIVE_VENV) if ACTIVE_VENV else (VENV_HOME.expanduser() / PKG_NAME)
-VENV = str(VENV_PATH.expanduser())
-BIN_DIR = "bin" if os.name != "nt" else "Scripts"
-VENV_BIN = Path(VENV) / Path(BIN_DIR)
-
-TOOLS = ("pdm", "pre-commit")
-PDM = which("pdm") if which("pdm") else (VENV_BIN / "pdm")
-CMD_PREFIX = f"{VENV_BIN}/" if ACTIVE_VENV else f"{PDM} run "
-PRECOMMIT = which("pre-commit") if which("pre-commit") else f"{CMD_PREFIX}pre-commit"
-PTY = os.name != "nt"
-
-
-@task
-def tests(c, deprecations=False):
-    """Run the test suite, optionally with `--deprecations`."""
-    deprecations_flag = "" if deprecations else "-W ignore::DeprecationWarning"
-    c.run(f"{CMD_PREFIX}pytest {deprecations_flag}", pty=PTY)
-
-
-@task
-def black(c, check=False, diff=False):
-    """Run Black auto-formatter, optionally with `--check` or `--diff`."""
-    check_flag, diff_flag = "", ""
-    if check:
-        check_flag = "--check"
-    if diff:
-        diff_flag = "--diff"
-    c.run(f"{CMD_PREFIX}black {check_flag} {diff_flag} {PKG_PATH} tasks.py", pty=PTY)
-
-
-@task
-def ruff(c, fix=False, diff=False):
-    """Run Ruff to ensure code meets project standards."""
-    diff_flag, fix_flag = "", ""
-    if fix:
-        fix_flag = "--fix"
-    if diff:
-        diff_flag = "--diff"
-    c.run(f"{CMD_PREFIX}ruff check {diff_flag} {fix_flag} .", pty=PTY)
-
-
-@task
-def lint(c, fix=False, diff=False):
-    """Check code style via linting tools."""
-    ruff(c, fix=fix, diff=diff)
-    black(c, check=(not fix), diff=diff)
-
-
-@task
-def tools(c):
-    """Install development tools in the virtual environment if not already on PATH."""
-    for tool in TOOLS:
-        if not which(tool):
-            logger.info(f"** Installing {tool} **")
-            c.run(f"{CMD_PREFIX}pip install {tool}")
-
-
-@task
-def precommit(c):
-    """Install pre-commit hooks to .git/hooks/pre-commit."""
-    logger.info("** Installing pre-commit hooks **")
-    c.run(f"{PRECOMMIT} install")
-
-
-@task
-def setup(c):
-    """Set up the development environment."""
-    if which("pdm") or ACTIVE_VENV:
-        tools(c)
-        c.run(f"{CMD_PREFIX}python -m pip install --upgrade pip", pty=PTY)
-        c.run(f"{PDM} update --dev", pty=PTY)
-        precommit(c)
-        logger.info("\nDevelopment environment should now be set up and ready!\n")
-    else:
-        error_message = """
-            PDM is not installed, and there is no active virtual environment available.
-            You can either manually create and activate a virtual environment, or you can
-            install PDM via:
-
-            curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3 -
-
-            Once you have taken one of the above two steps, run `invoke setup` again.
-            """  # noqa: E501
-        raise SystemExit(cleandoc(error_message))