xmatch 0.1.4 → 0.1.5

data/README.markdown

@@ -27,9 +27,9 @@ A matcher provides access to the match information by xpath values:
 Custom matchers
 ---------------
 The actual values of some xml elements are hard to know in advance (timestamps and ids being typical examples). XMatch allows custom matchers to be applied
-to provide a good guess at a match in advance of the match being run. Custom matchers are Ruby Procs that take the element to match as an argument. They are  identified by the xpath of the element they should be applied to.
+to provide a good guess at a match in advance of the match being run. Custom matchers are predicates provided as Ruby Procs, identified by the xpath of the element they should be applied to.
 
-	custom_matchers = { "/bookstore/@id" => lambda {|elem| elem.value =~ /\d+/} }
+	custom_matchers = { "/bookstore/@id" => lambda {|elem| elem.value.match(/\d+/) }
 	xml = Matcher::Xml.new("<bookstore id='1'></bookstore>", custom_matchers)
 	xml.match("<bookstore id='2'></bookstore>") # ==> true
 

data/lib/matcher/html_formatter.rb

@@ -22,35 +22,38 @@ module Matcher
         elem.attributes.values.each { | attr | match_data << match_info_for(attr) }
       end
       match_data.sort! {|a, b| a.line <=> b.line}
-      
+
       FileUtils.mkdir_p(@report_dir)
-      filename = "xmatch.html"
-      filename = "#{@prefix}-xmatch.html" if @prefix
+      filename = @prefix ? "#{@prefix}-xmatch.html" : "xmatch.html"
       File.open(File.join(@report_dir, filename), 'w') { |f|  f.write(generate_html(match_data)) }
     end
 
     private
-      
+
       def match_info_for(elem)
+        info = @matcher.results[elem.path]
         result = @matcher.result_for(elem.path)
-        message = result == "unmatched" ? "Unmatched" : @matcher.mismatches[elem.path]
-        OpenStruct.new(:result => result, :line => elem.line, :path => elem.path, :message => message)
+        OpenStruct.new(:result => result,
+                       :line => elem.line,
+                       :path => elem.path,
+                       :expected => info ? info.expected : Matcher::Xml::EXISTENCE,
+                       :actual => info ? info.actual : Matcher::Xml::UNMATCHED)
       end
-    
+
       def generate_html(data)
         actual_filename = create_actual_file
         expected_filename = create_expected_file
-        xml = @matcher  
+        xml = @matcher
         completedness = compute_completedness
         match_info = data
         html = ERB.new(File.read(TEMPLATE))
-        html.result(binding)        
+        html.result(binding)
       end
-    
+
       def compute_completedness
         (@matcher.matches.size.to_f / @matcher.results.size.to_f * 100).to_i
       end
-    
+
       def create_expected_file
         write_xml("expected", @matcher.lhs)
       end
@@ -61,11 +64,11 @@ module Matcher
 
       def write_xml(name, xml)
         file_name = "#{name}-#{Time.now.to_i}.xml"
-        file_name = "#{@prefix}-#{file_name}" if @prefix 
+        file_name = "#{@prefix}-#{file_name}" if @prefix
         File.open(File.join(@report_dir, file_name), 'w') { |f| f.write(xml)}
         file_name
       end
-      
+
   end
 
 end

data/lib/matcher/nokogiri_extensions.rb

@@ -8,7 +8,7 @@ module Nokogiri
       
       def matching(other, matcher)
         other_elem = other.at_xpath(path)
-        matcher.record(self, false, Matcher::Xml::NOT_FOUND) unless other_elem
+        matcher.record(self.path, false, Matcher::Xml::EXISTENCE, Matcher::Xml::NOT_FOUND) unless other_elem
         other_elem
       end
     end
@@ -34,14 +34,14 @@ module Nokogiri
 
         def children_match?(other)
           match = children.size == other.children.size
-          @matcher.record(self, match, "expected #{children.size} children, got #{other.children.size}")
+          @matcher.record(self.path, match, "#{children.size} children", "#{other.children.size} children")
           match
         end
 
         def attributes_match?(other)
           match = attributes.size == other.attributes.size
           unless match
-            @matcher.record(self, match, "expected #{attributes.size} attributes, got #{other.attributes.size}")
+            @matcher.record(self.path, match, "#{attributes.size} attributes", "#{other.attributes.size} attributes")
             return false
           end
 
@@ -60,7 +60,7 @@ module Nokogiri
 
         custom_matcher = matcher.custom_matchers[path]
         match = custom_matcher ? custom_matcher.call(other_elem) : (content == other_elem.content)
-        @matcher.record(self, match, "expected '#{content}', got '#{other_elem.content}'")
+        @matcher.record(self.path, match, content, other_elem.content)
         match
       end
 
@@ -74,7 +74,7 @@ module Nokogiri
 
         custom_matcher = matcher.custom_matchers[path]
         match = custom_matcher ? custom_matcher.call(other_elem) : (value == other_elem.value)
-        matcher.record(self, match, "expected '#{value}', got '#{other_elem.value}'")
+        matcher.record(self.path, match, value, other_elem.value)
         match
       end
 

data/lib/matcher/version.rb

@@ -1,3 +1,3 @@
 module Representative
-  VERSION = "0.1.4".freeze
+  VERSION = "0.1.5".freeze
 end

data/lib/matcher/xmatch.html.erb

@@ -35,13 +35,15 @@ Expected xml document is <b><%= completedness %>%</b> 'matched'.
 	<tr>
 		<th>Line</th>
 		<th>Path</th>
-		<th>Mismatch</th>
+		<th>Expected</th>
+		<th>Actual</th>
 	</tr>
 	<% match_info.each do | match | %>
 	<tr class=<%= match.result  %> >
 		<td><%= match.line %></td>
 		<td><%= match.path %></td>
-  		<td><%= match.message || '&nbsp;' %></td>
+  		<td><%= match.expected %></td>
+  		<td><%= match.actual %></td>
 	</tr>		
 	<% end %>
 </table>

data/lib/matcher/xml.rb

@@ -5,7 +5,9 @@ module Matcher
 
   class Xml
     
-    NOT_FOUND = "Not found in compared document"
+    NOT_FOUND = "[Not found]"
+    EXISTENCE = "[Existence]"
+    UNMATCHED = "[Unmatched]"
 
     attr_reader :lhs, :rhs, :custom_matchers, :results
 
@@ -21,8 +23,10 @@ module Matcher
       compare(@lhs, @rhs)
     end
 
-    def record(lhs, result, message)
-      @results[lhs.path] = OpenStruct.new(:result => result, :message => message)
+    def record(path, result, expected, actual)
+      # support 0 as true (for regex matches)
+      r = !result || result.nil? ? false : true
+      @results[path] = OpenStruct.new(:result => r, :expected => expected, :actual => actual)
     end
 
     def result_for(path)
@@ -43,7 +47,7 @@ module Matcher
     
       def results_that_are(value)
         match_info = {}
-        @results.each_pair { |path, info| match_info[path] = info.message if info.result == value}
+        @results.each { |path, info| match_info[path] = info if info.result == value}
         match_info
       end
 

data/spec/matcher/html_formatter_spec.rb

@@ -4,8 +4,5 @@ require 'nokogiri'
 
 describe Matcher::HtmlFormatter do
 
-  it "should allow output file to be specified"
-  
-  it "should show percentage complete"
 
 end

data/spec/matcher/xml_spec.rb

@@ -4,10 +4,12 @@ require 'nokogiri'
 
 describe Matcher::Xml do
 
-  def verify_mismatch(path, message, count = 1)
+  def verify_mismatch(path, expected, actual, count = 1)
     match = @xml.match(@rhs)
     @xml.mismatches.should have(count).mismatch
-    @xml.mismatches[path].should == message
+    @xml.mismatches[path].result.should be_false
+    @xml.mismatches[path].expected.should == expected.to_s
+    @xml.mismatches[path].actual.should == actual
   end
 
   context "attributes" do
@@ -91,7 +93,7 @@ describe Matcher::Xml do
         <book></book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore", "expected 1 children, got 2")
+        verify_mismatch("/bookstore", "1 children", "2 children")
       end
 
       it "should not match when rhs has a missing element" do
@@ -101,7 +103,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book/title", Matcher::Xml::NOT_FOUND, 2)
+        verify_mismatch("/bookstore/book/title", Matcher::Xml::EXISTENCE, Matcher::Xml::NOT_FOUND, 2)
       end
 
     end
@@ -116,7 +118,7 @@ describe Matcher::Xml do
         </bookx>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book", Matcher::Xml::NOT_FOUND, 3)
+        verify_mismatch("/bookstore/book", Matcher::Xml::EXISTENCE, Matcher::Xml::NOT_FOUND, 3)
       end
 
     end
@@ -131,7 +133,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book/@category", Matcher::Xml::NOT_FOUND)
+        verify_mismatch("/bookstore/book/@category", Matcher::Xml::EXISTENCE, Matcher::Xml::NOT_FOUND)
       end
 
       it "should not match when an attribute value doesn't match" do
@@ -142,7 +144,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book/@category", "expected 'COOKING', got 'COOKINGx'")
+        verify_mismatch("/bookstore/book/@category", 'COOKING', "COOKINGx")
       end
 
       it "should not match when rhs has an extra attribute" do
@@ -153,7 +155,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book", "expected 1 attributes, got 2")
+        verify_mismatch("/bookstore/book", "1 attributes", "2 attributes")
       end
 
       it "should not match when rhs has less attributes" do
@@ -164,7 +166,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book/title", "expected 1 attributes, got 0")
+        verify_mismatch("/bookstore/book/title", "1 attributes", "0 attributes")
       end
 
       it "should not match when rhs has more attributes" do
@@ -175,7 +177,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book/title", "expected 1 attributes, got 2")
+        verify_mismatch("/bookstore/book/title", "1 attributes", "2 attributes")
       end
 
     end
@@ -190,7 +192,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book/title/text()", "expected 'Everyday Italian', got 'Everyday Italianx'")
+        verify_mismatch("/bookstore/book/title/text()", "Everyday Italian", "Everyday Italianx")
       end
 
     end
@@ -257,7 +259,7 @@ describe Matcher::Xml do
       eos
 
       @xml = Matcher::Xml.new(lhs)
-      verify_mismatch("/bookstore/book[2]/@category", Matcher::Xml::NOT_FOUND)
+      verify_mismatch("/bookstore/book[2]/@category", Matcher::Xml::EXISTENCE, Matcher::Xml::NOT_FOUND)
     end
 
     context 'matches' do
@@ -268,6 +270,15 @@ describe Matcher::Xml do
         xml.match(lhs)
         xml.matches.should have(3).matches
       end
+      
+      it "should have expected and actual results" do
+        lhs = "<bookstore><book>foo</book></bookstore>"
+        xml = Matcher::Xml.new(lhs)
+        xml.match(lhs).should be_true
+        match_info = xml.matches["/bookstore"]
+        match_info.expected.should == "1 children"
+        match_info.actual.should == "1 children"
+      end
 
     end
 
@@ -307,6 +318,14 @@ describe Matcher::Xml do
       xml = Matcher::Xml.new("<bookstore><book>foo</book></bookstore", custom_matchers)
       xml.match("<bookstore><book>bar</book></bookstore").should be_true 
     end
+
+    it "supports regex style matching" 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 
+      xml.mismatches.should be_empty
+      xml.matches.should have(3).matches
+    end
     
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xmatch
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Peter Moran
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-19 00:00:00 +11:00
+date: 2010-11-23 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency