shoulda-matchers 2.7.0 → 2.8.0.rc1

data/lib/shoulda/matchers/active_model/{ensure_length_of_matcher.rb → validate_length_of_matcher.rb}

@@ -1,9 +1,9 @@
 module Shoulda
   module Matchers
     module ActiveModel
-      # The `ensure_length_of` matcher tests usage of the `validates_length_of`
-      # matcher. Note that this matcher is intended to be used against string
-      # columns and not integer columns.
+      # The `validate_length_of` matcher tests usage of the
+      # `validates_length_of` matcher. Note that this matcher is intended to be
+      # used against string columns and not integer columns.
       #
       # #### Qualifiers
       #
@@ -23,13 +23,13 @@ module Shoulda
       #     # RSpec
       #
       #     describe User do
-      #       it { should ensure_length_of(:bio).is_at_least(15) }
+      #       it { should validate_length_of(:bio).is_at_least(15) }
       #     end
       #
       #     # Test::Unit
       #
       #     class UserTest < ActiveSupport::TestCase
-      #       should ensure_length_of(:bio).is_at_least(15)
+      #       should validate_length_of(:bio).is_at_least(15)
       #     end
       #
       # ##### is_at_most
@@ -47,12 +47,12 @@ module Shoulda
       #
       #     # RSpec
       #     describe User do
-      #       it { should ensure_length_of(:status_update).is_at_most(140) }
+      #       it { should validate_length_of(:status_update).is_at_most(140) }
       #     end
       #
       #     # Test::Unit
       #     class UserTest < ActiveSupport::TestCase
-      #       should ensure_length_of(:status_update).is_at_most(140)
+      #       should validate_length_of(:status_update).is_at_most(140)
       #     end
       #
       # ##### is_equal_to
@@ -70,12 +70,12 @@ module Shoulda
       #
       #     # RSpec
       #     describe User do
-      #       it { should ensure_length_of(:favorite_superhero).is_equal_to(6) }
+      #       it { should validate_length_of(:favorite_superhero).is_equal_to(6) }
       #     end
       #
       #     # Test::Unit
       #     class UserTest < ActiveSupport::TestCase
-      #       should ensure_length_of(:favorite_superhero).is_equal_to(6)
+      #       should validate_length_of(:favorite_superhero).is_equal_to(6)
       #     end
       #
       # ##### is_at_least + is_at_most
@@ -93,14 +93,14 @@ module Shoulda
       #     # RSpec
       #     describe User do
       #       it do
-      #         should ensure_length_of(:password).
+      #         should validate_length_of(:password).
       #           is_at_least(5).is_at_most(30)
       #       end
       #     end
       #
       #     # Test::Unit
       #     class UserTest < ActiveSupport::TestCase
-      #       should ensure_length_of(:password).
+      #       should validate_length_of(:password).
       #         is_at_least(5).is_at_most(30)
       #     end
       #
@@ -120,7 +120,7 @@ module Shoulda
       #     # RSpec
       #     describe User do
       #       it do
-      #         should ensure_length_of(:password).
+      #         should validate_length_of(:password).
       #           is_at_least(10).
       #           with_message("Password isn't long enough")
       #       end
@@ -128,7 +128,7 @@ module Shoulda
       #
       #     # Test::Unit
       #     class UserTest < ActiveSupport::TestCase
-      #       should ensure_length_of(:password).
+      #       should validate_length_of(:password).
       #         is_at_least(10).
       #         with_message("Password isn't long enough")
       #     end
@@ -149,7 +149,7 @@ module Shoulda
       #     # RSpec
       #     describe User do
       #       it do
-      #         should ensure_length_of(:secret_key).
+      #         should validate_length_of(:secret_key).
       #           is_at_least(15).
       #           with_short_message('Secret key must be more than 15 characters')
       #       end
@@ -157,7 +157,7 @@ module Shoulda
       #
       #     # Test::Unit
       #     class UserTest < ActiveSupport::TestCase
-      #       should ensure_length_of(:secret_key).
+      #       should validate_length_of(:secret_key).
       #         is_at_least(15).
       #         with_short_message('Secret key must be more than 15 characters')
       #     end
@@ -178,7 +178,7 @@ module Shoulda
       #     # RSpec
       #     describe User do
       #       it do
-      #         should ensure_length_of(:secret_key).
+      #         should validate_length_of(:secret_key).
       #           is_at_most(100).
       #           with_long_message('Secret key must be less than 100 characters')
       #       end
@@ -186,19 +186,29 @@ module Shoulda
       #
       #     # Test::Unit
       #     class UserTest < ActiveSupport::TestCase
-      #       should ensure_length_of(:secret_key).
+      #       should validate_length_of(:secret_key).
       #         is_at_most(100).
       #         with_long_message('Secret key must be less than 100 characters')
       #     end
       #
-      # @return [EnsureLengthOfMatcher]
+      # @return [ValidateLengthOfMatcher]
       #
+      def validate_length_of(attr)
+        ValidateLengthOfMatcher.new(attr)
+      end
+
+      # @deprecated Use {#validate_length_of} instead.
+      # @return [ValidateLengthOfMatcher]
       def ensure_length_of(attr)
