libxml-ruby 2.4.0 → 2.5.0

data/ext/libxml/ruby_xml_writer.h

@@ -0,0 +1,16 @@
+#ifndef __RXML_WRITER__
+# define __RXML_WRITER__
+
+# include <libxml/xmlversion.h>
+
+# ifdef LIBXML_WRITER_ENABLED
+
+#  include <libxml/xmlwriter.h>
+
+extern VALUE cXMLWriter;
+
+void rxml_init_writer(void);
+
+# endif /* LIBXML_WRITER_ENABLED */
+
+#endif /* __RXML_WRITER__ */

data/lib/libxml/error.rb

@@ -3,6 +3,23 @@
 module LibXML
   module XML
     class Error
+
+      DOMAIN_CODE_MAP =Hash.new.tap do |map|
+        ([:NO_ERROR, :PARSER, :TREE, :NAMESPACE, :DTD, :HTML, :MEMORY, :OUTPUT, :IO, :FTP, :HTTP, :XINCLUDE, :XPATH, :XPOINTER, :REGEXP, :DATATYPE, :SCHEMASP, :SCHEMASV, :RELAXNGP, :RELAXNGV, :CATALOG, :C14N, :XSLT, :VALID, :CHECK, :WRITER, :MODULE, :I18N, :SCHEMATRONV]
+         ).each do |code|
+          map[const_get(code)] = code.to_s.gsub(/XML_ERR_/, '')
+        end
+      end
+
+      ERROR_CODE_MAP = Hash.new.tap do |map|
+        (constants -
+         DOMAIN_CODE_MAP.values - #Domains
+         [:NONE, :WARNING, :ERROR, :FATAL] # Levels
+         ).each do |code|
+          map[const_get(code)] = code.to_s.gsub(/XML_ERR_/, '')
+        end
+      end
+      
       # Verbose error handler
       VERBOSE_HANDLER = lambda do |error|
         STDERR << error.to_s << "\n"
@@ -47,29 +64,11 @@ module LibXML
       end
 
       def domain_to_s
-        const_map = Hash.new
-        domains = self.class.constants.grep(/XML_FROM/)
-        domains.each do |domain|
-          human_name = domain.gsub(/XML_FROM_/, '')
-          const_map[self.class.const_get(domain)] = human_name
-        end
-
-        const_map[self.domain]
+        DOMAIN_CODE_MAP[self.domain]
       end
 
       def code_to_s
-        const_map = Hash.new
-        codes = self.class.constants - 
-                self.class.constants.grep(/XML_FROM/) -
-                ["XML_ERR_NONE", "XML_ERR_WARNING", "XML_ERR_ERROR", "XML_ERR_FATAL"]
-
-        
-        codes.each do |code|
-          human_name = code.gsub(/XML_ERR_/, '')
-          const_map[self.class.const_get(code)] = human_name
-        end
-
-        const_map[self.code]
+        ERROR_CODE_MAP[self.code]
       end
 
       def to_s

data/libxml-ruby.gemspec

@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir.glob("test/tc_*.rb")
   spec.required_ruby_version = '>= 1.8.6'
   spec.date = DateTime.now
+  spec.add_development_dependency('hanna_guado')
 end

data/test/tc_encoding_sax.rb

@@ -4,8 +4,7 @@ require 'test/unit'
 
 class SaxEncodingCallbacks
   attr_reader :encoding
-  #include Test::Unit::Assertions
-  include MiniTest::Assertions
+  include Test::Unit::Assertions
 
   def initialize
     @encoding = Encoding::UTF_8

data/test/tc_error.rb

@@ -159,4 +159,22 @@ class TestError < Test::Unit::TestCase
     end
     assert_equal('Must specify a string with one or more characters', error.to_s)
   end
