Difference between revisions of "Module:TimeAgo"

From Sarkarverse
Jump to navigation Jump to search
m (1 revision)
 
m (1 revision)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
-- Replacement for [[Template:Time ago]]
 
-- Replacement for [[Template:Time ago]]
 
local getArgs = require('Module:Arguments').getArgs
 
local getArgs = require('Module:Arguments').getArgs
 +
local numberSpell = require('Module:NumberSpell')._main
 +
local yesno = require('Module:Yesno')
  
 
local p = {}
 
local p = {}
Line 30: Line 32:
 
local min_magnitude = args.min_magnitude
 
local min_magnitude = args.min_magnitude
 
local purge = args.purge
 
local purge = args.purge
 +
local spell_out = args.spellout
 +
local spell_out_max = args.spelloutmax
 
 
 
-- Generate the "ago" string. If ago is the blank string, do nothing - this allows overriding of args.ago
 
-- Generate the "ago" string. If ago is the blank string, do nothing - this allows overriding of args.ago
Line 48: Line 52:
  
 
-- Check that the entered timestamp is valid. If it isn't, then give an error message.
 
-- Check that the entered timestamp is valid. If it isn't, then give an error message.
local noError, inputTime = pcall( lang.formatDate, lang, 'U', args[1] )
+
local noError, inputTime = pcall( lang.formatDate, lang, 'U', args[1], true )
 
if not noError then
 
if not noError then
 
return '<strong class="error">Error: first parameter cannot be parsed as a date or time.</strong>'
 
return '<strong class="error">Error: first parameter cannot be parsed as a date or time.</strong>'
Line 54: Line 58:
  
 
-- Store the difference between the current time and the inputted time, as well as its absolute value.
 
-- Store the difference between the current time and the inputted time, as well as its absolute value.
local timeDiff = lang:formatDate( 'U' ) - inputTime
+
local timeDiff = lang:formatDate( 'U', nil, true ) - inputTime
 
local absTimeDiff = math.abs( timeDiff )
 
local absTimeDiff = math.abs( timeDiff )
  
Line 63: Line 67:
 
-- Calculate the appropriate unit of time if it was not specified as an argument.
 
-- Calculate the appropriate unit of time if it was not specified as an argument.
 
local autoMagnitudeData = {
 
local autoMagnitudeData = {
{denom = 63115200, amn = 31557600},
+
{ denom = 63115200, amn = 31557600 },
{denom = 5356800, amn = 2678400},
+
{ denom = 5356800, amn = 2678400 },
{denom = 172800, amn = 86400},
+
{ denom = 172800, amn = 86400 },
{denom = 7200, amn = 3600},
+
{ denom = 7200, amn = 3600 },
{denom = 120, amn = 60}
+
{ denom = 120, amn = 60 }
 
}
 
}
for i, t in ipairs(autoMagnitudeData) do
+
for i, t in ipairs( autoMagnitudeData ) do
 
if absTimeDiff / t.denom >= 1 then
 
if absTimeDiff / t.denom >= 1 then
 
auto_magnitude_num = t.amn
 
auto_magnitude_num = t.amn
Line 91: Line 95:
 
local result_num = math.floor ( absTimeDiff / magnitude_num )
 
local result_num = math.floor ( absTimeDiff / magnitude_num )
  
 +
local punctuation_key, suffix
 
if timeDiff >= 0 then -- Past
 
if timeDiff >= 0 then -- Past
 
if result_num == 1 then
 
if result_num == 1 then
result_unit = timeUnits[ magnitude_num ][1]
+
punctuation_key = 1
 
else
 
else
result_unit = timeUnits[ magnitude_num ][2]
+
punctuation_key = 2
 
end
 
end
result = result_num .. ' ' .. result_unit .. ago -- Spaces for "ago" are added earlier.
+
suffix = ago
 
else -- Future
 
else -- Future
 
if result_num == 1 then
 
if result_num == 1 then
result_unit = timeUnits[ magnitude_num ][3]
+
punctuation_key = 3
 
else
 
else
result_unit = timeUnits[ magnitude_num ][4]
+
punctuation_key = 4
 
end
 
end
result = result_num .. ' ' .. result_unit .. ' time'
+
suffix = ' time'
 
end
 
end
 +
result_unit = timeUnits[ magnitude_num ][ punctuation_key ]
  
 +
-- Convert numerals to words if appropriate.
 +
spell_out_max = tonumber( spell_out_max ) -- Would cause script errors if not a number.
 +
local result_num_text
 +
if ( spell_out == 'auto' and 1 <= result_num and result_num <= 9 and result_num <= ( spell_out_max or 9 ) )
 +
or ( yesno( spell_out ) and 1 <= result_num and result_num <= 100 and result_num <= ( spell_out_max or 100 ) )
 +
then
 +
