validators 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in validators.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    validators (0.1.0)
+      activerecord (>= 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.1)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.2)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    sqlite3-ruby (1.3.2)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0.0)
+  rspec (>= 2.0.0)
+  ruby-debug19
+  sqlite3-ruby
+  validators!

data/README.rdoc

@@ -0,0 +1,73 @@
+= Validators
+
+Add some nice Rails 3 ActiveRecord validators.
+
+== Installation
+
+  gem install validators
+
+Then add it to your Gemfile:
+
+  gem "validators"
+
+== Usage
+
+=== validates_email_format_of
+
+  class User < ActiveRecord::Base
+    # old fashion
+    validates_email_format_of :email
+
+    # alternative way
+    validates :email, :email => true
+  end
+
+=== validates_ownership_of
+
+  class Task < ActiveRecord::Base
+    belongs_to :user
+    belongs_to :category
+
+    validates_ownership_of :category, :with => :user
+  end
+
+  user = User.find(1)
+  another_user = User.find(2)
+
+  user_category = user.categories.first
+  another_user_category = another_user.categories.first
+
+  task = user.tasks.create(:category => user_category)
+  task.valid?
+  #=> true
+
+  task = user.tasks.create(:category => another_user_category)
+  task.valid?
+  #=> false
+
+== Maintainer
+
+* Nando Vieira - http://simplesideias.com.br
+
+== License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/lib/validators.rb

@@ -0,0 +1,7 @@
+require "active_record"
+require "validators/validates_email_format_of"
+require "validators/validates_ownership_of"
+
+module Validators
+  EMAIL_FORMAT = /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+end

data/lib/validators/validates_email_format_of.rb

@@ -0,0 +1,26 @@
+module ActiveModel
+  module Validations
+    class EmailValidator < EachValidator
+      def validate_each(record, attribute, value)
+        if value.to_s !~ Validators::EMAIL_FORMAT
+          record.errors.add(
+            attribute, :invalid_email,
+            :message => options[:message], :value => value
+          )
+        end
+      end
+    end
+
+    module ClassMethods
+      # Validates weather or not the specified e-mail address is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_email_format_of :email
+      #   end
+      #
+      def validates_email_format_of(*attr_names)
+        validates_with EmailValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/validators/validates_ownership_of.rb

@@ -0,0 +1,51 @@
+module ActiveModel
+  module Validations
+    class OwnershipValidator < EachValidator
+      def validate_each(record, attribute, value)
+        owner = record.send(options[:with])
+        actual_owner = value ? value.send(options[:with]) : nil
+
+        if value && owner != actual_owner
+          record.errors.add(
+            attribute, :invalid_owner,
+            :message => options[:message]
+          )
+        end
+      end
+
+      def check_validity!
+        raise ArgumentError, ":with is required" unless options.key?(:with)
+        raise ArgumentError, ":with option must be a string or a symbol" unless ["String", "Symbol"].include?(options[:with].class.name)
+      end
+    end
+
+    module ClassMethods
+      # Validates whether the owner of the specified attribute is the same from the current object.
+      #
+      #   class Task < ActiveRecord::Base
+      #     belongs_to :user
+      #     belongs_to :category
+      #
+      #     validates_ownership_of :category, :with => :user
+      #   end
+      #
+      #   user = User.find(1)
+      #   another_user = User.find(2)
+      #
+      #   user_category = user.categories.first
+      #   another_user_category = another_user.categories.first
+      #
+      #   task = user.tasks.create(:category => user_category)
+      #   task.valid?
+      #   #=> true
+      #
+      #   task = user.tasks.create(:category => another_user_category)
+      #   task.valid?
+      #   #=> false
+      #
+      def validates_ownership_of(*attr_names)
+        validates_with OwnershipValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/validators/version.rb

@@ -0,0 +1,8 @@
+module Validators
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :email, :corporate_email
+  end
+
+  create_table :categories do |t|
+    t.references :user
+  end
+
+  create_table :tasks do |t|
+    t.references :user, :category
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require "validators"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+load "schema.rb"
+
+I18n.load_path << File.dirname(__FILE__) + "/support/translations.yml"
+
+RSpec.configure do |config|
+  config.before do
+    I18n.locale = :en
+
+    ActiveRecord::Base.descendants.each do |model|
+      model.delete_all
+      Object.class_eval { remove_const model.name if const_defined?(model.name) }
+    end
+
+    load File.dirname(__FILE__) + "/support/models.rb"
+  end
+end

