thoughtbot--shoulda-matchers/lib/shoulda/matchers/active_model/allow_value_matcher.rb

138 lines
3.8 KiB
Ruby

module Shoulda # :nodoc:
module Matchers
module ActiveModel # :nodoc:
# Ensures that the attribute can be set to the given value or values. If
# multiple values are given the match succeeds only if all given values
# are allowed. Otherwise, the matcher fails at the first bad value in the
# argument list (the remaining arguments are not processed then).
#
# 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(*values)
if values.empty?
raise ArgumentError, "need at least one argument"
else
AllowValueMatcher.new(*values)
end
end
class AllowValueMatcher # :nodoc:
include Helpers
def initialize(*values)
@values_to_match = values
end
def for(attribute)
@attribute = attribute
self
end
def with_message(message)
@expected_message = message
self
end
def matches?(instance)
@instance = instance
@values_to_match.all? do |value|
@value = value
@instance.send("#{@attribute}=", @value)
! errors_match?
end
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 #{allowed_values}"
end
private
def errors_match?
if @instance.valid?
false
else
if expected_message
errors_match_regexp? || errors_match_string?
else
errors_for_attribute.compact.any?
end
end
end
def errors_for_attribute
if @instance.errors.respond_to?(:[])
errors = @instance.errors[@attribute]
else
errors = @instance.errors.on(@attribute)
end
Array.wrap(errors)
end
def errors_match_regexp?
if Regexp === expected_message
@matched_error = errors_for_attribute.detect { |e| e =~ expected_message }
end
end
def errors_match_string?
if errors_for_attribute.include?(expected_message)
@matched_error = expected_message
end
end
def expectation
includes_expected_message = expected_message ? "to include #{expected_message.inspect}" : ''
["errors", includes_expected_message, "when #{@attribute} is set to #{@value.inspect}"].join(' ')
end
def error_description
if @instance.errors.empty?
"no errors"
else
"errors: #{pretty_error_messages(@instance)}"
end
end
def allowed_values
if @values_to_match.length > 1
"any of [#{@values_to_match.map(&:inspect).join(', ')}]"
else
@values_to_match.first.inspect
end
end
def expected_message
if @expected_message
if Symbol === @expected_message
default_error_message(@expected_message, :model_name => model_name, :attribute => @attribute)
else
@expected_message
end
end
end
def model_name
@instance.class.to_s.underscore
end
end
end
end
end