From: Erik Hetzner <egh@e6h.org>
To: emacs-orgmode@gnu.org
Cc: Kyle Meyer <kyle@kyleam.com>
Subject: Re: [PATCH] org-attach.el: Fetch attachments from git annex
Date: Sun, 24 Jan 2016 21:24:32 -0800 [thread overview]
Message-ID: <56a5b193.ca77420a.1551e.667c@mx.google.com> (raw)
In-Reply-To: <568c6aaa.c345620a.7f4da.6359@mx.google.com>
* org-attach.el (org-attach-use-annex): New function to check if git
annex should be used.
(org-attach-annex-fetch-maybe): New function to fetch a file from git
annex if necessary.
(org-annex-open): Automatically fetch attached files from git annex when
opening if necessary.
* testing/lisp/test-org-annex.el: New file for testing org-attach. Only
contains code for testing org-attach with git annex at the moment.
---
I have finally updated this patch per the feedback on the list. I have also
added some tests of the git annex attach code.
Thanks for all the feedback.
lisp/org-attach.el | 46 +++++++++++++++--------
testing/lisp/test-org-attach.el | 81 +++++++++++++++++++++++++++++++++++++++++
2 files changed, 111 insertions(+), 16 deletions(-)
create mode 100644 testing/lisp/test-org-attach.el
diff --git a/lisp/org-attach.el b/lisp/org-attach.el
index e6ad4b1..3500e26 100644
--- a/lisp/org-attach.el
+++ b/lisp/org-attach.el
@@ -270,6 +270,22 @@ the ATTACH_DIR property) their own attachment directory."
(org-entry-put nil "ATTACH_DIR_INHERIT" "t")
(message "Children will inherit attachment directory"))
+(defun org-attach-use-annex ()
+ "Return non-nil if git annex can be used."
+ (let ((git-dir (vc-git-root (expand-file-name org-attach-directory))))
+ (and org-attach-git-annex-cutoff
+ (or (file-exists-p (expand-file-name "annex" git-dir))
+ (file-exists-p (expand-file-name ".git/annex" git-dir))))))
+
+(defun org-attach-annex-fetch-maybe (path)
+ "Fetch PATH from git annex if necessary."
+ (when (and (org-attach-use-annex)
+ (not (string-equal "found"
+ (shell-command-to-string
+ (format "git annex find --format=found --in=here %s" (shell-quote-argument path))))))
+ (message "Fetching \"%s\" using git annex." path)
+ (call-process "git" nil nil nil "annex" "get" path)))
+
(defun org-attach-commit ()
"Commit changes to git if `org-attach-directory' is properly initialized.
This checks for the existence of a \".git\" directory in that directory."
@@ -279,20 +295,16 @@ This checks for the existence of a \".git\" directory in that directory."
(when (and git-dir (executable-find "git"))
(with-temp-buffer
(cd dir)
- (let ((have-annex
- (and org-attach-git-annex-cutoff
- (or (file-exists-p (expand-file-name "annex" git-dir))
- (file-exists-p (expand-file-name ".git/annex" git-dir))))))
- (dolist (new-or-modified
- (split-string
- (shell-command-to-string
- "git ls-files -zmo --exclude-standard") "\0" t))
- (if (and have-annex
- (>= (nth 7 (file-attributes new-or-modified))
- org-attach-git-annex-cutoff))
- (call-process "git" nil nil nil "annex" "add" new-or-modified)
- (call-process "git" nil nil nil "add" new-or-modified))
- (incf changes)))
+ (dolist (new-or-modified
+ (split-string
+ (shell-command-to-string
+ "git ls-files -zmo --exclude-standard") "\0" t))
+ (if (and (org-attach-use-annex)
+ (>= (nth 7 (file-attributes new-or-modified))
+ org-attach-git-annex-cutoff))
+ (call-process "git" nil nil nil "annex" "add" new-or-modified)
+ (call-process "git" nil nil nil "add" new-or-modified))
+ (incf changes))
(dolist (deleted
(split-string
(shell-command-to-string "git ls-files -z --deleted") "\0" t))
@@ -465,8 +477,10 @@ If IN-EMACS is non-nil, force opening in Emacs."
(file (if (= (length files) 1)
(car files)
(completing-read "Open attachment: "
- (mapcar #'list files) nil t))))
- (org-open-file (expand-file-name file attach-dir) in-emacs)))
+ (mapcar #'list files) nil t)))
+ (path (expand-file-name file attach-dir)))
+ (org-attach-annex-fetch-maybe path)
+ (org-open-file path in-emacs)))
(defun org-attach-open-in-emacs ()
"Open attachment, force opening in Emacs.
diff --git a/testing/lisp/test-org-attach.el b/testing/lisp/test-org-attach.el
new file mode 100644
index 0000000..7f435bd
--- /dev/null
+++ b/testing/lisp/test-org-attach.el
@@ -0,0 +1,81 @@
+;;; test-org-attach.el --- Tests for Org Attach
+;;
+;; Copyright (c) 2016 Erik Hetzner
+;; Authors: Erik Hetzner
+
+;; This file is not part of GNU Emacs.
+
+;; 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/>.
+
+;;; Code:
+(require 'org-attach)
+
+(cl-defmacro test-org-attach-annex/with-annex (&body body)
+ `(let ((tmpdir (make-temp-file "org-annex-test" t)))
+ (unwind-protect
+ (let ((default-directory tmpdir)
+ (org-attach-directory tmpdir))
+ (shell-command "git init")
+ (shell-command "git annex init")
+ ,@body))))
+
+(ert-deftest test-org-attach/use-annex ()
+ (org-test-for-executable "git-annex")
+ ;; (skip-unless (test-org-attach-annex/installed))
+ (test-org-attach-annex/with-annex
+ (let ((org-attach-git-annex-cutoff 1))
+ (should (org-attach-use-annex)))
+
+ (let ((org-attach-git-annex-cutoff nil))
+ (should-not (org-attach-use-annex))))
+
+ ;; test with non annex directory
+ (let ((tmpdir (make-temp-file "org-annex-test" t)))
+ (unwind-protect
+ (let ((default-directory tmpdir)
+ (org-attach-directory tmpdir))
+ (shell-command "git init")
+ (should-not (org-attach-use-annex)))
+ (delete-directory tmpdir 'recursive))))
+
+(ert-deftest test-org-attach/fetch-maybe ()
+ (org-test-for-executable "git-annex")
+ ;; (skip-unless (test-org-attach-annex/installed))
+ (test-org-attach-annex/with-annex
+ (let ((path (expand-file-name "test-file"))
+ (annex-dup (make-temp-file "org-annex-test" t)))
+ (with-temp-buffer
+ (insert "hello world\n")
+ (write-file path))
+ (shell-command "git annex add test-file")
+ (shell-command "git annex sync")
+ ;; Set up remote & copy files there
+ (let ((annex-original default-directory)
+ (default-directory annex-dup))
+ (shell-command (format "git clone %s ." (shell-quote-argument annex-original)))
+ (shell-command "git annex init dup")
+ (shell-command (format "git remote add original %s" (shell-quote-argument annex-original)))
+ (shell-command "git annex get test-file")
+ (shell-command "git annex sync"))
+ (shell-command (format "git remote add dup %s" (shell-quote-argument annex-dup)))
+ (shell-command "git annex sync")
+ (shell-command "git annex drop --force test-file")
+ ;; test getting the file from the dup
+ (org-attach-annex-fetch-maybe (expand-file-name "test-file"))
+ ;; check that the file has the right contents
+ (with-temp-buffer
+ (insert-file-contents path)
+ (should (string-equal "hello world\n" (buffer-string)))))))
+
+;;; test-org-attach.el ends here
--
2.5.0
next prev parent reply other threads:[~2016-01-25 5:24 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-01-05 5:09 [PATCH] org-attach.el: Fetch attachments from git annex Erik Hetzner
2016-01-05 5:30 ` Eric Abrahamsen
2016-01-05 6:11 ` Erik Hetzner
2016-01-05 6:36 ` Kyle Meyer
2016-01-05 9:56 ` Rasmus
2016-01-05 17:14 ` Kyle Meyer
2016-01-05 18:16 ` Rasmus
2016-01-05 19:30 ` Kyle Meyer
2016-01-05 21:55 ` Rasmus
2016-01-06 5:43 ` Kyle Meyer
2016-01-06 1:27 ` Erik Hetzner
2016-01-06 9:37 ` Rasmus
2016-01-05 6:21 ` Kyle Meyer
2016-01-06 1:15 ` Erik Hetzner
2016-01-25 5:24 ` Erik Hetzner [this message]
2016-01-25 21:19 ` Rasmus
2016-01-25 4:34 ` Erik Hetzner
2016-01-26 7:40 ` Kyle Meyer
2016-01-26 16:39 ` Erik Hetzner
2016-01-26 17:34 ` Kyle Meyer
2016-01-26 22:04 ` Rasmus
2016-01-25 4:34 ` [PATCH] org-attach.el: Get " Erik Hetzner
2016-01-27 22:20 ` Rasmus
2016-02-01 3:32 ` Erik Hetzner
2016-01-29 5:39 ` Kyle Meyer
2016-01-25 4:34 ` Erik Hetzner
2016-02-05 2:41 ` Kyle Meyer
2016-02-06 12:18 ` Rasmus
2016-02-07 17:15 ` Erik Hetzner
2016-02-07 20:48 ` Achim Gratz
2016-02-09 5:25 ` Erik Hetzner
2016-02-09 19:40 ` Achim Gratz
2016-02-09 21:12 ` Erik Hetzner
2016-02-09 22:19 ` Achim Gratz
2016-02-11 2:24 ` Erik Hetzner
2016-02-11 18:57 ` Achim Gratz
2016-02-09 5:40 ` [PATCH] testing/lisp/test-org-attach-annex.el: New file Erik Hetzner
2016-02-14 11:50 ` Achim Gratz
2016-01-26 5:31 ` [PATCH] org-attach.el: Fetch attachments from git annex Erik Hetzner
2016-01-26 22:10 ` Rasmus
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=56a5b193.ca77420a.1551e.667c@mx.google.com \
--to=egh@e6h.org \
--cc=emacs-orgmode@gnu.org \
--cc=kyle@kyleam.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).