emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
blob 5165e867ce012590b91674658ef2ca8091fe2218 8910 bytes (raw)
name: testing/lisp/test-ox-ascii.el 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
;;; test-ox-latex.el --- tests for ox-latex.el       -*- lexical-binding: t; -*-

;; Copyright (C) 2023  Ihor Radchenko

;; Author: Ihor Radchenko <yantar92@posteo.net>

;; 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/>.

;;; Commentary:

;; Tests checking validity of Org ASCII export output.

;;; Code:

(require 'ox-ascii nil t)
(unless (featurep 'ox-ascii)
  (signal 'missing-test-dependency "org-export-ascii"))

(defun test-ox-ascii--restore-syntax ()
  (org-link-make-regexps)
  (when (featurep 'org-element) (org-element-update-syntax)))

(defun test-ox-ascii--link-export-inline (path desc backend info)
  (and (org-export-derived-backend-p backend 'ascii)
       (let ((description (and (org-string-nw-p desc) (org-trim desc)))
             (target (format "(|tststr:%s|)" path)))
         (if description
             (format "[|%s|] %s" description target)
           target))))
\f
(ert-deftest test-ox-ascii/link-custom-protocol-fallback ()
  "Test link custom protocol fallback."
  (unwind-protect
      (let ((org-link-parameters))
        (org-link-set-parameters "tstdflt")
        ;; As notes.
        (let ((org-ascii-links-to-notes t))
          (should ; With description.
           (string-equal
            (org-export-string-as
             "Link [[tstdflt:path-descr][with description]] as note."
             'ascii t)
            "Link [with description] as note.
\n
[with description] <tstdflt:path-descr>\n"))
          (should ; No description.
           (string-equal
            (org-export-string-as
             "Link [[tstdflt:path-no-descr]] without description (note)."
             'ascii t)
            "Link <tstdflt:path-no-descr> without description (note).\n")))
        ;; Inline.
        (let ((org-ascii-links-to-notes nil))
          (should ; With description.
           (string-equal
            (org-export-string-as
             "Inline link [[tstdflt:path-descr][with description]]."
             'ascii t)
            "Inline link [with description] (<tstdflt:path-descr>).\n"))
          (should ; No description.
           (string-equal
            (org-export-string-as
             "Inline link [[tstdflt:path-no-descr]] without description."
             'ascii t)
            "Inline link <tstdflt:path-no-descr> without description.\n"))))
    (test-ox-ascii--restore-syntax)))

(ert-deftest test-ox-ascii/link-custom-protocol-string ()
  "Test link custom protocol forced inline (string return value)."
  (unwind-protect
      (let ((org-link-parameters))
        (org-link-set-parameters "tststr"
                                 :export #'test-ox-ascii--link-export-inline)
        ;; Inline despite as notes is requested.
        (let ((org-ascii-links-to-notes t))
          (should ; With description.
           (string-equal
            (org-export-string-as
             "Link [[tststr:path-descr][with description]] as string (opt note)."
             'ascii t)
            "Link [|with description|] (|tststr:path-descr|) as string (opt note).\n"))
          (should ; No description.
           (string-equal
            (org-export-string-as
             "Link [[tststr:path-no-descr]] without description as string (opt note)."
             'ascii t)
            "Link (|tststr:path-no-descr|) without description as string (opt note).\n")))
        ;; Inline.
        (let ((org-ascii-links-to-notes nil))
          (should ; With description.
           (string-equal
            (org-export-string-as
             "Link [[tststr:path-descr][with description]] as string (opt inline)."
             'ascii t)
            "Link [|with description|] (|tststr:path-descr|) as string (opt inline).\n"))
          (should ; No description.
           (string-equal
            (org-export-string-as
             "Link <tststr:path-no-descr> without description as string (opt inline)."
             'ascii t)
            "Link (|tststr:path-no-descr|) without description as string (opt
inline).\n"))))
  (test-ox-ascii--restore-syntax)))

(ert-deftest test-ox-ascii/link-custom-protocol-cons ()
  "Test of custom link type optionally exported as a note."
  (unwind-protect
      (let ((org-link-parameters))
        (org-link-set-parameters
         "tstcons"
         :export (lambda (path descr _backend info)
                   (org-ascii-make-link-formatted
                    (concat "excons-" path) descr info)))
        ;; As notes.
        (let ((org-ascii-links-to-notes t))
          (should ; With description.
           (string-equal
            (org-export-string-as
             "Link [[tstcons:path-descr][with descr[iption]\u200b]] as note."
             'ascii t)
            "Link [with descr[iption]\u200b] as note.
\n
[with descr[iption]\u200b] excons-path-descr\n"))
          (should ; No description.
           (string-equal
            (org-export-string-as
             "Link <tstcons:path-no-descr> without description (note)."
             'ascii t)
            "Link excons-path-no-descr without description (note).\n")))
        ;; Inline.
        (let ((org-ascii-links-to-notes nil))
          (should ; With description.
           (string-equal
            (org-export-string-as
             "Inline link [[tstcons:path-descr][with description]]."
             'ascii t)
            "Inline link [with description] (excons-path-descr).\n"))
          (should ; No description.
           (string-equal
            (org-export-string-as
             "Inline link [[tstcons:path-no-descr]] without description."
             'ascii t)
            "Inline link excons-path-no-descr without description.\n")))
        ;; Ugly formatting with duplicated brackets.
        ;; Behavior likely should be changed to not add another pair of brackets.
        (let ((org-link-parameters))
          (org-link-set-parameters
           "brcons"
           :export (lambda (path descr _backend info)
                     (org-ascii-make-link-formatted
                      (format "(exbr-%s)" path)
                      (and descr (format "[%s]" descr))
                      info)))
          (let ((org-ascii-links-to-notes t))
            (should
             (string-equal
              (org-export-string-as
               "Link [[brcons:path-descr][with brackets]] as note."
               'ascii t)
              "Link [[with brackets]] as note.
\n
[[with brackets]] (exbr-path-descr)\n")))
          ;; Inline.
          (let ((org-ascii-links-to-notes nil))
            (should
             (string-equal
              (org-export-string-as
               "Link [[brcons:path-descr][with brackets]] inline."
               'ascii t)
              "Link [[with brackets]] (exbr-path-descr) inline.\n"))))
        ;; Error.
        (org-link-set-parameters
         "tsterr"
         :export (lambda (path descr _backend _info)
                   (list (concat "ex-error! " path) descr "extra arg")))
        (let* ((err (should-error
                     (org-export-string-as
                      "Signals [[tsterr:invalid :export][aaa]] error."
                      'ascii t)
                     :type 'error))
               (err-text (cadr err)))
          (should-not (unless (and (stringp err-text)
                                   (string-match-p "\\`Link :export returned not.*"
                                                   err-text))
                        err))))
  (test-ox-ascii--restore-syntax)))

(ert-deftest test-ox-ascii/list ()
  "Test lists."
  ;; Number counter.
  (org-test-with-exported-text
      'ascii
      "1. [@3] foo"
    (goto-char (point-min))
    (should
     (search-forward
      "3. foo")))
  ;; Number counter.  Start from 1.
  (org-test-with-exported-text
      'ascii
      "3. foo"
    (goto-char (point-min))
    (should
     (search-forward
      "1. foo")))
  ;; Alphanumeric counter.
  (let ((org-list-allow-alphabetical t))
    (org-test-with-exported-text
        'ascii
        "m. [@k] baz"
      (goto-char (point-min))
      (should
       (search-forward
        "11. baz"))))
  ;; Start from 1.
  (let ((org-list-allow-alphabetical t))
    (org-test-with-exported-text
        'ascii
        "m. bar"
      (goto-char (point-min))
      (should
       (search-forward
        "1. bar")))))

(provide 'test-ox-ascii)
;;; test-ox-ascii.el ends here

debug log:

solving 5165e867c ...
found 5165e867c in https://list.orgmode.org/orgmode/uhbbgr$or9$1@ciao.gmane.io/
found 07def1633 in https://list.orgmode.org/orgmode/ugucve$12l4$1@ciao.gmane.io/ ||
	https://list.orgmode.org/orgmode/uhbbgr$or9$1@ciao.gmane.io/
found fe12c0c27 in https://git.savannah.gnu.org/cgit/emacs/org-mode.git
preparing index
index prepared:
100644 fe12c0c27d32e43739bbf1827fe962369308a194	testing/lisp/test-ox-ascii.el

applying [1/2] https://list.orgmode.org/orgmode/ugucve$12l4$1@ciao.gmane.io/
diff --git a/testing/lisp/test-ox-ascii.el b/testing/lisp/test-ox-ascii.el
index fe12c0c27..07def1633 100644

Checking patch testing/lisp/test-ox-ascii.el...
Applied patch testing/lisp/test-ox-ascii.el cleanly.

skipping https://list.orgmode.org/orgmode/uhbbgr$or9$1@ciao.gmane.io/ for 07def1633
index at:
100644 07def16337ac00887e2c99c88f72335050e5952a	testing/lisp/test-ox-ascii.el

applying [2/2] https://list.orgmode.org/orgmode/uhbbgr$or9$1@ciao.gmane.io/
diff --git a/testing/lisp/test-ox-ascii.el b/testing/lisp/test-ox-ascii.el
index 07def1633..5165e867c 100644

Checking patch testing/lisp/test-ox-ascii.el...
Applied patch testing/lisp/test-ox-ascii.el cleanly.

index at:
100644 5165e867ce012590b91674658ef2ca8091fe2218	testing/lisp/test-ox-ascii.el

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

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).