xqsr3 0.26.4 → 0.27.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ccb3ee0c47865bb1eede2560dacd10988fe5c88
-  data.tar.gz: aa200aec397e17b577c201253faed63f4c4f31f6
+  metadata.gz: 786185c865b23fafc7fc1ebc7d81cf0bf5f39f36
+  data.tar.gz: a16dcecb9fed63c95545371cae951c4ced42f43f
 SHA512:
-  metadata.gz: 318fcaf298a8096a4ff6ad97b9ae6522bc7997c446cde7ad5e12cf25ae0e09cb7b771d38ac900ae680299eb031359bc46d799176ccee22460d02e36adca2276d
-  data.tar.gz: 3521b7dd6621c09af7bc43d65b9af27a98fbb32ee32296ce07cdc60ca4950d1e4d5e4f1a4dacec139366a89fd90cdd618194ad6bd019d79d219d405f23b58e4a
+  metadata.gz: '098d22e4dbee898ba1ab8f44ffa48114890a5c289afcf079ec5da96809e5218d387ff614fb049601d4cfadf8a3976d2066d0fe86f8a772d0ed07d75186a93f03'
+  data.tar.gz: 565ce70a0c6ecbc82f87d9c57e534fddceaab7a8c33c71ee568385b4edda3406693f4c7a7e82265bef85d1016fd6adf9fc3a3c8af68a7eecea166abe3035a5ea

data/lib/xqsr3/version.rb

@@ -5,7 +5,7 @@
 # Purpose:      Version for Xqsr3 library
 #
 # Created:      3rd April 2016
-# Updated:      1st August 2018
+# Updated:      24th August 2018
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
@@ -50,7 +50,7 @@
 module Xqsr3
 
 	# Current version of the Xqsr3 library
-	VERSION				=	'0.26.4'
+	VERSION				=	'0.27.2'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/lib/xqsr3/xml/utilities/compare.rb

@@ -6,7 +6,7 @@
 #               module
 #
 # Created:      30th July 2017
-# Updated:      28th February 2018
+# Updated:      16th August 2018
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
@@ -51,6 +51,8 @@
 =begin
 =end
 
+require 'xqsr3/xml/utilities/navigation'
+
 require 'xqsr3/quality/parameter_checking'
 
 require 'nokogiri'
@@ -89,6 +91,8 @@ module Compare
 
 		def initialize status, reason, **options
 
+			@call_stack	=	caller(2)
+
 			check_parameter status, 'status', types: [ ::FalseClass, ::TrueClass ]
 			check_parameter reason, 'reason', type: ::Symbol, allow_nil: true
 
@@ -114,8 +118,9 @@ module Compare
 			return self.new false, reason, **options
 		end
 
-		attr_reader	:status
-		attr_reader	:reason
+		attr_reader :call_stack
+		attr_reader :status
+		attr_reader :reason
 
 		def different?
 
@@ -160,6 +165,8 @@ module Compare
 
 	module Internal_Compare_
 
