mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-09-05 19:42:54 +00:00
* lisp/org-attach.el Changed the way attachments deal with property-inheritance. It now adheres to the =org-use-property-inheritance= setting by default but it can be customized if needed (I recommend to enable it!). The property ATTACH_DIR is deprecated in favour of the shorter and simpler property DIR. Added an explicit option to =org-attach= for unsetting attachment-directories (i.e. remove DIR property and deal with the attachments by interaction). Added attachment link type with the prefix "attachment:". Added customizations: - org-attach-dir-relative - org-attach-preferred-new-method - org-attach-use-inheritance - org-attach-id-to-path-function Hooks added: - org-attach-after-change-hook - org-attach-open-hook A new linktype "attachment" is added in order to reduce link-duplication when wanting to link to files in attached folders of nodes. This works for both ID and DIR properties. The goal is to make the functionality for attachment links mirror the functionality for file links. * lisp/org-attach-git.el New file, existing functionality. Code here has been factored out from org-attach.el and if GIT-functionality is to be used this module needs to be required sepatately. It extends org-attach by use of its hooks. Activating git functionality in org-attach is done by loading org-attach-git from now on, instead of customizing a variable. Naming of both functions and tests has been modified to match the move of functionality into its own module. * lisp/org.el Inline images are shown also using attachment-links, exactly the same as it works for file-links today. Make org-open-at-point respect ARG when opening attachment-dir. * lisp/org-compat.el org-attach-directory has been deprecated in favour for org-attach-id-dir. The new name matches its purpose better. * lisp/ox-html.el Export attachment links to images as inline images, in the same way as file links work today. * etc/ORG-NEWS Mention the changes in this patch. * doc/org-manual.org The chapter "Refile, Copy, Archive" has been split into two separate chapters. - "Refile, Copy and Archiving" for information related to moving existing data around. - "Capture, Attachments, RSS Feeds and Protocols" for information related to working with external data. The attachment-part has been rewritten and extended to match the changes in this patch. The new attachment link type is mentioned both inside the attachments chapter and in the chapter dealing with links. Documentation related to external links has been improved. * testing/lisp/test-org-attach-annex.el Require org-attach-git instead of org-attach, since this file tests the GIT-functionality. * testing/lisp/test-org-attach.el Add tests for org-attach. * testing/org-test.el Define a symbol for a file to test attachments with. * testing/examples/* A bunch of new example files and folders are created and are used in testing of org-attach to verify its functionality.
160 lines
5.5 KiB
EmacsLisp
160 lines
5.5 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)
|
||
(require 'org-attach)
|
||
(eval-and-compile (require 'cl-lib))
|
||
|
||
(ert-deftest test-org-attach/dir ()
|
||
"Test `org-attach-get' specifications."
|
||
(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)))))
|
||
(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))))))
|
||
(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 get's 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.
|
||
(unwind-protect
|
||
(org-test-with-temp-text-in-file
|
||
"* foo :foo:"
|
||
(split-window)
|
||
(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)
|
||
(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.
|
||
(unwind-protect
|
||
(org-test-with-temp-text-in-file
|
||
"* foo"
|
||
(split-window)
|
||
(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)
|
||
(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
|