sa_vat_validation 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42162cd0d649690602314d4c7936eacbacc0adfa1d0332fbc47f10bf848d40ee
+  data.tar.gz: 2f27791b1489bd91c45f1b578976b80b824b7e77ab8d7b1b6f64961a682ca4c5
+SHA512:
+  metadata.gz: 9088b0d2f574a246ccddc2c996ad2d147f1cbede353ee7b60e6ca94ce664409e578e01d0140080efb56d3913890fb4d0b0365fb7509d60a97a3a3fc8c990bb17
+  data.tar.gz: 34c02e321c98e548791f7aa87479be4ae42d91b9b38465bf64dbd48161cc4beede0b93b7141c73e4dc11f4ac1d22d4c015cfe0cae65aa68b482f36f162ef6de4

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.autotest
+pkg/*
+test/*
+bin/*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sa_vat_validation.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    sa_vat_validation (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.2.5)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  pry (~> 0.14.1)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  sa_vat_validation!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Shane Reddy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# SaVatValidation
+
+Validation of South African VAT numbers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sa_vat_validation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sa_vat_validation
+
+## Usage
+
+Validating a South African VAT number is easy:
+```ruby
+4023340283.valid_sa_vat_number?
+=> false
+```
+
+Works on strings too:
+```ruby
+'4023340283'.valid_sa_vat_number?
+=> false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mpowered/sa_vat_validation
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -1,12 +1,6 @@
-require 'rubygems'
-require 'rake'
-require 'echoe'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-Echoe.new('sa_vat_validation', '0.1.0') do |p|
-  p.description    = "Validate South African VAT numbers easily"
-  p.url            = "http://github.com/mpowered/sa_vat_validation"
-  p.author         = "Gary Greyling"
-  p.email          = "greyling.gary@gmail.co.za"
-  p.ignore_pattern = ["tmp/*", "script/*"]
-  p.development_dependencies = [['activesupport']]
-end
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sa_vat_validation/version.rb

@@ -0,0 +1,3 @@
+module SaVatValidation
+  VERSION = "0.2.0".freeze
+end

data/lib/sa_vat_validation.rb

@@ -1,42 +1,55 @@
-class Fixnum
-  def last_digit
-    self.to_s.last.to_i
-  end
+require "sa_vat_validation/version"
 
-  def first_digit
-    self.to_s.first.to_i 
-  end
-end
 
-class SaVatValidation
+module SaVatValidation
   def self.valid?(vat_number)
     digits = vat_number.to_s.split(//).map(&:to_i)
+
+    # As per SARS
+    # A VAT Number is a unique number, which comprises of 10 digits and starts with the number 4
+    return false unless digits.first == 4
+    return false unless digits.size  == 10 && vat_number.to_s.is_numeric?
+
     check_digit = digits.pop
+    sum         = 0
 
-    sum = 0
     digits.each_with_index do |digit, i|
       if i.even?
         result = digit * 2
-        if result >= 10
-          result = result.first_digit + result.last_digit
-        end
+        result = first_digit(result) + last_digit(result) if result >= 10
+
         sum += result
       else
-        sum += digit.to_i
+        sum += digit
       end
     end
-    if sum.last_digit.zero?
-      calculated_digit = sum.last_digit
-    else
-      calculated_digit = 10 - sum.last_digit
-    end
 
-    return check_digit == calculated_digit
+    calculated_digit = last_digit(sum).zero? ? last_digit(sum) : 10 - last_digit(sum)
+
+    check_digit == calculated_digit
+  end
+
+  def self.last_digit(a)
+    a.to_s.chars.last.to_i
+  end
+
+  def self.first_digit(a)
+    a.to_s.chars.first.to_i
+  end
+end
+
+class String
+  def valid_sa_vat_number?
+    SaVatValidation::valid?(self)
+  end
+
+  def is_numeric?
+    Float self rescue false
   end
 end
 
-class Object
+class Numeric
   def valid_sa_vat_number?
     SaVatValidation::valid?(self)
   end
-end
+end

data/sa_vat_validation.gemspec

@@ -1,35 +1,27 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
 
-Gem::Specification.new do |s|
-  s.name = %q{sa_vat_validation}
-  s.version = "0.1.0"
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sa_vat_validation/version'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Gary Greyling"]
-  s.cert_chain = ["/Users/gary/.gem_certs/gem-public_cert.pem"]
-  s.date = %q{2010-09-29}
-  s.description = %q{Validate South African VAT numbers easily}
-  s.email = %q{greyling.gary@gmail.co.za}
-  s.extra_rdoc_files = ["README.rdoc", "lib/sa_vat_validation.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/sa_vat_validation.rb", "sa_vat_validation.gemspec"]
-  s.homepage = %q{http://github.com/mpowered/sa_vat_validation}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sa_vat_validation", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{sa_vat_validation}
-  s.rubygems_version = %q{1.3.7}
-  s.signing_key = %q{/Users/gary/.gem_certs/gem-private_key.pem}
-  s.summary = %q{Validate South African VAT numbers easily}
+Gem::Specification.new do |spec|
+  spec.name          = "sa_vat_validation"
+  spec.version       = SaVatValidation::VERSION
+  spec.authors       = ["Gary Greyling"]
+  spec.email         = ["greyling.gary@gmail.com"]
+  spec.description   = "SA VAT number validation"
+  spec.summary       = "SA VAT number validation"
+  spec.homepage      = ""
+  spec.license       = "MIT"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<activesupport>, [">= 0"])
-    else
-      s.add_dependency(%q<activesupport>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, [">= 0"])
-  end
+  # spec.add_development_dependency "activesupport", "~> 4.2"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry",     "~> 0.14.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
 end

data/spec/sa_vat_validation_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe SaVatValidation do
+  it 'has a version number' do
+    expect(SaVatValidation::VERSION).not_to be nil
+  end
+
+  context 'validates a South African VAT number' do
+    it "should validate '4111111110' as true" do
+      expect(described_class).to be_valid(4111111110)
+    end
+
+    it "should validate '0000000000' as false" do
+      expect(described_class).not_to be_valid(0000000000)
+    end
+
+    it "should validate a non number 'kjabndfojb' as false" do
+      expect(described_class).not_to be_valid("kjabndfojb")
+    end
+  end
+
+  context "monkey patching" do
+    describe "String" do
+      context "when valid" do
+        subject { "4111111110" }
+
+        it { is_expected.to be_valid_sa_vat_number }
+      end
+
+      context "when invalid" do
+        subject { "0000000000" }
+
+        it { is_expected.not_to be_valid_sa_vat_number }
+      end
+    end
+
+    describe "Numeric" do
+      context "when valid" do
+        subject { 4111111110 }
+
+        it { is_expected.to be_valid_sa_vat_number }
+      end
+
+      context "when invalid" do
+        subject { 0000000000 }
+
+        it { is_expected.not_to be_valid_sa_vat_number }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'sa_vat_validation'
+require 'pry'

metadata

@@ -1,112 +1,114 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sa_vat_validation
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Gary Greyling
-autorequire: 
+autorequire:
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDVjCCAj6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBRMQ0wCwYDVQQDDARnYXJ5
-  MRgwFgYKCZImiZPyLGQBGRYIbXBvd2VyZWQxEjAQBgoJkiaJk/IsZAEZFgJjbzES
-  MBAGCgmSJomT8ixkARkWAnphMB4XDTEwMDkyOTExMDczM1oXDTExMDkyOTExMDcz
-  M1owUTENMAsGA1UEAwwEZ2FyeTEYMBYGCgmSJomT8ixkARkWCG1wb3dlcmVkMRIw
-  EAYKCZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJ6YTCCASIwDQYJKoZI
-  hvcNAQEBBQADggEPADCCAQoCggEBAKgoGyjXVfeJ10SWFNjlJe0bdPhpZZS+Culh
-  dr53YjWUuvQ7WzM+wvkwrUAnARVL/pmX2nMn/RwXgen26RR41dk5DA2KRuA+U06n
-  hxbZkDPpmzUSHXTZfya7a4YlzfqHkIPfzESxzl/r4XrtX7/bfZl4/Yx6sJKZ2Oxj
-  p/4FG24oRk1sq02KahoogB+tRIbQZyyIctkRkxpuJ87Jr+eQ5M0d/XC1dbSKpHoC
-  7wvFeXKN2Calp1iFc/5ivbXb7oVxVLQANMShdlueLh4O2I0/j+/EsRHTZjNHart1
-  R9slB5rgRp/mieX+QKCBqJ8gNv13I8thWBRcxv1HIAObKOJiUUECAwEAAaM5MDcw
-  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAQ0h81rouVRKvMSoF2p
-  VQmtFGwIMA0GCSqGSIb3DQEBBQUAA4IBAQBha9zG+tkYxyGq5GQtLzIukmNG5W/q
-  q4kpQs8J6nK+6LbfP5iH7T65CT4Kb4+zTzleaOKSEp4exTsIvmaiH45makbSLRbn
-  b8WkSdt2P1fy5uT9MVkieCvFfUP24Fbo0DiqP2coJLQ8BCnFZzN+GhJDVG0APd9X
-  c9Nk9uAODl8IXJLPYYEJ0YmOj1Y31pO/PBqWWoZv0yesopFW7niMFv9ylwqRBjul
-  hHuH2lU449ckVEXvs9lseZY8hHEvx5Bz90s7fv+gO+/NhKvEY+MeWuLORpZmPSD9
-  JSzVUJL2pes8Sw+j0TmyW7A+CfMJJjNaGku4LvnRPgRRb6Gd973i6FUS
-  -----END CERTIFICATE-----
-
-date: 2010-09-29 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
+cert_chain: []
+date: 2022-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-  version_requirements: *id001
-description: Validate South African VAT numbers easily
-email: greyling.gary@gmail.co.za
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: SA VAT number validation
+email:
+- greyling.gary@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-- lib/sa_vat_validation.rb
-files: 
-- Manifest
-- README.rdoc
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
 - Rakefile
 - lib/sa_vat_validation.rb
+- lib/sa_vat_validation/version.rb
 - sa_vat_validation.gemspec
-has_rdoc: true
-homepage: http://github.com/mpowered/sa_vat_validation
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Sa_vat_validation
-- --main
-- README.rdoc
-require_paths: 
+- spec/sa_vat_validation_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 11
-      segments: 
-      - 1
-      - 2
-      version: "1.2"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: sa_vat_validation
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
-summary: Validate South African VAT numbers easily
-test_files: []
-
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: SA VAT number validation
+test_files:
+- spec/sa_vat_validation_spec.rb
+- spec/spec_helper.rb

data/Manifest

@@ -1,4 +0,0 @@
-Manifest
-README.rdoc
-Rakefile
-lib/sa_vat_validation.rb

data/README.rdoc

@@ -1,50 +0,0 @@
-= sa_vat_validation
-
-http://github.com/mpowered/sa_vat_validation
-
-== DESCRIPTION:
-
-Validation of South African VAT numbers
-
-
-== EXAMPLE:
-
-Validating a South African VAT number is easy:
-  >> 4023340283.valid_sa_vat_number?
-  => false
-Works on strings too:
-  >> '4023340283'.valid_sa_vat_number?
-  => false
-
-== REQUIREMENTS:
-
-* activesupport
-
-== INSTALL:
-
-gem install sa_vat_validation
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2010 FIX
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.