Module:Infobox song

To generate {{Infobox song}}, invoke using the main function.

---

--------------------------
-- Module for [[Template:Infobox song]]
------------------------
local getArgs        = require('Module:Arguments').getArgs
local InfoboxBuilder = require('Module:InfoboxBuilder')
local DisplayFns     = require('Module:DisplayFunctions')
local ProcessingFns  = require('Module:ProcessingFunctions')
local constants      = require('Module:Constants')
local VariablesLua = mw.ext.VariablesLua

local p = {}


local function getMvClass(mv)
	-- probably should not use == with bool, but this is more explicit
	if mv == true then
		return 'true-cell'
	elseif mv == false then
		return 'false-cell'
	end
	
	return nil
end

local function makeDifficultiesRow(difficulties)
	local row = {}
	
	for _,v in ipairs(difficulties) do
		table.insert(row,
			{
				content = v,
				tag = 'th',
				css = {	['border-bottom-color'] = constants.get_difficulty_color(v)	}
			}
		)
	end
	
	return row
end


function p.main(frame)
	local args = getArgs(frame)
	local infobox = InfoboxBuilder.new();
	
	infobox:setName('Infobox song')
		:setParams{
			{ name = 'song id' },
			{ name = 'song name', default = mw.title.getCurrentTitle().text },
			{ name = 'jacket', default = 'Dummyalbumart.png' },
			{ name = 'jacket alt' },
			{ name = 'jacket alt 2' },
			{ name = 'japanese' },
			{ name = 'romaji' },
			{ name = 'english' },
			{ name = 'singers',   fn = ProcessingFns.stringToArray(',') },
			{ name = 'producers', fn = ProcessingFns.stringToArray(',') },
			{ name = 'duration', fn = ProcessingFns.stringToNumber },
			{ name = 'units', fn = ProcessingFns.stringToArray(';') },
			{ name = 'unlock' },
			{ name = 'arrangers', fn = ProcessingFns.stringToArray(',') },
			{ name = 'composers', fn = ProcessingFns.stringToArray(',') },
			{ name = 'lyricists', fn = ProcessingFns.stringToArray(',') },
			{ name = 'type' },
			{ name = 'bpm' },
			{ name = 'game duration', fn = ProcessingFns.stringToNumber },
			{ name = 'date' },
			{ name = '3d mv',       fn = ProcessingFns.stringToBoolOrNil },
			{ name = '2d mv',       fn = ProcessingFns.stringToBoolOrNil },
			{ name = 'original mv', fn = ProcessingFns.stringToBoolOrNil },
			{ name = 'easy difficulty' },
			{ name = 'normal difficulty' },
			{ name = 'hard difficulty' },
			{ name = 'expert difficulty' },
			{ name = 'master difficulty' },
			{ name = 'append difficulty', default = 'N/A' },
			{ name = 'easy notes' },
			{ name = 'normal notes' },
			{ name = 'hard notes' },
			{ name = 'expert notes' },
			{ name = 'master notes' },
			{ name = 'append notes', default = 'N/A' }
		}
		:setArgs(args)
		:processArgs()
		:setCategoryMap({
			['units'] = {
				['VIRTUAL SINGER']       = 'VIRTUAL SINGER songs',
				['Leo/need']             = 'Leo/need songs',
				['MORE MORE JUMP!']      = 'MORE MORE JUMP! songs',
				['Vivid BAD SQUAD']      = 'Vivid BAD SQUAD songs',
				['Wonderlands×Showtime'] = 'Wonderlands×Showtime songs',
				['25-ji, Nightcord de.'] = '25-ji, Nightcord de. songs',
				['Other']                = 'Other songs'
			},
			['unlock'] = {
				['Automatically unlocked'] = 'Songs unlocked automatically',
				['Music Shop'] = 'Songs unlocked from the Music Shop',
				['Present Box'] = 'Songs unlocked from the Present Box',
				['Main Story'] = 'Songs unlocked from the Main Story'
			},
			['type'] = {
				['Commissioned'] = 'Commissioned songs',
				['Contest winner'] = 'Contest winning songs',
				['Pre-existing'] = 'Pre-existing songs'
			},
			['3d mv'] = {
				[true] = 'Songs with 3D MV'
			},
			['2d mv'] = {
				[true] = 'Songs with 2D MV'
			},
			['original mv'] = {
				[true] = 'Songs with Original MV'
			},
		})

	infobox
		:addHeader({ tag = 'argth', content = 'song name' })
		:addImage({
			{ 
				tag = 'argtd',
				content = 'jacket',
				fn = DisplayFns.image('220px'),
				tabName = 'Original'
			},
			{
				tag = 'argtd',
				content = 'jacket alt',
				fn = DisplayFns.image('220px'),
				tabName = 'Alternate'
			},
			{
				tag = 'argtd',
				content = 'jacket alt 2',
				fn = DisplayFns.image('220px'),
				tabName = 'Alternate #2'
			},
		})
		:addRow(
			{
				{ tag = 'th', content = 'Japanese' },
				{ tag = 'argtd', content = 'japanese' }
			},
			{ hideIfEmpty = { 'japanese' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'Romaji' },
				{ tag = 'argtd', content = 'romaji' }
			},
			{ hideIfEmpty = { 'romaji' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'English' },
				{ tag = 'argtd', content = 'english' }
			},
			{ hideIfEmpty = { 'english' } }
		)
		:addHeader({ tag = 'th', content = 'Song Information' }, { subheader = true })
		:addRow(
			{
				{ 
					tag = 'argth', 
					content = 'singers', 
					fn = DisplayFns.pluralHeader({ 'Original singer', 'Original singers' }) 
				},
				{ 
					tag = 'argtd', 
					content = 'singers', 
					fn = DisplayFns.list('unbulleted') 
				}
			},
			{ hideIfEmpty = { 'singers' } }
		)
		:addRow(
			{
				{ 
					tag = 'argth', 
					content = 'producers', 
					fn = DisplayFns.pluralHeader({ 'Producer', 'Producers' })
				},
				{ 
					tag = 'argtd', 
					content = 'producers',
					fn = DisplayFns.list('unbulleted')
				}
			}
		)
		:addRow(
			{
				{
					tag = 'th',
					content = 'Duration'
				},
				{
					tag = 'argtd',
					content = 'duration',
					fn = DisplayFns.minutesAndSeconds
				}
			},
			{ hideIfEmpty = { 'duration' } }
		)
		:addHeader({ tag = 'th', content = 'In-game Information' }, { subheader = true })
		:addRow(
			{
				{ tag = 'th', content = 'Song ID' },
				{ tag = 'argtd', content = 'song id' }
			}
		)
		:addRow(
			{
				{ 
					tag = 'argth',
					content = 'units', 
					fn = DisplayFns.pluralHeader({ 'Unit category', 'Unit categories' }) 
				},
				{ 
					tag = 'argtd', 
					content = 'units', 
					fn = DisplayFns.list('unbulleted')
				}
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'How to unlock' },
				{ tag = 'argtd', content = 'unlock' }
			}
		)
		:addRow(
			{
				{ 
					tag = 'argth', 
					content = 'arrangers',
					fn = DisplayFns.pluralHeader({ 'Arranger', 'Arrangers' })
				},
				{ 
					tag = 'argtd',
					content = 'arrangers',
					fn = DisplayFns.list('unbulleted')
				}
			},
			{ hideIfEmpty = { 'arrangers' } }
		)
		:addRow(
			{
				{ 
					tag = 'argth',
					content = 'composers',
					fn = DisplayFns.pluralHeader({ 'Composer', 'Composers' })
				},
				{ 
					tag = 'argtd', 
					content = 'composers', 
					fn = DisplayFns.list('unbulleted') 
				}
			},
			{ hideIfEmpty = { 'composers' } }
		)
		:addRow(
			{
				{ 
					tag = 'argth',
					content = 'lyricists',
					fn = DisplayFns.pluralHeader({ 'Lyricist', 'Lyricists' })
				},
				{ 
					tag = 'argtd', 
					content = 'lyricists',
					fn = DisplayFns.list('unbulleted') 
				}
			},
			{ hideIfEmpty = { 'lyricists' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'Type' },
				{ tag = 'argtd', content = 'type' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'BPM' },
				{ tag = 'argtd', content = 'bpm' }
			}
		)
		:addRow(
			{
				{ 
					tag = 'th', 
					content = 'Duration (game)'
				},
				{
					tag = 'argtd',
					content = 'game duration',
					fn = DisplayFns.minutesAndSeconds
				}
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'Release date' },
				{ tag = 'argtd', content = 'date' }
			}
		)
		:addHeader({ tag = 'th', content = 'Music Video' }, { subheader = true })
		:addRow(
			{
				{ tag = 'th', content = '3D' },
				{ tag = 'th', content = '2D' },
				{ tag = 'th', content = 'Original' }
			},
			{ defaultCss = { ['text-align'] = 'center'	} }
		)
		:addRow(
			{
				{
					tag = 'argtd', 
					content = '3d mv',
					fn = DisplayFns.checkAndX, 
					classFns = { getMvClass }
				},
				{
					tag = 'argtd',
					content = '2d mv', 
					fn = DisplayFns.checkAndX,
					classFns = { getMvClass }
				},
				{
					tag = 'argtd', 
					content = 'original mv', 
					fn = DisplayFns.checkAndX, 
					classFns = { getMvClass }
				},
			},
			{ defaultCss = { ['text-align'] = 'center' } }
		)
		:addHeader({ tag = 'th', content = 'Difficulties' }, { subheader = true })
		:addRow(
			makeDifficultiesRow({ 'Easy', 'Normal', 'Hard' }),
			{
				defaultCss = { 
					['text-align'] = 'center',
					['border-bottom-style'] = 'solid' 
				}
			}
		)
		:addRow(
			{
				{ tag = 'argtd', content = 'easy difficulty' },
				{ tag = 'argtd', content = 'normal difficulty' },
				{ tag = 'argtd', content = 'hard difficulty' }
			},
			{ defaultCss = { ['text-align'] = 'center' } }
		)
		:addRow(
			makeDifficultiesRow({ 'Expert', 'Master', 'Append' }),
			{
				defaultCss = { 
					['text-align'] = 'center',
					['border-bottom-style'] = 'solid' 
				}
			}
		)
		:addRow(
			{
				{ tag = 'argtd', content = 'expert difficulty' },
				{ tag = 'argtd', content = 'master difficulty' },
				{ tag = 'argtd', content = 'append difficulty' }
			},
			{ defaultCss = { ['text-align'] = 'center' } }
		)
		:addHeader({ tag = 'th', content = 'Notes' }, { subheader = true })
		:addRow(
			makeDifficultiesRow({ 'Easy', 'Normal', 'Hard' }),
			{
				defaultCss = { 
					['text-align'] = 'center',
					['border-bottom-style'] = 'solid' 
				}
			}
		)
		:addRow(
			{
				{ tag = 'argtd', content = 'easy notes' },
				{ tag = 'argtd', content = 'normal notes' },
				{ tag = 'argtd', content = 'hard notes' }
			},
			{ defaultCss = { ['text-align'] = 'center' } }
		)
		:addRow(
			makeDifficultiesRow({ 'Expert', 'Master', 'Append' }),
			{
				defaultCss = { 
					['text-align'] = 'center',
					['border-bottom-style'] = 'solid' 
				}
			}
		)
		:addRow(
			{
				{ tag = 'argtd', content = 'expert notes' },
				{ tag = 'argtd', content = 'master notes' },
				{ tag = 'argtd', content = 'append notes' }
			},
			{ defaultCss = { ['text-align'] = 'center' } }
		)
	
	local categories = ""
	if mw.title.getCurrentTitle().namespace == 0 then
		categories = "[[Category:Songs]]" .. infobox:getCategories()
		
		local rawArgs = infobox:getRawArgs()
		VariablesLua.vardefine( 'song id', rawArgs['song id'] )
	end

	return infobox:tostring() .. categories
end

return p