valid8ors 0.0.9 → 0.1.0

data/README.md

@@ -14,79 +14,75 @@ Then run:
 
 ## Blacklist Validator
 
-### Usage
+Check that an attribute doesn't contain blacklisted values.
 
-Add the following to one of your models:
+### Usage
 
-    validates :name, blacklist: true
+```ruby
+class User < ActiveRecord::Base
+  validates :name, blacklist: true
+end
+```
 
 ### Blacklist file
 
 You can create a blacklist.yml file in the config directory of your Rails application if you need to overload the one used by this gem.
 
-### I18n
-
-If you use I18n, the default key to translate is :blacklisted. So if you add to your User model:
+### I18n error message
 
-    validates :name, blacklist: true
+Key to translate: **:blacklisted**.
+Hence, considering the example above, the translation path would be:
 
-You can translate (or overload) the default message via for e.g. using activerecord (in english): "en.activerecord.errors.models.user.attributes.name.blacklisted"
-
-### Tests
-
-    cd test
-    ruby blacklist_test.rb
+    en.activerecord.errors.models.user.attributes.name.blacklisted
 
 ## Reserved Validator
 
-### Usage
+Validate an attribute against a reserved list of values.
 
-Add the following to one of your models:
+### Usage
 
-    validates :name, reserved: true
+```ruby
+class User < ActiveRecord::Base
+  validates :name, reserved: true
+end
+```
 
 ### Reserved file
 
 You can create a reserved.yml file in the config directory of your Rails application if you need to overload the one used by this gem.
 
-### I18n
-
-If you use I18n, the default key to translate is :reserved. So if you add to your User model:
-
-    validates :name, reserved: true
+### I18n error message
 
-You can translate (or overload) the default message via for e.g. using activerecord (in english): "en.activerecord.errors.models.user.attributes.name.reserved"
+Key to translate: **:reserved**.
+Hence, considering the example above, the translation path would be:
 
-### Tests
-
-    cd test
-    ruby reserved_test.rb
+    en.activerecord.errors.models.user.attributes.name.reserved
 
 ## Email Format Validator
 
 ### Usage
 
-Add the following to one of your models:
-
-    validates :email, email_format: true
-
-Restrict your validation to accept emails from specific domains only:
+```ruby
+class User < ActiveRecord::Base
+  validates :email, email_format: true
+end
+```
 
-    validates :email, email_format: { domains: ['gmail.com', 'live.com'] }
+Restrict your validation to specific domains:
 
-### I18n
+```ruby
+class User < ActiveRecord::Base
+  validates :email, email_format: { domains: ['gmail.com', 'live.com'] }
+end
+```
 
-Default keys to translate are :improperly_formatted (when not an email format) and :invalid_domain (when email domain not listed in "domains" option).
-So if you add to your User model:
+### I18n error messages
 
-    validates :email, email_format: true
+Keys to translate: **:improperly_formatted** (when not an email format) and **:invalid_domain** (when email domain not listed in "domains" option).
+Hence, considering the two examples above, translation paths would be:
 
-You can translate (or overload) the default message via for e.g. (in english): "en.activerecord.errors.models.user.attributes.email.improperly_formatted"
-
-### Tests
-
-    cd test
-    ruby email_format_test.rb
+    en.activerecord.errors.models.user.attributes.email.improperly_formatted
+    en.activerecord.errors.models.user.attributes.email.invalid_domain
 
 ### Credits
 
