activevalidators 1.4.0 → 1.5.0

data/README.md

@@ -42,6 +42,10 @@ In your models, the gem provides new validators like `email`, or `url`:
       validates :credit_card,   :credit_card => { :type => :any  }
     end
 
+    class Order
+      validates :tracking_num,  :tracking_number => { :carrier => :ups }
+    end
+
 
 Exhaustive list of supported validators and their implementation:
 
@@ -55,6 +59,7 @@ Exhaustive list of supported validators and their implementation:
 * `date`  : based on the `DateValidator` gem
 * `password` : based on a set of regular expressions
 * `postal_code`: based on a set of predefined masks
+* `tracking_number`: based on a set of predefined masks
 
 Todo
 ----

data/activevalidators.gemspec

@@ -4,7 +4,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "activevalidators"
-  s.version     = '1.4.0'
+  s.version     = '1.5.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Franck Verrot", "Paco Guzmán", "Oriol Gual", "Garrett Bjerkhoel", "Renato Riccieri Santos Zannon", "Brian Moseley"]
   s.email       = ["franck@verrot.fr"]

data/lib/active_model/validations/tracking_number_validator.rb

@@ -0,0 +1,32 @@
+module ActiveModel
+  module Validations
+    class TrackingNumberValidator < EachValidator
+      def validate_each(record, attribute, value)
+        @value = value
+        carrier = options[:carrier]
+        raise "Carrier option required" unless carrier
+        @formats = TrackingNumberValidator.known_formats[carrier]
+        raise "No known tracking number formats for carrier #{carrier}" unless @formats
+        record.errors.add(attribute) unless matches_any?
+      end
+
+      def self.known_formats
+        @@known_formats ||= {
+          # see https://www.ups.com/content/us/en/tracking/help/tracking/tnh.html
+          :ups => ['1Z################', '############', 'T##########', '#########'],
+        }
+      end
+
+      def matches_any?
+        false if @formats.nil? or not @formats.respond_to?(:detect)
+        @formats.detect { |format| @value.match(TrackingNumberValidator.regexp_from format) }
+      end
+
+      private
+
+      def self.regexp_from(format)
+        Regexp.new "^"+(Regexp.escape format).gsub('\#','\d')+"$"
+      end
+    end
+  end
+end

data/lib/activevalidators.rb

@@ -9,7 +9,8 @@ module ActiveModel
     extend ActiveSupport::Autoload
 
     def self.activevalidators
-      ['Email','Url','RespondTo','Phone','Slug','Ip','CreditCard','Date','Password','Twitter','PostalCode']
+      ['Email','Url','RespondTo','Phone','Slug','Ip','CreditCard','Date','Password','Twitter','PostalCode',
+        'TrackingNumber']
     end
 
     #Eager autoload the library's validators into AR::Validations

data/spec/spec_helper.rb

@@ -11,5 +11,5 @@ class TestRecord
   include ActiveModel::Validations
   attr_accessor :ip, :url, :slug, :responder, :global_condition,
     :local_condition, :phone, :email, :card, :password, :twitter_username,
-    :postal_code
+    :postal_code, :tracking_number
 end

data/spec/validations/tracking_number_spec.rb

@@ -0,0 +1,66 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe "Tracking Number Validation" do
+
+  subject { TestRecord.new }
+
+  context "when no carrier parameter is given" do
+    before(:each) do
+      TestRecord.reset_callbacks(:validate)
+        TestRecord.validates :tracking_number, :tracking_number => true
+    end
+
+    it "raises an exception" do
+      lambda { subject.valid? }.should raise_error
+    end
+  end
+
+  context "when given a ups carrier parameter" do
+    before(:each) do
+      TestRecord.reset_callbacks(:validate)
+      TestRecord.validates :tracking_number, :tracking_number => {:carrier => :ups}
+    end
+
+    it 'should validate format of tracking number with 1Z################' do
+      subject.tracking_number = '1Z9999999999999999'
+      subject.should be_valid
+      subject.should have(0).errors
+    end
+
+    it 'should validate format of tracking number with ############' do
+      subject.tracking_number = '999999999999'
+      subject.should be_valid
+      subject.should have(0).errors
+    end
+
+    it 'should validate format of tracking number with T##########' do
+      subject.tracking_number = 'T9999999999'
+      subject.should be_valid
+      subject.should have(0).errors
+    end
+
+    it 'should validate format of tracking number with #########' do
+      subject.tracking_number = '999999999'
+      subject.should be_valid
+      subject.should have(0).errors
+    end
+  end
+
+  describe "for invalid formats" do
+    before :each do
+      TestRecord.reset_callbacks(:validate)
+      TestRecord.validates :tracking_number, :tracking_number => {:carrier => :ups}
+      subject.tracking_number = '999'
+    end
+
+    it "rejects invalid formats" do
+      subject.should_not be_valid
+      subject.should have(1).error
+    end
+
+    it "generates an error message of type invalid" do
+      subject.should_not be_valid
+      subject.errors[:tracking_number].should include subject.errors.generate_message(:tracking_number, :invalid)
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activevalidators
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 1
-  - 4
+  - 5
   - 0
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Franck Verrot
@@ -20,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-30 00:00:00 +02:00
+date: 2011-05-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -169,6 +169,7 @@ files:
 - lib/active_model/validations/postal_code_validator.rb
 - lib/active_model/validations/respond_to_validator.rb
 - lib/active_model/validations/slug_validator.rb
+- lib/active_model/validations/tracking_number_validator.rb
 - lib/active_model/validations/twitter_validator.rb
 - lib/active_model/validations/url_validator.rb
 - lib/activevalidators.rb
@@ -182,6 +183,7 @@ files:
 - spec/validations/postal_code_spec.rb
 - spec/validations/respond_to_spec.rb
 - spec/validations/slug_spec.rb
+- spec/validations/tracking_number_spec.rb
 - spec/validations/twitter_spec.rb
 - spec/validations/url_spec.rb
 has_rdoc: true
@@ -214,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Collection of ActiveModel/ActiveRecord validations
@@ -229,5 +231,6 @@ test_files:
 - spec/validations/postal_code_spec.rb
 - spec/validations/respond_to_spec.rb
 - spec/validations/slug_spec.rb
+- spec/validations/tracking_number_spec.rb
 - spec/validations/twitter_spec.rb
 - spec/validations/url_spec.rb