File: dest_spec.rb

package info (click to toggle)
ruby-asciidoctor-pdf 2.3.19-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 15,972 kB
  • sloc: ruby: 44,316; sh: 133; java: 45; makefile: 4
file content (406 lines) | stat: -rw-r--r-- 9,556 bytes parent folder | download | duplicates (2)
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
# frozen_string_literal: true

require_relative 'spec_helper'

describe 'Asciidoctor::PDF::Converter - Dest' do
  it 'should not define a dest named __anchor-top if document has no body pages' do
    pdf = to_pdf <<~'EOS'
    = Document Title
    :doctype: book
    EOS
    (expect get_names pdf).to be_empty
  end

  it 'should define a dest named __anchor-top at top of the first body page' do
    pdf = to_pdf <<~'EOS'
    = Document Title
    :doctype: book
    :toc:

    preamble

    == Chapter

    content
    EOS

    (expect (top_dest = get_dest pdf, '__anchor-top')).not_to be_nil
    (expect (top_dest[:page_number])).to be 3
    _, page_height = get_page_size pdf, top_dest[:page_number]
    (expect top_dest[:y]).to eql page_height
  end

  it 'should define a dest named toc at the top of the first toc page' do
    pdf = to_pdf <<~'EOS'
    = Document Title
    :doctype: book
    :toc:

    == Chapter
    EOS

    (expect (toc_dest = get_dest pdf, 'toc')).not_to be_nil
    (expect toc_dest[:page_number]).to be 2
    _, page_height = get_page_size pdf, toc_dest[:page_number]
    (expect toc_dest[:y]).to eql page_height
  end

  it 'should define a dest named toc at the location where the macro toc starts' do
    pdf = to_pdf <<~'EOS'
    = Document Title
    :toc: macro

    content before the toc

    toc::[]

    == Chapter

    == Another Chapter
    EOS

    (expect (toc_dest = get_dest pdf, 'toc')).not_to be_nil
    (expect (toc_dest[:page_number])).to be 1
    _, page_height = get_page_size pdf, toc_dest[:page_number]
    (expect toc_dest[:y]).to be < page_height
  end

  it 'should use the toc macro ID as the name of the dest for the macro toc' do
    pdf = to_pdf <<~'EOS'
    = Document Title
    :toc: macro

    content before the toc

    [#macro-toc]
    toc::[]

    == Chapter

    == Another Chapter
    EOS

    (expect get_names pdf).to have_key 'macro-toc'
  end

  it 'should define a dest at the top of a chapter page' do
    pdf = to_pdf <<~'EOS'
    = Document Title
    :doctype: book

    == Chapter
    EOS

    (expect (chapter_dest = get_dest pdf, '_chapter')).not_to be_nil
    (expect (chapter_dest[:page_number])).to be 2
    _, page_height = get_page_size pdf, chapter_dest[:page_number]
    (expect chapter_dest[:y]).to eql page_height
  end

  it 'should define a dest at the top of a part page' do
    pdf = to_pdf <<~'EOS'
    = Document Title
    :doctype: book

    = Part 1

    == Chapter

    content
    EOS

    (expect (part_dest = get_dest pdf, '_part_1')).not_to be_nil
    (expect (part_dest[:page_number])).to be 2
    _, page_height = get_page_size pdf, part_dest[:page_number]
    (expect part_dest[:y]).to eql page_height
  end

  it 'should define a dest at the top of page for section if section is at top of page' do
    pdf = to_pdf <<~'EOS'
    = Document Title

    content

    <<<

    == Section

    content
    EOS

    (expect (sect_dest = get_dest pdf, '_section')).not_to be_nil
    (expect (sect_dest[:page_number])).to be 2
    _, page_height = get_page_size pdf, sect_dest[:page_number]
    (expect sect_dest[:y]).to eql page_height
  end

  it 'should define a dest at the top of content area if page does not start with a section' do
    pdf_theme = { page_margin: 15 }

    pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
    [#p1]
    content
    EOS

    (expect (para_dest = get_dest pdf, 'p1')).not_to be_nil
    (expect (para_dest[:page_number])).to be 1
    _, page_height = get_page_size pdf, para_dest[:page_number]
    (expect para_dest[:y]).to eql page_height - 15
  end

  it 'should register dest for every block that has an ID' do
    ['', 'abstract', 'example', 'open', 'sidebar', 'quote', 'verse', 'listing', 'literal', 'NOTE'].each do |style|
      pdf = to_pdf <<~EOS
      [#{style}#disclaimer]
      All views expressed are my own.
      EOS

      (expect get_names pdf).to have_key 'disclaimer'
    end
  end

  it 'should register dest for table that has an ID' do
    pdf = to_pdf <<~'EOS'
    [#props]
    |===
    | Name | Value

    | Foo | Bar
    |===
    EOS

    (expect get_names pdf).to have_key 'props'
  end

  it 'should register dest for media macro that has an ID' do
    {
      image: 'tux.png',
      svg: 'green-bar.svg',
      video: 'webcast.mp4',
      audio: 'podcast.mp3',
    }.each do |macro_name, target|
      pdf = to_pdf <<~EOS
      [#media]
      #{macro_name == :svg ? 'image' : macro_name.to_s}::#{target}[]
      EOS

      (expect get_names pdf).to have_key 'media'
    end
  end

  it 'should register dest for unordered list that has an ID' do
    pdf = to_pdf <<~'EOS'
    [#takeaways]
    * one
    * two
    EOS

    (expect get_names pdf).to have_key 'takeaways'
  end

  it 'should register dest for ordered list that has an ID' do
    pdf = to_pdf <<~'EOS'
    [#takeaways]
    . one
    . two
    EOS

    (expect get_names pdf).to have_key 'takeaways'
  end

  it 'should register dest for description list that has an ID' do
    pdf = to_pdf <<~'EOS'
    [#takeaways]
    reuse:: try to avoid binning it in the first place
    recycle:: if you do bin it, make sure the material gets reused
    EOS

    (expect get_names pdf).to have_key 'takeaways'
  end

  it 'should register dest for callout list that has an ID' do
    pdf = to_pdf <<~'EOS'
    ----
    require 'asciidoctor-pdf' // <1>

    Asciidoctor.convert_file 'doc.adoc', backend: 'pdf', safe: :safe // <2>
    ----
    [#details]
    <1> requires the library
    <2> converts the document to PDF
    EOS

    (expect get_names pdf).to have_key 'details'
  end

  it 'should register dest for each section with implicit ID' do
    pdf = to_pdf <<~'EOS'
    == Fee

    === Fi

    ==== Fo

    ===== Fum
    EOS

    names = get_names pdf
    (expect names).to have_key '_fee'
    (expect names).to have_key '_fi'
    (expect names).to have_key '_fo'
    (expect names).to have_key '_fum'
  end

  it 'should register dest for each section with explicit ID' do
    pdf = to_pdf <<~'EOS'
    [#s-fee]
    == Fee

    [#s-fi]
    === Fi

    [#s-fo]
    ==== Fo

    [#s-fum]
    ===== Fum
    EOS

    names = get_names pdf
    (expect names).to have_key 's-fee'
    (expect names).to have_key 's-fi'
    (expect names).to have_key 's-fo'
    (expect names).to have_key 's-fum'
  end

  it 'should not register dest with auto-generated name for each section if sectids are disabled' do
    pdf = to_pdf <<~'EOS'
    :!sectids:

    == Fee

    === Fi

    ==== Fo

    ===== Fum
    EOS

    names = get_names pdf
    names.delete '__anchor-top'
    (expect names).to have_size 4
    names.each_key do |name|
      (expect name).to start_with '__anchor-'
    end
  end

  it 'should register dest for a discrete heading with an implicit ID' do
    pdf = to_pdf <<~'EOS'
    [discrete]
    == Bundler

    Use this procedure if you're using Bundler.
    EOS

    (expect get_names pdf).to have_key '_bundler'
  end

  it 'should not register dest for a discrete heading when sectids are disabled' do
    pdf = to_pdf <<~'EOS'
    :!sectids:

    [discrete]
    == Bundler

    Use this procedure if you're using Bundler.
    EOS

    names = get_names pdf
    names.delete '__anchor-top'
    (expect names).to be_empty
  end

  it 'should register dest for a discrete heading with an explicit ID' do
    pdf = to_pdf <<~'EOS'
    [discrete#bundler]
    == Bundler

    Use this procedure if you're using Bundler.
    EOS

    (expect get_names pdf).to have_key 'bundler'
  end

  it 'should register dest for a link with an ID' do
    pdf = to_pdf <<~'EOS'
    see <<link,link>>

    <<<

    https://asciidoctor.org[Asciidoctor,id=link]
    EOS

    (expect (link_dest = get_dest pdf, 'link')).not_to be_nil
    (expect link_dest[:page_number]).to be 2
  end

  it 'should hex encode name for ID that contains non-ASCII characters' do
    pdf = to_pdf '== Über Étudier'
    hex_encoded_id = %(0x#{('_über_étudier'.unpack 'H*')[0]})
    names = (get_names pdf).keys.reject {|k| k == '__anchor-top' }
    (expect names).to have_size 1
    name = names[0]
    (expect name).to eql hex_encoded_id
  end

  it 'should define a dest at the location of an inline anchor' do
    ['[[details]]details', '[#details]#details#'].each do |details|
      pdf = to_pdf <<~EOS
      Here's the intro.

      <<<

      Here are all the #{details}.
      EOS

      (expect (phrase_dest = get_dest pdf, 'details')).not_to be_nil
      (expect phrase_dest[:page_number]).to be 2
    end
  end

  it 'should keep anchor with text if text is advanced to next page' do
    pdf = to_pdf <<~EOS
    jump to <<anchor>>

    #{(['paragraph'] * 25).join %(\n\n)}

    #{(['paragraph'] * 16).join ' '} [#anchor]#supercalifragilisticexpialidocious#
    EOS

    (expect (phrase_dest = get_dest pdf, 'anchor')).not_to be_nil
    (expect phrase_dest[:page_number]).to be 2
    (expect (pdf.page phrase_dest[:page_number]).text).to eql 'supercalifragilisticexpialidocious'
  end

  it 'should not allocate space for anchor if font is missing glyph for null character' do
    pdf_theme = {
      extends: 'default',
      font_catalog: {
        'Missing Null' => {
          'normal' => (fixture_file 'mplus1mn-regular-ascii.ttf'),
        },
      },
      base_font_family: 'Missing Null',
    }

    pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
    foo [#bar]#bar# #baz#

    foo bar #baz#
    EOS

    baz_texts = pdf.find_text 'baz'
    (expect baz_texts).to have_size 2
    (expect baz_texts[0][:x]).to eql baz_texts[1][:x]
  end
end