@@ -96,22 +92,18 @@ Regular Expression tests based on [Comparing E-mail Address Validating Regular E
 
 ### Usage
 
-Add the following to one of your models:
-
-    validates :url, url_format: true
-
-### I18n
-
-If you use I18n, the default key to translate is :improperly_formatted. So if you add to your User model:
-
-    validates :url, url_format: true
+```ruby
+class User < ActiveRecord::Base
+  validates :url, url_format: true
+end
+```
 
-You can translate (or overload) the default message via for e.g. (in english): "en.activerecord.errors.models.user.attributes.url.improperly_formatted"
+### I18n error message
 
-### Tests
+Key to translate: **:improperly_formatted**.
+Hence, considering the example above, the translation path would be:
 
-    cd test
-    ruby url_format_test.rb
+    en.activerecord.errors.models.user.attributes.url.improperly_formatted
 
 ## Password Strength Validator
 
@@ -120,23 +112,44 @@ Password length validation is not included here as you can use Rails' builtin "L
 
 ### Usage
 
-Add the following to one of your models:
+```ruby
+class User < ActiveRecord::Base
+  validates :password, password_strength: true
+end
+```
 
-    validates :password, password_strength: true
+### I18n error message
+
+Key to translate: **:insecure**.
+Hence, considering the example above, the translation path would be:
+
+    en.activerecord.errors.models.user.attributes.password.insecure
+
+## Absence Validator
+
+By default, checks if an attribute is nil. Use allow_blank option to accept empty objects.
+
+### Usage
 
-### I18n
+```ruby
+class User < ActiveRecord::Base
+  validates :name,  absence: true                  # Validate name is nil
+  validates :email, absence: { allow_blank: true } # Validate email is blank
+end
+```
 
-The default key to translate is :insecure. So if you add to your User model:
+### I18n error message
 
-    validates :password, password_strength: true
+Key to translate: **:not_absent**.
+Hence, considering the example above, translation paths would be:
 
-You can translate (or overload) the default message via for e.g. (in english): "en.activerecord.errors.models.user.attributes.password.insecure"
+    en.activerecord.errors.models.user.attributes.name.not_absent
+    en.activerecord.errors.models.user.attributes.email.not_absent
 
-### Tests
+## Tests
 
-    cd test
-    ruby password_strength_test.rb
+    rake test
 
 ## Compatibility
 
-Ruby 1.8 is not supported.
+Ruby version >= 1.9.x

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ["lib"]
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/lib/valid8ors/absence.rb

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+class AbsenceValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    condition = options[:allow_blank?] ? :blank? : :nil?
+    record.errors.add(attribute, invalid_message(record, attribute)) unless value.send(condition)
+  end
+
+  #######################
+  ### Private methods ###
+  #######################
+
+  private
+
+  def invalid_message(record, attribute)
+    I18n.t  :not_absent,
+            scope:    "#{record.class.i18n_scope}.errors.models.#{record.class.model_name.i18n_key}.attributes.#{attribute}",
+            default:  "is present when it should be absent"
+  end
+
+end
+

data/lib/valid8ors.rb

@@ -5,3 +5,4 @@ require 'valid8ors/blacklist'
 require 'valid8ors/reserved'
 require 'valid8ors/url_format'
 require 'valid8ors/password_strength'
+require 'valid8ors/absence'

data/test/absence_test.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'test_helper'
+
+class TestAbsenceValidator < MiniTest::Unit::TestCase
+
+  class User < TestModel
+    validates :name, absence: true
+  end
+
+  class OtherUser < TestModel
+    validates :name, absence: { allow_blank: true }
+  end
+
+  def test_when_name_absent
+    user = User.new
+    assert user.valid?
+  end
+
+  def test_when_name_present_or_blank
+    ["", "James"].each do |name|
+      user = User.new(name: name)
+      refute user.valid?
+      assert user.errors[:name]
+    end
+  end
+
+  def test_when_allow_blank
+    other_user = OtherUser.new(name: "")
+    assert other_user.valid?
+  end
+
+  def test_default_message_on_error
+    user = User.new(name: "James")
+    refute user.valid?
+    assert user.errors[:name].include?("is present when it should be absent")
+  end
+
+end

data/test/blacklist_test.rb

@@ -2,28 +2,28 @@
 
 require_relative 'test_helper'
 
-class TestUser < TestModel
-  validates :name, blacklist: true
-end
-
 class TestBlacklistValidator < MiniTest::Unit::TestCase
 
+  class User < TestModel
+    validates :name, blacklist: true
+  end
+
   def test_some_blacklisted_words
     names_that_should_be_blacklisted.each do |name|
-      test_user = TestUser.new(name: name)
-      refute test_user.valid?
-      assert test_user.errors[:name]
+      user = User.new(name: name)
+      refute user.valid?
+      assert user.errors[:name]
     end
   end
 
   def test_some_whitelisted_words
-    names_that_should_be_whitelisted.each { |name| assert TestUser.new(name: name).valid? }
+    names_that_should_be_whitelisted.each { |name| assert User.new(name: name).valid? }
   end
 
   def test_default_message_on_error
-    test_user = TestUser.new(name: "Get up, fuck up")
-    refute test_user.valid?
-    assert test_user.errors[:name].include?("is blacklisted")
+    user = User.new(name: "Get up, fuck up")
+    refute user.valid?
+    assert user.errors[:name].include?("is blacklisted")
   end
 
   #######################

data/test/email_format_test.rb

@@ -2,30 +2,30 @@
 
 require_relative 'test_helper'
 
-class TestUser < TestModel
-  validates :email, email_format: true
-end
+class TestEmailFormatValidator < MiniTest::Unit::TestCase
 
-class TestUserWithEmailDomains < TestModel
-  validates :email, email_format: { domains: ['mail.com', 'subdomain.mail.com'] }
-end
+  class User < TestModel
+    validates :email, email_format: true
+  end
 
-class TestUserAllowsNilEmailToTrue < TestModel
-  validates :email, email_format: { allow_nil: true }
-end
+  class UserWithEmailDomains < TestModel
+    validates :email, email_format: { domains: ['mail.com', 'subdomain.mail.com'] }
+  end
 
-class TestUserAllowsNilEmailToFalse < TestModel
-  validates :email, email_format: { allow_nil: false }
-end
+  class UserAllowsNilEmailToTrue < TestModel
+    validates :email, email_format: { allow_nil: true }
+  end
 
-class TestEmailFormatValidator < MiniTest::Unit::TestCase
+  class UserAllowsNilEmailToFalse < TestModel
+    validates :email, email_format: { allow_nil: false }
+  end
 
   def test_valid_emails
-    valid_emails.each { |email| assert TestUser.new(email: email).valid? }
+    valid_emails.each { |email| assert User.new(email: email).valid? }
   end
 
   def test_invalid_emails
-    invalid_emails.each { |email| refute TestUser.new(email: email).valid? }
+    invalid_emails.each { |email| refute User.new(email: email).valid? }
   end
 
   def test_email_when_domains_option
@@ -33,36 +33,36 @@ class TestEmailFormatValidator < MiniTest::Unit::TestCase
     valid_emails_with_incorrect_domains = ['user@gmail.com', 'user@subdomain.gmail.com']
 
     valid_emails_with_correct_domains.each do |email|
-      assert TestUserWithEmailDomains.new(email: email).valid?
+      assert UserWithEmailDomains.new(email: email).valid?
     end
 
     valid_emails_with_incorrect_domains.each do |email|
-      refute TestUserWithEmailDomains.new(email: email).valid?
+      refute UserWithEmailDomains.new(email: email).valid?
     end
   end
 
   def test_default_invalid_domain_message_on_error
-    test_user = TestUserWithEmailDomains.new(email: "user@gmail.com")
-    refute test_user.valid?
-    assert test_user.errors[:email].include?("can't be from this domain")
+    user = UserWithEmailDomains.new(email: "user@gmail.com")
+    refute user.valid?
+    assert user.errors[:email].include?("can't be from this domain")
   end
 
   def test_default_message_on_error
-    test_user = TestUser.new(email: "invalid_email@")
-    refute test_user.valid?
-    assert test_user.errors[:email].include?("is improperly formatted")
+    user = User.new(email: "invalid_email@")
+    refute user.valid?
+    assert user.errors[:email].include?("is improperly formatted")
   end
 
   def test_nil_email_when_allow_nil_option_is_not_set
-    refute TestUser.new(email: nil).valid?
+    refute User.new(email: nil).valid?
   end
 
   def test_nil_email_when_allow_nil_option_is_set_to_true
-    assert TestUserAllowsNilEmailToTrue.new(email: nil).valid?
+    assert UserAllowsNilEmailToTrue.new(email: nil).valid?
   end
 
   def test_nil_email_when_allow_nil_option_is_set_to_false
-    refute TestUserAllowsNilEmailToFalse.new(email: nil).valid?
+    refute UserAllowsNilEmailToFalse.new(email: nil).valid?
   end
 
   #######################

data/test/password_strength_test.rb

@@ -2,44 +2,44 @@
 
 require_relative 'test_helper'
 
-class TestUser < TestModel
-  validates :password, password_strength: true
-end
+class TestPasswordFormatValidator < MiniTest::Unit::TestCase
 
-class TestUserAllowsNilPasswordToTrue < TestModel
-  validates :password, password_strength: { allow_nil: true }
-end
+  class User < TestModel
+    validates :password, password_strength: true
+  end
 
-class TestUserAllowsNilPasswordToFalse < TestModel
-  validates :password, password_strength: { allow_nil: false }
-end
+  class UserAllowsNilPasswordToTrue < TestModel
+    validates :password, password_strength: { allow_nil: true }
+  end
 
-class TestPasswordFormatValidator < MiniTest::Unit::TestCase
+  class UserAllowsNilPasswordToFalse < TestModel
+    validates :password, password_strength: { allow_nil: false }
+  end
 
   def test_valid_passwords
-    valid_passwords.each { |password| assert TestUser.new(password: password).valid? }
+    valid_passwords.each { |password| assert User.new(password: password).valid? }
   end
 
   def test_invalid_passwords
-    invalid_passwords.each { |password| refute TestUser.new(password: password).valid? }
+    invalid_passwords.each { |password| refute User.new(password: password).valid? }
   end
 
   def test_default_message_on_error
-    test_user = TestUser.new(password: "invalid_password")
-    refute test_user.valid?
-    assert test_user.errors[:password].include?("is not strong enough. It should contain at least a digit, lowercase and uppercase letter.")
+    user = User.new(password: "invalid_password")
+    refute user.valid?
+    assert user.errors[:password].include?("is not strong enough. It should contain at least a digit, lowercase and uppercase letter.")
   end
 
   def test_nil_password_when_allow_nil_option_is_not_set
-    refute TestUser.new(password: nil).valid?
+    refute User.new(password: nil).valid?
   end
 
   def test_nil_password_when_allow_nil_option_is_set_to_true
-    assert TestUserAllowsNilPasswordToTrue.new(password: nil).valid?
+    assert UserAllowsNilPasswordToTrue.new(password: nil).valid?
   end
 
   def test_nil_password_when_allow_nil_option_is_set_to_false
-    refute TestUserAllowsNilPasswordToFalse.new(password: nil).valid?
+    refute UserAllowsNilPasswordToFalse.new(password: nil).valid?
   end
 
   #######################

data/test/reserved_test.rb

@@ -2,33 +2,33 @@
 
 require_relative 'test_helper'
 
-class TestUser < TestModel
-  validates :name, reserved: true
-end
-
 class TestReservedValidator < MiniTest::Unit::TestCase
 
+  class User < TestModel
+    validates :name, reserved: true
+  end
+
   def test_some_reserved_words
     names_that_should_be_reserved.each do |name|
-      test_user = TestUser.new(name: name)
-      refute test_user.valid?
-      assert test_user.errors[:name]
+      user = User.new(name: name)
+      refute user.valid?
+      assert user.errors[:name]
     end
   end
 
   def test_some_not_reserved_words
-    names_that_should_be_not_reserved.each { |name| assert TestUser.new(name: name).valid? }
+    names_that_should_be_not_reserved.each { |name| assert User.new(name: name).valid? }
   end
 
   def test_with_nil_attribute
-    test_user = TestUser.new(name: nil)
-    assert test_user.valid?
+    user = User.new(name: nil)
+    assert user.valid?
   end
 
   def test_default_message_on_error
-    test_user = TestUser.new(name: "abOUt")
-    refute test_user.valid?
-    assert test_user.errors[:name].include?("is reserved")
+    user = User.new(name: "abOUt")
+    refute user.valid?
+    assert user.errors[:name].include?("is reserved")
   end
 
   #######################

data/test/test_helper.rb

@@ -1,12 +1,7 @@
 # -*- encoding: utf-8 -*-
 
-require 'rubygems'
 require 'active_model'
 require 'minitest/autorun'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
 require 'valid8ors'
 
 class TestModel

data/test/url_format_test.rb

@@ -2,44 +2,44 @@
 
 require_relative 'test_helper'
 
-class TestSite < TestModel
-  validates :url, url_format: true
-end
+class TestUrlFormatValidator < MiniTest::Unit::TestCase
 
-class TestSiteAllowsNilToTrue < TestModel
-  validates :url, url_format: { allow_nil: true }
-end
+  class Site < TestModel
+    validates :url, url_format: true
+  end
 
-class TestSiteAllowsNilToFalse < TestModel
-  validates :url, url_format: { allow_nil: false }
-end
+  class SiteAllowsNilToTrue < TestModel
+    validates :url, url_format: { allow_nil: true }
+  end
 
-class TestUrlFormatValidator < MiniTest::Unit::TestCase
+  class SiteAllowsNilToFalse < TestModel
+    validates :url, url_format: { allow_nil: false }
+  end
 
   def test_valid_url
-    valid_urls.each { |url| assert TestSite.new(url: url).valid? }
+    valid_urls.each { |url| assert Site.new(url: url).valid? }
   end
 
   def test_invalid_url
-    invalid_urls.each { |url| refute TestSite.new(url: url).valid? }
+    invalid_urls.each { |url| refute Site.new(url: url).valid? }
   end
 
   def test_default_message_on_error
-    test_site = TestSite.new(url: "invalid_url")
-    refute test_site.valid?
-    assert test_site.errors[:url].include?("is improperly formatted")
+    site = Site.new(url: "invalid_url")
+    refute site.valid?
+    assert site.errors[:url].include?("is improperly formatted")
   end
 
   def test_nil_url_when_allow_nil_option_is_not_set
-    refute TestSite.new(url: nil).valid?
+    refute Site.new(url: nil).valid?
   end
 
   def test_nil_url_when_allow_nil_option_is_set_to_true
-    assert TestSiteAllowsNilToTrue.new(url: nil).valid?
+    assert SiteAllowsNilToTrue.new(url: nil).valid?
   end
 
   def test_nil_url_when_allow_nil_option_is_set_to_false
-    refute TestSiteAllowsNilToFalse.new(url: nil).valid?
+    refute SiteAllowsNilToFalse.new(url: nil).valid?
   end
 
   #######################

data/valid8ors.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "valid8ors"
-  s.version     = "0.0.9"
+  s.version     = "0.1.0"
   s.authors     = ["Axel Vergult", "Vincent Pochet", "Ben Colon"]
   s.email       = ["axel@official.fm", "vincent@official.fm", "ben@official.fm"]
   s.homepage    = ""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valid8ors
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000Z
+date: 2012-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70223479086520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,7 +23,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70223479086520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rails 3 awesome custom validators
 email:
 - axel@official.fm
@@ -41,11 +46,13 @@ files:
 - config/blacklist.yml
 - config/reserved.yml
 - lib/valid8ors.rb
+- lib/valid8ors/absence.rb
 - lib/valid8ors/blacklist.rb
 - lib/valid8ors/email_format.rb
 - lib/valid8ors/password_strength.rb
 - lib/valid8ors/reserved.rb
 - lib/valid8ors/url_format.rb
+- test/absence_test.rb
 - test/blacklist_test.rb
 - test/email_format_test.rb
 - test/password_strength_test.rb
@@ -67,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2283626172012641948
+      hash: -557487691873541277
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -76,14 +83,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2283626172012641948
+      hash: -557487691873541277
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rails 3 awesome custom validators
 test_files:
+- test/absence_test.rb
 - test/blacklist_test.rb
 - test/email_format_test.rb
 - test/password_strength_test.rb