123456789_123456789_123456789_123456789_123456789_

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

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, ::RSpec::Matchers::Composable
Inherits: Object
Defined in: rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb

Overview

Provides the implementation for RSpec::Matchers#throw_symbol. Not intended to be instantiated directly.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

::RSpec::Matchers::Composable - Included

#&

Alias for Composable#and.
#===

Delegates to #matches?.
#and

Creates a compound and expectation.
#description_of

Returns the description of the given object in a way that is aware of composed matchers.
#or

Creates a compound or expectation.
#values_match?

This provides a generic way to fuzzy-match an expected value against an actual value.
#|

Alias for Composable#or.
#should_enumerate?

We should enumerate arrays as long as they are not recursive.
#surface_descriptions_in

Transforms the given data structure (typically a hash or array) into a new data structure that, when #inspect is called on it, will provide descriptions of any contained matchers rather than the normal #inspect output.
#unreadable_io?,
#with_matchers_cloned

Historically, a single matcher instance was only checked against a single value.

Instance Attribute Details

#expects_call_stack_jump? ⇒ Boolean (readonly)

[ GitHub ] 

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 103



def expects_call_stack_jump?
  true
end


  








  

    #supports_block_expectations?  ⇒ True  (readonly)
  



  

    

Indicates this matcher matches against a block.


  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 93



def supports_block_expectations?
  true
end


  








  

    #supports_value_expectations?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 98



def supports_value_expectations?
  false
end


  







Instance Method Details



  

    #actual_result   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 109



def actual_result
  return "but was not a block" unless Proc === @block
  "got #{caught}"
end


  








  

    #caught   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 118



def caught
  throw_description(@caught_symbol || 'nothing', @caught_arg)
end


  








  

    #description  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 86



def description
  "throw #{expected}"
end


  








  

    #does_not_match?(given_proc)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 68



def does_not_match?(given_proc)
  !matches?(given_proc) && Proc === given_proc
end


  








  

    #expected(symbol_desc = 'a Symbol')   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 114



def expected(symbol_desc='a Symbol')
  throw_description(@expected_symbol || symbol_desc, @expected_arg)
end


  








  

    #failure_message  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 74



def failure_message
  "expected #{expected} to be thrown, #{actual_result}"
end


  








  

    #failure_message_when_negated  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 80



def failure_message_when_negated
  "expected #{expected('no Symbol')}#{' not' if @expected_symbol} to be thrown, #{actual_result}"
end


  








  

    #matches?(given_proc)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 18



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 (match_data = e.message.match(/uncaught throw (`|\:)([a-zA-Z0-9_]*)(')?/))
      other_exception = e
      raise
    end
    @caught_symbol = match_data.captures[1].to_sym
  rescue => other_exception
    raise
  ensure
    # rubocop:disable Lint/EnsureReturn
    unless other_exception
      if @expected_symbol.nil?
        return !!@caught_symbol
      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
    # rubocop:enable Lint/EnsureReturn
  end
end


  








  

    #throw_description(symbol, arg)   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/throw_symbol.rb', line 122



def throw_description(symbol, arg)
  symbol_description = symbol.is_a?(String) ? symbol : description_of(symbol)

  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