equivalent-xml 0.1.6 → 0.2.1

data/README.rdoc

@@ -32,7 +32,7 @@ node_1 is equivalent to node_2 if and only if:
 
 If a block is given, the block will be called every time two nodes are compared. The parameters will be 
 the two nodes being compared as well as the result of the comparison. If the block explicitly returns 
-`true` or `false` (a real `TrueClass` or `FalseClass`, not just an expression that can be coerced to
++true+ or +false+ (a real +TrueClass+ or +FalseClass+, not just an expression that can be coerced to
 true or false), the return value will override the result of the comparison.
 
 +Element+ nodes are equivalent if they have the same name, and their 
@@ -62,6 +62,20 @@ considered equivalent.
 Don't normalize whitespace within text nodes; require text nodes to 
 match exactly.
 
+=== Using with RSpec
+
+EquivalentXml includes a custom matcher for RSpec (version >=1.2.4) that makes including XML
+equivalencies in your spec tests a cinch!
+
+Equivalency:
+  node_1.should be_equivalent_to(node_2)
+  node_1.should_not be_equivalent_to(node_2)
+
+Chained modifiers:
+  node_1.should be_equivalent_to(node_2).respecting_element_order
+  node_1.should be_equivalent_to(node_2).with_whitespace_intact
+  node_1.should be_equivalent_to(node_2).respecting_element_order.with_whitespace_intact
+
 == Contributing to equivalent-xml
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/lib/equivalent-xml/rspec_matchers.rb

@@ -0,0 +1,52 @@
+require 'equivalent-xml'
+
+class RSpecNotFound < Exception ; end
+  
+if defined?(RSpec)
+  rspec_namespace = RSpec::Matchers
+elsif defined?(Spec)
+  rspec_namespace = Spec::Matchers
+else
+  raise RSpecNotFound, "Cannot find Spec (rspec 1.x) or RSpec (rspec 2.x)"
+end
+
+rspec_namespace.define :be_equivalent_to do |expected, opts|
+  @opts = opts || {}
+  
+  match do |actual|
+    @expected = expected
+    @actual = actual
+    EquivalentXml.equivalent?(@actual,@expected,@opts) { |n1,n2,result|
+      if result == false and @failure_nodes.nil?
+        @failure_nodes = { :expected => n2, :actual => n1 }
+      end
+    }
+  end
+  
+  chain :respecting_element_order do 
+    @opts[:element_order] = true
+  end
+  
+  chain :with_whitespace_intact do
+    @opts[:normalize_whitespace] = false
+  end
+  
+  failure_message_for_should do
+    <<-MESSAGE
+expected:
+#{@failure_nodes[:expected].to_xml}
+got:
+#{@failure_nodes[:actual].to_xml}
+MESSAGE
+  end
+      
+  failure_message_for_should_not do
+    <<-MESSAGE
+expected:
+#{@actual.to_xml}
+not to be equivalent to:
+#{@expected.to_xml}
+MESSAGE
+  end
+
+end

data/spec/{equvalent-xml_spec.rb → equivalent-xml_spec.rb}

@@ -1,76 +1,77 @@
 $:.push(File.join(File.dirname(__FILE__),'..','lib'))
 require 'nokogiri'
 require 'equivalent-xml'
+require 'equivalent-xml/rspec_matchers'
 
 describe EquivalentXml do
 
   it "should consider a document equivalent to itself" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
-    EquivalentXml.equivalent?(doc1,doc1).should == true
+    doc1.should be_equivalent_to(doc1)
   end
   
   it "should ensure that attributes match" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first order='1'>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><first order='2'>foo  bar baz</first><second>things</second></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == false
+    doc1.should_not be_equivalent_to(doc2)
 
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first order='1'>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><first order='1'>foo  bar baz</first><second>things</second></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == true
+    doc1.should be_equivalent_to(doc2)
   end
   
   it "shouldn't care about attribute order" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first order='1' value='quux'>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><first value='quux' order='1'>foo  bar baz</first><second>things</second></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == true
+    doc1.should be_equivalent_to(doc2)
   end
   
   it "shouldn't care about element order by default" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><second>things</second><first>foo  bar baz</first></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == true
+    doc1.should be_equivalent_to(doc2)
   end
   
   it "should care about element order if :element_order => true is specified" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><second>things</second><first>foo  bar baz</first></doc>")
-    EquivalentXml.equivalent?(doc1,doc2,:element_order => true).should == false
+    doc1.should_not be_equivalent_to(doc2).respecting_element_order
   end
   
   it "should ensure nodesets have the same number of elements" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><second>things</second><first>foo  bar baz</first><third/></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == false
+    doc1.should_not be_equivalent_to(doc2)
   end
 
   it "should ensure namespaces match" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:baz'><first>foo  bar baz</first><second>things</second></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == false
+    doc1.should_not be_equivalent_to(doc2)
   end
 
   it "should compare namespaces based on URI, not on prefix" do
     doc1 = Nokogiri::XML("<doc xmlns:foo='foo:bar'><foo:first>foo  bar baz</foo:first><foo:second>things</foo:second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns:baz='foo:bar'><baz:first>foo  bar baz</baz:first><baz:second>things</baz:second></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == true
+    doc1.should be_equivalent_to(doc2)
   end
 
   it "should ignore declared but unused namespaces" do
     doc1 = Nokogiri::XML("<doc xmlns:foo='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc><first>foo  bar baz</first><second>things</second></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == true
+    doc1.should be_equivalent_to(doc2)
   end
 
   it "should normalize simple whitespace by default" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo bar  baz</first><second>things</second></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == true
+    doc1.should be_equivalent_to(doc2)
   end
 
   it "shouldn't normalize simple whitespace if :normalize_whitespace => false is specified" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo bar  baz</first><second>things</second></doc>")
-    EquivalentXml.equivalent?(doc1,doc2, :normalize_whitespace => false).should == false
+    doc1.should_not be_equivalent_to(doc2).with_whitespace_intact
   end
 
   it "should normalize complex whitespace by default" do
@@ -82,7 +83,7 @@ describe EquivalentXml do
         bar baz
       </first>
     </doc>})
-    EquivalentXml.equivalent?(doc1,doc2).should == true
+    doc1.should be_equivalent_to(doc2)
   end
   
   it "shouldn't normalize complex whitespace if :normalize_whitespace => false is specified" do
@@ -94,7 +95,7 @@ describe EquivalentXml do
         bar baz
       </first>
     </doc>})
