Merge pull request #128 from machow/test-spec-interlinks

Lua interlinks filter

Author: machow

Makefile

@@ -1,6 +1,22 @@
+EXAMPLE_INTERLINKS=quartodoc/tests/example_interlinks
+
 README.md: README.qmd
 	quarto render $<
 
+
+# These 2 rules are used to generate the example_interlinks folder,
+# which contains a full example for the interlinks filter to be tested
+
+$(EXAMPLE_INTERLINKS): scripts/filter-spec/generate_files.py
+	python3 $<
+
+$(EXAMPLE_INTERLINKS)/test.qmd: scripts/filter-spec/generate_test_qmd.py
+	python3 $<
+
+$(EXAMPLE_INTERLINKS)/test.md: $(EXAMPLE_INTERLINKS)/test.qmd _extensions/interlinks-experimental/interlinks.lua
+	cd $(EXAMPLE_INTERLINKS) && quarto render test.qmd --to gfm
+
+
 examples/%/_site: examples/%/_quarto.yml
 	cd examples/$* \
 		&& quarto add --no-prompt ../.. \
@@ -9,6 +25,7 @@ examples/%/_site: examples/%/_quarto.yml
 	cd examples/$* && quartodoc interlinks
 	quarto render $(dir $<)
 
+
 docs/examples/%: examples/%/_site
 	rm -rf docs/examples/$*
 	cp -rv $< $@
@@ -21,5 +38,7 @@ docs-build: docs-build-examples
 	cd docs && quartodoc interlinks
 	quarto render docs
 
+test-interlinks: quartodoc/tests/example_interlinks/test.md
+
 requirements-dev.txt:
 	pip-compile setup.cfg --extra dev -o $@

_extensions/interlinks/README.md

@@ -4,4 +4,4 @@ version: 1.0.0
 quarto-required: ">=1.2.0"
 contributes:
   filters:
-    - interlinks.py
+    - interlinks.lua

_extensions/interlinks/_extension.yml

@@ -0,0 +1,183 @@
+local function read_json(filename)
+    local file = io.open(filename, "r")
+    if file == nil then
+        return nil
+    end
+    local str = file:read("a")
+    file:close()
+    return quarto.json.decode(str)
+end
+
+local inventory = {}
+
+function lookup(search_object)
+
+    local results = {}
+    for ii, inventory in ipairs(inventory) do
+        for jj, item in ipairs(inventory.items) do
+            -- e.g. :external+<inv_name>:<domain>:<role>:`<name>`
+            if item.inv_name and item.inv_name ~= search_object.inv_name then
+                goto continue
+            end
+
+            if item.name ~= search_object.name then
+                goto continue
+            end
+
+            if search_object.role and item.role ~= search_object.role then
+                goto continue
+            end
+
+            if search_object.domain and item.domain ~= search_object.domain then
+                goto continue
+            else
+                table.insert(results, item)
+
+                goto continue
+            end
+
+            ::continue::
+        end
+    end
+
+    if #results == 1 then
+        return results[1]
+    end
+    if #results > 1 then
+        print("Found multiple matches for " .. search_object.name)
+        quarto.utils.dump(results)
+        return nil
+    end
+    if #results == 0 then
+        print("Found no matches for object:")
+        quarto.utils.dump(search_object)
+    end
+
+    return nil
+end
+
+function mysplit (inputstr, sep)
+    if sep == nil then
+            sep = "%s"
+    end
+    local t={}
+    for str in string.gmatch(inputstr, "([^"..sep.."]+)") do
+            table.insert(t, str)
+    end
+    return t
+end
+
+local function normalize_role(role)
+    if role == "func" then
+        return "function"
+    end
+    return role
+end
+
+local function build_search_object(str)
+    local starts_with_colon = str:sub(1, 1) == ":"
+    local search = {}
+    if starts_with_colon then
+        local t = mysplit(str, ":")
+        if #t == 2 then
+            -- e.g. :py:func:`my_func`
+            search.role = normalize_role(t[1])
+            search.name = t[2]:match("%%60(.*)%%60")
+        elseif #t == 3 then
+            -- e.g. :py:func:`my_func`
+            search.domain = t[1]
+            search.role = normalize_role(t[2])
+            search.name = t[3]:match("%%60(.*)%%60")
+        elseif #t == 4 then
+            -- e.g. :ext+inv:py:func:`my_func`
+            search.external = true
+
+            search.inv_name = t[1]:match("external%+(.*)")
+            search.domain = t[2]
+            search.role = normalize_role(t[3])
+            search.name = t[4]:match("%%60(.*)%%60")
+        else
+            print("couldn't parse this link: " .. str)
+            return {}
+        end
+    else
+        search.name = str:match("%%60(.*)%%60")
+    end
+
+    if search.name == nil then
+        print("couldn't parse this link: " .. str)
+        return {}
+    end
+
+    if search.name:sub(1, 1) == "~" then
+        search.shortened = true
+        search.name = search.name:sub(2, -1)
+    end
+    return search
+end
+
+function report_broken_link(link, search_object, replacement)
+    -- TODO: how to unescape html elements like [?
+    return pandoc.Code(pandoc.utils.stringify(link.content))
+end
+
+function Link(link)
+    -- do not process regular links ----
+    if not link.target:match("%%60") then
+        return link
+    end
+
+    -- lookup item ----
+    local search = build_search_object(link.target)
+    local item = lookup(search)
+
+    -- determine replacement, used if no link text specified ----
+    local original_text = pandoc.utils.stringify(link.content)
+    local replacement = search.name
+    if search.shortened then
+        local t = mysplit(search.name, ".")
+        replacement = t[#t]
+    end
+
+    -- set link text ----
+    if original_text == "" then
+        link.content = replacement
+    end
+
+    -- report broken links ----
+    if item == nil then
+        return report_broken_link(link, search)
+    end
+    link.target = item.uri:gsub("%$$", search.name)
+
+
+    return link
+end
+
+function fixup_json(json, prefix)
+    for _, item in ipairs(json.items) do
+        item.uri = prefix .. item.uri
+    end
+    table.insert(inventory, json)
+end
+
+return {
+    {
+        Meta = function(meta)
+            local json
+            local prefix
+            for k, v in pairs(meta.interlinks.sources) do
+                json = read_json(quarto.project.offset .. "/_inv/" .. k .. "_objects.json")
+                prefix = pandoc.utils.stringify(v.url)
+                fixup_json(json, prefix)
+            end
+            json = read_json(quarto.project.offset .. "/objects.json")
+            if json ~= nil then
+                fixup_json(json, "/")
+            end
+        end
+    },
+    {
+        Link = Link
+    }
+}