lib/semantic_attributes/locale/en.yml @@ -6,9 +6,4 @@ ActiveRecord::Base.class_eval do include ActiveRecord::ValidationRecursionControl end -# localization mock -ActiveRecord::Base.class_eval do - unless respond_to? :_ - def _(s); s; end - end -end +I18n.load_path << File.dirname(__FILE__) + '/lib/semantic_attributes/locale/en.yml' init.rb @@ -15,7 +15,7 @@ class Predicates::Association < Predicates::Base attr_accessor :max def error_message - @error_message || 'is required.' + @error_message || :required end def validate(value, record) lib/predicates/association.rb @@ -13,9 +13,21 @@ module Predicates ## # the error string when validation fails - attr_accessor :error_message + def error_message + @error_message || :invalid + end + attr_writer :error_message alias_accessor :message, :error_message + # available interpolation variables for the error message (see I18n.translate) + def error_binds + {} + end + + def error + I18n.t(error_message, error_binds.merge(:scope => 'semantic-attributes.errors.messages')) + end + # a condition to restrict when validation should occur. if it returns false, the validation will not happen. # if the value is a proc, then the proc will be called and the record object passed as the argument # if the value is a symbol, then a method by that name will be called on the record lib/predicates/base.rb @@ -10,7 +10,7 @@ class Predicates::Blacklisted < Predicates::Base attr_accessor :restricted def error_message - @error_message || "is not an allowed option." + @error_message || :exclusion end def validate(val, record) lib/predicates/blacklisted.rb @@ -3,7 +3,7 @@ require 'uri' # Defines a field as a simple domain (not URL). class Predicates::Domain < Predicates::Base def error_message - @error_message || "must be a simple domain." + @error_message || :domain end def validate(value, record) lib/predicates/domain.rb @@ -27,7 +27,7 @@ class Predicates::Email < Predicates::Base end def error_message - @error_message || 'must be an email address.' + @error_message || :email end EmailAddressPattern = begin @@ -39,4 +39,4 @@ class Predicates::Email < Predicates::Base Regexp::EXTENDED | Regexp::IGNORECASE ) end -end \ No newline at end of file +end lib/predicates/email.rb @@ -14,7 +14,7 @@ class Predicates::Enumerated < Predicates::Base end def error_message - @error_message || "is not an allowed option." + @error_message || :inclusion end def validate(value, record) lib/predicates/enumerated.rb @@ -6,7 +6,7 @@ class Predicates::HexColor < Predicates::Pattern end def error_message - @error_message ||= "must be a hex color." + @error_message ||= :hex end def normalize(value) lib/predicates/hex_color.rb @@ -24,7 +24,13 @@ class Predicates::Length < Predicates::Base attr_accessor :exactly def error_message - @error_message || "must be #{range_description} characters long." + @error_message || range_description + end + + def error_binds + self.range ? + {:min => self.range.first, :max => self.range.last} : + {:min => self.above, :max => self.below, :count => self.exactly} end def validate(value, record) @@ -52,10 +58,10 @@ class Predicates::Length < Predicates::Base end def range_description - return self.exactly.to_s if self.exactly - return "#{self.range.first} to #{self.range.last}" if self.range - return "more than #{self.above}" if self.above - return "less than #{self.below}" if self.below + return :inexact_length if self.exactly + return :wrong_length if self.range + return :too_short if self.above + return :too_long if self.below raise 'undetermined range' end end lib/predicates/length.rb @@ -42,7 +42,13 @@ class Predicates::Number < Predicates::Base end def error_message - @error_message || "must be a number#{range_description}." + @error_message || range_description + end + + def error_binds + self.range ? + {:min => self.range.first, :max => self.range.last} : + {:min => self.above, :max => self.below} end def validate(value, record) @@ -80,16 +86,19 @@ class Predicates::Number < Predicates::Base def range_description # if it has two endpoints - return " from #{self.range.first} #{self.range.exclude_end? ? 'to' : 'through'} #{self.range.last}" if self.range + if self.range + return :between + end # if it only has one inclusive endpoint if inclusive - return " at least #{self.above}" if self.above - return " no more than #{self.below}" if self.below + return :greater_than_or_equal_to if self.above + return :less_than_or_equal_to if self.below # if it only has one exclusive endpoint else - return " greater than #{self.above}" if self.above - return " less than #{self.below}" if self.below + return :greater_than if self.above + return :less_than if self.below end # if it has no endpoints + :not_a_number end end lib/predicates/number.rb @@ -15,12 +15,8 @@ class Predicates::Pattern < Predicates::Base attr_accessor :like - def error_message - @error_message ||= "is invalid." - end - def validate(value, record) value = value.to_s if [Symbol, Fixnum].include?(value.class) value.match(self.like) end -end \ No newline at end of file +end lib/predicates/pattern.rb @@ -14,7 +14,7 @@ class Predicates::PhoneNumber < Predicates::Base end def error_message - @error_message ||= "must be a phone number." + @error_message ||= :phone end def validate(value, record) lib/predicates/phone_number.rb @@ -13,10 +13,10 @@ class Predicates::Required < Predicates::Base end def error_message - @error_message || 'is required.' + @error_message || :required end def validate(value, record) !value.blank? end -end \ No newline at end of file +end lib/predicates/required.rb @@ -8,10 +8,10 @@ class Predicates::SameAs < Predicates::Base attr_accessor :method def error_message - @error_message ||= "must be the same as #{method}." + @error_message ||= :same_as end - + def validate(value, record) value == record.send(self.method) end -end \ No newline at end of file +end lib/predicates/same_as.rb @@ -24,7 +24,7 @@ class Predicates::Time < Predicates::Base attr_accessor :distance def error_message - @error_message || "must be a point in time." + @error_message || :time end def validate(value, record) lib/predicates/time.rb @@ -20,7 +20,7 @@ class Predicates::Unique < Predicates::Base end def error_message - @error_message || "has already been taken." + @error_message || :taken end def validate(value, record) lib/predicates/unique.rb @@ -33,7 +33,7 @@ class Predicates::Url < Predicates::Base end def error_message - @error_message || 'must be a valid URL.' + @error_message || :url end def validate(value, record) lib/predicates/url.rb @@ -17,7 +17,7 @@ class Predicates::UsaState < Predicates::Aliased undef_method :options= def error_message - @error_message || "must be a US state#{' or territory' if with_territories?}." + @error_message || with_territories? ? :us_state_or_territory : :us_state end TERRITORIES = { @@ -84,4 +84,4 @@ class Predicates::UsaState < Predicates::Aliased 'Wisconsin' => 'WI', 'Wyoming' => 'WY' } -end \ No newline at end of file +end lib/predicates/usa_state.rb @@ -20,6 +20,6 @@ class Predicates::UsaZipCode < Predicates::Pattern undef_method :like= def error_message - @error_message || 'must be a US zip code.' + @error_message || :us_zip_code end -end \ No newline at end of file +end lib/predicates/usa_zip_code.rb @@ -26,12 +26,12 @@ module SemanticAttributes applicable_predicates.each do |predicate| if value.blank? # it's empty, so add an error or not but either way move along - self.errors.add(attribute.field, _(predicate.error_message)) unless predicate.allow_empty? + self.errors.add(attribute.field, predicate.error) unless predicate.allow_empty? next end unless predicate.validate(value, self) - self.errors.add(attribute.field, _(predicate.error_message)) + self.errors.add(attribute.field, predicate.error) end end end lib/semantic_attributes/predicates.rb @@ -26,6 +26,8 @@ class BasePredicateTest < SemanticAttributes::TestCase def test_default_values assert @predicate.allow_empty?, "allow empty/nil values by default" assert_equal :both, @predicate.validate_on, "validate on create and update by default" + assert_equal :invalid, @predicate.error_message, "error message is a bland :invalid by default" + assert_equal Hash.new, @predicate.error_binds, "there are no binds by default" end def test_or_empty test/unit/predicates/base_test.rb @@ -25,10 +25,4 @@ class BlacklistedPredicateTest < SemanticAttributes::TestCase assert !@predicate.validate('3', nil) assert @predicate.validate(6, nil) end - - def test_error_message - assert_equal "is not an allowed option.", @predicate.error_message - @predicate.error_message = 'foo' - assert_equal 'foo', @predicate.error_message - end end test/unit/predicates/blacklisted_predicate_test.rb @@ -5,12 +5,6 @@ class DomainPredicateTest < SemanticAttributes::TestCase @predicate = Predicates::Domain.new(:foo) end - def test_error_message - assert_equal 'must be a simple domain.', @predicate.error_message - @predicate.error_message = 'foo' - assert_equal 'foo', @predicate.error_message - end - def test_valid_domains %w(example.com www.example.com).each do |domain| assert @predicate.validate(domain, nil), "#{domain} is a valid domain" @@ -30,4 +24,4 @@ class DomainPredicateTest < SemanticAttributes::TestCase assert_equal "", @predicate.normalize("") assert_equal "example.com", @predicate.normalize("example.com") end -end \ No newline at end of file +end test/unit/predicates/domain_predicate_test.rb @@ -80,10 +80,4 @@ class EmailPredicateTest < SemanticAttributes::TestCase assert !@predicate.validate('test@example.com', nil), 'syntax and mx check' assert @predicate.validate('test@gmail.com', nil) end - - def test_error_message - assert_equal 'must be an email address.', @predicate.error_message - @predicate.error_message = 'foo' - assert_equal 'foo', @predicate.error_message - end -end \ No newline at end of file +end test/unit/predicates/email_test.rb @@ -15,12 +15,6 @@ class EnumeratedPredicateTest < SemanticAttributes::TestCase assert !@predicate.validate(6, nil) end - def test_error_message - assert_equal "is not an allowed option.", @predicate.error_message - @predicate.error_message = 'foo' - assert_equal 'foo', @predicate.error_message - end - def test_or_empty assert !Predicates::Enumerated.new(:foo).allow_empty? assert Predicates::Enumerated.new(:foo, :or_empty => true).allow_empty? test/unit/predicates/enumerated_predicate_test.rb @@ -5,10 +5,6 @@ class HexColorPredicateTest < SemanticAttributes::TestCase @predicate = Predicates::HexColor.new(:foo) end - def test_default_error_message - assert_equal @predicate.error_message, "must be a hex color." - end - def test_normalize_conversions assert_equal "", @predicate.normalize("") assert_equal nil, @predicate.normalize(nil) @@ -30,4 +26,4 @@ class HexColorPredicateTest < SemanticAttributes::TestCase end end -end \ No newline at end of file +end test/unit/predicates/hex_color_predicate_test.rb @@ -7,7 +7,7 @@ class LengthPredicateTest < SemanticAttributes::TestCase def test_range @predicate.range = 1..5 - assert_equal 'must be 1 to 5 characters long.', @predicate.error_message + assert_equal :wrong_length, @predicate.error_message assert !@predicate.validate('', nil) assert @predicate.validate('1', nil) @@ -15,13 +15,13 @@ class LengthPredicateTest < SemanticAttributes::TestCase assert !@predicate.validate('123456', nil) @predicate.range = 1...5 - assert_equal 'must be 1 to 5 characters long.', @predicate.error_message, 'same message for inclusive range' + assert_equal :wrong_length, @predicate.error_message, 'same message for inclusive range' assert !@predicate.validate('12345', nil) end def test_min @predicate.above = 5 - assert_equal 'must be more than 5 characters long.', @predicate.error_message + assert_equal :too_short, @predicate.error_message assert !@predicate.validate('', nil) assert !@predicate.validate('12345', nil) @@ -30,7 +30,7 @@ class LengthPredicateTest < SemanticAttributes::TestCase def test_max @predicate.below = 5 - assert_equal 'must be less than 5 characters long.', @predicate.error_message + assert_equal :too_long, @predicate.error_message assert @predicate.validate('', nil) assert @predicate.validate('1234', nil) @@ -39,7 +39,7 @@ class LengthPredicateTest < SemanticAttributes::TestCase def test_exact @predicate.exactly = 5 - assert_equal 'must be 5 characters long.', @predicate.error_message + assert_equal :inexact_length, @predicate.error_message assert !@predicate.validate('', nil) assert !@predicate.validate('1234', nil) test/unit/predicates/length_predicate_test.rb @@ -6,9 +6,7 @@ class NumberPredicateTest < SemanticAttributes::TestCase end def test_basic_error_message - assert_equal 'must be a number.', @predicate.error_message - @predicate.error_message = 'foo' - assert_equal 'foo', @predicate.error_message + assert_equal :not_a_number, @predicate.error_message end def test_integers @@ -38,7 +36,7 @@ class NumberPredicateTest < SemanticAttributes::TestCase def test_min @predicate.above = 5 - assert_equal 'must be a number greater than 5.', @predicate.error_message + assert_equal :greater_than, @predicate.error_message assert !@predicate.validate(-10, nil) assert !@predicate.validate(-5, nil) @@ -55,7 +53,7 @@ class NumberPredicateTest < SemanticAttributes::TestCase @predicate.at_least = 5 assert_equal 5, @predicate.above assert @predicate.inclusive - assert_equal 'must be a number at least 5.', @predicate.error_message + assert_equal :greater_than_or_equal_to, @predicate.error_message assert !@predicate.validate(4, nil) assert @predicate.validate(5, nil) @@ -63,7 +61,7 @@ class NumberPredicateTest < SemanticAttributes::TestCase def test_max @predicate.below = 5 - assert_equal 'must be a number less than 5.', @predicate.error_message + assert_equal :less_than, @predicate.error_message assert @predicate.validate(-10, nil) assert @predicate.validate(-5, nil) @@ -80,7 +78,7 @@ class NumberPredicateTest < SemanticAttributes::TestCase @predicate.no_more_than = 5 assert_equal 5, @predicate.below assert @predicate.inclusive - assert_equal 'must be a number no more than 5.', @predicate.error_message + assert_equal :less_than_or_equal_to, @predicate.error_message assert @predicate.validate(5, nil) assert !@predicate.validate(6, nil) @@ -88,7 +86,7 @@ class NumberPredicateTest < SemanticAttributes::TestCase def test_range @predicate.range = -5...5 - assert_equal 'must be a number from -5 to 5.', @predicate.error_message + assert_equal :between, @predicate.error_message assert !@predicate.validate(-10, nil) assert @predicate.validate(-5, nil) @@ -103,7 +101,7 @@ class NumberPredicateTest < SemanticAttributes::TestCase def test_range_inclusive @predicate.range = -5..5 - assert_equal 'must be a number from -5 through 5.', @predicate.error_message + assert_equal :between, @predicate.error_message assert @predicate.validate(5, nil) assert !@predicate.validate(6, nil) test/unit/predicates/number_test.rb @@ -5,12 +5,6 @@ class TimePredicateTest < SemanticAttributes::TestCase @predicate = Predicates::Time.new(:foo) end - def test_error_message - assert_equal 'must be a point in time.', @predicate.error_message - @predicate.error_message = 'foo' - assert_equal 'foo', @predicate.error_message - end - def test_default_validation assert !@predicate.validate('2007-07-19 00:00:00', nil), 'value may not be a string, even if string parses' assert !@predicate.validate(1184817600, nil), 'value must not be a timestamp' test/unit/predicates/time_test.rb @@ -11,7 +11,6 @@ class UniquePredicateTest < SemanticAttributes::TestCase def test_defaults assert_equal false, @predicate.case_sensitive, 'case insensitive by default' assert_equal [], @predicate.scope, 'default scope is empty array' - assert_equal "has already been taken.", @predicate.error_message end def test_uniqueness_validation_scoping @@ -56,4 +55,4 @@ class UniquePredicateTest < SemanticAttributes::TestCase @predicate.validate(@fred.login, @fred) assert_equal "Fred", @fred.login, "attribute value was not changed by validate()" end -end \ No newline at end of file +end test/unit/predicates/unique_test.rb @@ -83,10 +83,4 @@ class UrlPredicateTest < SemanticAttributes::TestCase assert_equal 'example.com', @predicate.normalize('example.com') assert_equal 'example.com:80', @predicate.normalize('example.com:80') end - - def test_error_message - assert_equal 'must be a valid URL.', @predicate.error_message - @predicate.error_message = 'foo bar' - assert_equal 'foo bar', @predicate.error_message - end -end \ No newline at end of file +end test/unit/predicates/url_test.rb @@ -11,7 +11,7 @@ class UsaStatePredicateTest < SemanticAttributes::TestCase def test_with_territories @predicate.with_territories = true - assert_equal 'must be a US state or territory.', @predicate.error_message + assert_equal :us_state_or_territory, @predicate.error_message assert @predicate.options.include?('Guam') assert @predicate.options.include?('Minnesota') @@ -19,7 +19,7 @@ class UsaStatePredicateTest < SemanticAttributes::TestCase def test_without_territories @predicate.with_territories = false - assert_equal 'must be a US state.', @predicate.error_message + assert_equal :us_state, @predicate.error_message assert !@predicate.options.include?('Guam') assert @predicate.options.include?('Minnesota') test/unit/predicates/usa_state_test.rb @@ -38,6 +38,5 @@ class UsaZipCodePredicateTest < SemanticAttributes::TestCase def test_defaults assert !@predicate.extended - assert_equal 'must be a US zip code.', @predicate.error_message end -end \ No newline at end of file +end test/unit/predicates/usa_zip_code_test.rb @@ -18,12 +18,6 @@ class ValidationsTest < SemanticAttributes::TestCase assert_equal 'is required.', @record.errors[:login] end - def test_that_errors_are_localized - @record.expects(:_).returns("translated!") - @record.valid? - assert_equal "translated!", @record.errors[:login] - end - def test_validate_on_default assert_equal :both, @record.semantic_attributes['login'].get('required').validate_on end @@ -124,4 +118,4 @@ class ValidationsTest < SemanticAttributes::TestCase assert @record.errors.on(:login) end end -end \ No newline at end of file +end test/unit/validations_test.rb 7544ae92006f36be86354b35277314ac8e2bcf27 Lance Ivy lance@cainlevy.net http://github.com/cainlevy/semantic-attributes/commit/c235618b92e845de6b45f809c817e8ec1d2d8677 c235618b92e845de6b45f809c817e8ec1d2d8677 2009-02-23T22:57:15-08:00 2009-02-23T22:57:15-08:00 using Rails' I18n.translate() backend for semantic attribute error messages. attempting to mimic activerecord's message names where possible. 2a2072667eba9435ade70ae16740d32371da8e09 Lance Ivy lance@cainlevy.net