refactor(devices): rename alias fields

Author: haithium

src/evdev/devices.lua

@@ -12,9 +12,9 @@ local M = {
   device_info = core.device_info,
 }
 
----@type fun(devs:evdev.deviceInfo[], paths:table<string,evdev.deviceInfo>, field:"by_id"|"by_path")
+---@type fun(devs:evdev.deviceInfo[], paths:table<string,evdev.deviceInfo>, field:"id_aliases"|"path_aliases")
 local function attach_alias(devs, paths, field)
-  local dir = "/dev/input/" .. (field == "by_path" and "by-path" or "by-id")
+  local dir = "/dev/input/" .. (field == "path_aliases" and "by-path" or "by-id")
   local aliases = list_aliases(dir)
   if not aliases then
     return
@@ -46,8 +46,8 @@ local function attach_aliases(devs)
     paths[info.path] = info
   end
 
-  attach_alias(devs, paths, "by_id")
-  attach_alias(devs, paths, "by_path")
+  attach_alias(devs, paths, "id_aliases")
+  attach_alias(devs, paths, "path_aliases")
 end
 
 local function has_value(ls, query)
@@ -64,7 +64,7 @@ end
 ---@param dev evdev.deviceInfo
 local function matches_query(dev, query, is_path)
   if is_path then
-    return dev.path == query or has_value(dev.by_id, query) or has_value(dev.by_path, query)
+    return dev.path == query or has_value(dev.id_aliases, query) or has_value(dev.path_aliases, query)
   end
   return dev.name == query
 end

tests/devices.test.lua

@@ -6,15 +6,15 @@ local sleep = system.sleep
 
 local function find_by_id(devs)
   for _, dev in ipairs(devs) do
-    if dev.by_id and next(dev.by_id) then
+    if dev.id_aliases and next(dev.id_aliases) then
       return dev
     end
   end
 end
 
 local function find_by_path(devs)
   for _, dev in ipairs(devs) do
-    if dev.by_path and next(dev.by_path) then
+    if dev.path_aliases and next(dev.path_aliases) then
       return dev
     end
   end
@@ -79,16 +79,16 @@ describe("evdev.devices", function()
 
     it("attaches alias lists when present", function()
       for _, info in ipairs(devs) do
-        if info.by_id then
-          assert.Table(info.by_id)
-          for _, alias in ipairs(info.by_id) do
+        if info.id_aliases then
+          assert.Table(info.id_aliases)
+          for _, alias in ipairs(info.id_aliases) do
             assert.String(alias)
           end
         end
 
-        if info.by_path then
-          assert.Table(info.by_path)
-          for _, alias in ipairs(info.by_path) do
+        if info.path_aliases then
+          assert.Table(info.path_aliases)
+          for _, alias in ipairs(info.path_aliases) do
             assert.String(alias)
           end
         end
@@ -127,7 +127,7 @@ describe("evdev.devices", function()
         pending("no discovered device with a by-id alias")
       end
 
-      local dev = find(dev_with_alias.by_id[1])
+      local dev = find(dev_with_alias.id_aliases[1])
       assert.Table(dev) ---@cast dev -?
       assert.Equal(dev_with_alias.path, dev.path)
     end)
@@ -138,7 +138,7 @@ describe("evdev.devices", function()
         pending("no discovered device with a by-path alias")
       end
 
-      local dev = find(dev_with_alias.by_path[1])
+      local dev = find(dev_with_alias.path_aliases[1])
       assert.Table(dev) ---@cast dev -?
       assert.Equal(dev_with_alias.path, dev.path)
     end)
@@ -180,7 +180,7 @@ describe("evdev.devices", function()
         pending("no discovered device with a by-id alias")
       end
 
-      local dev = find_all(dev_with_alias.by_id[1])
+      local dev = find_all(dev_with_alias.id_aliases[1])
       assert.Table(dev) ---@cast dev -?
       assert.Equal(1, #dev)
       assert.Equal(dev_with_alias.path, dev[1].path)
@@ -192,7 +192,7 @@ describe("evdev.devices", function()
         pending("no discovered device with a by-path alias")
       end
 
-      local dev = find_all(dev_with_alias.by_path[1])
+      local dev = find_all(dev_with_alias.path_aliases[1])
       assert.Table(dev) ---@cast dev -?
       assert.Equal(1, #dev)
       assert.Equal(dev_with_alias.path, dev[1].path)

types/device.d.lua

@@ -16,8 +16,8 @@
 ---
 ---@class evdev.deviceInfo
 ---@field bustype integer Bus type from the kernel input ID.
----@field by_id? string[] Symlink aliases under `/dev/input/by-id`, when available.
----@field by_path? string[] Symlink aliases under `/dev/input/by-path`, when available.
+---@field id_aliases? string[] Symlink aliases under `/dev/input/by-id`, when available.
+---@field path_aliases? string[] Symlink aliases under `/dev/input/by-path`, when available.
 ---@field name? string Device name reported by the kernel.
 ---@field path string Device node path.
 ---@field phys? string Physical device path, when available.