xqsr3 0.8.3

data/lib/xqsr3/doc_.rb

@@ -0,0 +1,116 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/doc_.rb
+#
+# Purpose:      Documentation of the ::Xqsr3 modules
+#
+# Created:      10th June 2016
+# Updated:      10th June 2016
+#
+# Home:         http://github.com/synesissoftware/xqsr3
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2016, 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+# Main module for Xqsr3 library
+#
+# === Subordinate modules of interest
+# * ::Xqsr3::CommandLineUtilities
+# * ::Xqsr3::Containers
+# * ::Xqsr3::Diagnostics
+# * ::Xqsr3::IO
+# * ::Xqsr3::Quality
+# * ::Xqsr3::StringUtilities
+module Xqsr3
+
+	# Command-line Utilities
+	#
+	# === Subordinate modules of interest
+	# * ::Xqsr3::CommandLineUtilities::MapOptionString
+	module CommandLineUtilities
+
+	end # module CommandLineUtilities
+
+	# Containers
+	#
+	module Containers
+
+	end # module Containers
+
+	# Diagnostic facilities
+	#
+	# === Subordinate modules of interest
+	# * ::Xqsr3::Diagnostics::ExceptionUtilities
+	#
+	module Diagnostics
+
+		# Exception-related utilities
+		#
+		# === Components of interest
+		# * ::Xqsr3::Diagnostics::ExceptionUtilities::raise_with_options
+		#
+		module ExceptionUtilities
+		end # module ExceptionUtilities
+	end # module Diagnostics
+
+	# IO
+	#
+	module IO
+
+	end # module IO
+
+	# Quality
+	#
+	# === Subordinate modules of interest
+	# * ::Xqsr3::Quality::ParameterChecking
+	module Quality
+
+	end # module Quality
+
+	# String utilities
+	#
+	# === Subordinate modules of interest
+	# * ::Xqsr3::StringUtilities::ToSymbol
+	module StringUtilities
+
+	end # module StringUtilities
+
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/extensions/enumerable.rb

@@ -0,0 +1,4 @@
+
+require 'xqsr3/extensions/enumerable/collect_with_index'
+require 'xqsr3/extensions/enumerable/unique'
+

data/lib/xqsr3/extensions/enumerable/collect_with_index.rb

@@ -0,0 +1,71 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/extensions/enumerable/collect_with_index.rb
+#
+# Purpose:      Adds a collect_with_index() method to the Enumerable module
+#
+# Created:      24th October 2010
+# Updated:      4th April 2016
+#
+# Home:         http://github.com/synesissoftware/xqsr3
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2010-2016, 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.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# ::Enumerable
+
+=begin
+=end
+
+module Enumerable
+
+	## Two-parameter #collect, where the second parameter is a #base-based
+	# index, which increments by 1 for each enumerated element.
+	def collect_with_index(base = 0)
+
+		a = []
+
+		self.each_with_index do |element, index|
+
+			a.push yield(element, base + index)
+		end
+
+		a
+	end
+end # module Enumerable
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/extensions/enumerable/unique.rb

@@ -0,0 +1,102 @@
+
+# ######################################################################## #
+# File: 	    lib/xqsr3/extensions/enumerable/unique.rb
+#
+# Purpose:	    Adds a unique() method to the Enumerable module
+#
+# Created:	    5th March 2007
+# Updated:	    4th April 2016
+#
+# Home:         http://github.com/synesissoftware/xqsr3
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2007-2016, 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.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# ::Enumerable
+
+=begin
+=end
+
+module Enumerable
+
+	# Removes all duplicate elements in a sequence subject to an optional
+	# two-parameter block in order to return an array containing unique
+	# elements
+	def unique(&block)
+
+		if not block
+
+			return unique { |a, b| a == b }
+		else
+
+			if block.arity != 2
+
+				raise ArgumentError, "block requires two parameters"
+			end
+
+			ar	=	self.to_a
+
+			return ar if ar.length < 2
+
+			ar	=	ar.clone
+
+			i	=	0
+
+			while i < ar.length do
+
+				j = i + 1
+
+				while j < ar.length do
+
+					if yield ar[i], ar[j]
+
+						ar.delete_at(j)
+					else
+
+						j = j + 1
+					end
+				end
+
+				i = i + 1
+			end
+
+			return ar
+		end
+	end
+end # module Enumerable
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/extensions/io.rb

@@ -0,0 +1,3 @@
+
+require 'xqsr3/extensions/io/writelines'
+

data/lib/xqsr3/extensions/io/writelines.rb

@@ -0,0 +1,66 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/extensions/io/writelines.rb
+#
+# Purpose:      Adds a writelines() method to the IO class
+#
+# Created:      13th April 2007
+# Updated:      10th June 2016
+#
+# Home:         http://github.com/synesissoftware/xqsr3
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2007-2016, 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.
+#
+# ######################################################################## #
+
+
+require 'xqsr3/io/writelines'
+
+# ##########################################################
+# ::IO
+
+=begin
+=end
+
+class IO
+
+	# Extends +IO+ class with the ::Xqsr3::IO::write_lines
+	# method
+	def self.writelines(path, contents, lineSep = nil, columnSep = nil)
+
+		::Xqsr3::IO.writelines path, contents, line_separator: lineSep, column_separator: columnSep, eol_lookahead_limit: 20
+	end
+end # class IO
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/extensions/kernel.rb

@@ -0,0 +1,3 @@
+
+require 'xqsr3/extensions/kernel/raise_with_options'
+

data/lib/xqsr3/extensions/kernel/raise_with_options.rb

@@ -0,0 +1,68 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/extensions/kernel/raise_with_options.rb
+#
+# Purpose:      Adds a raise_with_options() method to the Kernel module
+#
+# Created:      12th February 2015
+# Updated:      3rd April 2016
+#
+# Home:         http://github.com/synesissoftware/xqsr3
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2015-2016, 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.
+#
+# ######################################################################## #
+
+
+require 'xqsr3/diagnostics/exception_utilities'
+
+# ##########################################################
+# ::Kernel
+
+=begin
+=end
+
+module Kernel
+
+	# Extends +Kernel+ module with the ::Xqsr3::Diagnostics::ExceptionUtilities::raise_with_options
+	# method
+	def raise_with_options *args, **options
+
+		options	||=	{}
+
+		::Xqsr3::Diagnostics::ExceptionUtilities.raise_with_options *args, **(options.merge({ :called_indirectly_06d353cb_5a6c_47ca_8dbe_ff76359c7e96 => 1}))
+	end
+end # module Kernel
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/extensions/string.rb

@@ -0,0 +1,5 @@
+
+require 'xqsr3/extensions/string/ends_with'
+require 'xqsr3/extensions/string/starts_with'
+require 'xqsr3/extensions/string/to_symbol'
+