-
Notifications
You must be signed in to change notification settings - Fork 13
/
org-shortcut.el
1293 lines (1118 loc) · 45.8 KB
/
org-shortcut.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
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; org-shortcut.el --- Simple, unopinionated integration between org-mode and
;;; Shortcut
;;; Copyright (C) 2018 Off Market Data, Inc. DBA Urbint
;;; 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.
;;; Package-Requires: ((emacs "26.1") dash s ivy json (org "9.3"))
;;; Package-Version: 0.0.1
;;; URL: https://github.com/glitterlshark/org-shortcut
;;; Commentary:
;;; org-shortcut provides simple, unopinionated integration between Emacs's
;;; org-mode and the Shortcut issue tracker
;;;
;;; To configure org-shortcut, create an authorization token in Cluhbouse's
;;; settings, then place the following configuration somewhere private:
;;;
;;; (setq org-shortcut-auth-token "<auth_token>"
;;; org-shortcut-team-name "<team-name>")
;;;
;;; Code:
(require 'cl-lib)
(require 'dash)
(require 's)
(require 'org)
(require 'org-element)
(require 'subr-x)
(require 'ivy)
(require 'json)
;;;
;;; Configuration
;;;
(defvar org-shortcut-auth-token nil
"Authorization token for the Shortcut API.")
(defvar org-shortcut-username nil
"Username for the current Shortcut user.
Unfortunately, the Shortcut API doesn't seem to provide this via the API given
an API token, so we need to configure this for
`org-shortcut-claim-story-on-status-updates' to work")
(defvar org-shortcut-team-name nil
"Team name to use in links to Shortcut.
ie https://app.shortcut.com/<TEAM_NAME>/stories")
(defvar org-shortcut-project-ids nil
"Specific list of project IDs to synchronize with shortcut.
If unset all projects will be synchronized")
(defvar org-shortcut-workflow-name "Default")
(defvar org-shortcut-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")
(defvar org-shortcut-state-alist
'(("LATER" . "Unscheduled")
("[ ]" . "Ready for Development")
("TODO" . "Ready for Development")
("OPEN" . "Ready for Development")
("ACTIVE" . "In Development")
("PR" . "Review")
("DONE" . "Merged")
("[X]" . "Merged")
("CLOSED" . "Merged"))
"Alist mapping org-mode todo keywords to their corresponding states in
Shortcut. In `org-shortcut-mode', moving headlines to these todo keywords
will update to the corresponding status in Shortcut")
(defvar org-shortcut-story-types
'(("feature" . "Feature")
("bug" . "Bug")
("chore" . "Chore")))
(defvar org-shortcut-default-story-types
'(("feature" . "Feature")
("bug" . "Bug")
("chore" . "Chore")
("prompt" . "**Prompt each time (do not set a default story type)**")))
(defvar org-shortcut-default-state "Proposed"
"Default state to create all new stories in.")
(defvar org-shortcut-claim-story-on-status-update 't
"Controls the assignee behavior of stories on status update.
If set to 't, will mark the current user as the owner of any shortcut
stories on any update to the status.
If set to nil, will never automatically update the assignee of shortcut
stories.
If set to a list of todo-state's, will mark the current user as the owner of
shortcut stories whenever updating the status to one of those todo states.")
(defvar org-shortcut-create-stories-with-labels nil
"Controls the way org-shortcut creates stories with labels based on org tags.
If set to 't, will create labels for all org tags on headlines when stories are
created.
If set to 'existing, will set labels on created stories only if the label
already exists in shortcut
If set to nil, will never create stories with labels")
;;;
;;; Utilities
;;;
(defmacro comment (&rest _)
"Comment out one or more s-expressions."
nil)
(defun ->list (vec) (append vec nil))
(defun reject-archived (item-list)
(-reject (lambda (item) (equal :json-true (alist-get 'archived item))) item-list))
(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)))
(defun invert-alist (alist)
"Invert the keys and values of ALIST."
(-map (lambda (cell) (cons (cdr cell) (car cell))) alist))
(comment
(alist->plist
'((foo . :foo)
(bar . :something))
'((foo . "foo") (bar . "bar") (ignored . "ignoreme!")))
;; => (:foo "foo" :something "bar")
)
(defun find-match-in-alist (target alist)
(->> alist
(-find (lambda (key-value)
(string-equal (cdr key-value) target)))
car))
(defun org-shortcut-collect-headlines (beg end)
"Collects the headline at point or the headlines in a region. Returns a list."
(if (and beg end)
(org-shortcut-get-headlines-in-region beg end)
(list (org-element-find-headline))))
(defun org-shortcut-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)))))
(reverse headlines))))
;;;
;;; 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 ()
(save-mark-and-excursion
(when (not (outline-on-heading-p)) (org-back-to-heading))
(let ((current-elt (org-element-at-point)))
(when (equal 'headline (car current-elt))
(cadr current-elt)))))
(defun org-element-extract-shortcut-id (elt &optional property)
(when-let* ((shortcut-id-link (plist-get elt (or property :SHORTCUT-ID))))
(cond
((string-match
(rx "[[" (one-or-more anything) "]"
"[" (group (one-or-more digit)) "]]")
shortcut-id-link)
(string-to-number (match-string 1 shortcut-id-link)))
((string-match
(rx "[[https://app.shortcut.com/"
(one-or-more anything)
"/story/" (group (one-or-more digit)))
shortcut-id-link)
(string-to-number (match-string 1 shortcut-id-link)))
((string-match-p
(rx buffer-start
(one-or-more digit)
buffer-end)
shortcut-id-link)
(string-to-number shortcut-id-link)))))
(comment
(let ((strn "[[https://app.shortcut.com/example/story/2330][2330]]"))
(string-match
(rx "[[" (one-or-more anything) "]"
"[" (group (one-or-more digit)) "]]")
strn)
(string-to-number (match-string 1 strn))))
(defun org-element-shortcut-id (&optional property)
(org-element-extract-shortcut-id
(org-element-find-headline)
property))
(defun org-shortcut--element-type (elt)
"Return one of 'epic, 'story, or nil indicating the type of ELT."
(cond
((plist-get elt :SHORTCUT-EPIC-ID) 'epic)
((plist-get elt :SHORTCUT-ID) 'story)))
(defun org-shortcut-clocked-in-story-id ()
"Return the shortcut story-id of the currently clocked-in org entry, if any."
(save-mark-and-excursion
(save-current-buffer
(when (org-clocking-p)
(set-buffer (marker-buffer org-clock-marker))
(save-restriction
(when (or (< org-clock-marker (point-min))
(> org-clock-marker (point-max)))
(widen))
(goto-char org-clock-marker)
(org-element-shortcut-id))))))
(comment
(org-shortcut-clocked-in-story-id)
;;
)
(defun org-element-and-children-at-point ()
(let* ((elt (org-element-find-headline))
(contents-begin (or (plist-get elt :contents-begin)
(plist-get elt :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)))))
(defun +org-element-contents (elt)
(if-let ((begin (plist-get (cadr elt) :contents-begin))
(end (plist-get (cadr elt) :contents-end)))
(buffer-substring-no-properties begin end)
""))
(defun org-shortcut-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-shortcut-find-description-drawer)))))))
(defun org-shortcut--description-for-elt (elt)
(save-mark-and-excursion
(goto-char (plist-get elt :begin))
(org-shortcut-find-description-drawer)))
(defun org-shortcut--labels-for-elt (elt)
"Return the Shortcut labels based on the tags of ELT and the user's config."
(unless (eq nil org-shortcut-create-stories-with-labels)
(let ((tags (org-get-tags (plist-get elt :contents-begin))))
(-map (lambda (l) `((name . ,l)))
(cl-case org-shortcut-create-stories-with-labels
('t tags)
('existing (-filter (lambda (tag) (-some (lambda (l)
(string-equal tag (cdr l)))
(org-shortcut-labels)))
tags)))))))
;;;
;;; API integration
;;;
(defvar org-shortcut-base-url* "https://api.app.shortcut.com/api/v3")
(defun org-shortcut-baseify-url (url)
(if (s-starts-with? org-shortcut-base-url* url) url
(concat org-shortcut-base-url*
(if (s-starts-with? "/" url) url
(concat "/" url)))))
(cl-defun org-shortcut-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")
("Shortcut-Token" . org-shortcut-auth-token)))
(url-request-data data)
(buf))
(setq url (-> url
org-shortcut-baseify-url))
(setq buf (url-retrieve-synchronously url))
(with-current-buffer buf
(goto-char url-http-end-of-headers)
(prog1 (json-read) (kill-buffer)))))
(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-shortcut-fetch-as-id-name-pairs
(resource &optional
(id-attr 'id)
(name-attr 'name))
"Returns the given resource from shortcut as (id . name) pairs"
(let ((resp-json (org-shortcut-request "GET" resource)))
(-> resp-json
->list
reject-archived
(to-id-name-pairs id-attr name-attr))))
(defun org-shortcut-get-story
(shortcut-id)
(org-shortcut-request "GET" (format "/stories/%s" shortcut-id)))
(defun org-shortcut-link-to-story (story-id)
(format "https://app.shortcut.com/%s/story/%d"
org-shortcut-team-name
story-id))
(defun org-shortcut-link-to-epic (epic-id)
(format "https://app.shortcut.com/%s/epic/%d"
org-shortcut-team-name
epic-id))
(defun org-shortcut-link-to-milestone (milestone-id)
(format "https://app.shortcut.com/%s/milestone/%d"
org-shortcut-team-name
milestone-id))
(defun org-shortcut-link-to-project (project-id)
(format "https://app.shortcut.com/%s/project/%d"
org-shortcut-team-name
project-id))
;;;
;;; Caching
;;;
(comment
(defcache org-shortcut-projects
(org-sync-shortcut-fetch-as-id-name-pairs "projectx"))
(clear-org-shortcut-projects-cache)
(clear-org-shortcut-cache)
;;
)
(defvar org-shortcut-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-shortcut-cache-clear-functions))))
(defun org-shortcut-clear-cache ()
(interactive)
(-map #'funcall org-shortcut-cache-clear-functions))
;;;
;;; API resource functions
;;;
(defcache org-shortcut-projects
"Returns projects as (project-id . name)"
(org-shortcut-fetch-as-id-name-pairs "projects"))
(defcache org-shortcut-epics
"Returns epics as (epic-id . name)"
(org-shortcut-fetch-as-id-name-pairs "epics"))
(defcache org-shortcut-milestones
"Returns milestone-id . name)"
(org-shortcut-fetch-as-id-name-pairs "milestones"))
(defcache org-shortcut-workflow-states
"Returns worflow states as (name . id) pairs"
(let* ((resp-json (org-shortcut-request "GET" "workflows"))
(workflows (->list resp-json))
;; just assume it exists, for now
(workflow (-find (lambda (workflow)
(equal org-shortcut-workflow-name
(alist-get 'name workflow)))
workflows))
(states (->list (alist-get 'states workflow))))
(to-id-name-pairs states
'name
'id)))
(defcache org-shortcut-labels
"Returns labels as (label-id . name)"
(org-shortcut-fetch-as-id-name-pairs "labels"))
(defcache org-shortcut-whoami
"Returns the ID of the logged in user"
(->> (org-shortcut-request
"GET"
"/members")
->list
(find-if (lambda (m)
(->> m
(alist-get 'profile)
(alist-get 'mention_name)
(equal org-shortcut-username))))
(alist-get 'id)))
(defcache org-shortcut-iterations
"Returns iterations as (iteration-id . name)"
(org-shortcut-fetch-as-id-name-pairs "iterations"))
(defun org-shortcut-stories-in-project (project-id)
"Return the stories in the given PROJECT-ID as org headlines."
(let ((resp-json (org-shortcut-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)))))))
(defun org-shortcut-workflow-state-id-to-todo-keyword (workflow-state-id)
"Convert the named shortcut WORKFLOW-STATE-ID to an org todo keyword."
(let* ((state-name (alist-get-equal
workflow-state-id
(invert-alist (org-shortcut-workflow-states))))
(inv-state-name-alist
(-map (lambda (cell) (cons (cdr cell) (car cell)))
org-shortcut-state-alist)))
(or (alist-get-equal state-name inv-state-name-alist)
(if state-name (s-upcase state-name) "UNKNOWN"))))
;;;
;;; Prompting
;;;
(defun org-shortcut-prompt-for-project (cb)
(ivy-read
"Select a project: "
(-map #'cdr (org-shortcut-projects))
:require-match t
:history 'org-shortcut-project-history
:action (lambda (selected)
(let ((project-id
(find-match-in-alist selected (org-shortcut-projects))))
(funcall cb project-id)))))
(defun org-shortcut-prompt-for-epic (cb)
"Prompt the user for an epic using ivy and call CB with its ID."
(ivy-read
"Select an epic: "
(-map #'cdr (append '((nil . "No Epic")) (org-shortcut-epics)))
:history 'org-shortcut-epic-history
:action (lambda (selected)
(let ((epic-id
(find-match-in-alist selected (org-shortcut-epics))))
(funcall cb epic-id)))))
(defun org-shortcut-prompt-for-milestone (cb)
"Prompt the user for a milestone using ivy and call CB with its ID."
(ivy-read
"Select a milestone: "
(-map #'cdr (append '((nil . "No Milestone")) (org-shortcut-milestones)))
:require-match t
:history 'org-shortcut-milestone-history
:action (lambda (selected)
(let ((milestone-id
(find-match-in-alist selected (org-shortcut-milestones))))
(funcall cb milestone-id)))))
(defun org-shortcut-prompt-for-story-type (cb)
(ivy-read
"Select a story type: "
(-map #'cdr org-shortcut-story-types)
:history 'org-shortcut-story-history
:action (lambda (selected)
(let ((story-type
(find-match-in-alist selected org-shortcut-story-types)))
(funcall cb story-type)))))
(defun org-shortcut-prompt-for-default-story-type ()
(interactive)
(ivy-read
"Select a default story type: "
(-map #'cdr org-shortcut-default-story-types)
:history 'org-shortcut-default-story-history
:action (lambda (selected)
(let ((story-type
(find-match-in-alist selected org-shortcut-default-story-types)))
(if (string-equal story-type "prompt")
(setq org-shortcut-default-story-type nil)
(setq org-shortcut-default-story-type story-type))))))
;;;
;;; Epic creation
;;;
(cl-defun org-shortcut-create-epic-internal
(title &key milestone-id description labels)
(cl-assert (and (stringp title)
(or (null milestone-id)
(integerp milestone-id))
(or (null description)
(stringp description))
(and (listp labels)
(-all? #'stringp labels))))
(org-shortcut-request
"POST"
"epics"
:data
(json-encode
`((name . ,title)
(milestone_id . ,milestone-id)
(description . ,(or description ""))
(labels . ,labels)))))
(defun org-shortcut-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 "shortcut-epic-id"
(org-link-make-string
(org-shortcut-link-to-epic epic-id)
(number-to-string epic-id)))
(when milestone-id
(org-set-property "shortcut-milestone"
(org-link-make-string
(org-shortcut-link-to-milestone milestone-id)
(alist-get milestone-id (org-shortcut-milestones))))))))
(defun org-shortcut-create-epic (&optional beg end)
"Creates a shortcut 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 SHORTCUT-EPIC-ID, they are filtered and ignored."
(interactive
(when (use-region-p)
(list (region-beginning) (region-end))))
(let* ((elts (org-shortcut-collect-headlines beg end))
(elts (-remove (lambda (elt) (plist-get elt :SHORTCUT-EPIC-ID)) elts)))
(org-shortcut-prompt-for-milestone
(lambda (milestone-id)
(dolist (elt elts)
(let* ((title (plist-get elt :title))
(description (org-shortcut--description-for-elt elt))
(labels (org-shortcut--labels-for-elt elt))
(epic (org-shortcut-create-epic-internal
title
:milestone-id milestone-id
:labels labels
:description description)))
(org-shortcut-populate-created-epic elt epic)))))))
;;;
;;; Story creation
;;;
(defun org-shortcut-default-state-id ()
(alist-get-equal org-shortcut-default-state (org-shortcut-workflow-states)))
(cl-defun org-shortcut-create-story-internal
(title &key project-id epic-id story-type description labels)
(cl-assert (and (stringp title)
(integerp project-id)
(or (null epic-id) (integerp epic-id))
(or (null description) (stringp description))))
(let ((workflow-state-id (org-shortcut-default-state-id))
(params `((name . ,title)
(project_id . ,project-id)
(epic_id . ,epic-id)
(story_type . ,story-type)
(description . ,(or description ""))
(labels . ,labels))))
(when workflow-state-id
(push `(workflow_state_id . ,workflow-state-id) params))
(org-shortcut-request
"POST"
"stories"
:data
(json-encode params))))
(cl-defun org-shortcut-populate-created-story (elt story &key extra-properties)
(let ((elt-start (plist-get elt :begin))
(story-id (alist-get 'id story))
(epic-id (alist-get 'epic_id story))
(project-id (alist-get 'project_id story))
(story-type (alist-get 'story_type story)))
(save-excursion
(goto-char elt-start)
(org-set-property "shortcut-id"
(org-link-make-string
(org-shortcut-link-to-story story-id)
(number-to-string story-id)))
(when epic-id
(org-set-property "shortcut-epic"
(org-link-make-string
(org-shortcut-link-to-epic epic-id)
(alist-get epic-id (org-shortcut-epics)))))
(org-set-property "shortcut-project"
(org-link-make-string
(org-shortcut-link-to-project project-id)
(alist-get project-id (org-shortcut-projects))))
(org-set-property "story-type"
(alist-get-equal story-type org-shortcut-story-types))
(dolist (extra-prop extra-properties)
(org-set-property (car extra-prop)
(alist-get (cdr extra-prop) story)))
(org-todo "TODO"))))
(defun org-shortcut-create-story (&optional beg end &key then)
"Creates a shortcut 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 SHORTCUT-ID, they are filtered and ignored."
(interactive
(when (use-region-p)
(list (region-beginning) (region-end))))
(let* ((elts (org-shortcut-collect-headlines beg end))
(new-elts (-remove (lambda (elt) (plist-get elt :SHORTCUT-ID)) elts)))
(org-shortcut-prompt-for-project
(lambda (project-id)
(when project-id
(org-shortcut-prompt-for-epic
(lambda (epic-id)
(let ((create-story
(lambda (story-type)
(-map
(lambda (elt)
(let* ((title (plist-get elt :title))
(description
(org-shortcut--description-for-elt elt))
(labels (org-shortcut--labels-for-elt elt))
(story (org-shortcut-create-story-internal
title
:project-id project-id
:epic-id epic-id
:story-type story-type
:description description
:labels labels)))
(org-shortcut-populate-created-story elt story)
(when (functionp then)
(funcall then story))))
new-elts))))
(if org-shortcut-default-story-type
(funcall create-story org-shortcut-default-story-type)
(org-shortcut-prompt-for-story-type create-story))))))))))
(defun org-shortcut-create-story-with-task-list (&optional beg end)
"Creates a shortcut 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-shortcut-create-story nil nil
:then (lambda (story)
(pp story)
(org-shortcut-push-task-list
(alist-get 'id story)
(plist-get elt :children))))))
;;;
;;; Task creation
;;;
(cl-defun org-shortcut-create-task (title &key story-id)
(cl-assert (and (stringp title)
(integerp story-id)))
(org-shortcut-request
"POST"
(format "/stories/%d/tasks" story-id)
:data (json-encode `((description . ,title)))))
(defun org-shortcut-push-task-list (&optional parent-shortcut-id child-elts)
"Writes each child of the element at point as a task list item.
When called as (org-shortcut-push-task-list PARENT-SHORTCUT-ID CHILD-ELTS),
allows manually passing a shortcut ID and list of org-element plists to write"
(interactive)
(let* ((elt (org-element-and-children-at-point))
(parent-shortcut-id (or parent-shortcut-id
(org-element-extract-shortcut-id elt)))
(child-elts (or child-elts (plist-get elt :children)))
(story (org-shortcut-get-story parent-shortcut-id))
(existing-tasks (alist-get 'tasks story))
(task-exists
(lambda (task-name)
(cl-some (lambda (task)
(string-equal task-name (alist-get 'description task)))
existing-tasks)))
(elts-with-starts
(-map (lambda (e) (cons (set-marker (make-marker)
(plist-get e :begin))
e))
child-elts)))
(dolist (child-elt-and-start elts-with-starts)
(let* ((start (car child-elt-and-start))
(child-elt (cdr child-elt-and-start))
(task-name (plist-get child-elt :title)))
(unless (funcall task-exists task-name)
(let ((task (org-shortcut-create-task
task-name
:story-id parent-shortcut-id)))
(org-shortcut-populate-created-task child-elt task start)))))))
(defun org-shortcut-populate-created-task (elt task &optional begin)
(let ((elt-start (or begin (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 "shortcut-task-id" (format "%d" task-id))
(org-set-property "shortcut-story-id"
(org-link-make-string
(org-shortcut-link-to-story story-id)
(number-to-string story-id)))
(org-todo "TODO"))))
;;;
;;; Task Updates
;;;
(cl-defun org-shortcut-update-task-internal
(story-id task-id &rest attrs)
(cl-assert (and (integerp story-id)
(integerp task-id)
(listp attrs)))
(org-shortcut-request
"PUT"
(format "stories/%d/tasks/%d" story-id task-id)
:data
(json-encode attrs)))
;;;
;;; Story updates
;;;
(cl-defun org-shortcut-update-story-internal
(story-id &rest attrs)
(cl-assert (and (integerp story-id)
(listp attrs)))
(org-shortcut-request
"PUT"
(format "stories/%d" story-id)
:data
(json-encode attrs)))
(cl-defun org-shortcut-update-epic-internal
(story-id &rest attrs)
(cl-assert (and (integerp story-id)
(listp attrs)))
(org-shortcut-request
"PUT"
(format "epics/%d" epic-id)
:data
(json-encode attrs)))
(cl-defun org-shortcut-update-story-at-point (&rest attrs)
(when-let* ((shortcut-id (org-element-shortcut-id)))
(apply
#'org-shortcut-update-story-internal
(cons shortcut-id attrs))
t))
(cl-defun org-shortcut-update-epic-at-point (&rest attrs)
(when-let* ((epic-id (org-element-shortcut-id :SHORTCUT-EPIC-ID)))
(apply
#'org-shortcut-update-epic-internal
(cons epic-id attrs))
t))
(defun org-shortcut-update-story-title ()
"Update the title of the Shortcut story linked to the current headline.
Update the title of the story linked to the current headline with the text of
the headline."
(interactive)
(let* ((elt (org-element-find-headline))
(title (plist-get elt :title))
(shortcut-id (org-element-shortcut-id)))
(and
(org-shortcut-update-story-at-point
shortcut-id
:name title)
(message "Successfully updated story title to \"%s\""
title))))
(defun org-shortcut-update-status ()
"Update the status of the Shortcut story linked to the current element.
Update the status of the Shortcut story linked to the current element with the
entry in `org-shortcut-state-alist' corresponding to the todo-keyword of the
element."
(interactive)
(let* ((elt (org-element-find-headline))
(todo-keyword (-> elt
(plist-get :todo-keyword)
(substring-no-properties)))
(shortcut-id (org-element-extract-shortcut-id elt))
(task-id (plist-get elt :SHORTCUT-TASK-ID)))
(cond
(shortcut-id
(let* ((todo-keyword (-> elt
(plist-get :todo-keyword)
(substring-no-properties))))
(when-let* ((shortcut-workflow-state
(alist-get-equal todo-keyword org-shortcut-state-alist))
(workflow-state-id
(alist-get-equal shortcut-workflow-state
(org-shortcut-workflow-states))))
(let ((update-assignee?
(if (or (eq 't org-shortcut-claim-story-on-status-update)
(member todo-keyword
org-shortcut-claim-story-on-status-update))
(if org-shortcut-username
't
(warn "Not claiming story since `org-shortcut-username'
is not set")
nil))))
(if update-assignee?
(org-shortcut-update-story-internal
shortcut-id
:workflow_state_id workflow-state-id
:owner_ids (if update-assignee?
(list (org-shortcut-whoami))
(list)))
(org-shortcut-update-story-internal
shortcut-id
:workflow_state_id workflow-state-id))
(message
(if update-assignee?
"Successfully claimed story and updated shortcut status to \"%s\""
"Successfully updated shortcut status to \"%s\"")
shortcut-workflow-state)))))
(task-id
(let ((story-id (org-element-extract-clubhouse-id
elt
:SHORTCUT-STORY-ID))
(done? (member todo-keyword org-done-keywords)))
(org-shortcut-update-task-internal
story-id
(string-to-number task-id)
:complete (if done? 't :json-false))
(message "Successfully marked shortcut task status as %s"
(if done? "complete" "incomplete")))))))
(defun org-shortcut-update-description ()
"Update the description of the Shortcut story linked to the current element.
Update the status of the Shortcut story linked to the current element with the
contents of a drawer inside the element called DESCRIPTION, if any."
(interactive)
(when-let* ((new-description (org-shortcut-find-description-drawer)))
(and
(org-shortcut-update-story-at-point
:description new-description)
(message "Successfully updated story description"))))
(defun org-shortcut-update-labels (&optional beg end)
"Update the labels of the story or epic linked to the element at point.
When called interactively with a region, operates on all elements between BEG
and END.