Version 2.2.3

Pacify Luacheck.

.gitignore

@@ -1,3 +0,0 @@
-__*
-*.tmp
-*.swp

README.md

@@ -98,6 +98,14 @@ local t = { 1, 2, 3 }
 lume.clear(t) -- `t` becomes {}
 ```
 
+### lume.extend(t, ...)
+Copies all the fields from the source tables to the table `t` and returns `t`.
+If a key exists in multiple tables the right-most table's value is used.
+```lua
+local t = { a = 1, b = 2 }
+lume.extend(t, { b = 4, c = 6 }) -- `t` becomes { a = 1, b = 4, c = 6 }
+```
+
 ### lume.shuffle(t)
 Returns a shuffled copy of the array `t`.
 
@@ -244,6 +252,12 @@ values the keys.
 lume.invert({a = "x", b = "y"}) -- returns {x = "a", y = "b"}
 ```
 
+### lume.pick(t, ...)
+Returns a copy of the table filtered to only contain values for the given keys.
+```lua
+lume.pick({ a = 1, b = 2, c = 3 }, "a", "c") -- Returns { a = 1, c = 3 }
+```
+
 ### lume.keys(t)
 Returns an array containing each key of the table.
 
@@ -315,7 +329,7 @@ f(10, 5) -- Returns 25
 ### lume.serialize(x)
 Serializes the argument `x` into a string which can be loaded again using
 `lume.deserialize()`. Only booleans, numbers, tables and strings can be
-serialized. Circular references are not handled; all nested tables are
+serialized. Circular references will result in an error; all nested tables are
 serialized as unique tables.
 ```lua
 lume.serialize({a = "test", b = {1, 2, 3}, false})
@@ -369,7 +383,7 @@ Prints the current filename and line number followed by each argument separated
 by a space.
 ```lua
 -- Assuming the file is called "example.lua" and the next line is 12:
-lume.trace("hello", 1234) -- Prints "[example.lua:12] hello 1234"
+lume.trace("hello", 1234) -- Prints "example.lua:12: hello 1234"
 ```
 
 ### lume.dostring(str)
@@ -404,6 +418,17 @@ for i, v in lume.ripairs({ "a", "b", "c" }) do
 end
 ```
 
+### lume.color(str [, mul])
+Takes color string `str` and returns 4 values, one for each color channel (`r`,
+`g`, `b` and `a`). By default the returned values are between 0 and 1; the
+values are multiplied by the number `mul` if it is provided.
+```lua
+lume.color("#ff0000")               -- Returns 1, 0, 0, 1
+lume.color("rgba(255, 0, 255, .5)") -- Returns 1, 0, 1, .5
+lume.color("#00ffff", 256)          -- Returns 0, 256, 256, 256
+lume.color("rgb(255, 0, 0)", 256)   -- Returns 256, 0, 0, 256
+```
+
 ### lume.rgba(color)
 Takes the 32bit integer `color` argument and returns 4 numbers, one for each
 channel, with a range of 0 - 255. The returned values can be used as the

lume.lua

@@ -7,7 +7,7 @@
 -- under the terms of the MIT license. See LICENSE for details.
 --
 
-local lume = { _version = "2.1.0" }
+local lume = { _version = "2.2.3" }
 
 local pairs, ipairs = pairs, ipairs
 local type, assert, unpack = type, assert, unpack or table.unpack
@@ -15,11 +15,9 @@ local tostring, tonumber = tostring, tonumber
 local math_floor = math.floor
 local math_ceil = math.ceil
 local math_random = math.random
-local math_cos = math.cos
 local math_atan2 = math.atan2 or math.atan
 local math_sqrt = math.sqrt
 local math_abs = math.abs
-local math_pi = math.pi
 
 local noop = function()
 end
@@ -46,10 +44,6 @@ local isarray = function(x)
   return (type(x) == "table" and x[1] ~= nil) and true or false
 end
 
-local iternil = function()
-  return noop
-end
-
 local getiter = function(x)
   if isarray(x) then
     return ipairs
@@ -82,7 +76,7 @@ end
 
 function lume.round(x, increment)
   if increment then return lume.round(x / increment) * increment end
-  return x > 0 and math_floor(x + .5) or math_ceil(x - .5)
+  return x >= 0 and math_floor(x + .5) or math_ceil(x - .5)
 end
 
 
@@ -135,7 +129,7 @@ end
 
 function lume.weightedchoice(t)
   local sum = 0
-  for k, v in pairs(t) do
+  for _, v in pairs(t) do
     assert(v >= 0, "weight value less than zero")
     sum = sum + v
   end
