wax 0.9.4

data/lib/xml_util.rb

@@ -0,0 +1,108 @@
+# This module provides utility methods for working with XML.
+# 
+# Copyright 2008 R. Mark Volkmann
+# 
+# This file is part of WAX.
+#
+# WAX is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# Foobar 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with WAX.  If not, see http://www.gnu.org/licenses.
+# 
+# R. Mark Volkmann, Object Computing, Inc.
+module XMLUtil
+
+  # The default encoding used in XML declarations.
+  DEFAULT_ENCODING = "UTF-8"
+
+  NMTOKEN_PATTERN = /^[A-Za-z][A-Za-z0-9\-_\.]*$/
+  XMLSCHEMA_INSTANCE_NS = "http://www.w3.org/1999/XMLSchema-instance"
+
+  # Escapes special characters in XML text.
+  def self.escape(text)
+    return text unless text.kind_of?(String)
+
+    result = ""
+    text.each_byte do |c|
+      # TODO: Is using [0] the best way to do these comparisons?
+      if c == '<'[0]
+        result << "&lt;"
+      elsif c == '>'[0]
+        result << "&gt;"
+      elsif c == "'"[0]
+        result << "&apos;"
+      elsif c == '"'[0]
+        result << "&quot;"
+      elsif c == '&'[0]
+        result << "&amp;"
+      else
+        result << c
+      end
+    end
+        
+    result
+  end
+
+  # Determines whether given text is a valid comment.
+  def self.is_comment(text)
+    /--/ !~ text
+  end
+
+  # Determines whether given text is a name token.
+  def self.is_nmtoken(text)
+    return false if text == nil
+    (NMTOKEN_PATTERN =~ text) != nil
+  end
+
+  # Determines whether given text is a URI.
+  def self.is_uri(text)
+    # TODO: Finish this
+    true
+  end
+
+  # Determines whether given text is a valid XML version.
+  def self.is_version(text)
+    ["1.0", "1.1", "1.2"].include?(text)
+  end
+
+  # Verifies that the given text is a valid comment
+  # and raises an ArgumentError if it isn't.
+  def self.verify_comment(text)
+    unless is_comment(text)
+      raise ArgumentError, "\"#{text}\" is an invalid comment"
+    end
+  end
+
+  # Verifies that the given text is a valid name token
+  # and raises an ArgumentError if it isn't.
+  def self.verify_nmtoken(text)
+    unless is_nmtoken(text)
+      raise ArgumentError, "\"#{text}\" is an invalid NMTOKEN"
+    end
+  end
+
+  # Verifies that the given text is a valid URI
+  # and raises an ArgumentError if it isn't.
+  def self.verify_uri(text)
+    unless is_uri(text)
+      raise ArgumentError, "\"#{text}\" is an invalid URI"
+    end
+  end
+
+  # Verifies that the given text is a valid XML version
+  # and raises an ArgumentError if it isn't.
+  def self.verify_version(text)
+    unless is_version(text)
+      raise ArgumentError, "\"#{text}\" is an invalid XML version"
+    end
+  end
+
+end

data/test/test_wax.rb

