format_validators 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,5 +1,9 @@
 == unreleased changes
 
+== 0.0.7
+
+* Updated comments for several validators
+
 == 0.0.6
 
 * Added devise password validator

data/README.rdoc

@@ -5,8 +5,9 @@ A consolidation of a few of the most common validations.
 == What do we validate
 
 * Currency
+* Days of the Week
 * Florida Counties (a little too custom but someone requested it so here it is)
-* Phone Numbers
+* North American Phone Number
 * Social Security Number
 * ZIP code
 

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/app/validators/days_of_week_validator.rb

@@ -1,10 +1,22 @@
+#  Checks validity of values supplied for an object's days of the week attribute
+#
+#  example usage:
+#    validates :atrribute_to_check, :days_of_week => true
 class DaysOfWeekValidator < ActiveModel::EachValidator
+  #  Compares object's days of week attribute against days_of_week array for validity
+  #  @param [BasicRecord] record This is the object needing validation
+  #  @param [Symbol] attribute The attribute being validated
+  #  @param [String] value The value of the attribute to compare aginst the days_of_week array
+  #  @return [Boolean] True or false depending on if the value of the record's attribute is contained within the days_of_week array
   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)
+    record.errors[attribute] << value + " is not a valid day of the week or abbreviation" unless self.days_of_week.include?(value)
   end
-    DAYS = [
-      "monday",
+  
+  #  All available days of the week and their abbreviations to be compared against for validation
+  #  @return [Array] Array containing all available abbreviations for days of the week
+  def self.days_of_week
+    ["monday",
       "mon",
       "m",
       "tuesday",
@@ -27,4 +39,5 @@ class DaysOfWeekValidator < ActiveModel::EachValidator
       "sun",
       "su"
     ]
+  end
 end

data/app/validators/florida_counties_validator.rb

@@ -1,19 +1,40 @@
-# counties use abbreviations and will not validate otherwise
+#
+# Counties use abbreviations and will not validate otherwise
+#
+# Note: counties with abbreviations do not account for the full name
 # example: Saint Lucie must be St. Lucie
+#
 class FloridaCountiesValidator < ActiveModel::EachValidator
+
+  #
+  # Checks the value parameter against a list of all Florida Counties
+  # If the value contains the word county, it is considered invalid
+  #
+  # @param [ActiveRecord::Base] record the record containing the value
+  # @param [Symbol] attribute the symbol used to access the value on the record
+  # @param [String] value The value of the attribute being validated
+  #
   def validate_each record, attribute, value
+
+    # normalize the value for later comparison
     value = value.to_s.downcase.split(' ').map {|w| w.capitalize }.join(' ')
 
+    # Check the value does not contain the word county
     if value.include?("County")
       message = value + ' should not contain the word county.' 
       record.errors[attribute] << (options[:message] || message )
+      
+      # strip county to further normalize the string. This allows
+      # the value to still be compared against the COUNTIES list
       value = value.gsub("County", "").strip
     end
 
     message = value + ' is not a county in Florida' 
+    # push message into errors if the value is not found in the COUNTIES list
     record.errors[attribute] << (options[:message] || message ) unless COUNTIES.include? value
   end
 
+  # List of known florida counties
   COUNTIES = [
     "Alachua",
     "Baker",

data/app/validators/phone_format_validator.rb

@@ -16,6 +16,9 @@ class PhoneFormatValidator < ActiveModel::EachValidator
   # checks for non digit characters in the number
   # checks against regional format validator
   # adds errors if necessary
+  # @param [ActiveRecord::Base] record The record to validate
+  # @param [Symbol] attribute The field on the record to validate
+  # @param [String] value The value of the attribute
   def validate_each record, attribute, value
     region = options[:region] || :north_america
     
@@ -27,6 +30,9 @@ class PhoneFormatValidator < ActiveModel::EachValidator
     end
   end
 
+  # Validates a phone number by region
+  #
+  # Currently only supports the north_america region
   # @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
@@ -38,16 +44,19 @@ class PhoneFormatValidator < ActiveModel::EachValidator
     end
   end
 
+  # @param [String] input String representation of a phone number with non digit characters removed
   # @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
 
+  # @param [String] input String representation of a phone number with non digit characters removed
   # @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
 
+  # @param [String] input String representation of a phone number with non digit characters removed
   # @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))

data/app/validators/ssn_format_validator.rb

@@ -1,8 +1,14 @@
 # Custom Validations for Social Security Number format
-
+#
 # e.g. validates :ssn, :ssn_format => true
 # e.g. validates :ssn, :ssn_format => { :allow_blank => true, :if => :method_returns_true }
 class SsnFormatValidator < ActiveModel::EachValidator
+
+  # Checks input against a social security regex that matches ###-##-#### with or without dashes
+  #
+  # @param [ActiveRecord::Base] record The record to validate
+  # @param [Symbol] attribute The field on the record to validate
+  # @param [String] value The value of the attribute
   def validate_each record, attribute, value
     format = /^\A([\d]{3}\-[\d]{2}\-[\d]{4}|[\d]{9})\Z$/
     message = attribute.to_s.humanize + ' does not match the format ###-##-####.'

data/app/validators/zipcode_format_validator.rb

@@ -3,6 +3,10 @@
 # e.g. validates :zip, :zipcode_format => true
 # e.g. validates :zip, :zipcode_format => { :allow_blank => true, :if => :method_returns_true }
 class ZipcodeFormatValidator < ActiveModel::EachValidator
+  # validates a US zipcode matching 12345, 12345 6789, or 12345-6789
+  # @param [ActiveRecord::Base] record The record to validate
+  # @param [Symbol] attribute The field on the record to validate
+  # @param [String] value The value of the attribute
   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.'

data/format_validators.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "format_validators"
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremiah Hemphill"]
-  s.date = "2012-04-04"
+  s.date = "2012-04-11"
   s.description = "Complex format validators"
   s.email = "jeremiah@cloudspace.com"
   s.extra_rdoc_files = [

metadata

@@ -2,7 +2,7 @@
 name: format_validators
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Jeremiah Hemphill
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-04 00:00:00 Z
+date: 2012-04-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -234,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 26858958529201011
+      hash: -2572695772213769967
       segments: 
       - 0
       version: "0"