shoulda-matchers 2.6.2 → 2.7.0

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

@@ -28,7 +28,7 @@ module Shoulda
       # @private
       class FilterParamMatcher
         def initialize(key)
-          @key = key.to_s
+          @key = key
         end
 
         def matches?(controller)
@@ -52,11 +52,18 @@ module Shoulda
         private
 
         def filters_key?
-          filtered_keys.include?(@key)
+          filtered_keys.any? do |filter|
+            case filter
+            when Regexp
+              filter =~ @key
+            else
+              filter == @key
+            end
+          end
         end
 
         def filtered_keys
-          Rails.application.config.filter_parameters.map(&:to_s)
+          Rails.application.config.filter_parameters
         end
       end
     end

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

@@ -38,28 +38,46 @@ module Shoulda
       # particular value.
       #
       #     class PostsController < ApplicationController
-      #       def show
+      #       def index
       #         session[:foo] = 'bar'
       #       end
+      #
+      #       def show
+      #         session[:foo] = nil
+      #       end
       #     end
       #
       #     # RSpec
       #     describe PostsController do
-      #       describe 'GET #show' do
-      #         before { get :show }
+      #       describe 'GET #index' do
+      #         before { get :index }
       #
       #         it { should set_session(:foo).to('bar') }
       #         it { should_not set_session(:foo).to('something else') }
+      #         it { should_not set_session(:foo).to(nil) }
+      #       end
+      #
+      #       describe 'GET #show' do
+      #         before { get :show }
+      #
+      #         it { should set_session(:foo).to(nil) }
       #       end
       #     end
       #
       #     # Test::Unit
       #     class PostsControllerTest < ActionController::TestCase
-      #       context 'GET #show' do
-      #         setup { get :show }
+      #       context 'GET #index' do
+      #         setup { get :index }
       #
       #         should set_session(:foo).to('bar')
       #         should_not set_session(:foo).to('something else')
+      #         should_not set_session(:foo).to(nil)
+      #       end
+      #
+      #       context 'GET #show' do
+      #         setup { get :show }
+      #
+      #         should set_session(:foo).to(nil)
       #       end
       #     end
       #
@@ -129,7 +147,7 @@ module Shoulda
 
         def assigned_correct_value?
           if assigned_value?
-            if value_or_default_value.nil?
+            if !defined?(@value)
               true
             else
               assigned_value == value_or_default_value

data/lib/shoulda/matchers/active_model.rb

@@ -5,8 +5,8 @@ require 'shoulda/matchers/active_model/exception_message_finder'
 require 'shoulda/matchers/active_model/allow_value_matcher'
 require 'shoulda/matchers/active_model/disallow_value_matcher'
 require 'shoulda/matchers/active_model/ensure_length_of_matcher'
-require 'shoulda/matchers/active_model/ensure_inclusion_of_matcher'
-require 'shoulda/matchers/active_model/ensure_exclusion_of_matcher'
+require 'shoulda/matchers/active_model/validate_inclusion_of_matcher'
+require 'shoulda/matchers/active_model/validate_exclusion_of_matcher'
 require 'shoulda/matchers/active_model/validate_absence_of_matcher'
 require 'shoulda/matchers/active_model/validate_presence_of_matcher'
 require 'shoulda/matchers/active_model/validate_uniqueness_of_matcher'

data/lib/shoulda/matchers/active_model/allow_value_matcher.rb

@@ -209,7 +209,7 @@ module Shoulda
           self
         end
 
-        def _after_setting_value(&callback)  # :nodoc:
+        def _after_setting_value(&callback)
           self.after_setting_value_callback = callback
         end
 

data/lib/shoulda/matchers/active_model/ensure_length_of_matcher.rb

@@ -57,7 +57,7 @@ module Shoulda
       #
       # ##### is_equal_to
       #
-      # Use `is_at_equal` to test usage of the `:is` option. This asserts that
+      # Use `is_equal_to` to test usage of the `:is` option. This asserts that
       # the attribute can take a string which is exactly equal to the given
       # length and cannot take a string which is shorter or longer.
       #

data/lib/shoulda/matchers/active_model/validate_absence_of_matcher.rb

@@ -82,8 +82,10 @@ module Shoulda
             else
               obj
             end
-          elsif attribute_class == Fixnum
+          elsif [Fixnum, Float].include?(attribute_class)
             1
+          elsif attribute_class == BigDecimal
+            BigDecimal.new(1, 0)
           elsif !attribute_class || attribute_class == String
             'an arbitrary value'
           else
@@ -93,8 +95,8 @@ module Shoulda
 
         def attribute_class
           @subject.class.respond_to?(:columns_hash) &&
-            @subject.class.columns_hash[@attribute].respond_to?(:klass) &&
-            @subject.class.columns_hash[@attribute].klass
+            @subject.class.columns_hash[@attribute.to_s].respond_to?(:klass) &&
+            @subject.class.columns_hash[@attribute.to_s].klass
         end
 
         def collection?

data/lib/shoulda/matchers/active_model/{ensure_exclusion_of_matcher.rb → validate_exclusion_of_matcher.rb}

@@ -1,7 +1,7 @@
 module Shoulda
   module Matchers
     module ActiveModel
-      # The `ensure_exclusion_of` matcher tests usage of the
+      # The `validate_exclusion_of` matcher tests usage of the
       # `validates_exclusion_of` validation, asserting that an attribute cannot
       # take a blacklist of values, and inversely, can take values outside of
       # this list.
@@ -18,14 +18,14 @@ module Shoulda
       #     # RSpec
       #     describe Game do
       #       it do
-      #         should ensure_exclusion_of(:supported_os).
+      #         should validate_exclusion_of(:supported_os).
       #           in_array(['Mac', 'Linux'])
       #       end
       #     end
       #
       #     # Test::Unit
       #     class GameTest < ActiveSupport::TestCase
-      #       should ensure_exclusion_of(:supported_os).
+      #       should validate_exclusion_of(:supported_os).
       #         in_array(['Mac', 'Linux'])
       #     end
       #
@@ -41,14 +41,14 @@ module Shoulda
       #     # RSpec
       #     describe Game do
       #       it do
-      #         should ensure_exclusion_of(:floors_with_enemies).
+      #         should validate_exclusion_of(:floors_with_enemies).
       #           in_range(5..8)
       #       end
       #     end
       #
       #     # Test::Unit
       #     class GameTest < ActiveSupport::TestCase
-      #       should ensure_exclusion_of(:floors_with_enemies).
+      #       should validate_exclusion_of(:floors_with_enemies).
       #         in_range(5..8)
       #     end
       #
@@ -70,7 +70,7 @@ module Shoulda
       #     # RSpec
       #     describe Game do
       #       it do
-      #         should ensure_exclusion_of(:weapon).
+      #         should validate_exclusion_of(:weapon).
       #           in_array(['pistol', 'paintball gun', 'stick']).
       #           with_message('You chose a puny weapon')
       #       end
@@ -78,19 +78,29 @@ module Shoulda
       #
       #     # Test::Unit
       #     class GameTest < ActiveSupport::TestCase
-      #       should ensure_exclusion_of(:weapon).
+      #       should validate_exclusion_of(:weapon).
       #         in_array(['pistol', 'paintball gun', 'stick']).
       #         with_message('You chose a puny weapon')
       #     end
       #
-      # @return [EnsureExclusionOfMatcher]
+      # @return [ValidateExclusionOfMatcher]
       #
+      def validate_exclusion_of(attr)
+        ValidateExclusionOfMatcher.new(attr)
+      end
+
+      # @deprecated Use {#validate_exclusion_of} instead.
+      # @return [ValidateExclusionOfMatcher]
       def ensure_exclusion_of(attr)
-        EnsureExclusionOfMatcher.new(attr)
+        Shoulda::Matchers.warn_about_deprecated_method(
+          :ensure_exclusion_of,
+          :validate_exclusion_of
+        )
+        validate_exclusion_of(attr)
       end
 
       # @private
