Difference between revisions of "Module:HtmlBuilder"
(don't add attributes with no values, plus a couple of minor tweaks) |
(Created page with "-- Module for building complex HTML (e.g. infoboxes, navboxes) using a fluent interface. local HtmlBuilder = {} local metatable = {} metatable.__index = function(t, key)...") |
||
Line 1: | Line 1: | ||
-- Module for building complex HTML (e.g. infoboxes, navboxes) using a fluent interface. | -- Module for building complex HTML (e.g. infoboxes, navboxes) using a fluent interface. | ||
− | + | ||
local HtmlBuilder = {} | local HtmlBuilder = {} | ||
− | + | ||
local metatable = {} | local metatable = {} | ||
− | + | ||
metatable.__index = function(t, key) | metatable.__index = function(t, key) | ||
local ret = rawget(t, key) | local ret = rawget(t, key) | ||
Line 10: | Line 10: | ||
return ret | return ret | ||
end | end | ||
− | + | ||
ret = metatable[key] | ret = metatable[key] | ||
if type(ret) == 'function' then | if type(ret) == 'function' then | ||
Line 20: | Line 20: | ||
end | end | ||
end | end | ||
− | + | ||
metatable.__tostring = function(t) | metatable.__tostring = function(t) | ||
local ret = {} | local ret = {} | ||
Line 26: | Line 26: | ||
return table.concat(ret) | return table.concat(ret) | ||
end | end | ||
− | + | ||
metatable._build = function(t, ret) | metatable._build = function(t, ret) | ||
if t.tagName then | if t.tagName then | ||
Line 62: | Line 62: | ||
end | end | ||
end | end | ||
− | + | ||
metatable.node = function(t, builder) | metatable.node = function(t, builder) | ||
if builder then | if builder then | ||
Line 69: | Line 69: | ||
return t | return t | ||
end | end | ||
− | + | ||
metatable.wikitext = function(t, ...) | metatable.wikitext = function(t, ...) | ||
local vals = {...} | local vals = {...} | ||
Line 79: | Line 79: | ||
return t | return t | ||
end | end | ||
− | + | ||
metatable.newline = function(t) | metatable.newline = function(t) | ||
table.insert(t.nodes, '\n') | table.insert(t.nodes, '\n') | ||
return t | return t | ||
end | end | ||
− | + | ||
metatable.tag = function(t, tagName, args) | metatable.tag = function(t, tagName, args) | ||
args = args or {} | args = args or {} | ||
Line 92: | Line 92: | ||
return builder | return builder | ||
end | end | ||
− | + | ||
local function getAttr(t, name) | local function getAttr(t, name) | ||
for i, attr in ipairs(t.attributes) do | for i, attr in ipairs(t.attributes) do | ||
Line 100: | Line 100: | ||
end | end | ||
end | end | ||
− | + | ||
metatable.attr = function(t, name, val) | metatable.attr = function(t, name, val) | ||
if type(val) == 'string' or type(val) == 'number' then | if type(val) == 'string' or type(val) == 'number' then | ||
Line 108: | Line 108: | ||
return t | return t | ||
end | end | ||
− | + | ||
local attr = getAttr(t, name) | local attr = getAttr(t, name) | ||
if attr then | if attr then | ||
Line 116: | Line 116: | ||
end | end | ||
end | end | ||
− | + | ||
return t | return t | ||
end | end | ||
− | + | ||
metatable.addClass = function(t, class) | metatable.addClass = function(t, class) | ||
if class then | if class then | ||
Line 129: | Line 129: | ||
end | end | ||
end | end | ||
− | + | ||
return t | return t | ||
end | end | ||
− | + | ||
metatable.css = function(t, name, val) | metatable.css = function(t, name, val) | ||
if type(val) == 'string' or type(val) == 'number' then | if type(val) == 'string' or type(val) == 'number' then | ||
Line 141: | Line 141: | ||
end | end | ||
end | end | ||
− | + | ||
table.insert(t.styles, {name = name, val = val}) | table.insert(t.styles, {name = name, val = val}) | ||
end | end | ||
− | + | ||
return t | return t | ||
end | end | ||
− | + | ||
metatable.cssText = function(t, css) | metatable.cssText = function(t, css) | ||
if css then | if css then | ||
Line 154: | Line 154: | ||
return t | return t | ||
end | end | ||
− | + | ||
metatable.done = function(t) | metatable.done = function(t) | ||
return t.parent or t | return t.parent or t | ||
end | end | ||
− | + | ||
metatable.allDone = function(t) | metatable.allDone = function(t) | ||
while t.parent do | while t.parent do | ||
Line 165: | Line 165: | ||
return t | return t | ||
end | end | ||
− | + | ||
function HtmlBuilder.create(tagName, args) | function HtmlBuilder.create(tagName, args) | ||
args = args or {} | args = args or {} | ||
Line 179: | Line 179: | ||
return builder | return builder | ||
end | end | ||
− | + | ||
return HtmlBuilder | return HtmlBuilder |
Revision as of 09:17, 12 May 2014
Documentation for this module may be created at Module:HtmlBuilder/doc
-- Module for building complex HTML (e.g. infoboxes, navboxes) using a fluent interface.
local HtmlBuilder = {}
local metatable = {}
metatable.__index = function(t, key)
local ret = rawget(t, key)
if ret then
return ret
end
ret = metatable[key]
if type(ret) == 'function' then
return function(...)
return ret(t, ...)
end
else
return ret
end
end
metatable.__tostring = function(t)
local ret = {}
t._build(ret)
return table.concat(ret)
end
metatable._build = function(t, ret)
if t.tagName then
table.insert(ret, '<' .. t.tagName)
for i, attr in ipairs(t.attributes) do
table.insert(ret, ' ' .. attr.name .. '="' .. attr.val .. '"')
end
if #t.styles > 0 then
table.insert(ret, ' style="')
for i, prop in ipairs(t.styles) do
if type(prop) == 'string' then -- added with cssText()
table.insert(ret, prop .. ';')
else -- added with css()
table.insert(ret, prop.name .. ':' .. prop.val .. ';')
end
end
table.insert(ret, '"')
end
if t.selfClosing then
table.insert(ret, ' /')
end
table.insert(ret, '>')
end
for i, node in ipairs(t.nodes) do
if node then
if type(node) == 'table' then
node._build(ret)
else
table.insert(ret, tostring(node))
end
end
end
if t.tagName and not t.unclosed and not t.selfClosing then
table.insert(ret, '</' .. t.tagName .. '>')
end
end
metatable.node = function(t, builder)
if builder then
table.insert(t.nodes, builder)
end
return t
end
metatable.wikitext = function(t, ...)
local vals = {...}
for i = 1, #vals do
if vals[i] then
table.insert(t.nodes, vals[i])
end
end
return t
end
metatable.newline = function(t)
table.insert(t.nodes, '\n')
return t
end
metatable.tag = function(t, tagName, args)
args = args or {}
args.parent = t
local builder = HtmlBuilder.create(tagName, args)
table.insert(t.nodes, builder)
return builder
end
local function getAttr(t, name)
for i, attr in ipairs(t.attributes) do
if attr.name == name then
return attr
end
end
end
metatable.attr = function(t, name, val)
if type(val) == 'string' or type(val) == 'number' then
-- if caller sets the style attribute explicitly, then replace all styles previously added with css() and cssText()
if name == 'style' then
t.styles = {val}
return t
end
local attr = getAttr(t, name)
if attr then
attr.val = val
else
table.insert(t.attributes, {name = name, val = val})
end
end
return t
end
metatable.addClass = function(t, class)
if class then
local attr = getAttr(t, 'class')
if attr then
attr.val = attr.val .. ' ' .. class
else
t.attr('class', class)
end
end
return t
end
metatable.css = function(t, name, val)
if type(val) == 'string' or type(val) == 'number' then
for i, prop in ipairs(t.styles) do
if prop.name == name then
prop.val = val
return t
end
end
table.insert(t.styles, {name = name, val = val})
end
return t
end
metatable.cssText = function(t, css)
if css then
table.insert(t.styles, css)
end
return t
end
metatable.done = function(t)
return t.parent or t
end
metatable.allDone = function(t)
while t.parent do
t = t.parent
end
return t
end
function HtmlBuilder.create(tagName, args)
args = args or {}
local builder = {}
setmetatable(builder, metatable)
builder.nodes = {}
builder.attributes = {}
builder.styles = {}
builder.tagName = tagName
builder.parent = args.parent
builder.unclosed = args.unclosed or false
builder.selfClosing = args.selfClosing or false
return builder
end
return HtmlBuilder