xmatch 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Peter Moran
+
+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.markdown

@@ -0,0 +1,53 @@
+XMatch
+==============
+
+XMatch is a Ruby library for comparing two XML documents and reporting on mismatches. An XML document will match another if:
+
+* elements have the same name
+* elements have the same number of children
+* elements have the same number of attributes
+* attributes have the same value
+* text elements have the same content
+
+Blank elements are ignored.
+XMatch uses Nokogiri for xml parsing.
+
+Matching XML
+------------
+Given two XML documents as strings, XMatch is run by:
+
+	xml = Matcher::Xml.new(lhs)
+	xml.match(rhs)
+
+A matcher provides access to the match information by xpath values:
+
+	xml.matches
+	xml.mismatches
+
+Custom matchers
+---------------
+The actual value of some xml elements are hard to know in advance, timestamps and ids being typical examples. XMatch allows custom matches to be applied
+to provide a good guess at a match in advance of the match being run. Custom matchers are Ruby procs.
+
+	custom_matchers = "/bookstore/@id" => lambda {|elem| elem.value == '2'} 
+	xml = Matcher::Xml.new("<bookstore id='1'></bookstore>", custom_matchers)
+	xml.match("<bookstore id='2'></bookstore>") # ==> true
+
+Formatting match results
+------------------------
+
+The HTML formatter provides a cucumber-inspired report of the match results:
+
+	Matcher::HtmlFormatter.new(xml).format
+
+Installation
+------------
+
+XMatch is packaged as a Gem.  Install with:
+
+    gem install xmatch
+
+Copyright
+---------
+
+Copyright (c) 2009 Peter Moran. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,31 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require "rubygems"
+require "rake"
+require "rake/clean"
+
+require 'xmatch'
+
+require "spec/rake/spectask"
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  # spec.spec_opts << "-Du"
+  spec.spec_opts << "--color"
+end
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.rcov = true
+end
+
+desc "Match two xml documents"
+task :match, :lhs, :rhs do |t, args|
+  puts "** Matching #{args[:lhs]} with #{args[:rhs]}"
+  xml = Matcher::Xml.new(File.read(args[:lhs]))
+  xml.match(File.read(args[:rhs]))
+  Matcher::HtmlFormatter.new(xml).format
+end

data/lib/matcher/html_formatter.rb

@@ -0,0 +1,47 @@
+require 'erb'
+require 'fileutils'
+
+module Matcher
+
+  class HtmlFormatter
+
+    TEMPLATE = File.dirname(__FILE__) + '/xmatch.html.erb'
+
+    def initialize(matcher, args = {})
+      @matcher = matcher
+      @report_dir = args[:report_dir] || File.dirname(__FILE__) + '/../../reports'
+    end
+
+    def format
+      FileUtils.mkdir_p(@report_dir)
+      File.open(File.join(@report_dir, "xmatch.html"), 'w') { |f|  f.write(generate_html) }
+    end
+
+    private
+    
+      def generate_html
+        actual_filename = create_actual_file
+        expected_filename = create_expected_file
+        xml = @matcher        
+        html = ERB.new(File.read(TEMPLATE))
+        html.result(binding)        
+      end
+    
+      def create_expected_file
+        write_xml("expected.xml", @matcher.lhs)
+      end
+
+      def create_actual_file
+        write_xml("actual.xml", @matcher.rhs)
+      end
+
+      def write_xml(name, xml)
+        File.open(File.join(@report_dir, name), 'w') { |f| f.write(xml)}
+        name
+      end
+
+      
+      
+  end
+
+end

data/lib/matcher/nokogiri_extensions.rb

