format_validators 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,5 +1,12 @@
 == unreleased changes
 
+== 0.0.5
+
+* Added a zip code format validator and tests
+* Added a phone format validator and tests
+* Added a days of the week validator
+* Added support for >= rails 3.0.7
+
 == 0.0.4
 
 * Added a currency validator

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
-gem "rails", "~> 3.0.7"
+gem "rails", ">= 3.0.7"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -143,7 +143,7 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   capybara (>= 0.4.0)
   jeweler (~> 1.6.4)
-  rails (~> 3.0.7)
+  rails (>= 3.0.7)
   rspec (~> 2.6.0)
   rspec-rails (~> 2.6.1)
   ruby-debug19

data/README.rdoc

@@ -1,6 +1,49 @@
-= format_validators
+== format_validators
+
+A consolidation of a few of the most common validations.
+
+== What do we validate
+
+* Currency
+* Florida Counties (a little too custom but someone requested it so here it is)
+* Phone Numbers
+* Social Security Number
+* ZIP code
+
+== Install
+
+    gem install format_validators
+
+== Examples:
+
+Like all validations these lines go in the model.
+
+=== Currency
+
+    validates :total, :currency_format => true
+    validates <field>, :currency_format => true
+
+=== Florida Counties
+
+    validates :county, :florida_counties => true
+    validates <field>, :florida_counties => true
+
+=== Phone Numbers
+
+    validates :phone_number, :phone_format => true
+    validates <field>, :phone_format => true
+
+=== Social Security Number
+
+    validates :social, :ssn_format => true
+    validates <field>, :ssn_format => true
+
+=== ZIP code
+
+    validates :zip, :zipcode_format => true
+    validates <field>, :zipcode_format => true
+
 
-Description goes here.
 
 == Contributing to format_validators
  

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/app/validators/days_of_week_validator.rb

@@ -0,0 +1,30 @@
+class DaysOfWeekValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    value = value.to_s.downcase
+    record.errors[attribute] << value + " is not a valid day of the week or abbreviation" unless DAYS.include?(value)
+  end
+    DAYS = [
+      "monday",
+      "mon",
+      "m",
+      "tuesday",
+      "tues",
+      "tu",
+      "t",
+      "wednesday",
+      "wed",
+      "w",
+      "thursday",
+      "thurs",
+      "th",
+      "friday",
+      "fri",
+      "f",
+      "saturday",
+      "sat",
+      "s",
+      "sunday",
+      "sun",
+      "su"
+    ]
+end

data/app/validators/phone_format_validator.rb

@@ -0,0 +1,55 @@
+# Custom Validations for Phone Number format
+#
+# Currently only has support for north american phone numbers.  Additional support will be added later
+#
+# e.g. validates :home_phone, :phone_format => true
+# e.g. validates :cell_phone, :phone_format => { :allow_blank => true, :if => :method_returns_true }
+#
+# Validates 7, 10, and 11 digit hone numbers to the NANP standard
+# Handles parentheses, +, -  and white space in the phone number
+class PhoneFormatValidator < ActiveModel::EachValidator
+
+  # validates the phone number
+  # defaults to north america region
+  #
+  # removes parens, dash, space, and plus from numbers
+  # checks for non digit characters in the number
+  # checks against regional format validator
+  # adds errors if necessary
+  def validate_each record, attribute, value
+    region = options[:region] || :north_america
+    
+    formatted_value = value.gsub(/[\s\.\+\(\)-]*/, "")
+    is_number = !(formatted_value =~ /^[-+]?[0-9]+$/).nil?  # it returns 0 if it is a number with digits 0-9 or nil if not
+    unless is_number && validate_by_region(region, formatted_value)
+      message = attribute.to_s.humanize + ' doesn\'t match an acceptable format.'
+      record.errors[attribute] << (options[:message] || message )
+    end
+  end
+
+  # @param [Symbol] region The phone number region to check against
+  # @param [String] formatted_value Formatted phone number, guaranteed to be all digits
+  # @return [Boolean] Whether the formatted value passes region validations
+  def validate_by_region(region, formatted_value)
+    if region == :north_america
+      valid_eleven_digit?(formatted_value) || valid_ten_digit?(formatted_value) || valid_seven_digit?(formatted_value)
+    else
+      false
+    end
+  end
+
+  # @return [Boolean] True if it is seven digits long and the first digit is not 1 or 0
+  def valid_seven_digit?(input)
+    input.length == 7 && input[0] != "0" && input[0] != "1"
+  end
+
+  # @return [Boolean] True if it is 10 digits long, first digit not 1 or 0 and the last 7 digits validate
+  def valid_ten_digit?(input)
+    input.length == 10 && input[0] != "0" && input[0] != "1" && valid_seven_digit?(input.slice(-7, 7))
+  end
+
+  # @return [Boolean] Same as the ten digit with a 1 in front
+  def valid_eleven_digit?(input)
+    input.length == 11 && input[0] == "1" && valid_ten_digit?(input.slice(-10, 10))
+  end
+end

