[elpa] externals/org 6bbd08f5aa: org-datetree-insert-line: Fix blank line insertion

[ELPA Syncer]

branch: externals/org
commit 6bbd08f5aa81bd0b6b2b2f448a858516f388702a
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    org-datetree-insert-line: Fix blank line insertion
    
    * lisp/org-datetree.el (org-datetree-insert-line): Use
    `org--blank-before-heading-p' check.
    
    * testing/lisp/test-org-datetree.el (test-org-datetree/find-date-create):
    (test-org-datetree/find-month-create):
    (test-org-datetree/find-iso-week-create): Explicitly set
    `org-blank-before-new-entry' assumed throughout the tests.
    
    Note that the `auto' behavior in `org-blank-before-new-entry' is
    somewhat arbitrary.  It currently prefers no blank lines by
    default (when no other headings are present in the buffer).  I went
    with fixing the tests rather than changing
    `org--blank-before-heading-p' to prefer inserting blank lines.  This
    should make lesser impact on the end users.
    
    Reported-by: Richard Walker <walkerrichardj@gmail.com>
    Link: 
https://list.orgmode.org/orgmode/CAFyNgSE4mAt+b0Ks8L9bg2LbHcXnayOh+bYyONTQ4jN+zx3C1w@mail.gmail.com/
---
 lisp/org-datetree.el              |   3 +-
 testing/lisp/test-org-datetree.el | 373 +++++++++++++++++++-------------------
 2 files changed, 189 insertions(+), 187 deletions(-)

diff --git a/lisp/org-datetree.el b/lisp/org-datetree.el
index a24472a954..fb4df3cbe8 100644
--- a/lisp/org-datetree.el
+++ b/lisp/org-datetree.el
@@ -188,8 +188,7 @@ inserted into the buffer."
 
 (defun org-datetree-insert-line (year &optional month day text)
   (delete-region (save-excursion (skip-chars-backward " \t\n") (point)) 
(point))
-  (when (assq 'heading org-blank-before-new-entry)
-    (insert "\n"))
+  (when (org--blank-before-heading-p) (insert "\n"))
   (insert "\n" (make-string org-datetree-base-level ?*) " \n")
   (backward-char)
   (when month (org-do-demote))
diff --git a/testing/lisp/test-org-datetree.el 
b/testing/lisp/test-org-datetree.el
index c66668466a..1f0169397c 100644
--- a/testing/lisp/test-org-datetree.el
+++ b/testing/lisp/test-org-datetree.el
@@ -26,197 +26,200 @@
 (ert-deftest test-org-datetree/find-date-create ()
   "Test `org-datetree-find-date-create' specifications."
   ;; When date is missing, create it.
