equivalent-xml 0.2.9 → 0.3.0

data/{README.rdoc → README.md}

@@ -1,9 +1,11 @@
-= equivalent-xml
+# equivalent-xml
 
-== Description
+## Description
+
+### Problem
 
-=== Problem
 Testing XML output is difficult:
+
 * Comparing text output is brittle due to the vagaries of serialization.
 * Attribute order doesn't matter.
 * Element order matters sometimes, but not always. 
@@ -11,17 +13,22 @@ Testing XML output is difficult:
 * Nodes in the same namespace don't always use the same prefix
 * Etc.
 
-=== Solution
+### Solution
+
 EquivalentXml for Nokogiri
 
-=== Use
-  EquivalentXml.equivalent?(node_1, node_2, opts = { :element_order => false, :normalize_whitespace => true }) { |n1, n2, result| ... }
+[![Build Status](https://secure.travis-ci.org/mbklein/equivalent-xml.png)](http://travis-ci.org/mbklein/equivalent-xml)
+[![Dependency Status](https://gemnasium.com/mbklein/equivalent-xml.png)](https://gemnasium.com/mbklein/equivalent-xml)
+
+### Use
+    EquivalentXml.equivalent?(node_1, node_2, opts = { :element_order => false, :normalize_whitespace => true }) { |n1, n2, result| ... }
 
 node_1 and node_2 can be any Nokogiri::XML::Node descendants (or any string 
 containing an XML document or document fragment). The most common use case is 
 to compare two Nokogiri::XML::Document instances.
 
 node_1 is equivalent to node_2 if and only if:
+
 * node_1 and node_2 are of the same class
 * node_1 and node_2 are in the same namespace
 * node_1 and node_2 have the same number of child nodes
@@ -32,51 +39,61 @@ 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 
+`Element` nodes are equivalent if they have the same name, and their 
 child nodesets are equal (as defined above)
 
-+Attribute+ nodes are equivalent if their names and values match exactly
+`Attribute` nodes are equivalent if their names and values match exactly
 
-+CDATA+ nodes are equivalent if their text strings match exactly,
+`CDATA` nodes are equivalent if their text strings match exactly,
 including leading, trailing, and internal whitespace
 
-Non-CDATA +CharacterData+ nodes are equivalent if their text strings 
+Non-CDATA `CharacterData` nodes are equivalent if their text strings 
 match after stripping leading and trailing whitespace and collapsing 
 internal whitespace to a single space
 
-+Document+ nodes are equivalent if their root nodes are equal
+`Document` nodes are equivalent if their root nodes are equal
 
-+ProcessingInstruction+ and +Comment+ nodes are ignored
+`ProcessingInstruction` and `Comment` nodes are ignored
 
-==== Options
-  :element_order => true
+#### Options
+
+    :element_order => true
 
 Require elements to be in the same relative position in order to be
 considered equivalent.
 
-  :normalize_whitespace => false
+    :normalize_whitespace => false
 
 Don't normalize whitespace within text nodes; require text nodes to 
 match exactly.
 
-=== Using with RSpec
+    :ignore_content => ["Device > SerialNumber", "Device > ICCID"]
+
+A single CSS selector, or an array of CSS selectors, of nodes for which the content (text and child
+nodes) should be ignored when comparing for equivalence.  Defaults to `nil`.  (Uses Nokogiri's
+`Node#css(*rules)` to conduct the search.)
+
+### 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)
+
+    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
+    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
+    node_1.should be_equivalent_to(node_2).ignoring_content_of("SerialNumber")
+
+## 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
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -84,10 +101,12 @@ Chained modifiers:
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is 
+  otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== History
+## History
 
+- <b>0.3.0</b> - Added :ignore_content option (conrib. by moklett)
 - <b>0.2.9</b> - Fix for rspec-rails >= 2.7 (contrib. by jcoyne)
 - <b>0.2.8</b> - Allow comparison against nodesets (contrib. by gkellogg)
 - <b>0.2.7</b> - Auto-require RSpec matchers if RSpec is loaded
@@ -106,7 +125,7 @@ Chained modifiers:
 - <b>0.1.1</b> - Removed explicit runtime dependency on nokogiri
 - <b>0.1.0</b> - Initial release
 
-== Copyright
+## Copyright
 
 Copyright (c) 2011 Michael B. Klein. See LICENSE.txt for further details.
 

data/lib/equivalent-xml.rb

@@ -13,6 +13,7 @@ module EquivalentXml
     # @param [Hash] opts Options that determine how certain comparisons are evaluated
     # @option opts [Boolean] :element_order (false) Child elements must occur in the same order to be considered equivalent
     # @option opts [Boolean] :normalize_whitespace (true) Collapse whitespace within Text nodes before comparing
+    # @option opts [String, Array] :ignore_content (nil) CSS selector(s) of nodes for which the content (text and child nodes) should be ignored when comparing for equivalence
     # @yield [n1,n2,result] The two nodes currently being evaluated, and whether they are considered equivalent. The block can return true or false to override the default evaluation
     # @return [Boolean] true or false
     def equivalent?(node_1, node_2, opts = {}, &block)
@@ -80,9 +81,14 @@ module EquivalentXml
     end
     
     def compare_children(node_1, node_2, opts, &block)
-      nodeset_1 = as_nodeset(node_1.children, opts)
-      nodeset_2 = as_nodeset(node_2.children, opts)
-      result = self.compare_nodesets(nodeset_1,nodeset_2,opts,&block)
+      if ignore_content?(node_1, opts)
+        # Stop recursion and state a match on the children
+        result = true
+      else
+        nodeset_1 = as_nodeset(node_1.children, opts)
+        nodeset_2 = as_nodeset(node_2.children, opts)
+        result = self.compare_nodesets(nodeset_1,nodeset_2,opts,&block)
+      end
       
       if node_1.respond_to?(:attribute_nodes)
         attributes_1 = node_1.attribute_nodes
@@ -167,6 +173,16 @@ module EquivalentXml
       end
     end
 
+    def ignore_content?(node, opts = {})
+      ignore_list = Array(opts[:ignore_content]).flatten.compact
+      return false if ignore_list.empty?
+
+      ignore_list.each do |selector|
+        return true if node.document.css(selector).include?(node)
+      end
+
+      return false
+    end
   end
 
 end

data/lib/equivalent-xml/rspec_matchers.rb

@@ -22,6 +22,7 @@ module EquivalentXml::RSpecMatchers
   #   node.should be_equivalent_to(other_node).respecting_element_order
   #   node.should be_equivalent_to(other_node).with_whitespace_intact
   #   node.should be_equivalent_to(other_node).respecting_element_order.with_whitespace_intact
+  #   node.should be_equivalent_to(other_node).ignoring_content_of("Device > SerialNumber")
   def be_equivalent_to(expected)
     # Placeholder method for documentation purposes; the actual
     # method is defined using RSpec's matcher DSL.
@@ -40,6 +41,10 @@ module EquivalentXml::RSpecMatchers
     chain :with_whitespace_intact do
       @opts[:normalize_whitespace] = false
     end
+
+    chain :ignoring_content_of do |paths|
+      @opts[:ignore_content] = paths
+    end
   
     failure_message_for_should do |actual|
       [ 'expected:', expected.to_s, 'got:', actual.to_s ].join("\n")

data/spec/equivalent-xml_spec.rb

@@ -1,7 +1,10 @@
+if defined?(RUBY_ENGINE) and (RUBY_ENGINE == 'ruby') and (RUBY_VERSION >= '1.9')
+  require 'simplecov'
+  SimpleCov.start
+end
 $:.push(File.join(File.dirname(__FILE__),'..','lib'))
 require 'nokogiri'
 require 'equivalent-xml'
-#require 'equivalent-xml/rspec_matchers'
 
 describe EquivalentXml do
 
@@ -146,4 +149,62 @@ describe EquivalentXml do
     doc1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second></doc>")
     doc1.root.children.should be_equivalent_to("<first xmlns='foo:bar'>foo  bar baz</first><second xmlns='foo:bar'>things</second>")
   end
+
+  context "with the :ignore_content_paths option set to a CSS selector" do
+    it "ignores the text content of a node that matches the given CSS selector when comparing with #equivalent?" do
+      doc1 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>1234</SerialNumber></Device></Devices>")
+      doc2 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>5678</SerialNumber></Device></Devices>")
+
+      EquivalentXml.equivalent?(doc1, doc2, :ignore_content => "SerialNumber").should be_true
+      EquivalentXml.equivalent?(doc1, doc2, :ignore_content => "Devices>Device>SerialNumber").should be_true
+
+      doc1.should be_equivalent_to(doc2).ignoring_content_of("SerialNumber")
+      doc1.should be_equivalent_to(doc2).ignoring_content_of("Devices>Device>SerialNumber")
+    end
+
+    it "ignores the text content of a node that matches the given CSS selector when comparing with a matcher" do
+      doc1 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>1234</SerialNumber></Device></Devices>")
+      doc2 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>5678</SerialNumber></Device></Devices>")
+
+      doc1.should be_equivalent_to(doc2).ignoring_content_of("SerialNumber")
+      doc1.should be_equivalent_to(doc2).ignoring_content_of("Devices>Device>SerialNumber")
+    end
+
+    it "ignores all children of a node that matches the given selector when comparing for equivalence" do
+      doc1 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>1234</SerialNumber></Device></Devices>")
+      doc2 = Nokogiri::XML("<Devices><Device><Name>iPad</Name><SerialNumber>5678</SerialNumber></Device></Devices>")
+
+      doc1.should be_equivalent_to(doc2).ignoring_content_of("Device")
+    end
+
+    it "still considers the number of elements even if they match the given CSS selector" do
+      doc1 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>1234</SerialNumber></Device></Devices>")
+      doc2 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>1234</SerialNumber></Device><Device><Name>iPad</Name><SerialNumber>5678</SerialNumber></Device></Devices>")
+
+      doc1.should_not be_equivalent_to(doc2).ignoring_content_of("Device")
+    end
+
+    it "still considers attributes on the matched path when comparing for equivalence" do
+      doc1 = Nokogiri::XML("<Devices><Device status='owned'><Name>iPhone</Name><SerialNumber>1234</SerialNumber></Device></Devices>")
+      doc2 = Nokogiri::XML("<Devices><Device status='rented'><Name>iPhone</Name><SerialNumber>1234</SerialNumber></Device></Devices>")
+
+      doc1.should_not be_equivalent_to(doc2).ignoring_content_of("Device")
+    end
+
+    it "ignores all matches of the CSS selector" do
+      doc1 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>1001</SerialNumber></Device><Device><Name>iPad</Name><SerialNumber>2001</SerialNumber></Device></Devices>")
+      doc2 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>1002</SerialNumber></Device><Device><Name>iPad</Name><SerialNumber>2002</SerialNumber></Device></Devices>")
+
+      doc1.should be_equivalent_to(doc2).ignoring_content_of("SerialNumber")
+    end
+  end
+
+  context "with the :ignore_content_paths option set to an array of CSS selectors" do
+    it "ignores the content of all nodes that match any of the given CSS selectors when comparing for equivalence" do
+      doc1 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>1234</SerialNumber><ICCID>AAAA</ICCID></Device></Devices>")
+      doc2 = Nokogiri::XML("<Devices><Device><Name>iPhone</Name><SerialNumber>5678</SerialNumber><ICCID>BBBB</ICCID></Device></Devices>")
+
+      doc1.should be_equivalent_to(doc2).ignoring_content_of(["SerialNumber", "ICCID"])
+    end
+  end
 end

metadata

@@ -1,137 +1,138 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: equivalent-xml
-version: !ruby/object:Gem::Version 
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 9
-  version: 0.2.9
 platform: ruby
-authors: 
+authors:
 - Michael B. Klein
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 4
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.3
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 9
-        - 0
-        version: 0.9.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :development
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 2
-        - 4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.2.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
   type: :development
-  version_requirements: *id004
-description: |-
-  Compares two XML Nodes (Documents, etc.) for certain semantic equivalencies. 
-      Currently written for Nokogiri, but with an eye toward supporting multiple XML libraries
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: ! "Compares two XML Nodes (Documents, etc.) for certain semantic equivalencies.
+  \n    Currently written for Nokogiri, but with an eye toward supporting multiple
+  XML libraries"
 email: mbklein@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-files: 
+- README.md
+files:
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/equivalent-xml.rb
 - lib/equivalent-xml/rspec_matchers.rb
 - spec/equivalent-xml_spec.rb
 homepage: http://github.com/mbklein/equivalent-xml
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Easy equivalency tests for Ruby XML
-test_files: 
+test_files:
 - spec/equivalent-xml_spec.rb
+has_rdoc: