feat: Add support for linking to section headings

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: '00:00'
+    timezone: UTC
+  open-pull-requests-limit: 10
+  commit-message:
+      prefix: "chore"
+      include: "scope"

dub.sdl

@@ -14,6 +14,10 @@ dependency "mustache-d" version="~>0.1"
 
 targetPath "build"
 
+// debugVersions "CodeHash"
+
+dflags "-preview=shortenedMethods"
+
 configuration "executable" {
 	targetType "executable"
 	versions "VibeDefaultMain"

dub.selections.json

@@ -3,20 +3,21 @@
 	"versions": {
 		"botan": "1.12.19",
 		"botan-math": "1.0.3",
-		"dfmt": "0.14.2",
+		"dfmt": "0.15.1",
 		"diet-ng": "1.8.1",
 		"dyaml": "0.9.2",
-		"eventcore": "0.9.22",
+		"eventcore": "0.9.25",
 		"libasync": "0.8.6",
-		"libdparse": "0.22.0",
-		"memutils": "1.0.4",
+		"libdparse": "0.23.2",
+		"memutils": "1.0.9",
 		"mir-linux-kernel": "1.0.1",
 		"mustache-d": "0.1.5",
-		"openssl": "3.2.2",
+		"openssl": "3.3.0",
+		"openssl-static": "1.0.2+3.0.8",
 		"stdx-allocator": "2.77.5",
 		"taggedalgebraic": "0.11.22",
 		"tinyendian": "0.2.0",
-		"vibe-core": "1.22.6",
-		"vibe-d": "0.9.5"
+		"vibe-core": "2.2.0",
+		"vibe-d": "0.9.6"
 	}
 }

public/static/css/common.css

@@ -174,3 +174,7 @@ pre code {
 .table-hover>tbody>tr:hover {
     background-color: #f5f5f5;
 }
+
+:target {
+  background-color: yellow;
+}

public/static/js/tour-controller.js

@@ -15,6 +15,14 @@ if (location.origin.indexOf("run.dlang.io") >= 0 || location.pathname.startsWith
 			requireBase: false
 		});
 	}]);
