abn 1.2.0 → 1.3.0

data/README.rdoc

@@ -2,7 +2,7 @@ A small class for validating Australian Business Numbers (ABN)
 
 = Installation
 
-  gem install yob-abn --source http://gems.github.com/
+  gem install abn
 
 = Usage
 
@@ -11,10 +11,10 @@ A small class for validating Australian Business Numbers (ABN)
   ABN.new("12042168743").valid?
   => true
 
-  ABN.valid_abn?("12042168743")
+  ABN.valid?("12042168743")
   => true
 
-  ABN.valid_abn?("12042168744")
+  ABN.valid?("12042168744")
   => false
 
 = Further Reading

data/lib/abn.rb

@@ -2,9 +2,9 @@ class ABN
 
   module Version #:nodoc:
     Major = 1
-    Minor = 2
+    Minor = 3
     Tiny  = 0
-    
+
     String = [Major, Minor, Tiny].join('.')
   end
 
@@ -27,7 +27,7 @@ class ABN
       digit = c.to_i - (i.zero? ? 1 : 0)
       sum += weights[i] * digit
     end
-    
+
     sum % 89 == 0 ? true : false
   end
 
@@ -43,3 +43,41 @@ class ABN
     new(abn).valid?
   end
 end
+
+module ABNValidations
+  class << self
+    def enable
+      ActiveRecord::Base.extend ABNValidations
+    end
+  end
+
+
+  # Validates whether the value of the specified attribute conforms to the Australian Business Number (ABN) format.
+  #
+  # +validates_abn_correctness_of+ will automatically non-destructively strip any formatting and whitespace before
+  # validation
+  def validates_abn_correctness_of(*args)
+
+    # Set up our configuration for this validation
+    configuration = { :on => :save, :allow_nil => false, :message => "is not a valid ABN" }
+    configuration.update(args.extract_options!)
+
+    # iterate through each field we've set up to validate the local numericality of
+    validates_each(args, configuration) do |instance, attr_name, value|
+
+      # get our raw value (ie, what was last sent to the instance...)
+      raw_value = instance.send("#{attr_name}_before_type_cast") || value
+
+      # skip our processing if we've got a legal nil...
+      next if (configuration[:allow_nil] and raw_value.nil?)
+
+      unless ABN.valid?(raw_value)
+        instance.errors.add(attr_name, configuration[:message])
+      end
+    end
+  end
+end
+
+if defined?(ActiveRecord)
+  ABNValidations.enable
+end

data/spec/abn_spec.rb

@@ -1,8 +1,52 @@
 $LOAD_PATH << File.dirname(__FILE__) + "/../lib"
 
+require 'active_support'
+require 'active_record'
 require 'spec'
 require 'abn'
 
+# set up some AR test frameworks
+# We gotta shove this somewhere...
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+# And finally...
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :businesses do |t|
+    t.string :abn
+  end
+end
+
+class Business < ActiveRecord::Base
+  validates_abn_correctness_of :abn
+end
+
+describe "The ABN validation plugin" do
+  it "should just plain work." do
+    b = Business.new
+
+    b.abn = "12 042 168 743"
+    b.should be_valid
+
+    b.abn = "12042168743"
+    b.should be_valid
+
+    b.abn = 12042168743
+    b.should be_valid
+
+
+
+    b.abn = "12 042 168 744"
+    b.should_not be_valid
+
+    b.abn = "12042168744"
+    b.should_not be_valid
+
+    b.abn = 12042168744
+    b.should_not be_valid
+  end
+end
+
+
 def bad_parameter; (1..11).to_a; end
 
 describe "The ABN class" do
@@ -10,26 +54,26 @@ describe "The ABN class" do
     ABN.valid?("12042168743").should be_true
     ABN.valid?(12042168743).should   be_true
   end
-  
-  it "should identify a preformatted valid ABN" do 
+
+  it "should identify a preformatted valid ABN" do
     ABN.valid?("12 042 168 743").should be_true
   end
-  
+
   it "should have a problem with a pre-formatted invalid ABN" do
     ABN.valid?("12 042 168 744").should be_false
   end
-  
+
   it "should have a problem with an invalid ABN" do
     ABN.valid?("12042168744").should be_false
     ABN.valid?("902865").should      be_false
   end
-  
+
   it "should have a problem with invalid parameters" do
     ABN.valid?(nil).should       be_false
     ABN.valid?(Array).should     be_false
     ABN.valid?(Array.new).should be_false
   end
-  
+
   it "should have a problem with invalid parameter type that has a #length of 11" do
     bad_parameter.length.should eql(11)
     ABN.valid?(bad_parameter).should be_false
@@ -38,22 +82,22 @@ describe "The ABN class" do
   it "should be able to format a valid ABN" do
     ABN.new("12042168743").to_s.should eql("12 042 168 743")
   end
-  
+
   it "should be able to return a pre-formatted ABN" do
     ABN.new("12 042 168 743").to_s.should eql("12 042 168 743")
   end
-  
+
   it "should not format invalid parameter" do
     ABN.new(nil).to_s.should       eql("")
     ABN.new(Array).to_s.should     eql("")
     ABN.new(Array.new).to_s.should eql("")
   end
-  
+
   it "should not format an invalid parameter type that has a #length of 11" do
     bad_parameter.length.should eql(11)
     ABN.new(bad_parameter).to_s.should eql("")
   end
-  
+
   it "should not format an invalid ABN" do
     ABN.new("12042168744").to_s.should eql("")
     ABN.new("902865").to_s.should eql("")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: abn
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - James Healy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-12 00:00:00 +10:00
+date: 2009-04-16 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -48,8 +48,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: abn
-rubygems_version: 1.2.0
+rubyforge_project: yob-projects
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: a (very) small library for working with Australian Business Numbers.