-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjira-fmt.el
190 lines (151 loc) · 6.87 KB
/
jira-fmt.el
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
;;; jira-fmt.el --- Formatting data -*- lexical-binding: t -*-
;; Copyright (C) 2025 Pablo González Carrizo
;; Author: Pablo González Carrizo <[email protected]>
;; Created: 2025-02-16
;; This file is NOT part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; Formatting data to display
;;; Code:
(require 'jira-api)
(require 'jira-utils)
(defface jira-face-link
'((t :inherit link)) "Face used to show links." :group 'jira)
(defface jira-face-date
'((t :inherit shadow))"Face used to show dates." :group 'jira)
(defface jira-face-date-today
'((t :inherit success))"Face used to show today date." :group 'jira)
(defface jira-face-time
'((t :inherit match)) "Face used to show times." :group 'jira)
(defface jira-face-success
'((t (:foreground "#fff" :background "#77AA77")))
"Face used to show success status." :group 'jira)
(defface jira-face-error
'((t (:foreground "#fff" :background "#884444")))
"Face used to show error status." :group 'jira)
(defface jira-face-info
'((t (:foreground "#fff" :background "#555588")))
"Face used to show info status." :group 'jira)
(defface jira-face-tag
'((t (:foreground "#fff" :background "#999999")))
"Face used to show tags." :group 'jira)
(defcustom jira-statuses-done '("Done" "Closed" "Waiting for QA")
"A list of statuses names representing done state."
:type '(repeat string) :group 'jira)
(defcustom jira-statuses-progress '("In Progress" "Pull-request")
"A list of statuses names representing progress state."
:type '(repeat string) :group 'jira)
(defcustom jira-statuses-todo '("To do" "Backlog")
"A list of statuses names representing TODO."
:type '(repeat string) :group 'jira)
(defcustom jira-statuses-error '("Blocked" "Paused")
"A list of statuses names representing problems in tasks."
:type '(repeat string) :group 'jira)
(defun jira-fmt--link-action (button)
"Action to open the link in BUTTON."
(browse-url (button-get button 'href)))
(defun jira-fmt-issue-key (issue-id)
"Format ISSUE-ID as a link to the issue in Jira (in a tabulated list)."
(list issue-id
'face 'jira-face-link
'help-echo (format "Click to open: %s" issue-id)
'href (concat jira-base-url "/browse/" issue-id)
'follow-link t
'action #'jira-fmt--link-action))
(defun jira-fmt-issue-key-not-tabulated (issue-id)
"Format ISSUE-ID as a link to the issue in Jira (outside a tabulated list)."
(buttonize
issue-id
(lambda (_data) (interactive)
(browse-url (concat jira-base-url "/browse/" issue-id)))))
(defun jira-fmt-date (date &optional color-today)
"Format DATE as `YYYY-MM-DD, Day of week` and adding color for current day.
COLOR-TODAY is a boolean to color the date if it is today."
(when (not (string-empty-p date))
(let ((value (concat date ", " (jira-utils-get-day-of-week date))))
(if (and color-today
(string= date (format-time-string "%F" (current-time))))
(propertize value 'face 'jira-face-date-today)
(propertize value 'face 'jira-face-date)))))
(defun jira-fmt-time-from-secs (secs)
"Format SECS as a string in the form `XhYm`."
(let* ((secs-num (string-to-number (or secs 0)))
(hours (truncate (/ (float secs-num) 3600)))
(minutes (truncate (/ (float (% secs-num 3600)) 60))))
(propertize
(concat
(if (> hours 0) (format "%sh" hours) "")
(when (or (> minutes 0) (= hours 0))
(concat (if (> hours 0) " " "") (format "%sm" minutes))))
'face 'jira-face-time)))
(defun jira-fmt-issue-progress (value)
"Format progress VALUE as a percentage and adding color."
(let ((val (concat (if (or (string-empty-p value) (string= value "-1"))
"0" value)
"%")))
(cond ((= (string-to-number val) 100) (propertize val 'face 'jira-face-success))
((> (string-to-number val) 100) (propertize val 'face 'jira-face-error))
(t val))))
(defun jira-fmt-issue-status (value)
"Format status VALUE adding color."
(cond ((member value jira-statuses-done)
(propertize (upcase value) 'face 'jira-face-success))
((member value jira-statuses-progress)
(propertize (upcase value) 'face 'jira-face-info))
((member value jira-statuses-todo)
(propertize (upcase value) 'face 'jira-face-error))
((member value jira-statuses-error)
(propertize (upcase value) 'face 'jira-face-error))
((or (string= value "Requirements Backlog"))
(propertize (upcase "Backlog") 'face 'jira-face-tag))
(t (propertize (upcase value) 'face 'jira-face-tag))))
(defun jira-fmt-truncate (len str)
"Truncate STR to LEN characters, removing any line breaks."
(let ((cleaned-str (replace-regexp-in-string "[\n\r]" " " str)))
(if (> (length cleaned-str) len)
(concat (substring cleaned-str 0 (- len 3)) "...")
cleaned-str)))
(defun jira-fmt--list-from-regex (regex value)
"Extract a list of values from VALUE using REGEX."
(let* ((pos 0) matches)
(while (string-match regex value pos)
(push (match-string 1 value) matches)
(setq pos (match-end 0)))
(string-join (reverse matches) ", ")))
;; TODO Ugly, but it works, there were problems parsing the JSON
(defun jira-fmt-issue-fix-versions (value)
"Extract a list of fix versions from VALUE."
(jira-fmt--list-from-regex "(name\\s-+\\.\\s-+\\([^ )]+\\))" value))
(defun jira-fmt-issue-components (value)
"Extract a list of components from VALUE."
(jira-fmt--list-from-regex "(name\\s-+\\.\\s-+\\([^()]+\\))" value))
(defun jira-fmt-issue-sprints (value)
"Extract a list of sprints from VALUE."
(jira-fmt--list-from-regex "(name\\s-+\\.\\s-+\\([^()]+\\))" value))
(defun jira-fmt-cost-center (value)
"Extract a list of cost centers from VALUE."
(jira-fmt--list-from-regex "(value\\s-+\\.\\s-+\\([^()]+\\))" value))
(defun jira-fmt-business-line (value)
"Extract a list of business lines from VALUE."
(jira-fmt--list-from-regex "(value\\s-+\\.\\s-+\\([^()]+\\))" value))
(defun jira-fmt-issue-type-name (value)
"Format issue type VALUE."
(propertize value 'face 'bold))
(defun jira-fmt-bold (value)
"Format VALUE as bold."
(propertize value 'face 'bold))
(provide 'jira-fmt)
;;; jira-fmt.el ends here