+} else {
+	dlangTourApp.config(['$locationProvider', function($locationProvider) {
+		$locationProvider.html5Mode({
+			enabled: true,
+			requireBase: false,
+			rewriteLinks: false,
+		});
+	}]);
 }
 
 dlangTourApp.controller('DlangTourAppCtrl',

source/app.d

@@ -57,7 +57,7 @@ private IExecProvider createExecProvider(Config config,
 
 	if (config.enableExecCache) {
 		import std.algorithm: map;
-		auto allowedSources = contentProvider.getContent()
+		auto allowedSources = contentProvider.getAllContent()
 			.map!(x => x.sourceCode.idup)
 			.array;
 		return new Cache(execProvider, allowedSources);
@@ -110,7 +110,7 @@ private void doSanityCheck(ContentProvider contentProvider, IExecProvider execPr
 
 	import std.parallelism : parallel;
 
-	auto content = contentProvider.getContent();
+	auto content = contentProvider.getAllContent();
 
 	if (cast(Docker) execProvider)
 		runChecks(content.parallel);

source/contentprovider.d

@@ -1,21 +1,25 @@
-import vibe.core.log;
-import vibe.textfilter.markdown;
+import vibe.core.log: logInfo, logError;
+import vibe.textfilter.markdown: MarkdownFlags, MarkdownSettings, filterMarkdown;
 
-import std.file;
+import std.file: exists, readText, dirEntries, isDir, SpanMode;
 import std.algorithm: splitter, filter, countUntil;
 import std.array: array, empty;
 import std.string: split, strip;
 import std.typecons: Tuple;
-import std.exception: enforce;
 import std.string: format;
 import std.path: baseName, buildPath;
 
-import dyaml;
-import mustache;
+import dyaml: Loader;
 
-import translator;
+import translator: Translator;
 
-alias MustacheEngine!(string) Mustache;
+alias enforce = imported!"std.exception".enforce!ContentProviderException;
+alias Mustache = imported!"mustache".MustacheEngine!(string);
+
+class ContentProviderException : Exception
+{
+	mixin imported!"std.exception".basicExceptionCtors;
+}
 
 /++
 	Manages the mark down files found in public/content
@@ -29,7 +33,7 @@ class ContentProvider
 	private immutable SourceCodeSectionTitle ="{SourceCode";
 	private immutable SourceCodeDisabled = ":disabled";
 	private immutable SourceCodeIncomplete = ":incomplete";
-	private immutable SourceCodeFullWidth =":fullWidth";
+	private immutable SourceCodeFullWidth = ":fullWidth";
 	private immutable SourceCodeMaxCharsPerLine = 48;
 
 	private {
@@ -102,19 +106,50 @@ class ContentProvider
 		return content;
 	}
 
-	private bool isValidLink(string link, string language)
+	private auto isValidLink(string link, string language)
 	{
-		import std.algorithm.searching : count;
-		if (link.count("/") != 1)
-			return false;
-
-		// check for existence in file system
 		import std.array : split;
-		auto parts = link.split("/");
+
+		static struct Result
+		{
+			string baseDir, path, fragment;
+
+			enum invalid = typeof(this).init;
+
+			bool opCast(T: bool)() => !!path;
+			string filename() => buildPath(baseDir, path ~ ".md");
+			string fragmentSuffix() => !fragment ? "" : '#' ~ fragment;
+			string routePath() => "/tour/%s/%s"
+				.format(baseDir.baseName, path ~ fragmentSuffix);
+		}
+
 		enforce(language in langWithPath, "Language hasn't been seen before.");
-		string fileName = buildPath(langWithPath[language], parts[0], parts[1] ~ ".md");
-		import std.stdio;
-		return exists(fileName);
+
+		auto parts = link.split("/");
+
+		if (parts.length != 2 || parts[0].empty || parts[1].empty)
+			return Result.invalid;
+
+		// Support links to chapter/section#heading
+		auto sectionAndFragment = parts[1].split("#");
+		parts[1] = sectionAndFragment[0];
+
+		Result r = {
+			baseDir: langWithPath[language],
+			path: buildPath(parts[0], parts[1]),
+			fragment: sectionAndFragment.length == 2
+				? sectionAndFragment[1]
+				: null,
+		};
+
+		enforce(r.fragment is null || r.fragment.length > 0,
+			"Fragment following # must not be empty.");
+
+		// check for existence in file system
+		if (!exists(r.filename))
+			return Result.invalid;
+
+		return r;
 	}
 
 	this(string contentDirectory)
@@ -170,8 +205,7 @@ class ContentProvider
 			langMeta.translator = new Translator();
 		}
 
-		import std.meta : AliasSeq;
-		foreach (attr; AliasSeq!("title", "repo"))
+		foreach (attr; imported!"std.meta".AliasSeq!("title", "repo"))
 		{
 			enforce(attr in root, "'" ~ attr ~ "' point required in language-specific yaml");
 			 mixin("langMeta." ~ attr ~ " = root[attr].as!string;");
@@ -212,12 +246,12 @@ class ContentProvider
 		scope (failure) logError("lang: %s, chapter: %s, section: %s failed", language, chapter, currentSection);
 		foreach (ref section; splitMarkdownBySection(readText(filename))) {
 			if (section.title.startsWith(SourceCodeSectionTitle)) {
-				enforce(section.level == 2, new Exception("%s: %s section expected to be on 2nd level"
-							.format(filename, SourceCodeSectionTitle)));
-				enforce(!content.html.empty, new Exception("%s: %s section must be within existing section."
-							.format(filename, SourceCodeSectionTitle)));
-				enforce(content.sourceCode.empty, new Exception("%s: Double %s section in '%s'"
-							.format(filename, SourceCodeSectionTitle, content.title)));
+				enforce(section.level == 2, "%s: %s section expected to be on 2nd level"
+							.format(filename, SourceCodeSectionTitle));
+				enforce(!content.html.empty, "%s: %s section must be within existing section."
+							.format(filename, SourceCodeSectionTitle));
+				enforce(content.sourceCode.empty, "%s: Double %s section in '%s'"
+							.format(filename, SourceCodeSectionTitle, content.title));
 				content.filename = filename;
 				content.sourceCode = section.bodyOnly;
 				// ignore markdown code blocks
@@ -235,14 +269,14 @@ class ContentProvider
 					checkSourceCodeLineWidth(content.sourceCode, content.title);
 			} else if (section.level == 1) {
 					enforce(content.title.length == 0,
-							new Exception("%s: Just one chapter title allowed: %s".format(filename, section.title)));
+							"%s: Just one chapter title allowed: %s".format(filename, section.title));
 					content.title = section.title;
 					content.html = processMarkdown(section.content, language);
 			} else if (section.level >= 2) {
-				enforce(content.title.length != 0, new Exception("%s: level 3 section can't be first (%s)".format(filename, section.title)));
+				enforce(content.title.length != 0, "%s: level 3 section can't be first (%s)".format(filename, section.title));
 				content.html ~= processMarkdown(section.content, language);
 			} else {
-				throw new Exception("%s: Illegal section %s".format(filename, section.title));
+				throw new ContentProviderException("%s: Illegal section %s".format(filename, section.title));
 			}
 		}
 		return content;
@@ -258,24 +292,26 @@ class ContentProvider
 	+/
 	private string processMarkdown(string content, string language)
 	{
+		import std.array : replace;
+		import std.algorithm.searching : startsWith;
+
 		auto processed = expandMacros(content, mustacheContext_);
 		auto settings = new MarkdownSettings;
 		with(MarkdownFlags)
 		settings.flags = backtickCodeBlocks | vanillaMarkdown | tables;
 		settings.urlFilter = (string link, bool) {
-			import std.algorithm.searching : startsWith;
 			if (link.startsWith("http", "https", "irc", "/"))
 				return link;
 			else
 			{
-				enforce(isValidLink(link, language), "Invalid link given: " ~ link);
-				return "/tour/%s/%s".format(language, link);
+				return isValidLink(link, language)
+					.enforce("Invalid link given: " ~ link)
+					.routePath;
 			}
 		};
 		auto text = filterMarkdown(processed, settings);
 		// workaround against vibe.textfiler.markdown inserting empty newlines
 		// in inline code blocks
-		import std.array : replace;
 		text = text.replace("\n\n</code></pre>", "\n</code></pre>");
 		return text;
 	}
@@ -287,6 +323,8 @@ class ContentProvider
 		cp.addLanguage(contentDir.buildPath("en"));
 
 		assert(cp.processMarkdown("[foo](welcome/welcome-to-d)", "en") == "<p><a href=\"/tour/en/welcome/welcome-to-d\">foo</a>\n</p>\n");
+		assert(cp.processMarkdown("[foo](welcome/welcome-to-d#what-is-d)", "en") == "<p><a href=\"/tour/en/welcome/welcome-to-d#what-is-d\">foo</a>\n</p>\n");
+		assert(cp.processMarkdown("[foo](basics/delegates#anonymous-functions-lambdas)", "en") == "<p><a href=\"/tour/en/basics/delegates#anonymous-functions-lambdas\">foo</a>\n</p>\n");
 		assert(cp.processMarkdown("[foo](http://dlang.org)", "en") == "<p><a href=\"http://dlang.org\">foo</a>\n</p>\n");
 	}
 
@@ -316,18 +354,17 @@ Text after`, "en");
 		to the SourceCodeMaxCharsPerLine bytes per lines
 		restriction.
 
-		Throws: Exception when contraint doesn't apply.
+		Throws: ContentProviderException when contraint doesn't apply.
 	+/
 	private void checkSourceCodeLineWidth(string sourceCode, string sectionTitle)
 	{
-		import std.algorithm: all;
 		import std.range.primitives : walkLength;
 		import std.uni : byGrapheme;
 		auto lineNo = 0;
 		foreach (line; splitter(sourceCode, '\n')) {
 			++lineNo;
 			if (line.byGrapheme.walkLength(SourceCodeMaxCharsPerLine + 1) > SourceCodeMaxCharsPerLine) {
-				throw new Exception("Source code line length exceeds %d limit in '%s': %s"
+				throw new ContentProviderException("Source code line length exceeds %d limit in '%s': %s"
 						.format(SourceCodeMaxCharsPerLine, sectionTitle, line));
 			}
 		}
@@ -381,7 +418,7 @@ Text after`, "en");
 			Tuple!(string, "title", string, "sectionId")[] sections;
 		}
 		auto chapterMeta = language in chapter_;