@@ -0,0 +1,76 @@
+require 'nokogiri'
+
+module Nokogiri
+
+  module XML
+
+    class Element
+
+      def match?(other, matcher)
+        @matcher = matcher
+        children_match?(other) &&
+          name_matches?(other) &&
+          attributes_match?(other)
+      end
+
+      private
+
+        def children_match?(other)
+          match = children.size == other.children.size
+          @matcher.record(path, match, "expected #{children.size} children, got #{other.children.size}")
+          match
+        end
+
+        def name_matches?(other)
+          match = name == other.name
+          @matcher.record(path, match, "expected element '#{name}', got '#{other.name}'")
+          match
+        end
+
+        def attributes_match?(other)
+          match = attributes.size == other.attributes.size
+          if match
+            attributes.each_pair do |name, lhs|
+              match = match && lhs.match?(other.attributes[name], @matcher)
+            end
+          else
+            @matcher.record(path, match, "expected #{attributes.size} attributes, got #{other.attributes.size}")
+          end
+          match
+        end
+
+    end
+
+    class Document
+      def match?(other, matcher = nil)
+        true
+      end
+    end
+
+    class Text
+      def match?(other, matcher)
+        custom_matcher = matcher.custom_matchers[path]
+        match = custom_matcher ? custom_matcher.call(other) : (content == other.content)        
+        matcher.record(path, match, "expected '#{content}', got '#{other.content}'")
+        match
+      end
+    end
+
+    class Attr
+      def match?(other, matcher)
+        if other.nil?
+          # record parent's path: nokogiri's traverse won't find attrs as children, so formatter won't report on them
+          matcher.record(parent.path, false, "expected attribute missing")
+          return false
+        end
+
+        custom_matcher = matcher.custom_matchers[path]
+        match = custom_matcher ? custom_matcher.call(other) : (value == other.value)
+        matcher.record(parent.path, match, "attribute '#{name}' expected '#{value}', got '#{other.value}'")
+        match
+      end
+    end
+
+  end
+
+end

data/lib/matcher/text_formatter.rb

@@ -0,0 +1,26 @@
+module Matcher
+
+  class TextFormatter
+
+    def format(matcher)
+      if matcher.mismatches.empty?
+        puts "Documents matched"
+      else
+        puts "Documents didn't match:"
+        puts matcher.mismatches.to_a.join(' : ')
+        puts 
+        matcher.lhs.traverse do |e|
+          print e.path
+          mismatch = matcher.mismatches[e.path]
+          if mismatch
+            puts " <====== #{mismatch}"
+          else
+            puts
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/matcher/version.rb

@@ -0,0 +1,3 @@
+module Representative
+  VERSION = "0.1.1".freeze
+end

data/lib/matcher/xmatch.html.erb

