mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-09-30 13:07:47 +00:00
129c33dddf
- Removed the global (defvar date) and (defvar entry) so as not to conflict with function arguments of that name. Instead I added such `defvar`s in the body of each of the functions where it seemed needed. - I added some FIXMEs for some issues I found along the way. - Added an `org-dlet` macro, just like I had done for `calendar-dlet`, but I also use `defvar` "manually" at some places, when splitting an existing `let` into a mix of `let`s and `dlet`s seemed too much trouble. - Removed uses of `org-let and `org-let2` not only because I consider them offensive to my sense of aesthetics but also because they're basically incompatible with lexical scoping. I replaced them with uses of `cl-progv` which are a bit more verbose. Maybe we should define some `org-progv` macro on top of `cl-progv` to make the code less verbose, but I didn't do that because I like the fact that the current code makes uses of `eval` a bit more obvious (since these behave differently with lexical scoping than with lexical binding, it seemed worthwhile). - Removed the use of `eval` in `org-store-agenda-views` which was only placed there in order to use a macro before it's defined (it would have been simpler/cleaner to just move that functions *after* the macro, but with the new code the problem doesn't occur any more anyway). - Replaced a few `(lambda...) with actual closures. Detailed changes follow: (date, entry): Don't declare as being globally dynbound. (org-agenda-format-date-aligned): Remove unused var `weekyear`. (org-agenda-mode): `run-mode-hooks` is always available nowadays. (org-agenda-undo): Remove unused var `last-undo-buffer`. (org-agenda): Rename arg to `keys` and then dyn-bind it as `org-keys`. Remove unused vars `buf` and `key`. (org-agenda): Use `pcase` and `cl-progv` instead of `org-let`. (org-let, org-let2): Mark as obsolete. (org-agenda-run-series): Use `cl-progv` instead of `org-let` and `org-let2`. (org-agenda-run-series): New function. (org--batch-agenda): New function extracted from `org-batch-agenda`. (org-batch-agenda): Use it. (org--batch-agenda-csv): New function extracted from `org-batch-agenda-csv`. (org-batch-agenda-csv): Use it. (org--batch-store-agenda-views): New function, extracted from `org-batch-store-agenda-views`. (org-store-agenda-views, org-batch-store-agenda-views): Use it. (org--batch-store-agenda-views): Use `cl-progv` instead of `org-eval-in-environment`. (org-agenda-write): Use `cl-progv` instead of `org-let`. Use `with-current-buffer`. (org-agenda-filter-any): Use `cl-some` instead of `eval`. (org-agenda-list): Remove unused var `e`. (org-search-view): η-reduce. (crm-separator): Declare var. (org-agenda-skip-if): Remove unused var `beg`. (org-agenda-list-stuck-projects): Use a closure rather than `(lambda..). (diary-modify-entry-list-string-function, diary-file-name-prefix) (diary-display-function): Declare vars. (org-diary): Declare `date` and `entry` as dynbound. (org-agenda-get-day-entries): Use `org-dlet`. (org-agenda-get-timestamps, org-agenda-get-progress) (org-agenda-get-deadlines, org-agenda-get-scheduled, org-agenda-get-blocks): Declare `date` as dynbound. (org-agenda-get-sexps, org-class): Declare `date` and `entry` as dynbound. (org-agenda-format-item): Declare the vars mentioned in `org-compile-prefix-format` as dyn-bound. Also binding `extra`, suggested by Kyle Meyer <kyle@kyleam.com>. (org-compile-prefix-format): Remove unused var `e`. Use `member` rather than or+equal. (org-set-sorting-strategy): Minor simplification. (org-entries-lessp): Use `org-dlet`. (org-agenda-redo): Declare var `org-agenda-tag-filter-while-redo`. (org-agenda-redo): Use `cl-progv` rather than `org-let`. (org-agenda-filter): Remove unused var `rpl-fn`. Use `org-pushnew-to-end` to replace `add-to-list` on lexical var. (org-agenda-filter-by-tag): Remove unused var `n`. (org-agenda-filter-apply): Use `org-dlet`. (org-agenda-compute-starting-span): Remove unused var `dg`. (org-agenda-forward-block): Remove unused var `pos`. (org-archive-from-agenda): Declare var. (org-agenda-refile): Remove unused var `pos`. (org-agenda-headline-snapshot-before-repeat): Declare var. (org-agenda-todo): Remove redundant use of `bound-and-true-p`. (org-agenda-add-note): Remove unused var `hdmarker` and unused `arg`. (org-agenda-change-all-lines): Remove unused var `pl`. (org-agenda-priority): Remove unused var `marker`. (org-agenda-set-effort): Remove unused var `newhead`. (org-agenda-schedule): Remove unused var `type`. (org-agenda-clock-cancel): Remove unused `arg`. (org-agenda-execute-calendar-command): Use `org-dlet`. (org-agenda-bulk-action): Use closures instead of `(lambda ...). (org-agenda-show-the-flagging-note): Remove unused vars `heading` and `newhead`. (org-agenda-remove-flag): Avoid `setq`. * testing/org-test.el (org--compile-when): New macro. (org-test-jump): Use it so compilation doesn't fail or generate broken code when `jump` is not available. * testing/lisp/test-org-src.el: * testing/lisp/test-org-attach.el: * testing/lisp/test-org-agenda.el: * testing/lisp/test-ob-java.el: Pass explicit filename to `require` so as not to rely on ".../testing" being in `load-path` during compilation. * lisp/org-num.el: Require` org`. * lisp/org-macs.el (org-eval-in-environment): Declare obsolete. (org-dlet, org-pushnew-to-end): New macros. * doc/Makefile (org.texi, orgguide.texi, %_letter.tex): Simplify quoting. * contrib/lisp/ob-sclang.el: Don't crash compilation when `sclang` is not available. * contrib/lisp/ob-clojure-literate.el: Don't crash compilation when `cider` is not available. * contrib/lisp/ob-arduino.el: Don't crash compilation when `arduino-mode` is not available. * .gitignore: Add files generated during `make packages/org`.
175 lines
6.3 KiB
EmacsLisp
175 lines
6.3 KiB
EmacsLisp
;;; test-org-attach.el --- tests for org-attach.el -*- lexical-binding: t; -*-
|
||
|
||
;; Copyright (C) 2017, 2019
|
||
|
||
;; Author: Marco Wahl
|
||
;; Keywords: internal
|
||
|
||
;; This program is free software; you can redistribute it and/or modify
|
||
;; it under the terms of the GNU General Public License as published by
|
||
;; the Free Software Foundation, either version 3 of the License, or
|
||
;; (at your option) any later version.
|
||
|
||
;; This program is distributed in the hope that it will be useful,
|
||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
;; GNU General Public License for more details.
|
||
|
||
;; You should have received a copy of the GNU General Public License
|
||
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
||
;;; Commentary:
|
||
|
||
;;
|
||
|
||
;;; Code:
|
||
|
||
(require 'org-test "../testing/org-test")
|
||
(require 'org-attach)
|
||
(eval-and-compile (require 'cl-lib))
|
||
|
||
(ert-deftest test-org-attach/dir ()
|
||
"Test `org-attach-get' specifications."
|
||
(let ((org-file-apps '((t . emacs))))
|
||
(should (equal "Text in fileA\n"
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 157) ;; First attachment link
|
||
(org-open-at-point)
|
||
(buffer-string))))
|
||
(should-not (equal "Text in fileB\n"
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 219) ;; Second attachment link
|
||
(let ((org-attach-use-inheritance nil))
|
||
(org-open-at-point)
|
||
(buffer-string)))))
|
||
(should (equal "Text in fileB\n"
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 219) ;; Second attachment link
|
||
(let ((org-attach-use-inheritance t))
|
||
(org-open-at-point)
|
||
(buffer-string)))))
|
||
(should-not (equal "att1"
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 179) ;; H1.1
|
||
(let ((org-attach-use-inheritance nil))
|
||
(org-attach-dir)))))
|
||
(should (equal "att1"
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 179) ;; H1.1
|
||
(let ((org-attach-use-inheritance t))
|
||
(org-attach-dir)))))
|
||
(should (equal '("fileC" "fileD")
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 239) ;; H1.2
|
||
(org-attach-file-list (org-attach-dir)))))
|
||
(should (equal '("fileC" "fileD")
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 239) ;; H1.2
|
||
(org-attach-file-list (org-attach-dir)))))
|
||
(should (equal '("fileE")
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 289) ;; H2
|
||
(let ((org-attach-id-dir "data/"))
|
||
(org-attach-file-list (org-attach-dir))))))
|
||
(should (equal "peek-a-boo\n"
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 289) ;; H2
|
||
(let ((org-attach-id-dir "data/"))
|
||
(org-attach-open-in-emacs)
|
||
(buffer-string)))))
|
||
(should (equal '("fileA" "fileB")
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 336) ;; H3
|
||
(org-attach-file-list (org-attach-dir)))))
|
||
;; Test for folder not initialized in the filesystem
|
||
(should-not (org-test-in-example-file org-test-attachments-file
|
||
(goto-char 401) ;; H3.1
|
||
(let ((org-attach-use-inheritance nil)
|
||
(org-attach-id-dir "data/"))
|
||
(org-attach-dir))))
|
||
;; Not yet initialized folder should be found if no-fs-check is
|
||
;; non-nil
|
||
(should (equal "data/ab/cd12345"
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 401) ;; H3.1
|
||
(let ((org-attach-use-inheritance nil)
|
||
(org-attach-id-dir "data/"))
|
||
(file-relative-name (org-attach-dir nil t))))))
|
||
(should (equal '("fileA" "fileB")
|
||
(org-test-in-example-file org-test-attachments-file
|
||
(goto-char 401) ;; H3.1
|
||
(let ((org-attach-use-inheritance t))
|
||
;; This is where it gets a bit sketchy...! DIR always has
|
||
;; priority over ID, even if ID is declared "higher up" in the
|
||
;; tree. This can potentially be revised. But it is also
|
||
;; pretty clean. DIR is always higher in priority than ID right
|
||
;; now, no matter the depth in the tree.
|
||
(org-attach-file-list (org-attach-dir))))))))
|
||
|
||
(ert-deftest test-org-attach/dired-attach-to-next-best-subtree/1 ()
|
||
"Attach file at point in dired to subtree."
|
||
(should
|
||
(let ((a-filename (make-temp-file "a")) ; file is an attach candidate.
|
||
(org-attach-id-dir "data/"))
|
||
(unwind-protect
|
||
(org-test-with-temp-text-in-file
|
||
"* foo :foo:"
|
||
(split-window)
|
||
(let ((org-buffer (current-buffer))
|
||
(dired-buffer (dired temporary-file-directory)))
|
||
(cl-assert (eq 'dired-mode major-mode))
|
||
(revert-buffer)
|
||
(dired-goto-file a-filename)
|
||
; action
|
||
(call-interactively #'org-attach-dired-to-subtree)
|
||
; check
|
||
(delete-window)
|
||
(switch-to-buffer org-buffer)
|
||
(cl-assert (eq 'org-mode major-mode)))
|
||
(beginning-of-buffer)
|
||
(search-forward "* foo")
|
||
; expectation. tag ATTACH has been appended.
|
||
(cl-reduce (lambda (x y) (or x y))
|
||
(mapcar (lambda (x) (string-equal "ATTACH" x))
|
||
(plist-get
|
||
(plist-get
|
||
(org-element-at-point) 'headline) :tags))))
|
||
(delete-file a-filename)))))
|
||
|
||
(ert-deftest test-org-attach/dired-attach-to-next-best-subtree/2 ()
|
||
"Attach 2 marked files."
|
||
(should
|
||
(let ((a-filename (make-temp-file "a"))
|
||
(b-filename (make-temp-file "b")) ; attach candidates.
|
||
(org-attach-id-dir "data/"))
|
||
(unwind-protect
|
||
(org-test-with-temp-text-in-file
|
||
"* foo"
|
||
(split-window)
|
||
(let ((org-buffer (current-buffer))
|
||
(dired-buffer (dired temporary-file-directory)))
|
||
(cl-assert (eq 'dired-mode major-mode))
|
||
(revert-buffer)
|
||
(dired-goto-file a-filename)
|
||
(dired-mark 1)
|
||
(dired-goto-file b-filename)
|
||
(dired-mark 1)
|
||
; action
|
||
(call-interactively #'org-attach-dired-to-subtree)
|
||
; check
|
||
(delete-window)
|
||
(switch-to-buffer org-buffer))
|
||
(cl-assert (eq 'org-mode major-mode))
|
||
(beginning-of-buffer)
|
||
(search-forward "* foo")
|
||
(and (file-exists-p (concat (org-attach-dir) "/"
|
||
(file-name-nondirectory a-filename)))
|
||
(file-exists-p (concat (org-attach-dir) "/"
|
||
(file-name-nondirectory b-filename)))))
|
||
(delete-file a-filename)
|
||
(delete-file b-filename)))))
|
||
|
||
|
||
(provide 'test-org-attach)
|
||
;;; test-org-attach.el ends here
|