Show horizons buffer on clarify if option is true

Work on #126

org-gtd-clarify.el

@@ -26,6 +26,18 @@
 
 (require 'org-gtd-id)
 
+(defgroup org-gtd-clarify nil
+  "Customize the behavior when clarifying an item."
+  :package-version '(org-gtd . "3.0")
+  :group 'org-gtd)
+
+(defcustom org-gtd-clarify-show-horizons nil
+  "When t, show a side buffer with the higher horizons during item clarification.
+The file shown can be configured in `org-gtd-horizons-file'"
+  :package-version '(org-gtd . "3.0")
+  :group 'org-gtd-clarify
+  :type 'boolean)
+
 (defconst org-gtd-clarify--prefix "Org-GTD WIP")
 
 (defvar-local org-gtd-clarify--window-config nil
@@ -44,6 +56,19 @@
 (defvar org-gtd-clarify-map (make-sparse-keymap)
   "Keymap for command `org-gtd-clarify-mode', a minor mode.")
 
+;; code to make windows atomic, from emacs manual
+;; (let ((window (split-window-right)))
+;;   (window-make-atom (window-parent window))
+;;   (display-buffer-in-atom-window
+;;    (get-buffer-create "*Messages*")
+;;    `((window . ,(window-parent window)) (window-height . 5))))
+
+;; code to make windows non-atomic
+;; (walk-window-subtree (lambda (window) (set-window-parameter window 'window-atom nil)) (window-parent (get-buffer-window (current-buffer))) t)
+
+;; dedicated side window
+;; (display-buffer-in-side-window (get-buffer "horizons.org") '((side . right) (dedicated . t)))
+
 ;;;###autoload
 (define-minor-mode org-gtd-clarify-mode
   "Minor mode for org-gtd."
@@ -74,7 +99,10 @@
                   org-gtd-clarify--clarify-id (org-id-get)))
     (set-buffer processing-buffer)
     (display-buffer processing-buffer)
-    (delete-other-windows (get-buffer-window processing-buffer))))
+    (delete-other-windows (get-buffer-window processing-buffer))
+    (display-buffer-in-side-window
+     (org-gtd--horizons-file)
+     '((side . right) (dedicated . t)))))
 
 ;;;###autoload
 (defun org-gtd-clarify-inbox-item ()

org-gtd-core.el

@@ -46,6 +46,15 @@ your own files if you want multiple refile targets (projects, etc.)."
   :package-version '(org-gtd . "0.1")
   :type 'directory)
 
+(defcustom org-gtd-horizons-file "horizons.org"
+  "File holding your GTD horizons.
+
+This may get displayed during item clarification for context and focus. This file
+must be in the `org-gtd-directory'."
+  :group 'org-gtd
+  :package-version '(org-gtd . "3.0")
+  :type 'file)
+
 (defcustom org-gtd-next "NEXT"
   "The org-mode keyword for an action ready to be done. Just the word."
   :group 'org-gtd

org-gtd-files.el

@@ -34,34 +34,42 @@ This is the inbox. Everything goes in here when you capture it.
 "
   "Template for the GTD inbox.")
 
-;; TODO remove this entirely
-(defconst org-gtd-file-header "")
-
-
 (defconst org-gtd-default-file-name "org-gtd-tasks")
 
+(defconst org-gtd-file-horizons-template
+  "* Purpose and principles (why)
+* Vision (what)
+* Goals
+* Areas of focus / accountabilities
+")
+
 ;;;###autoload
 (defun org-gtd-inbox-path ()
   "Return the full path to the inbox file."
   (let ((path (org-gtd--path org-gtd-inbox)))
     (org-gtd--ensure-file-exists path org-gtd-inbox-template)
     path))
 
+(defun org-gtd--horizons-file ()
+  (let ((path (f-join org-gtd-directory org-gtd-horizons-file)))
+    (org-gtd--ensure-file-exists path org-gtd-file-horizons-template)
+    (find-file-noselect path)))
+
 (defun org-gtd--inbox-file ()
   "Create or return the buffer to the GTD inbox file."
   (find-file-noselect (org-gtd-inbox-path)))
 
 (defun org-gtd--default-file ()
   "Create or return the buffer to the default GTD file."
   (let ((path (org-gtd--path org-gtd-default-file-name)))
-    (org-gtd--ensure-file-exists path org-gtd-file-header)
+    (org-gtd--ensure-file-exists path)
     (find-file-noselect path)))
 
-(defun org-gtd--ensure-file-exists (path initial-contents)
+(defun org-gtd--ensure-file-exists (path &optional initial-contents)
   "Create the file at PATH with INITIAL-CONTENTS if it does not exist."
   (unless (f-exists-p path)
     (with-current-buffer (find-file-noselect path)
-      (insert initial-contents)
+      (insert (or initial-contents ""))
       (org-gtd-core-prepare-buffer)
       (basic-save-buffer))))
 

test/files-test.el

@@ -8,8 +8,7 @@
 
 (describe "Create a default file"
 
-  (before-each
-   (ogt--configure-emacs))
+  (before-each (ogt--configure-emacs))
   (after-each (ogt--close-and-delete-files))
 
   (describe "with default content"

test/helpers/utils.el

@@ -27,14 +27,17 @@ Return the buffer visiting that file."
   (let ((filename (make-temp-file basename nil ".org" text)))
     (find-file-noselect filename)))
 
-(defun create-additional-project-target (filename)
-  (let* ((file (f-join org-gtd-directory (format "%s.org" filename)))
+(defun ogt--create-org-file-in-org-gtd-dir (basename &optional initial-contents)
+  (let* ((file (f-join org-gtd-directory (format "%s.org" basename)))
          (buffer (find-file-noselect file)))
     (with-current-buffer buffer
-      (insert ogt--base-project-heading)
+      (insert (or initial-contents ""))
       (basic-save-buffer))
     buffer))
 
+(defun create-additional-project-target (filename)
+  (ogt--create-org-file-in-org-gtd-dir filename ogt--base-project-heading))
+
 (defun ogt--buffer-string (buffer)
   "Return buffer's content."
   (with-current-buffer buffer

test/horizons-test.el

@@ -0,0 +1,59 @@
+;; -*- lexical-binding: t; coding: utf-8 -*-
+
+(load "test/helpers/setup.el")
+(load "test/helpers/utils.el")
+(require 'org-gtd)
+(require 'buttercup)
+(require 'with-simulated-input)
+
+(describe
+ "Higher horizons"
+
+ (before-each (ogt--configure-emacs))
+ (after-each (ogt--close-and-delete-files))
+
+ (describe
+  "when org-gtd should show the horizons"
+
+  (before-each (setq org-gtd-clarify-show-horizons t))
+  (after-each (setq org-gtd-clarify-show-horizons nil))
+
+  (describe
+   "when we clarify an item"
+
+   (it "creates a templated file when there isn't one"
+       (ogt--add-single-item "Add a configuration option")
+       (org-gtd-process-inbox)
+       (expect (get-buffer-window "horizons.org")
+               :not :to-be
+               nil)
+       (expect (get-buffer-window (car (org-gtd-clarify--get-buffers)))
+               :not :to-be
+               nil)
+       )
+
+   (it "shows the existing file if there is one"
+       (ogt--create-org-file-in-org-gtd-dir
+        "horizons"
+        "We are the champions")
+       (ogt--add-single-item "Add a configuration option")
+       (org-gtd-process-inbox)
+       (expect (get-buffer-window "horizons.org")
+               :not :to-be
+               nil)
+       (expect (get-buffer-window (car (org-gtd-clarify--get-buffers)))
+               :not :to-be
+               nil)
+       (expect (ogt--buffer-string "horizons.org")
+               :to-match
+               "We are the champions")))
+  (describe
+  "when we return to a WIP buffer"
+  ))
+
+
+ (describe
+  "when org-gtd should not show the horizons"
+  (before-each (setq org-gtd-clarify-show-horizons nil))
+  (after-each (setq org-gtd-clarify-show-horizons nil))
+  ))