-      class EnsureExclusionOfMatcher < ValidationMatcher
+      class ValidateExclusionOfMatcher < ValidationMatcher
         def initialize(attribute)
           super(attribute)
           @array = nil

data/lib/shoulda/matchers/active_model/{ensure_inclusion_of_matcher.rb → validate_inclusion_of_matcher.rb}

@@ -3,7 +3,7 @@ require 'bigdecimal'
 module Shoulda
   module Matchers
     module ActiveModel
-      # The `ensure_inclusion_of` matcher tests usage of the
+      # The `validate_inclusion_of` matcher tests usage of the
       # `validates_inclusion_of` validation, asserting that an attribute can
       # take a whitelist of values and cannot take values outside of this list.
       #
@@ -19,14 +19,14 @@ module Shoulda
       #     # RSpec
       #     describe Issue do
       #       it do
-      #         should ensure_inclusion_of(:state).
+      #         should validate_inclusion_of(:state).
       #           in_array(%w(open resolved unresolved))
       #       end
       #     end
       #
       #     # Test::Unit
       #     class IssueTest < ActiveSupport::TestCase
-      #       should ensure_inclusion_of(:state).
+      #       should validate_inclusion_of(:state).
       #         in_array(%w(open resolved unresolved))
       #     end
       #
@@ -41,15 +41,31 @@ module Shoulda
       #
       #     # RSpec
       #     describe Issue do
-      #       it { should ensure_inclusion_of(:state).in_range(1..5) }
+      #       it { should validate_inclusion_of(:state).in_range(1..5) }
       #     end
       #
       #     # Test::Unit
       #     class IssueTest < ActiveSupport::TestCase
-      #       should ensure_inclusion_of(:state).in_range(1..5)
+      #       should validate_inclusion_of(:state).in_range(1..5)
       #     end
       #
-      # #### Optional qualifiers
+      # #### Caveats
+      #
+      # We discourage using `validate_inclusion_of` with boolean columns. In
+      # fact, there is never a case where a boolean column will be anything but
+      # true, false, or nil, as ActiveRecord will type-cast an incoming value to
+      # one of these three values. That means there isn't any way we can refute
+      # this logic in a test. Hence, this will produce a warning:
+      #
+      #     it { should validate_inclusion_of(:imported).in_array([true, false]) }
+      #
+      # The only case where `validate_inclusion_of` *could* be appropriate is
+      # for ensuring that a boolean column accepts nil, but we recommend
+      # using `allow_value` instead, like this:
+      #
+      #     it { should allow_value(nil).for(:imported) }
+      #
+      # #### Qualifiers
       #
       # ##### with_message
       #
@@ -67,7 +83,7 @@ module Shoulda
       #     # RSpec
       #     describe Issue do
       #       it do
-      #         should ensure_inclusion_of(:severity).
+      #         should validate_inclusion_of(:severity).
       #           in_array(%w(low medium high)).
       #           with_message('Severity must be low, medium, or high')
       #       end
@@ -75,7 +91,7 @@ module Shoulda
       #
       #     # Test::Unit
       #     class IssueTest < ActiveSupport::TestCase
-      #       should ensure_inclusion_of(:severity).
+      #       should validate_inclusion_of(:severity).
       #         in_array(%w(low medium high)).
       #         with_message('Severity must be low, medium, or high')
       #     end
@@ -103,7 +119,7 @@ module Shoulda
       #     # RSpec
       #     describe Person do
       #       it do
-      #         should ensure_inclusion_of(:age).
+      #         should validate_inclusion_of(:age).
       #           in_range(0..65).
       #           with_low_message('You do not receive any benefits')
       #       end
@@ -111,7 +127,7 @@ module Shoulda
       #
       #     # Test::Unit
       #     class PersonTest < ActiveSupport::TestCase
-      #       should ensure_inclusion_of(:age).
+      #       should validate_inclusion_of(:age).
       #         in_range(0..65).
       #         with_low_message('You do not receive any benefits')
       #     end
@@ -139,7 +155,7 @@ module Shoulda
       #     # RSpec
       #     describe Person do
       #       it do
-      #         should ensure_inclusion_of(:age).
+      #         should validate_inclusion_of(:age).
       #           in_range(0..21).
       #           with_high_message("You're too old for this stuff")
       #       end
@@ -147,7 +163,7 @@ module Shoulda
       #
       #     # Test::Unit
       #     class PersonTest < ActiveSupport::TestCase
-      #       should ensure_inclusion_of(:age).
+      #       should validate_inclusion_of(:age).
       #         in_range(0..21).
       #         with_high_message("You're too old for this stuff")
       #     end
@@ -169,7 +185,7 @@ module Shoulda
       #     # RSpec
       #     describe Issue do
       #       it do
-      #         should ensure_inclusion_of(:state).
+      #         should validate_inclusion_of(:state).
       #           in_array(%w(open resolved unresolved)).
       #           allow_nil
       #       end
@@ -177,7 +193,7 @@ module Shoulda
       #
       #     # Test::Unit
       #     class IssueTest < ActiveSupport::TestCase
-      #       should ensure_inclusion_of(:state).
+      #       should validate_inclusion_of(:state).
       #         in_array(%w(open resolved unresolved)).
       #         allow_nil
       #     end
@@ -199,7 +215,7 @@ module Shoulda
       #     # RSpec
       #     describe Issue do
       #       it do
-      #         should ensure_inclusion_of(:state).
+      #         should validate_inclusion_of(:state).
       #           in_array(%w(open resolved unresolved)).
       #           allow_blank
       #       end
@@ -207,35 +223,43 @@ module Shoulda
       #
       #     # Test::Unit
       #     class IssueTest < ActiveSupport::TestCase
-      #       should ensure_inclusion_of(:state).
+      #       should validate_inclusion_of(:state).
       #         in_array(%w(open resolved unresolved)).
       #         allow_blank
       #     end
       #
-      # @return [EnsureInclusionOfMatcher]
+      # @return [ValidateInclusionOfMatcher]
       #
+      def validate_inclusion_of(attr)
+        ValidateInclusionOfMatcher.new(attr)
+      end
+
+      # @deprecated Use {#validate_inclusion_of} instead.
+      # @return [ValidateInclusionOfMatcher]
       def ensure_inclusion_of(attr)
-        EnsureInclusionOfMatcher.new(attr)
+        Shoulda::Matchers.warn_about_deprecated_method(
+          :ensure_inclusion_of,
+          :validate_inclusion_of
+        )
+        validate_inclusion_of(attr)
       end
 
       # @private
-      class EnsureInclusionOfMatcher < ValidationMatcher
+      class ValidateInclusionOfMatcher < ValidationMatcher
         ARBITRARY_OUTSIDE_STRING = 'shouldamatchersteststring'
         ARBITRARY_OUTSIDE_FIXNUM = 123456789
         ARBITRARY_OUTSIDE_DECIMAL = BigDecimal.new('0.123456789')
         BOOLEAN_ALLOWS_BOOLEAN_MESSAGE = <<EOT
-You are using `ensure_inclusion_of` to assert that a boolean column allows
-boolean values and disallows non-boolean ones. Assuming you are using
-`validates_format_of` in your model, be aware that it is not possible to fully
-test this, and in fact the validation is superfluous, as boolean columns will
-automatically convert non-boolean values to boolean ones. Hence, you should
-consider removing this test and the corresponding validation.
+You are using `validate_inclusion_of` to assert that a boolean column allows
+boolean values and disallows non-boolean ones. Be aware that it is not possible
+to fully test this, as boolean columns will automatically convert non-boolean
+values to boolean ones. Hence, you should consider removing this test.
 EOT
         BOOLEAN_ALLOWS_NIL_MESSAGE = <<EOT
-You are using `ensure_inclusion_of` to assert that a boolean column allows nil.
+You are using `validate_inclusion_of` to assert that a boolean column allows nil.
 Be aware that it is not possible to fully test this, as anything other than
 true, false or nil will be converted to false. Hence, you should consider
-removing this test and the corresponding validation.
+removing this test.
 EOT
 
         def initialize(attribute)