-    EquivalentXml.equivalent?(doc1,doc2, :normalize_whitespace => false).should == false
+    doc1.should_not be_equivalent_to(doc2).with_whitespace_intact
   end
 
   it "should ignore comment nodes" do
@@ -107,22 +108,23 @@ describe EquivalentXml do
         bar baz
       </first>
     </doc>})
-    EquivalentXml.equivalent?(doc1,doc2).should == true
+    doc1.should be_equivalent_to(doc2)
   end
   
   it "should properly handle a mixture of text and element nodes" do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><phrase>This phrase <b>has bold text</b> in it.</phrase></doc>")
     doc2 = Nokogiri::XML("<doc xmlns='foo:bar'><phrase>This phrase in <b>has bold text</b> it.</phrase></doc>")
-    EquivalentXml.equivalent?(doc1,doc2).should == false
+    doc1.should_not be_equivalent_to(doc2)
   end
 
   it "should properly handle documents passed in as strings" do
     doc1 = "<doc xmlns='foo:bar'><first order='1'>foo  bar baz</first><second>things</second></doc>"
     doc2 = "<doc xmlns='foo:bar'><first order='1'>foo  bar baz</first><second>things</second></doc>"
+    doc1.should be_equivalent_to(doc2)
 
     doc1 = "<doc xmlns='foo:bar'><first order='1'>foo  bar baz</first><second>things</second></doc>"
     doc2 = "<doc xmlns='foo:bar'><first order='1'>foo  bar baz quux</first><second>things</second></doc>"
-    EquivalentXml.equivalent?(doc1,doc2).should == false
+    doc1.should_not be_equivalent_to(doc2)
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: equivalent-xml
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
+  - 2
   - 1
-  - 6
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors: 
 - Michael B. Klein
@@ -93,7 +93,8 @@ files:
 - README.rdoc
 - Rakefile
 - lib/equivalent-xml.rb
-- spec/equvalent-xml_spec.rb
+- lib/equivalent-xml/rspec_matchers.rb
+- spec/equivalent-xml_spec.rb
 has_rdoc: true
 homepage: http://github.com/mbklein/equivalent-xml
 licenses: 
@@ -124,9 +125,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Easy equivalency tests for Ruby XML
 test_files: 
-- spec/equvalent-xml_spec.rb
+- spec/equivalent-xml_spec.rb