Module: RSpec::DescriptionConsistency

Defined in:
lib/rspec/description_consistency.rb,
lib/rspec/description_consistency/state.rb,
lib/rspec/description_consistency/reporter.rb,
lib/rspec/description_consistency/configuration.rb,
lib/rspec/description_consistency/resource_manager.rb,
lib/rspec/description_consistency/consitency_verifier.rb

Defined Under Namespace

Modules: ResourceManager Classes: Configuration, ConsitencyVerifier, Reporter, State

Constant Summary collapse

EVALUATION_PERSISTENCE_KEY = 
:'__rspec-description_consistency'

Class Method Summary collapse

Class Method Details

.bind(config) ⇒ Object

rubocop:disable Metrics/MethodLength,Metrics/AbcSize



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
 
# File 'lib/rspec/description_consistency.rb', line 22

def bind(config) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
  config.before(:suite) do
    Thread.current[EVALUATION_PERSISTENCE_KEY] = ::RSpec::DescriptionConsistency::State.new
  end

  config.before do |example|
    configuration = ::RSpec::DescriptionConsistency::Configuration.instance
    next unless configuration.enabled

    ::RSpec::DescriptionConsistency::ConsitencyVerifier.call(
      context: example.metadata, configuration: configuration
    )
  rescue StandardError => e
    configuration.error_stream.puts "Encountered unexpected exception: #{e.inspect}"
  end

  config.after(:suite) do
    configuration = ::RSpec::DescriptionConsistency::Configuration.instance

    ::RSpec::DescriptionConsistency::Reporter.new(
      output_stream: ::RSpec::DescriptionConsistency::Configuration.instance.output_stream
    ).report(Thread.current[EVALUATION_PERSISTENCE_KEY])

    unless [RSpec.configuration.error_stream,
            RSpec.configuration.error_stream].include?(configuration.output_stream)
      ::RSpec::DescriptionConsistency::ResourceManager.release_io(RSpec.configuration.output_stream)
    end

    next unless Thread.current[EVALUATION_PERSISTENCE_KEY].any?

    exit configuration.exit_code if configuration.exit_code.positive?
  end
end

.configuration ⇒ Object 



14
15
16
 
# File 'lib/rspec/description_consistency.rb', line 14

def configuration
  ::RSpec::DescriptionConsistency::Configuration.instance
end

.configure {|configuration| ... } ⇒ Object

Yields:



18
19
20
 
# File 'lib/rspec/description_consistency.rb', line 18

def configure
  yield configuration
end