Class: RSpec::Core::Configuration

541
542
543
544
545
546
547

# File 'lib/rspec/core/configuration.rb', line 541
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

1848
1849
1850
1851
1852
1853
1854
1855

# File 'lib/rspec/core/configuration.rb', line 1848
def after(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})
  end || begin
    add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

1088
1089
1090
1091

# File 'lib/rspec/core/configuration.rb', line 1088
def alias_example_group_to(new_name, *args)
  extra_options = Metadata.build_hash_from(args)
  RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)
end

1056
1057
1058
1059

# File 'lib/rspec/core/configuration.rb', line 1056
def alias_example_to(name, *args)
  extra_options = Metadata.build_hash_from(args)
  RSpec::Core::ExampleGroup.define_example_method(name, extra_options)
end

1119
1120
1121

# File 'lib/rspec/core/configuration.rb', line 1119
def alias_it_behaves_like_to(new_name, report_label='')
  RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)
end

1871
1872
1873
1874
1875
1876
1877
1878

# File 'lib/rspec/core/configuration.rb', line 1871
def append_after(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @after_suite_hooks << Hooks::AfterHook.new(block, {})
  end || begin
    add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

1883
1884
1885
1886

# File 'lib/rspec/core/configuration.rb', line 1883
def around(scope=nil, *meta, &block)
  add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }
  super(scope, *meta, &block)
end

577
578
579

# File 'lib/rspec/core/configuration.rb', line 577
def backtrace_exclusion_patterns
  @backtrace_formatter.exclusion_patterns
end

583
584
585

# File 'lib/rspec/core/configuration.rb', line 583
def backtrace_exclusion_patterns=(patterns)
  @backtrace_formatter.exclusion_patterns = patterns
end

595
596
597

# File 'lib/rspec/core/configuration.rb', line 595
def backtrace_inclusion_patterns
  @backtrace_formatter.inclusion_patterns
end

601
602
603

# File 'lib/rspec/core/configuration.rb', line 601
def backtrace_inclusion_patterns=(patterns)
  @backtrace_formatter.inclusion_patterns = patterns
end

1807
1808
1809
1810
1811
1812
1813
1814

# File 'lib/rspec/core/configuration.rb', line 1807
def before(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @before_suite_hooks << Hooks::BeforeHook.new(block, {})
  end || begin
    add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

822
823
824
825
826
827
828
829

# File 'lib/rspec/core/configuration.rb', line 822
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

882
883
884

# File 'lib/rspec/core/configuration.rb', line 882
def default_formatter
  formatter_loader.default_formatter
end

893
894
895

# File 'lib/rspec/core/configuration.rb', line 893
def default_formatter=(value)
  formatter_loader.default_formatter = value
end

1751
1752
1753
1754

# File 'lib/rspec/core/configuration.rb', line 1751
def define_derived_metadata(*filters, &block)
  meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
  @derived_metadata_blocks.append(block, meta)
end

146

# File 'lib/rspec/core/configuration.rb', line 146
define_reader :deprecation_stream

150
151
152
153
154
155
156
157
158
159
160

# File 'lib/rspec/core/configuration.rb', line 150
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

1724
1725
1726
1727
1728
1729

# File 'lib/rspec/core/configuration.rb', line 1724
def disable_monkey_patching!
  self.expose_dsl_globally = false
  self.disable_monkey_patching = true
  conditionally_disable_mocks_monkey_patching
  conditionally_disable_expectations_monkey_patching
end

1248
1249
1250

# File 'lib/rspec/core/configuration.rb', line 1248
def exclusion_filter
  filter_manager.exclusions
end

1241
1242
1243
1244

# File 'lib/rspec/core/configuration.rb', line 1241
def exclusion_filter=(filter)
  meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)
  filter_manager.exclude_only meta
end

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

# File 'lib/rspec/core/configuration.rb', line 737
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

710
711
712

# File 'lib/rspec/core/configuration.rb', line 710
def expectation_framework=(framework)
  expect_with(framework)
end

698
699
700
701
702
703
704
705
706
707

# File 'lib/rspec/core/configuration.rb', line 698
def expectation_frameworks
  if @expectation_frameworks.empty?
    begin
      expect_with :rspec
    rescue LoadError
      expect_with Module.new
    end
  end
  @expectation_frameworks
end

1662
1663
1664
1665
1666
1667
1668
1669

# File 'lib/rspec/core/configuration.rb', line 1662
def expose_current_running_example_as(method_name)
  ExposeCurrentExample.module_exec do
    extend RSpec::SharedContext
    let(method_name) { |ex| ex }
  end
  include ExposeCurrentExample
end

133
134
135
136
137
138
139
140
141

# File 'lib/rspec/core/configuration.rb', line 133
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

125
126
127

# File 'lib/rspec/core/configuration.rb', line 125
def expose_dsl_globally?
  Core::DSL.exposed_globally?
end

1371
1372
1373
1374
1375

# File 'lib/rspec/core/configuration.rb', line 1371
def extend(mod, *filters)
  define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|
    safe_extend(mod, group)
  end
end

621
622
623
624
625

# File 'lib/rspec/core/configuration.rb', line 621
def filter_gems_from_backtrace(*gem_names)
  gem_names.each do |name|
    @backtrace_formatter.filter_gem(name)
  end
end

1228
1229
1230
1231
1232

# File 'lib/rspec/core/configuration.rb', line 1228
def filter_run_excluding(*args)
  meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)
  filter_manager.exclude_with_low_priority meta
  static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)
end