-        EnsureLengthOfMatcher.new(attr)
+        Shoulda::Matchers.warn_about_deprecated_method(
+          :ensure_length_of,
+          :validate_length_of
+        )
+        validate_length_of(attr)
       end
 
       # @private
-      class EnsureLengthOfMatcher < ValidationMatcher
+      class ValidateLengthOfMatcher < ValidationMatcher
         include Helpers
 
         def initialize(attribute)

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

@@ -57,6 +57,27 @@ module Shoulda
       #
       # #### Qualifiers
       #
+      # ##### on
+      #
+      # Use `on` if your validation applies only under a certain context.
+      #
+      #     class Robot
+      #       include ActiveModel::Model
+      #       attr_accessor :arms
+      #
+      #       validates_presence_of :arms, on: :create
+      #     end
+      #
+      #     # RSpec
+      #     describe Robot do
+      #       it { should validate_presence_of(:arms).on(:create) }
+      #     end
+      #
+      #     # Test::Unit
+      #     class RobotTest < ActiveSupport::TestCase
+      #       should validate_presence_of(:arms).on(:create)
+      #     end
+      #
       # ##### with_message
       #
       # Use `with_message` if you are using a custom validation message.

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

@@ -29,9 +29,9 @@ module Shoulda
 
         def messages_description
           if errors.empty?
-            'no errors'
+            ' no errors'
           else
-            "errors: #{pretty_error_messages(validated_instance)}"
+            " errors:\n#{pretty_error_messages(validated_instance)}"
           end
         end
 

data/lib/shoulda/matchers/active_record.rb

@@ -16,6 +16,8 @@ require "shoulda/matchers/active_record/have_readonly_attribute_matcher"
 require "shoulda/matchers/active_record/serialize_matcher"
 require "shoulda/matchers/active_record/accept_nested_attributes_for_matcher"
 require "shoulda/matchers/active_record/define_enum_for_matcher"
+require "shoulda/matchers/active_record/uniqueness"
+require "shoulda/matchers/active_record/validate_uniqueness_of_matcher"
 
 module Shoulda
   module Matchers

data/lib/shoulda/matchers/active_record/association_matcher.rb

@@ -100,6 +100,28 @@ module Shoulda
       #       should belong_to(:ancient_city).class_name('City')
       #     end
       #
+      # ##### with_primary_key
+      #
+      # Use `with_primary_key` to test usage of the `:primary_key` option.
+      #
+      #     class Person < ActiveRecord::Base
+      #       belongs_to :great_country, primary_key: 'country_id'
+      #     end
+      #
+      #     # RSpec
+      #     describe Person do
+      #       it do
+      #         should belong_to(:great_country).
+      #           with_primary_key('country_id')
+      #       end
+      #     end
+      #
+      #     # Test::Unit
+      #     class PersonTest < ActiveSupport::TestCase
+      #       should belong_to(:great_country).
+      #         with_primary_key('country_id')
+      #     end
+      #
       # ##### with_foreign_key
       #
       # Use `with_foreign_key` to test usage of the `:foreign_key` option.
@@ -295,6 +317,24 @@ module Shoulda
       #       should have_many(:hopes).class_name('Dream')
       #     end
       #
+      # ##### with_primary_key
+      #
+      # Use `with_primary_key` to test usage of the `:primary_key` option.
+      #
+      #     class Person < ActiveRecord::Base
+      #       has_many :worries, primary_key: 'worrier_id'
+      #     end
+      #
+      #     # RSpec
+      #     describe Person do
+      #       it { should have_many(:worries).with_primary_key('worrier_id') }
+      #     end
+      #
+      #     # Test::Unit
+      #     class PersonTest < ActiveSupport::TestCase
+      #       should have_many(:worries).with_primary_key('worrier_id')
+      #     end
+      #
       # ##### with_foreign_key
       #
       # Use `with_foreign_key` to test usage of the `:foreign_key` option.
@@ -511,6 +551,24 @@ module Shoulda
       #       should have_one(:contract).dependent(:nullify)
       #     end
       #
+      # ##### with_primary_key
+      #
+      # Use `with_primary_key` to test usage of the `:primary_key` option.
+      #
+      #     class Person < ActiveRecord::Base
+      #       has_one :job, primary_key: 'worker_id'
+      #     end
+      #
+      #     # RSpec
+      #     describe Person do
+      #       it { should have_one(:job).with_primary_key('worker_id') }
+      #     end
+      #
+      #     # Test::Unit
+      #     class PersonTest < ActiveSupport::TestCase
+      #       should have_one(:job).with_primary_key('worker_id')
+      #     end
+      #
       # ##### with_foreign_key
       #
       # Use `with_foreign_key` to test usage of the `:foreign_key` option.
@@ -814,6 +872,11 @@ module Shoulda
           self
         end
 
+        def with_primary_key(primary_key)
+          @options[:primary_key] = primary_key
+          self
+        end
+
         def validate(validate = true)
           @options[:validate] = validate
           self
