rspec-rails 1.3.2 → 6.1.2

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

@@ -0,0 +1,217 @@
+module RSpec
+  module Rails
+    # @private
+    ControllerAssertionDelegator = RSpec::Rails::AssertionDelegator.new(
+      ActionDispatch::Assertions::RoutingAssertions
+    )
+
+    # @api public
+    # Container module for controller spec functionality.
+    module ControllerExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include ActionController::TestCase::Behavior
+      include RSpec::Rails::ViewRendering
+      include RSpec::Rails::Matchers::RedirectTo
+      include RSpec::Rails::Matchers::RenderTemplate
+      include RSpec::Rails::Matchers::RoutingMatchers
+      include ControllerAssertionDelegator
+
+      # Class-level DSL for controller specs.
+      module ClassMethods
+        # @private
+        def controller_class
+          described_class
+        end
+
+        # Supports a simple DSL for specifying behavior of ApplicationController.
+        # Creates an anonymous subclass of ApplicationController and evals the
+        # `body` in that context. Also sets up implicit routes for this
+        # controller, that are separate from those defined in "config/routes.rb".
+        #
+        # @note Due to Ruby 1.8 scoping rules in anonymous subclasses, constants
+        #   defined in `ApplicationController` must be fully qualified (e.g.
+        #   `ApplicationController::AccessDenied`) in the block passed to the
+        #   `controller` method. Any instance methods, filters, etc, that are
+        #   defined in `ApplicationController`, however, are accessible from
+        #   within the block.
+        #
+        # @example
+        #     describe ApplicationController do
+        #       controller do
+        #         def index
+        #           raise ApplicationController::AccessDenied
+        #         end
+        #       end
+        #
+        #       describe "handling AccessDenied exceptions" do
+        #         it "redirects to the /401.html page" do
+        #           get :index
+        #           response.should redirect_to("/401.html")
+        #         end
+        #       end
+        #     end
+        #
+        # If you would like to spec a subclass of ApplicationController, call
+        # controller like so:
+        #
+        #     controller(ApplicationControllerSubclass) do
+        #       # ....
+        #     end
+        def controller(base_class = nil, &body)
+          if RSpec.configuration.infer_base_class_for_anonymous_controllers?
+            base_class ||= controller_class
+          end
+          base_class ||= defined?(ApplicationController) ? ApplicationController : ActionController::Base
+
+          new_controller_class = Class.new(base_class) do
+            def self.name
+              root_controller = defined?(ApplicationController) ? ApplicationController : ActionController::Base
+              if superclass == root_controller || superclass.abstract?
+                "AnonymousController"
+              else
+                superclass.name
+              end
+            end
+          end
+          new_controller_class.class_exec(&body)
+          (class << self; self; end).__send__(:define_method, :controller_class) { new_controller_class }
+
+          before do
+            @orig_routes = routes
+            resource_name = if @controller.respond_to?(:controller_name)
+                              @controller.controller_name.to_sym
+                            else
+                              :anonymous
+                            end
+            resource_path = if @controller.respond_to?(:controller_path)
+                              @controller.controller_path
+                            else
+                              resource_name.to_s
+                            end
+            resource_module = resource_path.rpartition('/').first.presence
+            resource_as = 'anonymous_' + resource_path.tr('/', '_')
+            self.routes = ActionDispatch::Routing::RouteSet.new.tap do |r|
+              r.draw do
+                resources resource_name,
+                          as: resource_as,
+                          module: resource_module,
+                          path: resource_path
+              end
+            end
+          end
+
+          after do
+            self.routes  = @orig_routes
+            @orig_routes = nil
+          end
+        end
+
+        # Specifies the routeset that will be used for the example group. This
+        # is most useful when testing Rails engines.
+        #
+        # @example
+        #     describe MyEngine::PostsController do
+        #       routes { MyEngine::Engine.routes }
+        #
+        #       # ...
+        #     end
+        def routes
+          before do
+            self.routes = yield
+          end
+        end
+      end
+
+      # @!attribute [r]
+      # Returns the controller object instance under test.
+      attr_reader :controller
+
+      # @!attribute [r]
+      # Returns the Rails routes used for the spec.
+      attr_reader :routes
+
+      # @private
+      #
+      # RSpec Rails uses this to make Rails routes easily available to specs.
+      def routes=(routes)
+        @routes = routes
+        assertion_instance.instance_variable_set(:@routes, routes)
+      end
+
+      # @private
+      module BypassRescue
+        def rescue_with_handler(exception)
+          raise exception
+        end
+      end
+
+      # Extends the controller with a module that overrides
+      # `rescue_with_handler` to raise the exception passed to it. Use this to
+      # specify that an action _should_ raise an exception given appropriate
+      # conditions.
+      #
+      # @example
+      #     describe ProfilesController do
+      #       it "raises a 403 when a non-admin user tries to view another user's profile" do
+      #         profile = create_profile
+      #         login_as profile.user
+      #
+      #         expect do
+      #           bypass_rescue
+      #           get :show, id: profile.id + 1
+      #         end.to raise_error(/403 Forbidden/)
+      #       end
+      #     end
+      def bypass_rescue
+        controller.extend(BypassRescue)
+      end
+
+      # If method is a named_route, delegates to the RouteSet associated with
+      # this controller.
+      def method_missing(method, *args, &block)
+        if route_available?(method)
+          controller.send(method, *args, &block)
+        else
+          super
+        end
+      end
+      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
+
+      included do
+        subject { controller }
+
+        before do
+          self.routes = ::Rails.application.routes
+        end
+
+        around do |ex|
+          previous_allow_forgery_protection_value = ActionController::Base.allow_forgery_protection
+          begin
+            ActionController::Base.allow_forgery_protection = false
+            ex.call
+          ensure
+            ActionController::Base.allow_forgery_protection = previous_allow_forgery_protection_value
+          end
+        end
+      end
+
+    private
+
+      def route_available?(method)
+        (defined?(@routes) && route_defined?(routes, method)) ||
+          (defined?(@orig_routes) && route_defined?(@orig_routes, method))
+      end
+
+      def route_defined?(routes, method)
+        return false if routes.nil?
+
+        if routes.named_routes.respond_to?(:route_defined?)
+          routes.named_routes.route_defined?(method)
+        else
+          routes.named_routes.helpers.include?(method)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container module for routing spec functionality.
+    module FeatureExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+
+      # Default host to be used in Rails route helpers if none is specified.
+      DEFAULT_HOST = "www.example.com"
+
+      included do
+        app = ::Rails.application
+        if app.respond_to?(:routes)
+          include app.routes.url_helpers     if app.routes.respond_to?(:url_helpers)
+          include app.routes.mounted_helpers if app.routes.respond_to?(:mounted_helpers)
+
+          if respond_to?(:default_url_options)
+            default_url_options[:host] ||= ::RSpec::Rails::FeatureExampleGroup::DEFAULT_HOST
+          end
+        end
+      end
+
+      # Shim to check for presence of Capybara. Will delegate if present, raise
+      # if not. We assume here that in most cases `visit` will be the first
+      # Capybara method called in a spec.
+      def visit(*)
+        if defined?(super)
+          super
+        else
+          raise "Capybara not loaded, please add it to your Gemfile:\n\ngem \"capybara\""
+        end
+      end
+    end
+  end
+end
+
+unless RSpec.respond_to?(:feature)
+  opts = {
+    capybara_feature: true,
+    type: :feature,
+    skip: <<-EOT.squish
+      Feature specs require the Capybara (https://github.com/teamcapybara/capybara)
+      gem, version 2.13.0 or later.
+    EOT
+  }
+
+  RSpec.configure do |c|
+    c.alias_example_group_to :feature, opts
+    c.alias_example_to :scenario
+    c.alias_example_to :xscenario, skip: 'Temporarily skipped with xscenario'
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'rspec/rails/view_assigns'
+
+module RSpec
+  module Rails
+    # @api public
+    # Container module for helper specs.
+    module HelperExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include ActionView::TestCase::Behavior
+      include RSpec::Rails::ViewAssigns
+
+      # @private
+      module ClassMethods
+        def determine_constant_from_test_name(_ignore)
+          described_class if yield(described_class)
+        end
+      end
+
+      # Returns an instance of ActionView::Base with the helper being specified
+      # mixed in, along with any of the built-in rails helpers.
+      def helper
+        _view.tap do |v|
+          v.extend(ApplicationHelper) if defined?(ApplicationHelper)
+          v.assign(view_assigns)
+        end
+      end
+
+    private
+
+      def _controller_path(example)
+        example.example_group.described_class.to_s.sub(/Helper/, '').underscore
+      end
+
+      included do
+        before do |example|
+          controller.controller_path = _controller_path(example)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container module for job spec functionality. It is only available if
+    # ActiveJob has been loaded before it.
+    module JobExampleGroup
+      # This blank module is only necessary for YARD processing. It doesn't
+      # handle the conditional `defined?` check below very well.
+    end
+  end
+end
+
+if defined?(ActiveJob)
+  module RSpec
+    module Rails
+      # Container module for job spec functionality.
+      module JobExampleGroup
+        extend ActiveSupport::Concern
+        include RSpec::Rails::RailsExampleGroup
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container module for mailbox spec functionality.
+    module MailboxExampleGroup
+      extend ActiveSupport::Concern
+
+      if RSpec::Rails::FeatureCheck.has_action_mailbox?
+        require 'action_mailbox/test_helper'
+        extend ::ActionMailbox::TestHelper
+
+        # @private
+        def self.create_inbound_email(arg)
+          case arg
+          when Hash
+            create_inbound_email_from_mail(**arg)
+          else
+            create_inbound_email_from_source(arg.to_s)
+          end
+        end
+      else
+        def self.create_inbound_email(_arg)
+          raise "Could not load ActionMailer::TestHelper"
+        end
+      end
+
+      class_methods do
+        # @private
+        def mailbox_class
+          described_class
+        end
+      end
+
+      included do
+        subject { described_class }
+      end
+
+      # @api public
+      # Passes if the inbound email was delivered
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_been_delivered
+      def have_been_delivered
+        satisfy('have been delivered', &:delivered?)
+      end
+
+      # @api public
+      # Passes if the inbound email bounced during processing
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_bounced
+      def have_bounced
+        satisfy('have bounced', &:bounced?)
+      end
+
+      # @api public
+      # Passes if the inbound email failed to process
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_failed
+      def have_failed
+        satisfy('have failed', &:failed?)
+      end
+
+      # Process an inbound email message directly, bypassing routing.
+      #
+      # @param message [Hash, Mail::Message] a mail message or hash of
+      #   attributes used to build one
+      # @return [ActionMailbox::InboundMessage]
+      def process(message)
+        MailboxExampleGroup.create_inbound_email(message).tap do |mail|
+          self.class.mailbox_class.receive(mail)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container module for mailer spec functionality. It is only available if
+    # ActionMailer has been loaded before it.
+    module MailerExampleGroup
+      # This blank module is only necessary for YARD processing. It doesn't
+      # handle the conditional `defined?` check below very well.
+    end
+  end
+end
+
+if defined?(ActionMailer)
+  module RSpec
+    module Rails
+      # Container module for mailer spec functionality.
+      module MailerExampleGroup
+        extend ActiveSupport::Concern
+        include RSpec::Rails::RailsExampleGroup
+        include ActionMailer::TestCase::Behavior
+
+        included do
+          include ::Rails.application.routes.url_helpers
+          options = ::Rails.configuration.action_mailer.default_url_options || {}
+          options.each { |key, value| default_url_options[key] = value }
+        end
+
+        # Class-level DSL for mailer specs.
+        module ClassMethods
+          # Alias for `described_class`.
+          def mailer_class
+            described_class
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container class for model spec functionality. Does not provide anything
+    # special over the common RailsExampleGroup currently.
+    module ModelExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# Temporary workaround to resolve circular dependency between rspec-rails' spec
+# suite and ammeter.
+require 'rspec/rails/matchers'
+
+if ::Rails::VERSION::MAJOR >= 7
+  require 'active_support/execution_context/test_helper'
+end
+
+module RSpec
+  module Rails
+    # @api public
+    # Common rails example functionality.
+    module RailsExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::SetupAndTeardownAdapter
+      include RSpec::Rails::MinitestLifecycleAdapter
+      include RSpec::Rails::MinitestAssertionAdapter
+      include RSpec::Rails::FixtureSupport
+      if ::Rails::VERSION::MAJOR >= 7
+        include RSpec::Rails::TaggedLoggingAdapter
+        include ActiveSupport::ExecutionContext::TestHelper
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container class for request spec functionality.
+    module RequestExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include ActionDispatch::Integration::Runner
+      include ActionDispatch::Assertions
+      include RSpec::Rails::Matchers::RedirectTo
+      include RSpec::Rails::Matchers::RenderTemplate
+      include ActionController::TemplateAssertions
+      include ActionDispatch::IntegrationTest::Behavior
+
+      # Delegates to `Rails.application`.
+      def app
+        ::Rails.application
+      end
+
+      included do
+        before do
+          @routes = ::Rails.application.routes
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module RSpec
+  module Rails
+    # @private
+    RoutingAssertionDelegator =  RSpec::Rails::AssertionDelegator.new(
+      ActionDispatch::Assertions::RoutingAssertions
+    )
+
+    # @api public
+    # Container module for routing spec functionality.
+    module RoutingExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include RSpec::Rails::Matchers::RoutingMatchers
+      include RSpec::Rails::Matchers::RoutingMatchers::RouteHelpers
+      include RSpec::Rails::RoutingAssertionDelegator
+
+      # Class-level DSL for route specs.
+      module ClassMethods
+        # Specifies the routeset that will be used for the example group. This
+        # is most useful when testing Rails engines.
+        #
+        # @example
+        #     describe MyEngine::PostsController do
+        #       routes { MyEngine::Engine.routes }
+        #
+        #       it "routes posts#index" do
+        #         expect(:get => "/posts").to
+        #           route_to(:controller => "my_engine/posts", :action => "index")
+        #       end
+        #     end
+        def routes
+          before do
+            self.routes = yield
+          end
+        end
+      end
+
+      included do
+        before do
+          self.routes = ::Rails.application.routes
+        end
+      end
+
+      # @!attribute [r]
+      # @private
+      attr_reader :routes
+
+      # @private
+      def routes=(routes)
+        @routes = routes
+        assertion_instance.instance_variable_set(:@routes, routes)
+      end
+
+    private
+
+      def method_missing(m, *args, &block)
+        routes.url_helpers.respond_to?(m) ? routes.url_helpers.send(m, *args) : super
+      end
+    end
+  end
+end