/
assertions.rb
2219 lines (2041 loc) · 72.9 KB
/
assertions.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Author:: Nathaniel Talbott.
# Copyright:: Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
# Copyright (c) 2009-2013 Kouhei Sutou. All rights reserved.
# License:: Ruby license.
require 'test/unit/assertion-failed-error'
require 'test/unit/util/backtracefilter'
require 'test/unit/util/method-owner-finder'
require 'test/unit/diff'
begin
require 'power_assert'
rescue LoadError, SyntaxError
end
module Test
module Unit
##
# Test::Unit::Assertions contains the standard Test::Unit assertions.
# Assertions is included in Test::Unit::TestCase.
#
# To include it in your own code and use its functionality, you simply
# need to rescue Test::Unit::AssertionFailedError. Additionally you may
# override add_assertion to get notified whenever an assertion is made.
#
# Notes:
#
# * The message to each assertion, if given, will be propagated with the
# failure.
# * It is easy to add your own assertions based on assert_block().
#
# @example Example Custom Assertion
#
# def deny(boolean, message = nil)
# message = build_message message, '<?> is not false or nil.', boolean
# assert_block message do
# not boolean
# end
# end
module Assertions
##
# The assertion upon which all other assertions are based. Passes if the
# block yields true.
#
# @example
# assert_block "Couldn't do the thing" do
# do_the_thing
# end
def assert_block(message="assert_block failed.")
_wrap_assertion do
if (! yield)
raise AssertionFailedError.new(message.to_s)
end
end
end
# @private
NOT_SPECIFIED = Object.new
# @overload assert(object, message=nil)
#
# Asserts that `object` is not false nor nil.
#
# Normally, you don't need to use this assertion. Use more
# specific assertions such as #assert_equal and
# #assert_include.
#
# @example Pass patterns
# assert(true) # => pass
# assert([1, 2].include?(1)) # => pass
#
# @example Failure patterns
# assert(nil) # => failure
# assert(false) # => failure
# assert([1, 2].include?(5)) # => failure
#
# @param [Object] object The check target.
# @param [String] message The additional user message. It is
# showed when the assertion is failed.
# @return [void]
#
# @overload assert(message=nil) {}
#
# Asserts that the givens block returns not false nor nil.
#
# This style uses Power Assert. It means that you can see each
# object values in method chains on failure. See the following
# example about Power Assert.
#
# @example Power Assert
# coins = [1, 5, 50]
# target_coin = 10
# assert do
# coins.include?(target_coin)
# end
# # =>
# # coins.include?(target_coin)
# # | | |
# # | | 10
# # | false
# # [1, 5, 50]
#
# We recommend you to use Power Assert for predicate method
# checks rather than existing assertions such as
# #assert_include and #assert_predicate. Power Assert shows
# useful message for debugging.
#
# We don't recommend you use Power Assert for equality
# check. You should use #assert_equal for the case. Because
# #assert_equal shows more useful message for debugging.
#
# @example Pass patterns
# assert {true} # => pass
# assert {[1, 2].include?(1)} # => pass
#
# @example Failure patterns
# assert {nil} # => failure
# assert {false} # => failure
# assert {[1, 2].include?(5)} # => failure
#
# @param [String] message The additional user message. It is
# showed when the assertion is failed.
# @yield [] Given no parameters to the block.
# @yieldreturn [Object] The checked object.
# @return [void]
def assert(object=NOT_SPECIFIED, message=nil, &block)
_wrap_assertion do
have_object = !NOT_SPECIFIED.equal?(object)
if block
message = object if have_object
if defined?(PowerAssert)
PowerAssert.start(block, :assertion_method => __callee__) do |pa|
pa_message = AssertionMessage.delayed_literal(&pa.message_proc)
assertion_message = build_message(message, "?", pa_message)
assert_block(assertion_message) do
pa.yield
end
end
else
assert(yield, message)
end
else
unless have_object
raise ArgumentError, "wrong number of arguments (0 for 1..2)"
end
assertion_message = nil
case message
when nil, String, Proc
when AssertionMessage
assertion_message = message
else
error_message = "assertion message must be String, Proc or "
error_message << "#{AssertionMessage}: "
error_message << "<#{message.inspect}>(<#{message.class}>)"
raise ArgumentError, error_message, filter_backtrace(caller)
end
assertion_message ||= build_message(message,
"<?> is not true.",
object)
assert_block(assertion_message) do
object
end
end
end
end
# Asserts that +object+ is false or nil.
#
# @note Just for minitest compatibility. :<
#
# @param [Object] object The object to be asserted.
# @return [void]
#
# @example Pass patterns
# refute(false) # => pass
# refute(nil) # => pass
#
# @example Failure patterns
# refute(true) # => failure
# refute("string") # => failure
#
# @since 2.5.3
def refute(object, message=nil)
_wrap_assertion do
assertion_message = nil
case message
when nil, String, Proc
when AssertionMessage
assertion_message = message
else
error_message = "assertion message must be String, Proc or "
error_message << "#{AssertionMessage}: "
error_message << "<#{message.inspect}>(<#{message.class}>)"
raise ArgumentError, error_message, filter_backtrace(caller)
end
assert_block("refute should not be called with a block.") do
!block_given?
end
assertion_message ||= build_message(message,
"<?> is neither nil or false.",
object)
assert_block(assertion_message) do
not object
end
end
end
##
# Passes if +expected+ == +actual+.
#
# Note that the ordering of arguments is important, since a helpful
# error message is generated when this one fails that tells you the
# values of expected and actual.
#
# @example
# assert_equal 'MY STRING', 'my string'.upcase
def assert_equal(expected, actual, message=nil)
diff = AssertionMessage.delayed_diff(expected, actual)
if expected.respond_to?(:encoding) and
actual.respond_to?(:encoding) and
expected.encoding != actual.encoding
format = <<EOT
<?>(?) expected but was
<?>(?).?
EOT
full_message = build_message(message, format,
expected, expected.encoding.name,
actual, actual.encoding.name,
diff)
else
full_message = build_message(message, <<EOT, expected, actual, diff)
<?> expected but was
<?>.?
EOT
end
begin
assert_block(full_message) { expected == actual }
rescue AssertionFailedError => failure
_set_failed_information(failure, expected, actual, message)
raise failure # For JRuby. :<
end
end
##
# Passes if the block raises one of the expected
# exceptions. When an expected exception is an Exception
# object, passes if expected_exception == actual_exception.
#
# @example
# assert_raise(RuntimeError, LoadError) do
# raise 'Boom!!!'
# end # -> pass
#
# assert_raise do
# raise Exception, 'Any exception should be raised!!!'
# end # -> pass
#
# assert_raise(RuntimeError.new("XXX")) {raise "XXX"} # -> pass
# assert_raise(MyError.new("XXX")) {raise "XXX"} # -> fail
# assert_raise(RuntimeError.new("ZZZ")) {raise "XXX"} # -> fail
def assert_raise(*args, &block)
assert_expected_exception = Proc.new do |*_args|
message, assert_exception_helper, actual_exception = _args
expected = assert_exception_helper.expected_exceptions
diff = AssertionMessage.delayed_diff(expected, actual_exception)
full_message = build_message(message,
"<?> exception expected but was\n<?>.?",
expected, actual_exception, diff)
begin
assert_block(full_message) do
expected == [] or
assert_exception_helper.expected?(actual_exception)
end
rescue AssertionFailedError => failure
_set_failed_information(failure, expected, actual_exception,
message)
raise failure # For JRuby. :<
end
end
_assert_raise(assert_expected_exception, *args, &block)
end
# Just for minitest compatibility. :<
alias_method :assert_raises, :assert_raise
##
# Passes if the block raises one of the given
# exceptions or sub exceptions of the given exceptions.
#
# @example
# assert_raise_kind_of(SystemCallError) do
# raise Errno::EACCES
# end
def assert_raise_kind_of(*args, &block)
assert_expected_exception = Proc.new do |*_args|
message, assert_exception_helper, actual_exception = _args
expected = assert_exception_helper.expected_exceptions
full_message = build_message(message,
"<?> family exception expected " +
"but was\n<?>.",
expected, actual_exception)
assert_block(full_message) do
assert_exception_helper.expected?(actual_exception, :kind_of?)
end
end
_assert_raise(assert_expected_exception, *args, &block)
end
##
# Passes if +object+.instance_of?(+klass+). When +klass+ is
# an array of classes, it passes if any class
# satisfies +object.instance_of?(class).
#
# @example
# assert_instance_of(String, 'foo') # -> pass
# assert_instance_of([Fixnum, NilClass], 100) # -> pass
# assert_instance_of([Numeric, NilClass], 100) # -> fail
def assert_instance_of(klass, object, message="")
_wrap_assertion do
if klass.is_a?(Array)
klasses = klass
else
klasses = [klass]
end
assert_block("The first parameter to assert_instance_of should be " +
"a Class or an Array of Class.") do
klasses.all? {|k| k.is_a?(Class)}
end
klass_message = AssertionMessage.maybe_container(klass) do |value|
"<#{value}>"
end
full_message = build_message(message, <<EOT, object, klass_message, object.class)
<?> expected to be instance_of\\?
? but was
<?>.
EOT
assert_block(full_message) do
klasses.any? {|k| object.instance_of?(k)}
end
end
end
##
# Passes if +object+.instance_of?(+klass+) does not hold.
# When +klass+ is an array of classes, it passes if no class
# satisfies +object.instance_of?(class).
#
# @example
# assert_not_instance_of(String, 100) # -> pass
# assert_not_instance_of([Fixnum, NilClass], '100') # -> pass
# assert_not_instance_of([Numeric, NilClass], 100) # -> fail
#
# @since 3.0.0
def assert_not_instance_of(klass, object, message="")
_wrap_assertion do
if klass.is_a?(Array)
klasses = klass
else
klasses = [klass]
end
assert_block("The first parameter to assert_not_instance_of should be " <<
"a Class or an Array of Class.") do
klasses.all? {|k| k.is_a?(Class)}
end
klass_message = AssertionMessage.maybe_container(klass) do |value|
"<#{value}>"
end
full_message = build_message(message,
"<?> expected to not be instance_of\\?\n" +
"? but was.",
object,
klass_message)
assert_block(full_message) do
klasses.none? {|k| object.instance_of?(k)}
end
end
end
# Just for minitest compatibility. :<
#
# @since 3.0.0
alias_method :refute_instance_of, :assert_not_instance_of
##
# Passes if +object+ is nil.
#
# @example
# assert_nil [1, 2].uniq!
def assert_nil(object, message="")
full_message = build_message(message, <<EOT, object)
<?> expected to be nil.
EOT
assert_block(full_message) { object.nil? }
end
##
# Passes if +object+.kind_of?(+klass+). When +klass+ is
# an array of classes or modules, it passes if any
# class or module satisfies +object.kind_of?(class_or_module).
#
# @example
# assert_kind_of(Object, 'foo') # -> pass
# assert_kind_of([Fixnum, NilClass], 100) # -> pass
# assert_kind_of([Fixnum, NilClass], "string") # -> fail
def assert_kind_of(klass, object, message="")
_wrap_assertion do
if klass.is_a?(Array)
klasses = klass
else
klasses = [klass]
end
assert_block("The first parameter to assert_kind_of should be " +
"a kind_of Module or an Array of a kind_of Module.") do
klasses.all? {|k| k.kind_of?(Module)}
end
klass_message = AssertionMessage.maybe_container(klass) do |value|
"<#{value}>"
end
full_message = build_message(message,
"<?> expected to be kind_of\\?\n" +
"? but was\n" +
"<?>.",
object,
klass_message,
object.class)
assert_block(full_message) do
klasses.any? {|k| object.kind_of?(k)}
end
end
end
##
# Passes if +object+.kind_of?(+klass+) does not hold.
# When +klass+ is an array of classes or modules, it passes only if all
# classes (and modules) do not satisfy +object.kind_of?(class_or_module).
#
# @example
# assert_not_kind_of(Fixnum, 'foo') # -> pass
# assert_not_kind_of([Fixnum, NilClass], '0') # -> pass
# assert_not_kind_of([Fixnum, NilClass], 100) # -> fail
#
# @since 3.0.0
def assert_not_kind_of(klass, object, message="")
_wrap_assertion do
if klass.is_a?(Array)
klasses = klass
else
klasses = [klass]
end
assert_block("The first parameter to assert_not_kind_of should be " +
"a kind_of Module or an Array of a kind_of Module.") do
klasses.all? {|k| k.kind_of?(Module)}
end
klass_message = AssertionMessage.maybe_container(klass) do |value|
"<#{value}>"
end
full_message = build_message(message,
"<?> expected to not be kind_of\\?\n" +
"? but was.",
object,
klass_message)
assert_block(full_message) do
klasses.none? {|k| object.kind_of?(k)}
end
end
end
# Just for minitest compatibility. :<
#
# @since 3.0.0
alias_method :refute_kind_of, :assert_not_kind_of
##
# Passes if +object+ .respond_to? +method+
#
# @example
# assert_respond_to 'bugbear', :slice
def assert_respond_to(object, method, message="")
_wrap_assertion do
full_message = build_message(message,
"<?>.kind_of\\?(Symbol) or\n" +
"<?>.respond_to\\?(:to_str) expected",
method, method)
assert_block(full_message) do
method.kind_of?(Symbol) or method.respond_to?(:to_str)
end
full_message = build_message(message,
"<?>.respond_to\\?(?) expected\n" +
"(Class: <?>)",
object, method, object.class)
assert_block(full_message) {object.respond_to?(method)}
end
end
##
# Passes if +object+ does not .respond_to? +method+.
#
# @example
# assert_not_respond_to('bugbear', :nonexistence) # -> pass
# assert_not_respond_to('bugbear', :size) # -> fail
def assert_not_respond_to(object, method, message="")
_wrap_assertion do
full_message = build_message(message,
"<?>.kind_of\\?(Symbol) or\n" +
"<?>.respond_to\\?(:to_str) expected",
method, method)
assert_block(full_message) do
method.kind_of?(Symbol) or method.respond_to?(:to_str)
end
full_message = build_message(message,
"!<?>.respond_to\\?(?) expected\n" +
"(Class: <?>)",
object, method, object.class)
assert_block(full_message) {!object.respond_to?(method)}
end
end
# Just for minitest compatibility. :<
#
# @since 2.5.3
alias_method :refute_respond_to, :assert_not_respond_to
##
# Passes if +pattern+ =~ +string+.
#
# @example
# assert_match(/\d+/, 'five, 6, seven')
def assert_match(pattern, string, message="")
_wrap_assertion do
pattern = case(pattern)
when String
Regexp.new(Regexp.escape(pattern))
else
pattern
end
full_message = build_message(message, "<?> expected to be =~\n<?>.",
pattern, string)
assert_block(full_message) { pattern =~ string }
end
end
##
# Passes if +actual+ .equal? +expected+ (i.e. they are the same
# instance).
#
# @example
# o = Object.new
# assert_same o, o
def assert_same(expected, actual, message="")
full_message = build_message(message, <<EOT, expected, expected.__id__, actual, actual.__id__)
<?>
with id <?> expected to be equal\\? to
<?>
with id <?>.
EOT
assert_block(full_message) { actual.equal?(expected) }
end
##
# Compares the +object1+ with +object2+ using +operator+.
#
# Passes if object1.__send__(operator, object2) is true.
#
# @example
# assert_operator 5, :>=, 4
def assert_operator(object1, operator, object2, message="")
_wrap_assertion do
full_message = build_message(nil, "<?>\ngiven as the operator for #assert_operator must be a Symbol or #respond_to\\?(:to_str).", operator)
assert_block(full_message){operator.kind_of?(Symbol) || operator.respond_to?(:to_str)}
full_message = build_message(message, <<EOT, object1, AssertionMessage.literal(operator), object2)
<?> expected to be
?
<?>.
EOT
assert_block(full_message) { object1.__send__(operator, object2) }
end
end
##
# Compares the +object1+ with +object2+ using +operator+.
#
# Passes if object1.__send__(operator, object2) is not true.
#
# @example
# assert_not_operator(5, :<, 4) # => pass
# assert_not_operator(5, :>, 4) # => fail
#
# @since 3.0.0
def assert_not_operator(object1, operator, object2, message="")
_wrap_assertion do
full_message = build_message(nil, "<?>\ngiven as the operator for #assert_not_operator must be a Symbol or #respond_to\\?(:to_str).", operator)
assert_block(full_message){operator.kind_of?(Symbol) || operator.respond_to?(:to_str)}
full_message = build_message(message, <<EOT, object1, AssertionMessage.literal(operator), object2)
<?> expected to not be
?
<?>.
EOT
assert_block(full_message) { ! object1.__send__(operator, object2) }
end
end
# Just for minitest compatibility. :<
#
# @since 3.0.0
alias_method :refute_operator, :assert_not_operator
##
# Passes if block does not raise an exception.
#
# @example
# assert_nothing_raised do
# [1, 2].uniq
# end
def assert_nothing_raised(*args)
_wrap_assertion do
if args.last.is_a?(String)
message = args.pop
else
message = ""
end
assert_exception_helper = AssertExceptionHelper.new(self, args)
begin
yield
rescue Exception => e
if ((args.empty? && !e.instance_of?(AssertionFailedError)) ||
assert_exception_helper.expected?(e))
failure_message = build_message(message, "Exception raised:\n?", e)
assert_block(failure_message) {false}
else
raise
end
end
nil
end
end
##
# Flunk always fails.
#
# @example
# flunk 'Not done testing yet.'
def flunk(message="Flunked")
assert_block(build_message(message)){false}
end
##
# Passes if ! +actual+ .equal? +expected+
#
# @example
# assert_not_same Object.new, Object.new
def assert_not_same(expected, actual, message="")
full_message = build_message(message, <<EOT, expected, expected.__id__, actual, actual.__id__)
<?>
with id <?> expected to not be equal\\? to
<?>
with id <?>.
EOT
assert_block(full_message) { !actual.equal?(expected) }
end
# Just for minitest compatibility. :<
#
# @since 2.5.3
alias_method :refute_same, :assert_not_same
##
# Passes if +expected+ != +actual+
#
# @example
# assert_not_equal 'some string', 5
def assert_not_equal(expected, actual, message="")
full_message = build_message(message, "<?> expected to be != to\n<?>.", expected, actual)
assert_block(full_message) { expected != actual }
end
# Just for minitest compatibility. :<
#
# @since 2.5.3
alias_method :refute_equal, :assert_not_equal
##
# Passes if ! +object+ .nil?
#
# @example
# assert_not_nil '1 two 3'.sub!(/two/, '2')
def assert_not_nil(object, message="")
full_message = build_message(message, "<?> expected to not be nil.", object)
assert_block(full_message){!object.nil?}
end
# Just for minitest compatibility. :<
#
# @since 2.5.3
alias_method :refute_nil, :assert_not_nil
##
# Passes if +regexp+ !~ +string+
#
# @example
# assert_not_match(/two/, 'one 2 three') # -> pass
# assert_not_match(/three/, 'one 2 three') # -> fail
def assert_not_match(regexp, string, message="")
_wrap_assertion do
assert_instance_of(Regexp, regexp,
"<REGEXP> in assert_not_match(<REGEXP>, ...) " +
"should be a Regexp.")
full_message = build_message(message,
"<?> expected to not match\n<?>.",
regexp, string)
assert_block(full_message) { regexp !~ string }
end
end
# Just for minitest compatibility. :<
#
# @since 2.5.3
alias_method :refute_match, :assert_not_match
##
# Deprecated. Use #assert_not_match instead.
#
# Passes if +regexp+ !~ +string+
#
# @example
# assert_no_match(/two/, 'one 2 three') # -> pass
# assert_no_match(/three/, 'one 2 three') # -> fail
def assert_no_match(regexp, string, message="")
_wrap_assertion do
assert_instance_of(Regexp, regexp,
"The first argument to assert_no_match " +
"should be a Regexp.")
assert_not_match(regexp, string, message)
end
end
# @private
class ThrowTagExtractor
@@have_uncaught_throw_error = const_defined?(:UncaughtThrowError)
UncaughtThrowPatterns = {
NameError => /^uncaught throw `(.+)'$/,
ArgumentError => /^uncaught throw (`.+'|.+)$/,
ThreadError => /^uncaught throw `(.+)' in thread /,
}
def initialize(error)
@error = error
end
def extract_tag
tag = nil
if @@have_uncaught_throw_error
return nil unless @error.is_a?(UncaughtThrowError)
tag = @error.tag
else
pattern = UncaughtThrowPatterns[@error.class]
return nil if pattern.nil?
return nil unless pattern =~ @error.message
tag = $1
end
normalize_tag(tag)
end
private
def normalize_tag(tag)
case tag
when /\A:/
tag[1..-1].intern
when /\A`(.+)'\z/
$1.intern
when String
tag.intern
else
tag
end
end
end
##
# Passes if the block throws +expected_object+
#
# @example
# assert_throw(:done) do
# throw(:done)
# end
def assert_throw(expected_object, message="", &proc)
_wrap_assertion do
begin
catch([]) {}
rescue TypeError
assert_instance_of(Symbol, expected_object,
"assert_throws expects the symbol that should be thrown for its first argument")
end
assert_block("Should have passed a block to assert_throw.") do
block_given?
end
caught = true
begin
catch(expected_object) do
proc.call
caught = false
end
full_message = build_message(message,
"<?> should have been thrown.",
expected_object)
assert_block(full_message) {caught}
rescue => error
extractor = ThrowTagExtractor.new(error)
tag = extractor.extract_tag
raise if tag.nil?
full_message = build_message(message,
"<?> expected to be thrown but\n" +
"<?> was thrown.",
expected_object, tag)
flunk(full_message)
end
end
end
# Just for minitest compatibility. :<
#
# @since 2.5.3
alias_method :assert_throws, :assert_throw
##
# Passes if block does not throw anything.
#
# @example
# assert_nothing_thrown do
# [1, 2].uniq
# end
def assert_nothing_thrown(message="", &proc)
_wrap_assertion do
assert(block_given?, "Should have passed a block to assert_nothing_thrown")
begin
proc.call
rescue => error
extractor = ThrowTagExtractor.new(error)
tag = extractor.extract_tag
raise if tag.nil?
full_message = build_message(message,
"<?> was thrown when nothing was expected",
tag)
flunk(full_message)
end
assert(true, "Expected nothing to be thrown")
end
end
##
# Passes if +expected_float+ and +actual_float+ are equal
# within +delta+ tolerance.
#
# @example
# assert_in_delta 0.05, (50000.0 / 10**6), 0.00001
def assert_in_delta(expected_float, actual_float, delta=0.001, message="")
_wrap_assertion do
_assert_in_delta_validate_arguments(expected_float,
actual_float,
delta)
full_message = _assert_in_delta_message(expected_float,
actual_float,
delta,
message)
assert_block(full_message) do
(expected_float.to_f - actual_float.to_f).abs <= delta.to_f
end
end
end
##
# Passes if +expected_float+ and +actual_float+ are
# not equal within +delta+ tolerance.
#
# @example
# assert_not_in_delta(0.05, (50000.0 / 10**6), 0.00002) # -> pass
# assert_not_in_delta(0.05, (50000.0 / 10**6), 0.00001) # -> fail
def assert_not_in_delta(expected_float, actual_float, delta=0.001, message="")
_wrap_assertion do
_assert_in_delta_validate_arguments(expected_float,
actual_float,
delta)
full_message = _assert_in_delta_message(expected_float,
actual_float,
delta,
message,
:negative_assertion => true)
assert_block(full_message) do
(expected_float.to_f - actual_float.to_f).abs > delta.to_f
end
end
end
# Just for minitest compatibility. :<
#
# @since 2.5.3
alias_method :refute_in_delta, :assert_not_in_delta
private
def _assert_in_delta_validate_arguments(expected_float,
actual_float,
delta)
{
expected_float => "first float",
actual_float => "second float",
delta => "delta"
}.each do |float, name|
assert_respond_to(float, :to_f,
"The arguments must respond to to_f; " +
"the #{name} did not")
end
delta = delta.to_f
assert_operator(delta, :>=, 0.0, "The delta should not be negative")
end
def _assert_in_delta_message(expected_float, actual_float, delta,
message, options={})
if options[:negative_assertion]
format = <<-EOT
<?> -/+ <?> expected to not include
<?>.
EOT
else
format = <<-EOT
<?> -/+ <?> expected to include
<?>.
EOT
end
arguments = [expected_float, delta, actual_float]
normalized_expected = expected_float.to_f
normalized_actual = actual_float.to_f
normalized_delta = delta.to_f
relation_format = nil
relation_arguments = nil
if normalized_actual < normalized_expected - normalized_delta
relation_format = "<<?> < <?>-<?>[?] <= <?>+<?>[?]>"
relation_arguments = [actual_float,
expected_float, delta,
normalized_expected - normalized_delta,
expected_float, delta,
normalized_expected + normalized_delta]
elsif normalized_actual <= normalized_expected + normalized_delta
relation_format = "<<?>-<?>[?] <= <?> <= <?>+<?>[?]>"
relation_arguments = [expected_float, delta,
normalized_expected - normalized_delta,
actual_float,
expected_float, delta,
normalized_expected + normalized_delta]
else
relation_format = "<<?>-<?>[?] <= <?>+<?>[?] < <?>>"
relation_arguments = [expected_float, delta,
normalized_expected - normalized_delta,
expected_float, delta,
normalized_expected + normalized_delta,
actual_float]
end
if relation_format
format << <<-EOT
Relation:
#{relation_format}
EOT
arguments.concat(relation_arguments)
end
build_message(message, format, *arguments)
end
public
##
# Passes if +expected_float+ and +actual_float+ are equal
# within +epsilon+ relative error of +expected_float+.
#
# @example
# assert_in_epsilon(10000.0, 9900.0, 0.1) # -> pass
# assert_in_epsilon(10000.0, 9899.0, 0.1) # -> fail
def assert_in_epsilon(expected_float, actual_float, epsilon=0.001,
message="")
_wrap_assertion do
_assert_in_epsilon_validate_arguments(expected_float,
actual_float,
epsilon)
full_message = _assert_in_epsilon_message(expected_float,
actual_float,
epsilon,
message)
assert_block(full_message) do
normalized_expected_float = expected_float.to_f
if normalized_expected_float.zero?
delta = epsilon.to_f ** 2
else
delta = normalized_expected_float * epsilon.to_f
end
delta = delta.abs