result_num_text = numberSpell( result_num )
 +
else
 +
result_num_text = tostring( result_num )
 +
end
 +
 +
result = result_num_text .. ' ' .. result_unit .. suffix -- Spaces for suffix have been added in earlier.
 
return result .. purge
 
return result .. purge
 
end
 
end

Latest revision as of 16:13, 1 April 2014

-- Replacement for Template:Time ago local getArgs = require('Module:Arguments').getArgs local numberSpell = require('Module:NumberSpell')._main local yesno = require('Module:Yesno')

local p = {}

function p.main( frame ) local args = getArgs( frame, { valueFunc = function( k, v ) if v then v = v:match( '^%s*(.-)%s*$' ) -- Trim whitespace. if k == 'ago' or v ~= then return v end end return nil end }) return p._main( args ) end

function p._main( args ) -- Initialize variables local lang = mw.language.getContentLanguage() local ago local auto_magnitude_num local min_magnitude_num local result local result_unit local magnitude = args.magnitude local min_magnitude = args.min_magnitude local purge = args.purge local spell_out = args.spellout local spell_out_max = args.spelloutmax

-- Generate the "ago" string. If ago is the blank string, do nothing - this allows overriding of args.ago -- in cases where the module is used to generate something like "where he has worked for the past 20 years." ago = args.ago if ago and ago ~= then ago = ' ' .. ago elseif not ago then ago = ' ago' end

-- Add a purge link if something (usually "yes") is entered into the purge parameter if purge then purge = ' ([' .. mw.title.getCurrentTitle():fullUrl('action=purge') .. ' purge])' else purge = end

-- Check that the entered timestamp is valid. If it isn't, then give an error message. local noError, inputTime = pcall( lang.formatDate, lang, 'U', args[1], true ) if not noError then return 'Error: first parameter cannot be parsed as a date or time.' end

-- Store the difference between the current time and the inputted time, as well as its absolute value. local timeDiff = lang:formatDate( 'U', nil, true ) - inputTime local absTimeDiff = math.abs( timeDiff )

if magnitude then auto_magnitude_num = 0 min_magnitude_num = timeText[magnitude] else -- Calculate the appropriate unit of time if it was not specified as an argument. local autoMagnitudeData = { { denom = 63115200, amn = 31557600 }, { denom = 5356800, amn = 2678400 }, { denom = 172800, amn = 86400 }, { denom = 7200, amn = 3600 }, { denom = 120, amn = 60 } } for i, t in ipairs( autoMagnitudeData ) do if absTimeDiff / t.denom >= 1 then auto_magnitude_num = t.amn break end end auto_magnitude_num = auto_magnitude_num or 1 if min_magnitude then min_magnitude_num = timeText[min_magnitude] else min_magnitude_num = -1 end end

if not min_magnitude_num then -- Default to seconds if an invalid magnitude is entered. min_magnitude_num = 1 end

local magnitude_num = math.max( min_magnitude_num, auto_magnitude_num ) local result_num = math.floor ( absTimeDiff / magnitude_num )

local punctuation_key, suffix if timeDiff >= 0 then -- Past if result_num == 1 then punctuation_key = 1 else punctuation_key = 2 end suffix = ago else -- Future if result_num == 1 then punctuation_key = 3 else punctuation_key = 4 end suffix = ' time' end result_unit = timeUnits[ magnitude_num ][ punctuation_key ]

-- Convert numerals to words if appropriate. spell_out_max = tonumber( spell_out_max ) -- Would cause script errors if not a number. local result_num_text if ( spell_out == 'auto' and 1 <= result_num and result_num <= 9 and result_num <= ( spell_out_max or 9 ) ) or ( yesno( spell_out ) and 1 <= result_num and result_num <= 100 and result_num <= ( spell_out_max or 100 ) ) then result_num_text = numberSpell( result_num ) else result_num_text = tostring( result_num ) end

result = result_num_text .. ' ' .. result_unit .. suffix -- Spaces for suffix have been added in earlier. return result .. purge end

-- Table to convert entered text values to numeric values. timeText = { ['seconds'] = 1, ['minutes'] = 60, ['hours'] = 3600, ['days'] = 86400, ['weeks'] = 604800, ['months'] = 2678400, ['years'] = 31557600 }

-- Table containing tables of possible units to use in output. timeUnits = { [1] = { 'second', 'seconds', "second's", "seconds'" }, [60] = { 'minute', 'minutes', "minutes'", "minutes'" }, [3600] = { 'hour', 'hours', "hour's", "hours'" }, [86400] = { 'day', 'days', "day's", "days'" }, [604800] = { 'week', 'weeks', "week's", "weeks'" }, [2678400] = { 'month', 'months', "month's", "months'" }, [31557600] = { 'year', 'years', "year's", "years'" } }

return p