nz_bank_account_validator 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 41cda291273f19edfda0b18968d46ba1f65ef836
-  data.tar.gz: f542268d119d4b7eef21326a4232c70e030fe5c5
+SHA256:
+  metadata.gz: 93d01a32380a3a0205ac9fb23d6d641c3a0c1b87a991668461e360a1ededf858
+  data.tar.gz: 1acc8512108e428c6ffed4834f9604de152a5c4645fe3ff55e4eeb9023bd9854
 SHA512:
-  metadata.gz: b9ac2d9ace8242af0522242d24008396911e2d425cccbe681e0a7dd5fcee7640bf11a24d8596bfc97e761163391dd8abc0a185bcaabbe99c2c193b11a9e51e1f
-  data.tar.gz: d9d0ec628b5a8da404cd49b71f7dec529969cc73ea21eba2e38a54bd52709a80b06d385febc1806ab4f9677649d7b886de5f384e57c9befe88e275039404b3d3
+  metadata.gz: eb569c9d512b4c64037d1bb981ce2bbd613c2ba53531b627176c136f1eb86d00903f4c4cdca5fca83260213e746cd3e783ad08f2b0f6a4402256b602ad4c0621
+  data.tar.gz: 869edddce45641db25d7566b119a78bdeac3ff9fc284cb4ec606fbe8f21e4eb9dd8e874d9a0c3140023bdbd6b1512ea61b6bbdd5d288c9adfe40f0d471ed331c

data/.rubocop.yml

@@ -0,0 +1,134 @@
+require:
+- rubocop-rspec
+- rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+  - .git/
+  - bin/*
+  - config/deploy/*
+  - coverage/**/*
+  - db/migrate/*
+  - db/schema.rb
+  - doc/**/*
+  - Gemfile
+  - lib/tasks/*.rake
+  - log/**/*
+  - node_modules/**/*
+  - script/*
+  - spec/**/*
+  - test/**/*
+  - tmp/**/*
+  - vendor/assets/**/*
+  - vendor/gems/*/bin/*
+  - vendor/gems/*/spec/**/*
+
+Layout/AlignParameters:
+  EnforcedStyle: with_first_parameter
+
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Lint/UnusedBlockArgument:
+  AllowUnusedKeywordArguments: true
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Lint/LiteralAsCondition:
+  Enabled: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: keyword
+  AutoCorrect: true
+
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+  AutoCorrect: true
+
+Layout/DefEndAlignment:
+  EnforcedStyleAlignWith: def
+  AutoCorrect: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: false

data/CHANGELOG.txt

@@ -1,3 +1,5 @@
+1.1.0 - Tidy up code, add more bank accounts from updated document
+1.0.0 - First public release
 0.9.0 - Add new ranges from updated IRD document
         Use new RSpec syntax
         Accept a string of a full bank account number rather than a collection of parts

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,5 +1,7 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'nz_bank_account_validator'

data/lib/nz_bank_account_validator.rb

@@ -1,10 +1,24 @@
 # frozen_string_literal: true
-require 'nz_bank_account_validator/version'
+
+require "nz_bank_account_validator/version"
 
 class NzBankAccountValidator
-  BankDefinition = Struct.new(:ranges, :algo)
+  class BankDefinition
+    def initialize(ranges: [], algo: nil)
+      @ranges = ranges
+      @algo = algo
+    end
+
+    attr_reader :algo
+
+    def include?(branch)
+      @ranges.any? do |range|
+        range.include?(branch)
+      end
+    end
+  end
 
-  PATTERN = /\A^(?<bank_id>\d{1,2})[- ]?(?<bank_branch>\d{1,4})[- ]?(?<account_base_number>\d{1,8})[- ]?(?<account_suffix>\d{1,4})\z/
+  PATTERN = /\A^(?<bank_id>\d{1,2})[- ]?(?<bank_branch>\d{1,4})[- ]?(?<account_base_number>\d{1,8})[- ]?(?<account_suffix>\d{1,4})\z/.freeze
 
   RADIX = 10
 
