xqsr3 0.38.1.1 → 0.39.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (112) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -6
  3. data/examples/count_word_frequencies.md +13 -13
  4. data/examples/count_word_frequencies.rb +5 -5
  5. data/lib/xqsr3/array_utilities/join_with_or.rb +53 -54
  6. data/lib/xqsr3/array_utilities.rb +2 -2
  7. data/lib/xqsr3/command_line_utilities/map_option_string.rb +66 -67
  8. data/lib/xqsr3/command_line_utilities.rb +2 -2
  9. data/lib/xqsr3/containers/frequency_map.rb +405 -404
  10. data/lib/xqsr3/containers/multi_map.rb +454 -453
  11. data/lib/xqsr3/containers.rb +3 -3
  12. data/lib/xqsr3/conversion/bool_parser.rb +56 -57
  13. data/lib/xqsr3/conversion/integer_parser.rb +92 -93
  14. data/lib/xqsr3/conversion.rb +3 -3
  15. data/lib/xqsr3/diagnostics/exception_utilities.rb +152 -151
  16. data/lib/xqsr3/diagnostics/exceptions/with_cause.rb +99 -95
  17. data/lib/xqsr3/diagnostics/inspect_builder.rb +86 -86
  18. data/lib/xqsr3/diagnostics.rb +3 -3
  19. data/lib/xqsr3/doc_.rb +136 -136
  20. data/lib/xqsr3/extensions/array/join_with_or.rb +9 -9
  21. data/lib/xqsr3/extensions/enumerable/collect_with_index.rb +18 -17
  22. data/lib/xqsr3/extensions/enumerable/detect_map.rb +41 -41
  23. data/lib/xqsr3/extensions/enumerable/unique.rb +32 -31
  24. data/lib/xqsr3/extensions/hash/deep_transform.rb +1 -1
  25. data/lib/xqsr3/extensions/hash/except.rb +16 -16
  26. data/lib/xqsr3/extensions/hash/has_match.rb +10 -10
  27. data/lib/xqsr3/extensions/hash/match.rb +10 -10
  28. data/lib/xqsr3/extensions/hash/slice.rb +11 -11
  29. data/lib/xqsr3/extensions/hash.rb +1 -1
  30. data/lib/xqsr3/extensions/integer/to_s_grp.rb +118 -0
  31. data/lib/xqsr3/extensions/integer.rb +3 -0
  32. data/lib/xqsr3/extensions/io/writelines.rb +34 -34
  33. data/lib/xqsr3/extensions/kernel/integer.rb +26 -26
  34. data/lib/xqsr3/extensions/kernel/raise_with_options.rb +15 -14
  35. data/lib/xqsr3/extensions/kernel.rb +1 -0
  36. data/lib/xqsr3/extensions/string/ends_with.rb +1 -1
  37. data/lib/xqsr3/extensions/string/map_option_string.rb +4 -5
  38. data/lib/xqsr3/extensions/string/nil_if_empty.rb +1 -1
  39. data/lib/xqsr3/extensions/string/nil_if_whitespace.rb +1 -1
  40. data/lib/xqsr3/extensions/string/quote_if.rb +1 -2
  41. data/lib/xqsr3/extensions/string/starts_with.rb +1 -1
  42. data/lib/xqsr3/extensions/string/to_bool.rb +8 -9
  43. data/lib/xqsr3/extensions/string/to_symbol.rb +1 -1
  44. data/lib/xqsr3/extensions/string/truncate.rb +1 -2
  45. data/lib/xqsr3/extensions/test/unit/assert_eql.rb +7 -7
  46. data/lib/xqsr3/extensions/test/unit/assert_false.rb +6 -7
  47. data/lib/xqsr3/extensions/test/unit/assert_not.rb +6 -7
  48. data/lib/xqsr3/extensions/test/unit/assert_not_eql.rb +7 -7
  49. data/lib/xqsr3/extensions/test/unit/assert_raise_with_message.rb +61 -62
  50. data/lib/xqsr3/extensions/test/unit/assert_subclass_of.rb +7 -8
  51. data/lib/xqsr3/extensions/test/unit/assert_superclass_of.rb +7 -8
  52. data/lib/xqsr3/extensions/test/unit/assert_true.rb +6 -7
  53. data/lib/xqsr3/extensions/test/unit/assert_type_has_instance_methods.rb +36 -38
  54. data/lib/xqsr3/extensions.rb +5 -5
  55. data/lib/xqsr3/hash_utilities/deep_transform.rb +71 -71
  56. data/lib/xqsr3/hash_utilities/key_matching.rb +82 -82
  57. data/lib/xqsr3/hash_utilities.rb +3 -3
  58. data/lib/xqsr3/internal_/test_unit_version_.rb +130 -88
  59. data/lib/xqsr3/io/writelines.rb +125 -125
  60. data/lib/xqsr3/quality/parameter_checking.rb +452 -453
  61. data/lib/xqsr3/quality.rb +2 -2
  62. data/lib/xqsr3/string_utilities/ends_with.rb +64 -64
  63. data/lib/xqsr3/string_utilities/nil_if_empty.rb +33 -34
  64. data/lib/xqsr3/string_utilities/nil_if_whitespace.rb +35 -35
  65. data/lib/xqsr3/string_utilities/quote_if.rb +55 -56
  66. data/lib/xqsr3/string_utilities/starts_with.rb +64 -64
  67. data/lib/xqsr3/string_utilities/to_symbol.rb +80 -80
  68. data/lib/xqsr3/string_utilities/truncate.rb +60 -61
  69. data/lib/xqsr3/string_utilities.rb +8 -8
  70. data/lib/xqsr3/version.rb +19 -20
  71. data/test/performance/frequency_map.rb +13 -27
  72. data/test/scratch/test_assert_raise_with_message.rb +12 -13
  73. data/test/unit/array_utilities/tc_join_with_or.rb +140 -142
  74. data/test/unit/command_line_utilities/tc_map_option_string.rb +18 -18
  75. data/test/unit/containers/tc_frequency_map.rb +607 -554
  76. data/test/unit/containers/tc_multi_map.rb +573 -522
  77. data/test/unit/conversion/tc_integer_parser.rb +73 -73
  78. data/test/unit/conversion/tc_to_bool.rb +26 -26
  79. data/test/unit/diagnostics/exceptions/tc_with_cause.rb +165 -165
  80. data/test/unit/diagnostics/tc_exception_utilities.rb +156 -156
  81. data/test/unit/extensions/enumerable/tc_collect_with_index.rb +14 -14
  82. data/test/unit/extensions/enumerable/tc_detect_map.rb +20 -20
  83. data/test/unit/extensions/enumerable/tc_unique.rb +34 -34
  84. data/test/unit/extensions/hash/tc_deep_transform.rb +22 -22
  85. data/test/unit/extensions/hash/tc_except.rb +28 -28
  86. data/test/unit/extensions/hash/tc_hash.rb +1 -1
  87. data/test/unit/extensions/hash/tc_slice.rb +14 -14
  88. data/test/unit/extensions/integer/tc_to_s_grp.rb +60 -0
  89. data/test/unit/extensions/integer/ts_all.rb +12 -0
  90. data/test/unit/extensions/io/tc_writelines.rb +77 -77
  91. data/test/unit/extensions/kernel/tc_integer.rb +75 -75
  92. data/test/unit/extensions/kernel/tc_raise_with_options.rb +155 -155
  93. data/test/unit/extensions/object/tc_inspect.rb +51 -51
  94. data/test/unit/extensions/string/tc_bool.tb +24 -24
  95. data/test/unit/extensions/string/tc_ends_with.rb +53 -53
  96. data/test/unit/extensions/string/tc_map_option_string.rb +15 -15
  97. data/test/unit/extensions/string/tc_nil_if_empty.rb +8 -8
  98. data/test/unit/extensions/string/tc_nil_if_whitespace.rb +8 -8
  99. data/test/unit/extensions/string/tc_quote_if.rb +18 -18
  100. data/test/unit/extensions/string/tc_starts_with.rb +53 -53
  101. data/test/unit/extensions/string/tc_to_symbol.rb +26 -26
  102. data/test/unit/extensions/string/tc_truncate.rb +18 -18
  103. data/test/unit/extensions/test/unit/tc_assert_raise_with_message.rb +16 -16
  104. data/test/unit/extensions/test/unit/tc_assert_subclass_of.rb +9 -9
  105. data/test/unit/extensions/test/unit/tc_assert_superclass_of.rb +9 -9
  106. data/test/unit/hash_utilities/tc_has_match.rb +70 -70
  107. data/test/unit/hash_utilities/tc_match.rb +83 -83
  108. data/test/unit/io/tc_writelines.rb +106 -108
  109. data/test/unit/quality/tc_parameter_checking.rb +390 -390
  110. data/test/unit/string_utilities/tc_truncate.rb +28 -28
  111. data/test/unit/tc_version.rb +15 -15
  112. metadata +6 -2
