mask_validator 0.1 → 0.2

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,4 +1,8 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in mask_validator.gemspec
 gemspec
+
+group :test do
+  gem "rspec"
+  gem "sqlite3"
+end

data/README.markdown

@@ -2,7 +2,9 @@
 
 This gem was inspired in the Sobrinho's gems to validate simple things inside of ActiveModel.
 
-Use mask in inputs and validate then in the models.
+Use mask in inputs and validate in the models.
+
+The gem works getting the value before type cast and comparing with a regexp from the mask pattern.
 
 ## Installation
 

data/Rakefile

@@ -1,11 +1,2 @@
-require "bundler/gem_tasks"
-require 'rake/testtask'
-
+require "bundler"
 Bundler::GemHelper.install_tasks
-
-task :default => :test
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-end

data/lib/mask_validator.rb

@@ -2,27 +2,58 @@ class MaskValidator < ActiveModel::EachValidator
 
   #
   # This validator use the characters 'a', '9' and '*'
-  # to validate the form of the content
+  # to validate the format with regular expression
   #
   # Example using in models:
-  #   validates :phone, mask: "(99) 9999-9999"
-  #   validates :acronym, mask: "***"
+  #   validates :phone, :mask => "(99) 9999-9999"
+  #   validates :acronym, :mask => "***"
   #
   # Where:
-  #   a - Represents an alpha character (A-Z,a-z)
-  #   9 - Represents a numeric character (0-9)
-  #   * - Represents an alphanumeric character (A-Z,a-z,0-9)
+  #   a - to letters (A-Z, a-z)
+  #   9 - to numbers (0-9)
+  #   * - to alphanumerics (A-Z, a-z, 0-9)
   #
-  # TODO: refactoring
   def validate_each(record, attribute, value)
-    return true if value.nil? || value.empty?
+    value = record.send("#{attribute.to_s}_before_type_cast")
 
-    definitions = { "9" => "[0-9]", "a" => "[a-zA-Z]", "*" => "[a-zA-Z0-9]" }
-    regex = /#{(options[:with].to_s.each_char.collect { |char| definitions[char] || "\\#{char}" }).join}/
+    if value.nil?
+      record.errors.add(attribute, :blank) unless allow_nil?
+    end
 
-    match = value.match(regex)
-    unless match && match.to_s == value
-      record.errors.add(attribute, options[:message])
+    if value.blank?
+      record.errors.add(attribute, :empty) unless allow_blank?
+    else
+      record.errors.add(attribute, message, options) unless value.match(regexp)
     end
   end
+
+  #
+  # Transform the string in a regular expression:
+  #
+  #   options[:with] = "9a"
+  #
+  #   regexp #=> /[0-9][a-zA-Z]/
+  #
+  # TODO: improve this
+  def regexp
+    /\A#{(options[:with].to_s.each_char.collect { |char| character_map[char] || "\\#{char}" }).join}\z/
+  end
+
+  def character_map
+    { "9" => "[0-9]", "a" => "[a-zA-Z]", "*" => "[a-zA-Z0-9]" }
+  end
+
+  private
+
+  def message
+    options[:message]
+  end
+
+  def allow_nil?
+    options.include?(:allow_nil) && options[:allow_nil] == false ? false : true
+  end
+
+  def allow_blank?
+    options.include?(:allow_blank) && options[:allow_blank] == false ? false : true
+  end
 end

data/mask_validator.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "mask_validator"
-  s.version     = "0.1"
+  s.version     = "0.2"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Marcelo Cajueiro"]
   s.email       = ["marcelocajueiro@gmail.com"]
@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'activemodel', ">= 3.0"
+  s.add_dependency 'activerecord', ">= 3.0"
   s.add_development_dependency 'rake', '>= 0.8.7'
-
 end

