mask_validator 0.2 → 0.2.1

data/README.markdown

@@ -8,7 +8,9 @@ The gem works getting the value before type cast and comparing with a regexp fro
 
 ## Installation
 
-`gem "mask_validator"`
+Use the github version until a really stable version be released.
+
+`gem "mask_validator", :git => "git://github.com/MarceloCajueiro/mask_validator.git"`
 
 ## Usage:
 
@@ -16,6 +18,10 @@ The gem works getting the value before type cast and comparing with a regexp fro
 
 `validates :acronym, mask: "***"`
 
+`validates :acronym, mask: :custom_method`
+
+`validates :acronym, mask: Proc.new{|o| o.custom_method}`
+
 * 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)

data/lib/mask_validator.rb

@@ -13,47 +13,58 @@ class MaskValidator < ActiveModel::EachValidator
   #   9 - to numbers (0-9)
   #   * - to alphanumerics (A-Z, a-z, 0-9)
   #
+  def initialize(options)
+    @allow_nil, @allow_blank = options.delete(:allow_nil), options.delete(:allow_blank)
+
+    super
+  end
+
   def validate_each(record, attribute, value)
     value = record.send("#{attribute.to_s}_before_type_cast")
 
-    if value.nil?
-      record.errors.add(attribute, :blank) unless allow_nil?
-    end
+    return if (@allow_nil && value.nil?) || (@allow_blank && value.blank?)
 
-    if value.blank?
-      record.errors.add(attribute, :empty) unless allow_blank?
-    else
-      record.errors.add(attribute, message, options) unless value.match(regexp)
-    end
+    record.errors.add(attribute, message, options) unless value.to_s.match regexp(record)
   end
 
   #
   # Transform the string in a regular expression:
   #
-  #   options[:with] = "9a"
+  #   mask_value_for(record) => "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/
+  def regexp(record=nil)
+    /\A#{(mask_value_for(record).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
 
+  #
+  # Evaluate the options[:with] according with its class:
+  #
+  #   options[:with] = :custom_mask
+  #   options[:with] = Proc.new {|o| o.custom_mask}
+  #   options[:with] = "9a"
+  #
+  # TODO: improve this
+  def mask_value_for(record=nil)
+    case options[:with]
+    when String
+      options[:with]
+    when Proc
+      options[:with].call(record)
+    when Symbol
+      record.send(options[:with])
+    end
+  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.2"
+  s.version     = "0.2.1"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Marcelo Cajueiro"]
   s.email       = ["marcelocajueiro@gmail.com"]

data/spec/mask_validator_spec.rb

@@ -2,124 +2,147 @@ 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
+    Person.new
   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
-
+  context "mask validation to phone" do
     it "should be valid with a phone in according of the mask" do
       subject.phone = '(48) 9874-4569'
-      subject.should be_valid
+      subject.should have_valid_value_to(:phone)
     end
 
     it "should not be valid with a phone with a wrong pattern" do
       subject.phone = '4852458787'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:phone)
 
       subject.phone = '48 9865 4879'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:phone)
 
       subject.phone = '(48) 9874-45169'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:phone)
 
       subject.phone = '(48)98956698'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:phone)
     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
-
+  context "mask validation to acronym" do
     it "should be valid with a acronym in according of the mask" do
       subject.acronym = '1gd'
-      subject.should be_valid
+      subject.should have_valid_value_to(:acronym)
 
       subject.acronym = '666'
-      subject.should be_valid
+      subject.should have_valid_value_to(:acronym)
 
       subject.acronym = 'zzz'
-      subject.should be_valid
+      subject.should have_valid_value_to(:acronym)
     end
 
     it "should not be valid with a acronym with a wrong pattern" do
       subject.acronym = '1qw1'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:acronym)
     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
-
+  context "mask validation to alphanumeric" do
     it "should be valid with a alphanumeric in according of the mask" do
       subject.alphanumeric = 'awe987'
-      subject.should be_valid
+      subject.should have_valid_value_to(:alphanumeric)
     end
 
     it "should not be valid with a alphanumeric with a wrong pattern" do
       subject.alphanumeric = '999999'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:alphanumeric)
 
       subject.alphanumeric = 'QQQQQQ'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:alphanumeric)
 
       subject.alphanumeric = '666aaaa'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:alphanumeric)
 
       subject.alphanumeric = '666AAA'
-      subject.should_not be_valid
+      subject.should_not have_valid_value_to(:alphanumeric)
     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
+  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_not have_valid_value_to(:birth_date)
     end
 