@@ -13,36 +27,38 @@ class NzBankAccountValidator
   ACCOUNT_BASE_NUMBER_CUTOFF = 990_000
 
   BANKS = {
-    1  => BankDefinition.new([1..999, 1100..1199, 1800..1899]),
-    2  => BankDefinition.new([1..999, 1200..1299]),
-    3  => BankDefinition.new([1..999, 1300..1399, 1500..1599, 1700..1799, 1900..1999]),
-    6  => BankDefinition.new([1..999, 1400..1499]),
-    8  => BankDefinition.new([6500..6599], :d),
-    9  => BankDefinition.new([0..0], :e),
-    11 => BankDefinition.new([5000..6499, 6600..8999]),
-    12 => BankDefinition.new([3000..3299, 3400..3499, 3600..3699]),
-    13 => BankDefinition.new([4900..4999]),
-    14 => BankDefinition.new([4700..4799]),
-    15 => BankDefinition.new([3900..3999]),
-    16 => BankDefinition.new([4400..4499]),
-    17 => BankDefinition.new([3300..3399]),
-    18 => BankDefinition.new([3500..3599]),
-    19 => BankDefinition.new([4600..4649]),
-    20 => BankDefinition.new([4100..4199]),
-    21 => BankDefinition.new([4800..4899]),
-    22 => BankDefinition.new([4000..4049]),
-    23 => BankDefinition.new([3700..3799]),
-    24 => BankDefinition.new([4300..4349]),
-    25 => BankDefinition.new([2500..2599], :f),
-    26 => BankDefinition.new([2600..2699], :g),
-    27 => BankDefinition.new([3800..3849]),
-    28 => BankDefinition.new([2100..2149], :g),
-    29 => BankDefinition.new([2150..2299], :g),
-    30 => BankDefinition.new([2900..2949]),
-    31 => BankDefinition.new([2800..2849], :x),
-    33 => BankDefinition.new([6700..6799], :f),
-    35 => BankDefinition.new([2400..2499]),
-    38 => BankDefinition.new([9000..9499])
+    1  => BankDefinition.new(ranges: [1..999, 1100..1199, 1800..1899]),
+    2  => BankDefinition.new(ranges: [1..999, 1200..1299]),
+    3  => BankDefinition.new(ranges: [1..999, 1300..1399, 1500..1599, 1700..1799, 1900..1999, 7350..7399]),
+    4  => BankDefinition.new(ranges: [2020..2024]),
+    6  => BankDefinition.new(ranges: [1..999, 1400..1499]),
+    8  => BankDefinition.new(ranges: [6500..6599], algo: :d),
+    9  => BankDefinition.new(ranges: [0..0], algo: :e),
+    10 => BankDefinition.new(ranges: [5165..5169]),
+    11 => BankDefinition.new(ranges: [5000..6499, 6600..8999]),
+    12 => BankDefinition.new(ranges: [3000..3299, 3400..3499, 3600..3699]),
+    13 => BankDefinition.new(ranges: [4900..4999]),
+    14 => BankDefinition.new(ranges: [4700..4799]),
+    15 => BankDefinition.new(ranges: [3900..3999]),
+    16 => BankDefinition.new(ranges: [4400..4499]),
+    17 => BankDefinition.new(ranges: [3300..3399]),
+    18 => BankDefinition.new(ranges: [3500..3599]),
+    19 => BankDefinition.new(ranges: [4600..4649]),
+    20 => BankDefinition.new(ranges: [4100..4199]),
+    21 => BankDefinition.new(ranges: [4800..4899]),
+    22 => BankDefinition.new(ranges: [4000..4049]),
+    23 => BankDefinition.new(ranges: [3700..3799]),
+    24 => BankDefinition.new(ranges: [4300..4349]),
+    25 => BankDefinition.new(ranges: [2500..2599], algo: :f),
+    26 => BankDefinition.new(ranges: [2600..2699], algo: :g),
+    27 => BankDefinition.new(ranges: [3800..3849]),
+    28 => BankDefinition.new(ranges: [2100..2149], algo: :g),
+    29 => BankDefinition.new(ranges: [2150..2299], algo: :g),
+    30 => BankDefinition.new(ranges: [2900..2949]),
+    31 => BankDefinition.new(ranges: [2800..2849], algo: :x),
+    33 => BankDefinition.new(ranges: [6700..6799], algo: :f),
+    35 => BankDefinition.new(ranges: [2400..2499]),
+    38 => BankDefinition.new(ranges: [9000..9499]),
   }.freeze
 
   ALGOS = {
@@ -53,7 +69,7 @@ class NzBankAccountValidator
     e: [0, 0, 0, 0, 0, 0, 0, 0,  0, 0, 5, 4, 3, 2, 0, 0, 0, 1, 11],
     f: [0, 0, 0, 0, 0, 0, 0, 1,  7, 3, 1, 7, 3, 1, 0, 0, 0, 0, 10],
     g: [0, 0, 0, 0, 0, 0, 0, 1,  3, 7, 1, 3, 7, 1, 0, 3, 7, 1, 10],
-    x: [0, 0, 0, 0, 0, 0, 0, 0,  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]
+    x: [0, 0, 0, 0, 0, 0, 0, 0,  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1],
   }.freeze
 
   def self.valid?(string)
