xqsr3 0.32.2 → 0.32.3

data/lib/xqsr3/string_utilities/ends_with.rb

@@ -54,12 +54,14 @@
 module Xqsr3
 module StringUtilities
 
+# +include+-able module that provides ::string_ends_with? and #ends_with?
+# methods
 module EndsWith
 
 	private
-	module EndsWith_Helper_ #:nodoc:
+	module EndsWith_Helper_ # :nodoc:
 
-		def self.string_ends_with_helper_ s, prefix
+		def self.string_ends_with_helper_ s, prefix # :nodoc:
 
 			if prefix.nil? || prefix.empty?
 
@@ -78,7 +80,7 @@ module EndsWith
 			nil
 		end
 
-		def self.string_ends_with_array_ s, args
+		def self.string_ends_with_array_ s, args # :nodoc:
 
 			return '' if args.empty?
 
@@ -115,14 +117,20 @@ module EndsWith
 	# === Signature
 	#
 	# * *Parameters:*
-	#
-	# * *Required parameters*:
-	#   - +s+:: [String] The string to be evaluated
+	#   - +s+ (String) The string to be evaluated
+	#   - +args+ 0+ arguments against which +s+ will be evaluated
 	def self.string_ends_with? s, *args
 
 		EndsWith_Helper_.string_ends_with_array_ s, args
 	end
 
+	# Reports on whether the instance ends with a given prefix or set of
+	# prefixes (+args+)
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +args+ 0+ arguments against which the instance will be evaluated
 	def ends_with? *args
 
 		EndsWith_Helper_.string_ends_with_array_ self, args

data/lib/xqsr3/string_utilities/nil_if_empty.rb

@@ -54,12 +54,14 @@
 module Xqsr3
 module StringUtilities
 
+# +include+-able module that provides ::string_nil_if_empty and
+# #nil_if_empty methods
 module NilIfEmpty
 
 	private
-	module NilIfEmpty_Helper_ #:nodoc:
+	module NilIfEmpty_Helper_ # :nodoc:
 
-		def self.string_nil_if_empty_array_ s
+		def self.string_nil_if_empty_array_ s # :nodoc:
 
 			return s if s && !s.empty?
 
@@ -76,12 +78,13 @@ module NilIfEmpty
 	# * *Parameters:*
 	#
 	# * *Required parameters*:
-	#   - +s+:: [String] The string to be evaluated
+	#   - +s+ (String) The string to be evaluated
 	def self.string_nil_if_empty s
 
 		NilIfEmpty_Helper_.string_nil_if_empty_array_ s
 	end
 
+	# Returns +nil+ if the instance is empty, otherwise returning self
 	def nil_if_empty
 
 		NilIfEmpty_Helper_.string_nil_if_empty_array_ self

data/lib/xqsr3/string_utilities/nil_if_whitespace.rb

@@ -54,12 +54,14 @@
 module Xqsr3
 module StringUtilities
 
+# +include+-able module that provides ::string_nil_if_whitespace and
+# #nil_if_whitespace methods
 module NilIfWhitespace
 
 	private
-	module NilIfWhitespace_Helper_ #:nodoc:
+	module NilIfWhitespace_Helper_ # :nodoc:
 
-		def self.string_nil_if_whitespace_array_ s
+		def self.string_nil_if_whitespace_array_ s # :nodoc:
 
 			return nil if s.strip.empty?
 
@@ -76,12 +78,14 @@ module NilIfWhitespace
 	# * *Parameters:*
 	#
 	# * *Required parameters*:
-	#   - +s+:: [String] The string to be evaluated
+	#   - +s+ (String) The string to be evaluated
 	def self.string_nil_if_whitespace s
 
 		NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ s
 	end
 
+	# Returns +nil+ if the instance is empty or contains only whitespace,
+	# otherwise returning self
 	def nil_if_whitespace
 
 		NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ self

data/lib/xqsr3/string_utilities/quote_if.rb

@@ -54,12 +54,13 @@
 module Xqsr3
 module StringUtilities
 
+# +include+-able module that provides ::quote_if and #quote_if methods
 module QuoteIf
 
 	private
-	module QuoteIf_Helper_ #:nodoc:
+	module QuoteIf_Helper_ # :nodoc:
 
-		def self.string_quote_if_array_ s, options
+		def self.string_quote_if_array_ s, options # :nodoc:
 
 			s			=	s.to_s unless String === s
 
@@ -95,27 +96,23 @@ module QuoteIf
 	# * *Parameters:*
 	#
 	# * *Required parameters*:
-	#   - +s+:: [String] The string to be evaluated
+	#   - +s+ (String) The string to be evaluated
 	#
 	# * *Options parameters*:
-	#   - +options+:: [Hash] Options that control the behaviour of the
-	#       method
+	#   - +options+ (Hash) Options that control the behaviour of the method
 	#
 	# * *Options:*
 	#
-	#   - +:quotes+:: [String, Array] A string that is used as the opening
-	#       and closing quotes, or an array whose first two elements are
-	#       used as the opening and closing quotes. Defaults to '"'
-	#   - +:quotables+:: [String, Array, Regexp] A string representing the
-	#       quotable character, or an array containing the quotable
-	#       characters, or a regular expression that determines by match
-	#       whether the string should be quoted. Defaults to the regular
-	#       expression /\s/
+	#   - +:quotes+ (String, Array) A string that is used as the opening and closing quotes, or an array whose first two elements are used as the opening and closing quotes. Defaults to +'"'+
+	#   - +:quotables+ (String, Array, Regexp) A string representing the quotable character, or an array containing the quotable characters, or a regular expression that determines by match whether the string should be quoted. Defaults to the regular expression +/\s/+
 	def self.quote_if s, **options
 
 		QuoteIf_Helper_.string_quote_if_array_ s, options
 	end
 
