Fix dotfiles structure

.config/awesome/awesome-wm-widgets/gerrit-widget/README.md

@@ -0,0 +1,77 @@
+# Gerrit widget
+
+It shows number of currently assigned reviews in [Gerrit](https://www.gerritcodereview.com/) to the user (by default) :
+ 
+ ![gerrit_widget](./gerrit_widget.png)
+ 
+ when clicked it shows reviews in a list:
+ 
+ ![popup](./popup.png)
+ 
+ left click on an item will open review in the default browser, right click will copy the review number, which you can use to checkout this review by running `git-review -d <review number>`.
+ 
+ Also, if a new review is assigned to the user, there will be a pop-up:
+ 
+ ![new_review](./new_review.png)
+
+## Customization
+
+It is possible to customize widget by providing a table with all or some of the following config parameters:
+
+| Name | Default | Description |
+|---|---|---|
+| `icon`| `/.config/awesome/awesome-wm-widgets/gerrit-widget/gerrit_icon.svg`| Path to the icon |
+| `host` | Required | Ex https://gerrit.tmnt.com |
+| `query` | `is:reviewer AND status:open AND NOT is:wip` | Query to retrieve reviews |
+| `timeout` | 10 | How often in seconds the widget refreshes |
+
+## Prerequisite
+
+ - [curl](https://curl.haxx.se/) - is used to communicate with gerrit's [REST API](https://gerrit-review.googlesource.com/Documentation/rest-api.html)
+ - setup [netrc](https://ec.haxx.se/usingcurl-netrc.html) which is used to store username and password in order to call API's endpoints.
+
+## Installation
+
+1. This widget relies on Gerrit [REST API](https://gerrit-review.googlesource.com/Documentation/rest-api.html), so you need to have a permission to access it. You also need to setup [netrc](https://ec.haxx.se/usingcurl-netrc.html), as widget uses curl to communicate with API and you have to be authenticated. 
+To test if you have access to API and netrc setup is correct run following command, you should have a json response:
+
+    ```bash
+     curl  -s --request GET --netrc https://gerrit-host.com/a/changes/\?q\=status:open+AND+NOT+is:wip+AND+is:reviewer | tail -n +2
+    ``` 
+    Note: `tail -n +2` is needed to skip first line of the response, as gerrit returns some characters there in order to prevent XSS hacks.
+
+1. Download json parser for lua from [github.com/rxi/json.lua](https://github.com/rxi/json.lua) and place it under **~/.config/awesome/** (don't forget to star a repo):
+
+    ```bash
+    wget -P ~/.config/awesome/ https://raw.githubusercontent.com/rxi/json.lua/master/json.lua
+    ```
+
+1. Clone this repo (if not cloned yet) under **~/.config/awesome/**:
+
+    ```bash
+    git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
+    ```
+
+1. Require widget at the top of the **rc.lua**:
+
+    ```lua
+    local gerrit_widget = require("awesome-wm-widgets.gerrit-widget.gerrit")
+    ```
+
+1. Add widget to the tasklist:
+
+    ```lua
+    s.mytasklist, -- Middle widget
+        { -- Right widgets
+            layout = wibox.layout.fixed.horizontal,
+            ...
+            --default
+            gerrit_widget({host = 'https://gerrit.tmnt.com'}),
+            --customized
+            gerrit_widget({
+                host = 'https://gerrit.tmnt.com',
+                query = 'is:reviewer AND is:wip'
+            })
+            ...
+    ```
+    

.config/awesome/awesome-wm-widgets/gerrit-widget/gerrit.lua

@@ -0,0 +1,230 @@
+-------------------------------------------------
+-- Gerrit Widget for Awesome Window Manager
+-- Shows the number of currently assigned reviews
+-- More details could be found here:
+-- https://github.com/streetturtle/awesome-wm-widgets/tree/master/gerrit-widget
+
+-- @author Pavel Makhov
+-- @copyright 2019 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 HOME_DIR = os.getenv("HOME")
+local PATH_TO_AVATARS = HOME_DIR .. '/.cache/awmw/gerrit-widget/avatars/'
+
+local GET_CHANGES_CMD = [[bash -c "curl -s -X GET -n %s/a/changes/\\?q\\=%s | tail -n +2"]]
+local GET_USER_CMD = [[bash -c "curl -s -X GET -n %s/accounts/%s/ | tail -n +2"]]
+local DOWNLOAD_AVATAR_CMD = [[bash -c "curl --create-dirs -o %s %s"]]
+
+local gerrit_widget = {}
+
+local function worker(user_args)
+
+    local args = user_args or {}
+
+    local icon = args.icons or HOME_DIR .. '/.config/awesome/awesome-wm-widgets/gerrit-widget/gerrit_icon.svg'
+    local host = args.host or naughty.notify{
+        preset = naughty.config.presets.critical,
+        title = 'Gerrit Widget',
+        text = 'Gerrit host is unknown'
+    }
+    local query = args.query or 'is:reviewer AND status:open AND NOT is:wip'
+    local timeout = args.timeout or 10
+
+    local current_number_of_reviews
+    local previous_number_of_reviews = 0
+    local name_dict = {}
+
+    local rows = {
+        { widget = wibox.widget.textbox },
+        layout = wibox.layout.fixed.vertical,
+    }
+
+    local popup = awful.popup{
+        ontop = true,
+        visible = false,
+        shape = gears.shape.rounded_rect,
+        border_width = 1,
+        border_color = beautiful.bg_focus,
+        maximum_width = 400,
+        offset = { y = 5 },
+        widget = {}
+    }
+
+    gerrit_widget = wibox.widget {
+        {
+            {
+                image = icon,
+                widget = wibox.widget.imagebox
+            },
+            margins = 4,
+            layout = wibox.container.margin
+        },
+        {
+            id = "txt",
+            widget = wibox.widget.textbox
+        },
+        {
+            id = "new_rev",
+            widget = wibox.widget.textbox
+        },
+        layout = wibox.layout.fixed.horizontal,
+        set_text = function(self, new_value)
+            self.txt.text = new_value
+        end,
+        set_unseen_review = function(self, is_new_review)
+            self.new_rev.text = is_new_review and '*' or ''
+        end
+    }
+
+    local function get_name_by_user_id(user_id)
+        if name_dict[user_id] == nil then
+            name_dict[user_id] = {}
+        end
+
+        if name_dict[user_id].username == nil then
+            name_dict[user_id].username = ''
+            spawn.easy_async(string.format(GET_USER_CMD, host, user_id), function(stdout)
+                local user = json.decode(stdout)
+                name_dict[tonumber(user_id)].username = user.name
+                if not gfs.file_readable(PATH_TO_AVATARS .. user_id) then
+                    spawn.easy_async(
+                        string.format(DOWNLOAD_AVATAR_CMD, PATH_TO_AVATARS .. user_id, user.avatars[1].url))
+                end
+            end)
+            return name_dict[user_id].username
+        end
+
+        return name_dict[user_id].username
+    end
+
+    local update_widget = function(widget, stdout, _, _, _)
+        local reviews = json.decode(stdout)
+
+        current_number_of_reviews = rawlen(reviews)
+
+        if current_number_of_reviews == 0 then
+            widget:set_visible(false)
+            return
+        else
+            widget:set_visible(true)
+        end
+
+        widget:set_visible(true)
+        if current_number_of_reviews > previous_number_of_reviews then
+            widget:set_unseen_review(true)
+            naughty.notify{
+                icon = HOME_DIR ..'/.config/awesome/awesome-wm-widgets/gerrit-widget/gerrit_icon.svg',
+                title = 'New Incoming Review',
+                text = reviews[1].project .. '\n' .. get_name_by_user_id(reviews[1].owner._account_id) ..
+                    reviews[1].subject .. '\n',
+                run = function() spawn.with_shell("xdg-open https://" .. host .. '/' .. reviews[1]._number) end
+            }
+        end
+
+        previous_number_of_reviews = current_number_of_reviews
+        widget:set_text(current_number_of_reviews)
+
+        for i = 0, #rows do rows[i]=nil end
+        for _, review in ipairs(reviews) do
+
+            local row = wibox.widget {
+                {
+                    {
+                        {
+                            {
+                                resize = true,
+                                image = PATH_TO_AVATARS .. review.owner._account_id,
+                                forced_width = 40,
+                                forced_height = 40,
+                                widget = wibox.widget.imagebox
+                            },
+                            margins = 8,
+                            layout = wibox.container.margin
+                        },
+                        {
+                            {
+                                markup = '<b>' .. review.project .. '</b>',
+                                align = 'center',
+                                widget = wibox.widget.textbox
+                            },
+                            {
+                                text = '  ' .. review.subject,
+                                widget = wibox.widget.textbox
+                            },
+                            {
+                                text = '  ' .. get_name_by_user_id(review.owner._account_id),
+                                widget = wibox.widget.textbox
+                            },
+                            layout = wibox.layout.align.vertical
+                        },
+                        spacing = 8,
+                        layout = wibox.layout.fixed.horizontal
+                    },
+                    margins = 8,
+                    layout = wibox.container.margin
+                },
+                widget = wibox.container.background
+            }
+
+            row:connect_signal("button::release", function()
+                spawn.with_shell("xdg-open " .. host .. '/' .. review._number)
+            end)
+
+            row:connect_signal("mouse::enter", function(c) c:set_bg(beautiful.bg_focus) end)
+            row:connect_signal("mouse::leave", function(c) c:set_bg(beautiful.bg_normal) end)
+
+            row:buttons(
+                awful.util.table.join(
+                    awful.button({}, 1, function()
+                        spawn.with_shell("xdg-open " .. host .. '/' .. review._number)
+                        popup.visible = false
+                    end),
+                    awful.button({}, 3, function()
+                        spawn.with_shell("echo '" .. review._number .."' | xclip -selection clipboard")
+                        popup.visible = false
+                    end)
+                )
+            )
+
+            table.insert(rows, row)
+        end
+
+        popup:setup(rows)
+    end
+
+    gerrit_widget:buttons(
+        awful.util.table.join(
+            awful.button({}, 1, function()
+                gerrit_widget:set_unseen_review(false)
+                if popup.visible then
+                    popup.visible = not popup.visible
+                else
+                    --local geo = mouse.current_widget_geometry
+                    --if theme.calendar_placement == 'center' then
+                    --    local x = geo.x + (geo.width / 2) - (popup:geometry().width / 2) -- align two widgets
+                    --    popup:move_next_to({x = x, y = geo.y + 22, width = 0, height = geo.height})
+                    --else
+                    --    popup:move_next_to(geo)
+                    --end
+
+                    popup:move_next_to(mouse.current_widget_geometry)
+                end
+            end)
+        )
+    )
+
+    watch(string.format(GET_CHANGES_CMD, host, query:gsub(" ", "+")), timeout, update_widget, gerrit_widget)
+    return gerrit_widget
+end
+
+return setmetatable(gerrit_widget, { __call = function(_, ...) return worker(...) end })

.config/awesome/awesome-wm-widgets/gerrit-widget/gerrit_icon.svg

@@ -0,0 +1,8 @@
+<svg width="52" height="52" xmlns="http://www.w3.org/2000/svg">
+<rect ry="4" rx="4" height="40" width="40" y="0" x="0" fill="#ffaaaa"/>
+<rect ry="4" rx="4" height="40" width="40" y="12" x="12" fill="#aaffaa"/>
+<path d="m18,22l12,0l0,4l-12,0l0,-4z" fill="#ff0000"/>
+<path d="m34,22l12,0l0,4l-12,0l0,-4z" fill="#ff0000"/>
+<path d="m18,36l4,0l0,-4l4,0l0,4l4,0l0,4l-4,0l0,4l-4,0l0,-4l-4,0l0,-4z" fill="#008000"/>
+<path d="m34,36l4,0l0,-4l4,0l0,4l4,0l0,4l-4,0l0,4l-4,0l0,-4l-4,0l0,-4z" fill="#008000"/>
+</svg>