[elpa] externals/denote 983c2e7ad4 2/3: Revert "Remove denote-user-enforced-denote-directory"

[ELPA Syncer]

branch: externals/denote
commit 983c2e7ad452c764b6f06e2f02e907e1cc30d813
Author: Jean-Philippe Gagné Guay <jeanphilippe150@gmail.com>
Commit: Jean-Philippe Gagné Guay <jeanphilippe150@gmail.com>

    Revert "Remove denote-user-enforced-denote-directory"
    
    This reverts commit 49a060817bd7b2eb194c66851ca8538577cb42e8.
---
 README.org               | 22 +++++++++++++---------
 denote-journal-extras.el |  2 +-
 denote-silo-extras.el    |  6 +++---
 denote.el                | 37 +++++++++++++++++++++++++++----------
 tests/denote-test.el     | 10 ++++++++++
 5 files changed, 54 insertions(+), 23 deletions(-)

diff --git a/README.org b/README.org
index 9aa4c8f50d..745c3b9ff9 100644
--- a/README.org
+++ b/README.org
@@ -863,6 +863,7 @@ read the video's path when called from there (e.g. by using 
Emacs'
 
 [[#h:15719799-a5ff-4e9a-9f10-4ca03ef8f6c5][Maintain separate directory silos 
for notes]].
 
+#+vindex: denote-user-enforced-denote-directory
 There are cases where the user (i) wants to maintain multiple silos
 and (ii) prefers an interactive way to switch between them without
 going through Dired.  Since this is specific to the user's workflow,
@@ -899,7 +900,7 @@ added to the user's Denote configuration:
          (intern (completing-read
                   "Run command in silo: "
                   my-denote-commands-for-silos nil t))))
-  (let ((denote-directory silo))
+  (let ((denote-user-enforced-denote-directory silo))
     (call-interactively command)))
 #+end_src
 
@@ -907,12 +908,15 @@ With this in place, =M-x 
my-denote-pick-silo-then-command= will use
 minibuffer completion to select a silo among the predefined options
 and then ask for the command to run in that context.
 
-Note that =let= binding ~denote-directory~ can be used in custom
-commands and other wrapper functions to override the global default
-value of ~denote-directory~ to select silos.
+Note the use of the variable ~user-enforced-denote-directory~. This
+variable is specially meant for custom commands to select silos. When
+it is set, it overrides the global default value of ~denote-directory~
+as well as the value provided by the =.dir-locals.el= file. Use it
+only when writing wrapper functions like
+~my-denote-pick-silo-then-command~.
 
-To see another example of a wrapper function that =let= binds
-~denote-directory~, see:
+To see another example of a wrapper function that uses
+~user-enforced-denote-directory~, see:
 
 [[#h:d0c7cb79-21e5-4176-a6af-f4f68578c8dd][Extending Denote: Split an Org 
subtree into its own note]].
 
