Class: RSpec::Matchers::DSL::Matcher

Inherits:

Object

• Object
• RSpec::Matchers::DSL::Matcher

show all

Extended by:

Macros, RSpec::Matchers::DSL::Macros::Deprecated

Includes:

RSpec::Matchers, Composable, DefaultImplementations

Defined in:

lib/rspec/matchers/dsl.rb

Overview

Constant Summary

Instance Attribute Summary (collapse)

• - (Object) actual readonly

  Exposes the value being matched against -- generally the object object wrapped by expect.

• - (Object) block_arg readonly

  The block parameter used in the expectation.

• - (Object) expected_as_array readonly

  Returns the expected value as an an array.

• - (Object) name readonly

  The name of the matcher.

• - (Object) rescued_exception readonly

  Exposes the exception raised during the matching by match_unless_raises.

Instance Method Summary (collapse)

• - (Object) expected

  Provides the expected value.

• - (Matcher) initialize(name, declarations, matcher_execution_context, *expected, &block_arg) constructor private

  A new instance of Matcher.

• - (Object) inspect

  Adds the name (rather than a cryptic hex number) so we can identify an instance of the matcher in error messages (e.g. for NoMethodError).

• - (Boolean) respond_to?(method, include_private = false)

  :nocov: Indicates that this matcher responds to messages from the @matcher_execution_context as well.

• - (Boolean) respond_to_missing?(method, include_private = false)

  Indicates that this matcher responds to messages from the @matcher_execution_context as well.

Methods included from RSpec::Matchers::DSL::Macros::Deprecated

failure_message_for_should, failure_message_for_should_not, match_for_should, match_for_should_not

Methods included from Macros

chain, description, diffable, failure_message, failure_message_when_negated, match, match_unless_raises, match_when_negated, supports_block_expectations

Methods included from Composable

#===, #and, #description_of, #or, should_enumerate?, surface_descriptions_in, unreadable_io?, #values_match?

Methods included from RSpec::Matchers

#aggregate_failures, alias_matcher, #all, #be, #be_a, #be_a_kind_of, #be_an_instance_of, #be_between, #be_falsey, #be_nil, #be_truthy, #be_within, #change, clear_generated_description, configuration, #contain_exactly, #cover, define, define_negated_matcher, #end_with, #eq, #eql, #equal, #exist, #expect, generated_description, #have_attributes, #include, #match, #match_array, #output, #raise_error, #respond_to, #satisfy, #start_with, #throw_symbol, #yield_control, #yield_successive_args, #yield_with_args, #yield_with_no_args

Methods included from RSpec::Matchers::DSL

#alias_matcher, #define, #define_negated_matcher

Methods included from DefaultImplementations

#description, #diffable?, #expects_call_stack_jump?, #supports_block_expectations?

Methods included from BuiltIn::BaseMatcher::DefaultFailureMessages

#failure_message, #failure_message_when_negated

448
449
450
451
452
453
454
455
456
457
458
459
460
461

# File 'lib/rspec/matchers/dsl.rb', line 448
def initialize(name, declarations, matcher_execution_context, *expected, &block_arg)
  @name     = name
  @actual   = nil
  @expected_as_array = expected
  @matcher_execution_context = matcher_execution_context
  @chained_method_clauses = []
  @block_arg = block_arg
  class << self
    # See `Macros#define_user_override` above, for an explanation.
    include(@user_method_defs = Module.new)
    self
  end.class_exec(*expected, &declarations)
end

517
518
519
520
521
522
523

# File 'lib/rspec/matchers/dsl.rb', line 517
def method_missing(method, *args, &block)
  if @matcher_execution_context.respond_to?(method)
    @matcher_execution_context.__send__ method, *args, &block
  else
    super(method, *args, &block)
  end
end

435
436
437

# File 'lib/rspec/matchers/dsl.rb', line 435
def actual
  @actual
end

442
443
444

# File 'lib/rspec/matchers/dsl.rb', line 442
def block_arg
  @block_arg
end

479
480
481

# File 'lib/rspec/matchers/dsl.rb', line 479
def expected_as_array
  @expected_as_array
end

445
446
447

# File 'lib/rspec/matchers/dsl.rb', line 445
def name
  @name
end

439
440
441

# File 'lib/rspec/matchers/dsl.rb', line 439
def rescued_exception
  @rescued_exception
end

467
468
469
470
471
472
473

# File 'lib/rspec/matchers/dsl.rb', line 467
def expected
  if expected_as_array.size == 1
    expected_as_array[0]
  else
    expected_as_array
  end
end

484
485
486

# File 'lib/rspec/matchers/dsl.rb', line 484
def inspect
  "#<#{self.class.name} #{name}>"
end

499
500
501

# File 'lib/rspec/matchers/dsl.rb', line 499
def respond_to?(method, include_private=false)
  super || @matcher_execution_context.respond_to?(method, include_private)
end

492
493
494

# File 'lib/rspec/matchers/dsl.rb', line 492
def respond_to_missing?(method, include_private=false)
  super || @matcher_execution_context.respond_to?(method, include_private)
end