technicalpickles-shoulda 2.0.6 → 2.10.0

data/lib/shoulda/active_record/matchers.rb

@@ -0,0 +1,42 @@
+require 'shoulda/active_record/helpers'
+require 'shoulda/active_record/matchers/validation_matcher'
+require 'shoulda/active_record/matchers/allow_value_matcher'
+require 'shoulda/active_record/matchers/ensure_length_of_matcher'
+require 'shoulda/active_record/matchers/ensure_inclusion_of_matcher'
+require 'shoulda/active_record/matchers/validate_presence_of_matcher'
+require 'shoulda/active_record/matchers/validate_uniqueness_of_matcher'
+require 'shoulda/active_record/matchers/validate_acceptance_of_matcher'
+require 'shoulda/active_record/matchers/validate_numericality_of_matcher'
+require 'shoulda/active_record/matchers/association_matcher'
+require 'shoulda/active_record/matchers/have_db_column_matcher'
+require 'shoulda/active_record/matchers/have_index_matcher'
+require 'shoulda/active_record/matchers/have_readonly_attribute_matcher'
+require 'shoulda/active_record/matchers/allow_mass_assignment_of_matcher'
+require 'shoulda/active_record/matchers/have_named_scope_matcher'
+
+
+module Shoulda # :nodoc:
+  module ActiveRecord # :nodoc:
+    # = Matchers for your active record models
+    #
+    # These matchers will test most of the validations and associations for your
+    # ActiveRecord models.
+    #
+    #   describe User do
+    #     it { should validate_presence_of(:name) }
+    #     it { should validate_presence_of(:phone_number) }
+    #     %w(abcd 1234).each do |value|
+    #       it { should_not allow_value(value).for(:phone_number) }
+    #     end
+    #     it { should allow_value("(123) 456-7890").for(:phone_number) }
+    #     it { should_not allow_mass_assignment_of(:password) }
+    #     it { should have_one(:profile) }
+    #     it { should have_many(:dogs) }
+    #     it { should have_many(:messes).through(:dogs) }
+    #     it { should belong_to(:lover) }
+    #   end
+    #
+    module Matchers
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module Shoulda # :nodoc:
+  module ActiveRecord # :nodoc:
+    module Matchers
+
+      # Ensures that the attribute can be set on mass update.
+      #
+      #   it { should_not allow_mass_assignment_of(:password) }
+      #   it { should allow_mass_assignment_of(:first_name) }
+      #
+      def allow_mass_assignment_of(value)
+        AllowMassAssignmentOfMatcher.new(value)
+      end
+
+      class AllowMassAssignmentOfMatcher # :nodoc:
+
+        def initialize(attribute)
+          @attribute = attribute.to_s
+        end
+
+        def matches?(subject)
+          @subject = subject
+          if attr_mass_assignable?
+            if whitelisting?
+              @failure_message = "#{@attribute} was made accessible"
+            else
+              if protected_attributes.empty?
+                @failure_message = "no attributes were protected"
+              else
+                @failure_message = "#{class_name} is protecting " <<
+                  "#{protected_attributes.to_a.to_sentence}, " <<
+                  "but not #{@attribute}."
+              end
+            end
+            true
+          else
+            if whitelisting?
+              @negative_failure_message =
+                "Expected #{@attribute} to be accessible"
+            else
+              @negative_failure_message =
+                "Did not expect #{@attribute} to be protected"
+            end
+            false
+          end
+        end
+
+        attr_reader :failure_message, :negative_failure_message
+
+        def description
+          "protect #{@attribute} from mass updates"
+        end
+
+        private
+
+        def protected_attributes
+          @protected_attributes ||= (@subject.class.protected_attributes || [])
+        end
+
+        def accessible_attributes
+          @accessible_attributes ||= (@subject.class.accessible_attributes || [])
+        end
+
+        def whitelisting?
+          !accessible_attributes.empty?
+        end
+
+        def attr_mass_assignable?
+          if whitelisting?
+            accessible_attributes.include?(@attribute)
+          else
+            !protected_attributes.include?(@attribute)
+          end
+        end
+
+        def class_name
+          @subject.class.name
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+module Shoulda # :nodoc:
+  module ActiveRecord # :nodoc:
+    module Matchers
+
+      # 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. Defaults to the
+      #   translation for :invalid.
+      #
+      # 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
+          @expected_message ||= :invalid
+          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 = @instance.errors.on(@attribute)
+          @errors = [@errors] unless @errors.is_a?(Array)
+          errors_match_regexp? || errors_match_string?
+        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 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/active_record/matchers/association_matcher.rb

@@ -0,0 +1,226 @@
+module Shoulda # :nodoc:
+  module ActiveRecord # :nodoc:
+    module Matchers
+
+      # 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?
+            "#{model_class.name} does not have any relationship to #{@through}"
+            false
+          else
+            true
+          end
+        end
+
+        def through_association_correct?
+          if @through == reflection.options[:through]
+            "Expected #{model_class.name} to have #{@name} through #{@through}, " <<
+              " but got it through #{reflection.options[:through]}"
+            true
+          else
+            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