+
+  def test_error_domain_to_s
+    exception = assert_raise(XML::Error) do
+      XML::Parser.string('<foo href="http://example.org/cgi?k1=v1&k2=v2"></foo>').parse
+    end
+
+    assert_equal(XML::Error::PARSER, exception.domain)
+    assert_equal("PARSER",exception.domain_to_s)
+  end
+
+  def test_error_code_to_s
+    exception = assert_raise(XML::Error) do
+      XML::Parser.string('<foo href="http://example.org/cgi?k1=v1&k2=v2"></foo>').parse
+    end
+    assert_equal(XML::Error::ENTITYREF_SEMICOL_MISSING, exception.code)
+    assert_equal("ENTITYREF_SEMICOL_MISSING",exception.code_to_s)
+  end
+
 end

data/test/tc_reader.rb

@@ -9,7 +9,7 @@ class TestReader < Test::Unit::TestCase
 
   def verify_simple(reader)
     node_types = []
-    
+
     # Read each node
     26.times do
       assert(reader.read)
@@ -145,6 +145,48 @@ class TestReader < Test::Unit::TestCase
     assert_equal(nil, parser[2])
   end
 
+  def test_move_to_attribute_depreciation
+    previous_stderr, $stderr = $stderr, StringIO.new
+    reader = XML::Reader.string("<foo x='1' y='2'/>")
+    assert(reader.read)
+    assert(reader.move_to_attribute 1)
+    assert($stderr.string =~ /deprecated/)
+  ensure
+    $stderr = previous_stderr
+  end
+
+  def test_move_attr
+      reader = XML::Reader.string('<root xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xhtml="http://www.w3.org/1999/xhtml"><link xml:id="abc" xlink:href="def" xhtml:class="ghi" bar="jkl" /></root>')
+      assert(reader.read) # <root/>
+      assert(reader.read) # <link/>
+
+      assert(reader.move_to_attribute_no(1))
+      assert_equal(reader.value, 'def')
+      assert(reader.move_to_attribute_ns('id', 'http://www.w3.org/XML/1998/namespace'))
+      assert_equal(reader.value, 'abc')
+      assert(reader.move_to_attribute('bar'))
+      assert_equal(reader.value, 'jkl')
+
+      # 1 in case of success, -1 in case of error, 0 if not found
+      assert_equal(reader.move_to_attribute_no(12), 0)
+      assert_equal(reader.move_to_attribute('baz'), 0)
+      assert_equal(reader.move_to_attribute_ns('baz', 'http://ruby/namespace'), 0)
+  end
+
+  def test_get_attr
+      reader = XML::Reader.string('<root xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xhtml="http://www.w3.org/1999/xhtml"><link xml:id="abc" xlink:href="def" xhtml:class="ghi" bar="jkl" /></root>')
+      assert(reader.read) # <root/>
+      assert(reader.read) # <link/>
+
+      assert_equal(reader.get_attribute_no(1), 'def')
+      assert_equal(reader.get_attribute_ns('id', 'http://www.w3.org/XML/1998/namespace'), 'abc')
+      assert_equal(reader.get_attribute('bar'), 'jkl')
+
+      assert_equal(reader.get_attribute_no(12), nil)
+      assert_equal(reader.get_attribute('baz'), nil)
+      assert_equal(reader.get_attribute_ns('baz', 'http://ruby/namespace'), nil)
+  end
+
   def test_value
     parser = XML::Reader.string("<foo><bar>1</bar><bar>2</bar><bar>3</bar></foo>")
     assert(parser.read)

data/test/tc_writer.rb

@@ -0,0 +1,427 @@
+# encoding: UTF-8
+
+require './test_helper'
+require 'stringio'
+require 'test/unit'
+
+class TestWriter < Test::Unit::TestCase
+  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_equal(writer.result.strip!, "<?xml version=\"1.0\"?>\n<root><child abc='def'>ghi</child></root>")
+    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
+
+  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)
+    writer.flush
+  end
+
+  def element(writer, localname)
+    assert(writer.start_element localname)
+    yield if block_given?
+    assert(writer.end_element)
+  end
+end