@@ -0,0 +1,569 @@
+require 'stringio'
+require 'test/unit'
+require 'wax'
+
+# This class provides unit test methods for WAX.
+#
+# Copyright 2008 R. Mark Volkmann
+# 
+# This file is part of WAX.
+#
+# WAX is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# Foobar 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with WAX.  If not, see http://www.gnu.org/licenses.
+# 
+# author R. Mark Volkmann, Object Computing, Inc.
+class WAXTest < Test::Unit::TestCase
+
+  def get_file_first_line(file_path)
+    file = File.open(file_path)
+    line = file.readline
+    file.close
+    line
+  end
+
+  def setup
+    @sio = StringIO.new
+    @old_stdout, $stdout = $stdout, @sio
+  end
+  
+  def teardown
+    $stdout = @old_stdout
+  end
+  
+  def test_attributes
+    WAX.write do
+      set_indent nil
+      start 'root'
+      attr 'a1', 'v1'
+      attr 'a2', 2
+    end
+    
+    assert_equal '<root a1="v1" a2="2"/>', @sio.string
+  end
+  
+  def test_bad_attribute_name
+    assert_raise(ArgumentError) do
+      WAX.write do
+        start 'root'
+        attr '1a', 'value'
+      end
+    end
+  end
+  
+  def test_bad_cdata
+    assert_raise(RuntimeError) do
+      # Can't call cdata while in prologue section.
+      WAX.write { cdata "text" }
+    end
+  end
+  
+  def test_bad_child
+    assert_raise(RuntimeError) do
+      WAX.write do
+        start "root"
+        end_element
+        child "child", "text" # can't call child after root is closed
+      end
+    end
+  end
+
+  def test_bad_close_already_closed
+    assert_raise(RuntimeError) do
+      WAX.write do
+        start "root"
+        close
+        close # already closed
+      end
+    end
+  end
+  
+  def test_bad_close_without_root
+    assert_raise(RuntimeError) do
+      WAX.write { close } # didn't write anything yet
+    end
+  end
+  
+  def test_bad_close_then_write
+    assert_raise(RuntimeError) do
+      WAX.write do
+        start "root"
+        close
+        start "more" # already closed
+      end
+    end
+  end
+  
+  def test_bad_comment
+    assert_raise(ArgumentError) do
+      WAX.write do
+        start "root"
+        comment "foo--bar"
+      end
+    end
+  end
+  
+  def test_bad_dtd_after_root
+    assert_raise(RuntimeError) do
+      WAX.write do
+        start "root"
+        dtd "root.dtd" # can't specify DTD after root element
+      end
+    end
+  end
+  
+  def test_bad_element_name
+    assert_raise(ArgumentError) do
+      WAX.write { start "1root" }
+    end
+  end
+  
+  def test_bad_end
+    assert_raise(RuntimeError) do
+      WAX.write { end_element } # haven't called start yet
+    end
+  end
+  
+  def test_bad_indent_bad_chars
+    assert_raise(ArgumentError) do
+      WAX.write do
+        set_indent "abc" # must be nil, "", spaces or a single tab
+      end
+    end
+  end
+  
+  def test_bad_indent_negative
+    assert_raise(ArgumentError) do
+      WAX.write { set_indent(-1) } # must be >= 0
+    end
+  end
+  
+  def test_bad_indent_multiple_tabs
+    assert_raise(ArgumentError) do
+      WAX.write { set_indent "\t\t" } # more than one tab
+    end
+  end
+  
+  def test_bad_indent_too_large
+    assert_raise(ArgumentError) do
+      WAX.write { set_indent 5 } # must be <= 4
+    end
+  end
+    
+  def test_bad_namespace_duplicate_prefix
+    assert_raise(ArgumentError) do
+      # Can't define same namespace prefix more than once in the same scope.
+      WAX.write do
+        start "root"
+        namespace "tns", "http://www.ociweb.com/tns"
+        namespace "tns", "http://www.ociweb.com/tns"
+      end
+    end
+  end
+    
+  def test_bad_namespace_multiple_default
+    assert_raise(ArgumentError) do
+      # Can't define default namespace more than once in the same scope.
+      WAX.write do
+        start "root"
+        namespace "http://www.ociweb.com/tns1"
+        namespace "http://www.ociweb.com/tns2"
+      end
+    end
+  end
+    
+  def test_bad_prefix
+    assert_raise(ArgumentError) do
+      WAX.write do
+        start "root"
+        start "parent"
+        namespace "foo", "http://www.ociweb.com/foo"
+        child "foo", "child1", "one"
+        end_element
+        child "foo", "child2", "two"
+      end
+    end
+  end
+    
+  def test_bad_text
+    assert_raise(RuntimeError) do
+      WAX.write { text "text" } # haven't called start yet
+    end
+  end
+    
+  def test_bad_write
+    assert_raise(IOError) do
+      file_path = "temp.xml"
+      WAX.write(file_path) do
+        start "root"
+        @writer.close # closed the Writer instead of allowing WAX to do it
+        File.delete(file_path)
+        close # attempting to write more after the Writer was closed
+      end
+    end
+  end
+    
+  def test_bad_write_file
+    assert_raise(Errno::EISDIR) do
+      file_path = "." # the current directory, not a file
+      WAX.write(file_path) {}
+    end
+  end
+    
+  def test_bad_xslt_after_root
+    assert_raise(RuntimeError) do
+      WAX.write do
+        start "root"
+        xslt "root.xslt" # can't write pi after root element
+      end
+    end
+  end
+    
+  def test_big
+    WAX.write do
+      start "root"
+      nl_text "text #1"
+      child "child1", "text"
+      nl_text "text #2"
+      start "child2"
+      attr "a1", "v1"
+      end_element
+      nl_text "text #3"
+    end
+      
+    xml = "<root>\n" +
+      "  text #1\n" +
+      "  <child1>text</child1>\n" +
+      "  text #2\n" +
+      "  <child2 a1=\"v1\"/>\n" +
+      "  text #3\n" +
+      "</root>"
+      
+    assert_equal xml, @sio.string
+  end
+    
+  def test_blank_line
+    WAX.write do
+      start "root"
+      blank_line
+    end
+      
+    xml =
+      "<root>\n" +
+      "\n" +
+      "</root>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_cdata
+    WAX.write do
+      start "root"
+      cdata "1<2>3&4'5\"6"
+    end
+      
+    xml =
+      "<root>\n" +
+      "  <![CDATA[1<2>3&4'5\"6]]>\n" +
+      "</root>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_comment
+    WAX.write do
+      comment "comment #1"
+      comment "comment #2"
+      start "root"
+      comment "comment #3"
+    end
+      
+    xml =
+      "<!-- comment #1 -->\n" +
+      "<!-- comment #2 -->\n" +
+      "<root>\n" +
+      "  <!-- comment #3 -->\n" +
+      "</root>"
+      
+    assert_equal xml, @sio.string
+  end
+    
+  def test_dtd
+    WAX.write do
+      dtd "http://www.ociweb.com/xml/root.dtd"
+      start "root"
+    end
+      
+    xml =
+      "<!DOCTYPE root SYSTEM \"http://www.ociweb.com/xml/root.dtd\">\n" +
+      "<root/>"
+      
+    assert_equal xml, @sio.string
+  end
+    
+  def test_empty
+    WAX.write do
+      set_indent nil
+      start "root"
+    end
+      
+    assert_equal "<root/>", @sio.string
+  end
+    
+  def test_entity_def
+    WAX.write do
+      set_indent nil
+      entity_def "name", "value"
+      start "root"
+    end
+      
+    xml = "<!DOCTYPE root [<!ENTITY name \"value\">]><root/>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_external_entity_def
+    WAX.write do
+      set_indent nil
+      external_entity_def "name", "value"
+      start "root"
+    end
+      
+    xml = "<!DOCTYPE root [<!ENTITY name SYSTEM \"value\">]><root/>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_escape
+    WAX.write do
+      set_indent nil
+      start "root"
+      text "abc<def>ghi'jkl\"mno&pqr"
+    end
+      
+    xml = "<root>abc&lt;def&gt;ghi&apos;jkl&quot;mno&amp;pqr</root>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_extra_end
+    assert_raise(RuntimeError) do
+      WAX.write do
+        set_indent nil
+        start "root"
+        end_element
+        end_element
+      end
+    end
+  end
+    
+  def test_get_indent
+    wax = WAX.new
+    assert_equal "  ", wax.get_indent
+    
+    wax.set_indent "    "
+    assert_equal "    ", wax.get_indent
+
+    wax.set_indent "\t"
+    assert_equal "\t", wax.get_indent
+    
+    wax.set_indent nil
+    assert_equal nil, wax.get_indent
+    
+    wax.set_indent ""
+    assert_equal "", wax.get_indent
+  end
+    
+  def test_indent_by_num
+    WAX.write do
+      set_indent 2
+      start "root"
+      child "child", "text"
+    end
+      
+    xml = "<root>\n" + "  <child>text</child>\n" + "</root>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_indent_by_string
+    WAX.write do
+      set_indent "  "
+      start "root"
+      child "child", "text"
+    end
+      
+    xml = "<root>\n" + "  <child>text</child>\n" + "</root>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_namespace
+    WAX.write do
+      set_indent nil
+      start "root"
+      namespace "http://www.ociweb.com/tns1"
+      namespace "tns2", "http://www.ociweb.com/tns2"
+      namespace "tns3", "http://www.ociweb.com/tns3"
+    end
+      
+    xml = "<root" +
+      " xmlns=\"http://www.ociweb.com/tns1\"" +
+      " xmlns:tns2=\"http://www.ociweb.com/tns2\"" +
+      " xmlns:tns3=\"http://www.ociweb.com/tns3\"/>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_no_indent
+    WAX.write do
+      set_indent nil
+      start "root"
+      child "child", "text"
+    end
+      
+    xml = "<root><child>text</child></root>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_no_root
+    assert_raise(RuntimeError) do
+      WAX.write {}
+    end
+  end
+    
+  def test_processing_instruction_in_prologue
+    WAX.write do
+      processing_instruction "xml-stylesheet",
+        "type=\"text/xsl\" href=\"http://www.ociweb.com/foo.xslt\""
+      start "root"
+    end
+      
+    xml =
+      "<?xml-stylesheet type=\"text/xsl\" href=\"http://www.ociweb.com/foo.xslt\"?>\n" +
+      "<root/>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_processing_instruction_after_prologue
+    WAX.write do
+      set_indent nil
+      start "root"
+      processing_instruction "target", "data"
+    end
+      
+    xml = "<root><?target data?></root>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_prefix
+    WAX.write do
+      set_indent nil
+      start "foo", "root"
+      attr "bar", "baz"
+      # Note that the namespace is defined after it is used,
+      # but on the same element, which should be allowed.
+      namespace "foo", "http://www.ociweb.com/foo"
+    end
+      
+    xml = "<foo:root bar=\"baz\" " +
+      "xmlns:foo=\"http://www.ociweb.com/foo\"/>";
+    assert_equal xml, @sio.string
+  end
+    
+  def test_schemas_with_indent
+    WAX.write do
+      start "root"
+      namespace nil, "http://www.ociweb.com/tns1", "tns1.xsd"
+      namespace "tns2", "http://www.ociweb.com/tns2", "tns2.xsd"
+    end
+      
+    xml = "<root\n" +
+      "  xmlns=\"http://www.ociweb.com/tns1\"\n" +
+      "  xmlns:tns2=\"http://www.ociweb.com/tns2\"\n" +
+      "  xmlns:xsi=\"http://www.w3.org/1999/XMLSchema-instance\"\n" +
+      "  xsi:schemaLocation=\"" +
+      "http://www.ociweb.com/tns1 tns1.xsd\n" +
+      "    http://www.ociweb.com/tns2 tns2.xsd" +
+      "\"/>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_schemas_without_indent
+    WAX.write do
+      set_indent nil
+      start "root"
+      namespace nil, "http://www.ociweb.com/tns1", "tns1.xsd"
+      namespace "tns2", "http://www.ociweb.com/tns2", "tns2.xsd"
+    end
+      
+    xml = "<root" +
+      " xmlns=\"http://www.ociweb.com/tns1\"" +
+      " xmlns:tns2=\"http://www.ociweb.com/tns2\"" +
+      " xmlns:xsi=\"http://www.w3.org/1999/XMLSchema-instance\"" +
+      " xsi:schemaLocation=\"" +
+      "http://www.ociweb.com/tns1 tns1.xsd " +
+      "http://www.ociweb.com/tns2 tns2.xsd" +
+      "\"/>"
+    assert_equal xml, @sio.string
+  end
+    
+  def test_text
+    WAX.write do
+      set_indent nil
+      start "root"
+      text "text"
+    end
+      
+    assert_equal "<root>text</root>", @sio.string
+  end
+    
+  def test_trust_me_false
+    assert_raise(ArgumentError) do
+      WAX.write do
+        set_trust_me false
+        # Since error checking is turned on,
+        # element names must be valid and text is escaped.
+        start "123"
+        text "<>&'\""
+      end
+    end
+  end
+    
+  def test_trust_me_true
+    WAX.write do
+      set_trust_me true
+      set_indent nil
+      # Since error checking is turned off,
+      # invalid element names and unescaped text are allowed.
+      start "123"
+      text "<>&'\""
+    end
+      
+    assert_equal "<123><>&'\"</123>", @sio.string
+  end
+    
+  def test_write_file
+    file_path = "temp.xml"
+    WAX.write(file_path) do
+      set_indent nil
+      start "root"
+      text "text"
+    end
+      
+    assert_equal "<root>text</root>", get_file_first_line(file_path)
+    File.delete(file_path)
+  end
+    
+  def test_xml_declaration
+    WAX.write($stdout, "1.0") do
+      set_indent nil
+      start "root"
+    end
+      
+    xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<root/>"
+    assert_equal xml, @sio.string
+  end
+    
+end