data/spec/support/emails.rb

@@ -0,0 +1,55 @@
+INVALID_EMAILS = [
+  'invalid@example-com',
+  # period can not start local part
+  '.invalid@example.com',
+  # period can not end local part
+  'invalid.@example.com',
+  # period can not appear twice consecutively in local part
+  'invali..d@example.com',
+  # should not allow underscores in domain names
+  'invalid@ex_mple.com',
+  'invalid@example.com.',
+  'invalid@example.com_',
+  'invalid@example.com-',
+  'invalid-example.com',
+  'invalid@example.b#r.com',
+  'invalid@example.c',
+  'invali d@example.com',
+  'invalidexample.com',
+  'invalid@example.',
+  # from http://tools.ietf.org/html/rfc3696, page 5
+  # corrected in http://www.rfc-editor.org/errata_search.php?rfc=3696
+  'Fred\ Bloggs_@example.com',
+  'Abc\@def+@example.com',
+  'Joe.\\Blow@example.com'
+]
+
+VALID_EMAILS = [
+  'valid@example.com',
+  'Valid@test.example.com',
+  'valid+valid123@test.example.com',
+  'valid_valid123@test.example.com',
+  'valid-valid+123@test.example.co.uk',
+  'valid-valid+1.23@test.example.com.au',
+  'valid@example.co.uk',
+  'v@example.com',
+  'valid@example.ca',
+  'valid_@example.com',
+  'valid123.456@example.org',
+  'valid123.456@example.travel',
+  'valid123.456@example.museum',
+  'valid@example.mobi',
+  'valid@example.info',
+  'valid-@example.com',
+  # from RFC 3696, page 6
+  'customer/department=shipping@example.com',
+  '$A12345@example.com',
+  '!def!xyz%abc@example.com',
+  '_somename@example.com',
+  # apostrophes
+  "test'test@example.com",
+  # '"Abc\@def"@example.com',
+  # from http://www.rfc-editor.org/errata_search.php?rfc=3696
+  # '"Fred\ Bloggs"@example.com',
+  '"Joe.\\Blow"@example.com'
+]

data/spec/support/models.rb

@@ -0,0 +1,22 @@
+class User < ActiveRecord::Base
+  has_many :tasks
+  has_many :categories
+end
+
+class Category < ActiveRecord::Base
+  belongs_to :user
+  has_many :tasks
+end
+
+class Task < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :category
+end
+
+class Buyer < ActiveRecord::Base
+  set_table_name :users
+end
+
+class Person < ActiveRecord::Base
+  set_table_name :users
+end

data/spec/support/translations.yml

@@ -0,0 +1,15 @@
+en:
+  activerecord:
+    errors:
+      messages:
+        record_invalid: "Errors: %{errors}"
+        invalid_email: "is not a valid address"
+        invalid_owner: "is not associated with your user"
+
+pt-BR:
+  activerecord:
+    errors:
+      messages:
+        record_invalid: "Erros: %{errors}"
+        invalid_email: "não parece ser um e-mail válido"
+        invalid_owner: "não está associado ao seu usuário"

