-
-
Notifications
You must be signed in to change notification settings - Fork 763
/
configuration.rb
2413 lines (2168 loc) · 87 KB
/
configuration.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
RSpec::Support.require_rspec_core "backtrace_formatter"
RSpec::Support.require_rspec_core "ruby_project"
RSpec::Support.require_rspec_core "formatters/deprecation_formatter"
RSpec::Support.require_rspec_core "output_wrapper"
module RSpec
module Core
# rubocop:disable Metrics/ClassLength
# Stores runtime configuration information.
#
# Configuration options are loaded from multiple files and joined together
# with command-line switches and the `SPEC_OPTS` environment variable.
#
# Precedence order (where later entries overwrite earlier entries on
# conflicts):
#
# * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does
# not exist)
# * Project-specific (`./.rspec`)
# * Local (`./.rspec-local`)
# * Command-line options
# * `SPEC_OPTS`
#
# For example, an option set in the local file will override an option set
# in your global file.
#
# The global, project-specific and local files can all be overridden with a
# separate custom file using the --options command-line parameter.
#
# @example Standard settings
# RSpec.configure do |c|
# c.drb = true
# c.drb_port = 1234
# c.default_path = 'behavior'
# end
#
# @example Hooks
# RSpec.configure do |c|
# c.before(:suite) { establish_connection }
# c.before(:example) { log_in_as :authorized }
# c.around(:example) { |ex| Database.transaction(&ex) }
# end
#
# @see RSpec.configure
# @see Hooks
class Configuration
include RSpec::Core::Hooks
# Module that holds `attr_reader` declarations. It's in a separate
# module to allow us to override those methods and use `super`.
# @private
Readers = Module.new
include Readers
# @private
class MustBeConfiguredBeforeExampleGroupsError < StandardError; end
# @private
def self.define_reader(name)
Readers.class_eval do
remove_method name if method_defined?(name)
attr_reader name
end
define_method(name) { value_for(name) { super() } }
end
# @private
def self.define_alias(name, alias_name)
alias_method alias_name, name
alias_method "#{alias_name}=", "#{name}="
define_predicate alias_name
end
# @private
def self.define_predicate(name)
define_method "#{name}?" do
!!send(name)
end
end
# @private
#
# Invoked by the `add_setting` instance method. Use that method on a
# `Configuration` instance rather than this class method.
def self.add_setting(name, opts={})
raise "Use the instance add_setting method if you want to set a default" if opts.key?(:default)
attr_writer name
add_read_only_setting name
Array(opts[:alias_with]).each do |alias_name|
define_alias(name, alias_name)
end
end
# @private
#
# As `add_setting` but only add the reader.
def self.add_read_only_setting(name, opts={})
raise "Use the instance add_setting method if you want to set a default" if opts.key?(:default)
define_reader name
define_predicate name
end
# @macro [attach] add_setting
# @!attribute [rw] $1
#
# @macro [attach] define_reader
# @!attribute [r] $1
# @macro add_setting
# Path to use if no path is provided to the `rspec` command (default:
# `"spec"`). Allows you to just type `rspec` instead of `rspec spec` to
# run all the examples in the `spec` directory.
#
# @note Other scripts invoking `rspec` indirectly will ignore this
# setting.
# @return [String]
add_read_only_setting :default_path
def default_path=(path)
project_source_dirs << path
@default_path = path
end
# @macro add_setting
# Run examples over DRb (default: `false`). RSpec doesn't supply the DRb
# server, but you can use tools like spork.
# @return [Boolean]
add_setting :drb
# @macro add_setting
# The drb_port (default: nil).
add_setting :drb_port
# @macro add_setting
# Default: `$stderr`.
add_setting :error_stream
# Indicates if the DSL has been exposed off of modules and `main`.
# Default: true
# @return [Boolean]
def expose_dsl_globally?
Core::DSL.exposed_globally?
end
# Use this to expose the core RSpec DSL via `Module` and the `main`
# object. It will be set automatically but you can override it to
# remove the DSL.
# Default: true
def expose_dsl_globally=(value)
if value
Core::DSL.expose_globally!
Core::SharedExampleGroup::TopLevelDSL.expose_globally!
else
Core::DSL.remove_globally!
Core::SharedExampleGroup::TopLevelDSL.remove_globally!
end
end
# Determines where deprecation warnings are printed.
# Defaults to `$stderr`.
# @return [IO, String] IO or filename to write to
define_reader :deprecation_stream
# Determines where deprecation warnings are printed.
# @param value [IO, String] IO to write to or filename to write to
def deprecation_stream=(value)
if @reporter && !value.equal?(@deprecation_stream)
warn "RSpec's reporter has already been initialized with " \
"#{deprecation_stream.inspect} as the deprecation stream, so your change to "\
"`deprecation_stream` will be ignored. You should configure it earlier for " \
"it to take effect, or use the `--deprecation-out` CLI option. " \
"(Called from #{CallerFilter.first_non_rspec_line})"
else
@deprecation_stream = value
end
end
# @macro define_reader
# The file path to use for persisting example statuses. Necessary for the
# `--only-failures` and `--next-failure` CLI options.
#
# @overload example_status_persistence_file_path
# @return [String] the file path
# @overload example_status_persistence_file_path=(value)
# @param value [String] the file path
define_reader :example_status_persistence_file_path
# Sets the file path to use for persisting example statuses. Necessary for the
# `--only-failures` and `--next-failure` CLI options.
def example_status_persistence_file_path=(value)
@example_status_persistence_file_path = value
clear_values_derived_from_example_status_persistence_file_path
end
# @macro define_reader
# Indicates if the `--only-failures` (or `--next-failure`) flag is being used.
define_reader :only_failures
alias_method :only_failures?, :only_failures
# @private
def only_failures_but_not_configured?
only_failures? && !example_status_persistence_file_path
end
# @macro define_reader
# If specified, indicates the number of failures required before cleaning
# up and exit (default: `nil`). Can also be `true` to fail and exit on first
# failure
define_reader :fail_fast
# @see fail_fast
def fail_fast=(value)
case value
when true, 'true'
@fail_fast = true
when false, 'false', 0
@fail_fast = false
when nil
@fail_fast = nil
else
@fail_fast = value.to_i
if value.to_i == 0
# TODO: in RSpec 4, consider raising an error here.
RSpec.warning "Cannot set `RSpec.configuration.fail_fast`" \
" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers" \
" are valid values."
@fail_fast = true
end
end
end
# @macro add_setting
# Prints the formatter output of your suite without running any
# examples or hooks.
add_setting :dry_run
# @macro add_setting
# The exit code to return if there are any failures (default: 1).
# @return [Integer]
add_setting :failure_exit_code
# @macro add_setting
# The exit code to return if there are any errors outside examples (default: failure_exit_code)
# @return [Integer]
add_setting :error_exit_code
# @macro add_setting
# Whether or not to fail when there are no RSpec examples (default: false).
# @return [Boolean]
add_setting :fail_if_no_examples
# @macro define_reader
# Indicates files configured to be required.
# @return [Array<String>]
define_reader :requires
# @macro define_reader
# Returns dirs that have been prepended to the load path by the `-I`
# command line option.
# @return [Array<String>]
define_reader :libs
# @macro add_setting
# Determines where RSpec will send its output.
# Default: `$stdout`.
# @return [IO, String]
define_reader :output_stream
# Set the output stream for reporter.
# @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout
def output_stream=(value)
if @reporter && !value.equal?(@output_stream)
warn "RSpec's reporter has already been initialized with " \
"#{output_stream.inspect} as the output stream, so your change to "\
"`output_stream` will be ignored. You should configure it earlier for " \
"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})"
else
@output_stream = value
output_wrapper.output = @output_stream
end
end
# @macro define_reader
# Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).
# @return [String]
define_reader :pattern
# Set pattern to match files to load.
# @attr value [String] the filename pattern to filter spec files by
def pattern=(value)
update_pattern_attr :pattern, value
end
# @macro define_reader
# Exclude files matching this pattern.
# @return [String]
define_reader :exclude_pattern
# Set pattern to match files to exclude.
# @attr value [String] the filename pattern to exclude spec files by
def exclude_pattern=(value)
update_pattern_attr :exclude_pattern, value
end
# @macro add_setting
# Specifies which directories contain the source code for your project.
# When a failure occurs, RSpec looks through the backtrace to find a
# a line of source to print. It first looks for a line coming from
# one of the project source directories so that, for example, it prints
# the expectation or assertion call rather than the source code from
# the expectation or assertion framework.
# @return [Array<String>]
add_setting :project_source_dirs
# @macro add_setting
# Report the times for the slowest examples (default: `false`).
# Use this to specify the number of examples to include in the profile.
# @return [Boolean]
attr_writer :profile_examples
define_predicate :profile_examples
# @macro add_setting
# Run all examples if none match the configured filters
# (default: `false`).
# @deprecated Use {#filter_run_when_matching} instead for the specific
# filters that you want to be ignored if none match.
add_setting :run_all_when_everything_filtered
# @macro add_setting
# Color to use to indicate success. Defaults to `:green` but can be set
# to one of the following: `[:black, :white, :red, :green, :yellow,
# :blue, :magenta, :cyan]`
# @return [Symbol]
add_setting :success_color
# @macro add_setting
# Color to use to print pending examples. Defaults to `:yellow` but can
# be set to one of the following: `[:black, :white, :red, :green,
# :yellow, :blue, :magenta, :cyan]`
# @return [Symbol]
add_setting :pending_color
# @macro add_setting
# Color to use to indicate failure. Defaults to `:red` but can be set to
# one of the following: `[:black, :white, :red, :green, :yellow, :blue,
# :magenta, :cyan]`
# @return [Symbol]
add_setting :failure_color
# @macro add_setting
# The default output color. Defaults to `:white` but can be set to one of
# the following: `[:black, :white, :red, :green, :yellow, :blue,
# :magenta, :cyan]`
# @return [Symbol]
add_setting :default_color
# @macro add_setting
# Color used when a pending example is fixed. Defaults to `:blue` but can
# be set to one of the following: `[:black, :white, :red, :green,
# :yellow, :blue, :magenta, :cyan]`
# @return [Symbol]
add_setting :fixed_color
# @macro add_setting
# Color used to print details. Defaults to `:cyan` but can be set to one
# of the following: `[:black, :white, :red, :green, :yellow, :blue,
# :magenta, :cyan]`
# @return [Symbol]
add_setting :detail_color
# @macro add_setting
# Don't print filter info i.e. "Run options: include {:focus=>true}"
# (default `false`).
# return [Boolean]
add_setting :silence_filter_announcements
# @deprecated This config option was added in RSpec 2 to pave the way
# for this being the default behavior in RSpec 3. Now this option is
# a no-op.
def treat_symbols_as_metadata_keys_with_true_values=(_value)
RSpec.deprecate(
"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=",
:message => "RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= " \
"is deprecated, it is now set to true as default and " \
"setting it to false has no effect."
)
end
# @macro define_reader
# Configures how RSpec treats metadata passed as part of a shared example
# group definition. For example, given this shared example group definition:
#
# RSpec.shared_context "uses DB", :db => true do
# around(:example) do |ex|
# MyORM.transaction(:rollback => true, &ex)
# end
# end
#
# ...there are two ways RSpec can treat the `:db => true` metadata, each
# of which has a corresponding config option:
#
# 1. `:trigger_inclusion`: this shared context will be implicitly included
# in any groups (or examples) that have `:db => true` metadata.
# 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata
# hash of all host groups and examples.
#
# `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should
# be considered deprecated. Instead, you can explicitly include a group with
# `include_context`:
#
# RSpec.describe "My model" do
# include_context "uses DB"
# end
#
# ...or you can configure RSpec to include the context based on matching metadata
# using an API that mirrors configured module inclusion:
#
# RSpec.configure do |rspec|
# rspec.include_context "uses DB", :db => true
# end
#
# `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only
# supported behavior in RSpec 4.
#
# @overload shared_context_metadata_behavior
# @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior
# @overload shared_context_metadata_behavior=(value)
# @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior
define_reader :shared_context_metadata_behavior
# @see shared_context_metadata_behavior
def shared_context_metadata_behavior=(value)
case value
when :trigger_inclusion, :apply_to_host_groups
@shared_context_metadata_behavior = value
else
raise ArgumentError, "Cannot set `RSpec.configuration." \
"shared_context_metadata_behavior` to `#{value.inspect}`. Only " \
"`:trigger_inclusion` and `:apply_to_host_groups` are valid values."
end
end
# Record the start time of the spec suite to measure load time.
# return [Time]
add_setting :start_time
# @macro add_setting
# Use threadsafe options where available.
# Currently this will place a mutex around memoized values such as let blocks.
# return [Boolean]
add_setting :threadsafe
# @macro add_setting
# Maximum count of failed source lines to display in the failure reports
# (defaults to `10`).
# return [Integer]
add_setting :max_displayed_failure_line_count
# @macro full_cause_backtrace
# Display the full backtrace of an exceptions cause (defaults to `false`).
# return [Boolean]
add_setting :full_cause_backtrace
# @macro add_setting
# Format the output for pending examples. Can be set to:
# - :full (default) - pending examples appear similarly to failures
# - :no_backtrace - same as above, but with no backtrace
# - :skip - do not show the section at all
# return [Symbol]
add_read_only_setting :pending_failure_output
def pending_failure_output=(mode)
raise ArgumentError,
"`pending_failure_output` can be set to :full, :no_backtrace, " \
"or :skip" unless [:full, :no_backtrace, :skip].include?(mode)
@pending_failure_output = mode
end
# Determines which bisect runner implementation gets used to run subsets
# of the suite during a bisection. Your choices are:
#
# - `:shell`: Performs a spec run by shelling out, booting RSpec and your
# application environment each time. This runner is the most widely
# compatible runner, but is not as fast. On platforms that do not
# support forking, this is the default.
# - `:fork`: Pre-boots RSpec and your application environment in a parent
# process, and then forks a child process for each spec run. This runner
# tends to be significantly faster than the `:shell` runner but cannot
# be used in some situations. On platforms that support forking, this
# is the default. If you use this runner, you should ensure that all
# of your one-time setup logic goes in a `before(:suite)` hook instead
# of getting run at the top-level of a file loaded by `--require`.
#
# @note This option will only be used by `--bisect` if you set it in a file
# loaded via `--require`.
#
# @return [Symbol]
attr_reader :bisect_runner
def bisect_runner=(value)
if @bisect_runner_class && value != @bisect_runner
raise "`config.bisect_runner = #{value.inspect}` can no longer take " \
"effect as the #{@bisect_runner.inspect} bisect runnner is already " \
"in use. This config setting must be set in a file loaded by a " \
"`--require` option (passed at the CLI or in a `.rspec` file) for " \
"it to have any effect."
end
@bisect_runner = value
end
# @private
# @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}
add_setting :tty
# @private
attr_writer :files_to_run
# @private
attr_accessor :filter_manager, :world
# @private
attr_accessor :static_config_filter_manager
# @private
attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files
# rubocop:disable Metrics/AbcSize
# rubocop:disable Metrics/MethodLength
# Build an object to store runtime configuration options and set defaults
def initialize
# rubocop:disable Style/GlobalVars
@start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now
# rubocop:enable Style/GlobalVars
@expectation_frameworks = []
@include_modules = FilterableItemRepository::QueryOptimized.new(:any?)
@extend_modules = FilterableItemRepository::QueryOptimized.new(:any?)
@prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)
@bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell
@bisect_runner_class = nil
@before_suite_hooks = []
@after_suite_hooks = []
@mock_framework = nil
@files_or_directories_to_run = []
@loaded_spec_files = Set.new
@color = false
@color_mode = :automatic
@pattern = '**{,/*/**}/*_spec.rb'
@exclude_pattern = ''
@failure_exit_code = 1
@error_exit_code = nil # so it can be overridden by failure exit code
@fail_if_no_examples = false
@spec_files_loaded = false
@backtrace_formatter = BacktraceFormatter.new
@default_path = 'spec'
@project_source_dirs = %w[ spec lib app ]
@deprecation_stream = $stderr
@output_stream = $stdout
@reporter = nil
@reporter_buffer = nil
@filter_manager = FilterManager.new
@static_config_filter_manager = FilterManager.new
@ordering_manager = Ordering::ConfigurationManager.new
@preferred_options = {}
@failure_color = :red
@success_color = :green
@pending_color = :yellow
@default_color = :white
@fixed_color = :blue
@detail_color = :cyan
@profile_examples = false
@requires = []
@libs = []
@derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)
@threadsafe = true
@max_displayed_failure_line_count = 10
@full_cause_backtrace = false
@world = World::Null
@shared_context_metadata_behavior = :trigger_inclusion
@pending_failure_output = :full
define_built_in_hooks
end
# rubocop:enable Metrics/AbcSize
# rubocop:enable Metrics/MethodLength
# @private
#
# Used to set higher priority option values from the command line.
def force(hash)
ordering_manager.force(hash)
@preferred_options.merge!(hash)
return unless hash.key?(:example_status_persistence_file_path)
clear_values_derived_from_example_status_persistence_file_path
end
# @private
def reset
@spec_files_loaded = false
reset_reporter
end
# @private
def reset_reporter
@reporter = nil
@formatter_loader = nil
@output_wrapper = nil
end
# @private
def reset_filters
self.filter_manager = FilterManager.new
filter_manager.include_only(
Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)
)
filter_manager.exclude_only(
Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)
)
end
# @overload add_setting(name)
# @overload add_setting(name, opts)
# @option opts [Symbol] :default
#
# Set a default value for the generated getter and predicate methods:
#
# add_setting(:foo, :default => "default value")
#
# @option opts [Symbol] :alias_with
#
# Use `:alias_with` to alias the setter, getter, and predicate to
# another name, or names:
#
# add_setting(:foo, :alias_with => :bar)
# add_setting(:foo, :alias_with => [:bar, :baz])
#
# Adds a custom setting to the RSpec.configuration object.
#
# RSpec.configuration.add_setting :foo
#
# Used internally and by extension frameworks like rspec-rails, so they
# can add config settings that are domain specific. For example:
#
# RSpec.configure do |c|
# c.add_setting :use_transactional_fixtures,
# :default => true,
# :alias_with => :use_transactional_examples
# end
#
# `add_setting` creates three methods on the configuration object, a
# setter, a getter, and a predicate:
#
# RSpec.configuration.foo=(value)
# RSpec.configuration.foo
# RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.
def add_setting(name, opts={})
default = opts.delete(:default)
(class << self; self; end).class_exec do
add_setting(name, opts)
end
__send__("#{name}=", default) if default
end
# Returns the configured mock framework adapter module.
# @return [Symbol]
def mock_framework
if @mock_framework.nil?
begin
mock_with :rspec
rescue LoadError
mock_with :nothing
end
end
@mock_framework
end
# Delegates to mock_framework=(framework).
def mock_framework=(framework)
mock_with framework
end
# Regexps used to exclude lines from backtraces.
#
# Excludes lines from ruby (and jruby) source, installed gems, anything
# in any "bin" directory, and any of the RSpec libs (outside gem
# installs) by default.
#
# You can modify the list via the getter, or replace it with the setter.
#
# To override this behaviour and display a full backtrace, use
# `--backtrace` on the command line, in a `.rspec` file, or in the
# `rspec_options` attribute of RSpec's rake task.
# @return [Array<Regexp>]
def backtrace_exclusion_patterns
@backtrace_formatter.exclusion_patterns
end
# Set regular expressions used to exclude lines in backtrace.
# @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns
def backtrace_exclusion_patterns=(patterns)
@backtrace_formatter.exclusion_patterns = patterns
end
# Regexps used to include lines in backtraces.
#
# Defaults to [Regexp.new Dir.getwd].
#
# Lines that match an exclusion _and_ an inclusion pattern
# will be included.
#
# You can modify the list via the getter, or replace it with the setter.
# @return [Array<Regexp>]
def backtrace_inclusion_patterns
@backtrace_formatter.inclusion_patterns
end
# Set regular expressions used to include lines in backtrace.
# @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns
def backtrace_inclusion_patterns=(patterns)
@backtrace_formatter.inclusion_patterns = patterns
end
# Adds {#backtrace_exclusion_patterns} that will filter lines from
# the named gems from backtraces.
#
# @param gem_names [Array<String>] Names of the gems to filter
#
# @example
# RSpec.configure do |config|
# config.filter_gems_from_backtrace "rack", "rake"
# end
#
# @note The patterns this adds will match the named gems in their common
# locations (e.g. system gems, vendored with bundler, installed as a
# :git dependency with bundler, etc) but is not guaranteed to work for
# all possible gem locations. For example, if you have the gem source
# in a directory with a completely unrelated name, and use bundler's
# :path option, this will not filter it.
def filter_gems_from_backtrace(*gem_names)
gem_names.each do |name|
@backtrace_formatter.filter_gem(name)
end
end
# @private
MOCKING_ADAPTERS = {
:rspec => :RSpec,
:flexmock => :Flexmock,
:rr => :RR,
:mocha => :Mocha,
:nothing => :Null
}
# Sets the mock framework adapter module.
#
# `framework` can be a Symbol or a Module.
#
# Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the
# named framework.
#
# Given `:nothing`, configures no framework. Use this if you don't use
# any mocking framework to save a little bit of overhead.
#
# Given a Module, includes that module in every example group. The module
# should adhere to RSpec's mock framework adapter API:
#
# setup_mocks_for_rspec
# - called before each example
#
# verify_mocks_for_rspec
# - called after each example if the example hasn't yet failed.
# Framework should raise an exception when expectations fail
#
# teardown_mocks_for_rspec
# - called after verify_mocks_for_rspec (even if there are errors)
#
# If the module responds to `configuration` and `mock_with` receives a
# block, it will yield the configuration object to the block e.g.
#
# config.mock_with OtherMockFrameworkAdapter do |mod_config|
# mod_config.custom_setting = true
# end
def mock_with(framework)
framework_module =
if framework.is_a?(Module)
framework
else
const_name = MOCKING_ADAPTERS.fetch(framework) do
raise ArgumentError,
"Unknown mocking framework: #{framework.inspect}. " \
"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}"
end
RSpec::Support.require_rspec_core "mocking_adapters/#{const_name.to_s.downcase}"
RSpec::Core::MockingAdapters.const_get(const_name)
end
new_name, old_name = [framework_module, @mock_framework].map do |mod|
mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed
end
unless new_name == old_name
assert_no_example_groups_defined(:mock_framework)
end
if block_given?
raise "#{framework_module} must respond to `configuration` so that " \
"mock_with can yield it." unless framework_module.respond_to?(:configuration)
yield framework_module.configuration
end
@mock_framework = framework_module
end
# Returns the configured expectation framework adapter module(s)
def expectation_frameworks
if @expectation_frameworks.empty?
begin
expect_with :rspec
rescue LoadError
expect_with Module.new
end
end
@expectation_frameworks
end
# Delegates to expect_with(framework).
def expectation_framework=(framework)
expect_with(framework)
end
# Sets the expectation framework module(s) to be included in each example
# group.
#
# `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom
# module, or any combination thereof:
#
# config.expect_with :rspec
# config.expect_with :test_unit
# config.expect_with :minitest
# config.expect_with :rspec, :minitest
# config.expect_with OtherExpectationFramework
#
# RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the
# appropriate modules.
#
# ## Configuration
#
# If the module responds to `configuration`, `expect_with` will
# yield the `configuration` object if given a block:
#
# config.expect_with OtherExpectationFramework do |custom_config|
# custom_config.custom_setting = true
# end
def expect_with(*frameworks)
modules = frameworks.map do |framework|
case framework
when Module
framework
when :rspec
require 'rspec/expectations'
# Tag this exception class so our exception formatting logic knows
# that it satisfies the `MultipleExceptionError` interface.
::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(
:include, MultipleExceptionError::InterfaceTag
)
::RSpec::Matchers
when :test_unit
require 'rspec/core/test_unit_assertions_adapter'
::RSpec::Core::TestUnitAssertionsAdapter
when :minitest
require 'rspec/core/minitest_assertions_adapter'
::RSpec::Core::MinitestAssertionsAdapter
else
raise ArgumentError, "#{framework.inspect} is not supported"
end
end
if (modules - @expectation_frameworks).any?
assert_no_example_groups_defined(:expect_with)
end
if block_given?
raise "expect_with only accepts a block with a single argument. " \
"Call expect_with #{modules.length} times, " \
"once with each argument, instead." if modules.length > 1
raise "#{modules.first} must respond to `configuration` so that " \
"expect_with can yield it." unless modules.first.respond_to?(:configuration)
yield modules.first.configuration
end
@expectation_frameworks.push(*modules)
end
# Check if full backtrace is enabled.
# @return [Boolean] is full backtrace enabled
def full_backtrace?
@backtrace_formatter.full_backtrace?
end
# Toggle full backtrace.
# @attr true_or_false [Boolean] toggle full backtrace display
def full_backtrace=(true_or_false)
@backtrace_formatter.full_backtrace = true_or_false
end
# Enables color output if the output is a TTY. As of RSpec 3.6, this is
# the default behavior and this option is retained only for backwards
# compatibility.
#
# @deprecated No longer recommended because of complex behavior. Instead,
# rely on the fact that TTYs will display color by default, or set
# {#color_mode} to :on to display color on a non-TTY output.
# @see color_mode
# @see color_enabled?
# @return [Boolean]
def color
value_for(:color) { @color }
end
# The mode for determining whether to display output in color. One of:
#
# - :automatic - the output will be in color if the output is a TTY (the
# default)
# - :on - the output will be in color, whether or not the output is a TTY
# - :off - the output will not be in color
#
# @see color_enabled?
# @return [Boolean]
def color_mode
value_for(:color_mode) { @color_mode }
end
# Check if color is enabled for a particular output.
# @param output [IO] an output stream to use, defaults to the current
# `output_stream`
# @return [Boolean]
def color_enabled?(output=output_stream)
case color_mode
when :on then true
when :off then false
else # automatic
output_to_tty?(output) || (color && tty?)
end
end
# Set the color mode.
attr_writer :color_mode
# Toggle output color.
#
# @deprecated No longer recommended because of complex behavior. Instead,
# rely on the fact that TTYs will display color by default, or set
# {:color_mode} to :on to display color on a non-TTY output.
attr_writer :color
# @private
def libs=(libs)
libs.map do |lib|
@libs.unshift lib
$LOAD_PATH.unshift lib
end
end
# Run examples matching on `description` in all files to run.
# @param description [String, Regexp] the pattern to filter on
def full_description=(description)
filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })
end
# @return [Array] full description filter
def full_description
filter.fetch :full_description, nil
end
# @overload add_formatter(formatter)
# @overload add_formatter(formatter, output)
#
# @param formatter [Class, String, Object] formatter to use. Can be any of the
# string values supported from the CLI (`p`/`progress`,
# `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any
# class that implements the formatter protocol and has registered
# itself with RSpec as a formatter, or a formatter instance.
# @param output [String, IO] where the formatter will write its output.
# Can be an IO object or a string path to a file. If not provided,
# the configured `output_stream` (`$stdout`, by default) will be used.
#
# Adds a formatter to the set RSpec will use for this run.
#
# @see RSpec::Core::Formatters::Protocol
def add_formatter(formatter, output=output_wrapper)
formatter_loader.add(formatter, output)
end
alias_method :formatter=, :add_formatter