valid8ors 0.0.3 → 0.0.4

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 .rvmrc
+.project

data/README.md

@@ -40,6 +40,35 @@ You can translate (or overload) the default message via for e.g. using activerec
 
     cd test
     ruby blacklist_test.rb
+    
+## Reserved Validator
+
+### Usage
+
+Add the following to one of your models:
+
+    validates :name, reserved: true
+
+You can also modify the default message ("is reserved") if validation fails:
+
+    validates :name, reserved: { message: "is not part of the whitelist" }
+
+### 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
+
+You can translate (or overload) the default message via for e.g. using activerecord (in english): "en.activerecord.errors.models.user.attributes.name.reserved"
+
+### Tests
+
+    cd test
+    ruby reserved_test.rb
 
 ## Email Format Validator
 
@@ -70,6 +99,31 @@ You can translate (or overload) the default message via for e.g. (in english): "
 
 Regular Expression tests based on [Comparing E-mail Address Validating Regular Expressions](http://fightingforalostcause.net/misc/2006/compare-email-regex.php)
 
+## Url Format Validator
+
+### Usage
+
+Add the following to one of your models:
+
+    validates :url, url_format: true
+
+You can also modify the default message ("is improperly formatted") if validation fails:
+
+    validates :url, url_format: { message: "is not well formatted" }
+
+### 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
+
+You can translate (or overload) the default message via for e.g. (in english): "en.activerecord.errors.models.user.attributes.url.improperly_formatted"
+
+### Tests
+
+    cd test
+    ruby url_format_test.rb
+
 ## Compatibility
 
 Ruby 1.8 is not supported.

data/config/reserved.yml

@@ -0,0 +1,8 @@
+---
+- about
+- faq
+- help
+- team
+- blog
+- store
+- status

data/lib/valid8ors/reserved.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+class ReservedValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, options[:message] || invalid_message(record, attribute)) if reserved?(value)
+  end
+
+  # Lazy load and transform directly words to patterns instead of creating regexps at each matching tests
+  def reserved
+    @reserved ||= YAML.load_file(reserved_file)
+  end
+
+  #######################
+  ### Private methods ###
+  #######################
+
+  private
+
+  def invalid_message(record, attribute)
+    I18n.t  :reserved,
+            scope:    "#{record.class.i18n_scope}.errors.models.#{record.class.model_name.i18n_key}.attributes.#{attribute}",
+            default:  "is reserved"
+  end
+
+  def reserved?(str)
+    reserved.any? { |pattern| str == pattern }
+  end
+
+  def reserved_file
+    if defined?(Rails.root) && (reserved_file_path = Rails.root.join("config", "reserved.yml")).exist?
+      return reserved_file_path
+    end
+    File.join(File.dirname(__FILE__), "../../config/reserved.yml")
+  end
+
+end

data/lib/valid8ors.rb

@@ -2,4 +2,5 @@
 
 require 'valid8ors/email_format'
 require 'valid8ors/blacklist'
+require 'valid8ors/reserved'
 require 'valid8ors/url_format'

data/test/reserved_test.rb

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'test_helper'
+
+class TestUser < TestModel
+  validates :name, reserved: true
+end
+
+class TestUserWithMessage < TestModel
+  validates :name, reserved: { message: 'is not part of the whitelist' }
+end
+
+class TestBlacklistValidator < MiniTest::Unit::TestCase
+
+  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]
+    end
+  end
+
+  def test_some_not_reserved_words
+    names_that_should_be_not_reserved.each { |name| assert TestUser.new(name: name).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")
+  end
+
+  def test_custom_message_on_error
+    test_user = TestUserWithMessage.new(name: "help")
+    refute test_user.valid?
+    assert test_user.errors[:name].include?("is not part of the whitelist")
+  end
+
+  #######################
+  ### Private methods ###
+  #######################
+
+  private
+
+  def names_that_should_be_reserved
+    ["about", "faq", "help"]
+  end
+
+  def names_that_should_be_not_reserved
+    ["daftpunk", "u2", "madonna"]
+  end
+
+end

data/valid8ors.gemspec

@@ -3,9 +3,9 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "valid8ors"
-  s.version     = "0.0.3"
-  s.authors     = ["Axel Vergult", "Vincent Pochet"]
-  s.email       = ["axel@official.fm", "vincent@official.fm"]
+  s.version     = "0.0.4"
+  s.authors     = ["Axel Vergult", "Vincent Pochet", "Ben Colon"]
+  s.email       = ["axel@official.fm", "vincent@official.fm", "ben@official.fm"]
   s.homepage    = ""
   s.summary     = %q{Rails 3 awesome custom validators}
   s.description = %q{Rails 3 awesome custom validators}

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: valid8ors
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
 - Axel Vergult
 - Vincent Pochet
+- Ben Colon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-20 00:00:00.000000000Z
+date: 2012-01-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70335761002560 !ruby/object:Gem::Requirement
+  requirement: &70192395358060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,11 +23,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70335761002560
+  version_requirements: *70192395358060
 description: Rails 3 awesome custom validators
 email:
 - axel@official.fm
 - vincent@official.fm
+- ben@official.fm
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -37,12 +39,15 @@ files:
 - README.md
 - Rakefile
 - config/blacklist.yml
+- config/reserved.yml
 - lib/valid8ors.rb
 - lib/valid8ors/blacklist.rb
 - lib/valid8ors/email_format.rb
+- lib/valid8ors/reserved.rb
 - lib/valid8ors/url_format.rb
 - test/blacklist_test.rb
 - test/email_format_test.rb
+- test/reserved_test.rb
 - test/test_helper.rb
 - test/url_format_test.rb
 - valid8ors.gemspec
@@ -73,5 +78,6 @@ summary: Rails 3 awesome custom validators
 test_files:
 - test/blacklist_test.rb
 - test/email_format_test.rb
+- test/reserved_test.rb
 - test/test_helper.rb
 - test/url_format_test.rb