1154
1155
1156
1157
1158

# File 'lib/rspec/core/configuration.rb', line 1154
def filter_run_including(*args)
  meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)
  filter_manager.include_with_low_priority meta
  static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)
end

1170
1171
1172
1173
1174

# File 'lib/rspec/core/configuration.rb', line 1170
def filter_run_when_matching(*args)
  when_first_matching_example_defined(*args) do
    filter_run(*args)
  end
end

1512
1513
1514

# File 'lib/rspec/core/configuration.rb', line 1512
def format_docstrings(&block)
  @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER
end

903
904
905

# File 'lib/rspec/core/configuration.rb', line 903
def formatters
  formatter_loader.formatters.dup
end

787
788
789

# File 'lib/rspec/core/configuration.rb', line 787
def full_backtrace=(true_or_false)
  @backtrace_formatter.full_backtrace = true_or_false
end

781
782
783

# File 'lib/rspec/core/configuration.rb', line 781
def full_backtrace?
  @backtrace_formatter.full_backtrace?
end

856
857
858

# File 'lib/rspec/core/configuration.rb', line 856
def full_description
  filter.fetch :full_description, nil
end

851
852
853

# File 'lib/rspec/core/configuration.rb', line 851
def full_description=(description)
  filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })
end

1293
1294
1295
1296
1297

# File 'lib/rspec/core/configuration.rb', line 1293
def include(mod, *filters)
  define_mixed_in_module(mod, filters, @include_modules, :include) do |group|
    safe_include(mod, group)
  end
end

1336
1337
1338
1339

# File 'lib/rspec/core/configuration.rb', line 1336
def include_context(shared_group_name, *filters)
  shared_module = world.shared_example_group_registry.find([:main], shared_group_name)
  include shared_module, *filters
end

1192
1193
1194

# File 'lib/rspec/core/configuration.rb', line 1192
def inclusion_filter
  filter_manager.inclusions
end

1183
1184
1185
1186

# File 'lib/rspec/core/configuration.rb', line 1183
def inclusion_filter=(filter)
  meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)
  filter_manager.include_only meta
end

550
551
552
553
554
555
556
557
558
559

# File 'lib/rspec/core/configuration.rb', line 550
def mock_framework
  if @mock_framework.nil?
    begin
      mock_with :rspec
    rescue LoadError
      mock_with :nothing
    end
  end
  @mock_framework
end

562
563
564

# File 'lib/rspec/core/configuration.rb', line 562
def mock_framework=(framework)
  mock_with framework
end

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

# File 'lib/rspec/core/configuration.rb', line 665
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

1909
1910
1911

# File 'lib/rspec/core/configuration.rb', line 1909
def on_example_group_definition(&block)
  on_example_group_definition_callbacks << block
end

1915
1916
1917

# File 'lib/rspec/core/configuration.rb', line 1915
def on_example_group_definition_callbacks
  @on_example_group_definition_callbacks ||= []
end

1559

# File 'lib/rspec/core/configuration.rb', line 1559
delegate_to_ordering_manager :order=

1410
1411
1412
1413
1414

# File 'lib/rspec/core/configuration.rb', line 1410
def prepend(mod, *filters)
  define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|
    safe_prepend(mod, group)
  end
end

1830
1831
1832
1833
1834
1835
1836
1837

# File 'lib/rspec/core/configuration.rb', line 1830
def prepend_before(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})
  end || begin
    add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

1684
1685
1686

# File 'lib/rspec/core/configuration.rb', line 1684
def raise_errors_for_deprecations!
  self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new
end

1632
1633
1634
1635
1636
1637
1638

# File 'lib/rspec/core/configuration.rb', line 1632
def raise_on_warning=(value)
  if value
    RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER
  else
    RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER
  end
end

1606

# File 'lib/rspec/core/configuration.rb', line 1606
delegate_to_ordering_manager :register_ordering

935
936
937
938
939
940
941
942
943
944
945
946

# File 'lib/rspec/core/configuration.rb', line 935
def reporter
  # @reporter_buffer should only ever be set in this method to cover
  # initialization of @reporter.
  @reporter_buffer || @reporter ||=
    begin
      @reporter_buffer = DeprecationReporterBuffer.new
      formatter_loader.prepare_default output_wrapper, deprecation_stream
      @reporter_buffer.play_onto(formatter_loader.reporter)
      @reporter_buffer = nil
      formatter_loader.reporter
    end
end

1549

# File 'lib/rspec/core/configuration.rb', line 1549
delegate_to_ordering_manager :seed

1535

# File 'lib/rspec/core/configuration.rb', line 1535
delegate_to_ordering_manager :seed=

327
328
329
330
331
332
333
334

# File 'lib/rspec/core/configuration.rb', line 327
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

1612
1613
1614

# File 'lib/rspec/core/configuration.rb', line 1612
def warnings=(value)
  $VERBOSE = !!value
end

1617
1618
1619

# File 'lib/rspec/core/configuration.rb', line 1617
def warnings?
  $VERBOSE
end

1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789

# File 'lib/rspec/core/configuration.rb', line 1774
def when_first_matching_example_defined(*filters, &block)
  specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
  callback = lambda do |example_or_group_meta|
    # Example groups do not have `:example_group` metadata
    # (instead they have `:parent_example_group` metadata).
    return unless example_or_group_meta.key?(:example_group)
    # Ensure the callback only fires once.
    @derived_metadata_blocks.delete(callback, specified_meta)
    block.call
  end
  @derived_metadata_blocks.append(callback, specified_meta)
end