class RSpec::Mocks::ErrorGenerator

@private

Attributes

Public Class Methods

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 39
def initialize(target=nil)
  @target = target
end

Public Instance Methods

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 71
def default_error_message(expectation, expected_args, actual_args)
  "#{intro} received #{expectation.message.inspect} #{unexpected_arguments_message(expected_args, actual_args)}".dup
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 132
def describe_expectation(verb, message, expected_received_count, _actual_received_count, args)
  "#{verb} #{message}#{format_args(args)} #{count_message(expected_received_count)}"
end
# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 215
def expectation_on_nil_message(method_name)
  "An expectation of `:#{method_name}` was set on `nil`. " \
  "To allow expectations on `nil` and suppress this message, set `RSpec::Mocks.configuration.allow_message_expectations_on_nil` to `true`. " \
  "To disallow expectations on `nil`, set `RSpec::Mocks.configuration.allow_message_expectations_on_nil` to `false`"
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 222
def intro(unwrapped=false)
  case @target
  when TestDouble then TestDoubleFormatter.format(@target, unwrapped)
  when Class then
    formatted = "#{@target.inspect} (class)"
    return formatted if unwrapped
    "#<#{formatted}>"
  when NilClass then "nil"
  else @target.inspect
  end
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 235
def method_call_args_description(args, generic_prefix=" with arguments: ", matcher_prefix=" with ")
  case args.first
  when ArgumentMatchers::AnyArgsMatcher then "#{matcher_prefix}any arguments"
  when ArgumentMatchers::NoArgsMatcher  then "#{matcher_prefix}no arguments"
  else
    if yield
      "#{generic_prefix}#{format_args(args)}"
    else
      ""
    end
  end
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 44
def opts
  @opts ||= {}
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 203
def raise_already_invoked_error(message, calling_customization)
  error_message = "The message expectation for #{intro}.#{message} has already been invoked " \
    "and cannot be modified further (e.g. using `#{calling_customization}`). All message expectation " \
    "customizations must be applied before it is used for the first time."

  notify MockExpectationAlreadyInvokedError.new(error_message)
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 193
def raise_cant_constrain_count_for_negated_have_received_error(count_constraint)
  __raise "can't use #{count_constraint} when negative"
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 170
def raise_double_negation_error(wrapped_expression)
  __raise "Isn't life confusing enough? You've already set a " \
          "negative message expectation and now you are trying to " \
          "negate it again with `never`. What does an expression like " \
          "`#{wrapped_expression}.not_to receive(:msg).never` even mean?"
end

rubocop:disable Metrics/ParameterLists @private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 77
def raise_expectation_error(message, expected_received_count, argument_list_matcher,
                            actual_received_count, expectation_count_type, args,
                            backtrace_line=nil, source_id=nil)
  expected_part = expected_part_of_expectation_error(expected_received_count, expectation_count_type, argument_list_matcher)
  received_part = received_part_of_expectation_error(actual_received_count, args)
  __raise "(#{intro(:unwrapped)}).#{message}#{format_args(args)}\n    #{expected_part}\n    #{received_part}", backtrace_line, source_id
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 164
def raise_expectation_on_mocked_method(method)
  __raise "#{intro} expected to have received #{method}, but that " \
          "method has been mocked instead of stubbed or spied."
end
# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 211
def raise_expectation_on_nil_error(method_name)
  __raise expectation_on_nil_message(method_name)
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 158
def raise_expectation_on_unstubbed_method(method)
  __raise "#{intro} expected to have received #{method}, but that " \
          "object is not a spy or method has not been stubbed."
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 123
def raise_expired_test_double_error
  raise ExpiredTestDoubleError,
        "#{intro} was originally created in one example but has leaked into " \
        "another example and can no longer be used. rspec-mocks' doubles are " \
        "designed to only last for one example, and you need to create a new " \
        "one in each example you wish to use it for."
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 187
def raise_have_received_disallowed(type, reason)
  __raise "Using #{type}(...) with the `have_received` " \
          "matcher is not supported#{reason}."
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 118
def raise_invalid_arguments_error(verifier)
  __raise verifier.error_message
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 198
def raise_method_not_stubbed_error(method_name)
  __raise "The method `#{method_name}` was not stubbed or was already unstubbed"
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 142
def raise_missing_block_error(args_to_yield)
  __raise "#{intro} asked to yield |#{arg_list(args_to_yield)}| but no block was passed"
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 59
def raise_missing_default_stub_error(expectation, args_for_multiple_calls)
  __raise(
    error_message(expectation, args_for_multiple_calls) +
    "\n Please stub a default value first if message might be received with other args as well. \n"
  )
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 111
def raise_non_public_error(method_name, visibility)
  raise NoMethodError, "%s method `%s' called on %s" % [
    visibility, method_name, intro
  ]
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 152
def raise_only_valid_on_a_partial_double(method)
  __raise "#{intro} is a pure test double. `#{method}` is only " \
          "available on a partial double."
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 137
def raise_out_of_order_error(message)
  __raise "#{intro} received :#{message} out of order"
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 67
def raise_similar_message_args_error(expectation, args_for_multiple_calls, backtrace_line=nil)
  __raise error_message(expectation, args_for_multiple_calls), backtrace_line
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 54
def raise_unexpected_message_args_error(expectation, args_for_multiple_calls, source_id=nil)
  __raise error_message(expectation, args_for_multiple_calls), nil, source_id
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 49
def raise_unexpected_message_error(message, args)
  __raise "#{intro} received unexpected message :#{message} with #{format_args(args)}"
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 87
def raise_unimplemented_error(doubled_module, method_name, object)
  message = case object
            when InstanceVerifyingDouble
              "the %s class does not implement the instance method: %s".dup <<
                if ObjectMethodReference.for(doubled_module, method_name).implemented?
                  ". Perhaps you meant to use `class_double` instead?"
                else
                  ""
                end
            when ClassVerifyingDouble
              "the %s class does not implement the class method: %s".dup <<
                if InstanceMethodReference.for(doubled_module, method_name).implemented?
                  ". Perhaps you meant to use `instance_double` instead?"
                else
                  ""
                end
            else
              "%s does not implement: %s"
            end

  __raise message % [doubled_module.description, method_name]
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 178
def raise_verifying_double_not_defined_error(ref)
  notify(VerifyingDoubleNotDefinedError.new(
    "#{ref.description.inspect} is not a defined constant. " \
    "Perhaps you misspelt it? " \
    "Disable check with `verify_doubled_constant_names` configuration option."
  ))
end

@private

# File rspec-mocks/lib/rspec/mocks/error_generator.rb, line 147
def raise_wrong_arity_error(args_to_yield, signature)
  __raise "#{intro} yielded |#{arg_list(args_to_yield)}| to block with #{signature.description}"
end