xmatch 0.1.1 → 0.1.2

data/lib/matcher/html_formatter.rb

@@ -1,5 +1,6 @@
 require 'erb'
 require 'fileutils'
+require 'ostruct'
 
 module Matcher
 
@@ -9,20 +10,33 @@ module Matcher
 
     def initialize(matcher, args = {})
       @matcher = matcher
-      @report_dir = args[:report_dir] || File.dirname(__FILE__) + '/../../reports'
+      @report_dir = args[:report_dir] || '/tmp/xmatch'
     end
 
     def format
+      match_data = []
+      @matcher.lhs.traverse do |elem|
+        next if elem.xml?
+        match_data << match_info_for(elem)
+        elem.attributes.values.each { | attr | match_data << match_info_for(attr) }
+      end
+      
       FileUtils.mkdir_p(@report_dir)
-      File.open(File.join(@report_dir, "xmatch.html"), 'w') { |f|  f.write(generate_html) }
+      File.open(File.join(@report_dir, "xmatch.html"), 'w') { |f|  f.write(generate_html(match_data)) }
     end
 
     private
+      
+      def match_info_for(elem)
+        result = @matcher.result_for(elem.path)
+        OpenStruct.new(:result => result, :line => elem.line, :path => elem.path, :message => @matcher.mismatches[elem.path])
+      end
     
-      def generate_html
+      def generate_html(data)
         actual_filename = create_actual_file
         expected_filename = create_expected_file
         xml = @matcher        
+        match_info = data
         html = ERB.new(File.read(TEMPLATE))
         html.result(binding)        
       end

data/lib/matcher/nokogiri_extensions.rb

@@ -4,71 +4,80 @@ module Nokogiri
 
   module XML
 
+    class Node
+
+      def matching(other, matcher)
+        other_elem = other.at_xpath(path)
+        matcher.record(self, false, "not found") unless other_elem
+        other_elem
+      end
+    end
+
+    class Document
+
+      def match?(other, matcher)
+        matching(other, matcher)
+      end
+
+    end
+
     class Element
 
       def match?(other, matcher)
         @matcher = matcher
-        children_match?(other) &&
-          name_matches?(other) &&
-          attributes_match?(other)
+        other_elem = matching(other, matcher)
+        return false unless other_elem
+        children_match?(other_elem) & attributes_match?(other_elem)
       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}'")
+          @matcher.record(self, match, "expected #{children.size} children, got #{other.children.size}")
           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}")
+          unless match
+            @matcher.record(self, match, "expected #{attributes.size} attributes, got #{other.attributes.size}")
+            return false
           end
+
+          attributes.values.each { |attr|  match = match & attr.match?(other, @matcher) }
           match
         end
 
     end
 
-    class Document
-      def match?(other, matcher = nil)
-        true
-      end
-    end
-
     class Text
+
       def match?(other, matcher)
+        @matcher = matcher
+        other_elem = matching(other, matcher)
+        return false unless other_elem
+
         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 = custom_matcher ? custom_matcher.call(other_elem) : (content == other_elem.content)
