rspec-rails 1.3.2 → 6.1.2

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Rails
+    module Matchers
+      # @api private
+      #
+      # Matcher class for `send_email`. Should not be instantiated directly.
+      #
+      # @see RSpec::Rails::Matchers#send_email
+      class SendEmail < RSpec::Rails::Matchers::BaseMatcher
+        # @api private
+        # Define the email attributes that should be included in the inspection output.
+        INSPECT_EMAIL_ATTRIBUTES = %i[subject from to cc bcc].freeze
+
+        def initialize(criteria)
+          @criteria = criteria
+        end
+
+        # @api private
+        def supports_value_expectations?
+          false
+        end
+
+        # @api private
+        def supports_block_expectations?
+          true
+        end
+
+        def matches?(block)
+          define_matched_emails(block)
+
+          @matched_emails.one?
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message
+          result =
+            if multiple_match?
+              "More than 1 matching emails were sent."
+            else
+              "No matching emails were sent."
+            end
+          "#{result}#{sent_emails_message}"
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "Expected not to send an email but it was sent."
+        end
+
+        private
+
+        def diffable?
+          true
+        end
+
+        def deliveries
+          ActionMailer::Base.deliveries
+        end
+
+        def define_matched_emails(block)
+          before = deliveries.dup
+
+          block.call
+
+          after = deliveries
+
+          @diff = after - before
+          @matched_emails = @diff.select(&method(:matched_email?))
+        end
+
+        def matched_email?(email)
+          @criteria.all? do |attr, value|
+            expected =
+              case attr
+              when :to, :from, :cc, :bcc then Array(value)
+              else
+                value
+              end
+
+            values_match?(expected, email.public_send(attr))
+          end
+        end
+
+        def multiple_match?
+          @matched_emails.many?
+        end
+
+        def sent_emails_message
+          if @diff.empty?
+            "\n\nThere were no any emails sent inside the expectation block."
+          else
+            sent_emails =
+              @diff.map do |email|
+                inspected = INSPECT_EMAIL_ATTRIBUTES.map { |attr| "#{attr}: #{email.public_send(attr)}" }.join(", ")
+                "- #{inspected}"
+              end.join("\n")
+            "\n\nThe following emails were sent:\n#{sent_emails}"
+          end
+        end
+      end
+
+      # @api public
+      # Check email sending with specific parameters.
+      #
+      # @example Positive expectation
+      #   expect { action }.to send_email
+      #
+      # @example Negative expectations
+      #   expect { action }.not_to send_email
+      #
+      # @example More precise expectation with attributes to match
+      #   expect { action }.to send_email(to: 'test@example.com', subject: 'Confirm email')
+      def send_email(criteria = {})
+        SendEmail.new(criteria)
+      end
+    end
+  end
+end

data/lib/rspec/rails/matchers.rb

@@ -0,0 +1,36 @@
+require 'rspec/core/warnings'
+require 'rspec/expectations'
+require 'rspec/rails/feature_check'
+
+module RSpec
+  module Rails
+    # @api public
+    # Container module for Rails specific matchers.
+    module Matchers
+    end
+  end
+end
+
+require 'rspec/rails/matchers/base_matcher'
+require 'rspec/rails/matchers/have_rendered'
+require 'rspec/rails/matchers/redirect_to'
+require 'rspec/rails/matchers/routing_matchers'
+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'
+require 'rspec/rails/matchers/send_email'
+
+if RSpec::Rails::FeatureCheck.has_active_job?
+  require 'rspec/rails/matchers/active_job'
+  require 'rspec/rails/matchers/have_enqueued_mail'
+end
+
+if RSpec::Rails::FeatureCheck.has_action_cable_testing?
+  require 'rspec/rails/matchers/action_cable'
+end
+
+if RSpec::Rails::FeatureCheck.has_action_mailbox?
+  require 'rspec/rails/matchers/action_mailbox'
+end

