class RSpec::Matchers::BuiltIn::ThrowSymbol

@api private Provides the implementation for `throw_symbol`. Not intended to be instantiated directly.

Public Class Methods

new(expected_symbol = nil, expected_arg=nil) click to toggle source
# File lib/rspec/matchers/built_in/throw_symbol.rb, line 10
def initialize(expected_symbol = nil, expected_arg=nil)
  @expected_symbol = expected_symbol
  @expected_arg = expected_arg
  @caught_symbol = @caught_arg = nil
end

Public Instance Methods

description() click to toggle source

@api private @return [String]

# File lib/rspec/matchers/built_in/throw_symbol.rb, line 82
def description
  "throw #{expected}"
end
does_not_match?(given_proc) click to toggle source
# File lib/rspec/matchers/built_in/throw_symbol.rb, line 64
def does_not_match?(given_proc)
  !matches?(given_proc) && Proc === given_proc
end
failure_message() click to toggle source

@api private @return [String]

# File lib/rspec/matchers/built_in/throw_symbol.rb, line 70
def failure_message
  "expected #{expected} to be thrown, #{actual_result}"
end
failure_message_when_negated() click to toggle source

@api private @return [String]

# File lib/rspec/matchers/built_in/throw_symbol.rb, line 76
def failure_message_when_negated
  "expected #{expected('no Symbol')}#{' not' if @expected_symbol} to be thrown, #{actual_result}"
end
matches?(given_proc) click to toggle source

@private

# File lib/rspec/matchers/built_in/throw_symbol.rb, line 17
def matches?(given_proc)
  @block = given_proc
  return false unless Proc === given_proc

  begin
    if @expected_symbol.nil?
      given_proc.call
    else
      @caught_arg = catch :proc_did_not_throw_anything do
        catch @expected_symbol do
          given_proc.call
          throw :proc_did_not_throw_anything, :nothing_thrown
        end
      end

      if @caught_arg == :nothing_thrown
        @caught_arg = nil
      else
        @caught_symbol = @expected_symbol
      end
    end

    # Ruby 1.8 uses NameError with `symbol'
    # Ruby 1.9 uses ArgumentError with :symbol
  rescue NameError, ArgumentError => e
    unless e.message =~ /uncaught throw (`|\:)([a-zA-Z0-9_]*)(')?/
      other_exception = e
      raise
    end
    @caught_symbol = $2.to_sym
  rescue => other_exception
    raise
  ensure
    unless other_exception
      if @expected_symbol.nil?
        return !@caught_symbol.nil?
      else
        if @expected_arg.nil?
          return @caught_symbol == @expected_symbol
        else
          return (@caught_symbol == @expected_symbol) && values_match?(@expected_arg, @caught_arg)
        end
      end
    end
  end
end
supports_block_expectations?() click to toggle source

@api private Indicates this matcher matches against a block. @return [True]

# File lib/rspec/matchers/built_in/throw_symbol.rb, line 89
def supports_block_expectations?
  true
end

Private Instance Methods

actual_result() click to toggle source
# File lib/rspec/matchers/built_in/throw_symbol.rb, line 95
def actual_result
  return "but was not a block" unless Proc === @block
  "got #{caught}"
end
caught() click to toggle source
# File lib/rspec/matchers/built_in/throw_symbol.rb, line 104
def caught
  throw_description(@caught_symbol || 'nothing', @caught_arg)
end
expected(symbol_desc = 'a Symbol') click to toggle source
# File lib/rspec/matchers/built_in/throw_symbol.rb, line 100
def expected(symbol_desc = 'a Symbol')
  throw_description(@expected_symbol || symbol_desc, @expected_arg)
end
throw_description(symbol, arg) click to toggle source
# File lib/rspec/matchers/built_in/throw_symbol.rb, line 108
def throw_description(symbol, arg)
  symbol_description = symbol.is_a?(String) ? symbol : symbol.inspect

  arg_description = if arg
                      " with #{description_of arg}"
                    elsif @expected_arg && @caught_symbol == @expected_symbol
                      " with no argument"
                    else
                      ""
                    end

  symbol_description + arg_description
end