summaryrefslogtreecommitdiff
path: root/github-prs-widget/init.lua
blob: 8d59ac8a4b3238e8eb581f690aca9598a605f2e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
-------------------------------------------------
-- GitHub Widget for Awesome Window Manager
-- Shows the number of currently assigned merge requests
-- and information about them
-- More details could be found here:
-- https://github.com/streetturtle/awesome-wm-widgets/tree/master/github-prs-widget

-- @author Pavel Makhov
-- @copyright 2021 Pavel Makhov
-------------------------------------------------

local awful = require("awful")
local wibox = require("wibox")
local watch = require("awful.widget.watch")
local json = require("json")
local spawn = require("awful.spawn")
local naughty = require("naughty")
local gears = require("gears")
local beautiful = require("beautiful")
local gfs = require("gears.filesystem")
local color = require("gears.color")

local HOME_DIR = os.getenv("HOME")
local WIDGET_DIR = HOME_DIR .. '/.config/awesome/awesome-wm-widgets/github-prs-widget/'
local ICONS_DIR = WIDGET_DIR .. 'icons/'

local AVATARS_DIR = HOME_DIR .. '/.cache/awmw/github-widget/avatars/'
local DOWNLOAD_AVATAR_CMD = [[sh -c "curl -L --create-dirs -o ''\\]] .. AVATARS_DIR .. [[%s %s"]]

local GET_PRS_CMD = "gh api -X GET search/issues "
        .. "-f 'q=review-requested:%s is:unmerged is:open' "
        .. "-f per_page=30 "
        .. "--jq '[.items[] | {url,repository_url,title,html_url,comments,assignees,user,created_at,draft}]'"

local github_widget = wibox.widget {
    {
        {
            {
                {
                    {
                        id = 'icon',
                        widget = wibox.widget.imagebox
                    },
                    {
                        id = 'error_marker',
                        draw = function(_, _, cr, width, height)
                            cr:set_source(color('#BF616A'))
                            cr:arc(width - height / 6, height / 6, height / 6, 0, math.pi * 2)
                            cr:fill()
                        end,
                        visible = false,
                        layout = wibox.widget.base.make_widget,
                    },
                    layout = wibox.layout.stack
                },
                margins = 4,
                layout = wibox.container.margin
            },
            {
                id = "txt",
                widget = wibox.widget.textbox
            },
            {
                id = "new_pr",
                widget = wibox.widget.textbox
            },
            spacing = 4,
            layout = wibox.layout.fixed.horizontal,
        },
        left = 4,
        right = 4,
        widget = wibox.container.margin
    },
    shape = function(cr, width, height)
        gears.shape.rounded_rect(cr, width, height, 4)
    end,
    widget = wibox.container.background,
    set_text = function(self, new_value)
        self:get_children_by_id('txt')[1]:set_text(new_value)
    end,
    set_icon = function(self, new_value)
        self:get_children_by_id('icon')[1]:set_image(new_value)
    end,
    is_everything_ok = function(self, is_ok)
        if is_ok then
            self:get_children_by_id('error_marker')[1]:set_visible(false)
            self:get_children_by_id('icon')[1]:set_opacity(1)
            self:get_children_by_id('icon')[1]:emit_signal('widget:redraw_needed')
        else
            self.txt:set_text('')
            self:get_children_by_id('error_marker')[1]:set_visible(true)
            self:get_children_by_id('icon')[1]:set_opacity(0.2)
            self:get_children_by_id('icon')[1]:emit_signal('widget:redraw_needed')
        end
    end
}

local function show_warning(message)
    naughty.notify{
        preset = naughty.config.presets.critical,
        title = 'GitHub PRs Widget',
        text = message}
end

local popup = awful.popup{
    ontop = true,
    visible = false,
    shape = gears.shape.rounded_rect,
    border_width = 1,
    maximum_width = 400,
    offset = { y = 5 },
    widget = {}
}

--- Converts string representation of date (2020-06-02T11:25:27Z) to date
local function parse_date(date_str)
    local pattern = "(%d+)%-(%d+)%-(%d+)T(%d+):(%d+):(%d+)%Z"
    local y, m, d, h, min, sec, _ = date_str:match(pattern)

    return os.time{year = y, month = m, day = d, hour = h, min = min, sec = sec}
end

