rspec-rails 3.0.0.beta2 → 3.0.0.rc1

data/lib/rspec/rails/example/feature_example_group.rb

@@ -6,8 +6,6 @@ module RSpec::Rails
     DEFAULT_HOST = "www.example.com"
 
     included do
-      metadata[:type] = :feature
-
       app = ::Rails.application
       if app.respond_to?(:routes)
         include app.routes.url_helpers     if app.routes.respond_to?(:url_helpers)

data/lib/rspec/rails/example/helper_example_group.rb

@@ -30,8 +30,6 @@ module RSpec::Rails
     end
 
     included do
-      metadata[:type] = :helper
-
       before do |example|
         controller.controller_path = _controller_path(example)
       end

data/lib/rspec/rails/example/mailer_example_group.rb

@@ -6,7 +6,6 @@ if defined?(ActionMailer)
       include ActionMailer::TestCase::Behavior
 
       included do
-        metadata[:type] = :mailer
         include ::Rails.application.routes.url_helpers
         options = ::Rails.configuration.action_mailer.default_url_options
         options.each { |key, value| default_url_options[key] = value } if options

data/lib/rspec/rails/example/model_example_group.rb

@@ -2,9 +2,5 @@ module RSpec::Rails
   module ModelExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
-
-    included do
-      metadata[:type] = :model
-    end
   end
 end

data/lib/rspec/rails/example/request_example_group.rb

@@ -13,8 +13,6 @@ module RSpec::Rails
     end
 
     included do
-      metadata[:type] = :request
-
       before do
         @routes = ::Rails.application.routes
       end

data/lib/rspec/rails/example/routing_example_group.rb

@@ -30,8 +30,6 @@ module RSpec::Rails
     end
 
     included do
-      metadata[:type] = :routing
-
       before do
         self.routes = ::Rails.application.routes
       end

data/lib/rspec/rails/example/view_example_group.rb

@@ -10,7 +10,7 @@ module RSpec::Rails
 
     module ClassMethods
       def _default_helper
-        base = metadata[:example_group][:description].split('/')[0..-2].join('/')
+        base = metadata[:description].split('/')[0..-2].join('/')
         (base.camelize + 'Helper').constantize if base
       rescue NameError
         nil
@@ -142,7 +142,6 @@ module RSpec::Rails
     included do
       include ExampleMethods
 
-      metadata[:type] = :view
       helper(*_default_helpers)
 
       before do

data/lib/rspec/rails/extensions.rb

@@ -1,2 +1 @@
-require 'rspec/rails/extensions/active_record/base'
 require 'rspec/rails/extensions/active_record/proxy'

data/lib/rspec/rails/fixture_support.rb

@@ -26,14 +26,6 @@ module RSpec
           fixtures RSpec.configuration.global_fixtures if RSpec.configuration.global_fixtures
         end
       end
-
-      RSpec.configure do |c|
-        c.include RSpec::Rails::FixtureSupport
-        c.add_setting :use_transactional_fixtures, :alias_with => :use_transactional_examples
-        c.add_setting :use_instantiated_fixtures
-        c.add_setting :global_fixtures
-        c.add_setting :fixture_path
-      end
     end
   end
 end

data/lib/rspec/rails/matchers.rb

@@ -24,3 +24,4 @@ require 'rspec/rails/matchers/be_new_record'
 require 'rspec/rails/matchers/be_a_new'
 require 'rspec/rails/matchers/relation_match_array'
 require 'rspec/rails/matchers/be_valid'
+require 'rspec/rails/matchers/have_http_status'

data/lib/rspec/rails/matchers/have_http_status.rb

