xqsr3 0.32.2 → 0.32.3

data/lib/xqsr3/extensions/array/join_with_or.rb

@@ -3,6 +3,12 @@ require 'xqsr3/array_utilities/join_with_or'
 
 class Array
 
+	# Extended method implemented by JoinWithOr
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +options+ (Hash) See Xqsr3::ArrayUtilities
 	def join_with_or **options
 
 		return ::Xqsr3::ArrayUtilities::JoinWithOr.join_with_or self, **options

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

@@ -5,13 +5,13 @@
 # Purpose:      Adds a collect_with_index() method to the Enumerable module
 #
 # Created:      24th October 2010
-# Updated:      4th April 2016
+# Updated:      12th April 2019
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2010-2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2010-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -52,8 +52,9 @@
 
 module Enumerable
 
-	## Two-parameter #collect, where the second parameter is a #base-based
-	# index, which increments by 1 for each enumerated element.
+	# Two-parameter variant of +Enumerable+#+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 = []

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

@@ -5,13 +5,13 @@
 # Purpose:      ::Enumerable#detect_map extension
 #
 # Created:      3rd December 2017
-# Updated:      9th December 2017
+# Updated:      12th April 2019
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2017, Matthew Wilson and Synesis Software
+# Copyright (c) 2017-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -49,15 +49,15 @@
 
 module Enumerable
 
-	# The +Enumerable#detect+ method provides a way to detect the presence
+	# The +Enumerable+#+detect+ method provides a way to detect the presence
 	# of a particular value in a collection. The only constraint is that you
 	# get back the object unchanged.
 	#
-	# The +Enumerable#map+ method provides a way to transform the contents of
+	# The +Enumerable+#+map+ method provides a way to transform the contents of
 	# a collection. The only constraint is that you get back another
 	# collection.
 	#
-	# This extension method, +Enumerable#detect_map+ combines the features
+	# This extension method, +Enumerable+#+detect_map+ combines the features
 	# of both, in that it detects the presence of a particular value in a
 	# collection and transform the detected value.
 	#
@@ -65,7 +65,7 @@ module Enumerable
 	#
 	#  { :ab => 'cd', :ef => 'gh' }.detect_map { |k, v| v.upcase if k == :ef } # => 'GH'
 	#
-	# @note The block is required (for technical reasons), and must have
+	# *Note:* The block is required (for technical reasons), and must have
 	# arity 1 for sequences or 2 for associations
 	def detect_map &block
 
@@ -89,7 +89,6 @@ module Enumerable
 
 		nil
 	end
-
 end # module Enumerable
 
 # ############################## end of file ############################# #

data/lib/xqsr3/extensions/hash/has_match.rb

@@ -3,6 +3,13 @@ require 'xqsr3/hash_utilities/key_matching'
 
 class Hash
 
+	# Extended method implemented by Xqsr3::HashUtilities::KeyMatching
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +re+ (Regexp) The regular expression
+	#   - +options+ (Hash) See Xqsr3::HashUtilities::KeyMatching
 	def has_match? re, **options
 
 		return ::Xqsr3::HashUtilities::KeyMatching.has_match? self, re, **options

data/lib/xqsr3/extensions/hash/match.rb

@@ -3,6 +3,13 @@ require 'xqsr3/hash_utilities/key_matching'
 
 class Hash
 
+	# Extended method implemented by Xqsr3::HashUtilities::KeyMatching
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +re+ (Regexp) The regular expression
+	#   - +options+ (Hash) See Xqsr3::HashUtilities::KeyMatching
 	def match re, **options
 
 		return ::Xqsr3::HashUtilities::KeyMatching.match self, re, **options

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

@@ -61,21 +61,14 @@ module Kernel
 	# === Signature
 	#
 	# * *Parameters:*
