shoulda-matchers 1.0.0.beta1

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

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

@@ -0,0 +1,112 @@
+module Shoulda # :nodoc:
+  module Matchers
+    module ActiveRecord # :nodoc:
+
+      # 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_db_index(:age) }
+      #   it { should have_db_index([:commentable_type, :commentable_id]) }
+      #   it { should have_db_index(:ssn).unique(true) }
+      #
+      def have_db_index(columns)
+        HaveDbIndexMatcher.new(:have_index, columns)
+      end
+
+      class HaveDbIndexMatcher # :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.join(' and ')}"
+        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
+          case @unique
+          when nil
+            ''
+          when false
+            'non-unique'
+          else
+            'unique'
+          end
+        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

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

@@ -0,0 +1,59 @@
+module Shoulda # :nodoc:
+  module Matchers
+    module ActiveRecord # :nodoc:
+
+      # Ensures that the attribute cannot be changed once the record has been
+      # created.
+      #
+      #   it { should have_readonly_attributes(:password) }
+      #
+      def have_readonly_attribute(value)
+        HaveReadonlyAttributeMatcher.new(value)
+      end
+
+      class HaveReadonlyAttributeMatcher # :nodoc:
+
+        def initialize(attribute)
+          @attribute = attribute.to_s
+        end
+
+        def matches?(subject)
+          @subject = subject
+          if readonly_attributes.include?(@attribute)
+            @negative_failure_message =
+              "Did not expect #{@attribute} to be read-only"
+            true
+          else
+            if readonly_attributes.empty?
+              @failure_message = "#{class_name} attribute #{@attribute} " <<
+                "is not read-only"
+            else
+              @failure_message = "#{class_name} is making " <<
+                "#{readonly_attributes.to_sentence} " <<
+                "read-only, but not #{@attribute}."
+            end
+            false
+          end
+        end
+
+        attr_reader :failure_message, :negative_failure_message
+
+        def description
+          "make #{@attribute} read-only"
+        end
+
+        private
+
+        def readonly_attributes
+          @readonly_attributes ||= (@subject.class.readonly_attributes || [])
+        end
+
+        def class_name
+          @subject.class.name
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Shoulda # :nodoc:
+  module Matchers
+    module ActiveRecord # :nodoc:
+      module Helpers
+        def pretty_error_messages(obj) # :nodoc:
+          obj.errors.map do |a, m|
+            msg = "#{a} #{m}"
+            msg << " (#{obj.send(a).inspect})" unless a.to_sym == :base
+          end
+        end
+
+        # Helper method that determines the default error message used by Active
+        # Record.  Works for both existing Rails 2.1 and Rails 2.2 with the newly
+        # introduced I18n module used for localization.
+        #
+        #   default_error_message(:blank)
+        #   default_error_message(:too_short, :count => 5)
+        #   default_error_message(:too_long, :count => 60)
+        def default_error_message(key, values = {})
+          if Object.const_defined?(:I18n) # Rails >= 2.2
+            result = I18n.translate("activerecord.errors.messages.#{key}", values)
+            if result =~ /^translation missing/
+              I18n.translate("errors.messages.#{key}", values)
+            else
+              result
+            end
+          else # Rails <= 2.1.x
+            ::ActiveRecord::Errors.default_error_messages[key] % values[:count]
+          end
+        end
+      end
+    end
+  end
+end

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

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

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