aboutsummaryrefslogtreecommitdiffstats
path: root/scrumelo.el
blob: 74564f7367d8ad3b67bf75c1d33b1762f5623a8f (plain)
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
;;; scrumelo.el --- Scrum with elnode and org-mode

;; Copyright (C) 2013  Tom Willemse

;; Author: Tom Willemse <tom@ryuslash.org>
;; Keywords: tools, hypermedia, outlines, comm

;;; Commentary:

;; A scrum web app.

(require 'elnode)
(require 'esxml)
(require 'org)

;;; Code:

(defvar scrumelo-project-file "~/projects/scrumelo/aeos.org"
  "The file containing the scrum backlog.")

(defvar scrumelo--base-dir
  (if load-file-name
      (file-name-directory load-file-name)
    default-directory)
  "The current directory.")

(defvar scrumelo-bootstrap-css-location
  "http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css"
  "The location of the twitter bootstrap CSS file.")

(defvar scrumelo-bootstrap-js-location
  "http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"
  "The location of the twitter bootstrap JS file.")

(defvar scrumelo-font-awesome-css-location
  "http://netdna.bootstrapcdn.com/font-awesome/3.1.1/css/font-awesome.min.css"
  "The location of the font awesome CSS file.")

(defvar scrumelo-jquery-js-location
  "http://code.jquery.com/jquery-2.0.0.min.js"
  "The location of the jQuery JS file.")

(defmacro with-scrumelo-http-params (params httpcon &rest body)
  "Bind parameters PARAMS from HTTPCON and execute BODY."
  `(let (,@(mapcar (lambda (p)
                     `(,p (elnode-http-param ,httpcon ,(symbol-name p))))
                   params))
     ,@body))
(put 'with-scrumelo-http-params 'lisp-indent-function 2)

(defun scrumelo--css (href)
  "Return a link pointing to HREF."
  `(link (@ (href ,href) (rel "stylesheet") (type "text/css"))))

(defun scrumelo--css-list ()
  "Return a list of all required CSS files."
  (list (scrumelo--css scrumelo-bootstrap-css-location)
        (scrumelo--css scrumelo-font-awesome-css-location)))

(defun scrumelo--js (src)
  "Return a script sourcing SRC."
  `(script (@ (src ,src) (language "JavaScript")
              (type "text/javascript")) ""))

(defun scrumelo--js-list ()
  "Return a list of all required JS files."
  (list (scrumelo--js scrumelo-bootstrap-js-location)
        (scrumelo--js scrumelo-jquery-js-location)
        (scrumelo--js "js/scrumelo.js")))

(defun scrumelo--story ()
  "Return a description of the current org heading as a scrum story."
  (format "As a %s, I %s to %s" (org-entry-get (point) "Role")
          (org-entry-get (point) "Necessity")
          (nth 4 (org-heading-components))))

(defun scrumelo--task-state-class (state)
  "Return the correct icon class for STATE."
  (cdr (assoc state '(("TODO" . "icon-check-empty")
                      ("DOING" . "icon-sign-blank")
                      ("DONE" . "icon-check")))))

(defun scrumelo--story-row ()
  "Return a table row for the current org headline."
  (let ((state (org-entry-get (point) "TODO")))
    `(tr (td (i (@ (class ,(scrumelo--task-state-class state))) "")
             " " ,state)
         (td (a (@ (id ,(org-id-get))
                   (onclick "return get_story_info(this)"))
                ,(scrumelo--story))))))

(defun scrumelo--maybe-story-row ()
  "If looking at a top level heading, return a table row for it."
  (when (= (car (org-heading-components)) 1)
    (scrumelo--story-row)))

(defun scrumelo--inner-story-table (buffer)
  "Return the inner part of the story table for BUFFER."
  (with-current-buffer buffer
    (delq nil (org-map-entries
               'scrumelo--maybe-story-row nil nil 'comment))))

(defun scrumelo--story-table (buffer)
  "Return the story table for BUFFER."
  `(table (@ (class "table table-striped"))
          ,@(scrumelo--inner-story-table buffer)))

(defun scrumelo--new-story-form ()
  "Create a form for adding new stories."
  `(form (@ (method "POST")
            (action "/stories/new/"))
         (fieldset
          (legend (@ (class "toggle")
                     (data-show "new-story")) "New story")
          (div (@ (id "new-story")
                  (class "hide")
                  (style "text-align: center;"))
               (div (@ (class "input-prepend input-append"))
                    (span (@ (class "add-on")) "As a ")
                    (input (@ (class "input-medium") (type "text")
                              (name "role")))
                    (span (@ (class "add-on")) " I ")
                    (input (@ (class "input-mini") (type "text")
                              (name "necessity")))
                    (span (@ (class "add-on")) " to ")
                    (input (@ (class "input-xxlarge") (type "text")
                              (name "headline")))
                    (button (@ (class "btn") (type "submit")) "!"))))))

(defun scrumelo-backlog-page (httpcon)
  "Send the backlog overview over HTTPCON."
  (let ((buffer (find-file-noselect scrumelo-project-file)))
    (elnode-http-start httpcon 200 '("Content-Type" . "text/html"))
    (elnode-http-return
     httpcon
     (concat
      "<!DOCTYPE html>\n"
      (sxml-to-xml
       `(html (head (title "Scrumelo")
                    ,@(scrumelo--css-list)
                    ,@(scrumelo--js-list))
              (body
               (div (@ (class "container"))
                    ,(scrumelo--story-table buffer)
                    ,(scrumelo--new-story-form)))))))))

(defun scrumelo-new-story (httpcon)
  "Parse data from HTTPCON and write a new scrum story using it."
  (elnode-method httpcon
    (POST
     (let ((buffer (find-file-noselect scrumelo-project-file)))
       (with-scrumelo-http-params (role necessity headline) httpcon
         (with-current-buffer buffer
           (goto-char (point-max))
           (insert "\n* TODO " headline)
           (org-set-property "Role" role)
           (org-set-property "Necessity" necessity)
           (save-buffer))))
     (elnode-send-redirect httpcon "/"))))

(defun scrumelo--send-json (httpcon obj)
  "Respond to HTTPCON with OBJ converted to a json structure."
  (elnode-http-start httpcon 200 '("Content-Type" . "text/json"))
  (elnode-http-return httpcon (json-encode obj)))

(defun scrumelo-story-json (httpcon)
  "Repsond to HTTPCON with some json info about a story."
  (let* ((story (match-string 1 (elnode-http-mapping httpcon)))
         (buffer (find-file-noselect scrumelo-project-file))
         (entry (cdr (org-id-find story))))
    (with-current-buffer buffer
      (goto-char entry)
      (scrumelo--send-json
       httpcon (list (cons 'Assignee (org-entry-get (point) "Assignee"))
                     (cons 'content (buffer-substring-no-properties
                                     (org-end-of-meta-data-and-drawers)
                                     (org-entry-end-position))))))))

(defun scrumelo-handler (httpcon)
  "Send the right requests in HTTPCON to the right functions."
  (elnode-dispatcher
   httpcon
   `(("^/$" . scrumelo-backlog-page)
     ("^/js/scrumelo.js" . ,(elnode-make-send-file
                             (concat scrumelo--base-dir "js/scrumelo.js")))
     ("^/stories/new/$" . scrumelo-new-story)
     ("^/stories/\\([a-z0-9:-]+\\)/$" . scrumelo-story-json))))

(elnode-start 'scrumelo-handler :port 8028 :host "localhost")

(provide 'scrumelo)
;;; scrumelo.el ends here