Class: RSpec::Matchers::BuiltIn::ThrowSymbol

Inherits:
Object
  • Object
show all
Includes:
MatchAliases
Defined in:
lib/rspec/matchers/built_in/throw_symbol.rb

Instance Method Summary (collapse)

Methods included from MatchAliases

#==, #===

Constructor Details

- (ThrowSymbol) initialize(expected_symbol = nil, expected_arg = nil)

A new instance of ThrowSymbol

7
8
9
10
11
 
# File 'lib/rspec/matchers/built_in/throw_symbol.rb', line 7
def initialize(expected_symbol = nil, expected_arg=nil)
  @expected_symbol = expected_symbol
  @expected_arg = expected_arg
  @caught_symbol = @caught_arg = nil
end

Instance Method Details

- (Object) description 

65
66
67
 
# File 'lib/rspec/matchers/built_in/throw_symbol.rb', line 65
def description
  "throw #{expected}"
end

- (Object) failure_message_for_should 

57
58
59
 
# File 'lib/rspec/matchers/built_in/throw_symbol.rb', line 57
def failure_message_for_should
  "expected #{expected} to be thrown, got #{caught}"
end

- (Object) failure_message_for_should_not 

61
62
63
 
# File 'lib/rspec/matchers/built_in/throw_symbol.rb', line 61
def failure_message_for_should_not
  "expected #{expected('no Symbol')}#{' not' if @expected_symbol} to be thrown, got #{caught}"
end

- (Boolean) matches?(given_proc)

Returns:

  • (Boolean) 
13
14
15
16
17
18
19
20
21
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
55
 
# File 'lib/rspec/matchers/built_in/throw_symbol.rb', line 13
def matches?(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) & (@caught_arg == @expected_arg)
        end
      end
    end
  end
end

- (True) supports_block_expectations?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Indicates this matcher matches against a block.

Returns:

  • (True) 
72
73
74
 
# File 'lib/rspec/matchers/built_in/throw_symbol.rb', line 72
def supports_block_expectations?
  true
end