--- Converts seconds to "time ago" represenation, like '1 hour ago'
local function to_time_ago(seconds)
    local days = seconds / 86400
    if days > 1 then
        days = math.floor(days + 0.5)
        return days .. (days == 1 and ' day' or ' days') .. ' ago'
    end

    local hours = (seconds % 86400) / 3600
    if hours > 1 then
        hours = math.floor(hours + 0.5)
        return hours .. (hours == 1 and ' hour' or ' hours') .. ' ago'
    end

    local minutes = ((seconds % 86400) % 3600) / 60
    if minutes > 1 then
        minutes = math.floor(minutes + 0.5)
        return minutes .. (minutes == 1 and ' minute' or ' minutes') .. ' ago'
    end
end

local function ellipsize(text, length)
    return (text:len() > length and length > 0)
            and text:sub(0, length - 3) .. '...'
            or text
end

local warning_shown = false
local tooltip = awful.tooltip {
    mode = 'outside',
    preferred_positions = {'bottom'},
}

local config = {}

config.reviewer = nil

config.bg_normal = '#aaaaaa'
config.bg_focus = '#ffffff'


local function worker(user_args)

    local args = user_args or {}

    -- Setup config for the widget instance.
    -- The `_config` table will keep the first existing value after checking
    -- in this order: user parameter > beautiful > module default
    local _config = {}
    for prop, value in pairs(config) do
        _config[prop] = args[prop] or beautiful[prop] or value
    end

    local icon = args.icon or ICONS_DIR .. 'git-pull-request.svg'
    local reviewer = args.reviewer
    local timeout = args.timeout or 60

    local current_number_of_prs

    local to_review_rows = {layout = wibox.layout.fixed.vertical}
    local rows = {layout = wibox.layout.fixed.vertical}

    github_widget:set_icon(icon)

    local update_widget = function(widget, stdout, stderr, _, _)

        if stderr ~= '' then
            if not warning_shown then
                show_warning(stderr)
                warning_shown = true
                widget:is_everything_ok(false)
                tooltip:add_to_object(widget)

                widget:connect_signal('mouse::enter', function()
                    tooltip.text = stderr
                end)
            end
            return
        end

        warning_shown = false
        tooltip:remove_from_object(widget)
        widget:is_everything_ok(true)

        local prs = json.decode(stdout)

        current_number_of_prs = #prs

        if current_number_of_prs == 0 then
            widget:set_visible(false)
            return
        end

        widget:set_visible(true)
        widget:set_text(current_number_of_prs)

        for i = 0, #rows do rows[i]=nil end

        for i = 0, #to_review_rows do to_review_rows[i]=nil end
        table.insert(to_review_rows, {
            {
                markup = '<span size="large" color="#ffffff">PRs to review</span>',
                align = 'center',
                forced_height = 20,
                widget = wibox.widget.textbox
            },
            bg = _config.bg_normal,
            widget = wibox.container.background
        })

        local current_time = os.time(os.date("!*t"))

        for _, pr in ipairs(prs) do
            local path_to_avatar = AVATARS_DIR .. pr.user.id
            local index = string.find(pr.repository_url, "/[^/]*$")
            local repo = string.sub(pr.repository_url, index + 1)

            local row = wibox.widget {
                {
                    {
                        {
                            {
                                resize = true,
                                image = path_to_avatar,
                                forced_width = 40,
                                forced_height = 40,
                                widget = wibox.widget.imagebox
                            },
                            id = 'avatar',
                            margins = 4,
                            layout = wibox.container.margin
                        },
                        {
                            {
                                id = 'title',
                                markup = '<b>' .. ellipsize(pr.title, 60) .. '</b>',
                                widget = wibox.widget.textbox,
                                forced_width = 400
                            },
                            {
                                {
                                    {
                                        {
                                            image = ICONS_DIR .. 'book.svg',
                                            forced_width = 12,
                                            forced_height = 12,
                                            resize = true,
                                            widget = wibox.widget.imagebox
                                        },
                                        {
                                            text = repo,
                                            widget = wibox.widget.textbox
                                        },
                                        spacing = 4,
                                        expand = 'none',
                                        layout = wibox.layout.fixed.horizontal
                                    },
                                    {
                                        {
                                            image = ICONS_DIR .. 'user.svg',
                                            forced_width = 12,
                                            forced_height = 12,
                                            resize = true,
                                            widget = wibox.widget.imagebox
                                        },
                                        {
                                            text = pr.user.login,
                                            widget = wibox.widget.textbox
                                        },
                                        spacing = 4,
                                        expand = 'none',
                                        layout = wibox.layout.fixed.horizontal
                                    },
                                    spacing = 8,
                                    expand = 'none',
                                    layout = wibox.layout.fixed.horizontal
                                },
                                {
                                    {
                                        {
                                            image = ICONS_DIR .. 'user.svg',
                                            forced_width = 12,
                                            forced_height = 12,
                                            resize = true,
                                            widget = wibox.widget.imagebox
                                        },
                                        {
                                            text = to_time_ago(os.difftime(current_time, parse_date(pr.created_at))),
                                            widget = wibox.widget.textbox
                                        },
                                        spacing = 4,
                                        expand = 'none',
                                        layout = wibox.layout.fixed.horizontal

                                    },
                                    {
                                        {
                                            image = ICONS_DIR .. 'message-square.svg',
                                            forced_width = 12,
                                            forced_height = 12,
                                            resize = true,
                                            widget = wibox.widget.imagebox
                                        },
                                        {
                                            text = pr.comments,
                                            widget = wibox.widget.textbox
                                        },
                                        spacing = 4,
                                        expand = 'none',
                                        layout = wibox.layout.fixed.horizontal

                                    },
                                    spacing = 8,
                                    layout = wibox.layout.fixed.horizontal
                                },
                                layout = wibox.layout.fixed.vertical
                            },
                            spacing = 4,
                            layout = wibox.layout.fixed.vertical
                        },
                        spacing = 8,
                        layout = wibox.layout.fixed.horizontal
                    },
                    margins = 8,
                    layout = wibox.container.margin
                },
                bg = _config.bg_normal,
                widget = wibox.container.background
            }

            if not gfs.file_readable(path_to_avatar) then
                spawn.easy_async(string.format(
                        DOWNLOAD_AVATAR_CMD,
                        pr.user.id,
                        pr.user.avatar_url), function()
                    row:get_children_by_id('avatar')[1]:set_image(path_to_avatar)
                end)
            end

            row:connect_signal("mouse::enter", function(c) c:set_bg(_config.bg_focus) end)
            row:connect_signal("mouse::leave", function(c) c:set_bg(_config.bg_normal) end)

            row:get_children_by_id('title')[1]:buttons(
                    awful.util.table.join(
                            awful.button({}, 1, function()
                                spawn.with_shell("xdg-open " .. pr.html_url)
                                popup.visible = false
                            end)
                    )
            )
            row:get_children_by_id('avatar')[1]:buttons(
                    awful.util.table.join(
                            awful.button({}, 1, function()
                                spawn.with_shell("xdg-open " .. pr.user.html_url)
                                popup.visible = false
                            end)
                    )
            )

            local old_cursor, old_wibox
            row:get_children_by_id('title')[1]:connect_signal("mouse::enter", function()
                local wb = mouse.current_wibox
                old_cursor, old_wibox = wb.cursor, wb
                wb.cursor = "hand1"
            end)
            row:get_children_by_id('title')[1]:connect_signal("mouse::leave", function()
                if old_wibox then
                    old_wibox.cursor = old_cursor
                    old_wibox = nil
                end
            end)

            row:get_children_by_id('avatar')[1]:connect_signal("mouse::enter", function()
                local wb = mouse.current_wibox
                old_cursor, old_wibox = wb.cursor, wb
                wb.cursor = "hand1"
            end)
            row:get_children_by_id('avatar')[1]:connect_signal("mouse::leave", function()
                if old_wibox then
                    old_wibox.cursor = old_cursor
                    old_wibox = nil
                end
            end)

            table.insert(to_review_rows, row)
        end

        table.insert(rows, to_review_rows)
        popup:setup(rows)
    end

    github_widget:buttons(
            awful.util.table.join(
                    awful.button({}, 1, function()
                        if popup.visible then
                            popup.visible = not popup.visible
                            github_widget:set_bg('#00000000')
                        else
                            github_widget:set_bg(beautiful.bg_focus)
                            popup:move_next_to(mouse.current_widget_geometry)
                        end
                    end)
            )
    )

    watch(string.format(GET_PRS_CMD, reviewer),
            timeout, update_widget, github_widget)

    return github_widget
end

return setmetatable(github_widget, { __call = function(_, ...) return worker(...) end })