-	#   - +arg+:: The argument to be converted (to +Fixnum+ or +Bignum+)
-	#   - +base+:: A value of 0, or between 2 and 36. Defaults to 0
-	#   - +options+:: An options hash, containing any of the following
-	#     options
-	#   - +block+:: An optional caller-supplied block that will be invoked
-	#     with the +ArgumentError+ exception, allowing the caller to take
-	#     additional action. If the block returns then its return value will
-	#     be returned to the caller
+	#   - +arg+ The argument to be converted (to +Fixnum+ or +Bignum+)
+	#   - +base+ A value of 0, or between 2 and 36. Defaults to 0
+	#   - +options+ An options hash, containing any of the following options
+	#   - +block+ An optional caller-supplied block that will be invoked with the +ArgumentError+ exception, allowing the caller to take additional action. If the block returns then its return value will be returned to the caller
 	#
 	# * *Options:*
-	#   - +:default+:: A default value to be used when +arg+ is +nil+ or
-	#     cannot be converted by (the original) +Kernel#Integer+
-	#   - +:nil+:: Returns +nil+ if +arg+ is +nil+ or cannot be
-	#     converted by (the original) +Kernel#Integer+. Ignored if
-	#     +:default+ is specified
+	#   - +:default+ A default value to be used when +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+
+	#   - +:nil+ Returns +nil+ if +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+. Ignored if +:default+ is specified
 	def Integer(arg, base = 0, **options, &block)
 
 		::Xqsr3::Conversion::IntegerParser.to_integer arg, base = 0, **options, &block

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

@@ -3,6 +3,10 @@ require 'xqsr3/conversion/bool_parser'
 
 class String
 
+	# Attempts to convert instance to a Boolean value, based on the given
+	# +options+
+	#
+	# See Xqsr3::Conversion::BoolParser
 	def to_bool **options
 
 		return ::Xqsr3::Conversion::BoolParser.to_bool self, **options

data/lib/xqsr3/extensions/test/unit/assert_eql.rb

@@ -6,6 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_eql
 
+		# Assert that +expected+ and +actual+ have the same hash key
 		def assert_eql(expected, actual, failure_message = '')
 
 			assert expected.eql?(actual), failure_message

data/lib/xqsr3/extensions/test/unit/assert_false.rb

@@ -6,6 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_false
 
+		# Assert that +expression+ is +false+
 		def assert_false(expression, failure_message = '')
 
 			assert ::FalseClass === (expression), failure_message

data/lib/xqsr3/extensions/test/unit/assert_not.rb

@@ -6,6 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_not
 
+		# Assert that +expression+ is _falsey_
 		def assert_not(expression, failure_message = '')
 
 			assert !(expression), failure_message

data/lib/xqsr3/extensions/test/unit/assert_not_eql.rb

@@ -6,6 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_not_eql
 
+		# Assert that +expected+ and +actual+ have different hash keys
 		def assert_not_eql(expected, actual, failure_message = '')
 
 			assert !(expected.eql?(actual)), failure_message

data/lib/xqsr3/extensions/test/unit/assert_raise_with_message.rb

@@ -7,10 +7,10 @@ module X_assert_raise_with_message_ # :nodoc:
 
 	if TestUnitVersion_.is_at_least? [ 3, 0, 8 ]
 
-		AssertionFailedError_	=	Test::Unit::AssertionFailedError
+		AssertionFailedError_	=	Test::Unit::AssertionFailedError # :nodoc:
 	else
 
-		class AssertionFailedError_	< ArgumentError; end
+		class AssertionFailedError_	< ArgumentError; end # :nodoc:
 	end
 
 end # module X_assert_raise_with_message_
@@ -24,6 +24,9 @@ module Assertions
 
 	undef :assert_raise_with_message if respond_to? :assert_raise_with_message
 
+	# Asserts that the attached block raises an exception of one of the
+	# exceptions defined by +type_spec+ and/or has a message matching
+	# +message_spec+
 	def assert_raise_with_message(type_spec, message_spec, failure_message = nil, &block)
 
 		unless block_given?

