fix(policy): fix 'shuffle' random (#141)

Author: linrongbin16

lua/colorbox.lua

@@ -4,6 +4,7 @@ local jsons = require("colorbox.commons.jsons")
 local uv = require("colorbox.commons.uv")
 local numbers = require("colorbox.commons.numbers")
 local fileios = require("colorbox.commons.fileios")
+local strings = require("colorbox.commons.strings")
 
 --- @alias colorbox.Options table<any, any>
 --- @type colorbox.Options
@@ -146,6 +147,7 @@ local function _init()
     -- vim.opt.packpath:append(cwd .. "/pack/colorbox/opt")
     -- vim.cmd([[packadd catppuccin-nvim]])
 
+    local logger = logging.get("colorbox") --[[@as commons.logging.Logger]]
     local ColorNameToColorSpecsMap =
         require("colorbox.db").get_color_name_to_color_specs_map()
     local ColorNamesList = require("colorbox.db").get_color_names_list()
@@ -159,14 +161,14 @@ local function _init()
     for i, color_name in ipairs(FilteredColorNamesList) do
         FilteredColorNameToIndexMap[color_name] = i
     end
-    -- logger.debug(
-    --     "|colorbox._init| FilteredColorNamesList:%s",
-    --     vim.inspect(FilteredColorNamesList)
-    -- )
-    -- logger.debug(
-    --     "|colorbox._init| FilteredColorNameToIndexMap:%s",
-    --     vim.inspect(FilteredColorNameToIndexMap)
-    -- )
+    logger:debug(
+        "|_init| FilteredColorNamesList:%s",
+        vim.inspect(FilteredColorNamesList)
+    )
+    logger:debug(
+        "|_init| FilteredColorNameToIndexMap:%s",
+        vim.inspect(FilteredColorNameToIndexMap)
+    )
 end
 
 local function _force_sync_syntax()
@@ -224,18 +226,40 @@ local function _get_prev_color_name_by_idx(idx)
     return FilteredColorNamesList[idx]
 end
 
+local function randint(n)
+    local secs, millis = uv.gettimeofday()
+    local pid = uv.os_getpid()
+
+    secs = tonumber(secs) or math.random(n)
+    millis = tonumber(millis) or math.random(n)
+    pid = tonumber(pid) or math.random(n)
+
+    local total = numbers.mod(
+        numbers.mod(secs + millis, numbers.INT32_MAX) + pid,
+        numbers.INT32_MAX
+    )
+
+    local chars = strings.tochars(tostring(total)) --[[@as string[] ]]
+    chars = numbers.shuffle(chars) --[[@as string[] ]]
+    return numbers.mod(tonumber(table.concat(chars, "")) or math.random(n), n)
+        + 1
+end
+
 local function _policy_shuffle()
     if #FilteredColorNamesList > 0 then
-        local i = math.random(#FilteredColorNamesList)
+        local i = randint(#FilteredColorNamesList)
         local color = _get_next_color_name_by_idx(i)
-        -- logger.debug(
-        --     "|colorbox._policy_shuffle| color:%s, ColorNames:%s (%d), r:%d",
-        --     vim.inspect(color),
-        --     vim.inspect(ColorNames),
-        --     vim.inspect()
-        -- )
-        ---@diagnostic disable-next-line: param-type-mismatch
-        local ok, err = pcall(vim.cmd, string.format([[color %s]], color))
+        logging.get("colorbox"):debug(
+            "|_policy_shuffle| color:%s, FilteredColorNamesList:%s (%d), i:%d",
+            vim.inspect(color),
+            vim.inspect(FilteredColorNamesList),
+            vim.inspect(#FilteredColorNamesList),
+            vim.inspect(i)
+        )
+        local ok, err = pcall(
+            vim.cmd --[[@as function]],
+            string.format([[color %s]], color)
+        )
         assert(ok, err)
     end
 end
@@ -421,6 +445,7 @@ local function update(opts)
         file_log_name = "colorbox_update.log",
         file_log_mode = "w",
     })
+    local logger = logging.get("colorbox-update") --[[@as commons.logging.Logger]]
 
     local home_dir = vim.fn["colorbox#base_dir"]()
     -- local packstart = string.format("%s/pack/colorbox/start", home_dir)
@@ -459,21 +484,21 @@ local function update(opts)
     for handle, spec in pairs(HandleToColorSpecsMap) do
         local function _on_output(chanid, data, name)
             if type(data) == "table" then
-                logging.get("colorbox-update"):debug(
+                logger:debug(
                     "(%s) %s: %s",
                     vim.inspect(name),
                     vim.inspect(handle),
                     vim.inspect(data)
                 )
                 for _, d in ipairs(data) do
                     if type(d) == "string" and string.len(vim.trim(d)) > 0 then
-                        logging.get("colorbox-update"):info("%s: %s", handle, d)
+                        logger:info("%s: %s", handle, d)
                     end
                 end
             end
         end
         local function _on_exit(jid, exitcode, name)
-            logging.get("colorbox-update"):debug(
+            logger:debug(
                 "(%s-%s) %s: exit with %s",
                 vim.inspect(name),
                 vim.inspect(jid),
@@ -490,14 +515,14 @@ local function update(opts)
                 end
             end
             if not removed_from_working_queue then
-                logging.get("colorbox-update"):err(
+                logger:err(
                     "failed to remove job id %s from jobs_working_queue: %s",
                     vim.inspect(jid),
                     vim.inspect(jobs_working_queue)
                 )
             end
             if jobid_to_jobs_map[jid] == nil then
-                logging.get("colorbox-update"):err(
+                logger:err(
                     "failed to remove job id %s from jobid_to_jobs_map: %s",
                     vim.inspect(jid),
                     vim.inspect(jobid_to_jobs_map)
@@ -606,6 +631,7 @@ local function _clean()
         -- )
         return
     end
+    local logger = logging.get("colorbox") --[[@as commons.logging.Logger]]
     if vim.fn.executable("rm") > 0 then
         local jobid = vim.fn.jobstart({ "rm", "-rf", full_pack_dir }, {
             detach = false,
@@ -634,9 +660,9 @@ local function _clean()
             end,
         })
         vim.fn.jobwait({ jobid })
-        logging.get("colorbox"):info("cleaned directory: %s", shorten_pack_dir)
+        logger:info("cleaned directory: %s", shorten_pack_dir)
     else
-        logging.get("colorbox"):warn("no 'rm' command found, skip cleaning...")
+        logger:warn("no 'rm' command found, skip cleaning...")
     end
 end
 
@@ -699,6 +725,8 @@ local function setup(opts)
     vim.api.nvim_create_user_command(
         Configs.command.name,
         function(command_opts)
+            local logger = logging.get("colorbox") --[[@as commons.logging.Logger]]
+
             -- logger.debug(
             --     "|colorbox.setup| command opts:%s",
             --     vim.inspect(command_opts)
@@ -712,17 +740,15 @@ local function setup(opts)
             --     vim.inspect(args_splits)
             -- )
             if #args_splits == 0 then
-                logging.get("colorbox"):warn("missing parameter.")
+                logger:warn("missing parameter.")
                 return
             end
             if type(CONTROLLERS_MAP[args_splits[1]]) == "function" then
                 local fn = CONTROLLERS_MAP[args_splits[1]]
                 local sub_args = args:sub(string.len(args_splits[1]) + 1)
                 fn(sub_args)
             else
-                logging
-                    .get("colorbox")
-                    :warn("unknown parameter %s.", args_splits[1])
+                logger:warn("unknown parameter %s.", args_splits[1])
             end
         end,
         {

lua/colorbox/commons/numbers.lua

@@ -124,4 +124,24 @@ M.min = function(f, a, ...)
   return minimal_item, minimal_index
 end
 
+--- @param l any[]|string
+--- @return any[]|string
+M.shuffle = function(l)
+  assert(type(l) == "table")
+  local n = #l
+
+  local new_l = {}
+  for i = 1, n do
+    table.insert(new_l, l[i])
+  end
+
+  for i = n, 1, -1 do
+    local j = math.random(n)
+    local tmp = new_l[j]
+    new_l[j] = new_l[i]
+    new_l[i] = tmp
+  end
+  return new_l
+end
+
 return M

lua/colorbox/commons/strings.lua

@@ -85,69 +85,36 @@ M.rfind = function(s, t, rstart)
 end
 
 --- @param s string
---- @param t string?  by default t is whitespace
+--- @param t string?  by default is whitespace
 --- @return string
 M.ltrim = function(s, t)
   assert(type(s) == "string")
   assert(type(t) == "string" or t == nil)
 
-  local function has(idx)
-    if not t then
-      return M.isspace(s:sub(idx, idx))
-    end
-
-    local c = string.byte(s, idx)
-    local found = false
-    for j = 1, #t do
-      if string.byte(t, j) == c then
-        found = true
-        break
-      end
-    end
-    return found
-  end
-
-  local i = 1
-  while i <= #s do
-    if not has(i) then
-      break
-    end
-    i = i + 1
-  end
-  return s:sub(i, #s)
+  t = t or "%s+"
+  ---@diagnostic disable-next-line: redundant-return-value
+  return string.gsub(s, "^" .. t, "")
 end
 
 --- @param s string
---- @param t string?  by default t is whitespace
+--- @param t string?  by default is whitespace
 --- @return string
 M.rtrim = function(s, t)
   assert(type(s) == "string")
   assert(type(t) == "string" or t == nil)
 
-  local function has(idx)
-    if not t then
-      return M.isspace(s:sub(idx, idx))
-    end
-
-    local c = string.byte(s, idx)
-    local found = false
-    for j = 1, #t do
-      if string.byte(t, j) == c then
-        found = true
-        break
-      end
-    end
-    return found
-  end
+  t = t or "%s+"
+  ---@diagnostic disable-next-line: redundant-return-value
+  return string.gsub(s, t .. "$", "")
+end
 
-  local i = #s
-  while i >= 1 do
-    if not has(i) then
-      break
-    end
-    i = i - 1
-  end
-  return s:sub(1, i)
+--- @param s string
+--- @param t string?  by default is whitespace
+--- @return string
+M.trim = function(s, t)
+  assert(type(s) == "string")
+  assert(type(t) == "string" or t == nil)
+  return M.rtrim(M.ltrim(s, t), t)
 end
 
 --- @param s string
@@ -261,4 +228,41 @@ M.isupper = function(c)
   return c:match("%u") ~= nil
 end
 
+--- @param s string
+--- @param pos integer
+--- @param ch string
+--- @return string
+M.setchar = function(s, pos, ch)
+  assert(type(s) == "string")
+  assert(type(pos) == "number")
+  assert(type(ch) == "string")
+  assert(string.len(ch) == 1)
+
+  local n = string.len(s)
+  pos = require("colorbox.commons.tables").list_index(pos, n)
+
+  local buffer = ""
+  if pos > 1 then
+    buffer = string.sub(s, 1, pos - 1)
+  end
+  buffer = buffer .. ch
+  if pos < n then
+    buffer = buffer .. string.sub(s, pos + 1)
+  end
+
+  return buffer
+end
+
+--- @param s string
+--- @return string[]
+M.tochars = function(s)
+  assert(type(s) == "string")
+  local l = {}
+  local n = string.len(s)
+  for i = 1, n do
+    table.insert(l, string.sub(s, i, i))
+  end
+  return l
+end
+
 return M

lua/colorbox/commons/tables.lua

@@ -12,15 +12,12 @@ M.tbl_not_empty = function(t)
   return type(t) == "table" and not vim.tbl_isempty(t)
 end
 
--- retrieve value from table like json field indexing via dot `.` delimiter.
--- for example when parameter `t = { a = { b = 1 } }` and `field = 'a.b'`, it will return `1`.
---
 --- @param t any?
 --- @param ... any
 --- @return any
 M.tbl_get = function(t, ...)
   if vim.fn.has("nvim-0.10") > 0 and type(vim.tbl_get) == "function" then
-    return vim.tbl_get(t, ...)
+    return type(t) == "table" and vim.tbl_get(t, ...) or nil
   end
 
   local e = t --[[@as table]]

lua/colorbox/commons/version.txt

@@ -1 +1 @@
-3.1.4
+3.3.0