+		include ::Xqsr3::XML::Utilities::Navigation
+
 		extend ::Xqsr3::Quality::ParameterChecking
 
 		DEFAULT_OPTIONS = {
@@ -170,6 +177,8 @@ module Compare
 			ignore_attributes: false,
 			ignore_attribute_order: true,
 			ignore_child_node_order: true,
+			ignore_content: false,
+			ignore_content_case: false,
 			ignore_xml_declarations: true,
 			normalise_whitespace: true,
 #			normalize_whitespace: true,
@@ -181,6 +190,8 @@ module Compare
 			:element_order,
 			:ignore_attribute_order,
 			:ignore_child_node_order,
+			:ignore_content,
+			:ignore_content_case,
 		]
 
 		WHITESPACE_OPTIONS_SYMBOLS = [
@@ -384,12 +395,48 @@ module Compare
 			# ##########################
 			# content
 
-			normalise_ws	=	options[:normalise_whitespace]
+			unless options[:ignore_content]
+
+				lhs_texts		=	self.get_descendants(lhs).select { |el| el.text? }.map { |el| el.content }
+				rhs_texts		=	self.get_descendants(rhs).select { |el| el.text? }.map { |el| el.content }
 
-			lhs_content	=	normalise_ws ? lhs.content.gsub(/\s+/, ' ').strip : lhs.content
-			rhs_content	=	normalise_ws ? rhs.content.gsub(/\s+/, ' ').strip : rhs.content
+				content_same	=	lhs_texts == rhs_texts
 
-			return Result.different :different_node_contents, lhs_node: lhs, rhs_node: rhs if lhs_content != rhs_content
+				unless content_same
+
+					if options[:normalise_whitespace]
+
+						lhs_texts		=	lhs_texts.reject { |s| s.strip.empty? }
+						rhs_texts		=	rhs_texts.reject { |s| s.strip.empty? }
+
+						content_same	=	lhs_texts == rhs_texts
+					end
+				end
+
+				unless content_same
+
+					if options[:ignore_content_case]
+
+						lhs_texts		=	lhs_texts.reject { |s| s.downcase }
+						rhs_texts		=	rhs_texts.reject { |s| s.downcase }
+
+						content_same	=	lhs_texts == rhs_texts
+					end
+				end
+
+				unless content_same
+
+					if options[:ignore_child_node_order]
+
+						lhs_texts		=	lhs_texts.sort
+						rhs_texts		=	rhs_texts.sort
+
+						content_same	=	lhs_texts == rhs_texts
+					end
+				end
+
+				return Result.different :different_node_contents, lhs_node: lhs, rhs_node: rhs unless content_same
+			end
 
 
 			# ##########################
@@ -492,3 +539,6 @@ end # module Utilities
 end # module XML
 end # module Xqsr3
 
+# ############################## end of file ############################# #
+
+

data/lib/xqsr3/xml/utilities/navigation.rb

@@ -0,0 +1,108 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/xml/_utilities/navigation.rb
+#
+# Purpose:      Definition of the ::Xqsr3::XML::Utilities::Navigation
+#               module
+#
+# Created:      7th August 2018
+# Updated:      7th August 2018
+#
+# Home:         http://github.com/synesissoftware/xqsr3
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# * Neither the names of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# ::Xqsr3::XML::Utilities::Navigation
+
+=begin
+=end
+
+require 'xqsr3/quality/parameter_checking'
+
+require 'nokogiri'
+
+module Xqsr3
+module XML
+module Utilities
+
+module Navigation
+
+	module Internal_Compare_
+
+		extend ::Xqsr3::Quality::ParameterChecking
+
+		def self.get_descendants node
+
+			descendants	=	[]
+
+			node.children.each do |child|
+
+				descendants	<<	child
+
+				descendants	+=	self.get_descendants child
+			end
+
+			descendants
+		end
+	end # module Internal_Compare_
+
+	def self.included receiver
+
+		def receiver.get_descendants node
+
+			Internal_Compare_.get_descendants node
+		end
+	end
+
+	def self.get_descendants node
+
+		Internal_Compare_.get_descendants node
+	end
+
+	def get_descendants
+
+		Internal_Compare_.get_descendants self
+	end
+end # module Navigation
+
+end # module Utilities
+end # module XML
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+
+

data/test/unit/quality/tc_parameter_checking.rb

@@ -4,6 +4,7 @@ $:.unshift File.join(File.dirname(__FILE__), '../../../..', 'lib')
 
 require 'xqsr3/quality/parameter_checking'
 
+require 'xqsr3/extensions/test/unit'
 require 'test/unit'
 
 class Test_parameter_checks_as_separate_module < Test::Unit::TestCase

data/test/unit/xml/utilities/tc_compare.rb

@@ -184,5 +184,73 @@ END_OF_rhs_doc
 
 		assert r.same?, "#{r.details}"
 	end
+
+	def test_different_node_contents_by_child_node_order
+
+		lhs_str	=	<<END_OF_lhs_doc
+<?xml version="1.0"?>
+<outer>
+ <mid_1>
+  <inner>some text</inner>
+ </mid_1>
+ <mid_2>
+  <inner>some more text</inner>
+ </mid_2>
+</outer>
+END_OF_lhs_doc
+
+		rhs_str	=	<<END_OF_rhs_doc
+<?xml version="1.0"?>
+<outer>
+ <mid_2>
+  <inner>some more text</inner>
+ </mid_2>
+ <mid_1>
+  <inner>some text</inner>
+ </mid_1>
+</outer>
+END_OF_rhs_doc
+
+		lhs_doc		=	Nokogiri::XML lhs_str
+		rhs_doc		=	Nokogiri::XML rhs_str
+
+		expected	=	rhs_doc
+		actual		=	lhs_doc
+
+		r			=	xml_compare expected, actual, ignore_child_node_order: true, normalise_whitespace: true, ignore_xml_declarations: true
+
+		assert r.same?, "#{r.details}"
+	end
+
+	def test_different_node_contents_by_child_node_order_and_whitespace
+
+		lhs_str	=	<<END_OF_lhs_doc
+<?xml version="1.0"?>
+<outer><mid_1><inner>some text</inner></mid_1><mid_2><inner>some more text</inner></mid_2></outer>
+END_OF_lhs_doc
+
+		rhs_str	=	<<END_OF_rhs_doc
+<?xml version="1.0"?>
+<outer>
+ <mid_2>
+  <inner>some more text</inner>
+ </mid_2>
+ <mid_1>
+  <inner>some text</inner>
+ </mid_1>
+</outer>
+END_OF_rhs_doc
+
+		lhs_doc		=	Nokogiri::XML lhs_str
+		rhs_doc		=	Nokogiri::XML rhs_str
+
+		expected	=	rhs_doc
+		actual		=	lhs_doc
+
+		r			=	xml_compare expected, actual, ignore_child_node_order: true, normalise_whitespace: true, ignore_xml_declarations: true
+
+		assert r.same?, "#{r.details}"
+	end
 end
 
+

data/test/unit/xml/utilities/tc_navigation.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 4), 'lib')
+
+require 'xqsr3/xml/utilities/navigation'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+require 'nokogiri'
+
+class Test_Xqsr3_XML_Utilities_Navigation < Test::Unit::TestCase
+
+	include ::Xqsr3::XML::Utilities::Navigation
+
+	def test_get_descendants_1
+
+		xml_s	=	<<END_OF_rhs_doc
+<?xml version="1.0"?>
+<document>
+ <outer>
+  <mid_2>
+   <inner>some more text</inner>
+  </mid_2>
+  <mid_1>
+   <inner>some text</inner>
+  </mid_1>
+ </outer>
+</document>
+END_OF_rhs_doc
+
+		xml		=	::Nokogiri.XML(xml_s)
+		doc		=	xml.children.first
+
+		descs	=	self.class.get_descendants xml.children.first
+
+		assert_not_nil descs
+		assert_kind_of ::Array, descs
+
+		assert_operator 7, :<=, descs.size
+		%w{ outer mid_1 mid_2 }.each do |name|
+
+			assert(descs.find { |el| name == el.name }, "did not find an element named '#{name}' in the collection #{descs}")
+		end
+
+		texts	=	descs.select { |el| el.text? }
+
+		[ 'some text', 'some more text' ].each do |text|
+
+			assert(texts.find { |el| text == el.text }, "did not find an element with the text '#{text}' in the collection #{texts}")
+		end
+	end
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.26.4
+  version: 0.27.2
 platform: ruby
 authors:
 - Matt Wilson
@@ -78,6 +78,7 @@ files:
 - lib/xqsr3/string_utilities/truncate.rb
 - lib/xqsr3/version.rb
 - lib/xqsr3/xml/utilities/compare.rb
+- lib/xqsr3/xml/utilities/navigation.rb
 - test/unit/array_utilities/tc_join_with_or.rb
 - test/unit/array_utilities/ts_all.rb
 - test/unit/command_line_utilities/tc_map_option_string.rb
@@ -130,6 +131,7 @@ files:
 - test/unit/ts_all.rb
 - test/unit/xml/ts_all.rb
 - test/unit/xml/utilities/tc_compare.rb
+- test/unit/xml/utilities/tc_navigation.rb
 - test/unit/xml/utilities/ts_all.rb
 homepage: http://github.com/synesissoftware/xqsr3
 licenses: