shoulda-matchers 2.8.0 → 3.0.0.rc1

data/lib/shoulda/matchers.rb

@@ -1,28 +1,23 @@
-require 'shoulda/matchers/assertion_error'
+require 'shoulda/matchers/configuration'
 require 'shoulda/matchers/doublespeak'
 require 'shoulda/matchers/error'
+require 'shoulda/matchers/independent'
+require 'shoulda/matchers/integrations'
 require 'shoulda/matchers/matcher_context'
 require 'shoulda/matchers/rails_shim'
 require 'shoulda/matchers/util'
 require 'shoulda/matchers/version'
 require 'shoulda/matchers/warn'
 
-require 'shoulda/matchers/independent'
+require 'shoulda/matchers/action_controller'
+require 'shoulda/matchers/active_model'
+require 'shoulda/matchers/active_record'
 
-if defined?(ActiveModel)
-  require 'shoulda/matchers/active_model'
+module Shoulda
+  module Matchers
+    class << self
+      # @private
+      attr_accessor :assertion_exception_class
+    end
+  end
 end
-
-if defined?(ActiveRecord)
-  require 'shoulda/matchers/active_record'
-end
-
-if defined?(ActionController)
-  require 'shoulda/matchers/action_controller'
-end
-
-if defined?(RSpec)
-  require 'shoulda/matchers/integrations/rspec'
-end
-
-require 'shoulda/matchers/integrations/test_unit'

data/lib/shoulda/matchers/action_controller.rb

@@ -9,7 +9,10 @@ require 'shoulda/matchers/action_controller/redirect_to_matcher'
 require 'shoulda/matchers/action_controller/render_template_matcher'
 require 'shoulda/matchers/action_controller/rescue_from_matcher'
 require 'shoulda/matchers/action_controller/callback_matcher'
-require 'shoulda/matchers/action_controller/strong_parameters_matcher'
+require 'shoulda/matchers/action_controller/permit_matcher'
+require 'shoulda/matchers/action_controller/set_session_or_flash_matcher'
+require 'shoulda/matchers/action_controller/flash_store'
+require 'shoulda/matchers/action_controller/session_store'
 
 module Shoulda
   module Matchers

data/lib/shoulda/matchers/action_controller/flash_store.rb

@@ -0,0 +1,95 @@
+module Shoulda
+  module Matchers
+    module ActionController
+      # @private
+      class FlashStore
+        def self.future
+          new
+        end
+
+        def self.now
+          new.use_now!
+        end
+
+        attr_accessor :controller
+
+        def initialize
+          @use_now = false
+        end
+
+        def name
+          if @use_now
+            'flash.now'
+          else
+            'flash'
+          end
+        end
+
+        def has_key?(key)
+          values_to_check.include?(key)
+        end
+
+        def has_value?(expected_value)
+          values_to_check.values.any? do |actual_value|
+            expected_value === actual_value
+          end
+        end
+
+        def empty?
+          flash.empty?
+        end
+
+        def use_now!
+          @use_now = true
+          self
+        end
+
+        private
+
+        def flash
+          @_flash ||= copy_of_flash_from_controller
+        end
+
+        def copy_of_flash_from_controller
+          controller.flash.dup.tap do |flash|
+            copy_flashes(controller.flash, flash)
+            copy_discard_if_necessary(controller.flash, flash)
+            # sweep_flash_if_necessary(flash)
+          end
+        end
+
+        def copy_flashes(original_flash, new_flash)
+          flashes = original_flash.instance_variable_get('@flashes').dup
+          new_flash.instance_variable_set('@flashes', flashes)
+        end
+
+        def copy_discard_if_necessary(original_flash, new_flash)
+          discard = original_flash.instance_variable_get('@discard').dup
+          new_flash.instance_variable_set('@discard', discard)
+        end
+
+        def sweep_flash_if_necessary(flash)
+          unless @use_now
+            flash.sweep
+          end
+        end
+
+        def set_values
+          flash.instance_variable_get('@flashes')
+        end
+
+        def keys_to_discard
+          flash.instance_variable_get('@discard')
+        end
+
+        def values_to_check
+          if @use_now
+            set_values.slice(*keys_to_discard.to_a)
+          else
+            set_values.except(*keys_to_discard.to_a)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/action_controller/{strong_parameters_matcher.rb → permit_matcher.rb}

@@ -38,14 +38,16 @@ module Shoulda
       #     describe UsersController do
       #       it do
       #         should permit(:first_name, :last_name, :email, :password).
