forked from gizmomogwai/org-kanban
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathorg-kanban.el
1049 lines (951 loc) · 44.5 KB
/
org-kanban.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-kanban.el --- kanban dynamic block for org-mode. -*- lexical-binding: t -*-
;; Copyright (C) 2016 Christian Köstlin
;; This file is NOT part of GNU Emacs.
;; Author: Christian Köstlin <christian.koestlin@gmail.com>
;; Contributors:
;; Aldric Giacomoni <trevoke@gmail.com>
;; Damian Chrzanowski <a00246203@student.ait.ie>
;; Vlk <zdenek.mzourek@gmail.com>
;; Pieter Hijma <pieterhijma@users.noreply.github.com>
;; Darius Foo <darius.foo.tw@gmail.com>
;; Keywords: org-mode, org, kanban, tools
;; Package-Requires: ((s) (dash "2.17.0"))
;; Package-Version: 0.6.10
;; Homepage: http://github.com/gizmomogwai/org-kanban
;;; Commentary:
;; To create a kanban table for an org file, simply put the dynamic block
;; `
;; #+BEGIN: kanban
;; #+END:
;; '
;; somewhere and run `C-c C-c' on it. You can use
;; `org-kanban/initialize' to get this generated.
;;; Code:
(require 'dash)
(require 'org)
(require 'org-table)
(require 's)
(require 'subr-x)
(require 'wid-edit)
(require 'widget)
(defun org-kanban//sanity-check-parameters (context layout)
"Check for CONTEXT if LAYOUT is consistent."
(let ((link-abbreviation (car layout))
(link-max-length (cdr layout)))
(if link-max-length
(if (>= (length link-abbreviation) link-max-length)
(error "Problem with %s link-abbreviation (%s) is >= link-max-length (%s)" context link-abbreviation link-max-length)))))
(defgroup org-kanban nil
"Settings for org-kanban."
:group 'org
:prefix "org-kanban")
(defcustom org-kanban/prev-keys "ah"
"Key for promoting an entry of a kanban table to the previous state."
:type 'string
:group 'org-kanban)
(defcustom org-kanban/next-keys "dl"
"Key for promoting an entry of a kanban table to the next state."
:type 'string
:group 'org-kanban)
(defcustom org-kanban/subtree-up-keys "wk"
"Key for moving the subtree of an entry up in the org document."
:type 'string
:group 'org-kanban)
(defcustom org-kanban/subtree-down-keys "sj"
"Key for moving the subtree of an entry down in the org document."
:type 'string
:group 'org-kanban)
(defcustom org-kanban/layout (cons "..." 1000)
"Layout for long descriptions."
:type '(cons
(string :tag "abbreviation")
(integer :tag "max-length "))
:set (lambda (symbol value)
(progn
(org-kanban//sanity-check-parameters "customize-set" value)
(set-default symbol value)))
:group 'org-kanban)
(defun org-kanban//todo-info-extract ()
"Extract all required infos from a todo.
e.g. buffer, heading-components, allowed keywords, ids, priority, ..."
(list
(current-buffer)
(org-heading-components)
org-todo-keywords-1
(org-entry-get nil "CUSTOM_ID")
(org-entry-get nil "ID")
(org-entry-get nil "PRIORITY")
(org-entry-get nil "TODO")
))
(defun org-kanban//todo-info-get-file (todo-info)
"Get the buffer from a TODO-INFO."
(nth 0 todo-info))
(defun org-kanban//todo-info-get-heading (todo-info)
"Get the heading info from a TODO-INFO."
(nth 1 todo-info))
(defun org-kanban--todo-info-get-level (todo-info)
"Get the level from a TODO-INFO."
(nth 0 (nth 1 todo-info)))
(defun org-kanban--todo-info-get-keyword (todo-info)
"Get the keyword from a TODO-INFO."
(nth 2 (nth 1 todo-info)))
(defun org-kanban//todo-info-get-keywords (todo-info)
"Get the allowed keywords for a TODO-INFO."
(nth 2 todo-info))
(defun org-kanban//todo-info-get-custom-id (todo-info)
"Get the CUSTOM_ID from a heading TODO-INFO."
(nth 3 todo-info))
(defun org-kanban//todo-info-get-id (todo-info)
"Get the ID from a heading TODO-INFO."
(nth 4 todo-info))
(defun org-kanban//todo-info-get-priority (todo-info)
"Get the PRIORITY from a heading TODO-INFO."
(nth 5 todo-info))
(defun org-kanban//todo-info-get-state (todo-info)
"Get the STATE from a heading TODO-INFO."
(nth 6 todo-info))
(defun org-kanban//heading-get-title (heading)
"Get the title from an `org-mode` HEADING."
(nth 4 heading))
(defun org-kanban//heading-get-todo-keyword (todo)
"Get the TODO keyword from an `org-mode` HEADING."
(nth 2 todo))
(defun org-kanban//heading-to-description (heading layout)
"Create a description from a HEADING.
The description is truncated according to the LAYOUT cons (e.g. (\"...\" . 10))."
(org-kanban//sanity-check-parameters "sanity-check" layout)
(let* ((link-abbreviation (car layout))
(max-length (cdr layout)))
(if (> (length heading) max-length)
(concat
(substring heading 0 (- max-length (length link-abbreviation)))
link-abbreviation)
heading)))
(defun org-kanban//relative-filename (file)
"Calculate relative filename for FILE based on current buffer."
(file-relative-name (buffer-file-name file) (file-name-directory (buffer-file-name (current-buffer)))))
(defun org-kanban//link-for-custom-id (custom-id file description)
"Create a link for CUSTOM-ID, optionally USE-FILE FILE and DESCRIPTION."
(if custom-id
(format "[[file:%s::#%s][%s]]" (org-kanban//relative-filename file) custom-id description)
nil))
(defun org-kanban//link-for-id (id description)
"Create a link for ID with DESCRIPTION."
(if id
(format "[[id:%s][%s]]" id description)
nil))
(defun org-kanban//link-for-heading (heading file description)
"Create a link for a HEADING optionally a FILE and DESCRIPTION."
(if heading
(format "[[file:%s::*%s][%s]]" (org-kanban//relative-filename file) heading description)
(error "Illegal state")))
(defun org-kanban//escape-description (description)
"Cleanup DESCRIPTION for use in an org link."
(s-replace "|" "｜" ; trick to not break tables
(replace-regexp-in-string "\\[\\[.*]\\[\\(.*\\)]]" (lambda (x) (match-string 1 x)) description) ; replace links with linktext
))
(defun org-kanban//escape-heading (heading)
"Cleanup HEADING for use an org link."
(let* (
(escaped-links (replace-regexp-in-string (rx "[[" (+? not-newline) "][" (+? not-newline) "]]")
(lambda (x) (s-replace "]" "\\\\]" (s-replace "[" "\\\\[" (match-string 0 x)))) heading))
(escaped-cite (replace-regexp-in-string (rx "[" (group "cite" (+? not-newline)) "]") "\\\\[\\1\\\\]" escaped-links))
(removed-slash-checkbox (replace-regexp-in-string (rx "[" (+? digit) "/" (+? digit) "]") "" escaped-cite))
(removed-percent-checkbox (replace-regexp-in-string (rx "[" (+? digit) "%]") "" removed-slash-checkbox))
(trimmed (s-replace "|" "｜" removed-percent-checkbox)))
trimmed))
(defun org-kanban//unescape-heading (heading)
"Transform HEADING from org link to real heading."
(s-replace "\\[" "["
(s-replace "\\]" "]"
(s-replace "｜" "|" heading))))
(defun org-kanban//link (file heading kanban search-for custom-id id layout)
"Create a link to FILE and HEADING if the KANBAN value is equal to SEARCH-FOR.
CUSTOM-ID links are used if given.
ID links are used if given.
LAYOUT is the specification to layout long links.
This means, that the org-kanban table links are in one of several forms:
- file:#custom-id
- #custom-id
- id:id
- file:*heading
- heading"
(if
(and (stringp kanban) (string-equal search-for kanban))
(let* (
(description (funcall layout (org-kanban//escape-description heading)))
)
(or
(org-kanban//link-for-custom-id custom-id file description)
(org-kanban//link-for-id id description)
(org-kanban//link-for-heading (org-kanban//escape-heading heading) file description)
))
""))
(defun org-kanban//todo-keywords (files mirrored range-fun)
"Get list of org todos from FILES.
MIRRORED describes if keywords should be reversed. RANGE-FUN filters keywords."
(save-window-excursion
(let* (
(list-of-keywords (-flatten (-map
(lambda(file)
(find-file file)
org-todo-keywords-1)
files)))
(filtered (-distinct (-filter (lambda (i) (funcall range-fun i list-of-keywords)) list-of-keywords)))
(keywords (if mirrored (reverse filtered) filtered)))
keywords)))
(defun org-kanban//row-entries-for (todo-info todo-keywords layout)
"Convert a kanban TODO-INFO to elements of a row for org-table.
The result is a list of entries that can be converted by
`org-kanban//row-entries-to-row.
TODO-KEYWORDS are all the current org todos.
LAYOUT specification."
(let* (
(file (org-kanban//todo-info-get-file todo-info))
(heading (org-kanban//todo-info-get-heading todo-info))
(title (org-kanban//heading-get-title heading))
(kanban (org-kanban//heading-get-todo-keyword heading))
(custom-id (org-kanban//todo-info-get-custom-id todo-info))
(id (org-kanban//todo-info-get-id todo-info))
(row-entries (-map (lambda(i) (org-kanban//link file title i kanban custom-id id layout)) todo-keywords)))
row-entries))
(defun org-kanban//row-entries-to-string (row-entries)
"Convert ROW-ENTRIES to an org-kanban table row string."
(let* (
(row (string-join row-entries "|")))
(format "|%s|" row)))
(defun org-kanban//row-for (todo-info todo-keywords layout)
"Convert a kanban TODO-INFO to a row of a org-table.
TODO-KEYWORDS are all the current org todos.
LAYOUT specification."
(org-kanban//row-entries-to-string (org-kanban//row-entries-for todo-info todo-keywords layout)))
(defun org-kanban//transpose-lists (lists)
"Transpose LISTS."
(apply '-zip-lists (apply '-pad nil lists)))
(defun org-kanban//add-to-matrix (value column matrix)
"Add VALUE to COLUMN of MATRIX and return it.
An existing row with an empty column is changed or a new row is
appended to the matrix."
(let* (
(row-index (-find-index (lambda (x) (not (nth column x)))
matrix)))
(if row-index
(let* ( ;; change existing row
(row (nth row-index matrix))
(new-row (-replace-at column value row))
(new-matrix (-replace-at row-index new-row
matrix)))
new-matrix)
(let* ( ;; add new row
(row (make-list (length (car matrix)) nil))
(new-row (-replace-at column value row))
(new-matrix (append matrix (list new-row))))
new-matrix))))
(defun org-kanban//compressed-rows (rows)
"Produce a vertically compressed table out of ROWS.
Rows are proper org-table rows.
The processing is done on string level."
(let* (
(matrix (--map (split-string it "|" nil) rows))
(width (length (car matrix)))
(compressed (-reduce-from
(lambda (memo item)
(let* ((idx (-find-index (lambda (x) (> (length x) 0)) item)))
(org-kanban//add-to-matrix (nth idx item) idx memo)))
(list (make-list width nil))
matrix)))
(string-join (-map (lambda (x) (string-join x "|")) compressed) "\n")))
(require 're-builder)
(setq reb-re-syntax 'string)
(defun org-kanban//find-by-file-and-custom-id (line)
"Search for a todo in a LINE with file and custom_id."
(let* (
(pattern "\\[\\[file:\\(.*\\)::#\\(.*\\)\\]\\[.*\\]")
(match (string-match pattern line))
(file (and match (match-string 1 line)))
(custom-id (and match (match-string 2 line)))
(entry (and custom-id (save-excursion
(find-file file)
(org-find-property "CUSTOM_ID" custom-id)))))
(if entry (list file entry) nil)))
(defun org-kanban//find-by-file-and-heading (line)
"Search for a todo in a LINE with file and heading."
(let* (
(pattern "\\[\\[file:\\(.*\\)::\\*\\(.*\\)\\]\\[.*\\]")
(match (string-match pattern line))
(file (and match (match-string 1 line)))
(heading (and match (org-kanban//unescape-heading (match-string 2 line))))
(entry (and heading (save-excursion
(find-file file)
(org-find-exact-headline-in-buffer heading)))))
(if entry (list file entry) nil)))
(defun org-kanban//find-by-custom-id (line)
"Try to find a todo by custom id in LINE."
(let* (
(pattern "\\[\\[#\\(.*\\)\\]\\[.*\\]")
(match (string-match pattern line))
(custom-id (and match (match-string 1 line)))
(entry (and custom-id (org-find-property "CUSTOM_ID" custom-id))))
(if entry (list (buffer-file-name) entry) nil)))
(defun org-kanban//find-by-heading (line)
"Try to find a todo by heading in LINE."
(let* (
(pattern "\\[\\[\\(.*\\)\\]\\[.*\\]")
(match (string-match pattern line))
(heading (and match (org-kanban//unescape-heading (match-string 1 line))))
(entry (and heading (org-find-exact-headline-in-buffer heading))))
(if entry (list (buffer-file-name) entry) nil)))
(defun org-kanban//find-by-id (line)
"Try to find a todo by id in LINE."
(let* (
(pattern "\\[\\[id:\\(.*\\)\\]\\[.*\\]")
(match (string-match pattern line))
(id (and match (match-string 1 line)))
(entry (and id (org-find-entry-with-id id))))
(if entry (list (buffer-file-name) entry) nil)))
(defun org-kanban//find ()
"Search for a todo matching to the current kanban table row.
Return file and marker."
(let* (
(line-start (save-excursion
(move-beginning-of-line 1)
(point)))
(line-end (save-excursion
(move-end-of-line 1)
(point)))
(line (buffer-substring-no-properties line-start line-end)))
(or
(org-kanban//find-by-file-and-custom-id line)
(org-kanban//find-by-file-and-heading line)
(org-kanban//find-by-custom-id line)
(org-kanban//find-by-id line)
(org-kanban//find-by-heading line))))
(defun org-kanban/move-subtree-up ()
"Move the todo entry in the current line of the kanban table up."
(interactive)
(org-kanban//move-subtree 'up))
(defun org-kanban/move-subtree-down ()
"Move the todo entry in the current line of the kanban table down."
(interactive)
(org-kanban//move-subtree 'down))
(defun org-kanban//move-subtree (&optional direction)
"Move subtree into DIRECTION."
(save-window-excursion
(if (-contains? (list 'up 'down) direction)
(let* (
(file-and-marker (org-kanban//find))
(file (nth 0 file-and-marker))
(marker (nth 1 file-and-marker)))
(when (and file-and-marker file marker)
(with-demoted-errors "Error: %S"
;;(org-kanban//move-table-entry direction)
(let ((new-pos 0))
(save-excursion
(find-file file)
(goto-char marker)
(if (eq direction 'up)
(org-move-subtree-up)
(org-move-subtree-down))
(setq new-pos (point)))
(org-dblock-update)
(org-beginning-of-dblock)
(if (org-kanban//search-element file new-pos)
(goto-char (search-forward "[["))))))))))
(defun org-kanban//search-element (required-file required-point)
"Search for a matching org-kanban table entry.
The entry need to match on REQUIRED-FILE and REQUIRED-POINT."
(let* (
(done-p nil))
(while (not done-p)
(let* (
(file-and-marker (org-kanban//find))
(file (nth 0 file-and-marker))
(marker (nth 1 file-and-marker)))
(if marker
(if (and
(eq (marker-position marker) required-point)
(string-equal file required-file))
(setq done-p t)
(forward-line 1))
(forward-line 1))))))
(defun org-kanban/next ()
"Move the todo entry in the current line of the kanban table to the next state."
(interactive)
(org-kanban//move 'right))
(defun org-kanban/prev ()
"Move the kanban table entry in the current line to the previous state."
(interactive)
(org-kanban//move 'left))
(defun org-kanban/shift (&optional direction)
"Move todo to DIRECTION (repeatedly)."
(interactive)
(message "Use %s and %s to change todo state, %s and %s to reorder subtrees" org-kanban/prev-keys org-kanban/next-keys org-kanban/subtree-up-keys org-kanban/subtree-down-keys)
(cond
((eq 'left direction) (org-kanban//move direction))
((eq 'right direction) (org-kanban//move direction))
((eq 'up direction) (org-kanban//move-subtree direction))
((eq 'down direction) (org-kanban//move-subtree direction)))
(set-transient-map
(let* (
(map (make-sparse-keymap)))
(org-kanban//define-keys map org-kanban/prev-keys (lambda () (interactive) (org-kanban/shift 'left)))
(org-kanban//define-keys map org-kanban/next-keys (lambda () (interactive) (org-kanban/shift 'right)))
(org-kanban//define-keys map org-kanban/subtree-down-keys (lambda () (interactive) (org-kanban/shift 'down)))
(org-kanban//define-keys map org-kanban/subtree-up-keys (lambda () (interactive) (org-kanban/shift 'up)))
map)))
(defun org-kanban//define-keys (map keys fun)
"Define FUN for all KEYS in MAP."
(dolist (key (append keys nil))
(define-key map (format "%c" key) fun)))
;;;###autoload
(defun org-kanban/initialize (&optional arg)
"Create an org-kanban dynamic block at position ARG."
(interactive "p")
(cond (
(eq arg nil) (org-kanban/initialize-here))
((eq arg 1) (org-kanban/initialize-here))
((eq arg 4) (org-kanban/initialize-at-beginning))
((eq arg 16) (org-kanban/initialize-at-end))
(t (error (message "Unsupported universal argument %s" arg)))))
;;;###autoload
(defun org-kanban/initialize-at-beginning ()
"Create an org-kanban dynamic block at the beginning of the buffer."
(interactive)
(save-excursion
(goto-char (point-min))
(forward-line)
(org-kanban//initialize-mirrored-kanban-at-point)))
;;;###autoload
(defun org-kanban/initialize-at-end ()
"Create an org-kanban dynamic block at the end of the buffer."
(interactive)
(save-excursion
(goto-char (point-max))
(newline)
(org-kanban//initialize-mirrored-kanban-at-point)))
;;;###autoload
(defun org-kanban/initialize-here ()
"Create an org-kanban dynamic block at the point."
(interactive)
(save-excursion
(org-kanban//initialize-mirrored-kanban-at-point)))
(defun org-kanban//initialize-mirrored-kanban-at-point ()
"Create an org-kanban dynamic block at the point."
(save-excursion
(insert "#+BEGIN: kanban :mirrored t\n#+END:\n"))
(org-ctrl-c-ctrl-c))
(defun org-kanban//get-dynamic-block-parameters ()
"Get the dynamic block parameters if point is inside a block."
(save-excursion
(let* (
(_ (org-beginning-of-dblock))
(__ (unless (looking-at org-dblock-start-re)
(user-error "Not at a dynamic block")))
(name (org-no-properties (match-string 1))))
(append (list :name name) (read (concat "(" (match-string 3) ")"))))))
(defun org-kanban//move-table-entry (direction)
"Move the cell/entry in kanban table in direction DIRECTION."
(org-narrow-to-element)
;; goes to the element in the row, assume we are anywhere on the line
(or (search-forward "[[" nil t)
(search-backward "[["))
(unwind-protect
(org-table-move-column (if (eq 'left direction) 't nil))
(widen)
(org-table-align)))
(defun org-kanban//get-table-todo ()
"Return todo state in given column in kanban table."
(save-excursion
(let* ((cur-col (org-table-current-column)))
(org-table-goto-line 1)
(org-table-goto-column cur-col)
(-> (org-table-get-field)
(org-no-properties)
(s-trim)))))
(defmacro org-kanban//measure-time (title &rest body)
"Print time prefixed with TITLE it takes to evaluate BODY."
`(let ((time (current-time)))
,@body
(message "%s %.06f" ,title (float-time (time-since time)))))
(defun org-kanban//move (direction)
"Move the kanban table entry in the current line to the next state.
The next state is calculated by DIRECTION which can be \='left or \='right."
(save-window-excursion
(if (-contains? (list 'left 'right) direction)
(let* (
(file-and-marker (org-kanban//find))
(file (nth 0 file-and-marker))
(marker (nth 1 file-and-marker)))
(when (and file-and-marker file marker)
(with-demoted-errors "Error: %S"
(org-kanban//move-table-entry direction)
(let ((todo (org-kanban//get-table-todo)))
(save-excursion
(find-file file)
(goto-char marker)
(org-todo todo)))))))))
(defun org-kanban//params-layout (params)
"Calculate layout func based on PARAMS."
(let* (
(l (plist-get params :layout))
(layout (pcase l
(`nil (lambda(s) (org-kanban//heading-to-description s org-kanban/layout)))
((pred functionp) (lambda(s) (funcall l s)))
((pred symbolp) (lambda(s) (org-kanban//heading-to-description s (symbol-value l))))
((pred consp) (lambda(s) (org-kanban//heading-to-description s l)))
(_ (error (format "Unknown type %s" l))))))
layout))
(defun org-kanban//expand-like-agenda-files (files)
"Expand FILES like org agenda would do it.
This will also pick up all org files in a directory."
(let ((file-strings (-map (lambda (f) (symbol-name f)) files)))
(-flatten (-map (lambda (f)
(if (file-directory-p f)
(directory-files f t org-agenda-file-regexp)
(list (expand-file-name f))))
file-strings))))
(defun org-kanban//params-files (params)
"Calculate files on which the kanban is based from PARAMS.
This uses the parameter :scope of the block."
(let* (
(scope (plist-get params :scope))
(files (pcase scope
(`nil (list buffer-file-name))
(`tree (list buffer-file-name))
((pred functionp) (let* ((result (funcall scope))) (save-window-excursion (org-link-open-from-string result) (list buffer-file-name))))
(_ (org-kanban//expand-like-agenda-files scope)))))
files))
(defun org-kanban//params-scope (params files)
"Calculate scope based on PARAMS and FILES.
The result is directly forwarded to `org-map-entries,
the only exception :scope being a function."
(let* ((scope (plist-get params :scope)))
(pcase scope
(`nil files)
(`tree scope)
((pred functionp) scope)
(_ files))))
(defun org-kanban--params-depth (params)
"Get the depth from PARAMS. 1000 if not there."
(or (plist-get params :depth) 1000))
(defun org-kanban--compare-by-priority (a b f)
"Compare A and B by priority and function F."
(let* (
(pa (org-kanban//todo-info-get-priority a))
(pb (org-kanban//todo-info-get-priority b))
(result (funcall f pa pb)))
result))
(defun org-kanban--compare-by-state (a b all-keywords f)
"Compare A with B with the help of ALL-KEYWORDS and F."
(let* (
(idx-1 (or (-elem-index (org-kanban//todo-info-get-state a) all-keywords) 0))
(idx-2 (or (-elem-index (org-kanban//todo-info-get-state b) all-keywords) 0))
(result (funcall f idx-1 idx-2)))
result))
(defun org-kanban--compare-with-functions (a b functions)
"Compare A with B using FUNCTIONS.
If the first function cannot decide (neither a < b nor b < a), then
the rest of the functions is used."
(let* (
(first-function (car functions))
(result (if first-function
(if (funcall first-function a b) t
(if (funcall first-function b a) nil
(org-kanban--compare-with-functions a b (cdr functions))))
nil)))
result))
(defun org-kanban--combine-comparators(functions)
"Create a new compare function by chaining FUNCTIONS together."
(lambda (a b) (org-kanban--compare-with-functions a b functions)))
(defun org-kanban--prepare-comparator (spec all-keywords)
"Prepare a comparator function according to SPEC and ALL-KEYWORDS.
Supported are pP and oO."
(org-kanban--combine-comparators
(mapcar
(lambda (c)
(cond
((eq c ?o) (lambda (a b) (org-kanban--compare-by-state a b all-keywords '<)))
((eq c ?O) (lambda (a b) (org-kanban--compare-by-state a b all-keywords '>)))
((eq c ?p) (lambda (a b) (org-kanban--compare-by-priority a b 'string<)))
((eq c ?P) (lambda (a b) (org-kanban--compare-by-priority a b 'string>)))
(t (error "Unknown spec character %s" (char-to-string c)))
))
spec)))
(defun org-kanban//range-fun (value keywords from to)
"Return if VALUE is between FROM and TO in KEYWORDS."
(if from
(if to
(let* (
(from-idx (-elem-index from keywords))
(to-idx (-elem-index to keywords))
(value-idx (-elem-index value keywords))
)
(and from-idx to-idx value-idx (>= value-idx from-idx) (<= value-idx to-idx)))
t)
t))
(defun org-kanban--collect-todos (match scope)
"Collect all todos for the kanban based on MATCH in SCOPE."
(if (functionp scope)
(let* ((result (funcall scope)))
(save-window-excursion (org-link-open-from-string result)
(org-map-entries 'org-kanban//todo-info-extract match 'tree)))
(org-map-entries 'org-kanban//todo-info-extract match scope)))
;;;###autoload
(defun org-dblock-write:kanban (params)
"Create the kanban dynamic block.
PARAMS may contain `:mirrored`, `:match`, `:scope`, `:layout`,
`:range`, `:depth` and `:compressed`."
(insert
(let*
(
(mirrored (plist-get params :mirrored))
(compressed (plist-get params :compressed))
(match (plist-get params :match))
(range (plist-get params :range))
(depth (org-kanban--params-depth params))
(layout (org-kanban//params-layout params))
(files (org-kanban//params-files params))
(scope (org-kanban//params-scope params files))
(todo-keywords (org-kanban//todo-keywords files mirrored (lambda (value keywords) (org-kanban//range-fun value keywords (car range) (cdr range)))))
(sort-spec-string (plist-get params :sort))
(sort-spec (org-kanban--prepare-comparator sort-spec-string todo-keywords))
(todo-infos (org-kanban--collect-todos match scope))
(sorted-todo-infos (if sort-spec (-sort sort-spec todo-infos) todo-infos))
(filtered-todo-infos (-filter (lambda (todo-info)
(org-kanban//range-fun
(org-kanban--todo-info-get-keyword todo-info)
(org-kanban//todo-info-get-keywords todo-info)
(car range)
(cdr range)))
sorted-todo-infos))
(filtered-todo-infos (-filter (lambda (todo-info)
(if (or (eq scope 'tree) (functionp scope))
(let* (
(tree-info (nth 0 todo-infos))
(tree-level (org-kanban--todo-info-get-level tree-info)))
(< (org-kanban--todo-info-get-level todo-info) (+ depth tree-level)))
(<= (org-kanban--todo-info-get-level todo-info) depth))) filtered-todo-infos))
(filtered-todo-infos (-filter (lambda (todo-info) (nth 4 (org-kanban//todo-info-get-heading todo-info))) filtered-todo-infos))
(row-for (lambda (todo-info) (org-kanban//row-for todo-info todo-keywords layout)))
(table-title (string-join todo-keywords "|"))
(filtered (-filter (lambda (todo-info)
(-intersection
(list (org-kanban//heading-get-todo-keyword (org-kanban//todo-info-get-heading todo-info)))
(org-kanban//todo-info-get-keywords todo-info)))
filtered-todo-infos))
(table (if compressed
(org-kanban//compressed-rows (-map row-for filtered))
(let* ((rows (-map row-for filtered)))
(if rows
(--reduce (format "%s\n%s" acc it) rows)
""
)))))
(format "|%s|\n|--|\n%s" table-title table)))
(org-table-align))
(defun org-kanban/version ()
"Print org-kanban version."
(interactive)
(message "org-kanban 0.6.10"))
(defun org-kanban--scope-action (button)
"Set scope from a BUTTON."
(let* (
(parameters (button-get button 'parameters))
(scope (plist-get parameters :scope))
(delete (button-get button 'delete)))
(if delete
(plist-put parameters :scope nil)
(let* (
(default-scope (if scope (format "%s" scope) nil))
(new-scope (read-string "Scope: " default-scope)))
(plist-put parameters :scope new-scope)))
(org-kanban//show-configure-buffer
(button-get button 'buffer)
(button-get button 'beginning)
parameters)))
(defun org-kanban--layout-action (button)
"Set layout from a BUTTON."
(let* (
(parameters (button-get button 'parameters))
(layout (plist-get parameters :layout))
(delete (button-get button 'delete)))
(if delete
(plist-put parameters :layout nil)
(let* (
(default-s (if layout (car layout) (car org-kanban/layout)))
(default-max (if layout (cdr layout) (cdr org-kanban/layout)))
(s (read-string "Abbreviation: " default-s))
(max (read-string "Max width: " (format "%s" default-max))))
(plist-put parameters :layout (cons s max))))
(org-kanban//show-configure-buffer
(button-get button 'buffer)
(button-get button 'beginning)
parameters)))
(defun org-kanban--match-action (button)
"Set the current match string from a BUTTON."
(let* (
(parameters (button-get button 'parameters))
(match (plist-get parameters :match))
(delete (button-get button 'delete)))
(if delete
(plist-put parameters :match nil)
(plist-put parameters :match
(let ((match-default (if match match "")))
(read-from-minibuffer "Match string: " match-default))))
(org-kanban//show-configure-buffer
(button-get button 'buffer)
(button-get button 'beginning)
parameters)))
(defun org-kanban--mirrored-button-action (button)
"Set the current mirrored setting from a BUTTON."
(let* (
(parameters (button-get button 'parameters))
(mirrored (plist-get parameters :mirrored)))
(plist-put parameters :mirrored (not mirrored))
(org-kanban//show-configure-buffer
(button-get button 'buffer)
(button-get button 'beginning)
parameters)))
(defun org-kanban--dynamicblock-from-parameters (parameters)
"Create heading of a dynamic block from PARAMETERS."
(let* (
(mirrored (plist-get parameters :mirrored))
(match (plist-get parameters :match))
(layout (plist-get parameters :layout))
(scope (plist-get parameters :scope))
(compressed (plist-get parameters :compressed)))
(s-join " " (delq nil
(list "#+BEGIN: kanban"
(if mirrored ":mirrored t")
(if match (format " :match \"%s\"" match))
(if layout (format " :layout (\"%s\" . %s)" (car layout) (cdr layout)))
(if scope (format " :scope %s" scope))
(if compressed " :compressed t")
)))))
(defun org-kanban--calculate-preview (mirrored match layout scope range sort-spec-string depth compressed)
"Calculate the org-kanban header.
State is passed in MIRRORED, MATCH, LAYOUT, SCOPE, RANGE, SORT-SPEC-STRING,
DEPTH and COMPRESSED."
(s-join " " (delq nil
(list "#+BEGIN: kanban"
(if mirrored ":mirrored t")
(if (and match (> (length match) 0))
(format ":match \"%s\"" match))
(if layout (format ":layout (\"%s\" . %s)" (car layout) (cdr layout)))
(format ":scope %s" scope)
(if range (format ":range (\"%s\" . \"%s\")" (car
range)
(cdr range)))
(if (and sort-spec-string (> (length sort-spec-string) 0))
(format ":sort \"%s\"" sort-spec-string))
(if (and depth (> (length depth) 0))
(format ":depth %s" depth))
(if compressed ":compressed t")
))))
(defun org-kanban--update-preview (preview mirrored match layout scope range sort-spec-string depth compressed)
"Update the PREVIEW widget with the org-kanban header.
State is passed in MIRRORED, MATCH, LAYOUT, SCOPE, RANGE, SORT-SPEC-STRING,
DEPTH and COMPRESSED."
(widget-value-set preview (org-kanban--calculate-preview mirrored match layout scope range sort-spec-string depth compressed)))
(defun org-kanban//show-configure-buffer (buffer beginning parameters)
"Create the configuration form for BUFFER.
BEGINNING the position there and
PARAMETERS the org-kanban parameters."
(switch-to-buffer "*org-kanban-configure*")
(let (
(inhibit-read-only t)
(mirrored (plist-get parameters :mirrored))
(compressed (plist-get parameters :compressed))
(match (plist-get parameters :match))
(scope (plist-get parameters :scope))
(range (plist-get parameters :range))
(sort-spec-string (plist-get parameters :sort))
(layout (or (plist-get parameters :layout) org-kanban/layout))
(depth (format "%s" (or (plist-get parameters :depth) "")))
(preview nil)
(match-widget nil)
(range-from-widget nil)
(range-to-widget nil)
(sort-spec-widget nil)
(depth-widget nil)
)
(erase-buffer)
(remove-overlays)
(widget-insert (propertize "Mirrored: " 'face 'font-lock-keyword-face))
(widget-create 'toggle
:value mirrored
:notify (lambda (widget &rest _ignore)
(setq mirrored (widget-value widget))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed)))
(widget-insert (propertize " see https://theagileist.wordpress.com/tag/mirrored-kanban-board/ for details" 'face 'font-lock-doc-face))
(widget-insert "\n\n")
(widget-insert (propertize "Match: " 'face 'font-lock-keyword-face))
(setq match-widget (widget-create 'editable-field
:value (format "%s" (or match ""))
:size 30
:notify (lambda (widget &rest _ignore)
(setq match (widget-value widget))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))))
(widget-insert " ")
(widget-create 'push-button
:notify (lambda (_widget &rest _ignore)
(widget-value-set match-widget "")
(setq match nil)
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))
(propertize "Delete" 'face 'font-lock-string-face))
(widget-insert "\n")
(widget-insert (propertize " match to tags e.g. urgent|important" 'face 'font-lock-doc-face))
(widget-insert "\n\n")
(widget-insert (propertize "Range:\n" 'face 'font-lock-keyword-face))
(widget-insert (propertize " from: " 'face 'font-lock-keyword-face))
(setq range-from-widget (widget-create 'editable-field
:value (format "%s" (or (car range) ""))
:size 7
:notify (lambda (widget &rest _ignore)
(setq range (cons (widget-value widget) (cdr range)))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))))
(widget-insert (propertize " to: " 'face 'font-lock-keyword-face))
(setq range-to-widget (widget-create 'editable-field
:value (format "%s" (or (cdr range) ""))
:size 7
:notify (lambda (widget &rest _ignore)
(setq range (cons (car range) (widget-value widget)))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))))
(widget-insert " ")
(widget-create 'push-button
:notify (lambda (_widget &rest _ignore)
(widget-value-set range-from-widget "")
(widget-value-set range-to-widget "")
(setq range nil)
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))
(propertize "Delete" 'face 'font-lock-string-face))
(widget-insert "\n")
(widget-insert (propertize " from and to should be keywords" 'face 'font-lock-doc-face))
(widget-insert "\n\n")
(widget-insert (propertize "Layout:\n" 'face 'font-lock-keyword-face))
(widget-insert (propertize " Abbreviation: " 'face 'font-lock-keyword-face))
(widget-create 'editable-field
:value (format "%s" (if layout (car layout) ""))
:size 5
:notify (lambda (widget &rest _ignore)
(setq layout (cons (widget-value widget) (cdr layout)))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed)))
(widget-insert (propertize " Max-width: " 'face 'font-lock-keyword-face))
(widget-create 'editable-field
:value (format "%s" (if layout (cdr layout) ""))
:size 1
:notify (lambda (widget &rest _ignore)
(setq layout (cons (car layout) (widget-value widget)))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed)))
(widget-insert "\n")
(widget-insert (propertize " max-width should be bigger then the length of the abbreviation" 'face 'font-lock-doc-face))
(widget-insert "\n\n")
(widget-insert (propertize "Scope " 'face 'font-lock-keyword-face))
(let ((default-file-list (cond
((eq scope 'tree) "(file1.org file2.org ...)")
((eq scope nil) "(file1.org file2.org dir ...)")
(t (format "%s" scope)))))
(widget-create 'menu-choice
:tag "change type"
:value (cond
((eq scope 'tree) "tree")
((eq scope nil) "nil")
(t (format "%s" scope)))
:notify (lambda (widget &rest _ignore)
(let ((scope-string (widget-value widget)))
(setq scope
(cond
((string-equal scope-string "tree") "tree")
((string-equal scope-string "nil") nil)
(t (let (
(_ (setq default-file-list scope-string))
(res (car (read-from-string scope-string))))
res))))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed)))
:value-set (lambda (widget &rest value)
(widget-default-value-set widget
(cond
((equal value '("tree")) "tree")
((equal value '("nil")) "nil")
(t (format "%s" default-file-list)))))
'(item :tag "tree" :menu-tag "tree" :value "tree")
'(item :tag "whole file" :menu-tag "whole file" :value "nil")
'(editable-field :menu-tag "list of files" default-file-list)))
(widget-insert (propertize " Scope of the org-kanban table.\n" 'face 'font-lock-doc-face))
(widget-insert (propertize " - nil (current buffer)\n" 'face 'font-lock-doc-face))
(widget-insert (propertize " - tree (in the current buffer)\n" 'face 'font-lock-doc-face))
(widget-insert (propertize " - list of files or directories\n" 'face 'font-lock-doc-face))
(widget-insert (propertize " - function returning a string that is compatible with org-link-open-from-string\n" 'face 'font-lock-doc-face))
(widget-insert "\n")
(widget-insert (propertize "Sort Spec: " 'face 'font-lock-keyword-face))
(setq sort-spec-widget (widget-create 'editable-field
:value (format "%s" (or sort-spec-string ""))
:size 30
:notify (lambda (widget &rest _ignore)
(setq sort-spec-string (widget-value widget))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))))
(widget-insert " ")
(widget-create 'push-button
:notify (lambda (_widget &rest _ignore)
(widget-value-set sort-spec-widget "")
(setq sort-spec-string nil)
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))
(propertize "Delete" 'face 'font-lock-string-face))
(widget-insert "\n")
(widget-insert (propertize " Sort spec use a combination of todo[o/O]order and [p/P]riority" 'face 'font-lock-doc-face))
(widget-insert "\n\n")
(widget-insert (propertize "Depth: " 'face 'font-lock-keyword-face))
(setq depth-widget (widget-create 'editable-field
:value (format "%s" (or depth ""))
:size 3
:notify (lambda (widget &rest _ignore)
(setq depth (or (widget-value widget) ""))
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))))
(widget-insert " ")
(widget-create 'push-button
:notify (lambda (_widget &rest _ignore)
(widget-value-set depth-widget "")
(setq depth "")
(org-kanban--update-preview preview mirrored match layout scope range sort-spec-string depth compressed))