testunitxml 0.1.3 → 0.1.4

data/CHANGES

@@ -0,0 +1,15 @@
+= Changes
+
+
+== Version 0.1.4
+
+* Added support for Doctype comparisons in +assert_xml_equal+
+* Added <tt>setup.rb</tt> file to distribution packages
+* Added installation section to README file
+* Added links to online tutorial to README file
+* Added CHANGES file
+
+
+== Version 0.1.3
+
+The initial release.

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+= MIT-LICENSE
+
+Copyright � 2006 Henrik M�rtensson
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
+IN THE SOFTWARE.

data/README

@@ -0,0 +1,119 @@
+= Test::Unit::XML
+== An XML Test Framework
+
+Version: 0.1.4
+
+Author: Henrik M�rtensson
+
+(c) 2006 by Henrik M�rtensson
+
+== Introduction
+
+Test::Unit::XML extends the Test::Unit framework with
+an assertion for testing well-formed XML documents.
+
+Using Test::Unit::XML is easy. All you have to do is to
+require +testunitxml+, and you will then have an
++assert_xml_equal+ assertion available in the
+Test::Unit::TestCase class.
+
+In addition to the API documentation included in the package, you can get information about how
+to use Test::Unit::XML from the following sources:
+
+* The online tutorial[http://kallokain.blogspot.com/2006/01/testunitxml-quick-start-tutorial.html] at
+  the Kallokain[http://kallokain.blogspot.com/] blog.
+* The {test cases}[link:../../test/] included in the distribution package.
+
+== Installation
+
+=== Install Using the +RubyGem+ Package Manager
+
+The easiest way to install Test::Unit::XML is to make a remote installation via the RubyGem
+package manager:
+
+<tt>gem install testunitxml</tt>
+
+If you have downloaded a gem package from Rubyforge, you can do a local installation:
+
+<tt>cd <em>download_directory_path</em></tt>
+
+<tt>gem install testunitxml -l</tt>
+
+=== Install from a Zip file or Tarball
+
+If you do not have RubyGem installed, you can download a Zip file or tarball and install
+from it instead:
+
+1::  Unpack the Zip or tarball archive.
+2::  cd to the directory you just unpacked.
+3::  Run the command:
+     <tt>ruby setup.rb install</tt>
+
+
+
+== What Does _Equal_ XML Documents Mean?
+
+It is hard to define exactly what _equal_ means in the
+context of XML documents. I have tried to follow W3C
+XML recommendations as far as possible. There are a
+few things worthy of note:
+
+* Namespace _declarations_, i.e. attributes that declare
+  namespaces, are ignored for comparison purposes. (The
+  namespaces _are_ used in comparisons.) The reason is
+  that XML processors may move the declarations from one
+  element to another, or change prefixes in ways that
+  cannot be directly controlled by a programmer. For
+  example, two different XSLT processors could use
+  the same stylesheet and produce XML documents that use
+  different namespace prefixes, and have declarations
+  on different elements, but are still considered equal.
+
+* Text nodes that are empty or contain only whitespace
+  are ignored for comparison purposes. This makes it
+  easier to test output from various transformation
+  engines. These often produce extraneous whitespace.
+
+== The Future
+
+There are a few things in the pipeline:
+
+* assert_xml_equal_structure - checks that the structure
+  of two documents are equal, but ignores content, attributes,
+  processing istructions, comments, CDATA, and doctype
+  declarations.
+* assert_xml_similar - Like assert_xml_equal, but ignores the
+  order of child elements.
+* Configurability. It _might_ be useful to be able to set
+  configuration options for testing. I'll have to think a
+  bit about this though.
+* Document difference functions, like the Java XMLUnit test
+  suite.
+
+I plan to implement these features as I need them in other
+projects, so there is no time plan, and no guarantee as to the
+order in which I'll implement anything.
+
+== License
+
+See the {MIT-LICENSE}[link:files/MIT-LICENSE.html] file.
+
+== Contact
+
+You can email bug reports, opinions and questions to
+mailto:self@henrikmartensson.org. You may also wish to visit
+my home page, www.henrikmartensson.org, for more information
+about Test::Unit::XML and other projects. I will write about
+Test::Unit::XML at the the Kallokain[http://kallokain.blogspot.com/]
+blog. You are welcome to visit, and comment.
+
+If you find Test::Unit::XML useful, please do tell me about it. I would like
+to list projects that use it on the {Test::Unit::XML web site}[http://testunitxml.rubyforge.org/].
+
+If you find Test::Unit::XML lacking in some respect, or buggy,
+I am even more interested. I can't fix bugs I do not know about.
+
+Finally, if you write about Test::Unit::XML, I'd like to link to
+the article on my web site, or at least mention it if you write
+for a magazine, so please tell me.
+

data/docs/html/classes/REXML/Attributes.html

@@ -94,7 +94,7 @@ that are useful for attribute collections, but not present in the standard
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000001">get_attribute_ns</a>&nbsp;&nbsp;
+      <a href="#M000004">get_attribute_ns</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -116,19 +116,19 @@ that are useful for attribute collections, but not present in the standard
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000001" class="method-detail">
-        <a name="M000001"></a>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
 
         <div class="method-heading">
-          <a href="Attributes.src/M000001.html" target="Code" class="method-signature"
-            onclick="popupCode('Attributes.src/M000001.html');return false;">
+          <a href="Attributes.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('Attributes.src/M000004.html');return false;">
           <span class="method-name">get_attribute_ns</span><span class="method-args">(namespace, name)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-The <tt><a href="Attributes.html#M000001">get_attribute_ns</a></tt> method
+The <tt><a href="Attributes.html#M000004">get_attribute_ns</a></tt> method
 retrieves a method by its namespace and name. Thus it is possible to
 reliably identify an attribute even if an XML processor has changed the
 prefix.

data/docs/html/classes/REXML/DocType.html

@@ -0,0 +1,207 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: REXML::DocType</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">REXML::DocType</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/test/unit/xml/doctype_mixin_rb.html">
+                lib/test/unit/xml/doctype_mixin.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The <a href="DocType.html">REXML::DocType</a> mix-in adds methods that are
+useful for Doctype declarations, but not present in the standard <a
+href="DocType.html">REXML::DocType</a> class
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000008">notation</a>&nbsp;&nbsp;
+      <a href="#M000007">notations</a>&nbsp;&nbsp;
+      <a href="#M000005">public</a>&nbsp;&nbsp;
+      <a href="#M000006">system</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="DocType.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('DocType.src/M000008.html');return false;">
+          <span class="method-name">notation</span><span class="method-args">(name)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Retrieves a named notation. Only notations declared in the internal DTD
+subset can be retrieved.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="DocType.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('DocType.src/M000007.html');return false;">
+          <span class="method-name">notations</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This method returns a list of notations that have been declared in the
+<em>internal</em> DTD subset. Notations in the external DTD subset are not
+listed.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="DocType.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('DocType.src/M000005.html');return false;">
+          <span class="method-name">public</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This method retrieves the public identifier identifying the
+document&#8217;s DTD.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="DocType.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('DocType.src/M000006.html');return false;">
+          <span class="method-name">system</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This method retrieves the system identifier identifying the
+document&#8217;s DTD
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/docs/html/classes/REXML/DocType.src/M000005.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>public (REXML::DocType)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/test/unit/xml/doctype_mixin.rb, line 9</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">public</span>
+      <span class="ruby-ivar">@long_name</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/docs/html/classes/REXML/DocType.src/M000006.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>system (REXML::DocType)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/test/unit/xml/doctype_mixin.rb, line 14</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">system</span>
+      <span class="ruby-ivar">@uri</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/docs/html/classes/REXML/DocType.src/M000007.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>notations (REXML::DocType)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/test/unit/xml/doctype_mixin.rb, line 20</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">notations</span>
+      <span class="ruby-identifier">children</span>().<span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">NotationDecl</span>)}
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/docs/html/classes/REXML/DocType.src/M000008.html

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>notation (REXML::DocType)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/test/unit/xml/doctype_mixin.rb, line 26</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">notation</span>(<span class="ruby-identifier">name</span>)
+      <span class="ruby-identifier">notations</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">notation_decl</span><span class="ruby-operator">|</span>
+        <span class="ruby-identifier">notation_decl</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>
+      }
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/docs/html/classes/REXML/NotationDecl.html

@@ -0,0 +1,188 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: REXML::NotationDecl</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">REXML::NotationDecl</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/test/unit/xml/notationdecl_mixin_rb.html">
+                lib/test/unit/xml/notationdecl_mixin.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The <a href="NotationDecl.html">REXML::NotationDecl</a> mix-in adds methods
+that are useful for notation declarations, but not present in the standard
+<a href="NotationDecl.html">REXML::NotationDecl</a> class
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">name</a>&nbsp;&nbsp;
+      <a href="#M000003">public</a>&nbsp;&nbsp;
+      <a href="#M000002">system</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="NotationDecl.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('NotationDecl.src/M000001.html');return false;">
+          <span class="method-name">name</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This method retrieves the name of the notation.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="NotationDecl.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('NotationDecl.src/M000003.html');return false;">
+          <span class="method-name">public</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This method retrieves the public identifier specified in the notation
+declaration. If there is no public identifier defined, the method returns
+<tt>nil</tt>
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="NotationDecl.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('NotationDecl.src/M000002.html');return false;">
+          <span class="method-name">system</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This method retrieves the system identifier specified in the notation
+declaration. If there is no system identifier defined, the method returns
+<tt>nil</tt>
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>