-      #           for(:create)
+      #           for(:create).
+      #           on(:user)
       #       end
       #     end
       #
       #     # Test::Unit
       #     class UsersControllerTest < ActionController::TestCase
       #       should permit(:first_name, :last_name, :email, :password).
-      #         for(:create)
+      #         for(:create).
+      #         on(:user)
       #     end
       #
       # If your action requires query parameters in order to work, then you'll
@@ -82,7 +84,8 @@ module Shoulda
       #
       #       it do
       #         should permit(:first_name, :last_name, :email, :password).
-      #           for(:update, params: { id: 1 })
+      #           for(:update, params: { id: 1 }).
+      #           on(:user)
       #       end
       #     end
       #
@@ -93,7 +96,8 @@ module Shoulda
       #       end
       #
       #       should permit(:first_name, :last_name, :email, :password).
-      #         for(:update, params: { id: 1 })
+      #         for(:update, params: { id: 1 }).
+      #         on(:user)
       #     end
       #
       # Finally, if you have an action that isn't one of the seven resourceful
@@ -132,10 +136,9 @@ module Shoulda
       #       end
       #
       #       it do
-      #         should permit(:activated).for(:toggle,
-      #           params: { id: 1 },
-      #           verb: :put
-      #         )
+      #         should permit(:activated).
+      #           for(:toggle, params: { id: 1 }, verb: :put).
+      #           on(:user)
       #       end
       #     end
       #
@@ -145,28 +148,28 @@ module Shoulda
       #         create(:user, id: 1)
       #       end
       #
-      #       should permit(:activated).for(:toggle,
-      #         params: { id: 1 },
-      #         verb: :put
-      #       )
+      #       should permit(:activated).
+      #         for(:toggle, params: { id: 1 }, verb: :put).
+      #         on(:user)
       #     end
       #
-      # @return [StrongParametersMatcher]
+      # @return [PermitMatcher]
       #
       def permit(*params)
-        StrongParametersMatcher.new(params).in_context(self)
+        PermitMatcher.new(params).in_context(self)
       end
 
       # @private
-      class StrongParametersMatcher
+      class PermitMatcher
         attr_writer :stubbed_params
 
         def initialize(expected_permitted_params)
+          @expected_permitted_params = expected_permitted_params
           @action = nil
           @verb = nil
           @request_params = {}
-          @expected_permitted_params = expected_permitted_params
-          set_double_collection
+          @subparameter = nil
+          @parameters_doubles = ParametersDoubles.new
         end
 
         def for(action, options = {})
@@ -176,19 +179,32 @@ module Shoulda
           self
         end
 
+        def add_params(params)
+          request_params.merge!(params)
+          self
+        end
+
+        def on(subparameter)
+          @subparameter = subparameter
+          @parameters_doubles = SliceOfParametersDoubles.new(subparameter)
+          self
+        end
+
         def in_context(context)
           @context = context
           self
         end
 
         def description
-          "permit #{verb.upcase} ##{action} to receive parameters #{param_names_as_sentence}"
+          "(on #{verb.upcase} ##{action}) " + expectation
         end
 
         def matches?(controller)
           @controller = controller
           ensure_action_and_verb_present!
 
+          parameters_doubles.register
+
           Doublespeak.with_doubles_activated do
             context.__send__(verb, action, request_params)
           end
@@ -197,32 +213,49 @@ module Shoulda
         end
 
         def failure_message
-          "Expected controller to permit #{unpermitted_params.to_sentence}, but it did not."
+          "Expected #{verb.upcase} ##{action} to #{expectation},\nbut #{reality}."
         end
         alias failure_message_for_should failure_message
 
         def failure_message_when_negated
-          "Expected controller not to permit #{verified_permitted_params.to_sentence}, but it did."
+          "Expected #{verb.upcase} ##{action} not to #{expectation},\nbut it did."
         end
         alias failure_message_for_should_not failure_message_when_negated
 
         protected
 
-        attr_reader :controller, :double_collection, :action, :verb,
-          :request_params, :expected_permitted_params, :context
+        attr_reader :controller, :double_collections_by_param, :action, :verb,
+          :request_params, :expected_permitted_params, :context, :subparameter,
+          :parameters_doubles
+
+        def expectation
+          message = 'restrict parameters '
+
+          if subparameter
+            message << " for #{subparameter.inspect}"
+          end
+
+          message << 'to ' + format_param_names(expected_permitted_params)
 