-    it "should not be valid with an empty zip code" do
-      subject.zip_code = ''
-      subject.should_not be_valid
+    it "should not be valid with a wrong birth year" do
+      subject.birth_year = 20110
+      subject.should_not have_valid_value_to(:birth_year)
+    end
+
+    it "should not be valid with a wrong birth time" do
+      subject.birth_time = "333:20"
+      subject.should_not have_valid_value_to(:birth_time)
+    end
+
+    it "should not be valid with a wrong body fat" do
+      subject.body_fat = 333.00
+      subject.should_not have_valid_value_to(:body_fat)
+    end
+  end
+
+  # validates :custom, :mask => :custom_mask, :allow_blank => false
+  context "mask validation to custom field using custom_mask method" do
+    it "should be valid with an correct custom value" do
+      subject.stub!(:custom_mask => "99999-999")
+      subject.custom = '32632-567'
+      subject.should have_valid_value_to(:custom)
+    end
+
+    it "should not be valid with an empty custom value" do
+      subject.stub!(:custom_mask => "9.9.9")
+      subject.custom = ''
+      subject.should_not have_valid_value_to(:custom)
+    end
+  end
+
+  # validates :identification, :mask => Proc.new{|o| o.proc_mask}, :allow_blank => false
+  context "mask validation to proc field using a Proc" do
+    it "should be valid with an correct value" do
+      subject.stub!(:proc_mask => "999.9.99")
+      subject.identification = '326.3.67'
+      subject.should have_valid_value_to(:identification)
+    end
+
+    it "should not be valid with an empty value" do
+      subject.stub!(:prock_mask => "9.9.9")
+      subject.identification = ''
+      subject.should_not have_valid_value_to(:identification)
+    end
+  end
+
+  # validates :phone, :mask => "99999-999", :allow_blank => true
+  context "mask validation to phone with explicit ':allow_blank => true'" do
+    it "should not be valid with an nil phone" do
+      subject.phone = nil
+      subject.should have_valid_value_to(:phone)
+    end
+
+    it "should be valid with an empty phone" do
+      subject.phone = ''
+      subject.should have_valid_value_to(:phone)
+    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 have_valid_value_to(:acronym)
+    end
+
+    it "should be valid with an empty acronym" do
+      subject.acronym = ''
+      subject.should_not have_valid_value_to(:acronym)
     end
   end
 
@@ -127,34 +150,38 @@ describe MaskValidator do
   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
+      subject.should_not have_valid_value_to(:fax)
     end
 
     it "should be valid with an empty fax" do
       subject.fax = ''
-      subject.should be_valid
+      subject.should_not have_valid_value_to(:fax)
     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
+  # 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 have_valid_value_to(:zip_code)
     end
 
-    it "should not be valid with a wrong birth year" do
-      subject.birth_year = "20110"
-      subject.should be_invalid
+    it "should be valid with an empty zip_code" do
+      subject.zip_code = ''
+      subject.should_not have_valid_value_to(:zip_code)
     end
+  end
 
-    it "should not be valid with a wrong birth time" do
-      subject.birth_time = "333:20"
-      subject.should be_invalid
+  # validates :birth_date, :mask => '99/99/9999'
+  context "mask validation to birth_date with implicit ':allow_blank => false'" do
+    it "should not be valid with an nil birth_date" do
+      subject.birth_date = nil
+      subject.should_not have_valid_value_to(:birth_date)
     end
 
-    it "should not be valid with a wrong body fat" do
-      subject.birth_time = "333,00%"
-      subject.should be_invalid
+    it "should be valid with an empty birth_date" do
+      subject.birth_date = ''
+      subject.should_not have_valid_value_to(:birth_date)
     end
   end
 end

data/spec/models/person.rb

@@ -1,11 +1,21 @@
 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"
+  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"
+  validates :custom,           :mask => :custom_mask, :allow_blank => false
+  validates :identification,   :mask => Proc.new{|o| o.proc_mask}, :allow_blank => false
+
+  def custom_mask
+    "999.99"
+  end
+
+  def proc_mask
+    "99.99"
+  end
 end

data/spec/spec_helper.rb

@@ -5,3 +5,19 @@ require 'mask_validator'
 
 require "support/db/schema"
 require "support/models/person"
+
+RSpec::Matchers.define :have_valid_value_to do |attribute|
+  match do |actual|
+    actual.valid?
+
+    !actual.errors[attribute].include?("is invalid")
+  end
+
+  failure_message_for_should do |actual|
+    "expected that the #{attribute} attribute would be valid"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that the #{attribute} attribute would be invalid"
+  end
+end

data/spec/support/db/schema.rb

@@ -16,5 +16,7 @@ ActiveRecord::Schema.define do
     t.integer    :birth_year
     t.date       :birth_date
     t.datetime   :birth_time
+    t.string     :custom
+    t.string     :identification
   end
 end

data/spec/support/models/person.rb

@@ -1,11 +1,21 @@
 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"
+  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"
+  validates :custom,           :mask => :custom_mask, :allow_blank => false
+  validates :identification,   :mask => Proc.new{|o| o.proc_mask}, :allow_blank => false
+
+  def custom_mask
+    "999.99"
+  end
+
+  def proc_mask
+    "99.99"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mask_validator
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70361744263680 !ruby/object:Gem::Requirement
+  requirement: &70113695766940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70361744263680
+  version_requirements: *70113695766940
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70361744262500 !ruby/object:Gem::Requirement
+  requirement: &70113695766380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70361744262500
+  version_requirements: *70113695766380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70361744260860 !ruby/object:Gem::Requirement
+  requirement: &70113695765640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70361744260860
+  version_requirements: *70113695765640
 description: 
 email:
 - marcelocajueiro@gmail.com
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mask_validator
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Input Mask validation for ActiveModel