data/lib/rspec/rails/tasks/rspec.rake

@@ -0,0 +1,47 @@
+require 'rspec/core/rake_task'
+if default = Rake.application.instance_variable_get('@tasks')['default']
+  default.prerequisites.delete('test')
+end
+
+task default: :spec
+
+task stats: "spec:statsetup"
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(spec: "spec:prepare")
+
+namespace :spec do
+  types = begin
+            dirs = Dir['./spec/**/*_spec.rb']
+              .map { |f| f.sub(/^\.\/(spec\/\w+)\/.*/, '\\1') }
+              .uniq
+              .select { |f| File.directory?(f) }
+            Hash[dirs.map { |d| [d.split('/').last, d] }]
+          end
+
+  task :prepare do
+    ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'test'
+    if Rails.configuration.generators.options[:rails][:orm] == :active_record
+      if Rake::Task.task_defined?("test:prepare")
+        Rake::Task["test:prepare"].invoke
+      end
+    end
+  end
+
+  types.each do |type, dir|
+    desc "Run the code examples in #{dir}"
+    RSpec::Core::RakeTask.new(type => "spec:prepare") do |t|
+      t.pattern = "./#{dir}/**/*_spec.rb"
+    end
+  end
+
+  task :statsetup do
+    require 'rails/code_statistics'
+    types.each do |type, dir|
+      name = type.singularize.capitalize
+
+      ::STATS_DIRECTORIES << ["#{name} specs", dir]
+      ::CodeStatistics::TEST_TYPES << "#{name} specs"
+    end
+  end
+end

data/lib/rspec/rails/vendor/capybara.rb

@@ -0,0 +1,32 @@
+begin
+  require 'capybara/rspec'
+rescue LoadError
+end
+
+begin
+  require 'capybara/rails'
+rescue LoadError
+end
+
+if defined?(Capybara)
+  RSpec.configure do |c|
+    if defined?(Capybara::DSL)
+      c.include Capybara::DSL, type: :feature
+      c.include Capybara::DSL, type: :system
+    end
+
+    if defined?(Capybara::RSpecMatchers)
+      c.include Capybara::RSpecMatchers, type: :view
+      c.include Capybara::RSpecMatchers, type: :helper
+      c.include Capybara::RSpecMatchers, type: :mailer
+      c.include Capybara::RSpecMatchers, type: :controller
+      c.include Capybara::RSpecMatchers, type: :feature
+      c.include Capybara::RSpecMatchers, type: :system
+    end
+
+    unless defined?(Capybara::RSpecMatchers) || defined?(Capybara::DSL)
+      c.include Capybara, type: :request
+      c.include Capybara, type: :controller
+    end
+  end
+end

data/lib/rspec/rails/version.rb

@@ -0,0 +1,9 @@
+module RSpec
+  module Rails
+    # Version information for RSpec Rails.
+    module Version
+      # Current version of RSpec Rails, in semantic versioning format.
+      STRING = '6.1.2'
+    end
+  end
+end

data/lib/rspec/rails/view_assigns.rb

@@ -0,0 +1,27 @@
+module RSpec
+  module Rails
+    # Helpers for making instance variables available to views.
+    module ViewAssigns
+      # Assigns a value to an instance variable in the scope of the
+      # view being rendered.
+      #
+      # @example
+      #
+      #     assign(:widget, stub_model(Widget))
+      def assign(key, value)
+        _encapsulated_assigns[key] = value
+      end
+
+      # Compat-shim for AbstractController::Rendering#view_assigns
+      def view_assigns
+        super.merge(_encapsulated_assigns)
+      end
+
+    private
+
+      def _encapsulated_assigns
+        @_encapsulated_assigns ||= {}
+      end
+    end
+  end
+end

data/lib/rspec/rails/view_path_builder.rb

