xqsr3 0.8.3

data/lib/xqsr3/string_utilities/ends_with.rb

@@ -0,0 +1,134 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/string_utilities/ends_with.rb
+#
+# Purpose:      Definition of the ::Xqsr3::StringUtilities::EndsWith
+#               module
+#
+# Created:      13th April 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.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# ::Xqsr3::StringUtilities::EndsWith
+
+=begin
+=end
+
+module Xqsr3
+module StringUtilities
+
+module EndsWith
+
+	private
+	module EndsWith_Helper_ #:nodoc:
+
+		def self.string_ends_with_helper_ s, prefix
+
+			if prefix.nil? || prefix.empty?
+
+				return ''
+			elsif prefix.size < s.size
+
+				return prefix if s[(s.size - prefix.size) ... s.size] == prefix
+			elsif prefix.size == s.size
+
+				return prefix if prefix == s
+			else
+
+				nil
+			end
+
+			nil
+		end
+
+		def self.string_ends_with_array_ s, args
+
+			return '' if args.empty?
+
+			args.each do |prefix|
+
+				case	prefix
+				when	::NilClass
+
+					return ''
+				when	::String
+
+					r = self.string_ends_with_helper_ s, prefix
+
+					return r if r
+				else
+
+					if prefix.respond_to? :to_str
+
+						return self.string_ends_with_helper_ s.prefix.to_str
+					end
+
+					raise TypeError, "ends_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
+				end
+			end
+
+			return nil
+		end
+	end
+	public
+
+	# Reports on whether a string +s+ ends with a given prefix or set of
+	# prefixes (+args+)
+	#
+	# === *Parameters*
+	#
+	# * *Required parameters*:
+	#   - +s+:: [String] The string to be evaluated
+	def self.string_ends_with? s, *args
+
+		EndsWith_Helper_.string_ends_with_array_ s, args
+	end
+
+	def ends_with? *args
+
+		EndsWith_Helper_.string_ends_with_array_ self, args
+	end
+end # module EndsWith
+
+end # module StringUtilities
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/string_utilities/starts_with.rb

@@ -0,0 +1,127 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/string_utilities/starts_with.rb
+#
+# Purpose:      Definition of the ::Xqsr3::StringUtilities::StartsWith
+#               module
+#
+# Created:      13th April 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.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# ::Xqsr3::StringUtilities::StartsWith
+
+=begin
+=end
+
+module Xqsr3
+module StringUtilities
+
+module StartsWith
+
+	private
+	module StartsWith_Helper_ #:nodoc:
+
+		def self.string_starts_with_helper_ s, prefix
+
+			if prefix.nil? || prefix.empty?
+
+				return ''
+			elsif prefix.size < s.size
+
+				return prefix if s[0 ... prefix.size] == prefix
+			elsif prefix.size == s.size
+
+				return prefix if prefix == s
+			else
+
+				nil
+			end
+
+			nil
+		end
+
+		def self.string_starts_with_array_ s, args
+
+			return '' if args.empty?
+
+			args.each do |prefix|
+
+				case	prefix
+				when	::NilClass
+
+					return ''
+				when	::String
+
+					r = self.string_starts_with_helper_ s, prefix
+
+					return r if r
+				else
+
+					if prefix.respond_to? :to_str
+
+						return self.string_starts_with_helper_ s.prefix.to_str
+					end
+
+					raise TypeError, "starts_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
+				end
+			end
+
+			return nil
+		end
+	end
+	public
+
+	def self.string_starts_with? s, *args
+
+		StartsWith_Helper_.string_starts_with_array_ s, args
+	end
+
+	def starts_with? *args
+
+		StartsWith_Helper_.string_starts_with_array_ self, args
+	end
+end # module StartsWith
+
+end # module StringUtilities
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/string_utilities/to_symbol.rb

@@ -0,0 +1,145 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/string_utilities/to_symbol.rb
+#
+# Purpose:      Definition of the ::Xqsr3::StringUtilities::ToSymbol
+#               module
+#
+# Created:      14th April 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.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# ::Xqsr3::StringUtilities::ToSymbol
+
+=begin
+=end
+
+module Xqsr3
+module StringUtilities
+
+# To-symbol conversion facilities
+#
+module ToSymbol
+
+	private
+	module ToSymbol_Helper_ #:nodoc:
+
+		module Constants #:nodoc:
+
+			SymbolCharacters0	=	'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+			SymbolCharactersN	=	'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789'
+		end
+
+		def self.string_to_symbol_with_options_ s, options
+
+			case	s
+			when	::String
+				;
+			else
+
+				if s.respond_to? :to_str
+
+					s = s.to_str
+				else
+
+					raise TypeError, "string argument must be of type #{::String} or a type that will respond to to_str"
+				end
+			end
+
+			case	options
+			when	::Hash
+				;
+			else
+
+				raise TypeError, "options must be of type #{::Hash}, #{options.class} given"
+			end
+
+			return nil if s.empty?
+
+			transform_characters = options[:transform_characters] || []
+
+			s.chars.map.with_index do |c, index|
+
+				if 0 != index && Constants::SymbolCharactersN.include?(c)
+
+					c
+				elsif 0 == index && Constants::SymbolCharacters0.include?(c)
+
+					c
+				else
+
+					case	c
+					when	'-'
+
+						return nil if options[:reject_hyphens]
+					when	' '
+
+						return nil if options[:reject_spaces] || options[:reject_whitespace]
+					when	?\t
+
+						return nil if options[:reject_tabs] || options[:reject_whitespace]
+					else
+
+						return nil unless transform_characters.include? c
+					end
+
+					'_'
+				end
+			end.join('').to_sym
+		end
+	end
+	public
+
+	def self.string_to_symbol s, options = {}
+
+		ToSymbol_Helper_.string_to_symbol_with_options_ s, options
+	end
+
+	def to_symbol options = {}
+
+		ToSymbol_Helper_.string_to_symbol_with_options_ self, options
+	end
+end # module ToSymbol
+
+end # module StringUtilities
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/version.rb

@@ -0,0 +1,68 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/version.rb
+#
+# Purpose:      Version for Xqsr3 library
+#
+# Created:      3rd April 2016
+# Updated:      10th May 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
+
+module Xqsr3
+
+	# Current version of the Xqsr3 library
+	VERSION				=	'0.8.3'
+
+	private
+	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+	public
+	# Major version of the Xqsr3 library
+	VERSION_MAJOR		=	VERSION_PARTS_[0] # :nodoc:
+	# Minor version of the Xqsr3 library
+	VERSION_MINOR		=	VERSION_PARTS_[1] # :nodoc:
+	# Revision version of the Xqsr3 library
+	VERSION_REVISION	=	VERSION_PARTS_[2] # :nodoc:
+
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+