Module:HelperMethods
From MaRDI portal
Documentation for this module may be created at Module:HelperMethods/doc
------------------------------------------------------------------------------------
-- HelperMethods --
-- --
-- This module includes a number of helper functions for dealing with lists, --
-- e.g. in the person template. It is a meta-module, meant to be called from --
-- other Lua modules, and should not be called directly from #invoke. --
------------------------------------------------------------------------------------
local M = {}
-- Required modules for SPARQL queries and HTML table generation
local sparql = require('SPARQL')
local mwHtml = require('mw.html')
-- Utility function to trim and lowercase a string
function M.trimAndLower(str)
if str == nil then return nil end
str = str:gsub("^%s*(.-)%s*$", "%1")
return str:lower()
end
-- Utility function to count number of results in JSON answer of the SPQARL query
function M.countElementsInBindings(bindings)
if not bindings then return 0 end
local count = 0
while bindings[count] do
count = count + 1
end
return count
end
-- This function will replace spaces with + and encode other non-alphanumeric
-- characters into their percent-encoded representations, making the string
-- safe to use in a URL.
function M.urlencode(str)
if str then
str = string.gsub(str, "\n", "\r\n")
str = string.gsub(str, "([^%w %-%_%.%~])",
function (c) return string.format("%%%02X", string.byte(c)) end)
str = string.gsub(str, " ", "+")
end
return str
end
-- Function to convert JSON results into a Lua table
function M.convertJsonToTable(jsonResults)
local resultsTable = {}
if jsonResults and jsonResults.results and jsonResults.results.bindings then
local bindings = jsonResults.results.bindings
for j = 0, #bindings do
local row = {}
for key, value in pairs(bindings[j]) do
table.insert(row, value.value)
end
table.insert(resultsTable, row)
end
end
return resultsTable
end
-- Function to convert JSON results into a Lua table with specified field order
function M.convertJsonToTableOrdered(jsonResults,fieldOrder)
local resultsTable = {}
if jsonResults and jsonResults.results and jsonResults.results.bindings then
local bindings = jsonResults.results.bindings
for j = 0, #bindings do
local row = {}
for _, fieldName in ipairs(fieldOrder) do
local value = bindings[j][fieldName]
if value then
table.insert(row, value.value)
else
table.insert(row, nil)
end
end
table.insert(resultsTable, row)
end
end
return resultsTable
end
-- Additional function to generate the histogram data
-- colWithYear: Contains the index of the column that contains the year information. Expected format "2023-12-30"
function M.generateHistogramChartFromTable(dataTable, colWithYear)
local yearCounts = {}
for _, row in ipairs(dataTable) do
-- Extract the year from the fourth column (publication date)
local date = row[colWithYear]
if date then -- Check if the date exists
local year = date:sub(1, 4) -- Extract the year
if year ~= "" then
yearCounts[year] = (yearCounts[year] or 0) + 1
end
end
end
local years = {}
local counts = {}
for year, count in pairs(yearCounts) do
table.insert(years, year)
table.insert(counts, count)
end
-- Sort the years to maintain chronological order
table.sort(years)
local sortedCounts = {}
for _, year in ipairs(years) do
table.insert(sortedCounts, yearCounts[year])
end
local chartData = {
type = 'bar',
data = {
labels = years, -- x-axis labels (years)
datasets = {{
label = 'Number of Publications',
data = sortedCounts, -- y-axis data (counts)
backgroundColor = 'rgba(54, 162, 235, 0.2)',
borderColor = 'rgba(54, 162, 235, 1)',
hoverBackgroundColor = 'red',
borderWidth = 1
}}
},
options = {
scales = {
y = {
beginAtZero = true
}
}
}
}
return chartData
end
-- Function to create a HTML table from a Lua table where columns are merged
-- mergeColumns: contains a list of which columns should be merged, e.g. {{1, 2}, {4}} or {{2, 4}, {1, 3}}
function M.createHtmlTableWithMergedCols(dataTable, headers, mergeColumns)
local htmlTable = mwHtml.create('table')
htmlTable:addClass('wikitable'):attr('border', '1')
local headerRow = htmlTable:tag('tr')
-- Use the provided headers
for _, header in ipairs(headers) do
headerRow:tag('th'):wikitext(header)
end
for _, row in ipairs(dataTable) do
if not string.find(row[1], "/entity/statement/") then
local dataRow = htmlTable:tag('tr')
for _, cols in ipairs(mergeColumns) do
local combinedData
if #cols == 1 then
-- If only one column index is provided, use it as is, default to "N/A" string if nil
combinedData = row[cols[1]] or "N/A"
else
-- If two column indices are provided, merge them, defaulting to "N/A" string if nil
local col1Data = row[cols[1]] or "N/A"
local col2Data = row[cols[2]] or "N/A"
combinedData = '[' .. col1Data .. ' ' .. col2Data .. ']'
end
dataRow:tag('td'):wikitext(combinedData)
end
end
end
-- mw.log(htmlTable)
return tostring(htmlTable)
end
-- Function to convert Markdown text to Mediawiki format
function M.markdownToMediawiki(mdText)
if type(mdText) ~= 'string' then
error("Expected a string, got " .. type(mdText))
end
-- Replace Markdown bold **text** with MediaWiki bold '''text'''
mdText = string.gsub(mdText, "%*%*(.-)%*%*", "'''%1'''")
-- Replace links in Markdown format [text](url) with MediaWiki format [url text]
mdText = string.gsub(mdText, "%[(.-)%]%((.-)%)", "[%2 %1]")
-- Replace special escape sequences for line breaks and tabs
mdText = string.gsub(mdText, "\\N", "\n") -- Replace \N with newline
mdText = string.gsub(mdText, "\\T", "\t") -- Replace \T with tab
-- Convert headers
mdText = string.gsub(mdText, "\n### (.-)\n", "\n=== %1 ===\n")
mdText = string.gsub(mdText, "\n## (.-)\n", "\n== %1 ==\n")
mdText = string.gsub(mdText, "\n# (.-)\n", "\n= %1 =\n")
return mdText
end
return M