@@ -0,0 +1,355 @@
+# The following code inspired and modified from Rails' `assert_response`:
+#
+#   https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/testing/assertions/response.rb#L22-L38
+#
+# Thank you to all the Rails devs who did the heavy lifting on this!
+
+module RSpec::Rails::Matchers
+  # Namespace for various implementations of `have_http_status`.
+  #
+  # @api private
+  module HaveHttpStatus
+    # Instantiates an instance of the proper matcher based on the provided
+    # `target`.
+    #
+    # @param target [Object] expected http status or code
+    # @return response matcher instance
+    def self.matcher_for_status(target)
+      if GenericStatus.valid_statuses.include?(target)
+        GenericStatus.new(target)
+      elsif Symbol === target
+        SymbolicStatus.new(target)
+      else
+        NumericCode.new(target)
+      end
+    end
+
+    # @api private
+    # Conversion function to coerce the provided object into an
+    # `ActionDispatch::TestResponse`.
+    #
+    # @param obj [Object] object to convert to a response
+    # @return [ActionDispatch::TestResponse]
+    def as_test_response(obj)
+      if ::ActionDispatch::Response === obj
+        ::ActionDispatch::TestResponse.from_response(obj)
+      elsif ::ActionDispatch::TestResponse === obj
+        obj
+      elsif obj.respond_to?(:status_code) && obj.respond_to?(:response_headers)
+        # Acts As Capybara Session
+        # Hack to support `Capybara::Session` without having to load Capybara or
+        # catch `NameError`s for the undefined constants
+        ::ActionDispatch::TestResponse.new.tap{ |resp|
+          resp.status  = obj.status_code
+          resp.headers = obj.response_headers
+          resp.body    = obj.body
+        }
+      else
+        raise TypeError, "Invalid response type: #{obj}"
+      end
+    end
+    module_function :as_test_response
+
+    # @return [String, nil] a formatted failure message if `@invalid_response`
+    #   is present, `nil` otherwise
+    def invalid_response_type_message
+      if @invalid_response
+        "expected a response object, but an instance of " +
+        "#{@invalid_response.class} was received"
+      end
+    end
+
+    # @api private
+    # Provides an implementation for `have_http_status` matching against
+    # numeric http status codes.
+    #
+    # Not intended to be instantiated directly.
+    #
+    # @example
+    #   expect(response).to have_http_status(404)
+    #
+    # @see RSpec::Rails::Matchers.have_http_status
+    class NumericCode < RSpec::Matchers::BuiltIn::BaseMatcher
+      include HaveHttpStatus
+
+      def initialize(code)
+        @expected = code.to_i
+        @actual = nil
+        @invalid_response = nil
+      end
+
+      # @param [Object] response object providing an http code to match
+      # @return [Boolean] `true` if the numeric code matched the `response` code
+      def matches?(response)
+        test_response = as_test_response(response)
+        @actual = test_response.response_code
+        expected == @actual
+      rescue TypeError => _ignored
+        @invalid_response = response
+        false
+      end
+
+      # @return [String]
+      def description
+        "respond with numeric status code #{expected}"
+      end
+
+      # @return [String] explaining why the match failed
+      def failure_message
+        invalid_response_type_message ||
+        "expected the response to have status code #{expected.inspect}" +
+          " but it was #{actual.inspect}"
+      end
+
+      # @return [String] explaining why the match failed
+      def failure_message_when_negated
+        invalid_response_type_message ||
+        "expected the response not to have status code #{expected.inspect}" +
+          " but it did"
+      end
+    end
+
+    # @api private
+    # Provides an implementation for `have_http_status` matching against
+    # Rack symbol http status codes.
+    #
+    # Not intended to be instantiated directly.
+    #
+    # @example
+    #   expect(response).to have_http_status(:created)
+    #
+    # @see RSpec::Rails::Matchers.have_http_status
+    # @see https://github.com/rack/rack/blob/master/lib/rack/utils.rb `Rack::Utils::SYMBOL_TO_STATUS_CODE`
+    class SymbolicStatus < RSpec::Matchers::BuiltIn::BaseMatcher
+      include HaveHttpStatus
+
+      def initialize(status)
+        @expected_status = status
+        @actual = nil
+        @invalid_response = nil
+        unless set_expected_code!
+          raise ArgumentError, "Invalid HTTP status: #{status.inspect}"
+        end
+      end
+
+      # @param [Object] response object providing an http code to match
+      # @return [Boolean] `true` if Rack's associated numeric HTTP code matched
+      #   the `response` code
+      def matches?(response)
+        test_response = as_test_response(response)
+        @actual = test_response.response_code
+        expected == @actual
+      rescue TypeError => _ignored
+        @invalid_response = response
+        false
+      end
+
+      # @return [String]
+      def description
+        "respond with status code #{pp_expected}"
+      end
+
+      # @return [String] explaining why the match failed
+      def failure_message
+        invalid_response_type_message ||
+        "expected the response to have status code #{pp_expected} but it" +
+          " was #{pp_actual}"
+      end
+
+      # @return [String] explaining why the match failed
+      def failure_message_when_negated
+        invalid_response_type_message ||
+        "expected the response not to have status code #{pp_expected} " +
+          "but it did"
+      end
+
+      # The initialized expected status symbol
+      attr_reader :expected_status
+      private :expected_status
+
+    private
+
+      # @return [Symbol] representing the actual http numeric code
+      def actual_status
+        if actual
+          @actual_status ||= compute_status_from(actual)
+        end
+      end
+
+      # Reverse lookup of the Rack status code symbol based on the numeric http
+      # code
+      #
+      # @param code [Fixnum] http status code to look up
+      # @return [Symbol] representing the http numeric code
+      def compute_status_from(code)
+        status, _ = Rack::Utils::SYMBOL_TO_STATUS_CODE.find{ |_, c| c == code }
+        status
+      end
+
+      # @return [String] pretty format the actual response status
+      def pp_actual
+        pp_status(actual_status, actual)
+      end
+
+      # @return [String] pretty format the expected status and associated code
+      def pp_expected
+        pp_status(expected_status, expected)
+      end
+
+      # @return [String] pretty format the actual response status
+      def pp_status(status, code)
+        if status
+          "#{status.inspect} (#{code})"
+        else
+          code.to_s
+        end
+      end
+
+      # Sets `expected` to the numeric http code based on the Rack
+      # `expected_status` status
+      #
+      # @see Rack::Utils::SYMBOL_TO_STATUS_CODE
+      # @return [nil] if an associated code could not be found
+      def set_expected_code!
+        @expected ||= Rack::Utils::SYMBOL_TO_STATUS_CODE[expected_status]
+      end
+    end
+
+    # @api private
+    # Provides an implementation for `have_http_status` matching against
+    # `ActionDispatch::TestResponse` http status category queries.
+    #
+    # Not intended to be instantiated directly.
+    #
+    # @example
+    #   expect(response).to have_http_status(:success)
+    #   expect(response).to have_http_status(:error)
+    #   expect(response).to have_http_status(:missing)
+    #   expect(response).to have_http_status(:redirect)
+    #
+    # @see RSpec::Rails::Matchers.have_http_status
+    # @see ActionDispatch::TestResponse
+    class GenericStatus < RSpec::Matchers::BuiltIn::BaseMatcher
+      include HaveHttpStatus
+
+      # @return [Array<Symbol>] of status codes which represent a HTTP status
+      #   code "group"
+      # @see https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/testing/test_response.rb `ActionDispatch::TestResponse`
+      def self.valid_statuses
+        [:error, :success, :missing, :redirect]
+      end
+
+      def initialize(type)
+        unless self.class.valid_statuses.include?(type)
+          raise ArgumentError, "Invalid generic HTTP status: #{type.inspect}"
+        end
+        @expected = type
+        @actual = nil
+        @invalid_response = nil
+      end
+
+      # @return [Boolean] `true` if Rack's associated numeric HTTP code matched
+      #   the `response` code
+      def matches?(response)
+        test_response = as_test_response(response)
+        @actual = test_response.response_code
+        test_response.send("#{expected}?")
+      rescue TypeError => _ignored
+        @invalid_response = response
+        false
+      end
+
+      # @return [String]
+      def description
+        "respond with #{type_message}"
+      end
+
+      # @return [String] explaining why the match failed
+      def failure_message
+        invalid_response_type_message ||
+        "expected the response to have #{type_message} but it was #{actual}"
+      end
+
+      # @return [String] explaining why the match failed
+      def failure_message_when_negated
+        invalid_response_type_message ||
+        "expected the response not to have #{type_message} but it was #{actual}"
+      end
+
+    private
+
+      # @return [String] formating the expected status and associated code(s)
+      def type_message
+        @type_message ||= (expected == :error ? "an error" : "a #{expected}") +
+          " status code (#{type_codes})"
+      end
+
+      # @return [String] formatting the associated code(s) for the various
+      #   status code "groups"
+      # @see https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/testing/test_response.rb `ActionDispatch::TestResponse`
+      # @see https://github.com/rack/rack/blob/master/lib/rack/response.rb `Rack::Response`
+      def type_codes
+        # At the time of this commit the most recent version of
+        # `ActionDispatch::TestResponse` defines the following aliases:
+        #
+        #     alias_method :success?,  :successful?
+        #     alias_method :missing?,  :not_found?
+        #     alias_method :redirect?, :redirection?
+        #     alias_method :error?,    :server_error?
+        #
+        # It's parent `ActionDispatch::Response` includes
+        # `Rack::Response::Helpers` which defines the aliased methods as:
+        #
+        #     def successful?;   status >= 200 && status < 300; end
+        #     def redirection?;  status >= 300 && status < 400; end
+        #     def server_error?; status >= 500 && status < 600; end
+        #     def not_found?;    status == 404;                 end
+        #
+        # @see https://github.com/rails/rails/blob/ca200378/actionpack/lib/action_dispatch/testing/test_response.rb#L17-L27
+        # @see https://github.com/rails/rails/blob/ca200378/actionpack/lib/action_dispatch/http/response.rb#L74
+        # @see https://github.com/rack/rack/blob/ce4a3959/lib/rack/response.rb#L119-L122
+        @type_codes ||= case expected
+                        when :error
+                          "5xx"
+                        when :success
+                          "2xx"
+                        when :missing
+                          "404"
+                        when :redirect
+                          "3xx"
+                        end
+      end
+    end
+  end
+
+  # @api public
+  # Passes if `response` has a matching HTTP status code.
+  #
+  # The following symbolic status codes are allowed:
+  #
+  # - `Rack::Utils::SYMBOL_TO_STATUS_CODE`
+  # - One of the defined `ActionDispatch::TestResponse` aliases:
+  #   - `:error`
+  #   - `:missing`
+  #   - `:redirect`
+  #   - `:success`
+  #
+  # @example Accepts numeric and symbol statuses
+  #   expect(response).to have_http_status(404)
+  #   expect(response).to have_http_status(:created)
+  #   expect(response).to have_http_status(:success)
+  #   expect(response).to have_http_status(:error)
+  #   expect(response).to have_http_status(:missing)
+  #   expect(response).to have_http_status(:redirect)
+  #
+  # @example Works with standard `response` objects and Capybara's `page`
+  #   expect(response).to have_http_status(404)
+  #   expect(page).to     have_http_status(:created)
+  #
+  # @see https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/testing/test_response.rb `ActionDispatch::TestResponse`
+  # @see https://github.com/rack/rack/blob/master/lib/rack/utils.rb `Rack::Utils::SYMBOL_TO_STATUS_CODE`
+  def have_http_status(target)
+    raise ArgumentError, "Invalid HTTP status: nil" unless target
+    HaveHttpStatus.matcher_for_status(target)
+  end
+end