shoulda-activemodel 0.0.2

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

@@ -0,0 +1,87 @@
+module Shoulda # :nodoc:
+  module ActiveModel # :nodoc:
+    module Matchers
+
+      # Ensure that the attribute's value is in the range specified
+      #
+      # Options:
+      # * <tt>in_range</tt> - the range of allowed values for this attribute
+      # * <tt>with_low_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. Regexp or string. Defaults to the
+      #   translation for :inclusion.
+      # * <tt>with_high_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. Regexp or string. Defaults to the
+      #   translation for :inclusion.
+      #
+      # Example:
+      #   it { should ensure_inclusion_of(:age).in_range(0..100) }
+      #
+      def ensure_inclusion_of(attr)
+        EnsureInclusionOfMatcher.new(attr)
+      end
+
+      class EnsureInclusionOfMatcher < ValidationMatcher # :nodoc:
+
+        def in_range(range)
+          @range = range
+          @minimum = range.first
+          @maximum = range.last
+          self
+        end
+
+        def with_message(message)
+          if message
+            @low_message = message
+            @high_message = message
+          end
+          self
+        end
+
+        def with_low_message(message)
+          @low_message = message if message
+          self
+        end
+
+        def with_high_message(message)
+          @high_message = message if message
+          self
+        end
+
+        def description
+          "ensure inclusion of #{@attribute} in #{@range.inspect}"
+        end
+
+        def matches?(subject)
+          super(subject)
+
+          @low_message  ||= :inclusion
+          @high_message ||= :inclusion
+
+          disallows_lower_value && 
+            allows_minimum_value &&
+            disallows_higher_value &&
+            allows_maximum_value
+        end
+
+        private
+
+        def disallows_lower_value
+          @minimum == 0 || disallows_value_of(@minimum - 1, @low_message)
+        end
+
+        def disallows_higher_value
+          disallows_value_of(@maximum + 1, @high_message)
+        end
+
+        def allows_minimum_value
+          allows_value_of(@minimum, @low_message)
+        end
+
+        def allows_maximum_value
+          allows_value_of(@maximum, @high_message)
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+module Shoulda # :nodoc:
+  module ActiveModel # :nodoc:
+    module Matchers
+
+      # Ensures that the length of the attribute is validated.
+      #
+      # Options:
+      # * <tt>is_at_least</tt> - minimum length of this attribute
+      # * <tt>is_at_most</tt> - maximum length of this attribute
+      # * <tt>is_equal_to</tt> - exact requred length of this attribute
+      # * <tt>with_short_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. Regexp or string.  Defaults to the
+      #   translation for :too_short.
+      # * <tt>with_long_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. Regexp or string.  Defaults to the
+      #   translation for :too_long.
+      # * <tt>with_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. Regexp or string.  Defaults to the
+      #   translation for :wrong_length. Used in conjunction with
+      #   <tt>is_equal_to</tt>.
+      #
+      # Examples:
+      #   it { should ensure_length_of(:password).
+      #                 is_at_least(6).
+      #                 is_at_most(20) }
+      #   it { should ensure_length_of(:name).
+      #                 is_at_least(3).
+      #                 with_short_message(/not long enough/) }
+      #   it { should ensure_length_of(:ssn).
+      #                 is_equal_to(9).
+      #                 with_message(/is invalid/) }
+      def ensure_length_of(attr)
+        EnsureLengthOfMatcher.new(attr)
+      end
+
+      class EnsureLengthOfMatcher < ValidationMatcher # :nodoc:
+        include Helpers
+
+        def is_at_least(length)
+          @minimum = length
+          @short_message ||= :too_short
+          self
+        end
+
+        def is_at_most(length)
+          @maximum = length
+          @long_message ||= :too_long
+          self
+        end
+
+        def is_equal_to(length)
+          @minimum = length
+          @maximum = length
+          @short_message ||= :wrong_length
+          self
+        end
+
+        def with_short_message(message)
+          @short_message = message if message
+          self
+        end
+        alias_method :with_message, :with_short_message
+
+        def with_long_message(message)
+          @long_message = message if message
+          self
+        end
+
+        def description
+          description =  "ensure #{@attribute} has a length "
+          if @minimum && @maximum
+            if @minimum == @maximum
+              description << "of exactly #{@minimum}"
+            else
+              description << "between #{@minimum} and #{@maximum}"
+            end
+          else
+            description << "of at least #{@minimum}" if @minimum
+            description << "of at most #{@maximum}" if @maximum
+          end
+          description
+        end
+
+        def matches?(subject)
+          super(subject)
+          translate_messages!
+          disallows_lower_length && 
+            allows_minimum_length &&
+            ((@minimum == @maximum) ||
+              (disallows_higher_length &&
+              allows_maximum_length))
+        end
+
+        private
+
+        def translate_messages!
+          if Symbol === @short_message
+            @short_message = default_error_message(@short_message,
+                                                   :count => @minimum)
+          end
+
+          if Symbol === @long_message
+            @long_message = default_error_message(@long_message,
+                                                  :count => @maximum)
+          end
+        end
+
+        def disallows_lower_length
+          @minimum == 0 || 
+            @minimum.nil? ||
+            disallows_length_of(@minimum - 1, @short_message)
+        end
+
+        def disallows_higher_length
+          @maximum.nil? || disallows_length_of(@maximum + 1, @long_message)
+        end
+
+        def allows_minimum_length
+          allows_length_of(@minimum, @short_message)
+        end
+
+        def allows_maximum_length
+          allows_length_of(@maximum, @long_message)
+        end
+
+        def allows_length_of(length, message)
+          length.nil? || allows_value_of(string_of_length(length), message)
+        end
+
+        def disallows_length_of(length, message)
+          length.nil? || disallows_value_of(string_of_length(length), message)
+        end
+
+        def string_of_length(length)
+          'x' * length
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Shoulda # :nodoc:
+  module ActiveModel # :nodoc:
+    module Matchers
+
+      # Ensures that the model cannot be saved the given attribute is not
+      # accepted.
+      #
+      # Options:
+      # * <tt>with_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. Regexp or string.  Defaults to the
+      #   translation for <tt>:accepted</tt>.
+      #
+      # Example:
+      #   it { should validate_acceptance_of(:eula) }
+      #
+      def validate_acceptance_of(attr)
+        ValidateAcceptanceOfMatcher.new(attr)
+      end
+
+      class ValidateAcceptanceOfMatcher < ValidationMatcher # :nodoc:
+
+        def with_message(message)
+          @expected_message = message if message
+          self
+        end
+
+        def matches?(subject)
+          super(subject)
+          @expected_message ||= :accepted
+          disallows_value_of(false, @expected_message)
+        end
+
+        def description
+          "require #{@attribute} to be accepted"
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+module Shoulda # :nodoc:
+  module ActiveModel # :nodoc:
+    module Matchers
+
+      # Ensures that the model is not valid if the given attribute is not
+      # formatted correctly.
+      #
+      # Options:
+      # * <tt>with_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. <tt>Regexp</tt> or <tt>String</tt>.
+      #   Defaults to the translation for <tt>:blank</tt>.
+      # * <tt>with(string to test against)</tt>
+      # * <tt>not_with(string to test against)</tt>
+      #
+      # Examples:
+      #   it { should validate_format_of(:name).
+      #                 with('12345').
+      #                 with_message(/is not optional/) }
+      #   it { should validate_format_of(:name).
+      #                 not_with('12D45').
+      #                 with_message(/is not optional/) }
+      #
+      def validate_format_of(attr)
+        ValidateFormatOfMatcher.new(attr)
+      end
+
+      class ValidateFormatOfMatcher < ValidationMatcher # :nodoc:
+        
+        def initialize(attribute)
+          super
+        end
+
+        def with_message(message)
+          @expected_message = message if message
+          self
+        end
+        
+        def with(value)
+          raise "You may not call both with and not_with" if @value_to_fail
+          @value_to_pass = value
+          self
+        end
+        
+
+        def not_with(value)
+          raise "You may not call both with and not_with" if @value_to_pass
+          @value_to_fail = value
+          self
+        end
+
+
+        def matches?(subject)
+          super(subject)
+          @expected_message ||= :blank
+          return disallows_value_of(@value_to_fail, @expected_message) if @value_to_fail
+          allows_value_of(@value_to_pass, @expected_message) if @value_to_pass
+        end
+
+        def description
+          "#{@attribute} have a valid format"
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Shoulda # :nodoc:
+  module ActiveModel # :nodoc:
+    module Matchers
+
+      # Ensure that the attribute is numeric
+      #
+      # Options:
+      # * <tt>with_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. Regexp or string.  Defaults to the
+      #   translation for <tt>:not_a_number</tt>.
+      #
+      # Example:
+      #   it { should validate_numericality_of(:age) }
+      #
+      def validate_numericality_of(attr)
+        ValidateNumericalityOfMatcher.new(attr)
+      end
+
+      class ValidateNumericalityOfMatcher < ValidationMatcher # :nodoc:
+
+        def with_message(message)
+          @expected_message = message if message
+          self
+        end
+
+        def matches?(subject)
+          super(subject)
+          @expected_message ||= :not_a_number
+          disallows_value_of('abcd', @expected_message)
+        end
+
+        def description
+          "only allow numeric values for #{@attribute}"
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+module Shoulda # :nodoc:
+  module ActiveModel # :nodoc:
+    module Matchers
+
+      # Ensures that the model is not valid if the given attribute is not
+      # present.
+      #
+      # Options:
+      # * <tt>with_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. <tt>Regexp</tt> or <tt>String</tt>.
+      #   Defaults to the translation for <tt>:blank</tt>.
+      #
+      # Examples:
+      #   it { should validate_presence_of(:name) }
+      #   it { should validate_presence_of(:name).
+      #                 with_message(/is not optional/) }
+      #
+      def validate_presence_of(attr)
+        ValidatePresenceOfMatcher.new(attr)
+      end
+
+      class ValidatePresenceOfMatcher < ValidationMatcher # :nodoc:
+
+        def with_message(message)
+          @expected_message = message if message
+          self
+        end
+
+        def matches?(subject)
+          super(subject)
+          @expected_message ||= :blank
+          disallows_value_of(blank_value, @expected_message)
+        end
+
+        def description
+          "require #{@attribute} to be set"
+        end
+
+        private
+
+        def blank_value
+          if collection?
+            []
+          else
+            nil
+          end
+        end
+
+        def collection?
+          if reflection = @subject.class.reflect_on_association(@attribute)
+            [:has_many, :has_and_belongs_to_many].include?(reflection.macro)
+          else
+            false
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,148 @@
+module Shoulda # :nodoc:
+  module ActiveModel # :nodoc:
+    module Matchers
+
+      # Ensures that the model is invalid if the given attribute is not unique.
+      #
+      # Internally, this uses values from existing models to test validations,
+      # so this will always fail if you have not saved at least one model for
+      # the model being tested, like so:
+      #
+      #   describe User do
+      #     before(:each) { User.create!(:email => 'address@example.com') }
+      #     it { should validate_uniqueness_of(:email) }
+      #   end
+      #
+      # Options:
+      #
+      # * <tt>with_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. <tt>Regexp</tt> or <tt>String</tt>.
+      #   Defaults to the translation for <tt>:taken</tt>.
+      # * <tt>scoped_to</tt> - field(s) to scope the uniqueness to.
+      # * <tt>case_insensitive</tt> - ensures that the validation does not
+      #   check case. Off by default. Ignored by non-text attributes.
+      #
+      # Examples:
+      #   it { should validate_uniqueness_of(:keyword) }
+      #   it { should validate_uniqueness_of(:keyword).with_message(/dup/) }
+      #   it { should validate_uniqueness_of(:email).scoped_to(:name) }
+      #   it { should validate_uniqueness_of(:email).
+      #                 scoped_to(:first_name, :last_name) }
+      #   it { should validate_uniqueness_of(:keyword).case_insensitive }
+      #
+      def validate_uniqueness_of(attr)
+        ValidateUniquenessOfMatcher.new(attr)
+      end
+
+      class ValidateUniquenessOfMatcher < ValidationMatcher # :nodoc:
+        include Helpers
+
+        def initialize(attribute)
+          @attribute = attribute
+        end
+
+        def scoped_to(*scopes)
+          @scopes = [*scopes].flatten
+          self
+        end
+
+        def with_message(message)
+          @expected_message = message
+          self
+        end
+
+        def case_insensitive
+          @case_insensitive = true
+          self
+        end
+
+        def description
+          result = "require "
+          result << "case sensitive " unless @case_insensitive
+          result << "unique value for #{@attribute}"
+          result << " scoped to #{@scopes.join(', ')}" unless @scopes.blank?
+          result
+        end
+
+        def matches?(subject)
+          @subject = subject.class.new
+          @expected_message ||= :taken
+          find_existing && 
+            set_scoped_attributes && 
+            validate_attribute &&
+            validate_after_scope_change
+        end
+
+        private
+
+        def find_existing
+          if @existing = @subject.class.find(:first)
+            true
+          else
+            @failure_message = "Can't find first #{class_name}"
+            false
+          end
+        end
+
+        def set_scoped_attributes
+          unless @scopes.blank?
+            @scopes.each do |scope|
+              setter = :"#{scope}="
+              unless @subject.respond_to?(setter)
+                @failure_message =
+                  "#{class_name} doesn't seem to have a #{scope} attribute."
+                return false
+              end
+              @subject.send("#{scope}=", @existing.send(scope))
+            end
+          end
+          true
+        end
+
+        def validate_attribute
+          disallows_value_of(existing_value, @expected_message)
+        end
+
+        # TODO:  There is a chance that we could change the scoped field
+        # to a value that's already taken.  An alternative implementation
+        # could actually find all values for scope and create a unique
+        def validate_after_scope_change
+          if @scopes.blank?
+            true
+          else
+            @scopes.all? do |scope|
+              previous_value = @existing.send(scope)
+
+              # Assume the scope is a foreign key if the field is nil
+              previous_value ||= 0
+
+              next_value = previous_value.next
+
+              @subject.send("#{scope}=", next_value)
+
+              if allows_value_of(existing_value, @expected_message)
+                @negative_failure_message << 
+                  " (with different value of #{scope})"
+                true
+              else
+                @failure_message << " (with different value of #{scope})"
+                false
+              end
+            end
+          end
+        end
+
+        def class_name
+          @subject.class.name
+        end
+
+        def existing_value
+          value = @existing.send(@attribute)
+          value.swapcase! if @case_insensitive && value.respond_to?(:swapcase!)
+          value
+        end
+      end
+
+    end
+  end
+end