The definitive list of the best of (consumer facing) open source.
from __future__ import annotations
from pathlib import Path
import re
import sys
import unittest
# Ensure core is on sys.path
CORE_DIR = Path(__file__).resolve().parents[1]
if str(CORE_DIR) not in sys.path:
sys.path.insert(0, str(CORE_DIR))
from source.generation.contents_generator import ( # noqa: E402
app_matches_platform,
generate_contents,
)
from source.generation.header_generator import ( # noqa: E402
generate_header,
generate_navbar,
generate_top_header,
)
from source.generation.tableofcontents_generator import ( # noqa: E402
generate_table_of_contents,
)
from source.utils.markdown_utils import slugify # noqa: E402
from source.utils.path_utils import COMPONENTS_DIR # noqa: E402
class TestGeneration(unittest.TestCase):
def test_app_matches_platform(self):
cross_app = {"platforms": ["Cross"]}
mac_app = {"platforms": ["MacOS"]}
self_app = {"platforms": ["SelfHost"]}
self.assertTrue(app_matches_platform(cross_app, "all"))
self.assertTrue(app_matches_platform(cross_app, "windows"))
self.assertTrue(app_matches_platform(cross_app, "macos"))
self.assertTrue(app_matches_platform(cross_app, "linux"))
self.assertFalse(app_matches_platform(cross_app, "selfhost"))
self.assertTrue(app_matches_platform(mac_app, "macos"))
self.assertFalse(app_matches_platform(mac_app, "windows"))
self.assertFalse(app_matches_platform(mac_app, "selfhost"))
self.assertTrue(app_matches_platform(self_app, "selfhost"))
self.assertFalse(app_matches_platform(self_app, "macos"))
def test_no_empty_tables_or_empty_parents(self):
platforms = ["all", "windows", "macos", "linux", "selfhost"]
empty_table_regex = re.compile(
r"(### [^\n]+)\n\n\| Name \| Description \| Platform\(s\) \| Stars \|\n\| --- \| --- \| --- \| --- \|\n\s*(?=\n|#|\Z)"
)
empty_parent_regex = re.compile(
r"(# [^\n]+ - \[Go to top\]\(#table-of-contents\))\n\n(?=# [^#]|\Z)"
)
for platform in platforms:
contents = generate_contents(platform)
empty_tables = empty_table_regex.findall(contents)
empty_parents = empty_parent_regex.findall(contents)
self.assertEqual(
empty_tables,
[],
f"Found empty tables in platform '{platform}': {empty_tables}",
)
self.assertEqual(
empty_parents,
[],
f"Found empty parent categories in platform '{platform}': {empty_parents}",
)
def test_table_of_contents_synchronized_with_contents(self):
platforms = ["all", "windows", "macos", "linux", "selfhost"]
for platform in platforms:
toc = generate_table_of_contents(platform)
contents = generate_contents(platform)
# Subcategory headings in contents
subcat_headings = set(re.findall(r"^###\s+([^\n]+)", contents, re.MULTILINE))
content_slugs = {slugify(name) for name in subcat_headings}
# TOC subcategory links
toc_links = re.findall(r"\[([^\]]+)\]\(#([^\)]+)\)", toc)
# Exclude fixed footer sections
fixed_slugs = {
slugify("Removed Projects"),
slugify("FAQ"),
slugify("Honorable Mentions of Closed-Source Software"),
}
for name, anchor in toc_links:
if anchor in fixed_slugs:
continue
self.assertIn(
anchor,
content_slugs,
f"Platform '{platform}': TOC link '{name}' (#{anchor}) does not exist in content",
)
def test_specific_known_empty_categories_omitted(self):
# selfhost should omit EMACS Packages, Operating System, etc.
selfhost_toc = generate_table_of_contents("selfhost")
selfhost_contents = generate_contents("selfhost")
self.assertNotIn("EMACS Packages", selfhost_toc)
self.assertNotIn("EMACS Packages", selfhost_contents)
self.assertNotIn("# Operating System - [Go to top]", selfhost_contents)
self.assertNotIn("# Extensions - [Go to top]", selfhost_contents)
# README.md (all) should omit EMACS Packages
all_toc = generate_table_of_contents("all")
all_contents = generate_contents("all")
self.assertNotIn("EMACS Packages", all_toc)
self.assertNotIn("### EMACS Packages", all_contents)
def test_navbar_highlighting(self):
platforms = {
"all": "Main / All",
"windows": "Windows",
"macos": "MacOS",
"linux": "Linux",
"selfhost": "SelfHosted",
}
for current_platform, current_name in platforms.items():
navbar = generate_navbar(current_platform)
# The current platform must be bold and bracketed, NOT a link
self.assertIn(f"<b>[ {current_name} ]</b>", navbar)
self.assertNotIn(f'>{current_name}</a>', navbar)
# All other platforms must be links
for other_platform, other_name in platforms.items():
if other_platform == current_platform:
continue
self.assertIn(f">{other_name}</a>", navbar)
self.assertNotIn(f"<b>[ {other_name} ]</b>", navbar)
def test_unified_header_contains_all_components(self):
platforms = ["all", "windows", "macos", "linux", "selfhost"]
for platform in platforms:
top_header = generate_top_header(platform)
self.assertIn("π v0.8.5-beta", top_header)
self.assertIn("Status: Active", top_header)
header = generate_header(platform)
# Version badge
self.assertIn("π v0.8.5-beta", header)
# Status
self.assertIn("Status: Active", header)
self.assertIn("Projects:", header)
# Tips & Web client link
self.assertIn("[!TIP]", header)
self.assertIn("[!NOTE]", header)
self.assertIn("https://dos.mustbeperfect.com", header)
# Navigation bar
self.assertIn('<h4 align="center">', header)
# Explanation sections
self.assertIn("**Our Goal -**", header)
self.assertIn("More Information", header)
self.assertIn("How The List Works", header)
self.assertIn("Project Status", header)
def test_tag_spacing(self):
contents = generate_contents("all")
# Check Ollama and Vim have space between emoji and property tag
self.assertIn("[Ollama](https://github.com/ollama/ollama) π `CLI`", contents)
self.assertNotIn("[Ollama](https://github.com/ollama/ollama) π`CLI`", contents)
self.assertIn("[Vim](https://github.com/vim/vim) π `CLI`", contents)
self.assertNotIn("[Vim](https://github.com/vim/vim) π`CLI`", contents)
# Ensure no emojis immediately followed by backticks anywhere in tables
self.assertNotRegex(contents, r"[\U00010000-\U0010ffff]`")
def test_go_to_top_anchor_standardized(self):
with open(COMPONENTS_DIR / "footer.md", "r", encoding="utf-8") as f:
footer = f.read()
self.assertIn('href="#table-of-contents"', footer)
self.assertNotIn('href="#tags"', footer)
if __name__ == "__main__":
unittest.main()