From 699760651bb62e9ca006db8c7c9876d185684362 Mon Sep 17 00:00:00 2001
From: Daniel Hahler <github@thequod.de>
Date: Wed, 23 Jan 2019 10:00:38 +0100
Subject: [PATCH] Fix luacheck issues and add .luacheckrc (#72)

Uses `reg.timeout` for clarity (triggered via "shadowing upvalue timer
on line 13"), but keeps `reg.timer` for backward compatibility.
---
 .luacheckrc |  9 +++++++++
 init.lua    | 39 ++++++++++++++++++++-------------------
 2 files changed, 29 insertions(+), 19 deletions(-)
 create mode 100644 .luacheckrc

diff --git a/.luacheckrc b/.luacheckrc
new file mode 100644
index 0000000..7aacbc1
--- /dev/null
+++ b/.luacheckrc
@@ -0,0 +1,9 @@
+-- Only allow symbols available in all Lua versions
+std = "min"
+
+-- Global objects defined by the C code
+read_globals = {
+    "timer",  -- deprecated, but used in older versions.
+}
+
+-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
diff --git a/init.lua b/init.lua
index 4c6023b..e10d4d6 100644
--- a/init.lua
+++ b/init.lua
@@ -46,8 +46,7 @@ local function update(widget, reg, disablecache)
         return
     end
 
-    local t = os.time()
-    local data = {}
+    local update_time = os.time()
 
     local function format_data(data)
         local ret
@@ -100,7 +99,7 @@ local function update(widget, reg, disablecache)
 
     -- Check for cached output newer than the last update
     local c = widget_cache[reg.wtype]
-    if c and t < c.time + reg.timer and not disablecache then
+    if c and update_time < c.time + reg.timeout and not disablecache then
         update_value(c.data)
     elseif reg.wtype then
         if type(reg.wtype) == "table" and reg.wtype.async then
@@ -109,14 +108,14 @@ local function update(widget, reg, disablecache)
                 return reg.wtype.async(reg.format,
                     reg.warg,
                     function(data)
-                        update_cache(data, t, c)
+                        update_cache(data, update_time, c)
                         update_value(data)
                         reg.lock=false
                     end)
             end
         else
             local data = reg.wtype(reg.format, reg.warg)
-            update_cache(data, t, c)
+            update_cache(data, update_time, c)
             update_value(data)
         end
     end
@@ -153,18 +152,18 @@ local function regregister(reg)
         end
 
         -- Start the timer
-        if reg.timer > 0 then
-            local tm = timers[reg.timer] and timers[reg.timer].timer
-            tm = tm or timer({ timeout = reg.timer })
+        if reg.timeout > 0 then
+            local tm = timers[reg.timeout] and timers[reg.timeout].timer
+            tm = tm or timer({ timeout = reg.timeout })
             if tm.connect_signal then
                 tm:connect_signal("timeout", reg.update)
             else
                 tm:add_signal("timeout", reg.update)
             end
-            if not timers[reg.timer] then
-                timers[reg.timer] = { timer = tm, refs = 1 }
+            if not timers[reg.timeout] then
+                timers[reg.timeout] = { timer = tm, refs = 1 }
             else
-                timers[reg.timer].refs = timers[reg.timer].refs + 1
+                timers[reg.timeout].refs = timers[reg.timeout].refs + 1
             end
             if not tm.started then
                 tm:start()
@@ -181,16 +180,18 @@ end
 
 -- {{{ Global functions
 -- {{{ Register a widget
-function vicious.register(widget, wtype, format, timer, warg)
+function vicious.register(widget, wtype, format, timeout, warg)
     local reg = {
         -- Set properties
-        wtype  = wtype,
-        lock   = false,
-        format = format,
-        timer  = timer or 2,
-        warg   = warg,
-        widget = widget,
+        wtype   = wtype,
+        lock    = false,
+        format  = format,
+        timeout = timeout or 2,
+        warg    = warg,
+        widget  = widget,
     }
+    reg.timer = timeout  -- For backward compatibility.
+
     -- Set functions
     function reg.update()
         update(widget, reg)
@@ -235,7 +236,7 @@ function vicious.unregister(widget, keep, reg)
     end
 
     -- Disconnect from timer
-    local tm  = timers[reg.timer]
+    local tm  = timers[reg.timeout]
     if tm.timer.disconnect_signal then
         tm.timer:disconnect_signal("timeout", reg.update)
     else