data/spec/mask_validator_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+describe MaskValidator do
+  subject do
+    Person.new :phone => '(12) 3456-7890',
+               :fax => '(12) 3456-7890',
+               :acronym => 'ABC',
+               :alphanumeric => 'AAA666',
+               :zip_code => '88900-000',
+               :birth_date => '13/10/1989',
+               :birth_time => '10:20',
+               :birth_year => '2011',
+               :body_fat => '23,44'
+  end
+
+  it "Person should be valid" do
+    subject.should be_valid
+  end
+
+  # validates :phone, :mask => "(99) 9999-9999", :allow_blank => true
+  context "mask validation to phone with explicit ':allow_blank => true'" do
+    it "should be valid with a nil phone" do
+      subject.phone = nil
+      subject.should be_valid
+    end
+
+    it "should be valid with an empty phone" do
+      subject.phone = ''
+      subject.should be_valid
+    end
+
+    it "should be valid with a phone in according of the mask" do
+      subject.phone = '(48) 9874-4569'
+      subject.should be_valid
+    end
+
+    it "should not be valid with a phone with a wrong pattern" do
+      subject.phone = '4852458787'
+      subject.should_not be_valid
+
+      subject.phone = '48 9865 4879'
+      subject.should_not be_valid
+
+      subject.phone = '(48) 9874-45169'
+      subject.should_not be_valid
+
+      subject.phone = '(48)98956698'
+      subject.should_not be_valid
+    end
+  end
+
+  # validates :acronym, :mask => "***", :allow_nil => true
+  context "mask validation to acronym with explicit ':allow_nil => true'" do
+    it "should be valid with an nil acronym" do
+      subject.acronym = nil
+      subject.should be_valid
+    end
+
+    it "should be valid with an empty acronym" do
+      subject.acronym = ''
+      subject.should be_valid
+    end
+
+    it "should be valid with a acronym in according of the mask" do
+      subject.acronym = '1gd'
+      subject.should be_valid
+
+      subject.acronym = '666'
+      subject.should be_valid
+
+      subject.acronym = 'zzz'
+      subject.should be_valid
+    end
+
+    it "should not be valid with a acronym with a wrong pattern" do
+      subject.acronym = '1qw1'
+      subject.should_not be_valid
+    end
+  end
+
+  # validates :alphanumeric, :mask => "aaa999"
+  context "mask validation to alphanumeric with implicit ':allow_nil => true' and ':allow_blank => true'" do
+    it "should be valid with an nil alphanumeric" do
+      subject.alphanumeric = nil
+      subject.should be_valid
+    end
+
+    it "should be valid with an empty alphanumeric" do
+      subject.alphanumeric = ''
+      subject.should be_valid
+    end
+
+    it "should be valid with a alphanumeric in according of the mask" do
+      subject.alphanumeric = 'awe987'
+      subject.should be_valid
+    end
+
+    it "should not be valid with a alphanumeric with a wrong pattern" do
+      subject.alphanumeric = '999999'
+      subject.should_not be_valid
+
+      subject.alphanumeric = 'QQQQQQ'
+      subject.should_not be_valid
+
+      subject.alphanumeric = '666aaaa'
+      subject.should_not be_valid
+
+      subject.alphanumeric = '666AAA'
+      subject.should_not be_valid
+    end
+  end
+
+  # validates :zip_code, :mask => "99999-999", :allow_blank => false
+  context "mask validation to zip code with explicit ':allow_blank => false'" do
+    it "should not be valid with an nil zip code" do
+      subject.zip_code = nil
+      subject.should_not be_valid
+    end
+
+    it "should not be valid with an empty zip code" do
+      subject.zip_code = ''
+      subject.should_not be_valid
+    end
+  end
+
+  # validates :fax, :mask => "(99) 9999-9999", :allow_nil => false
+  context "mask validation to fax with explicit ':allow_nil => false'" do
+    it "should not be valid with an nil fax" do
+      subject.fax = nil
+      subject.should_not be_valid
+    end
+
+    it "should be valid with an empty fax" do
+      subject.fax = ''
+      subject.should be_valid
+    end
+  end
+
+  context "when the attributes type is not a string" do
+    it "should not be valid with a wrong date format" do
+      subject.birth_date = "15-12-2009"
+      subject.should be_invalid
+    end
+
+    it "should not be valid with a wrong birth year" do
+      subject.birth_year = "20110"
+      subject.should be_invalid
+    end
+
+    it "should not be valid with a wrong birth time" do
+      subject.birth_time = "333:20"
+      subject.should be_invalid
+    end
+
+    it "should not be valid with a wrong body fat" do
+      subject.birth_time = "333,00%"
+      subject.should be_invalid
+    end
+  end
+end

data/spec/models/person.rb

@@ -0,0 +1,11 @@
+class Person < ActiveRecord::Base
+  validates :phone,        :mask => "(99) 9999-9999", :allow_blank => true
+  validates :fax,          :mask => "(99) 9999-9999", :allow_nil => false
+  validates :acronym,      :mask => "***", :allow_nil => true
+  validates :alphanumeric, :mask => "aaa999"
+  validates :zip_code,     :mask => "99999-999", :allow_blank => false
+  validates :birth_date,   :mask => '99/99/9999'
+  validates :birth_time,   :mask => '99:99'
+  validates :birth_year,   :mask => '9999'
+  validates :body_fat,     :mask => "99,99"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'active_model'
+require 'active_record'
+require 'mask_validator'
+
+require "support/db/schema"
+require "support/models/person"