data/test/unit/conversion/tc_integer_parser.rb CHANGED
@@ -1,4 +1,4 @@
1
- #!/usr/bin/env ruby
1
+ #! /usr/bin/env ruby
2
2
 
3
3
  $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
4
4
 
@@ -10,101 +10,101 @@ require 'test/unit'
10
10
 
11
11
  class Test_IntegerParser < Test::Unit::TestCase
12
12
 
13
- IP = ::Xqsr3::Conversion::IntegerParser
13
+ IP = ::Xqsr3::Conversion::IntegerParser
14
14
 
15
- class SomeRandomException < Exception; end
15
+ class SomeRandomException < Exception; end
16
16
 
17
- def test_show_base_being_ignored
17
+ def test_show_base_being_ignored
18
18
 
19
- assert_equal -100, IP.to_integer(-100)
20
- assert_equal -100, IP.to_integer(-100, 0)
21
- assert_equal -100, IP.to_integer(-100.0, 0)
22
- assert_equal -100, IP.to_integer(-100.0, 10)
19
+ assert_equal -100, IP.to_integer(-100)
20
+ assert_equal -100, IP.to_integer(-100, 0)
21
+ assert_equal -100, IP.to_integer(-100.0, 0)
22
+ assert_equal -100, IP.to_integer(-100.0, 10)
23
23
 