-        def set_double_collection
-          @double_collection =
-            Doublespeak.double_collection_for(::ActionController::Parameters)
+          message
+        end
 
-          @double_collection.register_stub(:require).to_return { |params| params }
-          @double_collection.register_proxy(:permit)
+        def reality
+          if actual_permitted_params.empty?
+            'it did not restrict any parameters'
+          else
+            'the restricted parameters were ' +
+              format_param_names(actual_permitted_params) +
+              ' instead'
+          end
+        end
+
+        def format_param_names(param_names)
+          param_names.map(&:inspect).to_sentence
         end
 
         def actual_permitted_params
-          double_collection.calls_to(:permit).inject([]) do |all_param_names, call|
-            all_param_names + call.args
-          end.flatten
+          parameters_doubles.permitted_params
         end
 
         def permit_called?
@@ -258,6 +291,90 @@ module Shoulda
           expected_permitted_params.map(&:inspect).to_sentence
         end
 
+        # @private
+        class ParametersDoubles
+          def self.permitted_params_within(double_collection)
+            double_collection.calls_to(:permit).map(&:args).flatten
+          end
+
+          def initialize
+            klass = ::ActionController::Parameters
+            @double_collection = Doublespeak.double_collection_for(klass)
+          end
+
+          def register
+            double_collection.register_proxy(:permit)
+          end
+
+          def permitted_params
+            ParametersDoubles.permitted_params_within(double_collection)
+          end
+
+          protected
+
+          attr_reader :double_collection
+        end
+
+        # @private
+        class SliceOfParametersDoubles
+          TOP_LEVEL = Object.new
+
+          def initialize(subparameter)
+            klass = ::ActionController::Parameters
+
+            @subparameter = subparameter
+            @double_collections_by_param = {
+              TOP_LEVEL => Doublespeak.double_collection_for(klass)
+            }
+          end
+
+          def register
+            top_level_collection = double_collections_by_param[TOP_LEVEL]
+            double_permit_on(top_level_collection)
+            double_require_on(top_level_collection)
+          end
+
+          def permitted_params
+            if double_collections_by_param.key?(subparameter)
+              ParametersDoubles.permitted_params_within(
+                double_collections_by_param[subparameter]
+              )
+            else
+              []
+            end
+          end
+
+          protected
+
+          attr_reader :subparameter, :double_collections_by_param
+
+          private
+
+          def double_permit_on(double_collection)
+            double_collection.register_proxy(:permit)
+          end
+
+          def double_require_on(double_collection)
+            double_collections_by_param = @double_collections_by_param
+            require_double = double_collection.register_proxy(:require)
+
+            require_double.to_return do |call|
+              param_name = call.args.first
+              params = call.return_value
+              double_collections_by_param[param_name] ||=
+                double_permit_against(params)
+            end
+          end
+
+          def double_permit_against(params)
+            klass = params.singleton_class
+
+            Doublespeak.double_collection_for(klass).tap do |double_collection|
+              double_permit_on(double_collection)
+            end
+          end
+        end
+
         # @private
         class ActionNotDefinedError < StandardError
           def message

data/lib/shoulda/matchers/action_controller/redirect_to_matcher.rb

@@ -82,7 +82,7 @@ module Shoulda
             @context.__send__(:assert_redirected_to, url)
             @failure_message_when_negated = "Didn't expect to redirect to #{url}"
             true
-          rescue Shoulda::Matchers::AssertionError => error
+          rescue Shoulda::Matchers.assertion_exception_class => error
             @failure_message = error.message
             false
           end

data/lib/shoulda/matchers/action_controller/render_template_matcher.rb

@@ -80,7 +80,7 @@ module Shoulda
             @context.__send__(:assert_template, @options, @message)
             @failure_message_when_negated = "Didn't expect to render #{@template}"
             true
-          rescue Shoulda::Matchers::AssertionError => error
+          rescue Shoulda::Matchers.assertion_exception_class => error
             @failure_message = error.message
             false
           end

data/lib/shoulda/matchers/action_controller/render_with_layout_matcher.rb

@@ -125,7 +125,7 @@ module Shoulda
 
         def recorded_layouts
           if @context
-            @context.instance_variable_get(Shoulda::Matchers::RailsShim.layouts_ivar)
+            @context.instance_variable_get('@_layouts')
           else
             {}
           end