@@ -2827,7 +2831,7 @@ Delete the original subtree."
            (heading (org-get-heading :no-tags :no-todo :no-priority 
:no-comment)))
       (let ((element (org-element-at-point))
             (tags (org-get-tags))
-            (denote-directory silo))
+            (denote-user-enforced-denote-directory silo))
         (delete-region (org-entry-beginning-position)
                        (save-excursion (org-end-of-subtree t) (point)))
         (denote heading
@@ -3787,8 +3791,8 @@ might change them without further notice.
   ~denote-directory~ as a proper directory, also because it accepts a
   directory-local value for what we internally refer to as "silos"
   ([[#h:15719799-a5ff-4e9a-9f10-4ca03ef8f6c5][Maintain separate directories 
for notes]]).  Custom Lisp code can
-  ~let~ bind the value of the variable ~denote-directory~ to override
-  what this function returns.
+  ~let~ bind the value of the variable ~denote-user-enforced-denote-directory~
+  to override what this function returns.
 
 #+findex: denote-directory-files
 + Function ~denote-directory-files~ :: Return list of absolute file
diff --git a/denote-journal-extras.el b/denote-journal-extras.el
index 3de7ea48c4..abdd8a4369 100644
--- a/denote-journal-extras.el
+++ b/denote-journal-extras.el
@@ -161,7 +161,7 @@ that covered in the documentation of the `denote' function. 
 It
 is internally processed by `denote-journal-extras--get-date'."
   (interactive (list (when current-prefix-arg (denote-date-prompt))))
   (let ((internal-date (denote-journal-extras--get-date date))
-        (denote-directory (denote-journal-extras-directory)))
+        (denote-user-enforced-denote-directory 
(denote-journal-extras-directory)))
     (denote
      (denote-journal-extras-daily--title-format internal-date)
      `(,denote-journal-extras-keyword)
diff --git a/denote-silo-extras.el b/denote-silo-extras.el
index 7dda51876b..ed1287686c 100644
--- a/denote-silo-extras.el
+++ b/denote-silo-extras.el
@@ -70,7 +70,7 @@ SILO is a file path from `denote-silo-extras-directories'."
    (list
     (when current-prefix-arg
       (denote-silo-extras--directory-prompt))))
-  (let ((denote-directory silo))
+  (let ((denote-user-enforced-denote-directory silo))
     (call-interactively #'denote)))
 
 ;;;###autoload
@@ -81,7 +81,7 @@ SILO is a file path from `denote-silo-extras-directories'."
    (list
     (when current-prefix-arg
       (denote-silo-extras--directory-prompt))))
-  (let ((denote-directory silo))
+  (let ((denote-user-enforced-denote-directory silo))
     (call-interactively #'denote-open-or-create)))
 
 ;;;###autoload
@@ -93,7 +93,7 @@ COMMAND is one among `denote-silo-extras-commands'."
    (list
     (denote-silo-extras--directory-prompt)
     (denote-command-prompt)))
-  (let ((denote-directory silo))
+  (let ((denote-user-enforced-denote-directory silo))
     (call-interactively command)))
 
 (provide 'denote-silo-extras)
diff --git a/denote.el b/denote.el
index 0b438e6af4..eca9146bc8 100644
--- a/denote.el
+++ b/denote.el
@@ -592,23 +592,40 @@ things accordingly.")
         `(metadata (category . ,category))
       (complete-with-action action candidates string pred))))
 
+(defun denote--default-directory-is-silo-p ()
+  "Return path to silo if `default-directory' is a silo."
+  (when-let ((dir-locals (dir-locals-find-file default-directory))
+             ((alist-get 'denote-directory dir-local-variables-alist)))
+    (cond
+     ((listp dir-locals)
+      (car dir-locals))
+     ((stringp dir-locals)
+      dir-locals))))
+
 (defun denote--make-denote-directory ()
   "Make the variable `denote-directory' and its parents, if needed."
   (when (not (file-directory-p denote-directory))
     (make-directory denote-directory :parents)))
 
+(defvar denote-user-enforced-denote-directory nil
+  "Value of the variable `denote-directory'.
+Use this to `let' bind a directory path, thus overriding what the
+function `denote-directory' ordinarily returns.")
+
 (defun denote-directory ()
   "Return path of variable `denote-directory' as a proper directory.
-Custom Lisp code can `let' bind the variable `denote-directory'
-to override what this function returns."
-  (let ((denote-directory (file-name-as-directory (expand-file-name 
denote-directory))))
-    (denote--make-denote-directory)
-    denote-directory))
-
-(make-obsolete
- 'denote-user-enforced-denote-directory
- 'denote-directory
- "3.0.0")
+Custom Lisp code can `let' bind the value of the variable
+`denote-user-enforced-denote-directory' to override what this
+function returns.
+
+Otherwise, the order of precedence is to first check for a silo
+before falling back to the value of the variable
+`denote-directory'."
+  (let ((path (or denote-user-enforced-denote-directory
+                  (denote--default-directory-is-silo-p)
+                  (denote--make-denote-directory)
+                  (default-value 'denote-directory))))
+    (file-name-as-directory (expand-file-name path))))
 
 (defun denote--slug-no-punct (str &optional extra-characters)
   "Remove punctuation from STR.
diff --git a/tests/denote-test.el b/tests/denote-test.el
index 07b15bd019..8b90b6bf60 100644
--- a/tests/denote-test.el
+++ b/tests/denote-test.el
@@ -31,6 +31,16 @@
 (require 'ert)
 (require 'denote)
 
+;; TODO 2023-05-22: Incorporate an actual silo in this test directory
+;; and modify the test accordingly.
+(ert-deftest denote-test-denote--default-directory-is-silo-p ()
+  "Test that `denote--default-directory-is-silo-p' returns a path."
+  (let ((path (denote--default-directory-is-silo-p)))
+    (should (or (null path)
+                (and (stringp path)
+                     (file-exists-p path)
+                     (file-directory-p path))))))
+
 (ert-deftest denote-test--denote--make-denote-directory ()
   "Test that `denote--make-denote-directory' creates the directory."
   (should (null (denote--make-denote-directory))))