compare-xml 0.65 → 0.66

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 48d97a18ea1ad3981e16acd41c03d8abf90c3996
-  data.tar.gz: ebfda907e73d068f77b6f6bf795207a707040a68
+SHA256:
+  metadata.gz: eb6c3fb3e704a49642e05b7c2ff26442ad63a77aa22c4a2dc461ffce22c5dc59
+  data.tar.gz: 8fa4604c0f7216f077fa48807a68c4b222fefca2dd6beedfc0d745cb3f5074ee
 SHA512:
-  metadata.gz: 8b2328fac7d1ac1672dd8ba64ecfce353681d2e07aba8fe632fb27281ea2c58267764d3e10108993a8f2f0914502b5137293ab1f0fed12442ef9bf8865cef2fe
-  data.tar.gz: 0e12b9c47b2c6d79ea6e826cee70d538310d9d0203d500a4856fb904794e115528698a7c848d2f5154be8f0bf6fd5d81279b6dafa555a8d6dbd2dfd9040cd52a
+  metadata.gz: 7be5a2a949660aff92a2d4fea1fa6820a960ceb7b177479ee6a7b3464cc0f9b12ce7a81f08fe4567243a658987ab48c34362cf09b9a2f11767724d669cc0f142
+  data.tar.gz: 7d17c1fd43511146021eadc83037cf27d7c259fad86658ecba24f6c021ec4095b984d1e5cb9becaa1cd2e78b4338db95f0b437e00ab60aed0f54f6733087dde9

data/.rubocop.yml

@@ -32,6 +32,9 @@ Naming/FileName:
 Naming/MethodName:
   Enabled: false
 
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/README.md

@@ -78,6 +78,9 @@ CompareXML.equivalent?(doc1, doc2, {collapse_whitespace: false, verbose: true, .
 - `ignore_attrs: [css_selector1, css_selector1, ...]` default: **`[]`**     [show examples ⇨](#ignore_attrs)
     - when provided, ignores specific *attributes* using [CSS selectors](http://www.w3schools.com/cssref/css_selectors.asp)
 
+- `ignore_attrs_by_name: [string1, string2, ...]` default: **`[]`**     [show examples ⇨](#ignore_attrs_by_name)
+    - when provided, ignores specific *attributes* using [String]
+
 - `ignore_comments: {true|false}` default: **`true`**     [show examples ⇨](#ignore_comments)
     - when `true`, ignores comments, such as `<!-- comment -->`
 
@@ -90,6 +93,12 @@ CompareXML.equivalent?(doc1, doc2, {collapse_whitespace: false, verbose: true, .
 - `verbose: {true|false}` default: **`false`**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[show examples ⇨](#verbose)
     - when `true`, instead of a boolean, `CompareXML.equivalent?` returns an array of discrepancies.
 
+- `ignore_children {true|false}` default **`false`**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[show examples ⇨](#ignore_children)
+    - when `true`, the subnodes of a node in the xml are ignored
+
+- `force_children {true|false}` default **`false`**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[show examples ⇨](#force_children)
+    - when `true`, the subnodes of a node are checked independently of the status of the parent node
+
 
 ## Options in Depth
 
@@ -185,6 +194,18 @@ CompareXML.equivalent?(doc1, doc2, {collapse_whitespace: false, verbose: true, .
         <a href="http://google.ca" class="primary button">Link</a>
         <a href="https://google.com" class="primary button rounded">Link</a>
 
+----------
+
+- <a id="ignore_attrs_by_name"></a>`ignore_attrs_by_name: [string1, string2, ...]` default: **`false`**
+
+    When provided, ignores all **attributes** which name is specified in the string array.
+
+     **Usage Example:** `CompareXML.equivalent?(doc1, doc2, {ignore_attrs_by_name: ['target'])`
+
+    **Example:** With `ignore_attrs_by_name: ['target', 'rel']` the following HTML strings are considered equal:
+
+        <a href="/admin" class="button" target="_blank">Link</a>
+        <a href="/admin" class="button" target="_self" rel="nofollow">Link</a>
 
 ----------
 
@@ -305,7 +326,28 @@ CompareXML.equivalent?(doc1, doc2, {collapse_whitespace: false, verbose: true, .
         diff1: [Nokogiri::XML::Node|String] left difference
         diff2: [Nokogiri::XML::Node|String] right difference
 
+----------
 
+- <a id="ignore_children"></a>`ignore_children: {true|false}` default: **`false`**
+
+    When provided, ignores all **subnodes** of any node.
+
+    **Usage Example:** `CompareXML.equivalent?(doc1, doc2, {ignore_children: true})`
+
+    **Example:** With `ignore_children: true` the following HTML strings are considered equal:
+
+        <body><a href="/admin" class="icon" target="_blank">Link 1</a></body>
+        <body><a href="/index" class="button" target="_self" rel="nofollow">Link 2</a></body>
+
+----------
+
+- <a id="force_children"></a>`force_children: {true|false}` default: **`false`**
+
+    When provided, compares all **subnodes** of any node.
+
+    **Usage Example:** `CompareXML.equivalent?(doc1, doc2, {ignore_children: true})`
+
+----------
 
 ## Contributing
 

data/compare-xml.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'compare-xml/version'
 

data/lib/compare-xml.rb

@@ -16,6 +16,10 @@ module CompareXML
     # when false, children of elements are not compared if the root is different
     force_children: false,
 
+    # when true, children of elements are never compared
+    # when false, children of elements are compared if root is different or see force_children
+    ignore_children: false,
+
     # contains an array of user specified strings that is used to ignore any attributes
     # whose content contains a string from this array (e.g. "good automobile" contains "mobile")
     ignore_attr_content: [],
@@ -191,6 +195,7 @@ module CompareXML
     #
     def compareChildren(n1_set, n2_set, opts, differences, diffchildren = false, status = EQUIVALENT)
       i = 0; j = 0
+      return if opts[:ignore_children]
       while i < n1_set.length || j < n2_set.length
         if !n1_set[i].nil? && nodeExcluded?(n1_set[i], opts)
           i += 1 # increment counter if left node is excluded

data/lib/compare-xml/version.rb

@@ -1,3 +1,3 @@
 module CompareXML
-  VERSION = '0.65'.freeze
+  VERSION = '0.66'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compare-xml
 version: !ruby/object:Gem::Version
-  version: '0.65'
+  version: '0.66'
 platform: ruby
 authors:
 - Vadim Kononov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A customizable tool that compares two instances of Nokogiri::XML::Node for