za_id_number 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1091207c4bf7fe86f9dd8eff09d907439d0c77d13596ce394145b958c487ca65
-  data.tar.gz: '08fbe6e7a50f19a8a3d395b66f2e49e1883728387d47c52cf8ff8da4fdaba4fc'
+  metadata.gz: dd9d77d348b60523b50eb007e2f7d615b41e01291c8152427fc9aed33bbb9f97
+  data.tar.gz: 8f1edc87848ff3788b4039ca2f3492e133fac871a9237ced4bd99d6654638a2e
 SHA512:
-  metadata.gz: 650958c1b3305ad083b7b9ff0da547be34c292777c93635799e7bbdc04751fd74cd719761707832e4ea6d0d1d133dd5f2b887da9d21c5f201e8d6afc6b232d4c
-  data.tar.gz: d226d05b02865243ae604849da00669224b75984cd623947e54c97482fe0318157a490d0b65754e92dd49abdfbc69dee28239bfe01e0134526e262f903dfe672
+  metadata.gz: eada6d8d9ef2b92ab1237946123821d49ddabe6ce0131133f7253b1c355c791e8d822b5e495be8266a903d0a00c77b7a8164ccacf8da46b47643283827aa6be2
+  data.tar.gz: eb5a7a4b1cfdcd9e97ce0637df59c7799d927b20c96b5033b95663f8a4c775d04aad1228346e977cb6c5940e1f65dac6ae90fa0c8cefa201d218a3c4bd6858ea

data/CHANGES

@@ -9,6 +9,12 @@ and this project tries really hard to adhere to [Semantic Versioning](https://se
 
 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

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.1.0'
+    VERSION = '2.2.0'
   end
 end

data/lib/za_id_number.rb

@@ -8,9 +8,10 @@ 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
@@ -44,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
@@ -66,17 +67,25 @@ 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)
 
@@ -87,4 +96,10 @@ class ZAIDNumber
   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.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Gabriel Fortuna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler