rebase and add readable directory predicate

Author: justinhj-td

.luacheckrc

@@ -1 +1 @@
-globals = { "vim" }
+globals = { "vim", "_" }

README.md

@@ -122,9 +122,9 @@ If something breaks you should see a standard Vim error telling you what the pro
 
 For more than just info,warn and error logging you can enable debug logs which show a more verbose behaviour of the plugin using the following command to launch nvim.
 
-`PLENARY_DEBUG=true nvim`
+`DEBUG_PLENARY=true nvim`
 
 ## Notes
 Inspired by [lambdalisue/battery.vim](https://github.com/lambdalisue/battery.vim), which in turn uses code from [b4b4r07/dotfiles](https://github.com/b4b4r07/dotfiles/blob/66dddda6803ada50a0ab879e5db784afea72b7be/.tmux/bin/battery#L10).
 
-Copyright (c) 2022 Justin Heyes-Jones
+Copyright (c) 2022-2024 Justin Heyes-Jones

lua/battery/battery.lua

@@ -6,6 +6,7 @@ local pmset = require("battery.pmset")
 local powersupply = require("battery.powersupply")
 local acpi = require("battery.acpi")
 local config = require("battery.config")
+local file = require("util.file")
 
 -- TODO check for icons and if not available fallback to text
 -- TODO allow user to select no icons
@@ -53,6 +54,7 @@ local battery_status = {
   percent_charge_remaining = nil,
   battery_count = nil,
   ac_power = nil,
+  method = nil,
 }
 
 -- Gets the last updated battery information
@@ -70,28 +72,37 @@ local timer = nil
 local function select_job()
   if vim.fn.has("win32") and vim.fn.executable("powershell") == 1 then
     log.debug("windows powershell battery job")
-    return powershell.get_battery_info_job
+    return powershell.get_battery_info_job, 'powershell'
   elseif vim.fn.executable("pmset") == 1 then
     log.debug("pmset battery job")
-    return pmset.get_battery_info_job
-  -- Ensure directory exists (isdirectory() == 1) and is readable ($(ls) doesn't contain "ls: cannot")
-  elseif vim.fn.isdirectory("/sys/class/power_supply/") == 1 and
-    -- TODO: Find better way to check for readability (exit code of `ls`?)
-    not vim.fn.system("ls /sys/class/power_supply/"):find("ls: cannot") then
-    log.debug("/sys/class/power_supply/ battery job")
-    return powersupply.get_battery_info_job
+    return pmset.get_battery_info_job, 'pmset'
+  elseif file.is_readable_directory("/sys/class/power_supply/") then
+    log.debug("power_supply battery job")
+    return powersupply.get_battery_info_job, 'powersupply'
   elseif vim.fn.executable("acpi") == 1 then
     log.debug("acpi battery job")
-    return acpi.get_battery_info_job
+    return acpi.get_battery_info_job, 'acpi'
   else
     log.debug("no battery job")
+    return nil, 'none'
   end
 end
 
+-- This is used for the health check
+local function get_method()
+  local method = battery_status.method
+  if method == nil then
+    _, method = select_job()
+  end
+  return method
+end
+
 local function timer_loop()
   vim.defer_fn(function()
     log.debug(timer .. " is running now")
-    local job_function = select_job()
+    local job_function, method = select_job()
+    battery_status.method = method
+    log.debug("using method " .. method)
 
     if job_function then
       job_function(battery_status):start()
@@ -119,7 +130,9 @@ local function start_timer()
   timer = require("util.timers").get_next()
 
   -- Always call the job immediately before starting the timed loop
-  local job_function = select_job()
+  local job_function, method = select_job()
+  battery_status.method = method
+  log.debug("using method " .. method)
 
   if job_function then
     job_function(battery_status):start()
@@ -203,4 +216,5 @@ end
 M.setup = setup
 M.get_battery_status = get_battery_status
 M.get_status_line = get_status_line
+M.get_method = get_method
 return M

lua/battery/health.lua

@@ -4,23 +4,19 @@ local start = vim.health.start or vim.health.report_start
 local ok = vim.health.ok or vim.health.report_ok
 local error = vim.health.error or vim.health.report_error
 
--- TODO should check if the plugin is initialized and the setup is valid
--- TODO should check what method is being used for battery information
+local B = require("battery.battery")
 
-local function check_setup()
-  return true
+local function check_method()
+  return B.get_method() ~= nil
 end
 
 M.check = function()
-  start("battery report")
-  -- make sure setup function parameters are ok
-  if check_setup() then
-    ok("Setup function is correct")
+  start("Checking method to get battery status")
+  if check_method() then
+    ok("Using " .. B.get_method() ..  "")
   else
-    error("Setup function is incorrect")
+    error("No method found.")
   end
-  -- do some more checking
-  -- ...
 end
 
 return M

lua/util/file.lua

@@ -0,0 +1,10 @@
+local bit = require('bit')
+
+local function is_readable_directory(file)
+  local s = vim.loop.fs_stat(file)
+  return s ~= nil and s.type == 'directory' and bit.band(s.mode, 4) == 4
+end
+
+return {
+  is_readable_directory = is_readable_directory,
+}