@@ -0,0 +1,49 @@
+<!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>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+
+	<title>XMatch Report</title>
+	
+	<style type="text/css">
+		body { background-color: #fff; color: #333; }
+
+		body, p, ol, ul, td {
+		  font-family: verdana, arial, helvetica, sans-serif;
+		  font-size:   12px;
+		  line-height: 18px;
+		}
+	
+		.matched {	background-color: #DBFFB4 }
+		.mismatched { background-color: #FA5858 }
+		.unmatched { background-color: #FFFBD3 }
+	 </style>	
+	
+</head>
+
+<body>
+
+<h2>XMatch Report</h2>
+<p><%= xml.mismatches.size %> mismatches found</p>
+<p><a href='<%=expected_filename%>'>Expected xml</a> | <a href='<%=actual_filename%>'>Actual xml</a></p>
+
+<table border="0" cellspacing="2" cellpadding="5">
+	<tr>
+		<th>Line</th>
+		<th>Path</th>
+		<th>Mismatch</th>
+	</tr>
+	<% xml.lhs.traverse do | elem | %>
+	  <% next if elem.xml? %>
+	<tr class=<%= xml.result_for(elem.path)  %> >
+		<td><%= elem.line %></td>
+		<td><%= elem.path %></td>
+  		<td><%= xml.mismatches[elem.path] || '&nbsp;' %></td>
+	</tr>
+	<% end %>
+</table>
+
+</body>
+</html>

data/lib/matcher/xml.rb

@@ -0,0 +1,62 @@
+require 'matcher/nokogiri_extensions'
+require 'ostruct'
+
+module Matcher
+
+  class Xml
+
+    attr_reader :lhs, :rhs, :custom_matchers
+
+    def initialize(lhs, custom_matchers = {})
+      @lhs = parse(lhs)
+      @custom_matchers = custom_matchers
+      @results = {}
+    end
+
+    def match(actual)
+      @results.clear
+      @rhs = parse(actual)
+      compare(@lhs, @rhs)
+    end
+
+    def record(path, result, message = nil)
+      @results[path] = OpenStruct.new(:result => result, :message => message)
+    end
+
+    def result_for(path)
+      return "matched" if matches[path]
+      return "mismatched" if mismatches[path]
+      "unmatched"
+    end
+
+    def matches
+      match_info = {}
+      @results.each_pair { |k, v| match_info[k] = '' if v.result }
+      match_info
+    end
+    
+    def mismatches
+      match_info = {}
+      @results.each_pair { |k, v| match_info[k] = v.message unless v.result }
+      match_info
+    end
+
+    private
+
+      def parse(xml)
+        xml_as_string = xml.instance_of?(Nokogiri::XML::Document) ? xml.to_xml : xml
+        Nokogiri::XML(xml_as_string) { |config| config.noblanks }
+      end
+
+      def compare(lhs, rhs)
+        return false unless lhs && rhs
+        match = lhs.match?(rhs, self)
+        lhs.children.each_with_index do |child, i|
+          match = match & compare(child, rhs.children[i])
+        end
+        match
+      end
+
+  end
+
+end

data/lib/xmatch.rb

@@ -0,0 +1,4 @@
+require 'matcher/nokogiri_extensions'
+require 'matcher/xml'
+require 'matcher/text_formatter'
+require 'matcher/html_formatter'

data/spec/fixtures/books1.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/fixtures/books10.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">Learning XMLxxx</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/fixtures/books2.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/fixtures/books3.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <authorxxx>James McGovern</authorxxx>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/fixtures/books4.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">Learning XMLx</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/fixtures/books5.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEBx">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/fixtures/books6.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book categoryx="WEB">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/fixtures/books7.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+<book category="foo">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/fixtures/books8.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+
+
+
+</bookstore>

data/spec/fixtures/books9.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bookstore>
+
+<book category="COOKING">
+  <title lang="en">Everyday Italian</title>
+  <author>Giada De Laurentiis</author>
+  <year>2005</year>
+  <price>30.00</price>
+</book>
+
+<book category="CHILDREN">
+  <title lang="en">Harry Potter</title>
+  <author>J K. Rowling</author>
+  <year>2005</year>
+  <price>29.99</price>
+</book>
+
+<book category="WEB">
+  <title lang="en">XQuery Kick Start</title>
+  <author>James McGovern</author>
+  <author>Per Bothner</author>
+  <author>Kurt Cagle</author>
+  <author>James Linn</author>
+  <author>Vaidyanathan Nagarajan</author>
+  <year>2003</year>
+  <price>49.99</price>
+</book>
+
+<book category="WEB" foo="bar">
+  <title lang="en">Learning XML</title>
+  <author>Erik T. Ray</author>
+  <year>2003</year>
+  <price>39.95</price>
+</book>
+
+</bookstore>

data/spec/matcher/smoke_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'matcher/xml'
+
+describe Matcher::Xml do
+  
+  it "should compare files" do
+    1.upto(10) do |i|
+      instance_variable_set("@xml#{i}", open(File.expand_path(File.join(__FILE__, "../../fixtures/books#{i}.xml"))).read)
+    end
+
+    xml = Matcher::Xml.new(@xml1)
+    xml.match(@xml2).should be_true
+    xml.match(@xml3).should be_false
+    xml.match(@xml4).should be_false
+    xml.match(@xml5).should be_false
+    xml.match(@xml6).should be_false
+    xml.match(@xml7).should be_false
+    xml.match(@xml9).should be_false
+    xml.match(@xml10).should be_false
+    xml.match(@xml8).should be_true
+    
+    Matcher::Xml.new(@xml7).match(@xml1).should be_false
+  end
+  
+end

data/spec/matcher/xml_spec.rb

@@ -0,0 +1,328 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'nokogiri'
+
+describe Matcher::Xml do
+
+  def verify_mismatch(path, message)
+    @xml.match(@rhs).should be_false
+    @xml.mismatches.should have(1).mismatch
+    @xml.mismatches[path].should == message
+  end
+
+  context "attributes" do
+
+    before(:each) do
+      @xml = Matcher::Xml.new("<foo></foo>")
+    end
+
+    it "should initialise with a string" do
+      @xml.lhs.should be_a_kind_of(Nokogiri::XML::Document)
+    end
+
+    it "should initialise with a document" do
+      @xml.lhs.should be_a_kind_of(Nokogiri::XML::Document)
+    end
+
+    it "should provide the rhs after a match" do
+      @xml.match("<bar></bar>")
+      @xml.rhs.should be_a_kind_of(Nokogiri::XML::Document)
+    end
+
+  end
+
+  before(:each) do
+    @lhs = <<-eos
+    <bookstore>
+    <book category="COOKING">
+    <title lang="en">Everyday Italian</title>
+    </book>
+    </bookstore>
+    eos
+    @xml = Matcher::Xml.new(@lhs)
+  end
+
+  context "matching" do
+
+    it "should be true when documents match" do
+      Matcher::Xml.new(@lhs).match(@lhs.clone).should be_true
+    end
+
+    it "should provide empty mismatches on match" do
+      @xml.match(@lhs.clone).should be_true
+      @xml.mismatches.should be_empty
+    end
+
+    it "should ignore blank elements" do
+      rhs = <<-eos
+      <bookstore>
+      <book category="COOKING">
+      <title lang="en">Everyday Italian</title>
+      </book>
+
+
+      </bookstore>
+      eos
+      @xml.match(rhs).should be_true
+    end
+
+    it "should be true when a string is matched with a document" do
+      rhs = <<-eos
+      <bookstore>
+      <book category="COOKING">
+      <title lang="en">Everyday Italian</title>
+      </book>
+
+
+      </bookstore>
+      eos
+
+      Matcher::Xml.new(@lhs).match(Nokogiri::XML(rhs)).should be_true
+    end
+
+    context "elements" do
+
+      it "should not match when rhs has an extra element" do
+        @rhs = <<-eos
+        <bookstore>
+        <book category="COOKING">
+        <title lang="en">Everyday Italian</title>
+        </book>
+        <book></book>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore", "expected 1 children, got 2")
+      end
+
+      it "should not match when rhs has a missing element" do
+        @lhs = <<-eos
+        <bookstore>
+        <book category="COOKING">
+        <title lang="en">Everyday Italian</title>
+        </book>
+        </bookstore>
+        eos
+
+        @rhs = <<-eos
+        <bookstore>
+        <book category="COOKING">
+        </book>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore/book/title", "expected 1 children, got 0")
+      end
+
+    end
+
+    context "names" do
+
+      it "should not match when rhs has a different element name" do
+        @rhs = <<-eos
+        <bookstore>
+        <bookx category="COOKING">
+        <title lang="en">Everyday Italian</title>
+        </bookx>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore/book", "expected element 'book', got 'bookx'")
+      end
+
+    end
+
+    context "attributes" do
+
+      it "should not match when an attribute names don't match" do
+        @rhs = <<-eos
+        <bookstore>
+        <book categoryx="COOKING">
+        <title lang="en">Everyday Italian</title>
+        </book>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore/book", "expected attribute missing")
+      end
+
+      it "should not match when an attribute value doesn't match" do
+        @rhs = <<-eos
+        <bookstore>
+        <book category="COOKINGx">
+        <title lang="en">Everyday Italian</title>
+        </book>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore/book", "attribute 'category' expected 'COOKING', got 'COOKINGx'")
+      end
+
+      it "should not match when rhs has an extra attribute" do
+        @rhs = <<-eos
+        <bookstore>
+        <book category="COOKING" foo="bar">
+        <title lang="en">Everyday Italian</title>
+        </book>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore/book", "expected 1 attributes, got 2")
+      end
+
+      it "should not match when rhs has less attributes" do
+        @rhs = <<-eos
+        <bookstore>
+        <book category="COOKING">
+        <title>Everyday Italian</title>
+        </book>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore/book/title", "expected 1 attributes, got 0")
+      end
+
+      it "should not match when rhs has more attributes" do
+        @rhs = <<-eos
+        <bookstore>
+        <book category="COOKING">
+        <title lang="en" foo="bar">Everyday Italian</title>
+        </book>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore/book/title", "expected 1 attributes, got 2")
+      end
+
+    end
+
+    context "contents" do
+
+      it "should not match when inner text contents don't match" do
+        @rhs = <<-eos
+        <bookstore>
+        <book category="COOKING">
+        <title lang="en">Everyday Italianx</title>
+        </book>
+        </bookstore>
+        eos
+        verify_mismatch("/bookstore/book/title/text()", "expected 'Everyday Italian', got 'Everyday Italianx'")
+      end
+
+    end
+
+  end
+
+  context "mismatches" do
+
+    it "should be empty to start with" do
+      Matcher::Xml.new(@lhs).mismatches.should be_empty
+    end
+
+    it "should be reset when rematching" do
+      rhs = <<-eos
+      <bookstore>
+      <book category="COOKING">
+      </book>
+      </bookstore>
+      eos
+      @xml.match(rhs)
+      @xml.mismatches.should_not be_empty
+      @xml.match(@lhs)
+      @xml.mismatches.should be_empty
+    end
+
+    it 'can have multiple mismatches' do
+      rhs = <<-eos
+      <bookstorex>
+      <book>
+      <title lang="en">Everyday Italian</title>
+      </book>
+      </bookstore>
+      eos
+      @xml.match(rhs)
+      @xml.mismatches.should have(2).mismatches
+    end
+
+    it "should contain parent's path when an attribute doesn't match" do
+
+      lhs = <<-eos
+      <bookstore>
+      <book category="COOKING">
+      <title lang="en">Everyday Italian</title>
+      </book>
+      <book category="FOO">
+      <title lang="en">Everyday French</title>
+      </book>
+      </bookstore>
+      eos
+
+
+      @rhs = <<-eos
+      <bookstore>
+      <book category="COOKING">
+      <title lang="en">Everyday Italian</title>
+      </book>
+      <book foo="bar">
+      <title lang="en">Everyday French</title>
+      </book>
+      </bookstore>
+      eos
+
+      @xml = Matcher::Xml.new(lhs)
+      verify_mismatch("/bookstore/book[2]", "expected attribute missing")
+    end
+
+    context 'matches' do
+
+      it "should be provided with no message" do
+        lhs = "<bookstore><book></book></bookstore>"
+        xml = Matcher::Xml.new(lhs)
+        xml.match(lhs)
+        xml.matches.should have(2).matches
+        xml.matches.should include("/bookstore")
+        xml.matches.values.all? {|m| m == ''}.should be_true
+      end
+
+    end
+
+  end
+
+  context "match results" do
+    
+    it "provides all results"
+
+    it "returns 'matched' for a path that matched correctly" do
+      xml = Matcher::Xml.new("<bookstore></bookstore>")
+      xml.match("<bookstore></bookstore>")
+      xml.result_for("/bookstore").should == "matched"
+    end
+
+    it "returns 'mismatched' for a path that was mismatched" do
+      xml = Matcher::Xml.new("<bookstore></bookstore>")
+      xml.match("<bookstorex></bookstorex>")
+      xml.result_for("/bookstore").should == "mismatched"
+    end
+    
+    it "returns 'unmatched' for a path that was not matched at all" do
+      xml = Matcher::Xml.new("<bookstore><foo></foo></bookstore>")
+      xml.match("<bookstorex></bookstorex>")
+      xml.result_for("/bookstore/foo").should == "unmatched"
+    end
+
+  end
+  
+  context "custom matchers" do
+    
+    it "can be provided" do
+      xml = Matcher::Xml.new("<bookstore id='1'></bookstore>", {"my path" => "my predicate"})
+      xml.custom_matchers.should have(1).matcher
+    end
+    
+    it "can be used on an attribute value" do
+      custom_matchers = { "/bookstore/@id" => lambda {|elem| elem.value == '2'} }
+      xml = Matcher::Xml.new("<bookstore id='1'></bookstore>", custom_matchers)
+      xml.match("<bookstore id='2'></bookstore>").should be_true
+    end
+    
+    it "can be used on an element value" do
+      custom_matchers = { "/bookstore/book/text()" => lambda {|elem| elem.content == 'bar'} }
+      xml = Matcher::Xml.new("<bookstore><book>foo</book></bookstore", custom_matchers)
+      xml.match("<bookstore><book>bar</book></bookstore").should be_true 
+    end
+    
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+require "bundler/setup"
+require "nokogiri"
+require 'xmatch'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: xmatch
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Peter Moran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-18 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: 
+email: workingpeter@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/matcher/html_formatter.rb
+- lib/matcher/nokogiri_extensions.rb
+- lib/matcher/text_formatter.rb
+- lib/matcher/version.rb
+- lib/matcher/xmatch.html.erb
+- lib/matcher/xml.rb
+- lib/xmatch.rb
+- README.markdown
+- LICENSE
+- spec/fixtures/books1.xml
+- spec/fixtures/books10.xml
+- spec/fixtures/books2.xml
+- spec/fixtures/books3.xml
+- spec/fixtures/books4.xml
+- spec/fixtures/books5.xml
+- spec/fixtures/books6.xml
+- spec/fixtures/books7.xml
+- spec/fixtures/books8.xml
+- spec/fixtures/books9.xml
+- spec/matcher/smoke_spec.rb
+- spec/matcher/xml_spec.rb
+- spec/spec_helper.rb
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/pmoran/xmatch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby library for comparing XML documents and reporting on mismatches
+test_files: 
+- spec/fixtures/books1.xml
+- spec/fixtures/books10.xml
+- spec/fixtures/books2.xml
+- spec/fixtures/books3.xml
+- spec/fixtures/books4.xml
+- spec/fixtures/books5.xml
+- spec/fixtures/books6.xml
+- spec/fixtures/books7.xml
+- spec/fixtures/books8.xml
+- spec/fixtures/books9.xml
+- spec/matcher/smoke_spec.rb
+- spec/matcher/xml_spec.rb
+- spec/spec_helper.rb
+- Rakefile