@@ -372,7 +396,7 @@ EOT
         def disallows_value_outside_of_array?
           if attribute_type == :boolean
             case @array
-            when [true, false]
+            when [false, true], [true, false]
               Shoulda::Matchers.warn BOOLEAN_ALLOWS_BOOLEAN_MESSAGE
               return true
             when [nil]

data/lib/shoulda/matchers/active_model/validate_uniqueness_of_matcher.rb

@@ -4,10 +4,10 @@ module Shoulda
       # The `validate_uniqueness_of` matcher tests usage of the
       # `validates_uniqueness_of` validation. It first checks for an existing
       # instance of your model in the database, creating one if necessary. It
-      # then takes a new record and asserts that it fails validation if the
-      # attribute or attributes you've specified in the validation are set to
-      # values which are the same as those of the pre-existing record (thereby
-      # failing the uniqueness check).
+      # then takes a new instance of that model and asserts that it fails
+      # validation if the attribute or attributes you've specified in the
+      # validation are set to values which are the same as those of the
+      # pre-existing record (thereby failing the uniqueness check).
       #
       #     class Post < ActiveRecord::Base
       #       validates_uniqueness_of :permalink
@@ -29,8 +29,8 @@ module Shoulda
       # before, it will create an instance of your model if one doesn't already
       # exist. Sometimes this step fails, especially if you have database-level
       # restrictions on any attributes other than the one which is unique. In
-      # this case, the solution is to **create a record manually** before you
-      # call `validate_uniqueness_of`.
+      # this case, the solution is to populate these attributes with values
+      # before you call `validate_uniqueness_of`.
       #
       # For example, say you have the following migration and model:
       #
@@ -62,23 +62,27 @@ module Shoulda
       #          ActiveRecord::StatementInvalid:
       #            SQLite3::ConstraintException: posts.content may not be NULL: INSERT INTO "posts" ("title") VALUES (?)
       #
-      # To fix this, you'll need to write this instead:
+      # This happens because `validate_uniqueness_of` tries to create a new post
+      # but cannot do so because of the `content` attribute: though unrelated to
+      # this test, it nevertheless needs to be filled in. The solution is to
+      # build a custom Post object ahead of time with `content` filled in:
       #
       #     describe Post do
-      #       it do
-      #         Post.create!(content: 'Here is the content')
-      #         should validate_uniqueness_of(:title)
+      #       describe "validations" do
+      #         subject { Post.new(content: 'Here is the content') }
+      #         it { should validate_uniqueness_of(:title) }
       #       end
       #     end
       #
       # Or, if you're using
       # [FactoryGirl](http://github.com/thoughtbot/factory_girl) and you have a
-      # `post` factory defined which automatically sets `content`, you can say:
+      # `post` factory defined which automatically fills in `content`, you can
+      # say:
       #
       #     describe Post do
-      #       it do
-      #         FactoryGirl.create(:post)
-      #         should validate_uniqueness_of(:title)
+      #       describe "validations" do
+      #         subject { FactoryGirl.build(:post) }
+      #         it { should validate_uniqueness_of(:title) }
       #       end
       #     end
       #
@@ -209,6 +213,7 @@ module Shoulda
         end
 
         def matches?(subject)
+          @original_subject = subject
           @subject = subject.class.new
           @expected_message ||= :taken
           set_scoped_attributes &&
@@ -253,16 +258,20 @@ module Shoulda
             value = 'a'
           end
 
-          @subject.class.new.tap do |instance|
+          @original_subject.tap do |instance|
             instance.__send__("#{@attribute}=", value)
-            if has_secure_password?
-              instance.password = 'password'
-              instance.password_confirmation = 'password'
-            end
+            ensure_secure_password_set(instance)
             instance.save(validate: false)
           end
         end
 
+        def ensure_secure_password_set(instance)
+          if has_secure_password?
+            instance.password = "password"
+            instance.password_confirmation = "password"
+          end
+        end
+
         def has_secure_password?
           @subject.class.ancestors.map(&:to_s).include?('ActiveModel::SecurePassword::InstanceMethodsOnActivation')
         end