data/app/validators/zipcode_format_validator.rb

@@ -0,0 +1,11 @@
+# Custom Validations for Zip Code format
+
+# e.g. validates :zip, :zipcode_format => true
+# e.g. validates :zip, :zipcode_format => { :allow_blank => true, :if => :method_returns_true }
+class ZipcodeFormatValidator < ActiveModel::EachValidator
+  def validate_each record, attribute, value
+    format = /^\A[\d]{5}(?:[-|\s][\d]{4})?\Z$/
+    message = attribute.to_s.humanize + ' doesn\'t match an acceptable format.'
+    record.errors[attribute] << (options[:message] || message ) unless value =~ format
+  end
+end

data/format_validators.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "format_validators"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremiah Hemphill"]
-  s.date = "2012-03-21"
+  s.date = "2012-04-04"
   s.description = "Complex format validators"
   s.email = "jeremiah@cloudspace.com"
   s.extra_rdoc_files = [
@@ -27,8 +27,11 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "app/validators/currency_format_validator.rb",
+    "app/validators/days_of_week_validator.rb",
     "app/validators/florida_counties_validator.rb",
+    "app/validators/phone_format_validator.rb",
     "app/validators/ssn_format_validator.rb",
+    "app/validators/zipcode_format_validator.rb",
     "format_validators.gemspec",
     "lib/format_validators.rb",
     "lib/format_validators/engine.rb",
@@ -73,9 +76,12 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb",
     "spec/support/basic_record.rb",
     "spec/validators/currency_format_validator_spec.rb",
+    "spec/validators/days_of_week_validator_spec.rb",
     "spec/validators/florida_counties_integration_spec.rb",
     "spec/validators/florida_counties_spec.rb",
-    "spec/validators/ssn_format_validator_spec.rb"
+    "spec/validators/phone_format_validator_spec.rb",
+    "spec/validators/ssn_format_validator_spec.rb",
+    "spec/validators/zipcode_format_validator_spec.rb"
   ]
   s.homepage = "http://github.com/jeremiahishere/format_validators"
   s.licenses = ["MIT"]
@@ -87,7 +93,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, ["~> 3.0.7"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.7"])
       s.add_development_dependency(%q<capybara>, [">= 0.4.0"])
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -100,7 +106,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<ZenTest>, [">= 0"])
       s.add_development_dependency(%q<autotest-rails>, [">= 0"])
     else
