kennitala 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d35f02ba753cae3e03263f8fb33fa11bd425855d49dbead29c5661edd2eef1ac
+  data.tar.gz: aded0d8ea8337bd0a4d7d639b24d36c166f0e2100111cf94f6680de18040f7a8
+SHA512:
+  metadata.gz: 74f549441ebda6b238140412b8eb4175e0bdb6a6ea6a4e2d3e1b142adfbe70c03c62cee9e0709082535d3beb72fd7e213fccc83f4bf6290dadcda48c7ce34dfb
+  data.tar.gz: fbadc0f4bcce4f941a23d699be2aaeac1b4afd720e6ad3ae87c151d9caa7183ff835066a8a589e0c4bfcedceb924d2a0f2023cd71f9e104822f813123da089cb

data/.editorconfig

@@ -0,0 +1,2 @@
+[*.rb]
+indent_size = 2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - 'spec/*'
+Metrics/ClassLength:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 20

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at aldavigdis@aldavigdis.is. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kennitala.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    kennitala (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  kennitala!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Alda Vigdís Skarphéðinsdóttir
+
+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,123 @@
+# Kennitala
+
+Process Icelandic kenntiala identification numbers.
+
+The Gem provides a class to handle "kennitala" identifier codes and monkey patched the String class to that strings can be cast to Kennitala objects. The class can be used to sanitize the identifiers and read information like the date of birth (or date of registration in the case of companies and organization), age and the type of entity.
+
+The class does not access external APIs or databases such as the National Registry or the Company Registry, so names and status (sex/gender, death, bankruptcy, credit rating etc.) cannot be accessed using the class. However, it can be used to sanitize and validate such data before being sent to external APIs, as such services are provided by private companies, which often charge a specific amount for each query.
+
+## Uses of kennitala
+
+Unlike the US Social Security number and equivalents, the kennitala is only used for identification of persons and companies (as well as other registered organizations) — and is often used internally by educational institutions, companies and other organization as a primary identifier for persons (e.g. school, employee, customer and frequent flyer ID). It is not to be used for authentication (i.e. a password) and is not considered a secret per se. While a kennitala can be kept unencrypted in a database, publishing a kennitala or a list of them is generally not considered good practice and might cause liability.
+
+A kennitala is assigned to every newborn person and foreign national residing in Iceland as well as organizations and companies operating there. It is statically assigned and can not be changed.
+
+Article II, paragraph 10 of the 77/2000 Act on Data Protection (http://www.althingi.is/lagas/nuna/2000077.html) provides the legal framework regarding the use and processing of the kennitala in Iceland:
+
+> The use of a kennitala is allowed if it has a an objective cause and is necessary to ensure reliable identification of persons. The Data Protection Authority may ban or order the use of kennitala.
+
+## Technicalities
+
+The kennitala (`DDMMYY-RRCM`) is a 10-digit numeric string consisting on a date (date of birth for persons, date of registration for companies) in the form of `DDMMYY`, two random digits (`RR`) a check digit (`C`) and a century identifier (`M`). A hyphen or space is often added between the year and random values (Example: `010130-2989`).
+
+The number 40 is added to the registration day of companies and organizations. Hence, a kennitala for a company registered at January 1 1990 starts with `410190` as opposed to `010190` for a person born that day.
+
+The century identifier has 3 legal values. `8` for the 19th century, `9` for the 20th century and `0` for the 21st century.
+
+## Examples
+
+### Working with Kennitala objects
+
+```ruby
+# Initialize a Kennitala object.
+# The string provided may include spaces, hyphens and alphabetical characters,
+# which will then be erased from the resulting string.
+k = Kennitala.new(' 010130-2989')
+# => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+
+# Invalid strings are rejected with an argument error
+f = Kennitala.new('010130-2979')
+# => ArgumentError: Kennitala is invalid
+
+# If no kennitala string is specified, a random one will be generated
+r = Kennitala.new
+# => #<Kennitala:0x007fc589339f18 @value="2009155509">
+
+# Retrieve the kennitala as a string.
+# This is a sanitized string, without any non-numeric characters.
+# Pretty useful when storing it in a database.
+k.to_s
+# => "0101302989"
+
+# Pretty print the kennitala
+# Adds a space between the 6th and the 7th digits for readability
+k.pp
+# => "010130 2989"
+
+# You can also pass a string to .pp to use as a spacer
+k.pp('–')
+# => "010130-2989"
+
+# You can also pass a cat to the .pp method
+k.pp('🐈')
+# => "010130🐈2989"
+
+# Get the entity type (results in 'person' or 'company')
+k.entity_type
+# => "person"
+
+# It's also possible to use .company? and .person? to achieve the same thing
+k.company?
+# => false
+
+k.person?
+# => true
+
+# Cast the kennitala to a Date object
+k.to_date
+# => #<Date: 1930-01-01 ((2425978j,0s,0n),+0s,2299161j)>
+
+# Get the current age of the entity. Useful for age restrictions.
+k.age
+# => 86
+```
+
+### Casting strings
+
+```ruby
+# Casting a string to a Kennitala object
+'010130 2989'.to_kt
+# => #<Kennitala:0x007fc5893286a0 @value="0101302989">
+
+# Get the current age based on a String
+'0101302989'.to_kt.age
+# => 86
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle kennitala
+
+If bundler is not being used to manage dependencies:
+
+    $ gem install kennitala
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aldavigdis/kennitala-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/aldavigdis/kennitala-gem/blob/master/CODE_OF_CONDUCT.md).
+
+Don't be afraid of using Rubocop for correcting your code and to make it conform to the standards defined in `.rubocop.yml`. You will want to run `bundle exec rubocop -A` to see if your code has any errors and correct them on the fly.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kennitala project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aldavigdis/kennitala-gem/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/kennitala.rb

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+require 'date'
+require_relative 'kennitala_string'
+
+# The main Kennitala class
+class Kennitala
+  # The current version of the gem
+  VERSION = '0.1.1'
+
+  # Initialize a Kennitala object
+  #
+  # @note The string provided may include spaces, hyphens and alphabetical
+  #       characters, which will then be erased from the resulting string.
+  #
+  # @param [String, Boolean] kt_string Either Kennitala String or Boolean false.
+  # @param [Boolean] is_company Wether the randomly generated kennitala is
+  #                  for a company
+  # @return [Kennitala] description of returned object
+  #
+  # @example Initialize a Kennitala object based on an unsanitized String
+  #          Kennitala.new(' 010130-2989')
+  #          => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+  #
+  # @example Invalid strings are rejected with an argument error
+  #          Kennitala.new('010130-2979')
+  #          => ArgumentError: Kennitala is invalid
+  #
+  # @example If no kennitala string is specified, a random one will be generated
+  #          Kennitala.new
+  #          => #<Kennitala:0x007fc589339f18 @value="2009155509">
+  def initialize(kt_string = false, is_company = false)
+    kt_string = fake_kt_string(is_company) if kt_string == false
+    unless kt_string.instance_of?(String)
+      raise ArgumentError, 'Kennitala needs to be provided as a String or ' \
+                           'Boolean (false)'
+    end
+    sanitised_kt = sanitize(kt_string)
+    raise ArgumentError, 'Kennitala is invalid' if sanitised_kt.nil?
+
+    @value = sanitised_kt
+  end
+
+  # Get the type of entity - If it is a person or an organization
+  #
+  # @return [String] Either 'person' or 'company'
+  #
+  # @example Get the entity type (results in 'person' or 'company')
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+  #          k.entity_type
+  #          => "person"
+  def entity_type
+    date_integer = @value[0, 2].to_i
+    return 'person' if date_integer < 32
+    return 'company' if (date_integer > 40) && (date_integer < 72)
+  end
+
+  # Check if the entity is a company
+  #
+  # @return [Boolean]
+  def company?
+    date_integer = @value[0, 2].to_i
+    return true if (date_integer > 40) && (date_integer < 72)
+
+    false
+  end
+
+  # Check if the entity is a person
+  #
+  # @return [Boolean]
+  def person?
+    date_integer = @value[0, 2].to_i
+    return true if date_integer < 32
+
+    false
+  end
+
+  # Get the year of birth or registration
+  #
+  # @return [Fixnum]
+  def year
+    century = (10 + @value[9].to_i) * 100
+    year = @value[4, 2].to_i
+    return century + year if (1800..1900).cover?(century)
+    return 2000 + year if century == 1000
+  end
+
+  # Get the day of the month of birth or registration
+  #
+  # @return [Fixnum]
+  def day
+    date_integer = @value[0, 2].to_i
+    return @value[0, 2].to_i if date_integer < 32
+    return @value[0, 2].to_i - 40 if (date_integer > 40) && (date_integer < 71)
+  end
+
+  # Get a numeric representation of the month of birth or registration
+  #
+  # @return [Fixnum]
+  def month
+    @value[2, 2].to_i
+  end
+
+  # Get the age of entity in years. Useful when dealing with age restrictions.
+  #
+  # @return [Fixnum]
+  #
+  # @example Get the current age of the entity
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+  #          k.age
+  #          => 86
+  def age
+    year_diff = Date.today.year - to_date.year
+    month_diff = Date.today.month - to_date.month
+    day_diff = Date.today.month - to_date.month
+
+    return year_diff -= 1 if month_diff.negative? || (month_diff.zero? && day_diff.negative?)
+
+    year_diff
+  end
+
+  # Cast the kennitala to a Date object
+  #
+  # @return [Date]
+  #
+  # @example Cast the kennitala to a Date object
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+  #          k.to_date
+  #          => #<Date: 1930-01-01 ((2425978j,0s,0n),+0s,2299161j)>
+  def to_date
+    Date.new(year, month, day)
+  end
+
+  # Cast the kennitala to a String object
+  #
+  # @return [String]
+  def to_s
+    @value.to_s
+  end
+
+  # Pretty print a kennitala
+  #
+  # Adds a space between the 6th and the 7th digits for readability.
+  #
+  # @param [String] spacer A single space by default
+  # @return [String]
+  #
+  # @example Pretty print a Kennitala it its default form
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fc589339f18 @value="2009155509">
+  #          k.pp
+  #          => "010130 2989"
+  #
+  # @example Use a hyphen as a spacer instead of the default single space
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fc589339f18 @value="2009155509">
+  #          k.pp('-')
+  #          => "010130-2989"
+  def pp(spacer = ' ')
+    raise ArgumentError 'Spacer must be a string' unless spacer.instance_of?(String)
+
+    @value[0, 6] + spacer + @value[6, 9]
+  end
+
+  private
+
+  # Generate fake a birth number and check digit based on the first 6 digits
+  #
+  # @param [String] date_hash The first six digits is a kennitala
+  # @return [Hash, nil]
+  def fake_randoms(date_hash)
+    first_six = date_hash[:day] + date_hash[:month] + date_hash[:year]
+    loop do
+      birth_number = Random.rand(1..99).to_s.rjust(2, '0')
+      first_eight = "#{first_six}#{birth_number}"
+      check_digit = calculate_check_digit(first_eight)
+      return { check_digit: check_digit, birth_number: birth_number } if check_checksum(first_eight)
+    end
+  end
+
+  # Generate a fake year and century Hash
+  #
+  # @return [Hash]
+  def fake_year
+    century = [9, 9, 9, 8, 0, 0].sample
+    current_year = Date.today.strftime('%y').to_i
+    return { year: Random.rand(0..current_year), century: century } if century.zero?
+
+    { year: Random.rand(0..99), century: century }
+  end
+
+  # Generate a fake hash that includes randomly generated date elements
+  #
+  # @todo Take leap years into account and thus allow for 29 February
+  #
+  # @param [Boolean] is_company true if the day string is for a company
+  # @return [Hash]
+  def fake_date_hash(is_company = false)
+    year_hash = fake_year
+
+    month_days = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    month = Random.rand(1..12)
+
+    day = Random.rand(1..month_days[month - 1])
+    day = (day.to_i + 40).to_s.rjust(2, '0') if is_company == true
+
+    { century: year_hash[:century].to_s,
+      year: year_hash[:year].to_s.rjust(2, '0'),
+      month: month.to_s.rjust(2, '0'), day: day.to_s.rjust(2, '0') }
+  end
+
+  # Generate a fake, random kennitala string
+  #
+  # @param [Boolean] is_company If the kennitala is for a company, not a person
+  # @return [String] A 10-digit string representing a kennitala
+  def fake_kt_string(is_company = false)
+    date_hash = fake_date_hash(is_company)
+    randoms_hash = fake_randoms(date_hash)
+
+    first_six = date_hash[:day] + date_hash[:month] + date_hash[:year]
+    randoms = randoms_hash[:birth_number].to_s + randoms_hash[:check_digit].to_s
+
+    first_six + randoms + date_hash[:century]
+  end
+
+  # Get year from a kennitala string
+  #
+  # @param [String] kt_string Sanitized kennitala string
+  # @return [Fixnum] description of returned object
+  def get_year_from_string(kt_string)
+    century_code = kt_string[9, 1].to_i
+    case century_code
+    when 0
+      "20#{kt_string[4, 2]}".to_i
+    when 8..9
+      "1#{century_code}#{kt_string[4, 2]}".to_i
+    end
+  end
+
+  # Sanitize the kennitala
+  #
+  # @param [String] kt_string Unsanitised string representing a kennitala
+  # @return [String, nil] Sanitized kennitala, nil if invalid
+  def sanitize(kt_string)
+    sanitized_kt = kt_string.gsub(/[^0-9]/, '')
+    checks = check_checksum(sanitized_kt)
+
+    year = get_year_from_string(sanitized_kt)
+    day = sanitized_kt[0, 2].to_i
+    day -= 40 if day > 40
+    month = sanitized_kt[2, 2].to_i
+    date = Date.new(year, month, day)
+
+    return sanitized_kt if checks == true && date.instance_of?(Date)
+  rescue ArgumentError
+    nil
+  end
+
+  # Calculate the checksum
+  #
+  # @param [String] kt_string Sanitized kennitala
+  # @return [Fixnum] The checksum
+  def checksum(kt_string)
+    checksum = 0
+    multipliers = [3, 2, 7, 6, 5, 4, 3, 2]
+    multipliers.each_with_index do |multiplier, index|
+      checksum += multiplier * kt_string[index].to_i
+    end
+    checksum
+  end
+
+  # Calculate the check digit for a kennitala
+  #
+  # @param [String] kt_string Sanitized kennitala
+  # @return [Fixnum]
+  def calculate_check_digit(kt_string)
+    remainder = checksum(kt_string).modulo(11)
+
+    # A kennitala with a remainder of 10 is always considered to be invalid
+    return nil if remainder == 10
+
+    # The check digit should be 11 minus the remainder,
+    # unless the remainder is 0, then the theck digit becomes 0.
+    return 0 if remainder.zero?
+
+    11 - remainder
+  end
+
+  # Check validity of the check digit
+  #
+  # @param [String] kt_string Sanitized kennitala
+  # @return [Boolean, nil] true on success, false if the check digit is invalid
+  def check_checksum(kt_string)
+    expected_check_digit = calculate_check_digit(kt_string)
+    actual_check_digit = kt_string[8].to_i
+    return true if expected_check_digit == actual_check_digit
+
+    false
+  end
+end

data/lib/kennitala_string.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Monkey patch for the String class
+class String
+  # Converts a String to a Kennitala object
+  #
+  # @return [Kennitala]
+  def to_kt
+    Kennitala.new(self)
+  end
+
+  # Checks if the String is valid for initializing a Kennitala object
+  #
+  # This is useful if you want to deal with conditionals before catching errors.
+  #
+  # @return Boolean
+  def kt?
+    true if Kennitala.new(self)
+  rescue ArgumentError, TypeError
+    false
+  end
+
+  alias_method 'to_kennitala', 'to_kt'
+  alias_method 'kennitala?', 'kt?'
+end

data/sig/kennitala.rbs

@@ -0,0 +1,4 @@
+module Kennitala
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: kennitala
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alda Vigdís Skarphéðinsdóttir
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description:
+email:
+- aldavigdis@aldavigdis.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/kennitala.rb
+- lib/kennitala_string.rb
+- sig/kennitala.rbs
+homepage: https://github.com/aldavigdis/kennitala-gem/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aldavigdis/kennitala-gem/
+  source_code_uri: https://github.com/aldavigdis/kennitala-gem/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Process Icelandic kenntiala identification numbers.
+test_files: []