@@ -0,0 +1,29 @@
+module RSpec
+  module Rails
+    # Builds paths for view specs using a particular route set.
+    class ViewPathBuilder
+      def initialize(route_set)
+        self.class.send(:include, route_set.url_helpers)
+      end
+
+      # Given a hash of parameters, build a view path, if possible.
+      # Returns nil if no path can be built from the given params.
+      #
+      # @example
+      #     # path can be built because all required params are present in the hash
+      #     view_path_builder = ViewPathBuilder.new(::Rails.application.routes)
+      #     view_path_builder.path_for({ :controller => 'posts', :action => 'show', :id => '54' })
+      #     # => "/post/54"
+      #
+      # @example
+      #     # path cannot be built because the params are missing a required element (:id)
+      #     view_path_builder.path_for({ :controller => 'posts', :action => 'delete' })
+      #     # => ActionController::UrlGenerationError: No route matches {:action=>"delete", :controller=>"posts"}
+      def path_for(path_params)
+        url_for(path_params.merge(only_path: true))
+      rescue => e
+        e.message
+      end
+    end
+  end
+end

data/lib/rspec/rails/view_rendering.rb

@@ -0,0 +1,166 @@
+require 'action_view/testing/resolvers'
+
+module RSpec
+  module Rails
+    # @api public
+    # Helpers for optionally rendering views in controller specs.
+    module ViewRendering
+      extend ActiveSupport::Concern
+
+      # @!attribute [r]
+      # Returns the controller object instance under test.
+      attr_reader :controller
+
+      # @private
+      attr_writer :controller
+      private :controller=
+
+      # DSL methods
+      module ClassMethods
+        # @see RSpec::Rails::ControllerExampleGroup
+        def render_views(true_or_false = true)
+          @render_views = true_or_false
+        end
+
+        # @api private
+        def render_views?
+          return @render_views if defined?(@render_views)
+
+          if superclass.respond_to?(:render_views?)
+            superclass.render_views?
+          else
+            RSpec.configuration.render_views?
+          end
+        end
+      end
+
+      # @api private
+      def render_views?
+        self.class.render_views? || !controller.class.respond_to?(:view_paths)
+      end
+
+      # @private
+      class EmptyTemplateResolver
+        def self.build(path)
+          if path.is_a?(::ActionView::Resolver)
+            ResolverDecorator.new(path)
+          else
+            FileSystemResolver.new(path)
+          end
+        end
+
+        def self.nullify_template_rendering(templates)
+          templates.map do |template|
+            ::ActionView::Template.new(
+              "",
+              template.identifier,
+              EmptyTemplateHandler,
+              virtual_path: template.virtual_path,
+              format: template_format(template),
+              locals: []
+            )
+          end
+        end
+
+        def self.template_format(template)
+          template.format
+        end
+
+        # Delegates all methods to the submitted resolver and for all methods
+        # that return a collection of `ActionView::Template` instances, return
+        # templates with modified source
+        #
+        # @private
+        class ResolverDecorator < ::ActionView::Resolver
+          (::ActionView::Resolver.instance_methods - Object.instance_methods).each do |method|
+            undef_method method
+          end
+
+          (::ActionView::Resolver.methods - Object.methods).each do |method|
+            singleton_class.undef_method method
+          end
+
+          def initialize(resolver)
+            @resolver = resolver
+          end
+
+          def method_missing(name, *args, &block)
+            result = @resolver.send(name, *args, &block)
+            nullify_templates(result)
+          end
+
+        private
+
+          def nullify_templates(collection)
+            return collection unless collection.is_a?(Enumerable)
+            return collection unless collection.all? { |element| element.is_a?(::ActionView::Template) }
+
+            EmptyTemplateResolver.nullify_template_rendering(collection)
+          end
+        end
+
+        # Delegates find_templates to the submitted path set and then returns
+        # templates with modified source
+        #
+        # @private
+        class FileSystemResolver < ::ActionView::FileSystemResolver
+          private
+
+          def find_templates(*args)
+            templates = super
+            EmptyTemplateResolver.nullify_template_rendering(templates)
+          end
+        end
+      end
+
+      # @private
+      class EmptyTemplateHandler
+        def self.call(_template, _source = nil)
+          ::Rails.logger.info("  Template rendering was prevented by rspec-rails. Use `render_views` to verify rendered view contents if necessary.")
+
+          %("")
+        end
+      end
+
+      # Used to null out view rendering in controller specs.
+      #
+      # @private
+      module EmptyTemplates
+        def prepend_view_path(new_path)
+          super(_path_decorator(*new_path))
+        end
+
+        def append_view_path(new_path)
+          super(_path_decorator(*new_path))
+        end
+
+      private
+
+        def _path_decorator(*paths)
+          paths.map { |path| EmptyTemplateResolver.build(path) }
+        end
+      end
+
+      # @private
+      RESOLVER_CACHE = Hash.new do |hash, path|
+        hash[path] = EmptyTemplateResolver.build(path)
+      end
+
+      included do
+        before do
+          unless render_views?
+            @_original_path_set = controller.class.view_paths
+            path_set = @_original_path_set.map { |resolver| RESOLVER_CACHE[resolver] }
+
+            controller.class.view_paths = path_set
+            controller.extend(EmptyTemplates)
+          end
+        end
+
+        after do
+          controller.class.view_paths = @_original_path_set unless render_views?
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rails/view_spec_methods.rb