-		enforce(chapterMeta !is null, new Exception("%s not known.".format(language)));
+		enforce(chapterMeta !is null, "%s not known.".format(language));
 		Chapter[] toc = new Chapter[content_[language].length];
 
 		foreach (chapterId, sections; content_[language]) {
@@ -420,18 +457,15 @@ Text after`, "en");
 	  over the whole content, regardless of language. Content
 	  doesn't guarantee any order.
 	+/
-	auto getContent() const
+	auto getAllContent() const
 	{
-		alias Element = const(Content)*;
-		Element[] range;
-		foreach(ref chapters; content_) {
-			foreach(ref sections; chapters) {
-				foreach(ref content; sections) {
-					range ~= &content;
-				}
-			}
-		}
-		return range;
+		import std.algorithm : map, joiner;
+		return content_
+			.byValue
+			.map!byValue
+			.joiner
+			.map!byValue
+			.joiner;
 	}
 
 } // class ContentProvider
@@ -585,7 +619,7 @@ private string expandMacros(string content, Mustache.Context context)
 {
 	Mustache.Option options;
 	options.handler = (string tag) {
-		throw new Exception("Unknown template tag " ~ tag);
+		throw new ContentProviderException("Unknown template tag " ~ tag);
 	};
 	auto mustache = Mustache(options);
 	return mustache.renderString(content, context);