summaryrefslogtreecommitdiff
path: root/tests/test-custom-buffer-file-copy-buffer-source.el
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test-custom-buffer-file-copy-buffer-source.el')
-rw-r--r--tests/test-custom-buffer-file-copy-buffer-source.el144
1 files changed, 144 insertions, 0 deletions
diff --git a/tests/test-custom-buffer-file-copy-buffer-source.el b/tests/test-custom-buffer-file-copy-buffer-source.el
new file mode 100644
index 00000000..c4e073ae
--- /dev/null
+++ b/tests/test-custom-buffer-file-copy-buffer-source.el
@@ -0,0 +1,144 @@
+;;; test-custom-buffer-file-copy-buffer-source.el --- Tests for cj/copy-buffer-source-as-kill -*- lexical-binding: t; -*-
+
+;;; Commentary:
+;; Tests the dispatch behavior of `cj/copy-buffer-source-as-kill', the
+;; major-mode-aware extension of the old
+;; `cj/copy-path-to-buffer-file-as-kill' (which is kept as a
+;; `defalias' for backwards compat).
+;;
+;; Dispatch tiers:
+;; eww-mode -> (eww-current-url)
+;; elfeed-show-mode -> (elfeed-entry-link elfeed-show-entry)
+;; dired-mode -> (dired-get-filename nil t)
+;; dirvish-mode -> (dired-get-filename nil t)
+;; doc-view-mode -> buffer-file-name
+;; pdf-view-mode -> buffer-file-name
+;; anything else -> buffer-file-name fallback (errors if nil)
+
+;;; Code:
+
+(require 'ert)
+(require 'cl-lib)
+
+(add-to-list 'load-path (expand-file-name "modules" user-emacs-directory))
+(require 'custom-buffer-file)
+
+;; Top-level defvars so let-bindings reach the dynamic var under
+;; lexical scope (and stand-ins for vars defined in modes we don't
+;; require here).
+(defvar elfeed-show-entry nil)
+
+;;; Fallback to buffer-file-name
+
+(ert-deftest test-copy-buffer-source-falls-back-to-buffer-file-name ()
+ "Normal: a file-visiting buffer with no special dispatch falls back
+to `buffer-file-name'."
+ (let (kill-ring)
+ (with-temp-buffer
+ (setq buffer-file-name "/tmp/notes.txt")
+ (fundamental-mode)
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (cj/copy-buffer-source-as-kill))
+ (should (equal (car kill-ring) "/tmp/notes.txt")))))
+
+(ert-deftest test-copy-buffer-source-errors-on-nil-source ()
+ "Error: a buffer with no file and no mode dispatch signals a user-error."
+ (with-temp-buffer
+ (fundamental-mode)
+ (setq buffer-file-name nil)
+ (should-error (cj/copy-buffer-source-as-kill) :type 'user-error)))
+
+;;; eww-mode dispatch
+
+(ert-deftest test-copy-buffer-source-eww-copies-current-url ()
+ "Normal: in eww-mode, copy `(eww-current-url)'."
+ (let (kill-ring)
+ (cl-letf (((symbol-function 'eww-current-url)
+ (lambda () "https://example.org/article")))
+ (with-temp-buffer
+ (setq major-mode 'eww-mode)
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (cj/copy-buffer-source-as-kill))
+ (should (equal (car kill-ring) "https://example.org/article"))))))
+
+;;; elfeed-show-mode dispatch
+
+(ert-deftest test-copy-buffer-source-elfeed-copies-entry-link ()
+ "Normal: in elfeed-show-mode, copy the entry's link."
+ (let ((kill-ring nil)
+ (elfeed-show-entry (list :link "https://feed.test/post/42")))
+ (cl-letf (((symbol-function 'elfeed-entry-link)
+ (lambda (entry) (plist-get entry :link))))
+ (with-temp-buffer
+ (setq major-mode 'elfeed-show-mode)
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (cj/copy-buffer-source-as-kill))
+ (should (equal (car kill-ring) "https://feed.test/post/42"))))))
+
+;;; dired-mode dispatch
+
+(ert-deftest test-copy-buffer-source-dired-copies-file-at-point ()
+ "Normal: in dired-mode, copy the absolute path of the file at point
+(not the dired buffer's `default-directory')."
+ (let (kill-ring)
+ (cl-letf (((symbol-function 'dired-get-filename)
+ (lambda (&optional _localp _no-error)
+ "/home/u/projects/notes.org")))
+ (with-temp-buffer
+ (setq major-mode 'dired-mode)
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (cj/copy-buffer-source-as-kill))
+ (should (equal (car kill-ring) "/home/u/projects/notes.org"))))))
+
+(ert-deftest test-copy-buffer-source-dirvish-copies-file-at-point ()
+ "Normal: dirvish-mode dispatches identically to dired-mode."
+ (let (kill-ring)
+ (cl-letf (((symbol-function 'dired-get-filename)
+ (lambda (&optional _localp _no-error)
+ "/home/u/books/the-book.epub")))
+ (with-temp-buffer
+ (setq major-mode 'dirvish-mode)
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (cj/copy-buffer-source-as-kill))
+ (should (equal (car kill-ring) "/home/u/books/the-book.epub"))))))
+
+;;; doc-view / pdf-view dispatch
+
+(ert-deftest test-copy-buffer-source-doc-view-copies-buffer-file ()
+ "Normal: doc-view-mode copies the underlying file path
+(`buffer-file-name')."
+ (let (kill-ring)
+ (with-temp-buffer
+ (setq buffer-file-name "/home/u/papers/paper.pdf"
+ major-mode 'doc-view-mode)
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (cj/copy-buffer-source-as-kill))
+ (should (equal (car kill-ring) "/home/u/papers/paper.pdf")))))
+
+(ert-deftest test-copy-buffer-source-pdf-view-copies-buffer-file ()
+ "Normal: pdf-view-mode copies the underlying file path."
+ (let (kill-ring)
+ (with-temp-buffer
+ (setq buffer-file-name "/home/u/books/manual.pdf"
+ major-mode 'pdf-view-mode)
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (cj/copy-buffer-source-as-kill))
+ (should (equal (car kill-ring) "/home/u/books/manual.pdf")))))
+
+;;; Backwards-compat alias
+
+(ert-deftest test-copy-path-old-name-aliases-new-command ()
+ "Backwards compat: `cj/copy-path-to-buffer-file-as-kill' still
+resolves to the new `cj/copy-buffer-source-as-kill' via defalias."
+ (should (eq (symbol-function 'cj/copy-path-to-buffer-file-as-kill)
+ 'cj/copy-buffer-source-as-kill)))
+
+;;; Keybinding
+
+(ert-deftest test-copy-buffer-source-bound-on-b-p ()
+ "Normal: `p' in `cj/buffer-and-file-map' invokes the new command."
+ (should (eq (keymap-lookup cj/buffer-and-file-map "p")
+ #'cj/copy-buffer-source-as-kill)))
+
+(provide 'test-custom-buffer-file-copy-buffer-source)
+;;; test-custom-buffer-file-copy-buffer-source.el ends here