yob-abn 1.1.0 → 1.2.0

data/README.rdoc

@@ -1,7 +1,13 @@
 A small class for validating Australian Business Numbers (ABN)
 
+= Installation
+
+  gem install abn
+
 = Usage
 
+  require 'abn'
+
   ABN.new("12042168743").valid?
   => true
 
@@ -11,6 +17,6 @@ A small class for validating Australian Business Numbers (ABN)
   ABN.valid_abn?("12042168744")
   => false
 
-= Further Reader
+= Further Reading
 
 - http://www.clearwater.com.au/?action=code

data/lib/abn.rb

@@ -1,39 +1,45 @@
 class ABN
 
-  class Version #:nodoc:
+  module Version #:nodoc:
     Major = 1
-    Minor = 1
+    Minor = 2
     Tiny  = 0
     
     String = [Major, Minor, Tiny].join('.')
   end
 
+  # Creates an ABN object representing the ABN number passed
+  # as the only parameter.
   def initialize(num)
-    @number = num.to_s
+    @number = num.to_s.tr ' ',''
   end
 
+  # Returns whether the current ABN class represents a
+  # valid ABN number according to a weighting
+  # algorithm (not checked against a datbase)
   def valid?
-    ABN.valid? @number
-  end
-
-  def to_s
-    "#{@number[0,2]} #{@number[2,3]} #{@number[5,3]} #{@number[8,3]}"
-  end
-
-  def self.valid?(abn)
-    abn = abn.to_s
-    return false unless abn.length == 11
+    return false unless @number.length == 11
 
     weights = [10, 1, 3, 5, 7, 9, 11, 13, 15, 17, 19]
     sum = 0
-    (0..10).each do |idx|
-      c = abn[idx,1]
-      idx == 0 ? sub = 1 : sub = 0
-      digit = c.to_i - sub
-      sum += weights[idx] * digit
+    (0..10).each do |i|
+      c = @number[i,1]
+      digit = c.to_i - (i.zero? ? 1 : 0)
+      sum += weights[i] * digit
     end
     
     sum % 89 == 0 ? true : false
   end
-  
+
+  # Correctly formats the represented ABN if valid, else returns
+  # an empty string
+  def to_s
+    valid? ? "%s%s %s%s%s %s%s%s %s%s%s" % @number.split('') : ""
+  end
+
+  # Accepts an ABN number as a String or Bignum and returns
+  # whether or not it is valid (not checked against a database)
+  def self.valid?(abn)
+    new(abn).valid?
+  end
 end

data/spec/abn_spec.rb

@@ -3,21 +3,63 @@ $LOAD_PATH << File.dirname(__FILE__) + "/../lib"
 require 'spec'
 require 'abn'
 
+def bad_parameter; (1..11).to_a; end
+
 describe "The ABN class" do
   it "should identify a valid ABN" do
     ABN.valid?("12042168743").should be_true
     ABN.valid?(12042168743).should   be_true
   end
   
-  it "should identify an invalid 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?("902865").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
+  end
 
-  it "should be able to pretty print a valid ABN" 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("")
+  end
 
+  it "should not format an pre-formatted invalid ABN" do
+    ABN.new("12 042 168 744").to_s.should eql("")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yob-abn
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - James Healy
@@ -48,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: yob-projects
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2