@@ -846,6 +909,7 @@ module Shoulda
             macro_correct? &&
             (polymorphic? || class_exists?) &&
             foreign_key_exists? &&
+            primary_key_exists? &&
             class_name_correct? &&
             join_table_correct? &&
             autosave_correct? &&
@@ -889,7 +953,7 @@ module Shoulda
         end
 
         def missing_options
-          missing_options = [missing, failing_submatchers.map(&:missing_option)]
+          missing_options = [missing, missing_options_for_failing_submatchers]
           missing_options.flatten.compact.join(', ')
         end
 
@@ -899,6 +963,14 @@ module Shoulda
           end
         end
 
+        def missing_options_for_failing_submatchers
+          if defined?(@failing_submatchers)
+            @failing_submatchers.map(&:missing_option)
+          else
+            []
+          end
+        end
+
         def association_exists?
           if reflection.nil?
             @missing = "no association called #{name}"
@@ -920,10 +992,19 @@ module Shoulda
           end
         end
 
+        def macro_supports_primary_key?
+          macro == :belongs_to || 
+            ([:has_many, :has_one].include?(macro) && !through?)
+        end
+
         def foreign_key_exists?
           !(belongs_foreign_key_missing? || has_foreign_key_missing?)
         end
 
+        def primary_key_exists?
+          !macro_supports_primary_key? || primary_key_correct?(model_class)
+        end
+
         def belongs_foreign_key_missing?
           macro == :belongs_to && !class_has_foreign_key?(model_class)
         end
@@ -936,7 +1017,7 @@ module Shoulda
 
         def class_name_correct?
           if options.key?(:class_name)
-            if option_verifier.correct_for_string?(:class_name, options[:class_name])
+            if option_verifier.correct_for_constant?(:class_name, options[:class_name])
               true
             else
               @missing = "#{name} should resolve to #{options[:class_name]} for class_name"
@@ -1026,6 +1107,19 @@ module Shoulda
           end
         end
 
+        def primary_key_correct?(klass)
+          if options.key?(:primary_key)
+            if option_verifier.correct_for_string?(:primary_key, options[:primary_key])
+              true
+            else
+              @missing = "#{klass} does not have a #{options[:primary_key]} primary key"
+              false
+            end
+          else
+            true
+          end
+        end
+
         def foreign_key
           if foreign_key_reflection
             if foreign_key_reflection.respond_to?(:foreign_key)

data/lib/shoulda/matchers/active_record/association_matchers/join_table_matcher.rb

@@ -51,7 +51,7 @@ module Shoulda
 
           def missing_columns
             @missing_columns ||= expected_join_table_columns.select do |key|
-              !actual_join_table_columns.include?(key)
+              !actual_join_table_columns.include?(key.to_s)
             end
           end
 

data/lib/shoulda/matchers/active_record/association_matchers/model_reflection.rb

@@ -48,10 +48,10 @@ module Shoulda
           def foreign_key
             if has_and_belongs_to_many_reflection
               has_and_belongs_to_many_reflection.foreign_key
-            elsif reflection.respond_to?(:primary_key_name)
-              reflection.primary_key_name
-            else
+            elsif reflection.respond_to?(:foreign_key)
               reflection.foreign_key
+            else
+              reflection.primary_key_name
             end
           end
 

data/lib/shoulda/matchers/active_record/association_matchers/option_verifier.rb

@@ -24,6 +24,10 @@ module Shoulda
             correct_for?(:hash, name, expected_value)
           end
 
+          def correct_for_constant?(name, expected_unresolved_value)
+            correct_for?(:constant, name, expected_unresolved_value)
+          end
+
           def correct_for_relation_clause?(name, expected_value)
             correct_for?(:relation_clause, name, expected_value)
           end
@@ -50,7 +54,7 @@ module Shoulda
             if expected_value.nil?
               true
             else
-              expected_value = type_cast(type, expected_value_for(name, expected_value))
+              expected_value = type_cast(type, expected_value_for(type, name, expected_value))
               actual_value = type_cast(type, actual_value_for(name))
               expected_value == actual_value
             end
@@ -65,9 +69,11 @@ module Shoulda
             end
           end
 
-          def expected_value_for(name, value)
+          def expected_value_for(type, name, value)
             if RELATION_OPTIONS.include?(name)
               expected_value_for_relation_clause(name, value)
+            elsif type == :constant
+              expected_value_for_constant(value)
             else
               value
             end
@@ -78,6 +84,20 @@ module Shoulda
             reflector.extract_relation_clause_from(relation, name)
           end
 
+          def expected_value_for_constant(name)
+            namespace = Shoulda::Matchers::Util.deconstantize(
+              reflector.model_class.to_s
+            )
+
+            ["#{namespace}::#{name}", name].each do |path|
+              constant = Shoulda::Matchers::Util.safe_constantize(path)
+
+              if constant
+                return constant
+              end
+            end
+          end
+
           def actual_value_for_relation_clause(name)
             reflector.extract_relation_clause_from(reflector.association_relation, name)
           end