@@ -176,13 +170,26 @@ end
 
 function lume.clear(t)
   local iter = getiter(t)
-  for k, v in iter(t) do
+  for k in iter(t) do
     t[k] = nil
   end
   return t
 end
 
 
+function lume.extend(t, ...)
+  for i = 1, select("#", ...) do
+    local x = select(i, ...)
+    if x then
+      for k, v in pairs(x) do
+        t[k] = v
+      end
+    end
+  end
+  return t
+end
+
+
 function lume.shuffle(t)
   local rtn = {}
   for i = 1, #t do
@@ -241,7 +248,7 @@ end
 function lume.all(t, fn)
   fn = iteratee(fn)
   local iter = getiter(t)
-  for k, v in iter(t) do
+  for _, v in iter(t) do
     if not fn(v) then return false end
   end
   return true
@@ -251,7 +258,7 @@ end
 function lume.any(t, fn)
   fn = iteratee(fn)
   local iter = getiter(t)
-  for k, v in iter(t) do
+  for _, v in iter(t) do
     if fn(v) then return true end
   end
   return false
@@ -262,7 +269,7 @@ function lume.reduce(t, fn, first)
   local acc = first
   local started = first and true or false
   local iter = getiter(t)
-  for k, v in iter(t) do
+  for _, v in iter(t) do
     if started then
       acc = fn(acc, v)
     else
@@ -277,7 +284,7 @@ end
 
 function lume.set(t)
   local rtn = {}