data/lib/xqsr3/extensions/test/unit/assert_subclass_of.rb

@@ -6,6 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_subclass_of
 
+		# Assert that +tested_class+ is a sub-class of +parent_class+
 		def assert_subclass_of(parent_class, tested_class, failure_message = nil)
 
 			failure_message ||= "#{tested_class} is not a subclass of #{parent_class}"

data/lib/xqsr3/extensions/test/unit/assert_superclass_of.rb

@@ -6,6 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_superclass_of
 
+		# Assert that +tested_class+ is a super-class of +child_class+
 		def assert_superclass_of(child_class, tested_class, failure_message = nil)
 
 			failure_message ||= "#{tested_class} is not a superclass of #{child_class}"

data/lib/xqsr3/extensions/test/unit/assert_true.rb

@@ -6,6 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_true
 
+		# Assert that +expression+ is +true+
 		def assert_true(expression, failure_message = '')
 
 			assert ::TrueClass === (expression), failure_message

data/lib/xqsr3/extensions/test/unit/assert_type_has_instance_methods.rb

@@ -12,18 +12,9 @@ module Assertions
 		# === Signature
 		#
 		# * *Parameters:*
-		#   - +type+:: [::Class] The type
-		#   - +message_spec+:: [::Symbol, ::Array, ::Hash] A specification
-		#     of message(s) received by the instances of +type+. If a
-		#     ::Symbol, then instances must respond to this single message.
-		#     If an ::Array (all elements of which must be ::Symbol), then
-		#     instances must respond to _all_ messages. If a ::Hash, then
-		#     instances must respond to _all_ messages represented by the
-		#     keys; the values are available for specifying a custom failure
-		#     message (or value is +nil+ for stock message)
-		#  - +failure_message+:: [::String] If specified, is used when
-		#     instances of +type+ do not respond to a message and no custom
-		#     failure message is provided for it
+		#   - +type+ (::Class) The type
+		#   - +message_spec+ (::Symbol, ::Array, ::Hash) A specification of message(s) received by the instances of +type+. If a ::Symbol, then instances must respond to this single message.  If an ::Array (all elements of which must be ::Symbol), then instances must respond to _all_ messages. If a ::Hash, then instances must respond to _all_ messages represented by the keys; the values are available for specifying a custom failure message (or value is +nil+ for stock message)
+		#  - +failure_message+ (::String) If specified, is used when instances of +type+ do not respond to a message and no custom failure message is provided for it
 		def assert_type_has_instance_methods(type, message_spec, failure_message = nil)
 
 			warn "type parameter - '#{type} (#{type.class})' - should be a Class" unless type.is_a?(::Class)

data/lib/xqsr3/hash_utilities/deep_transform.rb

@@ -59,7 +59,7 @@ module HashUtilities
 module DeepTransform
 
 	private
-	def self.do_deep_transform_on_hashlike_ h, &block
+	def self.do_deep_transform_on_hashlike_ h, &block # :nodoc:
 
 		::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :map ]
 
@@ -92,7 +92,7 @@ module DeepTransform
 		h
 	end
 
-	def do_deep_transform_on_self_ &block
+	def do_deep_transform_on_self_ &block # :nodoc:
 
 		::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[]=, :delete, :keys ]
 

data/lib/xqsr3/internal_/test_unit_version_.rb

@@ -8,8 +8,8 @@ begin
 	require 'test/unit/version'
 
 	module Xqsr3
-	module Internal_
-	module TestUnitVersion_
+	module Internal_ # :nodoc:
+	module TestUnitVersion_ # :nodoc:
 
 		TEST_UNIT_VERSION_	=	Test::Unit::VERSION # :nodoc:
 	end # module TestUnitVersion_
@@ -18,8 +18,8 @@ begin
 rescue LoadError
 
 	module Xqsr3