+        @matcher.record(self, match, "expected '#{content}', got '#{other_elem.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
+        other_elem = matching(other, matcher)
+        return false unless other_elem
 
         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 = custom_matcher ? custom_matcher.call(other_elem) : (value == other_elem.value)
+        matcher.record(self, match, "expected '#{value}', got '#{other_elem.value}'")
         match
       end
+
     end
 
   end

data/lib/matcher/version.rb

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

data/lib/matcher/xmatch.html.erb

@@ -35,13 +35,12 @@
 		<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>
+	<% match_info.each do | match | %>
+	<tr class=<%= match.result  %> >
+		<td><%= match.line %></td>
+		<td><%= match.path %></td>
+  		<td><%= match.message || '&nbsp;' %></td>
+	</tr>		
 	<% end %>
 </table>
 

data/lib/matcher/xml.rb

@@ -19,8 +19,8 @@ module Matcher
       compare(@lhs, @rhs)
     end
 
-    def record(path, result, message = nil)
-      @results[path] = OpenStruct.new(:result => result, :message => message)
+    def record(lhs, result, message)
+      @results[lhs.path] = OpenStruct.new(:result => result, :message => message)
     end
 
     def result_for(path)
@@ -28,20 +28,22 @@ module Matcher
       return "mismatched" if mismatches[path]
       "unmatched"
     end
-
+    
     def matches
-      match_info = {}
-      @results.each_pair { |k, v| match_info[k] = '' if v.result }
-      match_info
+      results_that_are(true)
     end
     
     def mismatches
-      match_info = {}
-      @results.each_pair { |k, v| match_info[k] = v.message unless v.result }
-      match_info
+      results_that_are(false)
     end
 
     private
+    
+      def results_that_are(value)
+        match_info = {}
+        @results.each_pair { |path, info| match_info[path] = info.message if info.result == value}
+        match_info
+      end
 
       def parse(xml)
         xml_as_string = xml.instance_of?(Nokogiri::XML::Document) ? xml.to_xml : xml
@@ -50,10 +52,8 @@ module Matcher
 
       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 = true
+        lhs.traverse { |node| match = match & node.match?(rhs, self) }
         match
       end
 

data/spec/matcher/html_formatter_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+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,9 +4,9 @@ require 'nokogiri'
 
 describe Matcher::Xml do
 
-  def verify_mismatch(path, message)
-    @xml.match(@rhs).should be_false
-    @xml.mismatches.should have(1).mismatch
+  def verify_mismatch(path, message, count = 1)
+    match = @xml.match(@rhs)
+    @xml.mismatches.should have(count).mismatch
     @xml.mismatches[path].should == message
   end
 
@@ -95,21 +95,13 @@ describe Matcher::Xml do
       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")
+        verify_mismatch("/bookstore/book/title", "not found", 2)
       end
 
     end
@@ -124,7 +116,7 @@ describe Matcher::Xml do
         </bookx>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book", "expected element 'book', got 'bookx'")
+        verify_mismatch("/bookstore/book", "not found", 3)
       end
 
     end
@@ -139,7 +131,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book", "expected attribute missing")
+        verify_mismatch("/bookstore/book/@category", "not found")
       end
 
       it "should not match when an attribute value doesn't match" do
@@ -150,7 +142,7 @@ describe Matcher::Xml do
         </book>
         </bookstore>
         eos
-        verify_mismatch("/bookstore/book", "attribute 'category' expected 'COOKING', got 'COOKINGx'")
+        verify_mismatch("/bookstore/book/@category", "expected 'COOKING', got 'COOKINGx'")
       end
 
       it "should not match when rhs has an extra attribute" do
@@ -233,11 +225,10 @@ describe Matcher::Xml do
       </bookstore>
       eos
       @xml.match(rhs)
-      @xml.mismatches.should have(2).mismatches
+      @xml.mismatches.should have(4).mismatches
     end
 
     it "should contain parent's path when an attribute doesn't match" do
-
       lhs = <<-eos
       <bookstore>
       <book category="COOKING">
@@ -262,18 +253,16 @@ describe Matcher::Xml do
       eos
 
       @xml = Matcher::Xml.new(lhs)
-      verify_mismatch("/bookstore/book[2]", "expected attribute missing")
+      verify_mismatch("/bookstore/book[2]/@category", "not found")
     end
 
     context 'matches' do
 
-      it "should be provided with no message" do
-        lhs = "<bookstore><book></book></bookstore>"
+      it "should contain each match" do
+        lhs = "<bookstore><book>foo</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
+        xml.matches.should have(3).matches
       end
 
     end
@@ -282,26 +271,18 @@ describe Matcher::Xml do
 
   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
+    it "returns 'unmatched' for a path that was not found" 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xmatch
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Peter Moran
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-18 00:00:00 +11:00
+date: 2010-11-19 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -93,6 +93,7 @@ files:
 - spec/fixtures/books7.xml
 - spec/fixtures/books8.xml
 - spec/fixtures/books9.xml
+- spec/matcher/html_formatter_spec.rb
 - spec/matcher/smoke_spec.rb
 - spec/matcher/xml_spec.rb
 - spec/spec_helper.rb
@@ -142,6 +143,7 @@ test_files:
 - spec/fixtures/books7.xml
 - spec/fixtures/books8.xml
 - spec/fixtures/books9.xml
+- spec/matcher/html_formatter_spec.rb
 - spec/matcher/smoke_spec.rb
 - spec/matcher/xml_spec.rb
 - spec/spec_helper.rb