shoulda 2.0.6 → 2.9.0

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

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

@@ -0,0 +1,141 @@
+module Shoulda # :nodoc:
+  module ActiveRecord # :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_record/matchers/have_db_column_matcher.rb

@@ -0,0 +1,169 @@
+module Shoulda # :nodoc:
+  module ActiveRecord # :nodoc:
+    module Matchers
+
+      # Ensures the database column exists.
+      #
+      # Options:
+      # * <tt>of_type</tt> - db column type (:integer, :string, etc.)
+      # * <tt>with_options</tt> - same options available in migrations
+      #   (:default, :null, :limit, :precision, :scale)
+      #
+      # Examples:
+      #   it { should_not have_db_column(:admin).of_type(:boolean) }
+      #   it { should have_db_column(:salary).
+      #                 of_type(:decimal).
+      #                 with_options(:precision => 10, :scale => 2) }
+      #
+      def have_db_column(column)
+        HaveDbColumnMatcher.new(:have_db_column, column)
+      end
+
+      class HaveDbColumnMatcher # :nodoc:
+        def initialize(macro, column)
+          @macro  = macro
+          @column = column
+        end
+        
+        def of_type(column_type)
+          @column_type = column_type
+          self
+        end
+        
+        def with_options(opts = {})
+          @precision = opts[:precision]
+          @limit     = opts[:limit]
+          @default   = opts[:default]
+          @null      = opts[:null]
+          @scale     = opts[:scale]
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          column_exists? && 
+            correct_column_type? && 
+            correct_precision? &&
+            correct_limit? &&
+            correct_default? &&
+            correct_null? &&
+            correct_scale?
+        end
+
+        def failure_message
+          "Expected #{expectation} (#{@missing})"
+        end
+
+        def negative_failure_message
+          "Did not expect #{expectation}"
+        end
+
+        def description
+          desc = "have db column named #{@column}"
+          desc << " of type #{@column_type}"    unless @column_type.nil?
+          desc << " of precision #{@precision}" unless @precision.nil?
+          desc << " of limit #{@limit}"         unless @limit.nil?
+          desc << " of default #{@default}"     unless @default.nil?
+          desc << " of null #{@null}"           unless @null.nil?
+          desc << " of primary #{@primary}"     unless @primary.nil?
+          desc << " of scale #{@scale}"         unless @scale.nil?
+          desc
+        end
+
+        protected
+
+        def column_exists?
+          if model_class.column_names.include?(@column.to_s)
+            true
+          else
+            @missing = "#{model_class} does not have a db column named #{@column}."
+            false
+          end
+        end
+        
+        def correct_column_type?
+          return true if @column_type.nil?
+          if matched_column.type.to_s == @column_type.to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of type #{matched_column.type}, not #{@column_type}."
+            false
+          end
+        end
+        
+        def correct_precision?
+          return true if @precision.nil?
+          if matched_column.precision.to_s == @precision.to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of precision #{matched_column.precision}, " <<
+                       "not #{@precision}."
+            false
+          end
+        end
+        
+        def correct_limit?
+          return true if @limit.nil?
+          if matched_column.limit.to_s == @limit.to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of limit #{matched_column.limit}, " <<
+                       "not #{@limit}."
+            false
+          end
+        end
+        
+        def correct_default?
+          return true if @default.nil?
+          if matched_column.default.to_s == @default.to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of default #{matched_column.default}, " <<
+                       "not #{@default}."
+            false
+          end
+        end
+        
+        def correct_null?
+          return true if @null.nil?
+          if matched_column.null.to_s == @null.to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of null #{matched_column.null}, " <<
+                       "not #{@null}."
+            false
+          end
+        end
+                
+        def correct_scale?
+          return true if @scale.nil?
+          if matched_column.scale.to_s == @scale.to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of scale #{matched_column.scale}, not #{@scale}."
+            false
+          end
+        end
+        
+        def matched_column
+          model_class.columns.detect { |each| each.name == @column.to_s }
+        end
+
+        def model_class
+          @subject.class
+        end
+
+        def expectation
+          expected = "#{model_class.name} to #{description}"
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+module Shoulda # :nodoc:
+  module ActiveRecord # :nodoc:
+    module Matchers
+
+      # Ensures that there are DB indices on the given columns or tuples of
+      # columns.
+      #
+      # Options:
+      # * <tt>unique</tt> - whether or not the index has a unique
+      #   constraint. Use <tt>true</tt> to explicitly test for a unique
+      #   constraint.  Use <tt>false</tt> to explicitly test for a non-unique
+      #   constraint. Use <tt>nil</tt> if you don't care whether the index is
+      #   unique or not.  Default = <tt>nil</tt>
+      #
+      # Examples:
+      #
+      #   it { should have_index(:age) }
+      #   it { should have_index([:commentable_type, :commentable_id]) }
+      #   it { should have_index(:ssn).unique(true) }
+      #
+      def have_index(columns)
+        HaveIndexMatcher.new(:have_index, columns)
+      end
+
+      class HaveIndexMatcher # :nodoc:
+        def initialize(macro, columns)
+          @macro = macro
+          @columns = normalize_columns_to_array(columns)
+        end
+        
+        def unique(unique)
+          @unique = unique
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          index_exists? && correct_unique?
+        end
+
+        def failure_message
+          "Expected #{expectation} (#{@missing})"
+        end
+
+        def negative_failure_message
+          "Did not expect #{expectation}"
+        end
+
+        def description
+          "have a #{index_type} index on columns #{@columns}"
+        end
+
+        protected
+        
+        def index_exists?
+          ! matched_index.nil?
+        end
+        
+        def correct_unique?
+          return true if @unique.nil?
+          if matched_index.unique == @unique
+            true
+          else
+            @missing = "#{table_name} has an index named #{matched_index.name} " <<
+                       "of unique #{matched_index.unique}, not #{@unique}."
+            false
+          end
+        end
+        
+        def matched_index
+          indexes.detect { |each| each.columns == @columns }
+        end
+
+        def model_class
+          @subject.class
+        end
+        
+        def table_name
+          model_class.table_name
+        end
+        
+        def indexes
+          ::ActiveRecord::Base.connection.indexes(table_name)
+        end
+
+        def expectation
+          expected = "#{model_class.name} to #{description}"
+        end
+        
+        def index_type
+          @unique ? "unique" : "non-unique"
+        end
+        
+        def normalize_columns_to_array(columns)
+          if columns.class == Array
+            columns.collect { |each| each.to_s }
+          else
+            [columns.to_s]
+          end
+        end
+      end
+
+    end
+  end
+end