za_id_number 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ed3ce4b45b45da798697e7c5f48873752f53b6c12fc07ec985805d5acfe1190
-  data.tar.gz: 7e14ac75dc6ab6a710be4d3dc9a261a066515d1ac53522fe4a2b2d4c510eeed8
+  metadata.gz: dd9d77d348b60523b50eb007e2f7d615b41e01291c8152427fc9aed33bbb9f97
+  data.tar.gz: 8f1edc87848ff3788b4039ca2f3492e133fac871a9237ced4bd99d6654638a2e
 SHA512:
-  metadata.gz: 327d332579085ea13569812f310e577f280677726635e2df2493e545c4123aea8ba5b59408fc7ed0c40b97bcc9a6c3842a822c516fd352b5faaf0acb2bd8bf55
-  data.tar.gz: f7706ab08495208b569734ad6910ae90e4abbc82255fec79b32c202f865d88f6d7fd2a12c1e0843745bc86ea6e2db89bd4a69f6ace55038c34f2b7412645b7e1
+  metadata.gz: eada6d8d9ef2b92ab1237946123821d49ddabe6ce0131133f7253b1c355c791e8d822b5e495be8266a903d0a00c77b7a8164ccacf8da46b47643283827aa6be2
+  data.tar.gz: eb5a7a4b1cfdcd9e97ce0637df59c7799d927b20c96b5033b95663f8a4c775d04aad1228346e977cb6c5940e1f65dac6ae90fa0c8cefa201d218a3c4bd6858ea

data/.tool-versions

@@ -1 +1 @@
-ruby 2.5.7
+ruby 2.7.6

data/CHANGES

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project tries really hard to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Nothing
+
+## [2.2.0] - 2023-04-05
+
+### Added
+
+- Support for [ID numbers where the citizen is a refugee.](https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/South-Africa-TIN.pdf)
+
+## [2.1.0] - 2022-05-31
+
+### Added
+
+- `to_s` for easier string interpolation
+- Add equality operator `==` and `eql?` method
+- Add `hash` method
+- Make id number instances immutable

data/README.md

@@ -12,7 +12,7 @@ A South African ID number is a 13-digit number which is defined by the following
 
 -	The first 6 digits (`YYMMDD`) are based on your date of birth. **20 February 1992** is displayed as `920220`.
 -	The next 4 digits (`SSSS`) are used to define your gender. Females are assigned numbers in the range 0000-4999 and males from 5000-9999.
--	The next digit (`C`) shows if you're a ZA citizen status, with 0 denoting that you were born a ZA citizen and 1 denoting that you're a permanent resident.
+-	The next digit (`C`) shows if you're a ZA citizen status, with 0 denoting that you were born a ZA citizen, 1 denoting that you're a permanent resident and 2 denoting that you're a refugee.
 -	The last digit (`Z`) is a checksum digit – used to check that the number sequence is accurate using a set formula called the [Luhn algorithm](https://en.wikipedia.org/wiki/Luhn_algorithm).
 
 The graphic below details the different sections of an ID number, based on the fictitious sequence `9202204720082`
@@ -77,6 +77,7 @@ id_num.male?               # => false
 id_num.citizenship         # => :za_citizen
 id_num.za_citizen?         # => true
 id_num.permanent_resident? # => false
+id_num.refugee?            # => false
 ```
 
 Development

data/lib/za_id_number/version.rb

@@ -1,5 +1,5 @@
 class ZAIDNumber
   class Version
-    VERSION = '2.0.0'
+    VERSION = '2.2.0'
   end
 end

data/lib/za_id_number.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'za_id_number/version'
 require 'luhn'
 require 'date'
@@ -6,14 +8,16 @@ class ZAIDNumber
   REQUIRED_ID_LENGTH = 13
   FEMALE_RANGE       = (0..4999)
   MALE_RANGE         = (5000..9999)
-  CITIZENSHIP_RANGE  = (0..1)
+  CITIZENSHIP_RANGE  = (0..2)
   ZA_CITIZEN         = 0
   PERMANENT_RESIDENT = 1
+  REFUGEE            = 2
 
   attr_reader :id_number
+  alias to_s id_number
 
   def initialize(id_num)
-    @id_number = id_num.to_s
+    @id_number = id_num.to_s.freeze
   end
 
   def valid?
@@ -41,7 +45,7 @@ class ZAIDNumber
   end
 
   def valid_citizenship?
-    CITIZENSHIP_RANGE.include? @id_number[10].to_i
+    CITIZENSHIP_RANGE.include? citizenship_status
   end
 
   def date_of_birth
@@ -63,14 +67,39 @@ class ZAIDNumber
   end
 
   def citizenship
-    za_citizen? ? :za_citizen : :permanent_resident
+    case citizenship_status
+    when ZA_CITIZEN         then :za_citizen
+    when PERMANENT_RESIDENT then :permanent_resident
+    when REFUGEE            then :refugee
+    end
   end
 
   def za_citizen?
-    @id_number[10].to_i == ZA_CITIZEN
+    citizenship_status == ZA_CITIZEN
   end
 
   def permanent_resident?
     !za_citizen?
   end
+
+  def refugee?
+    citizenship_status == REFUGEE
+  end
+
+  def ==(other)
+    return false unless other.is_a?(ZAIDNumber)
+
+    return id_number == other.id_number
+  end
+  alias eql? ==
+
+  def hash
+    id_number.hash
+  end
+
+  private
+
+  def citizenship_status
+    @id_number[10].to_i
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: za_id_number
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Gabriel Fortuna
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,7 @@ files:
 - ".rspec"
 - ".tool-versions"
 - ".travis.yml"
+- CHANGES
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -127,7 +128,7 @@ homepage: http://www.zero-one.io
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A small library for parsing South African ID numbers
 test_files: []