mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-08-25 02:32:53 +00:00
Mainly, add the corresponding cookie, but also add various `require`s so that the compiler knows which vars should be trated as dynbound. This does not fix all the warnings, but does try to eliminate all those about "unused" variables. For the variables truly unused, the patch usually adds an underscore to their name to silence the warning. Some of the fixes affect files which already used `lexical-binding`. Not sure why the test worked before: maybe because the tests were run without compiling them first (which could cause some of the missing `require`d packages to be autoloaded before we got to the problematic code, thus hiding the problem)? I found some suspicious code, for which I added FIXMEs. There are also a few changes to the main files. * lisp/org-protocol.el (org-protocol-check-filename-for-protocol): Don't call `server-edit` if it's not yet defined. [ Needed to get the tests to pass. ] * lisp/ob-core.el (org-babel-temporary-directory) (org-babel-temporary-stable-directory): Always define (and use nil if we don't want to create a directory for it). Simplify the code based on the fact that (defvar V E) only evaluates E if V is not yet `boundp`. (org-babel-temp-file, org-babel-temp-stable-file) (org-babel-remove-temporary-directory) (org-babel-remove-temporary-stable-directory): Adjust accordingly. * lisp/org.el (org-log-beginning): Add FIXME. * testing/org-test.el: Require `org` and `org-id`. (org-id-locations-file): Don't `defconst` it. (org-test-at-id, org-test-in-example-file, org-test-at-marker) (org-test-with-temp-text, org-test-with-temp-text-in-file): Move edebug specs into `declare` (and simplify them). (org-test-with-tramp-remote-dir--worker): Declare dynbound tramp vars. (org--compile-when): Fix quoting of `exp`. (org-test-load): Tweak regexps. * testing/org-batch-test-init.el: Tweak regexp, remove dead code and add a FIXME about it. * testing/lisp/test-ox.el: Require `ox` instead of erroring out if it's not already loaded. Also require `org-inlinetask`. (org-test-with-parsed-data): Silence warnings when `info` is not used. (test-org-export/bind-keyword): Add FIXME. * testing/lisp/test-ox-publish.el: Require `org-test` and `ox-publish`. (test-org-publish/resolve-external-link): Expose lambdas to the compiler. Remove unused var `ids`. (test-org-publish/get-project-from-filename): Remove unused var `file`. * testing/lisp/test-org.el: Require `org-macs`, `org`, `org-inlinetask`, `org-refile`, and `org-agenda`. (test-org/org-read-date): Declare `org-time-was-given` as dynbound. (test-org/set-regexps-and-options): Add FIXME. * testing/lisp/test-org-timer.el: Require `org-timer`. * testing/lisp/test-org-table.el: Require `ox`. * testing/lisp/test-org-protocol.el: Require `org-protocol` instead of erroring out if it's not already loaded. Also require `capture`, and add missing `provide` statement. * testing/lisp/test-org-pcomplete.el: Require `org`. * testing/lisp/test-org-list.el: Require `org-list` and `org`. * testing/lisp/test-org-lint.el: Require `org-footnote` and `org-lint`. * testing/lisp/test-org-footnote.el: Require `org-footnote`. * testing/lisp/test-org-element.el: Require `org-element` instead of erroring out if it's not already loaded. Also require `org` and `org-inlinetask`. * testing/lisp/test-org-duration.el: Require `org-duration`. * testing/lisp/test-org-datetree.el: Require `org-datetree`. * testing/lisp/test-org-colview.el: Require `org-colview`, `org-duration`, and `org-inlinetask`. * testing/lisp/test-org-clock.el: Require `org-duration` and `org-clock`. * testing/lisp/test-org-archive.el: Require `org-archive`. * testing/lisp/test-org-agenda.el (test-org-agenda/bulk-custom-arg-func): Add FIXME. * testing/lisp/test-ol.el: Require `ol` and `org-id`. (test-org-link/store-link): Declare `org-store-link-props` and add FIXME. * testing/lisp/test-oc.el (test-org-cite/export-capability): Add FIXME. * testing/lisp/test-ob.el: Require `ob-core`, `org-src`, `ob-ref`, and `org-table`. (test-ob/eval-header-argument): Rename `foo` to `test-ob--foo` and declare it as dynbound. (test-ob/blocks-with-spaces, test-ob/specific-colnames): Add FIXME. (test-ob/noweb-expansions-in-cache): Declare `noweb-expansions-in-cache-var` as dynbound. * testing/lisp/test-ob-tangle.el: Require `org` and `ob-tangle`. * testing/lisp/test-ob-shell.el: * testing/lisp/test-ob-python.el: Require `ob-core`. * testing/lisp/test-ob-lob.el: Require `ob-lob`. (temporary-value-for-test): Declare as dynbound. * testing/lisp/test-ob-plantuml.el: Require `ob-plantuml` instead of erroring out if it's not already loaded. * testing/lisp/test-ob-lilypond.el: Require `ob-lilypond` instead of erroring out if it's not already loaded. Use `with-current-buffer`. * testing/lisp/test-ob-julia.el: Require `ob-core`. * testing/lisp/test-ob-java.el (org-babel-temporary-directory): Remove dead code now that `org-babel-temporary-directory` is always bound. * testing/lisp/test-ob-exp.el: Require `ob-exp`, `org-src`, and `org-test`. (ob-exp/evaluate-all-executables-in-order): Declare `*evaluation-collector*` as dynbound. * testing/lisp/test-ob-emacs-lisp.el (ob-emacs-lisp/dynamic-lexical-edit) (ob-emacs-lisp/dynamic-lexical-execute): Rename dynbound var to `ob-emacs--x` and declare it as such. * testing/lisp/test-ob-R.el: Require `ob-core`. (ess-ask-for-ess-directory, ess-history-file): Declare vars.
245 lines
12 KiB
EmacsLisp
245 lines
12 KiB
EmacsLisp
;;; test-org-protocol.el --- tests for org-protocol.el -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (c) Sacha Chua
|
|
;; Authors: Sacha Chua
|
|
|
|
;; 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 <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Code:
|
|
|
|
(require 'cl-lib)
|
|
(require 'org-protocol)
|
|
(require 'org-capture)
|
|
|
|
(ert-deftest test-org-protocol/org-protocol-parse-parameters ()
|
|
"Test `org-protocol-parse-parameters' specifications."
|
|
;; Ignore lists
|
|
(let ((data (org-protocol-parse-parameters '(:url "abc" :title "def") nil)))
|
|
(should (string= (plist-get data :url) "abc"))
|
|
(should (string= (plist-get data :title) "def")))
|
|
;; Parse new-style links
|
|
(let ((data (org-protocol-parse-parameters "url=abc&title=def" t)))
|
|
(should (string= (plist-get data :url) "abc"))
|
|
(should (string= (plist-get data :title) "def")))
|
|
;; Parse new-style complex links
|
|
(let* ((url (concat "template=p&"
|
|
"url=https%3A%2F%2Forgmode.org%2Forg.html%23capture-protocol&"
|
|
"title=The%20Org%20Manual&"
|
|
"body=9.4.2%20capture%20protocol"))
|
|
(data (org-protocol-parse-parameters url t)))
|
|
(should (string= (plist-get data :template) "p"))
|
|
(should (string= (plist-get data :url) "https://orgmode.org/org.html#capture-protocol"))
|
|
(should (string= (plist-get data :title) "The Org Manual"))
|
|
(should (string= (plist-get data :body) "9.4.2 capture protocol")))
|
|
;; Parse old-style links
|
|
(let ((data (org-protocol-parse-parameters "abc/def" nil '(:url :title))))
|
|
(should (string= (plist-get data :url) "abc"))
|
|
(should (string= (plist-get data :title) "def")))
|
|
;; Parse old-style links even without keys
|
|
(let ((data (org-protocol-parse-parameters "b/abc/def" nil)))
|
|
(should (equal data '("b" "abc" "def"))))
|
|
;; Parse old-style links with key/val pairs
|
|
(let ((data (org-protocol-parse-parameters "b/abc/extrakey/extraval" nil '(:param1 :param2))))
|
|
(should (string= (plist-get data :param1) "b"))
|
|
(should (string= (plist-get data :param2) "abc"))
|
|
(should (string= (plist-get data :extrakey) "extraval"))))
|
|
|
|
(ert-deftest test-org-protocol/org-protocol-store-link ()
|
|
"Test `org-protocol-store-link' specifications."
|
|
;; Old link style
|
|
(let ((uri "/some/directory/org-protocol:/store-link:/URL/TITLE"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (equal (car org-stored-links) '("URL" "TITLE"))))
|
|
;; URL encoded
|
|
(let ((uri (format "/some/directory/org-protocol:/store-link:/%s/TITLE"
|
|
(url-hexify-string "http://example.com"))))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (equal (car org-stored-links) '("http://example.com" "TITLE"))))
|
|
;; Handle multiple slashes, old link style
|
|
(let ((uri "/some/directory/org-protocol://store-link://URL2//TITLE2"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (equal (car org-stored-links) '("URL2" "TITLE2"))))
|
|
;; New link style
|
|
(let ((uri "/some/directory/org-protocol://store-link?url=URL3&title=TITLE3"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (equal (car org-stored-links) '("URL3" "TITLE3"))))
|
|
;; Do not decode "+" in old-style link
|
|
(let ((uri "/org-protocol:/store-link:/one+one/plus+preserved"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (equal (car org-stored-links) '("one+one" "plus+preserved"))))
|
|
;; Decode "+" to space in new-style link
|
|
(let ((uri "/org-protocol:/store-link/?url=one+two&title=plus+is+space"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (equal (car org-stored-links) '("one two" "plus is space")))))
|
|
|
|
(ert-deftest test-org-protocol/org-protocol-store-link-file ()
|
|
"store-link: `org-protocol-sanitize-uri' could distort URL."
|
|
:expected-result :failed
|
|
(let ((uri "/org-protocol:/store-link:/file%3A%2F%2F%2Fetc%2Fmailcap/Triple%20Slash"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (equal (car org-stored-links) '("file:///etc/mailcap" "Triple Slash"))))
|
|
(let ((uri "/org-protocol:/store-link?url=file%3A%2F%2F%2Fetc%2Fmailcap&title=Triple%20Slash"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (equal (car org-stored-links) '("file:///etc/mailcap" "Triple Slash")))))
|
|
|
|
(ert-deftest test-org-protocol/org-protocol-capture ()
|
|
"Test `org-protocol-capture' specifications."
|
|
(let* ((org-protocol-default-template-key "t")
|
|
(temp-file-name (make-temp-file "org-protocol-test"))
|
|
(org-capture-templates
|
|
`(("t" "Test" entry (file ,temp-file-name) "** TODO\n\n%i\n\n%a\n" :kill-buffer t)
|
|
("x" "With params" entry (file ,temp-file-name) "** SOMEDAY\n\n%i\n\n%a\n" :kill-buffer t)
|
|
("X" "Just the template" entry (file ,temp-file-name) "** Hello World\n\n%i\n\nGoodbye World\n" :kill-buffer t)))
|
|
(test-urls
|
|
'(
|
|
;; Old style:
|
|
;; - multiple slashes
|
|
("/some/directory/org-protocol:/capture:/URL/TITLE"
|
|
. "** TODO\n\n\n\n[[URL][TITLE]]\n")
|
|
;; - body specification
|
|
("/some/directory/org-protocol:/capture:/URL/TITLE/BODY"
|
|
. "** TODO\n\nBODY\n\n[[URL][TITLE]]\n")
|
|
;; - template
|
|
("/some/directory/org-protocol:/capture:/x/URL/TITLE/BODY"
|
|
. "** SOMEDAY\n\nBODY\n\n[[URL][TITLE]]\n")
|
|
;; - query parameters, not sure how to include them in template
|
|
("/some/directory/org-protocol:/capture:/x/URL/TITLE/BODY/from/example"
|
|
. "** SOMEDAY\n\nBODY\n\n[[URL][TITLE]]\n")
|
|
;; New style:
|
|
;; - multiple slashes
|
|
("/some/directory/org-protocol:/capture?url=NEWURL&title=TITLE"
|
|
. "** TODO\n\n\n\n[[NEWURL][TITLE]]\n")
|
|
;; - body specification
|
|
("/some/directory/org-protocol:/capture?url=NEWURL&title=TITLE&body=BODY"
|
|
. "** TODO\n\nBODY\n\n[[NEWURL][TITLE]]\n")
|
|
;; - template
|
|
("/some/directory/org-protocol:/capture?template=x&url=NEWURL&title=TITLE&body=BODY"
|
|
. "** SOMEDAY\n\nBODY\n\n[[NEWURL][TITLE]]\n")
|
|
;; - no url specified
|
|
("/some/directory/org-protocol:/capture?template=x&title=TITLE&body=BODY"
|
|
. "** SOMEDAY\n\nBODY\n\nTITLE\n")
|
|
;; - no title specified
|
|
("/some/directory/org-protocol:/capture?template=x&url=NEWURL&body=BODY"
|
|
. "** SOMEDAY\n\nBODY\n\n[[NEWURL][NEWURL]]\n")
|
|
;; - just the template
|
|
("/some/directory/org-protocol:/capture?template=X"
|
|
. "** Hello World\n\n\n\nGoodbye World\n")
|
|
;; - query parameters, not sure how to include them in template
|
|
("/some/directory/org-protocol:/capture?template=x&url=URL&title=TITLE&body=BODY&from=example"
|
|
. "** SOMEDAY\n\nBODY\n\n[[URL][TITLE]]\n")
|
|
;; - "+" is not decoded to space in old-style URIs
|
|
("/org-protocol:/capture:/t/https%3A%2F%2Forgmode.org%2Fsome+thing/org+mode/Body+plus"
|
|
. "** TODO\n\nBody+plus\n\n[[https://orgmode.org/some+thing][org+mode]]\n")
|
|
;; - decode "+" to space
|
|
("/org-protocol:/capture?template=t&url=URL&title=Mailing+list&body=Body+no+plus"
|
|
. "** TODO\n\nBody no plus\n\n[[URL][Mailing list]]\n")
|
|
)))
|
|
;; Old link style
|
|
(mapc
|
|
(lambda (test-case)
|
|
(let ((uri (car test-case)))
|
|
(org-protocol-check-filename-for-protocol uri (list uri) nil)
|
|
(should (string= (buffer-string) (cdr test-case)))
|
|
(org-capture-kill)))
|
|
test-urls)
|
|
(delete-file temp-file-name)))
|
|
|
|
(ert-deftest test-org-protocol/org-protocol-capture-file ()
|
|
"capture: `org-protocol-sanitize-uri' could distort URL."
|
|
:expected-result :failed
|
|
(let* ((org-protocol-default-template-key "t")
|
|
(temp-file-name (make-temp-file "org-protocol-test"))
|
|
(org-capture-templates
|
|
`(("t" "Test" plain (file ,temp-file-name) "%a\n%i\n" :kill-buffer t))))
|
|
(let ((uri "/org-protocol:/capture:/t/file%3A%2F%2F%2Fetc%2Fmailcap/Triple%20Slash/Body"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (string= (buffer-string) "[[file:///etc/mailcap][Triple Slash]]\nBody")))
|
|
(let ((uri "/org-protocol:/capture?template=t&url=file%3A%2F%2F%2Fetc%2Fmailcap&title=Triple%20Slash&body=Body"))
|
|
(should (null (org-protocol-check-filename-for-protocol uri (list uri) nil)))
|
|
(should (string= (buffer-string) "[[file:///etc/mailcap][Triple Slash]]\nBody")))))
|
|
|
|
(ert-deftest test-org-protocol/org-protocol-open-source ()
|
|
"Test org-protocol://open-source links."
|
|
(let* ((temp-file-name1 (make-temp-file "org-protocol-test1"))
|
|
(temp-file-name2 (make-temp-file "org-protocol-test2"))
|
|
(org-protocol-project-alist
|
|
`((test1
|
|
:base-url "http://example.com/"
|
|
:online-suffix ".html"
|
|
:working-directory ,(file-name-directory temp-file-name1))
|
|
(test2
|
|
:base-url "http://another.example.com/"
|
|
:online-suffix ".js"
|
|
:working-directory ,(file-name-directory temp-file-name2))
|
|
(test3
|
|
:base-url "https://blog-example.com/"
|
|
:working-directory ,(file-name-directory temp-file-name2)
|
|
:online-suffix ".html"
|
|
:working-suffix ".md"
|
|
:rewrites (("\\(https://blog-example.com/[0-9]+/[0-9]+/[0-9]+/\\)" . ".md")))))
|
|
(test-cases
|
|
(list
|
|
;; Old-style URLs
|
|
(cons
|
|
(concat "/some/directory/org-protocol:/open-source:/"
|
|
(url-hexify-string
|
|
(concat "http://example.com/" (file-name-nondirectory temp-file-name1) ".html")))
|
|
temp-file-name1)
|
|
(cons
|
|
(concat "/some/directory/org-protocol:/open-source:/"
|
|
(url-hexify-string
|
|
(concat "http://another.example.com/" (file-name-nondirectory temp-file-name2) ".js")))
|
|
temp-file-name2)
|
|
;; New-style URLs
|
|
(cons
|
|
(concat "/some/directory/org-protocol:/open-source?url="
|
|
(url-hexify-string
|
|
(concat "http://example.com/" (file-name-nondirectory temp-file-name1) ".html")))
|
|
temp-file-name1)
|
|
(cons
|
|
(concat "/some/directory/org-protocol:/open-source?url="
|
|
(url-hexify-string
|
|
(concat "http://another.example.com/" (file-name-nondirectory temp-file-name2) ".js")))
|
|
temp-file-name2))))
|
|
(mapc (lambda (test-case)
|
|
(should (string=
|
|
(org-protocol-check-filename-for-protocol
|
|
(car test-case)
|
|
(list (car test-case)) nil)
|
|
(cdr test-case))))
|
|
test-cases)
|
|
(delete-file temp-file-name1)
|
|
(delete-file temp-file-name2)))
|
|
|
|
(defun test-org-protocol/org-protocol-greedy-handler (fname)
|
|
;; fname should be a list of parsed items
|
|
(should (listp fname))
|
|
nil)
|
|
|
|
(ert-deftest test-org-protocol/org-protocol-with-greedy-handler ()
|
|
"Check that greedy handlers are called with all the filenames."
|
|
(let ((org-protocol-protocol-alist
|
|
'(("protocol-a" :protocol "greedy" :function test-org-protocol/org-protocol-greedy-handler :kill-client t :greedy t))))
|
|
;; Neither of these should signal errors
|
|
(let ((uri "/some/dir/org-protocol://greedy?a=b&c=d")
|
|
(uri2 "/some/dir/org-protocol://greedy?e=f&g=h"))
|
|
(org-protocol-check-filename-for-protocol uri (list uri uri2) nil))))
|
|
|
|
|
|
;; TODO: Verify greedy protocol handling
|
|
(provide 'test-org-protocol)
|
|
;;; test-org-protocol.el ends here
|