24
- assert_equal -100, IP.to_integer('-100')
25
- assert_equal -100, IP.to_integer('-100', 0)
26
- assert_equal -100, IP.to_integer('-100', 10)
27
- assert_equal -4, IP.to_integer('-100', 2)
28
- end
24
+ assert_equal -100, IP.to_integer('-100')
25
+ assert_equal -100, IP.to_integer('-100', 0)
26
+ assert_equal -100, IP.to_integer('-100', 10)
27
+ assert_equal -4, IP.to_integer('-100', 2)
28
+ end
29
29
 
30
- def test_default_for_invalid_type
30
+ def test_default_for_invalid_type
31
31
 
32
- assert_equal 12345, IP.to_integer(12..345, default: 12345)
33
- end
32
+ assert_equal 12345, IP.to_integer(12..345, default: 12345)
33
+ end
34
34
 
35
- def test_to_integer_with_valid_values
35
+ def test_to_integer_with_valid_values
36
36
 
37
- assert_equal 0, IP.to_integer(0)
38
- assert_equal +1, IP.to_integer(1)
39
- assert_equal +1, IP.to_integer(+1)
40
- assert_equal -1, IP.to_integer(-1)
37
+ assert_equal 0, IP.to_integer(0)
38
+ assert_equal +1, IP.to_integer(1)
39
+ assert_equal +1, IP.to_integer(+1)
40
+ assert_equal -1, IP.to_integer(-1)
41
41
 
42
- assert_equal 0, IP.to_integer('0')
43
- assert_equal +1, IP.to_integer('1')
44
- assert_equal +1, IP.to_integer('+1')
45
- assert_equal -1, IP.to_integer('-1')
46
- end
42
+ assert_equal 0, IP.to_integer('0')
43
+ assert_equal +1, IP.to_integer('1')
44
+ assert_equal +1, IP.to_integer('+1')
45
+ assert_equal -1, IP.to_integer('-1')
46
+ end
47
47
 
48
- def test_to_integer_with_invalid_values
48
+ def test_to_integer_with_invalid_values
49
49
 
50
- assert_raise(TypeError) { IP.to_integer nil }
51
- assert_raise(ArgumentError) { IP.to_integer '' }
52
- assert_raise(ArgumentError) { IP.to_integer 'abc' }
53
- assert_raise(ArgumentError) { IP.to_integer 'zero' }
54
- assert_raise(ArgumentError) { IP.to_integer 'plus 1' }
55
- assert_raise(ArgumentError) { IP.to_integer '/0' }
56
- end
50
+ assert_raise(TypeError) { IP.to_integer nil }
51
+ assert_raise(ArgumentError) { IP.to_integer '' }
52
+ assert_raise(ArgumentError) { IP.to_integer 'abc' }
53
+ assert_raise(ArgumentError) { IP.to_integer 'zero' }
54
+ assert_raise(ArgumentError) { IP.to_integer 'plus 1' }
55
+ assert_raise(ArgumentError) { IP.to_integer '/0' }
56
+ end
57
57
 
58
- def test_to_integer_with_invalid_values_returning_nil
58
+ def test_to_integer_with_invalid_values_returning_nil
59
59
 
