abn 1.3.0 → 2.0.0

data/CHANGELOG

@@ -0,0 +1,18 @@
+v2.0.0
+- remove ActiveRecord validation macro, it gets messy to maintain
+  support for AR 2.x and 3.x so I opted to keep things simple and
+  remove it
+- modernise package - clean out the Rakefile, use bundler for load
+  path management, etc.
+
+v1.3
+- [Dan Cheail] Added an ActiveRecord validation macro, validates_abn_correctness_of
+
+v1.2
+- Merged some cleanup and safety patches by Bodaniel Jeanes
+
+v1.1
+- Small tweak to add compatability with MRI < 1.8.7
+
+v1.0
+- Initial Release

data/README.rdoc

@@ -1,4 +1,4 @@
-A small class for validating Australian Business Numbers (ABN)
+A small library for validating Australian Business Numbers (ABN)
 
 = Installation
 
@@ -17,6 +17,29 @@ A small class for validating Australian Business Numbers (ABN)
   ABN.valid?("12042168744")
   => false
 
+== With ActiveRecord
+
+Version 1.3 of this gem had an active record mixin for validating ABN fields in
+models. I removed it in version 2.0 to avoid complications of supporting active
+record 2.x and 3.x.
+
+To validate an ABN field in your model add the ABN gem to your Gemfile and
+use the following pattern:
+
+  class Business < ActiveRecord::Base
+
+    validate :validate_abn
+
+    private
+
+    def validate_abn
+      if self.abn.present && !ABN.valid?(self.abn)
+        self.errors.add(:abn, "is not a valid ABN")
+        false
+      end
+    end
+  end
+
 = Further Reading
 
 - http://www.clearwater.com.au/?action=code

data/lib/abn.rb

@@ -1,8 +1,8 @@
 class ABN
 
   module Version #:nodoc:
-    Major = 1
-    Minor = 3
+    Major = 2
+    Minor = 0
     Tiny  = 0
 
     String = [Major, Minor, Tiny].join('.')
@@ -43,41 +43,3 @@ 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,55 +1,10 @@
-$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+require "rubygems"
+require "bundler"
+Bundler.setup
 
-require 'active_support'
-require 'active_record'
-require 'spec'
-require 'abn'
+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
+describe ABN, "valid? class method" do
   it "should identify a valid ABN" do
     ABN.valid?("12042168743").should be_true
     ABN.valid?(12042168743).should   be_true
@@ -75,10 +30,13 @@ describe "The ABN class" do
   end
 
   it "should have a problem with invalid parameter type that has a #length of 11" do
+    bad_parameter = (1..11).to_a
     bad_parameter.length.should eql(11)
     ABN.valid?(bad_parameter).should be_false
   end
+end
 
+describe ABN, "to_s instance method" do
   it "should be able to format a valid ABN" do
     ABN.new("12042168743").to_s.should eql("12 042 168 743")
   end
@@ -94,6 +52,7 @@ describe "The ABN class" do
   end
 
   it "should not format an invalid parameter type that has a #length of 11" do
+    bad_parameter = (1..11).to_a
     bad_parameter.length.should eql(11)
     ABN.new(bad_parameter).to_s.should eql("")
   end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: abn
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  hash: 15
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - James Healy
@@ -9,12 +15,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-16 00:00:00 +10:00
+date: 2010-12-04 00:00:00 +11:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: roodi
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id004
 description: a (very) small library for working with Australian Business Numbers.
-email: jimmy@deefa.com
+email: 
+- jimmy@deefa.com
 executables: []
 
 extensions: []
@@ -23,10 +86,14 @@ extra_rdoc_files: []
 
 files: 
 - lib/abn.rb
+- CHANGELOG
 - MIT-LICENSE
 - README.rdoc
+- spec/abn_spec.rb
 has_rdoc: true
-homepage: http://github.com/yob/abn/tree/master
+homepage: http://github.com/yob/abn
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -35,23 +102,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: yob-projects
-rubygems_version: 1.3.1
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: a (very) small library for working with Australian Business Numbers.
 test_files: 
 - spec/abn_spec.rb