data/spec/validators/validates_email_format_of_spec.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe ".validates_email_format_of" do
+  before do
+    User.validates_email_format_of :email, :corporate_email, :allow_blank => false
+    Buyer.validates_email_format_of :email, :message => "is not a valid e-mail"
+    Person.validates :email, :email => true
+  end
+
+  VALID_EMAILS.each do |email|
+    it "should accept #{email.inspect} as a valid email" do
+      user = User.new(:email => email, :corporate_email => email)
+      user.should be_valid
+
+      user = Person.new(:email => email)
+      user.should be_valid
+    end
+  end
+
+  INVALID_EMAILS.each do |email|
+    it "should reject #{email.inspect} as a valid email" do
+      user = User.new(:email => "invalid", :corporate_email => "invalid")
+      user.should_not be_valid
+
+      user = Person.new(:email => "invalid")
+      user.should_not be_valid
+    end
+  end
+
+  it "should use default error message" do
+    user = User.new(:email => "invalid")
+    user.should_not be_valid
+    errors_for(user, :email).should == ["is not a valid address"]
+  end
+
+  it "should reject nil value" do
+    user = User.new(:email => nil)
+    user.should_not be_valid
+    errors_for(user, :email).should_not be_empty
+  end
+
+  it "should reject empty value" do
+    user = User.new(:email => "")
+    user.should_not be_valid
+    errors_for(user, :email).should_not be_empty
+  end
+
+  it "should validate multiple attributes" do
+    user = User.new(:corporate_email => "invalid")
+    user.should_not be_valid
+    errors_for(user, :corporate_email).should == ["is not a valid address"]
+  end
+
+  it "should use custom error message as :message options" do
+    buyer = Buyer.new(:email => "invalid")
+    buyer.should_not be_valid
+    errors_for(buyer, :email).should == ["is not a valid e-mail"]
+  end
+
+  it "should use I18n string as error message [pt-BR]" do
+    I18n.locale = :'pt-BR'
+    user = User.new(:email => "invalid")
+    user.should_not be_valid
+    errors_for(user, :email).should == ["não parece ser um e-mail válido"]
+  end
+
+  def errors_for(record, attr_name)
+    record.errors[attr_name]
+  end
+end

data/spec/validators/validates_ownership_of_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe ".validates_ownership_of" do
+  let!(:user) { User.create! }
+  let!(:another_user) { User.create! }
+  let!(:category) { Category.create!(:user => user) }
+  let!(:another_category) { Category.create!(:user => another_user) }
+  subject { Task.new(:user => user, :category => category) }
+
+  before do
+    Task.validates_ownership_of :category, :with => :user
+  end
+
+  it "should be valid when record is owned by the correct user" do
+    subject.should be_valid
+  end
+
+  it "should not be valid when record is owned by a different user" do
+    subject.category = another_category
+    subject.should_not be_valid
+  end
+
+  it "should raise error without :with option" do
+    expect {
+      Task.validates_ownership_of :category
+    }.to raise_error(ArgumentError)
+  end
+
+  it "should raise error when :with options is not a valid type" do
+    expect {
+      Task.validates_ownership_of :category, :with => user
+    }.to raise_error(ArgumentError)
+  end
+
+  it "should not be valid when owner is not present" do
+    expect {
+      subject.user = nil
+      subject.should_not be_valid
+    }.to_not raise_error
+  end
+
+  it "should not be valid when attribute owner is not present" do
+    expect {
+      subject.category.user = nil
+      subject.should_not be_valid
+    }.to_not raise_error
+  end
+
+  it "should be valid when both owners are nil" do
+    expect {
+      subject.category.user = nil
+      subject.user = nil
+      subject.should be_valid
+    }.to_not raise_error
+  end
+
+  it "should be valid when attribute is nil" do
+    expect {
+      subject.category = nil
+      subject.should be_valid
+    }.to_not raise_error
+  end
+
+  it "should set error message" do
+    subject.user = nil
+    subject.should_not be_valid
+    subject.errors[:category].should == ["is not associated with your user"]
+  end
+end

data/validators.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "validators/version"
+
+Gem::Specification.new do |s|
+  s.name        = "validators"
+  s.version     = Validators::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nando Vieira"]
+  s.email       = ["fnando.vieira@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/validators"
+  s.summary     = "Add some nice Rails 3 ActiveRecord validators."
+  s.description = "Add some nice Rails 3 ActiveRecord validators."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", ">= 3.0.0"
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "sqlite3-ruby"
+  s.add_development_dependency "ruby-debug19"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: validators
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-10 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Add some nice Rails 3 ActiveRecord validators.
+email: 
+- fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/validators.rb
+- lib/validators/validates_email_format_of.rb
+- lib/validators/validates_ownership_of.rb
+- lib/validators/version.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/emails.rb
+- spec/support/models.rb
+- spec/support/translations.yml
+- spec/validators/validates_email_format_of_spec.rb
+- spec/validators/validates_ownership_of_spec.rb
+- validators.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/validators
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Add some nice Rails 3 ActiveRecord validators.
+test_files: 
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/emails.rb
+- spec/support/models.rb
+- spec/support/translations.yml
+- spec/validators/validates_email_format_of_spec.rb
+- spec/validators/validates_ownership_of_spec.rb