xqsr3 0.21.3 → 0.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9936914cef9067c177b1b09269377d177462b12
-  data.tar.gz: 8b042c8bb542a09423bf91a4d63ba94fcd3d506b
+  metadata.gz: 91fb18a7f4ffac6b0ad761c9d41dc29b325f172c
+  data.tar.gz: 06db1f1fb19d9afed8e77e65c1c4f543af6fdee6
 SHA512:
-  metadata.gz: 74406b650004129620d0953bfa8831efd8a3c145b760494e8c6c07d1addfc8a3ca272d315726fe2dc183e66223044b2223b089e005a58adbc02e8d2275fe91ef
-  data.tar.gz: c17199c88637ef514364a4941963824fcceaaec2c00551a36fc852ff433ed8f192ed47a7c0206b3ae81bc39862f1596ed73cec0aa6409f2668fbf0c38aad76c5
+  metadata.gz: 265250202da381835bb2a4d8fdde5197293dffc01f0fdf4da89fb51672883ec31ba1f6e1bfe01c2745e5b92dfaff417a50163be63e098bc328f1d82a2189a7d2
+  data.tar.gz: 85318de93eeb417cee8b49fe45455b19ad8a7d3a5c8d2467edb68b22ac7196c52c79c84a06435ec6ccda5a226e43001cc0594a9540e6f4ea05cb592743330a2a

data/lib/xqsr3/extensions/string/nil_if_empty.rb

@@ -0,0 +1,8 @@
+
+require 'xqsr3/string_utilities/nil_if_empty'
+
+class String
+
+	include ::Xqsr3::StringUtilities::NilIfEmpty
+end # class String
+

data/lib/xqsr3/extensions/string/nil_if_whitespace.rb

@@ -0,0 +1,8 @@
+
+require 'xqsr3/string_utilities/nil_if_whitespace'
+
+class String
+
+	include ::Xqsr3::StringUtilities::NilIfWhitespace
+end # class String
+

data/lib/xqsr3/string_utilities/nil_if_empty.rb

@@ -0,0 +1,94 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/string_utilities/nil_if_empty.rb
+#
+# Purpose:      Definition of the ::Xqsr3::StringUtilities::NilIfEmpty
+#               module
+#
+# Created:      25th January 2018
+# Updated:      25th January 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::StringUtilities::NilIfEmpty
+
+=begin
+=end
+
+module Xqsr3
+module StringUtilities
+
+module NilIfEmpty
+
+	private
+	module NilIfEmpty_Helper_ #:nodoc:
+
+		def self.string_nil_if_empty_array_ s
+
+			return s if s && !s.empty?
+
+			nil
+		end
+	end
+	public
+
+	# Returns +nil+ if the given string is empty, otherwise returning the
+	# given string
+	#
+	# === *Parameters*
+	#
+	# * *Required parameters*:
+	#   - +s+:: [String] The string to be evaluated
+	def self.string_nil_if_empty s
+
+		NilIfEmpty_Helper_.string_nil_if_empty_array_ s
+	end
+
+	def nil_if_empty
+
+		NilIfEmpty_Helper_.string_nil_if_empty_array_ self
+	end
+end # module NilIfEmpty
+
+end # module StringUtilities
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+
+

data/lib/xqsr3/string_utilities/nil_if_whitespace.rb

@@ -0,0 +1,94 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/string_utilities/nil_if_whitespace.rb
+#
+# Purpose:      Definition of the ::Xqsr3::StringUtilities::NilIfWhitespace
+#               module
+#
+# Created:      25th January 2018
+# Updated:      25th January 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::StringUtilities::NilIfWhitespace
+
+=begin
+=end
+
+module Xqsr3
+module StringUtilities
+
+module NilIfWhitespace
+
+	private
+	module NilIfWhitespace_Helper_ #:nodoc:
+
+		def self.string_nil_if_whitespace_array_ s
+
+			return nil if s.strip.empty?
+
+			s
+		end
+	end
+	public
+
+	# Returns +nil+ if the given string is empty or contains only whitespace,
+	# otherwise returning the given string
+	#
+	# === *Parameters*
+	#
+	# * *Required parameters*:
+	#   - +s+:: [String] The string to be evaluated
+	def self.string_nil_if_whitespace s
+
+		NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ s
+	end
+
+	def nil_if_whitespace
+
+		NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ self
+	end
+end # module NilIfWhitespace
+
+end # module StringUtilities
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+
+