+	# Converts the instance to a quoted form if necessary
+	#
+	# See Xqsr3::StringUtilities::QuoteIf::quite_if() for options
 	def quote_if **options
 
 		QuoteIf_Helper_.string_quote_if_array_ self, options

data/lib/xqsr3/string_utilities/starts_with.rb

@@ -6,13 +6,13 @@
 #               module
 #
 # Created:      13th April 2016
-# Updated:      10th June 2016
+# Updated:      12th April 2019
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -54,12 +54,14 @@
 module Xqsr3
 module StringUtilities
 
+# +include+-able module that provides ::string_starts_with? and #starts_with?
+# methods
 module StartsWith
 
 	private
-	module StartsWith_Helper_ #:nodoc:
+	module StartsWith_Helper_ # :nodoc:
 
-		def self.string_starts_with_helper_ s, prefix
+		def self.string_starts_with_helper_ s, prefix # :nodoc:
 
 			if prefix.nil? || prefix.empty?
 
@@ -78,7 +80,7 @@ module StartsWith
 			nil
 		end
 
-		def self.string_starts_with_array_ s, args
+		def self.string_starts_with_array_ s, args # :nodoc:
 
 			return '' if args.empty?
 
@@ -109,11 +111,26 @@ module StartsWith
 	end
 	public
 
+	# Reports on whether a string +s+ starts with a given prefix or set of
+	# prefixes (+args+)
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +s+ (String) The string to be evaluated
+	#   - +args+ 0+ arguments against which +s+ will be evaluated
 	def self.string_starts_with? s, *args
 
 		StartsWith_Helper_.string_starts_with_array_ s, args
 	end
 
+	# Reports on whether the instance starts with a given prefix or set of
+	# prefixes (+args+)
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +args+ 0+ arguments against which the instance will be evaluated
 	def starts_with? *args
 
 		StartsWith_Helper_.string_starts_with_array_ self, args

data/lib/xqsr3/string_utilities/to_symbol.rb

@@ -6,13 +6,13 @@
 #               module
 #
 # Created:      14th April 2016
-# Updated:      10th June 2016
+# Updated:      12th April 2019
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -59,15 +59,15 @@ module StringUtilities
 module ToSymbol
 
 	private
-	module ToSymbol_Helper_ #:nodoc:
+	module ToSymbol_Helper_ # :nodoc:
 
-		module Constants #:nodoc:
+		module Constants # :nodoc:
 
 			SymbolCharacters0	=	'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 			SymbolCharactersN	=	'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789'
 		end
 
-		def self.string_to_symbol_with_options_ s, options
+		def self.string_to_symbol_with_options_ s, options # :nodoc:
 
 			case	s
 			when	::String
@@ -127,11 +127,29 @@ module ToSymbol
 	end
 	public
 
+	# Converts the given string +s+ to a symbol according to the given
+	# +options+
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +s+ (String) The string to convert
+	#   - +options+ (Hash) Options hash
+	#
+	# * *Options:*
+	#   - +:reject_hyphens+ (boolean)
+	#   - +:reject_spaces+ (boolean)
+	#   - +:reject_tabs+ (boolean)
+	#   - +:reject_whitespace+ (boolean)
+	#   - +:transform_characters+ (boolean)
 	def self.string_to_symbol s, options = {}
 
 		ToSymbol_Helper_.string_to_symbol_with_options_ s, options
 	end
 
+	# Converts the instance to a symbol, according to the given +options+
+	#
+	# See Xqsr3::StringUtilities::ToSymbol::string_to_symbol for options
 	def to_symbol options = {}
 
 		ToSymbol_Helper_.string_to_symbol_with_options_ self, options

data/lib/xqsr3/string_utilities/truncate.rb

@@ -6,13 +6,13 @@
 #               module
 #
 # Created:      12th April 2018
-# Updated:      12th April 2018
+# Updated:      12th April 2019
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2018-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -59,9 +59,9 @@ module StringUtilities
 module Truncate
 
 	private
-	module Truncate_Helper_ #:nodoc:
+	module Truncate_Helper_ # :nodoc:
 
-		def self.string_truncate_with_options_ s, width, options
+		def self.string_truncate_with_options_ s, width, options # :nodoc:
 
 			case	s
 			when	::String
@@ -102,11 +102,26 @@ module Truncate
 	end
 	public
 
+	# Truncates the given string +s+ to the given +width+ according to the
+	# given +options+
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +s+ (String) The string to convert
+	#   - +width+ (Integer) The truncation width
+	#   - +options+ (Hash) Options hash
+	#
+	# * *Options:*
+	#   - +:omission+ (String) Omission string. Defaults to "..."
 	def self.string_truncate s, width, options = {}
 
 		Truncate_Helper_.string_truncate_with_options_ s, width, options
 	end
 
+	# Truncates the instance, according to the given +width+ and +options+
+	#
+	# See Xqsr3::StringUtilities::ToSymbol::string_truncate for options
 	def truncate width, options = {}
 
 		Truncate_Helper_.string_truncate_with_options_ self, width, options

data/lib/xqsr3/version.rb

@@ -50,7 +50,7 @@
 module Xqsr3
 
 	# Current version of the Xqsr3 library
-	VERSION				=	'0.32.2'
+	VERSION				=	'0.32.3'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.32.2
+  version: 0.32.3
 platform: ruby
 authors:
 - Matt Wilson