data/spec/support/db/schema.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :people do |t|
+    t.string     :phone
+    t.string     :acronym
+    t.string     :alphanumeric
+    t.string     :zip_code
+    t.string     :fax
+    t.decimal    :body_fat
+    t.integer    :birth_year
+    t.date       :birth_date
+    t.datetime   :birth_time
+  end
+end

data/spec/support/models/person.rb

@@ -0,0 +1,11 @@
+class Person < ActiveRecord::Base
+  validates :phone,        :mask => "(99) 9999-9999", :allow_blank => true
+  validates :fax,          :mask => "(99) 9999-9999", :allow_nil => false
+  validates :acronym,      :mask => "***", :allow_nil => true
+  validates :alphanumeric, :mask => "aaa999"
+  validates :zip_code,     :mask => "99999-999", :allow_blank => false
+  validates :birth_date,   :mask => '99/99/9999'
+  validates :birth_time,   :mask => '99:99'
+  validates :birth_year,   :mask => '9999'
+  validates :body_fat,     :mask => "99,99"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mask_validator
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-07 00:00:00.000000000 -03:00
-default_executable: 
+date: 2012-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &78039790 !ruby/object:Gem::Requirement
+  requirement: &70361744263680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,21 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *78039790
+  version_requirements: *70361744263680
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70361744262500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70361744262500
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &78033190 !ruby/object:Gem::Requirement
+  requirement: &70361744260860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +43,7 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *78033190
+  version_requirements: *70361744260860
 description: 
 email:
 - marcelocajueiro@gmail.com
@@ -42,15 +52,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - MIT-LICENSE
 - README.markdown
 - Rakefile
 - lib/mask_validator.rb
 - mask_validator.gemspec
-- test/mask_validator_test.rb
-- test/test_helper.rb
-has_rdoc: true
+- spec/mask_validator_spec.rb
+- spec/models/person.rb
+- spec/spec_helper.rb
+- spec/support/db/schema.rb
+- spec/support/models/person.rb
 homepage: https://github.com/marcelocajueiro/mask_validator
 licenses: []
 post_install_message: 
@@ -71,8 +84,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mask_validator
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Input Mask validation for ActiveModel
-test_files: []
+test_files:
+- spec/mask_validator_spec.rb
+- spec/models/person.rb
+- spec/spec_helper.rb
+- spec/support/db/schema.rb
+- spec/support/models/person.rb
+has_rdoc: 

data/test/mask_validator_test.rb

@@ -1,50 +0,0 @@
-require 'test_helper'
-
-class MaskValidatorTest < Test::Unit::TestCase
-  def test_phones
-    create_asserts('phone')
-
-    assert_invalid '4852458787'
-    assert_invalid '48 9865 4879'
-    assert_invalid "(48)98956698"
-    assert_invalid "(48) 9874-45169"
-    assert_valid   "(48) 9874-4569"
-  end
-
-  def test_acronyms
-    create_asserts('acronym')
-
-    assert_invalid '1qw1'
-    assert_valid '1gd'
-    assert_valid '666'
-    assert_valid 'zzz'
-  end
-
-  def test_alphanumerics
-    create_asserts('alphanumeric')
-
-    assert_invalid '999999'
-    assert_invalid 'QQQQQQ'
-    assert_invalid '666AAAA'
-    assert_invalid '666AAA'
-    assert_valid 'AAA666'
-  end
-
-  protected
-
-  def create_asserts(attr)
-    class_eval <<-RUBY
-      def assert_valid(value)
-        assert person(:#{attr} => value).valid?
-      end
-
-      def assert_invalid(value)
-        assert person(:#{attr} => value).invalid?
-      end
-    RUBY
-  end
-
-  def person(attributes = {})
-    Person.new(attributes)
-  end
-end

data/test/test_helper.rb

@@ -1,12 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'active_model'
-require 'mask_validator'
-require 'ostruct'
-
-class Person < OpenStruct
-  include ActiveModel::Validations
-  validates :phone, mask: "(99) 9999-9999"
-  validates :acronym, mask: "***"
-  validates :alphanumeric, mask: "aaa999"
-end