data/lib/xqsr3/version.rb

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

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

@@ -6,13 +6,13 @@
 #               module
 #
 # Created:      30th July 2017
-# Updated:      1st November 2017
+# Updated:      1st February 2018
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2017, Matthew Wilson and Synesis Software
+# Copyright (c) 2017-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -149,6 +149,13 @@ module Compare
 
 			r
 		end
+
+		def to_s
+
+			return 'same' if same?
+
+			"different, because: #{details}"
+		end
 	end
 
 	module Internal_Compare_

data/test/unit/extensions/string/tc_nil_if_empty.rb

@@ -0,0 +1,27 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../../../lib')
+
+require 'xqsr3/extensions/string/nil_if_empty'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+require 'stringio'
+
+class Test_String_nil_if_empty < Test::Unit::TestCase
+
+	def test_String_has_method
+
+		assert ''.respond_to? :nil_if_empty
+	end
+
+	def test_nil_if_empty
+
+		assert_nil ''.nil_if_empty
+		assert_equal ' ', ' '.nil_if_empty
+		assert_equal 'a', 'a'.nil_if_empty
+	end
+end
+
+

data/test/unit/extensions/string/tc_nil_if_whitespace.rb

@@ -0,0 +1,27 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../../../lib')
+
+require 'xqsr3/extensions/string/nil_if_whitespace'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+require 'stringio'
+
+class Test_String_nil_if_whitespace < Test::Unit::TestCase
+
+	def test_String_has_method
+
+		assert ''.respond_to? :nil_if_whitespace
+	end
+
+	def test_nil_if_whitespace
+
+		assert_nil ''.nil_if_whitespace
+		assert_nil ' '.nil_if_whitespace
+		assert_equal 'a', 'a'.nil_if_whitespace
+	end
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.21.3
+  version: 0.22.2
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies: []
 description: |
   eXtensions by fine Quantum for Standard Ruby and 3rd-party libraries is a
@@ -46,6 +46,8 @@ files:
 - lib/xqsr3/extensions/string.rb
 - lib/xqsr3/extensions/string/ends_with.rb
 - lib/xqsr3/extensions/string/map_option_string.rb
+- lib/xqsr3/extensions/string/nil_if_empty.rb
+- lib/xqsr3/extensions/string/nil_if_whitespace.rb
 - lib/xqsr3/extensions/string/quote_if.rb
 - lib/xqsr3/extensions/string/starts_with.rb
 - lib/xqsr3/extensions/string/to_bool.rb
@@ -66,6 +68,8 @@ files:
 - lib/xqsr3/quality.rb
 - lib/xqsr3/quality/parameter_checking.rb
 - lib/xqsr3/string_utilities/ends_with.rb
+- lib/xqsr3/string_utilities/nil_if_empty.rb
+- lib/xqsr3/string_utilities/nil_if_whitespace.rb
 - lib/xqsr3/string_utilities/quote_if.rb
 - lib/xqsr3/string_utilities/starts_with.rb
 - lib/xqsr3/string_utilities/to_symbol.rb
@@ -98,6 +102,8 @@ files:
 - test/unit/extensions/string/tc_bool.tb
 - test/unit/extensions/string/tc_ends_with.rb
 - test/unit/extensions/string/tc_map_option_string.rb
+- test/unit/extensions/string/tc_nil_if_empty.rb
+- test/unit/extensions/string/tc_nil_if_whitespace.rb
 - test/unit/extensions/string/tc_quote_if.rb
 - test/unit/extensions/string/tc_starts_with.rb
 - test/unit/extensions/string/tc_to_symbol.rb