kuwaiti_civil_id 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a21ea678cf307710bed0713ca346724682c76cf76c3f263cb6c1c34f19c9c607
+  data.tar.gz: a41945e7cd13c5439c8fa85961373946e377febe33abd8be3e2058a7401df435
+SHA512:
+  metadata.gz: 59ddf0c651fb4276928f8c1bb7b91ed11c844897fa27ab513177ab9df3b86c698c9ec5cd22af6d5285c2b215dad131bfce78b9a57ff9e2214707ddbfec37fdb4
+  data.tar.gz: d15297a93038d4f499bab7b9d0c1dce309fcd58159669eaceba5a87514fafe5f7054a790410e5d5eaeb50ab0590aa93344384531c909fd7f3d21df0928349717

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2026-06-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"kuwaiti_civil_id" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["info@kaffeinated.dev"](mailto:"info@kaffeinated.dev").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Abdullah Esmail
+
+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,49 @@
+# KuwaitiCivilId
+
+This gem provides a simple interface to validate and extract information from Kuwaiti Civil ID numbers. It checks the validity of the ID number and extracts the birth date.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+```ruby
+require 'kuwaiti_civil_id'
+KuwaitiCivilId::CivilIdValidator.valid?('123456789012')
+#=> false
+
+# assuming '295020101234' is a valid Kuwaiti Civil ID number
+KuwaitiCivilId::BirthdateExtractor.extract('295020101234')
+#=> #<Date: 1995-02-01>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaffeinated-dev/kuwaiti-civil-id-ruby. 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/kaffeinated-dev/kuwaiti-civil-id-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 KuwaitiCivilId project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kaffeinated-dev/kuwaiti-civil-id-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/kuwaiti_civil_id/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KuwaitiCivilId
+  VERSION = "1.0.0"
+end

data/lib/kuwaiti_civil_id.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "kuwaiti_civil_id/version"
+
+module KuwaitiCivilId
+  class Error < StandardError; end
+  class InvalidCivilIdError < Error; end
+
+  class CivilIdValidator
+    def self.valid?(id_number)
+      return false unless id_number.to_s.match?(/\A\d{12}$\z/)
+
+      digits = id_number.to_s.chars.map(&:to_i)
+      checksum = digits.pop
+      coefficients = [2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2]
+      digits.zip(coefficients).sum { |d, c| d * c }
+      calculated_checksum = 11 - (sun % 11)
+      calculated_checksum == checksum
+    end
+  end
+
+  class BirthdateExtractor
+    def self.extract(id_number)
+      raise InvalidCivilIdError unless CivilIdValidator.valid?(id_number)
+
+      century = id_number[0].to_i
+      year = id_number[1..2].to_i
+      month = id_number[3..4].to_i
+      day = id_number[5..6].to_i
+
+      century_prefix = case century
+                       when 2 then "19"
+                       when 3 then "20"
+                       else return nil
+                       end
+
+      year = "#{century_prefix}#{year}".to_i
+      Date.new(year, month, day)
+    end
+  end
+end

data/sig/kuwaiti_civil_id.rbs

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

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: kuwaiti_civil_id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Abdullah Esmail
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Provides functionality to validate the format of Kuwaiti Civil ID numbers
+  and extract information such as birth date.
+email:
+- info@kaffeinated.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/kuwaiti_civil_id.rb
+- lib/kuwaiti_civil_id/version.rb
+- sig/kuwaiti_civil_id.rbs
+homepage: https://github.com/kaffeinated-dev/kuwaiti-civil-id-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaffeinated-dev/kuwaiti-civil-id-ruby
+  source_code_uri: https://github.com/kaffeinated-dev/kuwaiti-civil-id-ruby
+  changelog_uri: https://github.com/kaffeinated-dev/kuwaiti-civil-id-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.13
+specification_version: 4
+summary: A Ruby gem for validating and parsing Kuwaiti Civil ID numbers.
+test_files: []