za_id_number 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f5a9409a4cbf5d9fecfd49c0f75a5edc20927d27
-  data.tar.gz: 8d8a5ccd8bdd39e1badb5d9a20ae75e222d20cdd
+SHA256:
+  metadata.gz: 1091207c4bf7fe86f9dd8eff09d907439d0c77d13596ce394145b958c487ca65
+  data.tar.gz: '08fbe6e7a50f19a8a3d395b66f2e49e1883728387d47c52cf8ff8da4fdaba4fc'
 SHA512:
-  metadata.gz: 35008d2b1410cf41fb9b8d870c67f71b3088be38013d03f7f14ec269459f1de56c9920051bc941c69b01e507f8a122568fe619ec82175db530400b6831f51f26
-  data.tar.gz: 6cbca82db59d804a7edf81a1e1f3aec60e2a0ee94e053e0e0f38cb6937e7055fa047f99d6915df5347834643d27ff83a95cf7abffa92533af92eb6043b409ac9
+  metadata.gz: 650958c1b3305ad083b7b9ff0da547be34c292777c93635799e7bbdc04751fd74cd719761707832e4ea6d0d1d133dd5f2b887da9d21c5f201e8d6afc6b232d4c
+  data.tar.gz: d226d05b02865243ae604849da00669224b75984cd623947e54c97482fe0318157a490d0b65754e92dd49abdfbc69dee28239bfe01e0134526e262f903dfe672

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.6

data/CHANGES

@@ -0,0 +1,19 @@
+# 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.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

@@ -52,11 +52,11 @@ id_number = ZAIDNumber.new('7501151234085') # => #<ZAIDNumber:0x00d40 @id_number
 ### Validation checks
 
 ```ruby
-id_num.has_valid_length?      # => true
-id_num.has_only_digits?       # => true
-id_num.has_valid_date?        # => true
-id_num.has_valid_citizenship? # => true
-id_num.has_valid_checksum?    # => true
+id_num.valid_length?      # => true
+id_num.only_digits?       # => true
+id_num.valid_date?        # => true
+id_num.valid_citizenship? # => true
+id_num.valid_checksum?    # => true
 ```
 
 Or, roll up all those validation checks into one call:

data/lib/za_id_number/version.rb

@@ -1,5 +1,5 @@
 class ZAIDNumber
   class Version
-    VERSION = '1.0.0'
+    VERSION = '2.1.0'
   end
 end

data/lib/za_id_number.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'za_id_number/version'
 require 'luhn'
+require 'date'
 
 class ZAIDNumber
   REQUIRED_ID_LENGTH = 13
@@ -10,36 +13,37 @@ class ZAIDNumber
   PERMANENT_RESIDENT = 1
 
   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?
-    has_valid_length?      &&
-    has_only_digits?       &&
-    has_valid_date?        &&
-    has_valid_citizenship? &&
-    has_valid_checksum?
+    valid_length?      &&
+    only_digits?       &&
+    valid_date?        &&
+    valid_citizenship? &&
+    valid_checksum?
   end
 
-  def has_valid_checksum?
+  def valid_checksum?
     Luhn.valid? @id_number
   end
 
-  def has_valid_length?
+  def valid_length?
     @id_number.length == REQUIRED_ID_LENGTH
   end
 
-  def has_only_digits?
+  def only_digits?
     @id_number.to_s.gsub(/\D*/, '') == @id_number.to_s
   end
 
-  def has_valid_date?
+  def valid_date?
     date_of_birth ? true : false
   end
 
-  def has_valid_citizenship?
+  def valid_citizenship?
     CITIZENSHIP_RANGE.include? @id_number[10].to_i
   end
 
@@ -72,4 +76,15 @@ class ZAIDNumber
   def permanent_resident?
     !za_citizen?
   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
 end

data/za_id_number.gemspec

@@ -32,9 +32,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'bundler',       '~> 1.13'
-  spec.add_development_dependency 'rake',          '~> 10.0'
+  spec.add_development_dependency 'rake',          '~> 13.0.3'
   spec.add_development_dependency 'rspec',         '~> 3.0'
-  spec.add_development_dependency 'pry',           '~> 0.11.3'
+  spec.add_development_dependency 'pry',           '~> 0.14.0'
   spec.add_development_dependency 'awesome_print', '~> 1.8'
 
   spec.add_dependency 'luhn', '~> 1.0', '>= 1.0.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: za_id_number
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Gabriel Fortuna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-01 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
+- CHANGES
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -141,8 +143,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.1.6
 signing_key: 
 specification_version: 4
 summary: A small library for parsing South African ID numbers