-  for k, v in pairs(lume.invert(t)) do
+  for k in pairs(lume.invert(t)) do
     rtn[#rtn + 1] = k
   end
   return rtn
@@ -293,7 +300,7 @@ function lume.filter(t, fn, retainkeys)
       if fn(v) then rtn[k] = v end
     end
   else
-    for k, v in iter(t) do
+    for _, v in iter(t) do
       if fn(v) then rtn[#rtn + 1] = v end
     end
   end
@@ -310,7 +317,7 @@ function lume.reject(t, fn, retainkeys)
       if not fn(v) then rtn[k] = v end
     end
   else
-    for k, v in iter(t) do
+    for _, v in iter(t) do
       if not fn(v) then rtn[#rtn + 1] = v end
     end
   end
@@ -337,7 +344,7 @@ function lume.concat(...)
     local t = select(i, ...)
     if t ~= nil then
       local iter = getiter(t)
-      for k, v in iter(t) do
+      for _, v in iter(t) do
         rtn[#rtn + 1] = v
       end
     end
@@ -370,14 +377,14 @@ function lume.count(t, fn)
   local iter = getiter(t)
   if fn then
     fn = iteratee(fn)
-    for k, v in iter(t) do
+    for _, v in iter(t) do
       if fn(v) then count = count + 1 end
     end
   else
     if isarray(t) then
       return #t
     end
-    for k in iter(t) do count = count + 1 end
+    for _ in iter(t) do count = count + 1 end
   end
   return count
 end
@@ -413,10 +420,20 @@ function lume.invert(t)
 end
 
 
+function lume.pick(t, ...)
+  local rtn = {}
+  for i = 1, select("#", ...) do
+    local k = select(i, ...)
+    rtn[k] = t[k]
+  end
+  return rtn
+end
+
+
 function lume.keys(t)
   local rtn = {}
   local iter = getiter(t)
-  for k, v in iter(t) do rtn[#rtn + 1] = k end
+  for k in iter(t) do rtn[#rtn + 1] = k end
   return rtn
 end
 
@@ -439,12 +456,12 @@ end
 
 
 function lume.once(fn, ...)
-  local fn = lume.fn(fn, ...)
+  local f = lume.fn(fn, ...)
   local done = false
   return function(...)
     if done then return end
     done = true
-    return fn(...)
+    return f(...)
   end
 end
 
@@ -517,19 +534,41 @@ function lume.lambda(str)
 end
 
 
-function lume.serialize(x)
-  local f = { string = function(v) return string.format("%q", v) end,
-              number = tostring, boolean = tostring }
-  f.table = function(t)
+local serialize
+
+local serialize_map = {
+  [ "boolean" ] = tostring,
+  [ "nil"     ] = tostring,
+  [ "string"  ] = function(v) return string.format("%q", v) end,
+  [ "number"  ] = function(v)
+    if      v ~=  v     then return  "0/0"      --  nan
+    elseif  v ==  1 / 0 then return  "1/0"      --  inf
+    elseif  v == -1 / 0 then return "-1/0" end  -- -inf
+    return tostring(v)
+  end,
+  [ "table"   ] = function(t, stk)
+    stk = stk or {}
+    if stk[t] then error("circular reference") end
     local rtn = {}
+    stk[t] = true
     for k, v in pairs(t) do
-      rtn[#rtn + 1] = "[" .. f[type(k)](k) .. "]=" .. f[type(v)](v) .. ","
+      rtn[#rtn + 1] = "[" .. serialize(k, stk) .. "]=" .. serialize(v, stk)
     end
-    return "{" .. table.concat(rtn) .. "}"
+    stk[t] = nil
+    return "{" .. table.concat(rtn, ",") .. "}"
   end
-  local err = function(t,k) error("unsupported serialize type: " .. k) end
-  setmetatable(f, { __index = err })
-  return f[type(x)](x)
+}
+
+setmetatable(serialize_map, {
+  __index = function(_, k) error("unsupported serialize type: " .. k) end
+})
+
+serialize = function(x, stk)
+  return serialize_map[type(x)](x, stk)
+end
+
+function lume.serialize(x)
+  return serialize(x)
 end
 
 
@@ -560,25 +599,31 @@ function lume.wordwrap(str, limit)
   limit = limit or 72
   local check
   if type(limit) == "number" then
-    check = function(str) return #str >= limit end
+    check = function(s) return #s >= limit end
   else
     check = limit
   end
   local rtn = {}
-  for j, line in ipairs(lume.split(str, "\n")) do
-    local str
-    for i, word in ipairs(lume.split(line)) do
-      local s = (str and (str .. " ") or "") .. word
-      if check(s) then
-        rtn[#rtn + 1] = str
-        str = word
+  local line = ""
+  for word, spaces in str:gmatch("(%S+)(%s*)") do
+    local s = line .. word
+    if check(s) then
+      table.insert(rtn, line .. "\n")
+      line = word
+    else
+      line = s
+    end
+    for c in spaces:gmatch(".") do
+      if c == "\n" then
+        table.insert(rtn, line .. "\n")
+        line = ""
       else
-        str = s
+        line = line .. c
       end
     end
-    rtn[#rtn + 1] = str
   end
-  return table.concat(rtn, "\n")
+  table.insert(rtn, line)
+  return table.concat(rtn)
 end
 
 
@@ -593,7 +638,7 @@ end
 
 function lume.trace(...)
   local info = debug.getinfo(2, "Sl")
-  local t = { "[" .. info.short_src .. ":" .. info.currentline .. "]" }
+  local t = { info.short_src .. ":" .. info.currentline .. ":" }
   for i = 1, select("#", ...) do
     local x = select(i, ...)
     if type(x) == "number" then
@@ -634,7 +679,7 @@ function lume.hotswap(modname)
   end
   local err = nil
   local function onerror(e)
-    for k, v in pairs(_G) do _G[k] = oldglobal[k] end
+    for k in pairs(_G) do _G[k] = oldglobal[k] end
     err = lume.trim(e)
   end
   local ok, oldmod = pcall(require, modname)
@@ -663,13 +708,32 @@ local ripairs_iter = function(t, i)
 end
 
 function lume.ripairs(t)
-  if t == nil then
-    return noop
-  end
   return ripairs_iter, t, (#t + 1)
 end
 
 
+function lume.color(str, mul)
+  mul = mul or 1
+  local r, g, b, a
+  r, g, b = str:match("#(%x%x)(%x%x)(%x%x)")
+  if r then
+    r = tonumber(r, 16) / 0xff
+    g = tonumber(g, 16) / 0xff
+    b = tonumber(b, 16) / 0xff
+    a = 1
+  elseif str:match("rgba?%s*%([%d%s%.,]+%)") then
+    local f = str:gmatch("[%d.]+")
+    r = (f() or 0) / 0xff
+    g = (f() or 0) / 0xff
+    b = (f() or 0) / 0xff
+    a = f() or 1
+  else
+    error(("bad color string '%s'"):format(str))
+  end
+  return r * mul, g * mul, b * mul, a * mul
+end
+
+
 function lume.rgba(color)
   local a = math_floor((color / 16777216) % 256)
   local r = math_floor((color /    65536) % 256)
@@ -694,7 +758,7 @@ function lume.chain(value)
 end
 
 setmetatable(lume,  {
-  __call = function(t, ...)
+  __call = function(_, ...)
     return lume.chain(...)
   end
 })

test/test.lua

@@ -1,4 +1,4 @@
-local tester = require "tester"
+local tester = require "util.tester"
 
 package.path = "../?.lua;" .. package.path
 
@@ -145,6 +145,16 @@ tests["lume.clear"] = function()
   testeq( lume.clear(t) == t, true )
 end
 
+-- lume.extend
+tests["lume.extend"] = function()
+  local t = { a = 10, b = 20, c = 30 }
+  testeq( lume.extend(t) == t, true )
+  lume.extend(t, { d = 40 }, { e = 50 })
+  testeq( t, { a = 10, b = 20, c = 30, d = 40, e = 50 } )
+  lume.extend(t, { a = "cat", b = "dog" }, { b = "owl", c = "fox" })
+  testeq( t, { a = "cat", b = "owl", c = "fox", d = 40, e = 50 } )
+end
+
 -- lume.shuffle
 tests["lume.shuffle"] = function()
   local t = {1, 2, 3, 4, 5}
@@ -363,6 +373,15 @@ tests["lume.invert"] = function()
   testeq( lume.invert(lume.invert{a = 1, b = 2}), {a = 1, b = 2}      )
 end
 
+-- lume.pick
+tests["lume.pick"] = function()
+  local t = { cat = 10, dog = 20, fox = 30, owl = 40 }
+  testeq( lume.pick(t, "cat", "dog"), { cat = 10, dog = 20 } )
+  testeq( lume.pick(t, "fox", "owl"), { fox = 30, owl = 40 } )
+  testeq( lume.pick(t, "owl"), { owl = 40 } )
+  testeq( lume.pick(t), {} )
+end
+
 -- lume.keys
 tests["lume.keys"] = function()
   testeq( lume.keys({}), {} )
@@ -465,6 +484,10 @@ tests["lume.serialize, lume.deserialize"] = function()
   local t = { 1, 2, 3, 4, true, false, "cat", "dog", {1, 2, 3} }
   local s = lume.serialize(t)
   testeq( lume.deserialize(s), t )
+  testeq( lume.deserialize(lume.serialize(math.huge)), math.huge )
+  testeq( lume.deserialize(lume.serialize(-math.huge)), -math.huge )
+  local x = lume.deserialize(lume.serialize(0 / 0)) -- nan
+  testeq( x ~= x, true )
 end
 
 -- lume.split
@@ -491,8 +514,8 @@ end
 
 -- lume.wordwrap
 tests["lume.wordwrap"] = function()
-  local str = "A small string with some words and then some more words"
-  local b = "A small string with\nsome words and then\nsome more words"
+  local str = "A small string with some words and then some more   words"
+  local b = "A small string with \nsome words and then \nsome more   words"
   local fn = function(str) return #str >= 20 end
   testeq( lume.wordwrap(str),     str )
   testeq( lume.wordwrap(str, 20), b   )
@@ -516,7 +539,7 @@ tests["lume.trace"] = function()
   local oldprint = print
   local file, line, msg
   print = function(x)
-    file, line, msg = x:match("%[(.-):(.-)%] (.*)")
+    file, line, msg = x:match("(.-):(.-): (.*)")
   end
   lume.trace("Hi world", 123.456, 1, nil)
   print = oldprint
@@ -552,8 +575,24 @@ tests["lume.ripairs"] = function()
     table.insert(r, { i, v })
   end
   testeq( r, { { 3, "c" }, { 2, "b" }, { 1, "a" } })
-  for i, v in lume.ripairs(nil) do
-  end
+  tester.test.error(lume.ripairs, nil)
+end
+
+-- lume.color
+tests["lume.color"] = function()
+  testeq({ lume.color("#ff0000") },                   { 1, 0, 0, 1 }  )
+  testeq({ lume.color("#00ff00") },                   { 0, 1, 0, 1 }  )
+  testeq({ lume.color("#0000ff") },                   { 0, 0, 1, 1 }  )
+  testeq({ lume.color("rgb( 255, 255, 255 )") },      { 1, 1, 1, 1 }  )
+  testeq({ lume.color("rgb (0, 0, 0)") },             { 0, 0, 0, 1 }  )
+  testeq({ lume.color("rgba(255, 255, 255, .5)") },   { 1, 1, 1, .5 } )
+  testeq({ lume.color("#ffffff", 2) },                { 2, 2, 2, 2 }  )
+  testeq({ lume.color("rgba(255, 255, 255, 1)", 3) }, { 3, 3, 3, 3 }  )
+  tester.test.error(lume.color, "#ff00f")
+  tester.test.error(lume.color, "#xyzxyz")
+  tester.test.error(lume.color, "rgba(hello)")
+  tester.test.error(lume.color, "rgba()")
+  tester.test.error(lume.color, "rgba(1, 1, 1, 1")
 end
 
 -- lume.rgba