compare-xml 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb7ad2fa6ba45154479d1129ad6ce84337b331fa
-  data.tar.gz: eb3a5b0f7caedccb403c1a5504baa80b4e5ff7a8
+  metadata.gz: 33a222cacf011fd953938812fd99be01832a61ca
+  data.tar.gz: fd30d6713bddf059806814e28faf431132697c60
 SHA512:
-  metadata.gz: d46798f576e812ad39b3604c8b41f01d531f6490ba1690facb1cd978c200139d8b1e58a17b98a2d47fbbd76cc011487f9850bb68f5a5e28f5d3156d41a7c9f7c
-  data.tar.gz: 91993f87fca6eb40ec302bb598a88b85fa36e1876e1c9ef88396b2f52360e8bed89597400d9803ceaa7a455e8d5930750a9239d4610f607efe46f01d03c5dc31
+  metadata.gz: cc7042aa3c3ff8b69a6ebcbf76d8a443d5fc7f4d38379f12cbd91d6fe8b908d6d096f70dd22945231e0403ff742cd04f9c0423237fcb3b0715a89baf92d3a93c
+  data.tar.gz: 54d723bfb1c797083b103328bfee70ad40ad302c15355106755da9d22d9e58a854f56a859032a3af771a1a042b16727b4082b119832f3f1b5ea0c770b1bd849d

data/README.md

@@ -60,19 +60,39 @@ require 'compare-xml'
 ```
 
 
-## Options
+## Options at a Glance
 
 CompareXML has a variety of options that can be invoked as an optional argument, e.g.:
 
 ```ruby
