Module:Reading time

From ProleWiki, the proletarian encyclopedia
Revision as of 20:13, 10 March 2024 by CriticalResist (talk | contribs) (quick test)
local p = {}
local mw = require("mw")

-- Global variables
local minReadingTime
local maxReadingTime
local pageTitle
local pageNamespace

function p.calculateReadingTime()
    -- Fetching the current page title and namespace
    pageTitle = mw.title.getCurrentTitle().text
    pageNamespace = mw.title.getCurrentTitle().namespace

    if type(pageTitle) == "string" then
        local content = mw.title.new(pageTitle):getContent()

        if type(content) == "string" then
            local wordCount = 0
            for word in content:gmatch("%S+") do
                wordCount = wordCount + 1
            end

            -- Defining the range of reading speeds
            local minSpeed = 160
            local maxSpeed = 238

            -- Calculate reading times for both minimum and maximum speeds
            minReadingTime = math.floor(wordCount / maxSpeed)
            maxReadingTime = math.ceil(wordCount / minSpeed)

            minReadingTime = math.floor(minReadingTime / 5) * 5
            maxReadingTime = math.ceil(maxReadingTime / 5) * 5

            -- ensure that minReadingTime is at least 1
            if minReadingTime == 0 then
                minReadingTime = 1
            end
        end
    end
end

function p.estimateReadingTime(frame)
    p.calculateReadingTime()
    return minReadingTime .. "-" .. maxReadingTime .. " minutes"
end

function p.estimateReadingLength(frame)
    p.calculateReadingTime()
    local averageReadingTime = (minReadingTime + maxReadingTime) / 2

    if averageReadingTime < 120 then
        return "Short"
    elseif averageReadingTime >= 120 and averageReadingTime < 360 then
        return "Medium"
    elseif averageReadingTime >= 360 and averageReadingTime < 720 then
        return "Long"
    else
        return "Very Long"
    end
end

return p