-      s.add_dependency(%q<rails>, ["~> 3.0.7"])
+      s.add_dependency(%q<rails>, [">= 3.0.7"])
       s.add_dependency(%q<capybara>, [">= 0.4.0"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -114,7 +120,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<autotest-rails>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rails>, ["~> 3.0.7"])
+    s.add_dependency(%q<rails>, [">= 3.0.7"])
     s.add_dependency(%q<capybara>, [">= 0.4.0"])
     s.add_dependency(%q<sqlite3>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

data/spec/validators/days_of_week_validator_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe DaysOfWeekValidator do
+
+  describe ".validate_each" do
+    before(:all) do
+      @options = {:attributes => {}}
+      @validator = DaysOfWeekValidator.new(@options)
+      @record = BasicRecord.new(:days)
+    end
+
+    it "should return true for valid day names" do
+      @record.errors[:days].should_not_receive("<<")
+      @validator.validate_each(@record, :days, "MONDAY")
+    end
+
+    it "should return true for valid day abbreviation" do
+      @record.errors[:days].should_not_receive("<<")
+      @validator.validate_each(@record, :days, "WED")
+    end
+
+    it "should return true for valid day abbreviation" do
+      @record.errors[:days].should_not_receive("<<")
+      @validator.validate_each(@record, :days, "TU")
+    end
+
+    it "should return false for invalid days" do
+      @record.errors[:days].should_receive("<<")
+      @validator.validate_each(@record, :days, "kajhef")
+    end
+
+    it "should return false for invalid days" do
+      @record.errors[:days].should_receive("<<")
+      @validator.validate_each(@record, :days, "GDHSKFBF HGVHEHJF 5636464 FHFGGG")
+    end
+
+    it "should return false for blank string" do
+      @record.errors[:days].should_receive("<<")
+      @validator.validate_each(@record, :days, "")
+    end
+
+    it "should return false for nil" do
+      @record.errors[:days].should_receive("<<")
+      @validator.validate_each(@record, :days, nil)
+    end
+  end
+end

data/spec/validators/phone_format_validator_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe PhoneFormatValidator do
+  before(:each) do
+    @options = {:attributes => {}}
+    @validator = PhoneFormatValidator.new(@options)
+  end
+
+  describe ".validate_seven_digit?" do
+    it "should return false if the length isn't 7" do
+      @validator.valid_seven_digit?("4321").should be_false
+    end
+
+    it "should return false if the first digit is 0" do
+      @validator.valid_seven_digit?("0123456").should be_false
+    end
+
+    it "should return false if the first digit is 1" do
+      @validator.valid_seven_digit?("1234567").should be_false
+    end
+
+    it "should return true if all requirements are met" do
+      @validator.valid_seven_digit?("2345678").should be_true
+    end
+  end
+
+  describe ".validate_ten_digit?" do
+    before(:each) do
+      @validator.stub!(:valid_seven_digit?).and_return(true)
+    end
+
+    it "should return false if the length isn't 10" do
+      @validator.valid_ten_digit?("4321").should be_false
+    end
+    
+    it "should return false if the first digit is 0" do
+      @validator.valid_ten_digit?("0123456789").should be_false
+    end
+
+    it "should return false if the first digit is 1" do
+      @validator.valid_ten_digit?("1234567890").should be_false
+    end
+
+    it "should return false if it fails seven digit validation" do
+      @validator.should_receive(:valid_seven_digit?).and_return(false)
+      @validator.valid_ten_digit?("2345678901").should be_false
+    end
+
+    it "should return true if all requirements are met" do
+      @validator.valid_ten_digit?("2345678901").should be_true
+    end
+  end
+
+  describe ".validate_ten_digit?" do
+    before(:each) do
+      @validator.stub!(:valid_ten_digit?).and_return(true)
+    end
+
+    it "should return false if the length isn't 11" do
+      @validator.valid_eleven_digit?("4321").should be_false
+    end
+
+    it "should return false if the first digit is not 1" do
+      @validator.valid_eleven_digit?("22234567890")
+    end
+
+    it "should return false if it fails ten digit validation" do
+      @validator.should_receive(:valid_ten_digit?).and_return(false)
+      @validator.valid_eleven_digit?("12234567890").should be_false
+    end
+
+    it "should return true if all requirements are met" do
+      @validator.valid_eleven_digit?("12234567890").should be_true
+    end
+  end
+
+  describe ".validate_by_region" do
+    it "it should call the three north american methods" do
+      @validator.should_receive(:valid_seven_digit?)
+      @validator.should_receive(:valid_ten_digit?)
+      @validator.should_receive(:valid_eleven_digit?)
+      @validator.validate_by_region(:north_america, "2345678901")
+    end
+    it "should return false if the region does not match any known region" do
+      @validator.validate_by_region(:other_region, "2345678901").should be_false
+    end
+  end
+
+  describe ".validate_each" do
+    before(:each) do
+      @record = BasicRecord.new(:phone)
+    end
+
+    it "should call validate_by_region with north america by default" do
+      @validator.should_receive(:validate_by_region).with(:north_america, "123456789")
+      @validator.validate_each(@record, :phone, "123-45-6789")
+    end
+    
+    it "should not validate_by_region if number is not numeric" do
+      @validator.should_not_receive(:validate_by_region)
+      @validator.validate_each(@record, :phone, "123-xyz-6789")
+    end
+
+    it "should not add an error due to allowed special characters" do
+      @record.errors[:phone].should_not_receive("<<")
+      @validator.validate_each(@record, :phone, "()+.- 12345678901")
+    end
+    
+    it "should add an error on a bad phone number" do
+      @record.errors[:phone].should_receive("<<")
+      @validator.validate_each(@record, :phone, "123abc")
+    end
+
+    it "should not add an error on a good phone number" do
+      @record.errors[:phone].should_not_receive("<<")
+      @validator.validate_each(@record, :phone, "555-555-5555")
+    end
+  end
+end

data/spec/validators/zipcode_format_validator_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe ZipcodeFormatValidator do
+  describe ".validate_each" do
+    before(:each) do
+      @options = {:attributes => {}}
+      @validator = ZipcodeFormatValidator.new(@options)
+      @record = BasicRecord.new(:zip_code)
+    end
+
+    it "should validate 5 digit zip codes" do
+      @record.errors[:zip_code].should_not_receive("<<")
+      @validator.validate_each(@record, :zip_code, "12345")
+    end
+
+    it "should validate 9 digit zip codes with a space"do
+      @record.errors[:zip_code].should_not_receive("<<")
+      @validator.validate_each(@record, :zip_code, "12345 6789")
+    end
+
+    it "should validate 9 digit zip codes with a dash"do
+      @record.errors[:zip_code].should_not_receive("<<")
+      @validator.validate_each(@record, :zip_code, "12345-6789")
+    end
+
+    it "should not validate 9 digit zip codes with nothing between the first 5 and last 4"do
+      @record.errors[:zip_code].should_receive("<<")
+      @validator.validate_each(@record, :zip_code, "123456789")
+    end
+
+    it "should not validate zip codes of other lengths"do
+      @record.errors[:zip_code].should_receive("<<")
+      @validator.validate_each(@record, :zip_code, "123456")
+    end
+
+    it "does not have support for canadian zip codes"do
+      @record.errors[:zip_code].should_receive("<<")
+      @validator.validate_each(@record, :zip_code, "K1A OB1")
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: format_validators
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Jeremiah Hemphill
@@ -10,14 +10,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-21 00:00:00 Z
+date: 2012-04-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 3.0.7
   type: :runtime
@@ -164,8 +164,11 @@ files:
 - Rakefile
 - VERSION
 - app/validators/currency_format_validator.rb
+- app/validators/days_of_week_validator.rb
 - app/validators/florida_counties_validator.rb
+- app/validators/phone_format_validator.rb
 - app/validators/ssn_format_validator.rb
+- app/validators/zipcode_format_validator.rb
 - format_validators.gemspec
 - lib/format_validators.rb
 - lib/format_validators/engine.rb
@@ -210,9 +213,12 @@ files:
 - spec/spec_helper.rb
 - spec/support/basic_record.rb
 - spec/validators/currency_format_validator_spec.rb
+- spec/validators/days_of_week_validator_spec.rb
 - spec/validators/florida_counties_integration_spec.rb
 - spec/validators/florida_counties_spec.rb
+- spec/validators/phone_format_validator_spec.rb
 - spec/validators/ssn_format_validator_spec.rb
+- spec/validators/zipcode_format_validator_spec.rb
 homepage: http://github.com/jeremiahishere/format_validators
 licenses: 
 - MIT
@@ -226,7 +232,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4008772419598118185
+      hash: 2589333216613871779
       segments: 
       - 0
       version: "0"