File: test_writer.rb

package info (click to toggle)
ruby-libxml 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 3,040 kB
  • sloc: xml: 18,263; ansic: 8,344; ruby: 6,987; makefile: 3
file content (447 lines) | stat: -rw-r--r-- 14,932 bytes parent folder | download
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
# encoding: UTF-8

require File.expand_path('../test_helper', __FILE__)
require 'stringio'

class TestWriter < Minitest::Test
  XSL_PREFIX = 'xsl'
  XSL_URI = 'http://www.w3.org/1999/XSL/Transform'

  def test_generic_failure
    writer = XML::Writer.string
    writer.start_document
    assert(!writer.end_element)
    writer.end_document
  end

  def test_empty_doc
    writer = XML::Writer.string
    document writer
    assert_equal(writer.result.strip!, '<?xml version="1.0"?>')

    writer = XML::Writer.string
    document writer, { :encoding => XML::Encoding::ISO_8859_1 }
    assert_equal(writer.result.strip!, '<?xml version="1.0" encoding="ISO-8859-1"?>')

    writer = XML::Writer.string
    document writer, { :standalone => 1 }
    assert_equal(writer.result.strip!, '<?xml version="1.0" standalone="yes"?>')

    writer = XML::Writer.string
    document writer, { :standalone => 1, :encoding => XML::Encoding::ISO_8859_1, :foo => :bar }
    assert_equal(writer.result.strip!, '<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>')
  end

  def test_single_root
    writer = XML::Writer.string
    document writer do
      element writer, 'root'
    end

    assert_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<root/>")
  end

  def test_pi
    expected = "<?xml version=\"1.0\"?>\n<?php echo \"foo\";?>"

    writer = XML::Writer.string
    document writer do
      assert(writer.start_pi('php'))
      assert(writer.write_string('echo "foo";'))
      assert(writer.end_pi)
    end
    assert_equal(writer.result.strip!, expected)

    writer = XML::Writer.string
    document writer do
      assert(writer.write_pi('php', 'echo "foo";'))
    end
    assert_equal(writer.result.strip!, expected)
  end

  def test_comment
    expected = "<?xml version=\"1.0\"?>\n<!--foo-->"

    writer = XML::Writer.string
    document writer do
      assert(writer.start_comment)
      assert(writer.write_string 'foo')
      assert(writer.end_comment)
    end
    assert_equal(writer.result.strip!, expected)

    writer = XML::Writer.string
    document writer do
      assert(writer.write_comment 'foo')
    end
    assert_equal(writer.result.strip!, expected)
  end

  def test_cdata
    expected = "<?xml version=\"1.0\"?>\n<root><![CDATA[<?php echo $foo; ?>]]></root>"

    writer = XML::Writer.string
    document writer do
      element writer, 'root' do
        assert(writer.start_cdata)
        assert(writer.write_string '<?php echo $foo; ?>')
        assert(writer.end_cdata)
      end
    end
    assert_equal(writer.result.strip!, expected)

    writer = XML::Writer.string
    document writer do
      element writer, 'root' do
        assert(writer.write_cdata '<?php echo $foo; ?>')
      end
    end
    assert_equal(writer.result.strip!, expected)
  end

  def test_write_empty_elements
    writer = XML::Writer.string
    document writer do
      assert(writer.write_element 'foo')
    end
    assert_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<foo/>")

    writer = XML::Writer.string
    document writer do
      assert(writer.write_element_ns XSL_PREFIX, 'stylesheet', XSL_URI)
    end
    assert_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<" + XSL_PREFIX + ":stylesheet xmlns:xsl=\"" + XSL_URI + "\"/>")
  end

  def test_valued_element
    expected = "<?xml version=\"1.0\"?>\n<abc>123<def>456<ghi>789</ghi>cueillir des cerises</def>nous irons au bois</abc>"

    writer = XML::Writer.string
    document writer do
      assert(writer.start_element 'abc')
        assert(writer.write_string '123')
        assert(writer.start_element 'def')
          assert(writer.write_string '456')
          assert(writer.start_element 'ghi')
            assert(writer.write_string '789')
          assert(writer.end_element)
          assert(writer.write_string 'cueillir des cerises')
        assert(writer.end_element)
        assert(writer.write_string 'nous irons au bois')
      assert(writer.end_element)
    end
    assert_equal(writer.result.strip!, expected)

    writer = XML::Writer.string
    document writer do
      assert(writer.start_element 'abc')
        assert(writer.write_string '123')
        assert(writer.start_element 'def')
          assert(writer.write_string '456')
          assert(writer.write_element 'ghi', '789')
          assert(writer.write_string 'cueillir des cerises')
        assert(writer.end_element)
        assert(writer.write_string 'nous irons au bois')
      assert(writer.end_element)
    end
    assert_equal(writer.result.strip!, expected)
  end

  def test_valued_element_ns
    expected = "<?xml version=\"1.0\"?>\n" +
      "<xsl:stylesheet xmlns:xsl=\"http://www.w3.org/1999/XSL/Transform\">" +
      "<xsl:attribute-set>" +
      "<xsl:attribute>20px</xsl:attribute>" +
      "<xsl:attribute>solid</xsl:attribute>" +
      "</xsl:attribute-set>" +
      "</xsl:stylesheet>"

    writer = XML::Writer.string
    document writer do
      assert(writer.start_element_ns XSL_PREFIX, 'stylesheet', XSL_URI)
        assert(writer.start_element_ns XSL_PREFIX, 'attribute-set')
          assert(writer.start_element_ns XSL_PREFIX, 'attribute')
            assert(writer.write_string '20px')
          assert(writer.end_element)
          assert(writer.start_element_ns XSL_PREFIX, 'attribute')
            assert(writer.write_string 'solid')
          assert(writer.end_element)
        assert(writer.end_element)
      assert(writer.end_element)
    end
    assert_equal(writer.result.strip!, expected)

    writer = XML::Writer.string
    document writer do
      assert(writer.start_element_ns XSL_PREFIX, 'stylesheet', XSL_URI)
        assert(writer.start_element_ns XSL_PREFIX, 'attribute-set')
          assert(writer.write_element_ns XSL_PREFIX, 'attribute', nil, '20px')
          assert(writer.write_element_ns XSL_PREFIX, 'attribute', nil, 'solid')
        assert(writer.end_element)
      assert(writer.end_element)
    end
    assert_equal(writer.result.strip!, expected)
  end

  def test_attribute
    writer = XML::Writer.string
    document writer do
      element writer, 'root' do
        element writer, 'child' do
          assert(writer.start_attribute 'foo')
          assert(writer.write_string 'bar')
          assert(writer.end_attribute)
        end
      end
    end
    assert_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<root><child foo=\"bar\"/></root>")

    writer = XML::Writer.string
    document writer do
      element writer, 'root' do
        element writer, 'child' do
          assert(writer.write_attribute 'abc', 'def')
          assert(writer.write_string 'ghi') # must be done after attributes
        end
      end
    end
    assert_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<root><child abc=\"def\">ghi</child></root>")
  end

  def test_attribute_ns
    expected = "<?xml version=\"1.0\"?>\n<root><link xlink:href=\"abc\" xhtml:class=\"def\"/></root>"

    writer = XML::Writer.string
    document writer do
      element writer, 'root' do
        element writer, 'link' do
          assert(writer.write_attribute_ns 'xlink', 'href', nil, 'abc')
          assert(writer.write_attribute_ns 'xhtml', 'class', nil, 'def')
        end
      end
    end
    assert_equal(writer.result.strip!, expected)

    writer = XML::Writer.string
    document writer do
      element writer, 'root' do
        element writer, 'link' do
          assert(writer.start_attribute_ns 'xlink', 'href')
            assert(writer.write_string 'abc')
          assert(writer.end_attribute)
          assert(writer.start_attribute_ns 'xhtml', 'class')
            assert(writer.write_string 'def')
          assert(writer.end_attribute)
        end
      end
    end
    assert_equal(writer.result.strip!, expected)
  end

  def test_quote_char
    if XML::Writer.method_defined? :set_quote_char
      writer = XML::Writer.string
      writer.set_quote_char "'"
      document writer do
        element writer, 'root' do
          assert(writer.start_attribute 'abc')
          assert(writer.write_string 'def')
          assert(writer.end_attribute)
        end
      end
      assert(writer.result.strip!.end_with? "<root abc='def'/>")
    end
  end

  def test_indentation_on
    if XML::Writer.method_defined? :set_indent
      writer = XML::Writer.string
      assert(writer.set_indent true)
      document writer do
        element writer, 'root' do
          element writer, 'child' do
            assert(writer.start_attribute 'abc')
            assert(writer.write_string 'def')
            assert(writer.end_attribute)
          end
        end
      end
      assert_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<root>\n <child abc=\"def\"/>\n</root>")
    end
  end

  def test_indentation_string
    if XML::Writer.method_defined? :set_indent_string
      writer = XML::Writer.string
      assert(writer.set_indent true)
      assert(writer.set_indent_string ' ' * 4)
      document writer do
        element writer, 'root' do
          element writer, 'child' do
            assert(writer.start_attribute 'abc')
            assert(writer.write_string 'def')
            assert(writer.end_attribute)
          end
        end
      end
      assert_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<root>\n    <child abc=\"def\"/>\n</root>")
    end
  end

  def test_dtd_declaration
    writer = XML::Writer.string
    dtd writer, 'html'
    assert_equal(writer.result, '<!DOCTYPE html>')

    writer = XML::Writer.string
    dtd writer, 'html', '-//W3C//DTD XHTML 1.0 Strict//EN', 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
    assert_equal(writer.result, '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">')
  end

  def test_dtd_attlist
    expected = '<!DOCTYPE http [<!ATTLIST method (get|post) "get">]>'

    writer = XML::Writer.string
    dtd writer, 'http' do
      assert(writer.start_dtd_attlist 'method')
        assert(writer.write_string '(get|post) "get"')
      assert(writer.end_dtd_attlist)
    end
    assert_equal(writer.result, expected)

    writer = XML::Writer.string
    dtd writer, 'http' do
      assert(writer.write_dtd_attlist 'method', '(get|post) "get"')
    end
    assert_equal(writer.result, expected)
  end

  def test_dtd_element
    expected = '<!DOCTYPE html [<!ELEMENT dl (dt|dd)+>]>'

    writer = XML::Writer.string
    dtd writer, 'html' do
      assert(writer.start_dtd_element 'dl')
        assert(writer.write_string '(dt|dd)+')
      assert(writer.end_dtd_element)
    end
    assert_equal(writer.result, expected)

    writer = XML::Writer.string
    dtd writer, 'html' do
      assert(writer.write_dtd_element 'dl', '(dt|dd)+')
    end
    assert_equal(writer.result, expected)
  end

  def test_dtd_entity
    # parameterized entity
    expected = '<!DOCTYPE html [<!ENTITY % special.pre "br | span | bdo | map"><!ENTITY % special "%special.pre; | object | img">]>'

    writer = XML::Writer.string
    dtd writer, 'html' do
      assert(writer.start_dtd_entity 'special.pre', true)
        assert(writer.write_string 'br | span | bdo | map')
      assert(writer.end_dtd_entity)
      assert(writer.start_dtd_entity 'special', true)
        assert(writer.write_string '%special.pre; | object | img')
      assert(writer.end_dtd_entity)
    end
    assert_equal(writer.result, expected)

    writer = XML::Writer.string
    dtd writer, 'html' do
      assert(writer.write_dtd_internal_entity 'special.pre', 'br | span | bdo | map', true)
      assert(writer.write_dtd_internal_entity 'special', '%special.pre; | object | img', true)
    end
    assert_equal(writer.result, expected)

    # non parameterized entity
    expected = '<!DOCTYPE html [<!ENTITY Alpha "&#913;">]>'

    writer = XML::Writer.string
    dtd writer, 'html' do
      assert(writer.start_dtd_entity 'Alpha')
        assert(writer.write_string '&#913;')
      assert(writer.end_dtd_entity)
    end
    assert_equal(writer.result, expected)

    writer = XML::Writer.string
    dtd writer, 'html' do
      assert(writer.start_dtd_entity 'Alpha', false)
        assert(writer.write_string '&#913;')
      assert(writer.end_dtd_entity)
    end
    assert_equal(writer.result, expected)

    writer = XML::Writer.string
    dtd writer, 'html' do
      assert(writer.write_dtd_internal_entity 'Alpha', '&#913;', false)
    end
    assert_equal(writer.result, expected)
  end

  def test_dtd_notation
    writer = XML::Writer.string
    dtd writer, 'pictures' do
      assert(writer.write_dtd_notation 'GIF89a', '-//Compuserve//NOTATION Graphics Interchange Format 89a//EN', nil)
      assert(writer.write_dtd_external_entity 'pictures', nil, 'images/plage.gif', 'GIF89a', false)
    end
    assert_equal(writer.result, '<!DOCTYPE pictures [<!NOTATION GIF89a PUBLIC "-//Compuserve//NOTATION Graphics Interchange Format 89a//EN"><!ENTITY pictures SYSTEM "images/plage.gif" NDATA GIF89a>]>')
  end

  def test_encoding
    if defined?(Encoding)
      iso = 'éloïse'.encode 'ISO-8859-1'

      writer = XML::Writer.string
      document writer do
        assert(writer.write_element iso)
      end
      assert_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<éloïse/>")
    end
  end

  def test_flush
    writer = XML::Writer.string
    assert(writer.start_document)
    assert_equal(writer.flush.strip!, '<?xml version="1.0"?>')
    assert(writer.start_element 'foo')
    assert(writer.end_element)
    assert(writer.end_document)
    writer.flush false
    assert_equal(writer.result.strip, '<foo/>')
  end

  def test_nil_pe_issue
    expected = '<!DOCTYPE html [<!ENTITY special.pre "br | span | bdo | map"><!ENTITY special "%special.pre; | object | img">]>'

    writer = XML::Writer.string
    dtd writer, 'html' do
      assert(writer.write_dtd_internal_entity 'special.pre', 'br | span | bdo | map', nil)
      assert(writer.write_dtd_internal_entity 'special', '%special.pre; | object | img', nil)
    end
    assert_equal(writer.result, expected)
  end

  private

  def document(writer, options = {})
    assert(writer.start_document options)
    yield if block_given?
    assert(writer.end_document)
  end

  def dtd(writer, name, pubid = nil, sysid = nil)
    assert(writer.start_dtd name, pubid, sysid)
    yield if block_given?
    assert(writer.end_dtd)
  end

  def element(writer, localname)
    assert(writer.start_element localname)
    yield if block_given?
    assert(writer.end_element)
  end
end