rspec-rails 4.0.0.beta2 → 4.0.0.beta3

data/README.md

@@ -12,7 +12,7 @@ Use **[`rspec-rails` 1.x][]** for Rails 2.x.
 
 [Build Status]: https://secure.travis-ci.org/rspec/rspec-rails.svg?branch=master
 [travis-ci]: https://travis-ci.org/rspec/rspec-rails
-[Code Climate]: https://img.shields.io/codeclimate/github/rspec/rspec-rails.svg
+[Code Climate]: https://codeclimate.com/github/rspec/rspec-rails.svg
 [code-climate]: https://codeclimate.com/github/rspec/rspec-rails
 [Gem Version]: https://badge.fury.io/rb/rspec-rails.svg
 [gem-version]: https://badge.fury.io/rb/rspec-rails

data/lib/generators/rspec/channel/channel_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class ChannelGenerator < Base
+      def create_channel_spec
+        template 'channel_spec.rb.erb', File.join('spec/channels', class_path, "#{file_name}_channel_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/channel/templates/channel_spec.rb.erb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Channel, <%= type_metatag(:channel) %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/generators/rspec/controller/controller_generator.rb

@@ -7,8 +7,9 @@ module Rspec
       argument :actions, :type => :array, :default => [], :banner => "action action"
 
       class_option :template_engine, :desc => "Template engine to generate view files"
-      class_option :controller_specs, :type => :boolean, :default => true
-      class_option :view_specs,       :type => :boolean, :default => true
+      class_option :controller_specs, :type => :boolean, :default => true, :desc => "Generate controller specs"
+      class_option :view_specs,       :type => :boolean, :default => true, :desc => "Generate view specs"
+      class_option :routing_specs,    :type => :boolean, :default => false, :desc => "Generate routing specs"
 
       def generate_controller_spec
         return unless options[:controller_specs]
@@ -29,6 +30,14 @@ module Rspec
                    File.join("spec", "views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
         end
       end
+
+      def generate_routing_spec
+        return if actions.empty?
+        return unless options[:routing_specs]
+
+        template 'routing_spec.rb',
+                 File.join('spec/routing', class_path, "#{file_name}_routing_spec.rb")
+      end
     end
   end
 end

data/lib/generators/rspec/controller/templates/routing_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe '<%= class_name %>Controller', <%= type_metatag(:routing) %> do
+  describe 'routing' do
+<% for action in actions -%>
+    it 'routes to #<%= action %>' do
+      expect(:get => "/<%= class_name.underscore %>/<%= action %>").to route_to("<%= class_name.underscore %>#<%= action  %>")
+    end
+<% end -%>
+  end
+end
+<% end -%>

data/lib/generators/rspec/mailbox/mailbox_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class MailboxGenerator < Base
+      def create_mailbox_spec
+        template('mailbox_spec.rb.erb',
+                 File.join('spec/mailboxes', class_path, "#{file_name}_mailbox_spec.rb")
+        )
+      end
+    end
+  end
+end

data/lib/generators/rspec/mailbox/templates/mailbox_spec.rb.erb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Mailbox, <%= type_metatag(:mailbox) %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/generators/rspec/model/templates/fixtures.yml

@@ -1,4 +1,4 @@
-# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
 <% unless attributes.empty? -%>
 one:

data/lib/rspec/rails/configuration.rb

@@ -25,6 +25,7 @@ module RSpec
     #
     # @api private
     DIRECTORY_MAPPINGS = {
+      :channel    => %w[spec channels],
       :controller => %w[spec controllers],
       :helper     => %w[spec helpers],
       :job        => %w[spec jobs],
@@ -34,7 +35,8 @@ module RSpec
       :routing    => %w[spec routing],
       :view       => %w[spec views],
       :feature    => %w[spec features],
-      :system     => %w[spec system]
+      :system     => %w[spec system],
+      :mailbox    => %w[spec mailboxes]
     }
 
     # Sets up the different example group modules for the different spec types
@@ -53,7 +55,7 @@ module RSpec
     end
 
     # @private
-    # rubocop:disable Style/MethodLength
+    # rubocop:disable Metrics/MethodLength
     def self.initialize_configuration(config)
       config.backtrace_exclusion_patterns << /vendor\//
       config.backtrace_exclusion_patterns << %r{lib/rspec/rails}
@@ -133,15 +135,23 @@ module RSpec
         end
       end
 
-      if defined?(ActionMailer)
+      if RSpec::Rails::FeatureCheck.has_action_mailer?
         config.include RSpec::Rails::MailerExampleGroup, :type => :mailer
       end
 
-      if defined?(ActiveJob)
+      if RSpec::Rails::FeatureCheck.has_active_job?
         config.include RSpec::Rails::JobExampleGroup, :type => :job
       end
+
+      if RSpec::Rails::FeatureCheck.has_action_cable_testing?
+        config.include RSpec::Rails::ChannelExampleGroup, :type => :channel
+      end
+
+      if RSpec::Rails::FeatureCheck.has_action_mailbox?
+        config.include RSpec::Rails::MailboxExampleGroup, :type => :mailbox
+      end
     end
-    # rubocop:enable Style/MethodLength
+    # rubocop:enable Metrics/MethodLength
 
     initialize_configuration RSpec.configuration
   end

data/lib/rspec/rails/example.rb

@@ -9,3 +9,5 @@ require 'rspec/rails/example/model_example_group'
 require 'rspec/rails/example/job_example_group'
 require 'rspec/rails/example/feature_example_group'
 require 'rspec/rails/example/system_example_group'
+require 'rspec/rails/example/channel_example_group'
+require 'rspec/rails/example/mailbox_example_group'

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

@@ -0,0 +1,93 @@
+require "rspec/rails/matchers/action_cable/have_streams"
+
+module RSpec
+  module Rails
+    # @api public
+    # Container module for channel spec functionality. It is only available if
+    # ActionCable has been loaded before it.
+    module ChannelExampleGroup
+      # @private
+      module ClassMethods
+        # These blank modules are only necessary for YARD processing. It doesn't
+        # handle the conditional check below very well and reports undocumented objects.
+      end
+    end
+  end
+end
+
+if RSpec::Rails::FeatureCheck.has_action_cable_testing?
+  module RSpec
+    module Rails
+      # @api public
+      # Container module for channel spec functionality.
+      module ChannelExampleGroup
+        extend ActiveSupport::Concern
+        include RSpec::Rails::RailsExampleGroup
+        include ActionCable::Connection::TestCase::Behavior
+        include ActionCable::Channel::TestCase::Behavior
+
+        # Class-level DSL for channel specs.
+        module ClassMethods
+          # @private
+          def channel_class
+            (_channel_class || described_class).tap do |klass|
+              next if klass <= ::ActionCable::Channel::Base
+
+              raise "Described class is not a channel class.\n" \
+                    "Specify the channel class in the `describe` statement "\
+                    "or set it manually using `tests MyChannelClass`"
+            end
+          end
+
+          # @private
+          def connection_class
+            (_connection_class || described_class).tap do |klass|
+              next if klass <= ::ActionCable::Connection::Base
+
+              raise "Described class is not a connection class.\n" \
+                    "Specify the connection class in the `describe` statement "\
+                    "or set it manually using `tests MyConnectionClass`"
+            end
+          end
+        end
+
+        # Checks that the connection attempt has been rejected.
+        #
+        # @example
+        #     expect { connect }.to have_rejected_connection
+        def have_rejected_connection
+          raise_error(::ActionCable::Connection::Authorization::UnauthorizedError)
+        end
+
+        # Checks that the subscription is subscribed to at least one stream.
+        #
+        # @example
+        #     expect(subscription).to have_streams
+        def have_streams
+          check_subscribed!
+
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new
+        end
+
+        # Checks that the channel has been subscribed to the given stream
+        #
+        # @example
+        #     expect(subscription).to have_stream_from("chat_1")
+        def have_stream_from(stream)
+          check_subscribed!
+
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new(stream)
+        end
+
+        # Checks that the channel has been subscribed to a stream for the given model
+        #
+        # @example
+        #     expect(subscription).to have_stream_for(user)
+        def have_stream_for(object)
+          check_subscribed!
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new(broadcasting_for(object))
+        end
+      end
+    end
+  end
+end

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

@@ -40,7 +40,7 @@ unless RSpec.respond_to?(:feature)
     :capybara_feature => true,
     :type => :feature,
     :skip => <<-EOT.squish
-      Feature specs require the Capybara (http://github.com/jnicklas/capybara)
+      Feature specs require the Capybara (https://github.com/jnicklas/capybara)
       gem, version 2.2.0 or later. We recommend version 2.4.0 or later to avoid
       some deprecation warnings and have support for
       `config.expose_dsl_globally = false`.

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 [ActionMaibox::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

@@ -22,7 +22,7 @@ if defined?(ActionMailer)
         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 } if options
+          options&.each { |key, value| default_url_options[key] = value }
         end
 
         # Class-level DSL for mailer specs.

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

@@ -15,7 +15,11 @@ module RSpec
       CHARS_TO_TRANSLATE = ['/', '.', ':', ',', "'", '"', " "].freeze
 
       # @private
-      module BlowAwayAfterTeardownHook
+      module BlowAwayTeardownHooks
+        # @private
+        def before_teardown
+        end
+
         # @private
         def after_teardown
         end
@@ -59,13 +63,18 @@ module RSpec
           """.gsub(/\s+/, ' ').strip
         end
 
+        if ::Rails::VERSION::STRING >= '6.0'
+          original_before_teardown =
+            ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:before_teardown)
+        end
+
         original_after_teardown =
           ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:after_teardown)
 
         other.include ActionDispatch::IntegrationTest::Behavior
         other.include ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown
         other.include ::ActionDispatch::SystemTesting::TestHelpers::ScreenshotHelper
-        other.include BlowAwayAfterTeardownHook
+        other.include BlowAwayTeardownHooks
 
         attr_reader :driver
 
@@ -93,6 +102,9 @@ module RSpec
           orig_stdout = $stdout
           $stdout = StringIO.new
           begin
+            if ::Rails::VERSION::STRING >= '6.0'
+              original_before_teardown.bind(self).call
+            end
             original_after_teardown.bind(self).call
           ensure
             myio = $stdout

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

@@ -129,14 +129,35 @@ module RSpec
 
         def _default_render_options
           if ::Rails::VERSION::STRING >= '3.2'
-            # pluck the handler, format, and locale out of, eg, posts/index.de.html.haml
-            template, *components   = _default_file_to_render.split('.')
-            handler, format, locale = *components.reverse
-
-            render_options = { :template => template }
-            render_options[:handlers] = [handler] if handler
-            render_options[:formats] = [format.to_sym] if format
-            render_options[:locales] = [locale] if locale
+            formats = if ActionView::Template::Types.respond_to?(:symbols)
+                        ActionView::Template::Types.symbols
+                      else
+                        [:html, :text, :js, :css, :xml, :json].map(&:to_s)
+                      end.map { |x| Regexp.escape(x) }.join("|")
+
+            handlers = ActionView::Template::Handlers.extensions.map { |x| Regexp.escape(x) }.join("|")
+            locales = "[a-z]{2}(?:-[A-Z]{2})?"
+            variants = "[^.]*"
+            path_regex = %r{
+            \A
+            (?<template>.*?)
+            (?:\.(?<locale>#{locales}))??
+              (?:\.(?<format>#{formats}))??
+              (?:\+(?<variant>#{variants}))??
+              (?:\.(?<handler>#{handlers}))?
+              \z
+            }x
+
+            # This regex should always find a match.
+            # Worst case, everything will be nil, and :template will just be
+            # the original string.
+            match = path_regex.match(_default_file_to_render)
+
+            render_options = { :template => match[:template] }
+            render_options[:handlers] = [match[:handler]] if match[:handler]
+            render_options[:formats] = [match[:format].to_sym] if match[:format]
+            render_options[:locales] = [match[:locale]] if match[:locale]
+            render_options[:variants] = [match[:variant]] if match[:variant]
 
             render_options
           else