shoulda-matchers 1.0.0.beta1

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

@@ -0,0 +1,110 @@
+module Shoulda # :nodoc:
+  module Matchers
+    module ActiveRecord # :nodoc:
+
+      # Ensures that the attribute can be set to the given value.
+      #
+      # Options:
+      # * <tt>with_message</tt> - value the test expects to find in
+      #   <tt>errors.on(:attribute)</tt>. Regexp or string. If omitted,
+      #   the test looks for any errors in <tt>errors.on(:attribute)</tt>.
+      #
+      # Example:
+      #   it { should_not allow_value('bad').for(:isbn) }
+      #   it { should allow_value("isbn 1 2345 6789 0").for(:isbn) }
+      #
+      def allow_value(value)
+        AllowValueMatcher.new(value)
+      end
+
+      class AllowValueMatcher # :nodoc:
+        include Helpers
+
+        def initialize(value)
+          @value = value
+        end
+
+        def for(attribute)
+          @attribute = attribute
+          self
+        end
+
+        def with_message(message)
+          @expected_message = message if message
+          self
+        end
+
+        def matches?(instance)
+          @instance = instance
+          if Symbol === @expected_message
+            @expected_message = default_error_message(@expected_message)
+          end
+          @instance.send("#{@attribute}=", @value)
+          !errors_match?
+        end
+
+        def failure_message
+          "Did not expect #{expectation}, got error: #{@matched_error}"
+        end
+
+        def negative_failure_message
+          "Expected #{expectation}, got #{error_description}"
+        end
+
+        def description
+          "allow #{@attribute} to be set to #{@value.inspect}"
+        end
+
+        private
+
+        def errors_match?
+          @instance.valid?
+          @errors = errors_for_attribute(@instance, @attribute)
+          @errors = [@errors] unless @errors.is_a?(Array)
+          @expected_message ? (errors_match_regexp? || errors_match_string?) : (@errors.compact.any?)
+        end
+
+        def errors_for_attribute(instance, attribute)
+          if instance.errors.respond_to?(:[])
+            instance.errors[attribute]
+          else
+            instance.errors.on(attribute)
+          end
+        end
+
+        def errors_match_regexp?
+          if Regexp === @expected_message
+            @matched_error = @errors.detect { |e| e =~ @expected_message }
+            !@matched_error.nil?
+          else
+            false
+          end
+        end
+
+        def errors_match_string?
+          if @errors.include?(@expected_message)
+            @matched_error = @expected_message
+            true
+          else
+            false
+          end
+        end
+
+        def expectation
+          "errors " <<
+          (@expected_message ? "to include #{@expected_message.inspect} " : "") <<
+          "when #{@attribute} is set to #{@value.inspect}"
+        end
+
+        def error_description
+          if @instance.errors.empty?
+            "no errors"
+          else
+            "errors: #{pretty_error_messages(@instance)}"
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,226 @@
+module Shoulda # :nodoc:
+  module Matchers
+    module ActiveRecord # :nodoc:
+
+      # Ensure that the belongs_to relationship exists.
+      #
+      #   it { should belong_to(:parent) }
+      #
+      def belong_to(name)
+        AssociationMatcher.new(:belongs_to, name)
+      end
+
+      # Ensures that the has_many relationship exists.  Will also test that the
+      # associated table has the required columns.  Works with polymorphic
+      # associations.
+      #
+      # Options:
+      # * <tt>through</tt> - association name for <tt>has_many :through</tt>
+      # * <tt>dependent</tt> - tests that the association makes use of the
+      #   dependent option.
+      #
+      # Example:
+      #   it { should have_many(:friends) }
+      #   it { should have_many(:enemies).through(:friends) }
+      #   it { should have_many(:enemies).dependent(:destroy) }
+      #
+      def have_many(name)
+        AssociationMatcher.new(:has_many, name)
+      end
+
+      # Ensure that the has_one relationship exists.  Will also test that the
+      # associated table has the required columns.  Works with polymorphic
+      # associations.
+      #
+      # Options:
+      # * <tt>:dependent</tt> - tests that the association makes use of the
+      #   dependent option.
+      #
+      # Example:
+      #   it { should have_one(:god) } # unless hindu
+      #
+      def have_one(name)
+        AssociationMatcher.new(:has_one, name)
+      end
+
+      # Ensures that the has_and_belongs_to_many relationship exists, and that
+      # the join table is in place.
+      #
+      #   it { should have_and_belong_to_many(:posts) }
+      #
+      def have_and_belong_to_many(name)
+        AssociationMatcher.new(:has_and_belongs_to_many, name)
+      end
+
+      class AssociationMatcher # :nodoc:
+        def initialize(macro, name)
+          @macro = macro
+          @name  = name
+        end
+
+        def through(through)
+          @through = through
+          self
+        end
+
+        def dependent(dependent)
+          @dependent = dependent
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          association_exists? &&
+            macro_correct? &&
+            foreign_key_exists? &&
+            through_association_valid? &&
+            dependent_correct? &&
+            join_table_exists?
+        end
+
+        def failure_message
+          "Expected #{expectation} (#{@missing})"
+        end
+
+        def negative_failure_message
+          "Did not expect #{expectation}"
+        end
+
+        def description
+          description = "#{macro_description} #{@name}"
+          description += " through #{@through}" if @through
+          description += " dependent => #{@dependent}" if @dependent
+          description
+        end
+
+        protected
+
+        def association_exists?
+          if reflection.nil?
+            @missing = "no association called #{@name}"
+            false
+          else
+            true
+          end
+        end
+
+        def macro_correct?
+          if reflection.macro == @macro
+            true
+          else
+            @missing = "actual association type was #{reflection.macro}"
+            false
+          end
+        end
+
+        def foreign_key_exists?
+          !(belongs_foreign_key_missing? || has_foreign_key_missing?)
+        end
+
+        def belongs_foreign_key_missing?
+          @macro == :belongs_to && !class_has_foreign_key?(model_class)
+        end
+
+        def has_foreign_key_missing?
+          [:has_many, :has_one].include?(@macro) &&
+            !through? &&
+            !class_has_foreign_key?(associated_class)
+        end
+
+        def through_association_valid?
+          @through.nil? || (through_association_exists? && through_association_correct?)
+        end
+
+        def through_association_exists?
+          if through_reflection.nil?
+            @missing = "#{model_class.name} does not have any relationship to #{@through}"
+            false
+          else
+            true
+          end
+        end
+
+        def through_association_correct?
+          if @through == reflection.options[:through]
+            true
+          else
+            @missing = "Expected #{model_class.name} to have #{@name} through #{@through}, " <<
+              "but got it through #{reflection.options[:through]}"
+            false
+          end
+        end
+
+        def dependent_correct?
+          if @dependent.nil? || @dependent.to_s == reflection.options[:dependent].to_s
+            true
+          else
+            @missing = "#{@name} should have #{@dependent} dependency"
+            false
+          end
+        end
+
+        def join_table_exists?
+          if @macro != :has_and_belongs_to_many ||
+              ::ActiveRecord::Base.connection.tables.include?(join_table.to_s)
+            true
+          else
+            @missing = "join table #{join_table} doesn't exist"
+            false
+          end
+        end
+
+        def class_has_foreign_key?(klass)
+          if klass.column_names.include?(foreign_key.to_s)
+            true
+          else
+            @missing = "#{klass} does not have a #{foreign_key} foreign key."
+            false
+          end
+        end
+
+        def model_class
+          @subject.class
+        end
+
+        def join_table
+          reflection.options[:join_table]
+        end
+
+        def associated_class
+          reflection.klass
+        end
+
+        def foreign_key
+          reflection.primary_key_name
+        end
+
+        def through?
+          reflection.options[:through]
+        end
+
+        def reflection
+          @reflection ||= model_class.reflect_on_association(@name)
+        end
+
+        def through_reflection
+          @through_reflection ||= model_class.reflect_on_association(@through)
+        end
+
+        def expectation
+          "#{model_class.name} to have a #{@macro} association called #{@name}"
+        end
+
+        def macro_description
+          case @macro.to_s
+          when 'belongs_to' then 'belong to'
+          when 'has_many'   then 'have many'
+          when 'has_one'    then 'have one'
+          when 'has_and_belongs_to_many' then
+            'have and belong to many'
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+module Shoulda # :nodoc:
+  module Matchers
+    module ActiveRecord # :nodoc:
+
+      # 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/matchers/active_record/ensure_length_of_matcher.rb

@@ -0,0 +1,141 @@
+module Shoulda # :nodoc:
+  module Matchers
+    module ActiveRecord # :nodoc:
+
+      # 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