60
- assert_nil IP.to_integer(nil, nil: true)
61
- assert_nil IP.to_integer('', nil: true)
62
- assert_nil IP.to_integer('abc', nil: true)
63
- assert_nil IP.to_integer('zero', nil: true)
64
- assert_nil IP.to_integer('plus 1', nil: true)
65
- assert_nil IP.to_integer('/0', nil: true)
66
- end
60
+ assert_nil IP.to_integer(nil, nil: true)
61
+ assert_nil IP.to_integer('', nil: true)
62
+ assert_nil IP.to_integer('abc', nil: true)
63
+ assert_nil IP.to_integer('zero', nil: true)
64
+ assert_nil IP.to_integer('plus 1', nil: true)
65
+ assert_nil IP.to_integer('/0', nil: true)
66
+ end
67
67
 
68
- def test_to_integer_with_invalid_values_returning_0
68
+ def test_to_integer_with_invalid_values_returning_0
69
69
 
70
- assert_equal 0, IP.to_integer(nil, default: 0)
71
- assert_equal 0, IP.to_integer('', default: 0)
72
- assert_equal 0, IP.to_integer('abc', default: 0)
73
- assert_equal 0, IP.to_integer('zero', default: 0)
74
- assert_equal 0, IP.to_integer('plus 1', default: 0)
75
- assert_equal 0, IP.to_integer('/0', default: 0)
76
- end
70
+ assert_equal 0, IP.to_integer(nil, default: 0)
71
+ assert_equal 0, IP.to_integer('', default: 0)
72
+ assert_equal 0, IP.to_integer('abc', default: 0)
73
+ assert_equal 0, IP.to_integer('zero', default: 0)
74
+ assert_equal 0, IP.to_integer('plus 1', default: 0)
75
+ assert_equal 0, IP.to_integer('/0', default: 0)
76
+ end
77
77
 
78
- def test_to_integer_with_invalid_values_returning_sentinel
78
+ def test_to_integer_with_invalid_values_returning_sentinel
79
79
 
80
- assert_equal :sentinel, IP.to_integer(nil, default: :sentinel)
81
- assert_equal :sentinel, IP.to_integer('', default: :sentinel)
82
- assert_equal :sentinel, IP.to_integer('abc', default: :sentinel)
83
- assert_equal :sentinel, IP.to_integer('zero', default: :sentinel)
84
- assert_equal :sentinel, IP.to_integer('plus 1', default: :sentinel)
85
- assert_equal :sentinel, IP.to_integer('/0', default: :sentinel)
86
- end
80
+ assert_equal :sentinel, IP.to_integer(nil, default: :sentinel)
81
+ assert_equal :sentinel, IP.to_integer('', default: :sentinel)
82
+ assert_equal :sentinel, IP.to_integer('abc', default: :sentinel)
83
+ assert_equal :sentinel, IP.to_integer('zero', default: :sentinel)
84
+ assert_equal :sentinel, IP.to_integer('plus 1', default: :sentinel)
85
+ assert_equal :sentinel, IP.to_integer('/0', default: :sentinel)
86
+ end
87
87
 
88
- def test_to_integer_with_invalid_values_returning_sentinel_of_nil
88
+ def test_to_integer_with_invalid_values_returning_sentinel_of_nil
89
89
 
90
- assert_equal nil, IP.to_integer(nil, default: nil)
91
- assert_equal nil, IP.to_integer('', default: nil)
92
- assert_equal nil, IP.to_integer('abc', default: nil)
93
- assert_equal nil, IP.to_integer('zero', default: nil)
94
- assert_equal nil, IP.to_integer('plus 1', default: nil)
95
- assert_equal nil, IP.to_integer('/0', default: nil)
96
- end
90
+ assert_equal nil, IP.to_integer(nil, default: nil)
91
+ assert_equal nil, IP.to_integer('', default: nil)
92
+ assert_equal nil, IP.to_integer('abc', default: nil)
93
+ assert_equal nil, IP.to_integer('zero', default: nil)
94
+ assert_equal nil, IP.to_integer('plus 1', default: nil)
95
+ assert_equal nil, IP.to_integer('/0', default: nil)
96
+ end
97
97
 
98
- def test_to_integer_with_invalid_values_and_block
98
+ def test_to_integer_with_invalid_values_and_block
99
99
 
100
- assert_equal nil, IP.to_integer(nil) { nil }
101
- assert_equal nil, IP.to_integer('blah') { nil }
100
+ assert_equal nil, IP.to_integer(nil) { nil }
101
+ assert_equal nil, IP.to_integer('blah') { nil }
102
102
 
