123456789_123456789_123456789_123456789_123456789_

Class: RSpec::Rails::Matchers::HaveHttpStatus::SymbolicStatus Private

Do not use. This class is for internal use only.

Overview

Provides an implementation for ‘have_http_status` matching against Rack symbol http status codes.

Not intended to be instantiated directly.

Examples:

expect(response).to have_http_status(:created)

See Also:

Constant Summary

::RSpec::Rails::Matchers::BaseMatcher - Inherited

UNDEFINED

Class Method Summary

::RSpec::Rails::Matchers::BaseMatcher - Inherited

.matcher_name, .new,
.underscore

Borrowed from ActiveSupport.

Instance Attribute Summary

  • #expected_status readonly private Internal use only

    The initialized expected status symbol.

::RSpec::Rails::Matchers::BaseMatcher - Inherited

#actual,
#diffable?

::RSpec::Rails::Matchers are not diffable by default.
#expected, #expects_call_stack_jump?, #matcher_name, #matcher_name=, #rescued_exception,
#supports_block_expectations?

Most matchers are value matchers (i.e. meant to work with ‘expect(value)`) rather than block matchers (i.e. meant to work with `expect { }`), so this defaults to false.

Instance Method Summary

::RSpec::Rails::Matchers::HaveHttpStatus - Included

#invalid_response_type_message,
#as_test_response

Conversion function to coerce the provided object into an ‘ActionDispatch::TestResponse`.

::RSpec::Rails::Matchers::BaseMatcher - Inherited

#actual_formatted,
#description

Generates a description using ::RSpec::Matchers::EnglishPhrasing.
#expected_formatted,
#match_unless_raises

Used to wrap a block of code that will indicate failure by raising one of the named exceptions.
#matches?

Indicates if the match is successful.
#assert_ivars, #present_ivars

::RSpec::Rails::Matchers::BaseMatcher::DefaultFailureMessages - Included

#failure_message

Provides a good generic failure message.
#failure_message_when_negated

Provides a good generic negative failure message.

::RSpec::Rails::Matchers::BaseMatcher::HashFormatting - Included

#improve_hash_formatting

‘{ :a => 5, :b => 2 }.inspect` produces:

::RSpec::Matchers::Composable - Included

#&

Alias for Matchers::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 Matchers::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

#expected_status (readonly, private)

The initialized expected status symbol

[ GitHub ] 

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 170



attr_reader :expected_status


  







Instance Method Details



  

    #actual_status  ⇒ Symbol  (private)
  



  

    
  





  
Returns:


    
  
  • 
    (Symbol)
—    
    

    representing the actual http numeric code
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 176



def actual_status
  return unless actual

  @actual_status ||= compute_status_from(actual)
end


  








  

    #compute_status_from(code)  ⇒ Symbol  (private)
  



  

    

Reverse lookup of the Rack status code symbol based on the numeric http code


  





  
Parameters:


    
  
  • 
    code
    (Fixnum)
—    
    

    http status code to look up
    

    
  
    • 



Returns:


    
  
  • 
    (Symbol)
—    
    

    representing the http numeric code
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 187



def compute_status_from(code)
  status, _ = Rack::Utils::SYMBOL_TO_STATUS_CODE.find do |_, c|
    c == code
  end
  status
end


  








  

    #description  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 151



def description
  "respond with status code #{pp_expected}"
end


  








  

    #failure_message  ⇒ String 
  



  

    
  





  
Returns:


    
  
  • 
    (String)
—    
    

    explaining why the match failed
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 156



def failure_message
  invalid_response_type_message ||
  "expected the response to have status code #{pp_expected} but it" \
    " was #{pp_actual}"
end


  








  

    #failure_message_when_negated  ⇒ String 
  



  

    
  





  
Returns:


    
  
  • 
    (String)
—    
    

    explaining why the match failed
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 163



def failure_message_when_negated
  invalid_response_type_message ||
  "expected the response not to have status code #{pp_expected} " \
    "but it did"
end


  








  

    #matches?(response)  ⇒ Boolean 
  



  

    
  





  
Parameters:


    
  
  • 
    response
    (Object)
—    
    

    object providing an http code to match
    

    
  
    • 



Returns:


    
  
  • 
    (Boolean)
—    
    

    ‘true` if Rack’s associated numeric HTTP code matched the ‘response` code
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 141



def matches?(response)
  test_response = as_test_response(response)
  @actual = test_response.response_code
  expected == @actual
rescue TypeError => _ignored
  @invalid_response = response
  false
end


  








  

    #pp_actual  ⇒ String  (private)
  



  

    
  





  
Returns:


    
  
  • 
    (String)
—    
    

    pretty format the actual response status
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 195



def pp_actual
  pp_status(actual_status, actual)
end


  








  

    #pp_expected  ⇒ String  (private)
  



  

    
  





  
Returns:


    
  
  • 
    (String)
—    
    

    pretty format the expected status and associated code
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 200



def pp_expected
  pp_status(expected_status, expected)
end


  








  

    #pp_status(status, code)  ⇒ String  (private)
  



  

    
  





  
Returns:


    
  
  • 
    (String)
—    
    

    pretty format the actual response status
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 205



def pp_status(status, code)
  if status
    "#{status.inspect} (#{code})"
  else
    code.to_s
  end
end


  








  

    #set_expected_code!   (private)
  



  

    

Sets ‘expected` to the numeric http code based on the Rack #expected_status status


  





  
Raises:


    
  
  • 
    (ArgumentError)
—    
    

    if an associated code could not be found
    

    
  
    • 


  
See Also:

  
    
      
  • Rack::Utils::SYMBOL_TO_STATUS_CODE
    • 
      




  [ GitHub ]


  

  


# File 'rspec-rails/lib/rspec/rails/matchers/have_http_status.rb', line 218



def set_expected_code!
  @expected ||=
    Rack::Utils::SYMBOL_TO_STATUS_CODE.fetch(expected_status) do
      raise ArgumentError,
            "Invalid HTTP status: #{expected_status.inspect}"
    end
end