2018-08-13 18:20:07 +02:00
|
|
|
;;; org-clubhouse.el --- Simple, unopinionated integration between org-mode and
|
|
|
|
;;; Clubhouse
|
2018-03-02 16:12:50 +01:00
|
|
|
|
|
|
|
;;; Copyright (C) 2018 Off Market Data, Inc. DBA Urbint
|
2018-03-02 16:44:48 +01:00
|
|
|
;;; Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
;;; of this software and associated documentation files (the "Software"), to
|
|
|
|
;;; deal in the Software without restriction, including without limitation the
|
|
|
|
;;; rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
|
|
;;; sell copies of the Software, and to permit persons to whom the Software is
|
|
|
|
;;; furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
;;; The above copyright notice and this permission notice shall be included in
|
|
|
|
;;; all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
;;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
;;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
;;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
;;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
;;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
|
|
;;; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
|
|
;;; IN THE SOFTWARE.
|
2018-03-02 16:12:50 +01:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
;;; org-clubhouse provides simple, unopinionated integration between Emacs's
|
|
|
|
;;; org-mode and the Clubhouse issue tracker
|
|
|
|
;;;
|
|
|
|
;;; To configure org-clubhouse, create an authorization token in Cluhbouse's
|
|
|
|
;;; settings, then place the following configuration somewhere private:
|
|
|
|
;;;
|
|
|
|
;;; (setq org-clubhouse-auth-token "<auth_token>"
|
|
|
|
;;; org-clubhouse-team-name "<team-name>")
|
|
|
|
;;;
|
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
2019-02-18 17:56:43 +01:00
|
|
|
(require 'cl-macs)
|
2018-03-02 16:12:50 +01:00
|
|
|
(require 'dash)
|
|
|
|
(require 'dash-functional)
|
|
|
|
(require 's)
|
|
|
|
(require 'org)
|
|
|
|
(require 'org-element)
|
|
|
|
(require 'subr-x)
|
|
|
|
(require 'json)
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; Configuration
|
|
|
|
;;;
|
|
|
|
|
|
|
|
(defvar org-clubhouse-auth-token nil
|
|
|
|
"Authorization token for the Clubhouse API")
|
|
|
|
|
|
|
|
(defvar org-clubhouse-team-name nil
|
|
|
|
"Team name to use in links to Clubhouse
|
|
|
|
ie https://app.clubhouse.io/<TEAM_NAME>/stories")
|
|
|
|
|
|
|
|
(defvar org-clubhouse-project-ids nil
|
|
|
|
"Specific list of project IDs to synchronize with clubhouse.
|
|
|
|
If unset all projects will be synchronized")
|
|
|
|
|
|
|
|
(defvar org-clubhouse-workflow-name "Default")
|
|
|
|
|
2018-06-10 07:05:36 +02:00
|
|
|
(defvar org-clubhouse-default-story-type nil
|
|
|
|
"Sets the default story type. If set to 'nil', it will interactively prompt
|
|
|
|
the user each and every time a new story is created. If set to 'feature',
|
|
|
|
'bug', or 'chore', that value will be used as the default and the user will
|
|
|
|
not be prompted")
|
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
(defvar org-clubhouse-state-alist
|
|
|
|
'(("LATER" . "Unscheduled")
|
|
|
|
("[ ]" . "Ready for Development")
|
|
|
|
("TODO" . "Ready for Development")
|
|
|
|
("OPEN" . "Ready for Development")
|
|
|
|
("ACTIVE" . "In Development")
|
|
|
|
("PR" . "Review")
|
|
|
|
("DONE" . "Merged")
|
|
|
|
("[X]" . "Merged")
|
2019-02-01 17:39:14 +01:00
|
|
|
("CLOSED" . "Merged"))
|
|
|
|
"Alist mapping org-mode todo keywords to their corresponding states in
|
|
|
|
Clubhouse. In `org-clubhouse-mode', moving headlines to these todo keywords
|
|
|
|
will update to the corresponding status in Clubhouse")
|
2018-03-02 16:12:50 +01:00
|
|
|
|
2018-03-26 23:47:03 +02:00
|
|
|
(defvar org-clubhouse-story-types
|
|
|
|
'(("feature" . "Feature")
|
|
|
|
("bug" . "Bug")
|
|
|
|
("chore" . "Chore")))
|
|
|
|
|
2018-06-10 07:05:36 +02:00
|
|
|
(defvar org-clubhouse-default-story-types
|
|
|
|
'(("feature" . "Feature")
|
|
|
|
("bug" . "Bug")
|
|
|
|
("chore" . "Chore")
|
|
|
|
("prompt" . "**Prompt each time (do not set a default story type)**")))
|
|
|
|
|
2019-02-01 17:39:14 +01:00
|
|
|
(defvar org-clubhouse-default-state "Proposed"
|
|
|
|
"Default state to create all new stories in")
|
2018-08-13 18:20:07 +02:00
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
;;;
|
|
|
|
;;; Utilities
|
|
|
|
;;;
|
|
|
|
|
|
|
|
(defmacro comment (&rest _)
|
|
|
|
"Comment out one or more s-expressions."
|
|
|
|
nil)
|
|
|
|
|
|
|
|
(defun ->list (vec) (append vec nil))
|
|
|
|
|
|
|
|
(defun reject-archived (item-list)
|
2018-03-12 20:00:22 +01:00
|
|
|
(-reject (lambda (item) (equal :json-true (alist-get 'archived item))) item-list))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
|
|
|
(defun alist->plist (key-map alist)
|
|
|
|
(->> key-map
|
|
|
|
(-map (lambda (key-pair)
|
|
|
|
(let ((alist-key (car key-pair))
|
|
|
|
(plist-key (cdr key-pair)))
|
|
|
|
(list plist-key (alist-get alist-key alist)))))
|
|
|
|
(-flatten-n 1)))
|
|
|
|
|
|
|
|
(defun alist-get-equal (key alist)
|
|
|
|
"Like `alist-get', but uses `equal' instead of `eq' for comparing keys"
|
|
|
|
(->> alist
|
|
|
|
(-find (lambda (pair) (equal key (car pair))))
|
|
|
|
(cdr)))
|
|
|
|
|
|
|
|
(comment
|
|
|
|
|
|
|
|
(alist->plist
|
|
|
|
'((foo . :foo)
|
|
|
|
(bar . :something))
|
|
|
|
|
|
|
|
'((foo . "foo") (bar . "bar") (ignored . "ignoreme!")))
|
|
|
|
;; => (:foo "foo" :something "bar")
|
|
|
|
|
|
|
|
)
|
|
|
|
|
2018-06-10 07:05:36 +02:00
|
|
|
(defun find-match-in-alist (target alist)
|
|
|
|
(->> alist
|
|
|
|
(-find (lambda (key-value)
|
|
|
|
(string-equal (cdr key-value) target)))
|
|
|
|
car))
|
2018-03-02 21:13:23 +01:00
|
|
|
|
|
|
|
(defun org-clubhouse-collect-headlines (beg end)
|
|
|
|
"Collects the headline at point or the headlines in a region. Returns a list."
|
|
|
|
(setq test-headlines
|
|
|
|
(if (and beg end)
|
2018-03-02 23:22:02 +01:00
|
|
|
(org-clubhouse-get-headlines-in-region beg end)
|
2018-03-02 21:13:23 +01:00
|
|
|
(list (org-element-find-headline)))))
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-clubhouse-get-headlines-in-region (beg end)
|
|
|
|
"Collects the headlines from BEG to END"
|
|
|
|
(save-excursion
|
|
|
|
;; This beg/end clean up pulled from `reverse-region`.
|
|
|
|
;; it expands the region to include the full lines from the selected region.
|
|
|
|
|
|
|
|
;; put beg at the start of a line and end and the end of one --
|
|
|
|
;; the largest possible region which fits this criteria
|
|
|
|
(goto-char beg)
|
|
|
|
(or (bolp) (forward-line 1))
|
|
|
|
(setq beg (point))
|
|
|
|
(goto-char end)
|
|
|
|
;; the test for bolp is for those times when end is on an empty line;
|
|
|
|
;; it is probably not the case that the line should be included in the
|
|
|
|
;; reversal; it isn't difficult to add it afterward.
|
|
|
|
(or (and (eolp) (not (bolp))) (progn (forward-line -1) (end-of-line)))
|
|
|
|
(setq end (point-marker))
|
|
|
|
|
|
|
|
;; move to the beginning
|
|
|
|
(goto-char beg)
|
|
|
|
;; walk by line until past end
|
|
|
|
(let ((headlines '())
|
|
|
|
(before-end 't))
|
|
|
|
(while before-end
|
|
|
|
(add-to-list 'headlines (org-element-find-headline))
|
|
|
|
(let ((before (point)))
|
|
|
|
(org-forward-heading-same-level 1)
|
|
|
|
(setq before-end (and (not (eq before (point))) (< (point) end)))))
|
|
|
|
headlines)))
|
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
;;;
|
|
|
|
;;; Org-element interaction
|
|
|
|
;;;
|
|
|
|
|
|
|
|
;; (defun org-element-find-headline ()
|
|
|
|
;; (let ((current-elt (org-element-at-point)))
|
|
|
|
;; (if (equal 'headline (car current-elt))
|
|
|
|
;; current-elt
|
|
|
|
;; (let* ((elt-attrs (cadr current-elt))
|
|
|
|
;; (parent (plist-get elt-attrs :post-affiliated)))
|
|
|
|
;; (goto-char parent)
|
|
|
|
;; (org-element-find-headline)))))
|
|
|
|
|
|
|
|
(defun org-element-find-headline ()
|
|
|
|
(let ((current-elt (org-element-at-point)))
|
|
|
|
(when (equal 'headline (car current-elt))
|
|
|
|
(cadr current-elt))))
|
|
|
|
|
|
|
|
(defun org-element-extract-clubhouse-id (elt)
|
2018-08-13 18:20:07 +02:00
|
|
|
(when-let* ((clubhouse-id-link (plist-get elt :CLUBHOUSE-ID)))
|
2018-03-02 16:12:50 +01:00
|
|
|
(cond
|
|
|
|
((string-match
|
|
|
|
(rx "[[" (one-or-more anything) "]"
|
|
|
|
"[" (group (one-or-more digit)) "]]")
|
|
|
|
clubhouse-id-link)
|
2018-06-10 07:05:36 +02:00
|
|
|
(string-to-number (match-string 1 clubhouse-id-link)))
|
2018-03-02 16:12:50 +01:00
|
|
|
((string-match-p
|
|
|
|
(rx buffer-start
|
|
|
|
(one-or-more digit)
|
|
|
|
buffer-end)
|
|
|
|
clubhouse-id-link)
|
2018-06-10 07:05:36 +02:00
|
|
|
(string-to-number clubhouse-id-link)))))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
|
|
|
(comment
|
|
|
|
(let ((strn "[[https://app.clubhouse.io/example/story/2330][2330]]"))
|
|
|
|
(string-match
|
|
|
|
(rx "[[" (one-or-more anything) "]"
|
|
|
|
"[" (group (one-or-more digit)) "]]")
|
|
|
|
strn)
|
2018-06-10 07:05:36 +02:00
|
|
|
(string-to-number (match-string 1 strn)))
|
2018-03-02 16:12:50 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
(defun org-element-clubhouse-id ()
|
|
|
|
(org-element-extract-clubhouse-id
|
|
|
|
(org-element-find-headline)))
|
|
|
|
|
2018-08-13 18:20:07 +02:00
|
|
|
(defun org-element-and-children-at-point ()
|
|
|
|
(let* ((elt (org-element-find-headline))
|
|
|
|
(contents-begin (plist-get elt :contents-begin))
|
|
|
|
(end (plist-get elt :end))
|
|
|
|
(level (plist-get elt :level))
|
|
|
|
(children '()))
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (+ contents-begin (length (plist-get elt :title))))
|
|
|
|
(while (<= (point) end)
|
|
|
|
(let* ((next-elt (org-element-at-point))
|
|
|
|
(elt-type (car next-elt))
|
|
|
|
(elt (cadr next-elt)))
|
|
|
|
(when (and (eql 'headline elt-type)
|
|
|
|
(eql (+ 1 level) (plist-get elt :level)))
|
|
|
|
(push elt children))
|
|
|
|
(goto-char (plist-get elt :end)))))
|
|
|
|
(append elt `(:children ,(reverse children)))))
|
|
|
|
|
2019-02-01 17:58:26 +01:00
|
|
|
(defun +org-element-contents (elt)
|
2019-02-15 22:12:33 +01:00
|
|
|
(if-let ((begin (plist-get (cadr elt) :contents-begin))
|
|
|
|
(end (plist-get (cadr elt) :contents-end)))
|
|
|
|
(buffer-substring-no-properties begin end)
|
|
|
|
""))
|
2019-02-01 17:58:26 +01:00
|
|
|
|
|
|
|
(defun org-clubhouse-find-description-drawer ()
|
|
|
|
"Try to find a DESCRIPTION drawer in the current element."
|
|
|
|
(let ((elt (org-element-at-point)))
|
|
|
|
(cl-case (car elt)
|
|
|
|
('drawer (+org-element-contents elt))
|
|
|
|
('headline
|
|
|
|
(when-let ((drawer-pos (string-match
|
|
|
|
":DESCRIPTION:"
|
|
|
|
(+org-element-contents elt))))
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (+ (plist-get (cadr elt) :contents-begin)
|
|
|
|
drawer-pos))
|
|
|
|
(org-clubhouse-find-description-drawer)))))))
|
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
;;;
|
|
|
|
;;; API integration
|
|
|
|
;;;
|
|
|
|
|
|
|
|
(defvar org-clubhouse-base-url* "https://api.clubhouse.io/api/v2")
|
|
|
|
|
2018-04-11 16:49:30 +02:00
|
|
|
(defun org-clubhouse-auth-url (url &optional params)
|
|
|
|
(concat url
|
|
|
|
"?"
|
|
|
|
(url-build-query-string
|
|
|
|
(cons `("token" ,org-clubhouse-auth-token) params))))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
|
|
|
(defun org-clubhouse-baseify-url (url)
|
2018-04-11 16:49:30 +02:00
|
|
|
(if (s-starts-with? org-clubhouse-base-url* url) url
|
|
|
|
(concat org-clubhouse-base-url*
|
|
|
|
(if (s-starts-with? "/" url) url
|
|
|
|
(concat "/" url)))))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
2018-04-11 16:49:30 +02:00
|
|
|
(cl-defun org-clubhouse-request (method url &key data (params '()))
|
|
|
|
(message "%s %s %s" method url (prin1-to-string data))
|
|
|
|
(let* ((url-request-method method)
|
|
|
|
(url-request-extra-headers
|
|
|
|
'(("Content-Type" . "application/json")))
|
|
|
|
(url-request-data data)
|
|
|
|
(buf))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
2018-04-11 16:49:30 +02:00
|
|
|
(setq url (-> url
|
|
|
|
org-clubhouse-baseify-url
|
|
|
|
(org-clubhouse-auth-url params)))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
2018-04-11 16:49:30 +02:00
|
|
|
(setq buf (url-retrieve-synchronously url))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
2018-04-11 16:49:30 +02:00
|
|
|
(with-current-buffer buf
|
|
|
|
(goto-char url-http-end-of-headers)
|
|
|
|
(prog1 (json-read) (kill-buffer)))))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
|
|
|
(cl-defun to-id-name-pairs
|
|
|
|
(seq &optional (id-attr 'id) (name-attr 'name))
|
|
|
|
(->> seq
|
|
|
|
->list
|
|
|
|
(-map (lambda (resource)
|
|
|
|
(cons (alist-get id-attr resource)
|
|
|
|
(alist-get name-attr resource))))))
|
|
|
|
|
|
|
|
(cl-defun org-clubhouse-fetch-as-id-name-pairs
|
|
|
|
(resource &optional
|
|
|
|
(id-attr 'id)
|
|
|
|
(name-attr 'name))
|
|
|
|
"Returns the given resource from clubhouse as (id . name) pairs"
|
|
|
|
(let ((resp-json (org-clubhouse-request "GET" resource)))
|
|
|
|
(-> resp-json
|
|
|
|
->list
|
|
|
|
reject-archived
|
|
|
|
(to-id-name-pairs id-attr name-attr))))
|
|
|
|
|
2018-08-13 18:20:07 +02:00
|
|
|
(defun org-clubhouse-get-story
|
|
|
|
(clubhouse-id)
|
|
|
|
(org-clubhouse-request "GET" (format "/stories/%s" clubhouse-id)))
|
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
(defun org-clubhouse-link-to-story (story-id)
|
|
|
|
(format "https://app.clubhouse.io/%s/story/%d"
|
|
|
|
org-clubhouse-team-name
|
|
|
|
story-id))
|
|
|
|
|
|
|
|
(defun org-clubhouse-link-to-epic (epic-id)
|
|
|
|
(format "https://app.clubhouse.io/%s/epic/%d"
|
|
|
|
org-clubhouse-team-name
|
|
|
|
epic-id))
|
|
|
|
|
2018-03-12 20:00:22 +01:00
|
|
|
(defun org-clubhouse-link-to-milestone (milestone-id)
|
|
|
|
(format "https://app.clubhouse.io/%s/milestone/%d"
|
|
|
|
org-clubhouse-team-name
|
|
|
|
milestone-id))
|
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
(defun org-clubhouse-link-to-project (project-id)
|
|
|
|
(format "https://app.clubhouse.io/%s/project/%d"
|
|
|
|
org-clubhouse-team-name
|
|
|
|
project-id))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; Caching
|
|
|
|
;;;
|
|
|
|
|
|
|
|
(comment
|
|
|
|
(defcache org-clubhouse-projects
|
|
|
|
(org-sync-clubhouse-fetch-as-id-name-pairs "projectx"))
|
|
|
|
|
|
|
|
(clear-org-clubhouse-projects-cache)
|
|
|
|
(clear-org-clubhouse-cache)
|
|
|
|
)
|
|
|
|
|
|
|
|
(defvar org-clubhouse-cache-clear-functions ())
|
|
|
|
|
|
|
|
(defmacro defcache (name &optional docstring &rest body)
|
|
|
|
(let* ((doc (when docstring (list docstring)))
|
|
|
|
(cache-var-name (intern (concat (symbol-name name)
|
|
|
|
"-cache")))
|
|
|
|
(clear-cache-function-name
|
|
|
|
(intern (concat "clear-" (symbol-name cache-var-name)))))
|
|
|
|
`(progn
|
|
|
|
(defvar ,cache-var-name :no-cache)
|
|
|
|
(defun ,name ()
|
|
|
|
,@doc
|
|
|
|
(when (equal :no-cache ,cache-var-name)
|
|
|
|
(setq ,cache-var-name (progn ,@body)))
|
|
|
|
,cache-var-name)
|
|
|
|
(defun ,clear-cache-function-name ()
|
|
|
|
(interactive)
|
|
|
|
(setq ,cache-var-name :no-cache))
|
|
|
|
|
|
|
|
(push (quote ,clear-cache-function-name)
|
|
|
|
org-clubhouse-cache-clear-functions))))
|
|
|
|
|
|
|
|
(defun org-clubhouse-clear-cache ()
|
|
|
|
(interactive)
|
|
|
|
(-map #'funcall org-clubhouse-cache-clear-functions))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; API resource functions
|
|
|
|
;;;
|
|
|
|
|
|
|
|
(defcache org-clubhouse-projects
|
|
|
|
"Returns projects as (project-id . name)"
|
|
|
|
(org-clubhouse-fetch-as-id-name-pairs "projects"))
|
|
|
|
|
|
|
|
(defcache org-clubhouse-epics
|
|
|
|
"Returns projects as (project-id . name)"
|
|
|
|
(org-clubhouse-fetch-as-id-name-pairs "epics"))
|
|
|
|
|
2018-03-12 20:00:22 +01:00
|
|
|
(defcache org-clubhouse-milestones
|
|
|
|
"Returns milestone-id . name)"
|
|
|
|
(org-clubhouse-fetch-as-id-name-pairs "milestones"))
|
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
(defcache org-clubhouse-workflow-states
|
|
|
|
"Returns worflow states as (name . id) pairs"
|
|
|
|
(let* ((resp-json (org-clubhouse-request "GET" "workflows"))
|
|
|
|
(workflows (->list resp-json))
|
|
|
|
;; just assume it exists, for now
|
|
|
|
(workflow (-find (lambda (workflow)
|
|
|
|
(equal org-clubhouse-workflow-name
|
|
|
|
(alist-get 'name workflow)))
|
|
|
|
workflows))
|
|
|
|
(states (->list (alist-get 'states workflow))))
|
|
|
|
(to-id-name-pairs states
|
|
|
|
'name
|
|
|
|
'id)))
|
|
|
|
|
|
|
|
(defun org-clubhouse-stories-in-project (project-id)
|
2019-02-18 17:56:43 +01:00
|
|
|
"Return the stories in the given PROJECT-ID as org headlines."
|
2018-03-02 16:12:50 +01:00
|
|
|
(let ((resp-json (org-clubhouse-request "GET" (format "/projects/%d/stories" project-id))))
|
|
|
|
(->> resp-json ->list reject-archived
|
|
|
|
(-reject (lambda (story) (equal :json-true (alist-get 'completed story))))
|
|
|
|
(-map (lambda (story)
|
|
|
|
(cons
|
|
|
|
(cons 'status
|
|
|
|
(cond
|
|
|
|
((equal :json-true (alist-get 'started story))
|
|
|
|
'started)
|
|
|
|
((equal :json-true (alist-get 'completed story))
|
|
|
|
'completed)
|
|
|
|
('t
|
|
|
|
'open)))
|
|
|
|
story)))
|
|
|
|
(-map (-partial #'alist->plist
|
|
|
|
'((name . :title)
|
|
|
|
(id . :id)
|
|
|
|
(status . :status)))))))
|
|
|
|
|
|
|
|
;;;
|
2018-03-12 20:00:22 +01:00
|
|
|
;;; Prompting
|
2018-03-02 16:12:50 +01:00
|
|
|
;;;
|
|
|
|
|
|
|
|
(defun org-clubhouse-prompt-for-project (cb)
|
|
|
|
(ivy-read
|
|
|
|
"Select a project: "
|
|
|
|
(-map #'cdr (org-clubhouse-projects))
|
|
|
|
:require-match t
|
|
|
|
:history 'org-clubhouse-project-history
|
|
|
|
:action (lambda (selected)
|
|
|
|
(let ((project-id
|
2018-06-10 07:05:36 +02:00
|
|
|
(find-match-in-alist selected (org-clubhouse-projects))))
|
2018-03-02 16:12:50 +01:00
|
|
|
(funcall cb project-id)))))
|
|
|
|
|
|
|
|
(defun org-clubhouse-prompt-for-epic (cb)
|
|
|
|
(ivy-read
|
|
|
|
"Select an epic: "
|
|
|
|
(-map #'cdr (org-clubhouse-epics))
|
|
|
|
:history 'org-clubhouse-epic-history
|
|
|
|
:action (lambda (selected)
|
|
|
|
(let ((epic-id
|
2018-06-10 07:05:36 +02:00
|
|
|
(find-match-in-alist selected (org-clubhouse-epics))))
|
2018-03-02 16:12:50 +01:00
|
|
|
(funcall cb epic-id)))))
|
|
|
|
|
2018-03-12 20:00:22 +01:00
|
|
|
(defun org-clubhouse-prompt-for-milestone (cb)
|
|
|
|
(ivy-read
|
|
|
|
"Select a milestone: "
|
|
|
|
(-map #'cdr (org-clubhouse-milestones))
|
|
|
|
:require-match t
|
|
|
|
:history 'org-clubhouse-milestone-history
|
|
|
|
:action (lambda (selected)
|
|
|
|
(let ((milestone-id
|
2018-06-10 07:05:36 +02:00
|
|
|
(find-match-in-alist selected (org-clubhouse-milestones))))
|
2018-03-12 20:00:22 +01:00
|
|
|
(funcall cb milestone-id)))))
|
|
|
|
|
2018-03-26 23:47:03 +02:00
|
|
|
(defun org-clubhouse-prompt-for-story-type (cb)
|
|
|
|
(ivy-read
|
|
|
|
"Select a story type: "
|
|
|
|
(-map #'cdr org-clubhouse-story-types)
|
|
|
|
:history 'org-clubhouse-story-history
|
|
|
|
:action (lambda (selected)
|
|
|
|
(let ((story-type
|
2018-06-10 07:05:36 +02:00
|
|
|
(find-match-in-alist selected org-clubhouse-story-types)))
|
2018-03-26 23:47:03 +02:00
|
|
|
(funcall cb story-type)))))
|
|
|
|
|
2018-06-10 07:05:36 +02:00
|
|
|
(defun org-clubhouse-prompt-for-default-story-type ()
|
|
|
|
(interactive)
|
|
|
|
(ivy-read
|
|
|
|
"Select a default story type: "
|
|
|
|
(-map #'cdr org-clubhouse-default-story-types)
|
|
|
|
:history 'org-clubhouse-default-story-history
|
|
|
|
:action (lambda (selected)
|
|
|
|
(let ((story-type
|
|
|
|
(find-match-in-alist selected org-clubhouse-default-story-types)))
|
|
|
|
(if (string-equal story-type "prompt")
|
|
|
|
(setq org-clubhouse-default-story-type nil)
|
|
|
|
(setq org-clubhouse-default-story-type story-type))))))
|
|
|
|
|
2018-03-12 20:00:22 +01:00
|
|
|
;;;
|
|
|
|
;;; Epic creation
|
|
|
|
;;;
|
|
|
|
|
|
|
|
(cl-defun org-clubhouse-create-epic-internal
|
|
|
|
(title &key milestone-id)
|
2019-02-18 17:56:43 +01:00
|
|
|
(cl-assert (and (stringp title)
|
2018-03-12 20:00:22 +01:00
|
|
|
(integerp milestone-id)))
|
|
|
|
(org-clubhouse-request
|
|
|
|
"POST"
|
|
|
|
"epics"
|
2018-04-11 16:49:30 +02:00
|
|
|
:data
|
2018-03-12 20:00:22 +01:00
|
|
|
(json-encode
|
|
|
|
`((name . ,title)
|
|
|
|
(milestone_id . ,milestone-id)))))
|
|
|
|
|
|
|
|
(defun org-clubhouse-populate-created-epic (elt epic)
|
|
|
|
(let ((elt-start (plist-get elt :begin))
|
|
|
|
(epic-id (alist-get 'id epic))
|
|
|
|
(milestone-id (alist-get 'milestone_id epic)))
|
|
|
|
|
|
|
|
(save-excursion
|
|
|
|
(goto-char elt-start)
|
|
|
|
|
|
|
|
(org-set-property "clubhouse-epic-id"
|
|
|
|
(org-make-link-string
|
|
|
|
(org-clubhouse-link-to-epic epic-id)
|
|
|
|
(number-to-string epic-id)))
|
|
|
|
|
|
|
|
(org-set-property "clubhouse-milestone"
|
|
|
|
(org-make-link-string
|
|
|
|
(org-clubhouse-link-to-milestone milestone-id)
|
|
|
|
(alist-get milestone-id (org-clubhouse-milestones)))))))
|
|
|
|
|
|
|
|
(defun org-clubhouse-create-epic (&optional beg end)
|
|
|
|
"Creates a clubhouse epic using selected headlines.
|
|
|
|
Will pull the title from the headline at point, or create epics for all the
|
|
|
|
headlines in the selected region.
|
|
|
|
|
|
|
|
All epics are added to the same milestone, as selected via a prompt.
|
|
|
|
If the epics already have a CLUBHOUSE-EPIC-ID, they are filtered and ignored."
|
|
|
|
(interactive
|
|
|
|
(when (use-region-p)
|
|
|
|
(list (region-beginning region-end))))
|
|
|
|
|
|
|
|
(let* ((elts (org-clubhouse-collect-headlines beg end))
|
|
|
|
(elts (-remove (lambda (elt) (plist-get elt :CLUBHOUSE-EPIC-ID)) elts)))
|
|
|
|
(org-clubhouse-prompt-for-milestone
|
|
|
|
(lambda (milestone-id)
|
|
|
|
(when milestone-id
|
|
|
|
(dolist (elt elts)
|
|
|
|
(let* ((title (plist-get elt :title))
|
|
|
|
(epic (org-clubhouse-create-epic-internal
|
|
|
|
title
|
|
|
|
:milestone-id milestone-id)))
|
|
|
|
(org-clubhouse-populate-created-epic elt epic))
|
|
|
|
elts))))))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; Story creation
|
|
|
|
;;;
|
|
|
|
|
2018-08-13 18:20:07 +02:00
|
|
|
(defun org-clubhouse-default-state-id ()
|
|
|
|
(alist-get-equal org-clubhouse-default-state (org-clubhouse-workflow-states)))
|
|
|
|
|
2018-03-12 20:00:22 +01:00
|
|
|
(cl-defun org-clubhouse-create-story-internal
|
2019-02-15 22:12:33 +01:00
|
|
|
(title &key project-id epic-id story-type description)
|
2019-02-18 17:56:43 +01:00
|
|
|
(cl-assert (and (stringp title)
|
2018-03-12 20:00:22 +01:00
|
|
|
(integerp project-id)
|
2019-02-15 22:12:33 +01:00
|
|
|
(or (null epic-id) (integerp epic-id))
|
|
|
|
(or (null description) (stringp description))))
|
2018-08-13 18:20:07 +02:00
|
|
|
(let ((workflow-state-id (org-clubhouse-default-state-id))
|
|
|
|
(params `((name . ,title)
|
|
|
|
(project_id . ,project-id)
|
|
|
|
(epic_id . ,epic-id)
|
2019-02-15 22:12:33 +01:00
|
|
|
(story_type . ,story-type)
|
2019-02-18 18:06:28 +01:00
|
|
|
(description . ,(or description "")))))
|
2018-08-13 18:20:07 +02:00
|
|
|
|
|
|
|
(when workflow-state-id
|
|
|
|
(push `(workflow_state_id . ,workflow-state-id) params))
|
|
|
|
|
|
|
|
(org-clubhouse-request
|
|
|
|
"POST"
|
|
|
|
"stories"
|
|
|
|
:data
|
|
|
|
(json-encode params))))
|
2018-03-12 20:00:22 +01:00
|
|
|
|
2018-03-02 21:13:23 +01:00
|
|
|
(defun org-clubhouse-populate-created-story (elt story)
|
|
|
|
(let ((elt-start (plist-get elt :begin))
|
2018-03-02 16:12:50 +01:00
|
|
|
(story-id (alist-get 'id story))
|
|
|
|
(epic-id (alist-get 'epic_id story))
|
2018-03-26 23:47:03 +02:00
|
|
|
(project-id (alist-get 'project_id story))
|
|
|
|
(story-type (alist-get 'story_type story)))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
2018-03-02 21:13:23 +01:00
|
|
|
(save-excursion
|
|
|
|
(goto-char elt-start)
|
|
|
|
|
|
|
|
(org-set-property "clubhouse-id"
|
|
|
|
(org-make-link-string
|
|
|
|
(org-clubhouse-link-to-story story-id)
|
|
|
|
(number-to-string story-id)))
|
|
|
|
|
|
|
|
(org-set-property "clubhouse-epic"
|
|
|
|
(org-make-link-string
|
|
|
|
(org-clubhouse-link-to-epic epic-id)
|
|
|
|
(alist-get epic-id (org-clubhouse-epics))))
|
|
|
|
|
|
|
|
(org-set-property "clubhouse-project"
|
|
|
|
(org-make-link-string
|
|
|
|
(org-clubhouse-link-to-project project-id)
|
|
|
|
(alist-get project-id (org-clubhouse-projects))))
|
|
|
|
|
2018-03-26 23:47:03 +02:00
|
|
|
(org-set-property "story-type"
|
|
|
|
(alist-get-equal story-type org-clubhouse-story-types))
|
|
|
|
|
2018-03-02 21:13:23 +01:00
|
|
|
(org-todo "TODO"))))
|
|
|
|
|
2018-08-13 18:20:07 +02:00
|
|
|
(defun org-clubhouse-create-story (&optional beg end &key then)
|
2018-03-02 21:13:23 +01:00
|
|
|
"Creates a clubhouse story using selected headlines.
|
|
|
|
|
|
|
|
Will pull the title from the headline at point,
|
|
|
|
or create cards for all the headlines in the selected region.
|
|
|
|
|
|
|
|
All stories are added to the same project and epic, as selected via two prompts.
|
|
|
|
If the stories already have a CLUBHOUSE-ID, they are filtered and ignored."
|
|
|
|
(interactive
|
2018-08-13 18:20:07 +02:00
|
|
|
(when (use-region-p)
|
|
|
|
(list (region-beginning) (region-end))))
|
2018-03-02 21:13:23 +01:00
|
|
|
|
|
|
|
(let* ((elts (org-clubhouse-collect-headlines beg end))
|
|
|
|
(new-elts (-remove (lambda (elt) (plist-get elt :CLUBHOUSE-ID)) elts)))
|
|
|
|
(org-clubhouse-prompt-for-project
|
|
|
|
(lambda (project-id)
|
|
|
|
(when project-id
|
|
|
|
(org-clubhouse-prompt-for-epic
|
2018-08-13 18:20:07 +02:00
|
|
|
(lambda (epic-id)
|
2019-02-01 17:25:39 +01:00
|
|
|
(let ((create-story
|
2018-08-13 18:20:07 +02:00
|
|
|
(lambda (story-type)
|
2019-02-15 22:12:33 +01:00
|
|
|
(-map
|
|
|
|
(lambda (elt)
|
|
|
|
(let* ((title (plist-get elt :title))
|
2019-02-18 18:06:28 +01:00
|
|
|
(description
|
|
|
|
(save-mark-and-excursion
|
|
|
|
(goto-char (plist-get elt :begin))
|
|
|
|
(org-clubhouse-find-description-drawer)))
|
2019-02-15 22:12:33 +01:00
|
|
|
(story (org-clubhouse-create-story-internal
|
|
|
|
title
|
|
|
|
:project-id project-id
|
|
|
|
:epic-id epic-id
|
2019-02-18 18:06:28 +01:00
|
|
|
:story-type story-type
|
|
|
|
:description description)))
|
2019-02-15 22:12:33 +01:00
|
|
|
(org-clubhouse-populate-created-story elt story)
|
|
|
|
(when (functionp then)
|
|
|
|
(funcall then story))))
|
|
|
|
new-elts))))
|
2019-02-01 17:25:39 +01:00
|
|
|
(if org-clubhouse-default-story-type
|
|
|
|
(funcall create-story org-clubhouse-default-story-type)
|
|
|
|
(org-clubhouse-prompt-for-story-type create-story))))))))))
|
2018-08-13 18:20:07 +02:00
|
|
|
|
|
|
|
(defun org-clubhouse-create-story-with-task-list (&optional beg end)
|
|
|
|
"Creates a clubhouse story using the selected headline, making all direct
|
|
|
|
children of that headline into tasks in the task list of the story."
|
|
|
|
(interactive
|
|
|
|
(when (use-region-p)
|
|
|
|
(list (region-beginning) (region-end))))
|
|
|
|
|
|
|
|
(let* ((elt (org-element-and-children-at-point)))
|
|
|
|
(org-clubhouse-create-story nil nil
|
|
|
|
:then (lambda (story)
|
|
|
|
(pp story)
|
|
|
|
(org-clubhouse-push-task-list
|
|
|
|
(alist-get 'id story)
|
|
|
|
(plist-get elt :children))))))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; Task creation
|
|
|
|
;;;
|
|
|
|
|
|
|
|
(cl-defun org-clubhouse-create-task (title &key story-id)
|
2019-02-18 17:56:43 +01:00
|
|
|
(cl-assert (and (stringp title)
|
2018-08-13 18:20:07 +02:00
|
|
|
(integerp story-id)))
|
|
|
|
(org-clubhouse-request
|
|
|
|
"POST"
|
|
|
|
(format "/stories/%d/tasks" story-id)
|
|
|
|
:data (json-encode `((description . ,title)))))
|
|
|
|
|
|
|
|
(defun org-clubhouse-push-task-list (&optional parent-clubhouse-id child-elts)
|
|
|
|
"Writes each child element of the current clubhouse element as a task list
|
|
|
|
item of the associated clubhouse ID.
|
|
|
|
|
|
|
|
when called as (org-clubhouse-push-task-list PARENT-CLUBHOUSE-ID CHILD-ELTS),
|
|
|
|
allows manually passing a clubhouse ID and list of org-element plists to write"
|
|
|
|
(interactive)
|
|
|
|
(let* ((elt (org-element-and-children-at-point))
|
|
|
|
(parent-clubhouse-id (or parent-clubhouse-id
|
|
|
|
(org-element-extract-clubhouse-id elt)))
|
|
|
|
(child-elts (or child-elts (plist-get elt :children)))
|
|
|
|
;; (story (org-clubhouse-get-story parent-clubhouse-id))
|
|
|
|
;; (existing-tasks (alist-get 'tasks story))
|
|
|
|
;; (task-exists
|
|
|
|
;; (lambda (task-name)
|
|
|
|
;; (some (lambda (task)
|
|
|
|
;; (string-equal task-name (alist-get 'description task)))
|
|
|
|
;; (existing-tasks))))
|
|
|
|
)
|
|
|
|
(dolist (child-elt child-elts)
|
|
|
|
(let ((task-name (plist-get child-elt :title)))
|
|
|
|
;; (unless (task-exists task-name)
|
|
|
|
(let ((task (org-clubhouse-create-task
|
|
|
|
task-name
|
|
|
|
:story-id parent-clubhouse-id)))
|
|
|
|
;; TODO this doesn't currently work, since the act of populating the
|
|
|
|
;; previous task bumps up the char start of the next task
|
|
|
|
;; (org-clubhouse-populate-created-task child-elt task)
|
|
|
|
)
|
|
|
|
;; )
|
|
|
|
))))
|
|
|
|
|
|
|
|
(defun org-clubhouse-populate-created-task (elt task)
|
|
|
|
(let ((elt-start (plist-get elt :begin))
|
|
|
|
(task-id (alist-get 'id task))
|
|
|
|
(story-id (alist-get 'story_id task)))
|
|
|
|
|
|
|
|
(save-excursion
|
|
|
|
(goto-char elt-start)
|
|
|
|
|
|
|
|
(org-set-property "clubhouse-task-id" (format "%d" task-id))
|
|
|
|
|
|
|
|
(org-set-property "clubhouse-story-id"
|
|
|
|
(org-make-link-string
|
|
|
|
(org-clubhouse-link-to-story story-id)
|
|
|
|
(number-to-string story-id)))
|
|
|
|
|
|
|
|
(org-todo "TODO"))))
|
2018-03-02 16:12:50 +01:00
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; Story updates
|
|
|
|
;;;
|
|
|
|
|
2018-03-27 04:25:30 +02:00
|
|
|
(defun org-clubhouse-update-story-title ()
|
2019-02-01 17:58:26 +01:00
|
|
|
"Update the title of the Clubhouse story linked to the current headline.
|
|
|
|
|
|
|
|
Update the title of the story linked to the current headline with the text of
|
|
|
|
the headline."
|
2018-03-27 04:25:30 +02:00
|
|
|
(interactive)
|
|
|
|
|
|
|
|
(when-let (clubhouse-id (org-element-clubhouse-id))
|
|
|
|
(let* ((elt (org-element-find-headline))
|
|
|
|
(title (plist-get elt :title)))
|
|
|
|
(org-clubhouse-update-story-internal
|
|
|
|
clubhouse-id
|
|
|
|
:name title)
|
|
|
|
(message "Successfully updated story title to \"%s\""
|
|
|
|
title))))
|
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
(cl-defun org-clubhouse-update-story-internal
|
|
|
|
(story-id &rest attrs)
|
2019-02-18 17:56:43 +01:00
|
|
|
(cl-assert (and (integerp story-id)
|
2018-03-02 16:12:50 +01:00
|
|
|
(listp attrs)))
|
|
|
|
(org-clubhouse-request
|
|
|
|
"PUT"
|
|
|
|
(format "stories/%d" story-id)
|
2018-04-11 16:49:30 +02:00
|
|
|
:data
|
2018-03-02 16:12:50 +01:00
|
|
|
(json-encode attrs)))
|
|
|
|
|
|
|
|
(defun org-clubhouse-update-status ()
|
2019-02-01 17:58:26 +01:00
|
|
|
"Update the status of the Clubhouse story linked to the current element.
|
|
|
|
|
|
|
|
Update the status of the Clubhouse story linked to the current element with the
|
|
|
|
entry in `org-clubhouse-state-alist' corresponding to the todo-keyword of the
|
|
|
|
element."
|
2018-04-11 16:49:30 +02:00
|
|
|
(interactive)
|
|
|
|
(when-let* ((clubhouse-id (org-element-clubhouse-id)))
|
2018-03-02 16:12:50 +01:00
|
|
|
(let* ((elt (org-element-find-headline))
|
|
|
|
(todo-keyword (-> elt (plist-get :todo-keyword) (substring-no-properties))))
|
2018-04-11 16:49:30 +02:00
|
|
|
(when-let* ((clubhouse-workflow-state
|
2018-03-02 16:12:50 +01:00
|
|
|
(alist-get-equal todo-keyword org-clubhouse-state-alist))
|
|
|
|
(workflow-state-id
|
|
|
|
(alist-get-equal clubhouse-workflow-state (org-clubhouse-workflow-states))))
|
|
|
|
(org-clubhouse-update-story-internal
|
|
|
|
clubhouse-id
|
|
|
|
:workflow_state_id workflow-state-id)
|
|
|
|
(message "Successfully updated clubhouse status to \"%s\""
|
|
|
|
clubhouse-workflow-state)))))
|
|
|
|
|
2019-02-01 17:58:26 +01:00
|
|
|
(defun org-clubhouse-update-description ()
|
|
|
|
"Update the description of the Clubhouse story linked to the current element.
|
|
|
|
|
|
|
|
Update the status of the Clubhouse story linked to the current element with the
|
|
|
|
contents of a drawer inside the element called DESCRIPTION, if any."
|
|
|
|
(interactive)
|
|
|
|
(when-let* ((clubhouse-id (org-element-clubhouse-id))
|
|
|
|
(new-description (org-clubhouse-find-description-drawer)))
|
|
|
|
(org-clubhouse-update-story-internal
|
|
|
|
clubhouse-id
|
|
|
|
:description new-description)
|
|
|
|
(message "Successfully updated story description")))
|
2018-09-26 17:41:33 +02:00
|
|
|
|
|
|
|
(defun org-clubhouse-headlines-from-query (level query)
|
|
|
|
"Create `org-mode' headlines from a clubhouse query.
|
|
|
|
|
|
|
|
Submits QUERY to clubhouse, and creates `org-mode' headlines from all the
|
|
|
|
resulting stories at headline level LEVEL."
|
|
|
|
(interactive
|
|
|
|
"*nLevel: \nMQuery: ")
|
|
|
|
(let* ((sprint-stories
|
|
|
|
(org-clubhouse-request
|
|
|
|
"GET"
|
|
|
|
"search/stories"
|
2019-02-01 17:22:31 +01:00
|
|
|
:params `((query ,query))))
|
|
|
|
(sprint-story-list (-> sprint-stories cdr car cdr (append nil)
|
|
|
|
reject-archived)))
|
|
|
|
(if (null sprint-story-list)
|
|
|
|
(message "Query returned no stories: %s" query)
|
|
|
|
(save-mark-and-excursion
|
|
|
|
(insert
|
|
|
|
(mapconcat (lambda (story)
|
|
|
|
(format
|
|
|
|
"%s TODO %s
|
2018-09-26 17:41:33 +02:00
|
|
|
:PROPERTIES:
|
|
|
|
:clubhouse-id: %s
|
|
|
|
:END:
|
2019-02-01 17:22:31 +01:00
|
|
|
:DESCRIPTION:
|
|
|
|
%s
|
|
|
|
:END:
|
2018-09-26 17:41:33 +02:00
|
|
|
"
|
2019-02-01 17:22:31 +01:00
|
|
|
(make-string level ?*)
|
|
|
|
(alist-get 'name story)
|
|
|
|
(let ((story-id (alist-get 'id story)))
|
|
|
|
(org-make-link-string
|
|
|
|
(org-clubhouse-link-to-story story-id)
|
|
|
|
(number-to-string story-id)))
|
|
|
|
(alist-get 'description story)))
|
|
|
|
(reject-archived sprint-story-list) "\n"))))))
|
2018-09-26 17:41:33 +02:00
|
|
|
|
2018-03-02 16:12:50 +01:00
|
|
|
(define-minor-mode org-clubhouse-mode
|
2019-02-15 22:13:12 +01:00
|
|
|
"If enabled, updates to the todo keywords on org headlines will update the
|
|
|
|
linked ticket in Clubhouse."
|
2018-03-02 16:12:50 +01:00
|
|
|
:group 'org
|
|
|
|
:lighter "Org-Clubhouse"
|
|
|
|
:keymap '()
|
|
|
|
(add-hook 'org-after-todo-state-change-hook
|
|
|
|
'org-clubhouse-update-status
|
|
|
|
nil
|
|
|
|
t))
|
|
|
|
|
|
|
|
|
|
|
|
(provide 'org-clubhouse)
|
|
|
|
;;; org-clubhouse.el ends here
|