rsxml 0.1.2 → 0.1.3

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/rsxml.rb

@@ -4,7 +4,7 @@ require 'builder'
 module Rsxml
   module_function
 
-  # convert an s-expression representation of an XML document to XML
+  # convert an Rsxml s-expression representation of an XML document to XML
   #  Rsxml.to_xml(["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"] ["Baz"]])
   #   => '<Foo foofoo="10"><Bar>barbar</Bar><Baz></Baz></Foo>' 
   def to_xml(rsxml)
@@ -13,7 +13,7 @@ module Rsxml
     xml.target!
   end
 
-  # convert an XML string to an s-expression representation
+  # convert an XML string to an Rsxml s-expression representation
   #  Rsxml.to_rsxml('<Foo foofoo="10"><Bar>barbar</Bar><Baz></Baz></Foo>')
   #   => ["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"], ["Baz"]] 
   #
@@ -29,6 +29,14 @@ module Rsxml
     Xml.read_xml(root, [])
   end
 
+  # compare two documents in XML or Rsxml. returns +true+ if they are identical, and
+  # if not raises +ComparisonError+ describing where they differ
+  def compare(xml_or_sexp_a, xml_or_sexp_b)
+    sexp_a = xml_or_sexp_a.is_a?(String) ? to_rsxml(xml_or_sexp_a) : xml_or_sexp_a
+    sexp_b = xml_or_sexp_b.is_a?(String) ? to_rsxml(xml_or_sexp_b) : xml_or_sexp_b
+    Sexp.compare(sexp_a, sexp_b)
+  end
+
   module Sexp
     module_function
 
@@ -58,6 +66,33 @@ module Rsxml
       end
       [tag, attrs, children]
     end
+
+    class ComparisonError < RuntimeError
+      attr_reader :path
+      def initialize(msg, path)
+        super("[#{path}]: #{msg}")
+        @path = path
+      end
+    end
+
+    def compare(sexpa, sexpb, path=nil)
+      taga, attrsa, childrena = decompose_sexp(sexpa)
+      tagb, attrsb, childrenb = decompose_sexp(sexpb)
+
+      raise ComparisonError.new("element names differ: '#{taga}', '#{tagb}'", path) if taga != tagb
+      raise ComparisonError.new("attributes differ", path) if attrsa != attrsb
+      raise ComparisonError.new("child cound differes", path) if childrena.length != childrenb.length
+
+      path = [path, taga].compact.join("/")
+      (0...childrena.length).each do |i|
+        if childrena[i].is_a?(Array) && childrenb[i].is_a?(Array)
+          compare(childrena[i], childrenb[i], path)
+        else
+          raise ComparisonError.new("content differs: '#{childrena[i]}', '#{childrenb[i]}'", path) if childrena[i] != childrenb[i]
+        end
+      end
+      true
+    end
   end
 
   module Xml

data/spec/rsxml_spec.rb

@@ -111,4 +111,34 @@ describe Rsxml do
     end
 
   end
+
+  describe "compare" do
+    it "should return true when two simple docs are equivalent" do
+      Rsxml.compare(["Foo"], "<Foo></Foo").should == true
+    end
+
+    it "should return true when two simple docs with attributes are equivalent" do
+      Rsxml.compare([:foo, {:bar=>1, :baz=>"baz"}],
+                    [:foo, {:bar=>1, :baz=>"baz"}]).should == true
+    end
+
+    it "should return true when two more complex docs are equivalent" do
+      Rsxml.compare(["foo:foofoo", {"xmlns:foo"=>"http://foo.com/foo", "foo:bar"=>1, "foo:baz"=>"baz"}, ["Bar", "barbar"], ["Baz"]],
+                    ["foo:foofoo", {"xmlns:foo"=>"http://foo.com/foo", "foo:bar"=>1, "foo:baz"=>"baz"}, ["Bar", "barbar"], ["Baz"]]).should ==true
+    end
+
+    it "should raise an error when two simple docs differ" do
+      lambda {
+        Rsxml.compare(["Foo"], "<Boo></Boo").should == true
+      }.should raise_error("[]: element names differ: 'Foo', 'Boo'")
+    end
+
+    it "should raise an error when two more complex docs differ" do
+      lambda {
+        Rsxml.compare(["foo:foofoo", {"xmlns:foo"=>"http://foo.com/foo", "foo:bar"=>1, "foo:baz"=>"baz"}, ["Bar", "barbAr"], ["Baz"]],
+                      ["foo:foofoo", {"xmlns:foo"=>"http://foo.com/foo", "foo:bar"=>1, "foo:baz"=>"baz"}, ["Bar", "barbar"], ["Baz"]]).should ==true
+      }.should raise_error("[foo:foofoo/Bar]: content differs: 'barbAr', 'barbar'")
+
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsxml
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Trampoline Systems Ltd