103
- assert_equal 'one', IP.to_integer(nil) { 'one' }
104
- assert_equal 'one', IP.to_integer('blah') { 'one' }
103
+ assert_equal 'one', IP.to_integer(nil) { 'one' }
104
+ assert_equal 'one', IP.to_integer('blah') { 'one' }
105
105
 
106
- assert_raise(SomeRandomException) { IP.to_integer(nil) { raise SomeRandomException.new } }
107
- end
106
+ assert_raise(SomeRandomException) { IP.to_integer(nil) { raise SomeRandomException.new } }
107
+ end
108
108
  end
109
109
 
110
110
 
data/test/unit/conversion/tc_to_bool.rb CHANGED
@@ -1,4 +1,4 @@
1
- #!/usr/bin/env ruby
1
+ #! /usr/bin/env ruby
2
2
 
3
3
  $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
4
4
 
@@ -9,38 +9,38 @@ require 'test/unit'
9
9
 
10
10
  class Test_Xqsr3_ConversionMultiMap < Test::Unit::TestCase
11
11
 
12
- include ::Xqsr3::Conversion
12
+ include ::Xqsr3::Conversion
13
13
 
14
- def test_parse_normal
14
+ def test_parse_normal
15
15
 
16
- assert_true BoolParser.to_bool 'true'
17
- assert_false BoolParser.to_bool 'false'
18
- end
16
+ assert_true BoolParser.to_bool 'true'
17
+ assert_false BoolParser.to_bool 'false'
18
+ end
19
19
 
20
- def test_parse_custom_true_false
20
+ def test_parse_custom_true_false
21
21
 
22
- true_values = [ 'affirmative', 'yup' ]
23
- false_values = [ 'negative', 'nope' ]
22
+ true_values = [ 'affirmative', 'yup' ]
23
+ false_values = [ 'negative', 'nope' ]
24
24
 
25
- assert_true BoolParser.to_bool 'affirmative', true_values: true_values, false_values: false_values
26
- assert_true BoolParser.to_bool 'yup', true_values: true_values, false_values: false_values
27
- assert_nil BoolParser.to_bool 'true', true_values: true_values, false_values: false_values
28
- assert_false BoolParser.to_bool 'negative', true_values: true_values, false_values: false_values
29
- assert_false BoolParser.to_bool 'nope', true_values: true_values, false_values: false_values
30
- assert_nil BoolParser.to_bool 'false', true_values: true_values, false_values: false_values
31
- end
25
+ assert_true BoolParser.to_bool 'affirmative', true_values: true_values, false_values: false_values
26
+ assert_true BoolParser.to_bool 'yup', true_values: true_values, false_values: false_values
27
+ assert_nil BoolParser.to_bool 'true', true_values: true_values, false_values: false_values
28
+ assert_false BoolParser.to_bool 'negative', true_values: true_values, false_values: false_values
29
+ assert_false BoolParser.to_bool 'nope', true_values: true_values, false_values: false_values
30
+ assert_nil BoolParser.to_bool 'false', true_values: true_values, false_values: false_values
31
+ end
32
32
 
33
- def test_parse_custom_true_false_regexes
33
+ def test_parse_custom_true_false_regexes
34
34
 
35
- true_values = [ /affirm/, /yup/ ]
36
- false_values = [ 'negative', /no/ ]
35
+ true_values = [ /affirm/, /yup/ ]
36
+ false_values = [ 'negative', /no/ ]
37
37
 
38
- assert_true BoolParser.to_bool 'affirmative', true_values: true_values, false_values: false_values
39
- assert_true BoolParser.to_bool 'yup', true_values: true_values, false_values: false_values
40
- assert_nil BoolParser.to_bool 'true', true_values: true_values, false_values: false_values
41
- assert_false BoolParser.to_bool 'negative', true_values: true_values, false_values: false_values
42
- assert_false BoolParser.to_bool 'nope', true_values: true_values, false_values: false_values
43
- assert_nil BoolParser.to_bool 'false', true_values: true_values, false_values: false_values
44
- end
38
+ assert_true BoolParser.to_bool 'affirmative', true_values: true_values, false_values: false_values
39
+ assert_true BoolParser.to_bool 'yup', true_values: true_values, false_values: false_values
40
+ assert_nil BoolParser.to_bool 'true', true_values: true_values, false_values: false_values
41
+ assert_false BoolParser.to_bool 'negative', true_values: true_values, false_values: false_values
42
+ assert_false BoolParser.to_bool 'nope', true_values: true_values, false_values: false_values
43
+ assert_nil BoolParser.to_bool 'false', true_values: true_values, false_values: false_values
44
+ end
45
45
  end
46
46