xqsr3 0.38.2 → 0.39.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +15 -6
- data/examples/count_word_frequencies.md +12 -12
- data/examples/count_word_frequencies.rb +4 -4
- data/lib/xqsr3/array_utilities/join_with_or.rb +47 -47
- data/lib/xqsr3/array_utilities.rb +2 -2
- data/lib/xqsr3/command_line_utilities/map_option_string.rb +60 -60
- data/lib/xqsr3/command_line_utilities.rb +2 -2
- data/lib/xqsr3/containers/frequency_map.rb +399 -399
- data/lib/xqsr3/containers/multi_map.rb +448 -448
- data/lib/xqsr3/containers.rb +3 -3
- data/lib/xqsr3/conversion/bool_parser.rb +51 -51
- data/lib/xqsr3/conversion/integer_parser.rb +87 -87
- data/lib/xqsr3/conversion.rb +3 -3
- data/lib/xqsr3/diagnostics/exception_utilities.rb +145 -145
- data/lib/xqsr3/diagnostics/exceptions/with_cause.rb +90 -90
- data/lib/xqsr3/diagnostics/inspect_builder.rb +80 -80
- data/lib/xqsr3/diagnostics.rb +3 -3
- data/lib/xqsr3/doc_.rb +130 -130
- data/lib/xqsr3/extensions/array/join_with_or.rb +9 -9
- data/lib/xqsr3/extensions/enumerable/collect_with_index.rb +12 -12
- data/lib/xqsr3/extensions/enumerable/detect_map.rb +35 -35
- data/lib/xqsr3/extensions/enumerable/unique.rb +29 -28
- data/lib/xqsr3/extensions/hash/deep_transform.rb +1 -1
- data/lib/xqsr3/extensions/hash/except.rb +16 -16
- data/lib/xqsr3/extensions/hash/has_match.rb +10 -10
- data/lib/xqsr3/extensions/hash/match.rb +10 -10
- data/lib/xqsr3/extensions/hash/slice.rb +11 -11
- data/lib/xqsr3/extensions/hash.rb +1 -1
- data/lib/xqsr3/extensions/integer/to_s_grp.rb +118 -0
- data/lib/xqsr3/extensions/integer.rb +3 -0
- data/lib/xqsr3/extensions/io/writelines.rb +28 -28
- data/lib/xqsr3/extensions/kernel/integer.rb +20 -20
- data/lib/xqsr3/extensions/kernel/raise_with_options.rb +8 -8
- data/lib/xqsr3/extensions/kernel.rb +1 -0
- data/lib/xqsr3/extensions/string/ends_with.rb +1 -1
- data/lib/xqsr3/extensions/string/map_option_string.rb +4 -4
- data/lib/xqsr3/extensions/string/nil_if_empty.rb +1 -1
- data/lib/xqsr3/extensions/string/nil_if_whitespace.rb +1 -1
- data/lib/xqsr3/extensions/string/quote_if.rb +1 -1
- data/lib/xqsr3/extensions/string/starts_with.rb +1 -1
- data/lib/xqsr3/extensions/string/to_bool.rb +8 -8
- data/lib/xqsr3/extensions/string/to_symbol.rb +1 -1
- data/lib/xqsr3/extensions/string/truncate.rb +1 -1
- data/lib/xqsr3/extensions/test/unit/assert_eql.rb +7 -7
- data/lib/xqsr3/extensions/test/unit/assert_false.rb +6 -6
- data/lib/xqsr3/extensions/test/unit/assert_not.rb +6 -6
- data/lib/xqsr3/extensions/test/unit/assert_not_eql.rb +7 -7
- data/lib/xqsr3/extensions/test/unit/assert_raise_with_message.rb +61 -61
- data/lib/xqsr3/extensions/test/unit/assert_subclass_of.rb +7 -7
- data/lib/xqsr3/extensions/test/unit/assert_superclass_of.rb +7 -7
- data/lib/xqsr3/extensions/test/unit/assert_true.rb +6 -6
- data/lib/xqsr3/extensions/test/unit/assert_type_has_instance_methods.rb +36 -36
- data/lib/xqsr3/extensions.rb +5 -5
- data/lib/xqsr3/hash_utilities/deep_transform.rb +65 -65
- data/lib/xqsr3/hash_utilities/key_matching.rb +77 -77
- data/lib/xqsr3/hash_utilities.rb +3 -3
- data/lib/xqsr3/internal_/test_unit_version_.rb +85 -85
- data/lib/xqsr3/io/writelines.rb +119 -119
- data/lib/xqsr3/quality/parameter_checking.rb +445 -445
- data/lib/xqsr3/quality.rb +2 -2
- data/lib/xqsr3/string_utilities/ends_with.rb +59 -59
- data/lib/xqsr3/string_utilities/nil_if_empty.rb +28 -28
- data/lib/xqsr3/string_utilities/nil_if_whitespace.rb +29 -29
- data/lib/xqsr3/string_utilities/quote_if.rb +50 -50
- data/lib/xqsr3/string_utilities/starts_with.rb +59 -59
- data/lib/xqsr3/string_utilities/to_symbol.rb +75 -75
- data/lib/xqsr3/string_utilities/truncate.rb +55 -55
- data/lib/xqsr3/string_utilities.rb +8 -8
- data/lib/xqsr3/version.rb +12 -12
- data/test/performance/frequency_map.rb +12 -12
- data/test/scratch/test_assert_raise_with_message.rb +11 -11
- data/test/unit/array_utilities/tc_join_with_or.rb +140 -140
- data/test/unit/command_line_utilities/tc_map_option_string.rb +18 -18
- data/test/unit/containers/tc_frequency_map.rb +591 -591
- data/test/unit/containers/tc_multi_map.rb +558 -558
- data/test/unit/conversion/tc_integer_parser.rb +72 -72
- data/test/unit/conversion/tc_to_bool.rb +25 -25
- data/test/unit/diagnostics/exceptions/tc_with_cause.rb +165 -165
- data/test/unit/diagnostics/tc_exception_utilities.rb +156 -156
- data/test/unit/extensions/enumerable/tc_collect_with_index.rb +14 -14
- data/test/unit/extensions/enumerable/tc_detect_map.rb +20 -20
- data/test/unit/extensions/enumerable/tc_unique.rb +34 -34
- data/test/unit/extensions/hash/tc_deep_transform.rb +22 -22
- data/test/unit/extensions/hash/tc_except.rb +28 -28
- data/test/unit/extensions/hash/tc_slice.rb +13 -13
- data/test/unit/extensions/integer/tc_to_s_grp.rb +60 -0
- data/test/unit/extensions/integer/ts_all.rb +12 -0
- data/test/unit/extensions/io/tc_writelines.rb +77 -77
- data/test/unit/extensions/kernel/tc_integer.rb +75 -75
- data/test/unit/extensions/kernel/tc_raise_with_options.rb +155 -155
- data/test/unit/extensions/object/tc_inspect.rb +50 -50
- data/test/unit/extensions/string/tc_bool.tb +24 -24
- data/test/unit/extensions/string/tc_ends_with.rb +53 -53
- data/test/unit/extensions/string/tc_map_option_string.rb +15 -15
- data/test/unit/extensions/string/tc_nil_if_empty.rb +8 -8
- data/test/unit/extensions/string/tc_nil_if_whitespace.rb +8 -8
- data/test/unit/extensions/string/tc_quote_if.rb +18 -18
- data/test/unit/extensions/string/tc_starts_with.rb +53 -53
- data/test/unit/extensions/string/tc_to_symbol.rb +26 -26
- data/test/unit/extensions/string/tc_truncate.rb +18 -18
- data/test/unit/extensions/test/unit/tc_assert_raise_with_message.rb +16 -16
- data/test/unit/extensions/test/unit/tc_assert_subclass_of.rb +9 -9
- data/test/unit/extensions/test/unit/tc_assert_superclass_of.rb +9 -9
- data/test/unit/hash_utilities/tc_has_match.rb +70 -70
- data/test/unit/hash_utilities/tc_match.rb +83 -83
- data/test/unit/io/tc_writelines.rb +106 -106
- data/test/unit/quality/tc_parameter_checking.rb +389 -389
- data/test/unit/string_utilities/tc_truncate.rb +27 -27
- data/test/unit/tc_version.rb +15 -15
- metadata +6 -2
@@ -3,14 +3,14 @@ require 'xqsr3/command_line_utilities/map_option_string'
|
|
3
3
|
|
4
4
|
class String
|
5
5
|
|
6
|
-
|
6
|
+
include ::Xqsr3::CommandLineUtilities::MapOptionString
|
7
7
|
end # class String
|
8
8
|
|
9
9
|
class NilClass
|
10
10
|
|
11
|
-
|
11
|
+
def map_option_string *args
|
12
12
|
|
13
|
-
|
14
|
-
|
13
|
+
nil
|
14
|
+
end
|
15
15
|
end
|
16
16
|
|
@@ -3,13 +3,13 @@ require 'xqsr3/conversion/bool_parser'
|
|
3
3
|
|
4
4
|
class String
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
6
|
+
# Attempts to convert instance to a Boolean value, based on the given
|
7
|
+
# +options+
|
8
|
+
#
|
9
|
+
# See Xqsr3::Conversion::BoolParser
|
10
|
+
def to_bool **options
|
11
|
+
|
12
|
+
return ::Xqsr3::Conversion::BoolParser.to_bool self, **options
|
13
|
+
end
|
14
14
|
end # class String
|
15
15
|
|
@@ -4,15 +4,15 @@ module Unit
|
|
4
4
|
|
5
5
|
module Assertions
|
6
6
|
|
7
|
-
|
7
|
+
unless respond_to? :assert_eql
|
8
8
|
|
9
|
-
|
10
|
-
|
11
|
-
|
9
|
+
# Assert that +expected+ and +actual+ have the same hash key, as
|
10
|
+
# evaluated by the instance method +eq?+
|
11
|
+
def assert_eql(expected, actual, failure_message = '')
|
12
12
|
|
13
|
-
|
14
|
-
|
15
|
-
|
13
|
+
assert expected.eql?(actual), failure_message
|
14
|
+
end
|
15
|
+
end
|
16
16
|
|
17
17
|
end # class Assertions
|
18
18
|
end # module Unit
|
@@ -4,14 +4,14 @@ module Unit
|
|
4
4
|
|
5
5
|
module Assertions
|
6
6
|
|
7
|
-
|
7
|
+
unless respond_to? :assert_false
|
8
8
|
|
9
|
-
|
10
|
-
|
9
|
+
# Assert that +expression+ is +false+ (and not merely _falsey_)
|
10
|
+
def assert_false(expression, failure_message = '')
|
11
11
|
|
12
|
-
|
13
|
-
|
14
|
-
|
12
|
+
assert ::FalseClass === (expression), failure_message
|
13
|
+
end
|
14
|
+
end
|
15
15
|
|
16
16
|
end # class Assertions
|
17
17
|
end # module Unit
|
@@ -4,14 +4,14 @@ module Unit
|
|
4
4
|
|
5
5
|
module Assertions
|
6
6
|
|
7
|
-
|
7
|
+
unless respond_to? :assert_not
|
8
8
|
|
9
|
-
|
10
|
-
|
9
|
+
# Assert that +expression+ is _falsey_
|
10
|
+
def assert_not(expression, failure_message = '')
|
11
11
|
|
12
|
-
|
13
|
-
|
14
|
-
|
12
|
+
assert !(expression), failure_message
|
13
|
+
end
|
14
|
+
end
|
15
15
|
|
16
16
|
end # class Assertions
|
17
17
|
end # module Unit
|
@@ -4,15 +4,15 @@ module Unit
|
|
4
4
|
|
5
5
|
module Assertions
|
6
6
|
|
7
|
-
|
7
|
+
unless respond_to? :assert_not_eql
|
8
8
|
|
9
|
-
|
10
|
-
|
11
|
-
|
9
|
+
# Assert that +expected+ and +actual+ have different hash keys, as
|
10
|
+
# evaluated by the instance method +eq?+
|
11
|
+
def assert_not_eql(expected, actual, failure_message = '')
|
12
12
|
|
13
|
-
|
14
|
-
|
15
|
-
|
13
|
+
assert !(expected.eql?(actual)), failure_message
|
14
|
+
end
|
15
|
+
end
|
16
16
|
|
17
17
|
end # class Assertions
|
18
18
|
end # module Unit
|
@@ -9,13 +9,13 @@ module Internal_ # :nodoc: all
|
|
9
9
|
# @!visibility private
|
10
10
|
module X_assert_raise_with_message_ # :nodoc: all
|
11
11
|
|
12
|
-
|
12
|
+
if TestUnitVersion_.is_at_least? [ 3, 0, 8 ]
|
13
13
|
|
14
|
-
|
15
|
-
|
14
|
+
AssertionFailedError_ = Test::Unit::AssertionFailedError # :nodoc:
|
15
|
+
else
|
16
16
|
|
17
|
-
|
18
|
-
|
17
|
+
class AssertionFailedError_ < ArgumentError; end # :nodoc:
|
18
|
+
end
|
19
19
|
|
20
20
|
end # module X_assert_raise_with_message_
|
21
21
|
end # module Internal_
|
@@ -28,87 +28,87 @@ module Unit
|
|
28
28
|
|
29
29
|
module Assertions
|
30
30
|
|
31
|
-
|
31
|
+
undef :assert_raise_with_message if respond_to? :assert_raise_with_message
|
32
32
|
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
33
|
+
# Asserts that the attached block raises an exception of one of the
|
34
|
+
# exceptions defined by +type_spec+ and/or has a message matching
|
35
|
+
# +message_spec+
|
36
|
+
#
|
37
|
+
# === Signature
|
38
|
+
#
|
39
|
+
# * *Parameters:*
|
40
|
+
# - +type_spec+ (String, Regexp, [String], [Regexp], nil) Specification of type expectation(s)
|
41
|
+
# - +message_spec+ (String, Regexp, [String], [Regexp], nil) Specification of message expectation(s)
|
42
|
+
# - +failure_message+ (String, nil) Optional message to be used if the matching fails
|
43
|
+
#
|
44
|
+
# * *Block*
|
45
|
+
# A required block containing code that is expected to raise an exception
|
46
|
+
def assert_raise_with_message(type_spec, message_spec, failure_message = nil, &block)
|
47
47
|
|
48
|
-
|
48
|
+
unless block_given?
|
49
49
|
|
50
|
-
|
50
|
+
msg = "WARNING: no block_given to assert_raise_with_message() called from: #{caller[0]}"
|
51
51
|
|
52
|
-
|
52
|
+
warn "\n#{msg}"
|
53
53
|
|
54
|
-
|
55
|
-
|
54
|
+
assert false, msg
|
55
|
+
end
|
56
56
|
|
57
|
-
|
58
|
-
|
57
|
+
case type_spec
|
58
|
+
when ::Array, nil
|
59
59
|
|
60
|
-
|
61
|
-
|
60
|
+
;
|
61
|
+
else
|
62
62
|
|
63
|
-
|
64
|
-
|
63
|
+
type_spec = [ type_spec ]
|
64
|
+
end
|
65
65
|
|
66
|
-
|
67
|
-
|
66
|
+
case message_spec
|
67
|
+
when ::Array, nil
|
68
68
|
|
69
|
-
|
70
|
-
|
69
|
+
;
|
70
|
+
else
|
71
71
|
|
72
|
-
|
73
|
-
|
72
|
+
message_spec = [ message_spec ]
|
73
|
+
end
|
74
74
|
|
75
75
|
|
76
|
-
|
76
|
+
begin
|
77
77
|
|
78
|
-
|
78
|
+
yield
|
79
79
|
|
80
|
-
|
81
|
-
|
80
|
+
assert false, 'the block did not throw an exception as was expected'
|
81
|
+
rescue ::Xqsr3::Internal_::X_assert_raise_with_message_::AssertionFailedError_
|
82
82
|
|
83
|
-
|
84
|
-
|
83
|
+
raise
|
84
|
+
rescue Exception => x
|
85
85
|
|
86
|
-
|
86
|
+
if type_spec
|
87
87
|
|
88
|
-
|
89
|
-
|
88
|
+
assert false, "exception (#{x.class}) - message: '#{x.message}' - not of any of required types (#{type_spec.join(', ')}); #{x.class} given" unless type_spec.any? { |c| x.is_a? c}
|
89
|
+
end
|
90
90
|
|
91
|
-
|
91
|
+
if message_spec
|
92
92
|
|
93
|
-
|
93
|
+
assert false, "exception message not of any of required messages; '#{x.message}' given" unless message_spec.any? do |m|
|
94
94
|
|
95
|
-
|
96
|
-
|
95
|
+
case m
|
96
|
+
when ::Regexp
|
97
97
|
|
98
|
-
|
99
|
-
|
98
|
+
x.message =~ m
|
99
|
+
when ::String
|
100
100
|
|
101
|
-
|
102
|
-
|
101
|
+
x.message == m
|
102
|
+
else
|
103
103
|
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
104
|
+
warn "\nunsupported message_spec entry '#{m}' (#{m.class})"
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
108
108
|
|
109
|
-
|
110
|
-
|
111
|
-
|
109
|
+
assert true
|
110
|
+
end
|
111
|
+
end
|
112
112
|
end # class Assertions
|
113
113
|
end # module Unit
|
114
114
|
end # module Test
|
@@ -4,16 +4,16 @@ module Unit
|
|
4
4
|
|
5
5
|
module Assertions
|
6
6
|
|
7
|
-
|
7
|
+
unless respond_to? :assert_subclass_of
|
8
8
|
|
9
|
-
|
10
|
-
|
9
|
+
# Assert that +tested_class+ is a sub-class of +parent_class+
|
10
|
+
def assert_subclass_of(parent_class, tested_class, failure_message = nil)
|
11
11
|
|
12
|
-
|
12
|
+
failure_message ||= "#{tested_class} is not a subclass of #{parent_class}"
|
13
13
|
|
14
|
-
|
15
|
-
|
16
|
-
|
14
|
+
assert(tested_class < parent_class, failure_message)
|
15
|
+
end
|
16
|
+
end
|
17
17
|
|
18
18
|
end # class Assertions
|
19
19
|
end # module Unit
|
@@ -4,16 +4,16 @@ module Unit
|
|
4
4
|
|
5
5
|
module Assertions
|
6
6
|
|
7
|
-
|
7
|
+
unless respond_to? :assert_superclass_of
|
8
8
|
|
9
|
-
|
10
|
-
|
9
|
+
# Assert that +tested_class+ is a super-class of +child_class+
|
10
|
+
def assert_superclass_of(child_class, tested_class, failure_message = nil)
|
11
11
|
|
12
|
-
|
12
|
+
failure_message ||= "#{tested_class} is not a superclass of #{child_class}"
|
13
13
|
|
14
|
-
|
15
|
-
|
16
|
-
|
14
|
+
assert(child_class < tested_class, failure_message)
|
15
|
+
end
|
16
|
+
end
|
17
17
|
|
18
18
|
end # class Assertions
|
19
19
|
end # module Unit
|
@@ -4,14 +4,14 @@ module Unit
|
|
4
4
|
|
5
5
|
module Assertions
|
6
6
|
|
7
|
-
|
7
|
+
unless respond_to? :assert_true
|
8
8
|
|
9
|
-
|
10
|
-
|
9
|
+
# Assert that +expression+ is +true+ (and not merely _truey_)
|
10
|
+
def assert_true(expression, failure_message = '')
|
11
11
|
|
12
|
-
|
13
|
-
|
14
|
-
|
12
|
+
assert ::TrueClass === (expression), failure_message
|
13
|
+
end
|
14
|
+
end
|
15
15
|
|
16
16
|
end # class Assertions
|
17
17
|
end # module Unit
|
@@ -4,58 +4,58 @@ module Unit
|
|
4
4
|
|
5
5
|
module Assertions
|
6
6
|
|
7
|
-
|
7
|
+
unless respond_to? :assert_type_has_instance_methods
|
8
8
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
9
|
+
# Fails unless the given +type+ responds to all of the messages
|
10
|
+
# given by +message_spec+
|
11
|
+
#
|
12
|
+
# === Signature
|
13
|
+
#
|
14
|
+
# * *Parameters:*
|
15
|
+
# - +type+ (::Class) The type
|
16
|
+
# - +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)
|
17
|
+
# - +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
|
18
|
+
def assert_type_has_instance_methods(type, message_spec, failure_message = nil)
|
19
19
|
|
20
|
-
|
20
|
+
warn "type parameter - '#{type} (#{type.class})' - should be a Class" unless type.is_a?(::Class)
|
21
21
|
|
22
|
-
|
23
|
-
|
22
|
+
case message_spec
|
23
|
+
when ::Hash
|
24
24
|
|
25
|
-
|
26
|
-
|
25
|
+
warn "every key in a Hash message_spec should be of type Symbol" unless message_spec.keys.all? { |k| ::Symbol === k }
|
26
|
+
when ::Array
|
27
27
|
|
28
|
-
|
28
|
+
warn "every key in an Array message_spec should be of type Symbol" unless message_spec.all? { |k| ::Symbol === k }
|
29
29
|
|
30
|
-
|
31
|
-
|
30
|
+
message_spec = Hash[message_spec.map { |s| [ s, nil ] }]
|
31
|
+
when ::Symbol
|
32
32
|
|
33
|
-
|
34
|
-
|
33
|
+
message_spec[message_spec] = nil
|
34
|
+
else
|
35
35
|
|
36
|
-
|
36
|
+
msg = "message_spec - '#{message_spec} (#{message_spec.class})' - should be a Symbol, an Array of Symbols, or a Hash of Symbol => message"
|
37
37
|
|
38
|
-
|
38
|
+
warn msg
|
39
39
|
|
40
|
-
|
41
|
-
|
40
|
+
return assert false, msg
|
41
|
+
end
|
42
42
|
|
43
|
-
|
43
|
+
ims = type.instance_methods
|
44
44
|
|
45
|
-
|
45
|
+
message_spec.each do |sym, message|
|
46
46
|
|
47
|
-
|
47
|
+
unless ims.include? sym
|
48
48
|
|
49
|
-
|
50
|
-
|
49
|
+
message ||= failure_message
|
50
|
+
message ||= "type #{type} does not contain the instance method #{sym}"
|
51
51
|
|
52
|
-
|
53
|
-
|
54
|
-
|
52
|
+
return assert false, message
|
53
|
+
end
|
54
|
+
end
|
55
55
|
|
56
|
-
|
57
|
-
|
58
|
-
|
56
|
+
assert true
|
57
|
+
end
|
58
|
+
end
|
59
59
|
|
60
60
|
end # class Assertions
|
61
61
|
end # module Unit
|
data/lib/xqsr3/extensions.rb
CHANGED