✨ feat(plugins): add FIGlet plugin

.gitignore

@@ -2,3 +2,4 @@ __pycache__/
 *coverage*
 .vscode/
 dist/
+*bat

doteki/plugins/figlet.py

@@ -0,0 +1,39 @@
+import logging
+import pyfiglet  # type: ignore
+from typing import Any
+
+
+def run(settings: dict[str, Any]) -> str | None:
+
+    if not validate_settings(settings):
+        return None
+    text = settings.get("ascii_text")
+    font = settings.get("font", "standard")
+    result = pyfiglet.figlet_format(text, font)
+    result = "<pre>" + result + "</pre>"
+    return str(result)
+
+
+def validate_settings(settings: dict[str, Any]) -> bool:
+
+    text = settings.get("ascii_text")
+    font = settings.get("font", "standard")
+
+    errors = []
+
+    # Check required setting.
+    if "ascii_text" not in settings:
+        errors.append("No text provided for the Figlet plugin")
+
+    try:
+        pyfiglet.figlet_format("test", font)
+
+    except pyfiglet.FontNotFound:
+        errors.append("Invalid font for the Figlet plugin")
+
+    if errors:
+        for error in errors:
+            logging.error(error)
+        return False
+
+    return True

pyproject.toml

@@ -29,16 +29,19 @@ python = "^3.11"
 # Optional dependencies for plugins.
 feedparser = { version = "^6.0", optional = true }
 requests = { version = "^2.28", optional = true }
+pyfiglet = { version = "^1.0.2", optional = true}
 
 
 [tool.poetry.extras]
 # Plugin dependencies.
 all = [ # This enables `pip install doteki[all]`. Should contain all dependencies below.
     "requests",
     "feedparser",
+    "pyfiglet",
 ]
 lastfm = ["requests"]
 feed = ["requests", "feedparser"]
+figlet = ["pyfiglet"]
 
 [build-system]
 requires = ["poetry-core"]

tests/plugins/test_figlet.py

@@ -0,0 +1,63 @@
+import logging
+from doteki.plugins.figlet import run
+
+
+def test_prototype():
+    settings = {"ascii_text": "hola"} 
+    expected = """ _           _       \n| |__   ___ | | __ _ \n| '_ \\ / _ \\| |/ _` |\n| | | | (_) | | (_| |\n|_| |_|\\___/|_|\\__,_|\n                     \n"""
+    expected = "<pre>" + expected + "</pre>"
+    result = run(settings)
+    expected = expected.replace(" ", "S").replace("\n","r")
+    result = result.replace(" ", "S").replace("\n","r")
+
+    print(repr(expected))
+    print(repr(result))
+    assert result == expected
+
+
+def test_proto_2():
+    import pyfiglet
+
+    expected = """ _           _       \n| |__   ___ | | __ _ \n| '_ \\ / _ \\| |/ _` |\n| | | | (_) | | (_| |\n|_| |_|\\___/|_|\\__,_|\n                     \n"""
+    result = pyfiglet.figlet_format("hola")
+
+    #expected = expected.replace(" ", "S").replace("\n","r")
+    #result = result.replace(" ", "S").replace("\n","r")
+
+    #print(repr(expected))
+    #print(repr(result))
+    assert result == expected
+
+#If no parameters, result is none
+#Test is superseeded by test_empty_text
+"""def test_empty_settings(caplog):
+
+    settings = {}
+
+    with caplog.at_level(logging.ERROR):
+        result = run(settings)
+    assert result is None
+    assert "No settings provided for the Figlet plugin" in caplog.text"""
+
+#If no text, result is none
+
+def test_empty_text(caplog):
+
+    settings = {"font": "standard"}
+
+    with caplog.at_level(logging.ERROR):
+        result = run(settings)
+    assert result is None
+    assert "No text provided for the Figlet plugin" in caplog.text
+
+
+#If invalid font, result is none
+
+def test_invalid_font(caplog):
+
+    settings = {"ascii_text": "hola", "font": "invalid_font"}
+
+    with caplog.at_level(logging.ERROR):
+        result = run(settings)
+    assert result is None
+    assert "Invalid font for the Figlet plugin" in caplog.text

website/docs/plugins/figlet.md

@@ -0,0 +1,37 @@
+# Figlet Plugin
+
+Display text with customizable ASCII art using Figlet fonts. If no font is provided, it defaults to the standard output. Useful for adding decorative displays in your documents or applications.
+
+## Configuration
+
+The Figlet plugin can be configured with the following parameters:
+
+- `text`: Text to be rendered in ASCII font.
+- `font`: Specify the Figlet font to use for rendering the text. Default is standard ASCII font.
+
+## Usage
+
+Using a custom format and prepending and appending some text:
+
+```toml title="doteki.toml"
+[sections.ascii_art]
+plugin = "figlet"
+ascii_text = "text"
+font = "standard"
+```
+
+dōteki would generate:
+
+```md
+ _            _
+| |_ _____  _| |_
+| __/ _ \ \/ / __|
+| ||  __/>  <| |_
+ \__\___/_/\_\\__|
+```
+
+## Frequently Asked Questions
+
+### What are the available fonts?
+
+Check the [FIGlet official site](http://www.figlet.org/#format-codes) to see several samples of available fonts.