@@ -0,0 +1,56 @@
+module RSpec
+  module Rails
+    # Adds methods (generally to ActionView::TestCase::TestController).
+    # Intended for use in view specs.
+    module ViewSpecMethods
+      module_function
+
+      # Adds methods `extra_params=` and `extra_params` to the indicated class.
+      # When class is `::ActionView::TestCase::TestController`, these methods
+      # are exposed in view specs on the `controller` object.
+      def add_to(klass)
+        return if klass.method_defined?(:extra_params) && klass.method_defined?(:extra_params=)
+
+        klass.module_exec do
+          # Set any extra parameters that rendering a URL for this view
+          # would require.
+          #
+          # @example
+          #
+          #     # In "spec/views/widgets/show.html.erb_spec.rb":
+          #     before do
+          #       widget = Widget.create!(:name => "slicer")
+          #       controller.extra_params = { :id => widget.id }
+          #     end
+          def extra_params=(hash)
+            @extra_params = hash
+            request.path =
+              ViewPathBuilder.new(::Rails.application.routes).path_for(
+                extra_params.merge(request.path_parameters)
+              )
+          end
+
+          # Use to read extra parameters that are set in the view spec.
+          #
+          # @example
+          #
+          #     # After the before in the above example:
+          #     controller.extra_params
+          #     # => { :id => 4 }
+          def extra_params
+            @extra_params ||= {}
+            @extra_params.dup.freeze
+          end
+        end
+      end
+
+      # Removes methods `extra_params=` and `extra_params` from the indicated class.
+      def remove_from(klass)
+        klass.module_exec do
+          undef extra_params= if klass.method_defined?(:extra_params=)
+          undef extra_params  if klass.method_defined?(:extra_params)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rails.rb

@@ -0,0 +1,18 @@
+require 'rspec/core'
+require 'rails/version'
+
+# Load any of our adapters and extensions early in the process
+require 'rspec/rails/adapters'
+require 'rspec/rails/extensions'
+
+# Load the rspec-rails parts
+require 'rspec/rails/view_rendering'
+require 'rspec/rails/matchers'
+require 'rspec/rails/fixture_support'
+require 'rspec/rails/file_fixture_support'
+require 'rspec/rails/fixture_file_upload_support'
+require 'rspec/rails/example'
+require 'rspec/rails/vendor/capybara'
+require 'rspec/rails/configuration'
+require 'rspec/rails/active_record'
+require 'rspec/rails/feature_check'