-  (should
-   (string-match
-    "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
-    (org-test-with-temp-text ""
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (org-trim (buffer-string)))))
-  ;; Do not create new year node when one exists.
-  (should
-   (string-match
-    "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
-    (org-test-with-temp-text "* 2012\n"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (org-trim (buffer-string)))))
-  ;; Do not create new month node when one exists.
-  (should
-   (string-match
-    "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
-    (org-test-with-temp-text "* 2012\n\n** 2012-03 month"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (org-trim (buffer-string)))))
-  ;; Do not create new day node when one exists.
-  (should
-   (string-match
-    "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
-    (org-test-with-temp-text "* 2012\n\n** 2012-03 month\n\n*** 2012-03-29 day"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (org-trim (buffer-string)))))
-  ;; Sort new entry in right place.
-  (should
-   (string-match
-    "\\`\\* 2012\n\n\\*\\* 2012-02 .*\n\n\\*\\*\\* 2012-02-01 .*\n\n\\*\\* 
2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
-    (org-test-with-temp-text "* 2012\n\n** 2012-03 month\n\n*** 2012-03-29 day"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-date-create '(3 29 2012))
-       (org-datetree-find-date-create '(2 1 2012)))
-      (org-trim (buffer-string)))))
-  ;; When `org-datetree-add-timestamp' is non-nil, insert a timestamp
-  ;; in entry.  When set to `inactive', insert an inactive one.
-  (should
-   (string-match
-    "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* \\(2012-03-29\\) .*\n[ 
\t]*<\\1.*?>\\'"
-    (org-test-with-temp-text "* 2012\n"
-      (let ((org-datetree-add-timestamp t))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (org-trim (buffer-string)))))
-  (should
-   (string-match
-    "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* \\(2012-03-29\\) .*\n[ 
\t]*\\[\\1.*?\\]\\'"
-    (org-test-with-temp-text "* 2012\n"
-      (let ((org-datetree-add-timestamp 'inactive))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (org-trim (buffer-string)))))
-  ;; Insert at top level, unless some node has DATE_TREE property.  In
-  ;; this case, date tree becomes one of its sub-trees.
-  (should
-   (string-match
-    "\\* 2012"
-    (org-test-with-temp-text "* Top"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (org-trim (buffer-string)))))
-  (should
-   (string-match
-    "\\*\\* H1.1\n:PROPERTIES:\n:DATE_TREE: t\n:END:\n\n\\*\\*\\* 2012"
-    (org-test-with-temp-text
-       "* H1\n\n** H1.1\n:PROPERTIES:\n:DATE_TREE: t\n:END:\n\n* H2"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (org-trim (buffer-string)))))
-  ;; Always leave point at beginning of day entry.
-  (should
-   (string-match
-    "\\*\\*\\* 2012-03-29"
-    (org-test-with-temp-text "* 2012\n\n** 2012-03 month\n\n*** 2012-03-29 day"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (buffer-substring (point) (line-end-position)))))
-  (should
-   (string-match
-    "\\*\\*\\* 2012-03-29"
-    (org-test-with-temp-text "* 2012\n\n** 2012-03 month\n\n*** 2012-03-29 day"
-      (let ((org-datetree-add-timestamp t))
-       (org-datetree-find-date-create '(3 29 2012)))
-      (buffer-substring (point) (line-end-position))))))
+  (let ((org-blank-before-new-entry '((heading . t))))
+    (should
+     (string-match
+      "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
+      (org-test-with-temp-text ""
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (org-trim (buffer-string)))))
+    ;; Do not create new year node when one exists.
+    (should
+     (string-match
+      "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
+      (org-test-with-temp-text "* 2012\n"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (org-trim (buffer-string)))))
+    ;; Do not create new month node when one exists.
+    (should
+     (string-match
+      "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
+      (org-test-with-temp-text "* 2012\n\n** 2012-03 month"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (org-trim (buffer-string)))))
+    ;; Do not create new day node when one exists.
+    (should
+     (string-match
+      "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
+      (org-test-with-temp-text "* 2012\n\n** 2012-03 month\n\n*** 2012-03-29 
day"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (org-trim (buffer-string)))))
+    ;; Sort new entry in right place.
+    (should
+     (string-match
+      "\\`\\* 2012\n\n\\*\\* 2012-02 .*\n\n\\*\\*\\* 2012-02-01 .*\n\n\\*\\* 
2012-03 .*\n\n\\*\\*\\* 2012-03-29 .*\\'"
+      (org-test-with-temp-text "* 2012\n\n** 2012-03 month\n\n*** 2012-03-29 
day"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-date-create '(3 29 2012))
+         (org-datetree-find-date-create '(2 1 2012)))
+        (org-trim (buffer-string)))))
+    ;; When `org-datetree-add-timestamp' is non-nil, insert a timestamp
+    ;; in entry.  When set to `inactive', insert an inactive one.
+    (should
+     (string-match
+      "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* \\(2012-03-29\\) .*\n[ 
\t]*<\\1.*?>\\'"
+      (org-test-with-temp-text "* 2012\n"
+        (let ((org-datetree-add-timestamp t))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (org-trim (buffer-string)))))
+    (should
+     (string-match
+      "\\`\\* 2012\n\n\\*\\* 2012-03 .*\n\n\\*\\*\\* \\(2012-03-29\\) .*\n[ 
\t]*\\[\\1.*?\\]\\'"
+      (org-test-with-temp-text "* 2012\n"
+        (let ((org-datetree-add-timestamp 'inactive))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (org-trim (buffer-string)))))
+    ;; Insert at top level, unless some node has DATE_TREE property.  In
+    ;; this case, date tree becomes one of its sub-trees.
+    (should
+     (string-match
+      "\\* 2012"
+      (org-test-with-temp-text "* Top"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (org-trim (buffer-string)))))
+    (should
+     (string-match
+      "\\*\\* H1.1\n:PROPERTIES:\n:DATE_TREE: t\n:END:\n\n\\*\\*\\* 2012"
+      (org-test-with-temp-text
+         "* H1\n\n** H1.1\n:PROPERTIES:\n:DATE_TREE: t\n:END:\n\n* H2"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (org-trim (buffer-string)))))
+    ;; Always leave point at beginning of day entry.
+    (should
+     (string-match
+      "\\*\\*\\* 2012-03-29"
+      (org-test-with-temp-text "* 2012\n\n** 2012-03 month\n\n*** 2012-03-29 
day"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (buffer-substring (point) (line-end-position)))))
+    (should
+     (string-match
+      "\\*\\*\\* 2012-03-29"
+      (org-test-with-temp-text "* 2012\n\n** 2012-03 month\n\n*** 2012-03-29 
day"
+        (let ((org-datetree-add-timestamp t))
+         (org-datetree-find-date-create '(3 29 2012)))
+        (buffer-substring (point) (line-end-position)))))))
 
 (ert-deftest test-org-datetree/find-month-create ()
   "Test `org-datetree-find-month-create' specifications."
-  ;; When date is missing, create it with the entry under month.
-  (should
-   (string-match
-    "\\`\\* 2012\n\n\\*\\* 2012-03 .*\\'"
-    (org-test-with-temp-text ""
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-month-create '(3 29 2012)))
-      (org-trim (buffer-string))))))
+  (let ((org-blank-before-new-entry '((heading . t))))
+    ;; When date is missing, create it with the entry under month.
+    (should
+     (string-match
+      "\\`\\* 2012\n\n\\*\\* 2012-03 .*\\'"
+      (org-test-with-temp-text ""
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-month-create '(3 29 2012)))
+        (org-trim (buffer-string)))))))
 
 (ert-deftest test-org-datetree/find-iso-week-create ()
   "Test `org-datetree-find-iso-date-create' specificaiton."
-  ;; When date is missing, create it.
-  (should
-   (string-match
-    "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\\'"
-    (org-test-with-temp-text ""
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  ;; Do not create new year node when one exists.
-  (should
-   (string-match
-    "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\\'"
-    (org-test-with-temp-text "* 2015\n"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  ;; Do not create new month node when one exists.
-  (should
-   (string-match
-    "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\\'"
-    (org-test-with-temp-text "* 2015\n\n** 2015-W01"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  ;; Do not create new day node when one exists.
-  (should
-   (string-match
-    "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\\'"
-    (org-test-with-temp-text "* 2015\n\n** 2015-W01\n\n*** 2014-12-31 day"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  ;; Sort new entry in right place.
-  (should
-   (string-match
-    "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\n\n\\*\\* 
2015-W36\n\n\\*\\*\\* 2015-09-01 .*\\'"
-    (org-test-with-temp-text "* 2015"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-iso-week-create '(9 1 2015))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  ;; When `org-datetree-add-timestamp' is non-nil, insert a timestamp
-  ;; in entry.  When set to `inactive', insert an inactive one.
-  (should
-   (string-match
-    "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* \\(2014-12-31\\) .*\n[ 
\t]*<\\1.*?>\\'"
-    (org-test-with-temp-text "* 2015\n"
-      (let ((org-datetree-add-timestamp t))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  (should
-   (string-match
-    "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* \\(2014-12-31\\) .*\n[ 
\t]*\\[\\1.*?\\]\\'"
-    (org-test-with-temp-text "* 2015\n"
-      (let ((org-datetree-add-timestamp 'inactive))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  ;; Insert at top level, unless some node has WEEK_TREE property.  In
-  ;; this case, date tree becomes one of its sub-trees.
-  (should
-   (string-match
-    "\\* 2015"
-    (org-test-with-temp-text "* Top"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  (should
-   (string-match
-    "\\*\\* H1.1\n:PROPERTIES:\n:WEEK_TREE: t\n:END:\n\n\\*\\*\\* 2015"
-    (org-test-with-temp-text
-       "* H1\n** H1.1\n:PROPERTIES:\n:WEEK_TREE: t\n:END:\n\n* H2"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (org-trim (buffer-string)))))
-  ;; Always leave point at beginning of day entry.
-  (should
-   (string-match
-    "\\*\\*\\* 2014-12-31"
-    (org-test-with-temp-text "* 2015\n\n** 2015-W01\n\n*** 2014-12-31 day"
-      (let ((org-datetree-add-timestamp nil))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (buffer-substring (point) (line-end-position)))))
-  (should
-   (string-match
-    "\\*\\*\\* 2014-12-31"
-    (org-test-with-temp-text "* 2015\n\n** 2015-W01\n\n*** 2014-12-31 day"
-      (let ((org-datetree-add-timestamp t))
-       (org-datetree-find-iso-week-create '(12 31 2014)))
-      (buffer-substring (point) (line-end-position))))))
+  (let ((org-blank-before-new-entry '((heading . t))))
+    ;; When date is missing, create it.
+    (should
+     (string-match
+      "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\\'"
+      (org-test-with-temp-text ""
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    ;; Do not create new year node when one exists.
+    (should
+     (string-match
+      "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\\'"
+      (org-test-with-temp-text "* 2015\n"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    ;; Do not create new month node when one exists.
+    (should
+     (string-match
+      "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\\'"
+      (org-test-with-temp-text "* 2015\n\n** 2015-W01"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    ;; Do not create new day node when one exists.
+    (should
+     (string-match
+      "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\\'"
+      (org-test-with-temp-text "* 2015\n\n** 2015-W01\n\n*** 2014-12-31 day"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    ;; Sort new entry in right place.
+    (should
+     (string-match
+      "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* 2014-12-31 .*\n\n\\*\\* 
2015-W36\n\n\\*\\*\\* 2015-09-01 .*\\'"
+      (org-test-with-temp-text "* 2015"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-iso-week-create '(9 1 2015))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    ;; When `org-datetree-add-timestamp' is non-nil, insert a timestamp
+    ;; in entry.  When set to `inactive', insert an inactive one.
+    (should
+     (string-match
+      "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* \\(2014-12-31\\) .*\n[ 
\t]*<\\1.*?>\\'"
+      (org-test-with-temp-text "* 2015\n"
+        (let ((org-datetree-add-timestamp t))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    (should
+     (string-match
+      "\\`\\* 2015\n\n\\*\\* 2015-W01\n\n\\*\\*\\* \\(2014-12-31\\) .*\n[ 
\t]*\\[\\1.*?\\]\\'"
+      (org-test-with-temp-text "* 2015\n"
+        (let ((org-datetree-add-timestamp 'inactive))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    ;; Insert at top level, unless some node has WEEK_TREE property.  In
+    ;; this case, date tree becomes one of its sub-trees.
+    (should
+     (string-match
+      "\\* 2015"
+      (org-test-with-temp-text "* Top"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    (should
+     (string-match
+      "\\*\\* H1.1\n:PROPERTIES:\n:WEEK_TREE: t\n:END:\n\n\\*\\*\\* 2015"
+      (org-test-with-temp-text
+         "* H1\n** H1.1\n:PROPERTIES:\n:WEEK_TREE: t\n:END:\n\n* H2"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (org-trim (buffer-string)))))
+    ;; Always leave point at beginning of day entry.
+    (should
+     (string-match
+      "\\*\\*\\* 2014-12-31"
+      (org-test-with-temp-text "* 2015\n\n** 2015-W01\n\n*** 2014-12-31 day"
+        (let ((org-datetree-add-timestamp nil))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (buffer-substring (point) (line-end-position)))))
+    (should
+     (string-match
+      "\\*\\*\\* 2014-12-31"
+      (org-test-with-temp-text "* 2015\n\n** 2015-W01\n\n*** 2014-12-31 day"
+        (let ((org-datetree-add-timestamp t))
+         (org-datetree-find-iso-week-create '(12 31 2014)))
+        (buffer-substring (point) (line-end-position)))))))
 
 (provide 'test-org-datetree)
 ;;; test-org-datetree.el ends here