-	module Internal_
-	module TestUnitVersion_
+	module Internal_ # :nodoc:
+	module TestUnitVersion_ # :nodoc:
 
 		TEST_UNIT_VERSION_	=	:not_found # :nodoc:
 	end # module TestUnitVersion_

data/lib/xqsr3/io/writelines.rb

@@ -126,14 +126,14 @@ $stderr.puts "#{self.class}.write_to_target_(target(#{target.class})='#{target}'
 	# === Signature
 	#
 	# * *Parameters:*
-	#   - +target+:: The target of the write, which may be a string containing the path or a stream instance that supports write
-	#   - +contents+:: The contents to be write, which may be a +Hash+, or an +Array+, or a +String+ containing delimited fields
-	#   - +options+:: An options hash, containing any of the following options
+	#   - +target+ The target of the write, which may be a string containing the path or a stream instance that supports write
+	#   - +contents+ The contents to be write, which may be a +Hash+, or an +Array+, or a +String+ containing delimited fields
+	#   - +options+ An options hash, containing any of the following options
 	#
 	# * *Options:*
-	#   - +:column_separator+:: {optional} The column separator, to be applied between each field in the case where +contents+ is a +Hash+.
-	#   - +:eol_lookahead_limit+:: {optional} The number of content elements (line/pair) to inspect to determine whether element has a terminating end-of-line sequence. Defaults to 20. If 0, and +:line_separator+ is not specified, then will default to <tt>"\n"</tt>. If +nil+, then every line will be inspected.
-	#   - +:line_separator+:: {optional} The line separator, to be applied to the end of line created from each entry. When not specified, it will be deduced by inspecting +contents+ (according to +eol_lookahead_limit+).
+	#   - +:column_separator+ {optional} The column separator, to be applied between each field in the case where +contents+ is a +Hash+.
+	#   - +:eol_lookahead_limit+ {optional} The number of content elements (line/pair) to inspect to determine whether element has a terminating end-of-line sequence. Defaults to 20. If 0, and +:line_separator+ is not specified, then will default to <tt>"\n"</tt>. If +nil+, then every line will be inspected.
+	#   - +:line_separator+ {optional} The line separator, to be applied to the end of line created from each entry. When not specified, it will be deduced by inspecting +contents+ (according to +eol_lookahead_limit+).
 	#
 	# === Return
 	#

data/lib/xqsr3/quality/parameter_checking.rb

@@ -5,13 +5,13 @@
 # Purpose:      Definition of the ParameterChecking module
 #
 # Created:      12th February 2015
-# Updated:      18th October 2018
+# Updated:      12th April 2019
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2015-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -76,7 +76,7 @@ module ParameterChecking
 			end
 		end
 
