From 603204c064d2819851b15c7083877d8fbac972aa Mon Sep 17 00:00:00 2001 From: Aire-One Date: Thu, 31 Oct 2024 21:19:34 +0100 Subject: [PATCH] init luarocks --- .cspell.json | 1 + .github/workflows/lint.yaml | 6 +- .github/workflows/rock.yaml | 32 +++--- awesome-battery_widget-dev-1.rockspec | 22 ++++ .../awesome-battery_widget/init.lua | 106 +++++++++--------- 5 files changed, 92 insertions(+), 75 deletions(-) create mode 100644 awesome-battery_widget-dev-1.rockspec rename init.lua => src/awesome-battery_widget/init.lua (58%) diff --git a/.cspell.json b/.cspell.json index 08e7561..6ca8908 100644 --- a/.cspell.json +++ b/.cspell.json @@ -15,6 +15,7 @@ "luacheckrc", "luadoc", "luarocks", + "lunarmodules", "mktemp", "mousegrabber", "rockspec", diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 3c82f12..e82957d 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -46,6 +46,6 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: leafo/gh-actions-lua@v9 - - uses: leafo/gh-actions-luarocks@v4 - - run: luarocks lint awesome-slot-dev-1.rockspec + - uses: luarocks/gh-actions-lua@v10 + - uses: luarocks/gh-actions-luarocks@v5 + - run: luarocks lint awesome-battery_widget-dev-1.rockspec diff --git a/.github/workflows/rock.yaml b/.github/workflows/rock.yaml index 29852af..c141123 100644 --- a/.github/workflows/rock.yaml +++ b/.github/workflows/rock.yaml @@ -1,21 +1,21 @@ name: Upload rock to LuaRocks on: - push: + push: jobs: - affected: - uses: lunarmodules/.github/.github/workflows/list_affected_rockspecs.yml@main - upload: - needs: affected - if: >- - ${{ - github.repository == 'Aire-One/awesome-slot' && - ( github.ref_name == 'master' || startsWith(github.ref, 'refs/tags/') ) && - needs.affected.outputs.rockspecs - }} - uses: lunarmodules/.github/.github/workflows/upload_to_luarocks.yml@main - with: - rockspecs: ${{ needs.affected.outputs.rockspecs }} - secrets: - apikey: ${{ secrets.LUAROCKS_APIKEY }} + affected: + uses: lunarmodules/.github/.github/workflows/list_affected_rockspecs.yml@main + upload: + needs: affected + if: >- + ${{ + github.repository == 'Aire-One/awesome-battery_widget' && + ( github.ref_name == 'master' || startsWith(github.ref, 'refs/tags/') ) && + needs.affected.outputs.rockspecs + }} + uses: lunarmodules/.github/.github/workflows/upload_to_luarocks.yml@main + with: + rockspecs: ${{ needs.affected.outputs.rockspecs }} + secrets: + apikey: ${{ secrets.LUAROCKS_APIKEY }} diff --git a/awesome-battery_widget-dev-1.rockspec b/awesome-battery_widget-dev-1.rockspec new file mode 100644 index 0000000..3809332 --- /dev/null +++ b/awesome-battery_widget-dev-1.rockspec @@ -0,0 +1,22 @@ +package = "awesome-battery_widget" +version = "dev-1" + +source = { + url = "git+https://github.com/Aire-One/awesome-battery_widget.git", +} + +description = { + summary = "A UPowerGlib based battery widget for the Awesome WM with a basic widget template mechanism! 🔋", + homepage = "https://github.com/Aire-One/awesome-battery_widget", + license = "*** please specify a license ***", +} + +build = { + type = "builtin", + modules = { + ["awesome-battery_widget.init"] = "src/awesome-battery_widget/init.lua", + }, + copy_directories = { + "doc", + }, +} diff --git a/init.lua b/src/awesome-battery_widget/init.lua similarity index 58% rename from init.lua rename to src/awesome-battery_widget/init.lua index a001d4f..eff783f 100644 --- a/init.lua +++ b/src/awesome-battery_widget/init.lua @@ -1,34 +1,33 @@ --------------------------------------------------------------------------- --- A battery widget based on the UPower deamon. +-- A battery widget based on the UPower daemon. -- -- @author Aire-One -- @copyright 2020 Aire-One --------------------------------------------------------------------------- -local upower = require('lgi').require('UPowerGlib') +local upower = require("lgi").require "UPowerGlib" -local gtable = require 'gears.table' -local gtimer = require 'gears.timer' -local wbase = require 'wibox.widget.base' +local gtable = require "gears.table" +local gtimer = require "gears.timer" -- cspell: ignore gtimer +local wbase = require "wibox.widget.base" -- cspell: ignore wbase local setmetatable = setmetatable -- luacheck: ignore setmetatable local battery_widget = {} local mt = {} - --- Helper to get the path of all connected power devices. -- @treturn table The list of all power devices path. -- @staticfct battery_widget.list_devices function battery_widget.list_devices() - local ret = {} - local devices = upower.Client():get_devices() + local ret = {} + local devices = upower.Client():get_devices() - for _,d in ipairs(devices) do - table.insert(ret, d:get_object_path()) - end + for _, d in ipairs(devices) do + table.insert(ret, d:get_object_path()) + end - return ret + return ret end --- Helper function to get a device instance from its path. @@ -36,23 +35,23 @@ end -- @treturn UPowerGlib.Device|nil The device if it was found, `nil` otherwise. -- @staticfct battery_widget.get_device function battery_widget.get_device(path) - local devices = upower.Client():get_devices() + local devices = upower.Client():get_devices() - for _,d in ipairs(devices) do - if d:get_object_path() == path then - return d - end - end + for _, d in ipairs(devices) do + if d:get_object_path() == path then + return d + end + end - return nil + return nil end --- Helper function to easily get the default BAT0 device path without. -- @treturn string The BAT0 device path. -- @staticfct battery_widget.get_BAT0_device_path function battery_widget.get_BAT0_device_path() - local bat0_path = '/org/freedesktop/UPower/devices/battery_BAT0' - return bat0_path + local bat0_path = "/org/freedesktop/UPower/devices/battery_BAT0" + return bat0_path end --- Helper function to convert seconds into a human readable clock string. @@ -64,34 +63,31 @@ end -- @treturn string The human readable generated clock string. -- @staticfct battery_widget.to_clock function battery_widget.to_clock(seconds) - if seconds <= 0 then - return '00:00'; - else - local hours = string.format('%02.f', math.floor(seconds/3600)); - local mins = string.format('%02.f', math.floor(seconds/60 - hours*60)); - return hours .. ':' .. mins - end + if seconds <= 0 then + return "00:00" + else + local hours = string.format("%02.f", math.floor(seconds / 3600)) + local mins = string.format("%02.f", math.floor(seconds / 60 - hours * 60)) + return hours .. ":" .. mins + end end - --- Gives the default widget to use if user didn't specify one. -- The default widget used is an `empty_widget` instance. -- @treturn widget The default widget to use. -local function default_template () - return wbase.empty_widget() +local function default_template() + return wbase.empty_widget() end - --- The device monitored by the widget. -- @property device -- @tparam UPowerGlib.Device device ---- Emited when the UPower device notify an update. +--- Emitted when the UPower device notify an update. -- @signal upower::update -- @tparam battery_widget widget The widget. -- @tparam UPowerGlib.Device device The Upower device. - --- battery_widget constructor. -- -- This function creates a new `battery_widget` instance. This widget watches @@ -106,35 +102,33 @@ end -- widget creation. -- @treturn battery_widget The battery_widget instance build. -- @constructorfct battery_widget.new -function battery_widget.new (args) - args = gtable.crush({ - widget_template = default_template(), - device_path = '', - use_display_device = false - }, args or {}) +function battery_widget.new(args) + args = gtable.crush({ + widget_template = default_template(), + device_path = "", + use_display_device = false, + }, args or {}) - local widget = wbase.make_widget_from_value(args.widget_template) + local widget = wbase.make_widget_from_value(args.widget_template) - widget.device = args.use_display_device - and upower.Client():get_display_device() - or battery_widget.get_device(args.device_path) + widget.device = args.use_display_device and upower.Client():get_display_device() + or battery_widget.get_device(args.device_path) - -- Attach signals: - widget.device.on_notify = function (d) - widget:emit_signal('upower::update', d) - end + -- Attach signals: + widget.device.on_notify = function(d) + widget:emit_signal("upower::update", d) + end - -- Call an update cycle if the user asked to instan update the widget. - if args.instant_update then - gtimer.delayed_call(widget.emit_signal, widget, 'upower::update', widget.device) - end + -- Call an update cycle if the user asked to instant update the widget. + if args.instant_update then + gtimer.delayed_call(widget.emit_signal, widget, "upower::update", widget.device) + end - return widget + return widget end - -function mt.__call(self, ...) - return battery_widget.new(...) +function mt.__call(_, ...) + return battery_widget.new(...) end return setmetatable(battery_widget, mt)