data/lib/rspec-rails.rb

@@ -0,0 +1,80 @@
+require 'rspec/rails/feature_check'
+
+# Namespace for all core RSpec projects.
+module RSpec
+  # Namespace for rspec-rails code.
+  module Rails
+    # Railtie to hook into Rails.
+    class Railtie < ::Rails::Railtie
+      # As of Rails 5.1.0 you can register directories to work with `rake notes`
+      require 'rails/source_annotation_extractor'
+      ::Rails::SourceAnnotationExtractor::Annotation.register_directories("spec")
+      generators = config.app_generators
+      generators.integration_tool :rspec
+      generators.test_framework :rspec
+
+      generators do
+        ::Rails::Generators.hidden_namespaces.reject! { |namespace| namespace.to_s.start_with?("rspec") }
+      end
+
+      rake_tasks do
+        load "rspec/rails/tasks/rspec.rake"
+      end
+
+      # This is called after the environment has been loaded but before Rails
+      # sets the default for the `preview_path`
+      initializer "rspec_rails.action_mailer",
+                  before: "action_mailer.set_configs" do |app|
+                    setup_preview_path(app)
+                  end
+
+    private
+
+      def setup_preview_path(app)
+        return unless supports_action_mailer_previews?(app.config)
+
+        options = app.config.action_mailer
+        config_default_preview_path(options) if config_preview_path?(options)
+      end
+
+      def config_preview_path?(options)
+        # We cannot use `respond_to?(:show_previews)` here as it will always
+        # return `true`.
+        if options.show_previews.nil?
+          options.show_previews = ::Rails.env.development?
+        else
+          options.show_previews
+        end
+      end
+
+      if ::Rails::VERSION::STRING >= "7.1.0"
+        def config_default_preview_path(options)
+          return unless options.preview_paths.empty?
+
+          options.preview_paths << "#{::Rails.root}/spec/mailers/previews"
+        end
+      else
+        def config_default_preview_path(options)
+          return unless options.preview_path.blank?
+
+          options.preview_path = "#{::Rails.root}/spec/mailers/previews"
+        end
+      end
+
+      def supports_action_mailer_previews?(config)
+        # These checks avoid loading `ActionMailer`. Using `defined?` has the
+        # side-effect of the class getting loaded if it is available. This is
+        # problematic because loading `ActionMailer::Base` will cause it to
+        # read the config settings; this is the only time the config is read.
+        # If the config is loaded now, any settings declared in a config block
+        # in an initializer will be ignored.
+        #
+        # If the action mailer railtie has not been loaded then `config` will
+        # not respond to the method. However, we cannot use
+        # `config.action_mailer.respond_to?(:preview_path)` here as it will
+        # always return `true`.
+        config.respond_to?(:action_mailer)
+      end
+    end
+  end
+end

data.tar.gz.sig

@@ -0,0 +1,2 @@
+��q��c��Y��PC�'{ޮSD
��)5C���,���*no�G]=6��<0Ĺ���1gO�‹�'[<_�Cf'����ې�h
+�p�9=���}f�Ͽ��`�U�L��pi�p@y���K�Y����R�cszu-��_�cU4�>��7A�,���u=ϣ=�.zp������gg�[��Vo��dTgr�K�Tao�ȇ��Dҹ����w(�k9IwV7���p޼C/y�|��=�ȿ���J���Dh��}����	9��R\qNa?8"�������MSm��x��"̊��br]�ӳ�``G԰Jr?��n�*�}p[��Q#o��|HT]����ߧ�ʋc9��T4Z��G�	�P=(��'r��4���1���,�8Q($���̵��҉X�����Y����%�x��]�mp��r>�=�bEַGo��k��t-s�Ӻ�nv(�A���z����Yڽ��F�H%���eY��l
-��z��p�G!��shY��2sKv��"�R�nK<