-		module Constants
+		module Constants # :nodoc:
 
 			RECOGNISED_OPTION_NAMES = %w{
 
@@ -99,7 +99,7 @@ module ParameterChecking
 	end # module Util_
 	public
 
-	def self.included base
+	def self.included base # :nodoc:
 
 		base.extend self
 	end
@@ -107,42 +107,27 @@ module ParameterChecking
 	private
 	# Check a given parameter (value=+value+, name=+name+) for type and value
 	#
-	# @param +value+:: the parameter whose value and type is to be checked
-	# @param +name+:: (::String, ::Symbol) the name of the parameter to be
-	#         checked
-	# @param +options+:: (::Hash) options that moderate the behaviour
+	# === Signature
 	#
-	# @option +:allow_nil+:: (boolean) The +value+ must not be +nil+ unless
-	#          this option is true
-	# @option +:nil+:: an alias for +:allow_nil+
-	# @option +:ignore_case+:: (boolean) When +:values+ is specified,
-	#  comparisons of strings, or arrays of strings, will be carried out in
-	#  a case-insensitive manner
-	# @option +:types+:: (::Array) An array of types one of which +value+
-	#          must be (or must be derived from). One of these types may be
-	#          an array of types, in which case +value+ may be an array that
-	#          must consist wholly of those types
-	# @option +:type+:: (::Class) A single type parameter, used only if
-	#          +:types+ is not specified
-	# @option +:values+:: (::Array) an array of values one of which +value+
-	#          must be
-	# @option +:responds_to+:: (::Array) An array of symbols specifying all
-	#          messages to which the parameter will respond
-	# @option +:reject_empty+:: (boolean) requires value to respond to
-	#          +empty?+ message and to do so with false, unless +nil+
-	# @option +:require_empty+:: (boolean) requires value to respond to
-	#          +empty?+ message and to do so with true, unless +nil+
-	# @option +:nothrow+:: (boolean) causes failure to be indicated by a
-	#          +nil+ return rather than a thrown exception
-	# @option +:message+:: (::String) specifies a message to be used in any
-	#          thrown exception, which suppresses internal message
-	#          preparation
-	# @option +:strip_str_whitespace+:: (boolean) If +value+ is a string (as
-	#          determined by responding to +to_str+ message), then it will
-	#          be stripped - leading and trailing whitespace removed -
-	#          before any processing
-	# @option +:treat_as_option+:: (boolean) If true, the value will be
-	#          treated as an option when reporting check failure
+	# * *Parameters:*
+	#   - +value+ the parameter whose value and type is to be checked
+	#   - +name+ (::String, ::Symbol) the name of the parameter to be checked
+	#   - +options+ (::Hash) options that moderate the behaviour
+	#
+	# * *Options:*
+	#   - +:allow_nil+ (boolean) The +value+ must not be +nil+ unless this option is true
+	#   - +:nil+ an alias for +:allow_nil+
+	#   - +:ignore_case+ (boolean) When +:values+ is specified, comparisons of strings, or arrays of strings, will be carried out in a case-insensitive manner
+	#   - +:types+ (::Array) An array of types one of which +value+ must be (or must be derived from). One of these types may be an array of types, in which case +value+ may be an array that must consist wholly of those types
+	#   - +:type+ (::Class) A single type parameter, used only if +:types+ is not specified
+	#   - +:values+ (::Array) an array of values one of which +value+ must be
+	#   - +:responds_to+ (::Array) An array of symbols specifying all messages to which the parameter will respond
+	#   - +:reject_empty+ (boolean) requires value to respond to +empty?+ message and to do so with false, unless +nil+
+	#   - +:require_empty+ (boolean) requires value to respond to +empty?+ message and to do so with true, unless +nil+
+	#   - +:nothrow+ (boolean) causes failure to be indicated by a +nil+ return rather than a thrown exception
+	#   - +:message+ (::String) specifies a message to be used in any thrown exception, which suppresses internal message preparation
+	#   - +:strip_str_whitespace+ (boolean) If +value+ is a string (as determined by responding to +to_str+ message), then it will be stripped - leading and trailing whitespace removed - before any processing
+	#   - +:treat_as_option+ (boolean) If true, the value will be treated as an option when reporting check failure
 	#
 	# This method is private, because it should only be used within methods
 	def check_parameter value, name, options = {}, &block
@@ -162,15 +147,14 @@ module ParameterChecking
 	# Specific form of the +check_parameter()+ that is used to check
 	# options, taking instead the hash and the key
 	#
-	# @param +h+:: (::Hash) The options hash from which the named element is
-	#         to be tested. May not be +nil+
-	# @param +name+:: (::String, ::Symbol, [ ::String, ::Symbol ]) The
-	#         options key name, or an array of names. May not be +nil+
-	# @param +options+:: (::Hash) options that moderate the behaviour in the
-	#         same way as for +check_parameter()+ except that the
-	#         +:treat_as_option+ option (with the value +true+) is merged in
-	#         before calling +check_parameter()+
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +h+ (::Hash) The options hash from which the named element is to be tested. May not be +nil+
+	#   - +name+ (::String, ::Symbol, [ ::String, ::Symbol ]) The options key name, or an array of names. May not be +nil+
+	#   - +options+ (::Hash) options that moderate the behaviour in the same way as for +check_parameter()+ except that the +:treat_as_option+ option (with the value +true+) is merged in before calling +check_parameter()+
 	#
+	# * *Options:*
 	def check_option h, name, options = {}, &block
 
 		Util_.check_option h, name, options, &block
@@ -179,37 +163,26 @@ module ParameterChecking
 	public
 	# Check a given parameter (value=+value+, name=+name+) for type and value
 	#
-	# @param +value+:: the parameter whose value and type is to be checked
-	# @param +name+:: the name of the parameter to be checked
-	# @param +options+:: options
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +value+ the parameter whose value and type is to be checked
+	#   - +name+ the name of the parameter to be checked
+	#   - +options+ options
 	#
-	# @option +:allow_nil+:: (boolean) The +value+ must not be +nil+ unless
-	#          this option is true
-	# @option +:nil+:: an alias for +:allow_nil+
-	# @option +:ignore_case+:: (boolean) When +:values+ is specified,
-	#  comparisons of strings, or arrays of strings, will be carried out in
-	#  a case-insensitive manner
-	# @option +:types+:: (::Array) An array of types one of which +value+ must
-	#          be (or must be derived from). One of these types may be an
-	#          array of types, in which case +value+ may be an array that
-	#          must consist wholly of those types
-	# @option +:type+:: (::Class) A single type parameter, used only if
-	#          +:types+ is not specified
-	# @option +:values+:: (::Array) an array of values one of which +value+
-	#          must be
-	# @option +:responds_to+:: (::Array) An array of symbols specifying all
-	#          messages to which the parameter will respond
-	# @option +:reject_empty+:: (boolean) requires value to respond to +empty?+
-	#          message and to do so with false, unless +nil+
-	# @option +:require_empty+:: (boolean) requires value to respond to
-	#          +empty?+ message and to do so with true, unless +nil+
-	# @option +:nothrow+:: (boolean) causes failure to be indicated by a +nil+
-	#          return rather than a thrown exception
-	# @option +:message+:: (boolean) specifies a message to be used in any
-	#          thrown exception, which suppresses internal message
-	#          preparation
-	# @option +:treat_as_option+:: (boolean) If true, the value will be
-	#          treated as an option when reporting check failure
+	# * *Options:*
+	#   - +:allow_nil+ (boolean) The +value+ must not be +nil+ unless this option is true
+	#   - +:nil+ an alias for +:allow_nil+
+	#   - +:ignore_case+ (boolean) When +:values+ is specified, comparisons of strings, or arrays of strings, will be carried out in a case-insensitive manner
+	#   - +:types+ (::Array) An array of types one of which +value+ must be (or must be derived from). One of these types may be an array of types, in which case +value+ may be an array that must consist wholly of those types
+	#   - +:type+ (::Class) A single type parameter, used only if +:types+ is not specified
+	#   - +:values+ (::Array) an array of values one of which +value+ must be
+	#   - +:responds_to+ (::Array) An array of symbols specifying all messages to which the parameter will respond
+	#   - +:reject_empty+ (boolean) requires value to respond to +empty?+ message and to do so with false, unless +nil+
+	#   - +:require_empty+ (boolean) requires value to respond to +empty?+ message and to do so with true, unless +nil+
+	#   - +:nothrow+ (boolean) causes failure to be indicated by a +nil+ return rather than a thrown exception
+	#   - +:message+ (boolean) specifies a message to be used in any thrown exception, which suppresses internal message preparation
+	#   - +:treat_as_option+ (boolean) If true, the value will be treated as an option when reporting check failure
 	#
 	def self.check_parameter value, name, options = {}, &block