-CompareXML.equivalent?(doc1, doc2, {squeeze_whitespace: true, verbose: true})
+CompareXML.equivalent?(doc1, doc2, {ignore_comments: false, verbose: true, ...})
 ```
 
+- `ignore_attr_order: {true|false}` default: **`true`**
+	- when `true`, ignores attribute order within tags
 
-----------
+- `ignore_attrs: {css}` default: **`{}`**
+	- when provided, ignores specific *attributes* using [CSS selectors](http://www.w3schools.com/cssref/css_selectors.asp)
 
+- `ignore_comments: {true|false}` default: **`true`**
+	- when `true`, ignores comments, such as `<!-- comment -->`
 
-- ####`ignore_attr_order: {true|false}` default: **`true`**
+- `ignore_nodes: {css}` default: **`{}`**
+	- when provided, ignores specific *nodes* using [CSS selectors](http://www.w3schools.com/cssref/css_selectors.asp)
+
+- `ignore_text_nodes: {true|false}` default: **`false`**
+	- when `true`, ignores all text content within a document
+
+- `collapse_whitespace: {true|false}` default: **`true`**
+	- when `true`, trims and collapses whitespace
+
+- `verbose: {true|false}` default: **`false`**
+	- when `true`, instead of a boolean, `CompareXML.equivalent?` returns an array of discrepancies.
+
+
+## Options in Depth
+
+- `ignore_attr_order: {true|false}` default: **`true`**
 
     When `true`, all attributes are sorted before comparison and only attributes of the same type are compared.
 
@@ -100,10 +120,8 @@ CompareXML.equivalent?(doc1, doc2, {squeeze_whitespace: true, verbose: true})
 		target="_blank" == target="_blank"
 
 
-----------
 
-
-- ####`ignore_attrs: {css}` default: **`{}`**
+- `ignore_attrs: {css}` default: **`{}`**
 
     When provided, ignores all **attributes** that satisfy a particular rule using [CSS selectors](http://www.w3schools.com/cssref/css_selectors.asp).
 
@@ -120,10 +138,8 @@ CompareXML.equivalent?(doc1, doc2, {squeeze_whitespace: true, verbose: true})
 		<a href="https://google.com" class="primary button rounded">Link</a>
 
 
-----------
-
 
-- ####`ignore_comments: {true|false}` default: **`true`**
+- `ignore_comments: {true|false}` default: **`true`**
 
     When `true`, ignores comments, such as `<!-- This is a comment -->`.
 
@@ -140,10 +156,8 @@ CompareXML.equivalent?(doc1, doc2, {squeeze_whitespace: true, verbose: true})
 		<a href="/admin">Link</a>
 
 
-----------
-
 
-- ####`ignore_nodes: {css}` default: **`{}`**
+- `ignore_nodes: {css}` default: **`{}`**
 
     When provided, ignores all **nodes** that satisfy a particular rule using [CSS selectors](http://www.w3schools.com/cssref/css_selectors.asp).
 
@@ -160,10 +174,8 @@ CompareXML.equivalent?(doc1, doc2, {squeeze_whitespace: true, verbose: true})
 		<a href="/admin"><i class"icon info"></i><b>Message:</b> Link</a>
 
 
-----------
 
-
-- ####`ignore_text_nodes: {true|false}` default: **`false`**
+- `ignore_text_nodes: {true|false}` default: **`false`**
 
     When `true`, ignores all text content. Text content is anything that is included between an opening and a closing tag, e.g. `<tag>THIS IS TEXT CONTENT</tag>`.
 
@@ -180,14 +192,12 @@ CompareXML.equivalent?(doc1, doc2, {squeeze_whitespace: true, verbose: true})
 		<i class="icon>  </i>    <b>Message:</b>
 
 
-----------
-
 
-- ####`squeeze_whitespace: {true|false}` default: **`true`**
+- `collapse_whitespace: {true|false}` default: **`true`**
 
-    When `true`, all text content within the document is trimmed (i.e. space removed from left and right) and whitespace is squeezed (i.e. tabs, new lines, multiple whitespaces are all replaced by a single whitespace).
+    When `true`, all text content within the document is trimmed (i.e. space removed from left and right) and whitespace is collapsed (i.e. tabs, new lines, multiple whitespace characters are replaced by a single whitespace).
 
-	**Usage Example:** `CompareXML.equivalent?(doc1, doc2, {squeeze_whitespace: true})`
+	**Usage Example:** `CompareXML.equivalent?(doc1, doc2, {collapse_whitespace: true})`
 
     **Example:** When `true` the following HTML strings are considered equal:
 
@@ -205,10 +215,8 @@ CompareXML.equivalent?(doc1, doc2, {squeeze_whitespace: true, verbose: true})
 		<html><title>This is my title</title></html>
 
 
-----------
-
 
-- ####`verbose: {true|false}` default: **`false`**
+- `verbose: {true|false}` default: **`false`**
 
     When `true`, instead of returning a boolean value  `CompareXML.equivalent?` returns an array of all errors encountered when performing a comparison.
 

data/compare-xml.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A customizable tool that compares two instances of Nokogiri::XML::Node for equality or equivalency.}
   spec.description   = %q{CompareXML is a fast, lightweight and feature-rich tool that will solve your XML/HTML comparison or diffing needs. its purpose is to compare two instances of Nokogiri::XML::Node or Nokogiri::XML::NodeSet for equality or equivalency.}
-  spec.homepage      = 'https://github.com/vkononov/compare-xml-xml'
+  spec.homepage      = 'https://github.com/vkononov/compare-xml'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/compare-xml.rb

@@ -25,9 +25,9 @@ module CompareXML
       # when false, all text nodes are compared to their counterparts (except the empty ones)
       ignore_text_nodes: false,
 
-      # when true, trims and squeezes whitespace in text nodes and comments to a single space
+      # when true, trims and collapses whitespace in text nodes and comments to a single space
       # when false, all whitespace is preserved as it is without any changes
-      squeeze_whitespace: true,
+      collapse_whitespace: true,
 
       # when true, provides a list of all error messages encountered in comparisons
       # when false, execution stops when the first error is encountered with no error messages
@@ -123,7 +123,7 @@ module CompareXML
     def compareCommentNodes(n1, n2, opts, errors, status = EQUIVALENT)
       return true if opts[:ignore_comments]
       t1, t2 = n1.content, n2.content
-      t1, t2 = squeeze(t1), squeeze(t2) if opts[:squeeze_whitespace]
+      t1, t2 = collapse(t1), collapse(t2) if opts[:collapse_whitespace]
       unless t1 == t2
         status = UNEQUAL_COMMENTS
         errors << [nodePath(n1.parent), t1, status, t2, nodePath(n2.parent)] if opts[:verbose]
@@ -228,7 +228,7 @@ module CompareXML
     def compareTextNodes(n1, n2, opts, errors, status = EQUIVALENT)
       return true if opts[:ignore_text_nodes]
       t1, t2 = n1.content, n2.content
-      t1, t2 = squeeze(t1), squeeze(t2) if opts[:squeeze_whitespace]
+      t1, t2 = collapse(t1), collapse(t2) if opts[:collapse_whitespace]
       unless t1 == t2
         status = UNEQUAL_TEXT_CONTENTS
         errors << [nodePath(n1.parent), t1, status, t2, nodePath(n2.parent)] if opts[:verbose]
@@ -362,7 +362,7 @@ module CompareXML
     #
     def nodeExcluded?(n, opts)
       return true if n.is_a?(Nokogiri::XML::Comment) && opts[:ignore_comments]
-      return true if n.is_a?(Nokogiri::XML::Text) && (opts[:ignore_text_nodes] || squeeze(n.content).empty?)
+      return true if n.is_a?(Nokogiri::XML::Text) && (opts[:ignore_text_nodes] || collapse(n.content).empty?)
       opts[:ignore_nodes].each do |css|
         return true if n.xpath('../*').css(css).include?(n)
       end
@@ -435,14 +435,14 @@ module CompareXML
 
 
     ##
-    # Strips the whitespace (from beginning and end) and squeezes it,
-    # i.e. multiple spaces, new lines and tabs are all squeezed to a single space.
+    # Strips the whitespace (from beginning and end) and collapses it,
+    # i.e. multiple spaces, new lines and tabs are all collapsed to a single space.
     #
-    #   @param [String] text string to squeeze
+    #   @param [String] text string to collapse
     #
-    #   @return squeezed string
+    #   @return collapsed string
     #
-    def squeeze(text)
+    def collapse(text)
       text = text.to_s unless text.is_a? String
       text.strip.gsub(/\s+/, ' ')
     end

data/lib/compare-xml/version.rb

@@ -1,3 +1,3 @@
 module CompareXML
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: compare-xml
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Vadim Kononov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '11.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 description: CompareXML is a fast, lightweight and feature-rich tool that will solve
@@ -61,7 +61,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,7 +71,7 @@ files:
 - compare-xml.gemspec
 - lib/compare-xml.rb
 - lib/compare-xml/version.rb
-homepage: https://github.com/vkononov/compare-xml-xml
+homepage: https://github.com/vkononov/compare-xml
 licenses:
 - MIT
 metadata: {}
@@ -81,17 +81,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: A customizable tool that compares two instances of Nokogiri::XML::Node for