@@ -62,13 +78,12 @@ class NzBankAccountValidator
 
   def initialize(string)
     match = string.match(PATTERN)
+    return unless match
 
-    if match
-      @bank_id = Integer(match[:bank_id], RADIX)
-      @bank_branch = Integer(match[:bank_branch], RADIX)
-      @account_base_number = Integer(match[:account_base_number], RADIX)
-      @account_suffix = Integer(match[:account_suffix], RADIX)
-    end
+    @bank_id = Integer(match[:bank_id], RADIX)
+    @bank_branch = Integer(match[:bank_branch], RADIX)
+    @account_base_number = Integer(match[:account_base_number], RADIX)
+    @account_suffix = Integer(match[:account_suffix], RADIX)
   end
 
   attr_accessor :bank_id, :bank_branch, :account_base_number, :account_suffix
@@ -79,6 +94,7 @@ class NzBankAccountValidator
     return false unless account_base_number
     return false unless account_suffix
     return false unless valid_modulo?
+
     true
   end
 
@@ -88,35 +104,33 @@ class NzBankAccountValidator
     BANKS.key?(bank_id)
   end
 
-  def bank_definition
-    BANKS[bank_id]
-  end
-
   def valid_bank_branch?
     return false unless bank_definition
     return false unless bank_branch
 
-    bank_definition.ranges.any? do |range|
-      range.include?(bank_branch)
-    end
+    bank_definition.include?(bank_branch)
   end
 
   def valid_modulo?
     (checksum % algo[CHECKSUM_DIGITS]).zero?
   end
 
-  def algo_code
-    # If the account base number is below 00990000 then apply algorithm A
-    # Otherwise apply algorithm B.
-    bank_definition.algo || (account_base_number < ACCOUNT_BASE_NUMBER_CUTOFF ? :a : :b)
+  def bank_definition
+    BANKS[bank_id]
   end
 
   def algo
     ALGOS[algo_code]
   end
 
+  def algo_code
+    # If the account base number is below 00990000 then apply algorithm A
+    # Otherwise apply algorithm B.
+    bank_definition.algo || (account_base_number < ACCOUNT_BASE_NUMBER_CUTOFF ? :a : :b)
+  end
+
   def number_for_checksum
-    format('%02d%04d%08d%04d', bank_id, bank_branch, account_base_number, account_suffix)
+    format("%02d%04d%08d%04d", bank_id, bank_branch, account_base_number, account_suffix)
   end
 
   def checksum

data/lib/nz_bank_account_validator/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class NzBankAccountValidator
-  VERSION = '1.0.0'.freeze
+  VERSION = "1.1.0"
 end

data/validate_nz_bank_acc.gemspec

@@ -1,24 +1,28 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'nz_bank_account_validator/version'
+require "nz_bank_account_validator/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'nz_bank_account_validator'
+  spec.name          = "nz_bank_account_validator"
   spec.version       = NzBankAccountValidator::VERSION
-  spec.authors       = ['Steve Hoeksema', 'Eaden McKee']
-  spec.email         = ['steve@kotiri.com']
-  spec.summary       = 'Validate a New Zealand bank account number according to IRD specifications'
-  spec.description   = 'Validate a New Zealand bank account number according to IRD specifications'
-  spec.homepage      = 'https://github.com/steveh/nz_bank_account_validator'
-  spec.license       = 'MIT'
+  spec.authors       = ["Steve Hoeksema", "Eaden McKee"]
+  spec.email         = ["steve@kotiri.com"]
+  spec.summary       = "Validate a New Zealand bank account number according to IRD specifications"
+  spec.description   = "Validate a New Zealand bank account number according to IRD specifications"
+  spec.homepage      = "https://github.com/steveh/nz_bank_account_validator"
+  spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nz_bank_account_validator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Steve Hoeksema
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-30 00:00:00.000000000 Z
+date: 2019-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,7 +54,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -76,6 +118,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.txt
 - Gemfile
@@ -106,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Validate a New Zealand bank account number according to IRD specifications