datacheck-kit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8a90ccd789ae768ec83c93e6d061133bcf35792d6637a0654e2ca5465aa4835
+  data.tar.gz: 37eac4ab3994c91ae600d070cefa36b08928fc160603fac8d94c2d677ce5fdcb
+SHA512:
+  metadata.gz: 490776a1f4fce252c8e1036cbf61bac7eae69ad4e32f2535063a21d4d2e271380514a8786f74d465d99dd34880930e019f1a74fec39eb39ee0144a6a763e7637
+  data.tar.gz: '0792e1b61db14431d1317ca15eac3ff73928c90935113077b23db87991818a75e28c2286b1154c68a56506c1c46b1dea4f88e1d04d60e60da446c5b655de3b92'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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,76 @@
+# datacheck-kit
+
+A small, zero-dependency toolkit for validating and formatting the kinds of
+data that show up in almost every form or import script: email addresses,
+phone numbers, URLs, IBANs, credit card numbers, postal codes and slugs.
+
+It exists because most projects end up copy-pasting the same handful of
+regexes and checksum functions over and over. This gem collects the ones
+worth reusing into one place, with tests and no runtime dependencies.
+
+This is a Ruby port of [datacheck-kit](https://www.npmjs.com/package/datacheck-kit)
+(originally written for npm, also on [PyPI](https://pypi.org/project/datacheck-kit/)
+and [Packagist](https://packagist.org/packages/galvaonten-coder/datacheck-kit)) — same
+functionality, adapted to Ruby conventions (`?`-suffixed predicates, `nil`
+instead of other languages' null-likes).
+
+Homepage: https://luckymisters.uk
+
+## Install
+
+```bash
+gem install datacheck-kit
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'datacheck-kit'
+```
+
+## Usage
+
+```ruby
+require 'datacheck-kit'
+
+DataCheckKit::Email.valid?('user@example.com')             # true
+DataCheckKit::Email.normalize('  User@Example.COM ')       # 'user@example.com'
+
+DataCheckKit::Url.valid?('example.com')                    # false (no protocol)
+DataCheckKit::Url.normalize('example.com/path/')           # 'https://example.com/path/'
+
+DataCheckKit::Phone.valid?('+44 20 7123 4567')              # true
+DataCheckKit::Phone.format_e164('+44 20 7123 4567')         # '+442071234567'
+
+DataCheckKit::Iban.valid?('NL91ABNA0417164300')             # true
+DataCheckKit::Iban.format('NL91ABNA0417164300')             # 'NL91 ABNA 0417 1643 00'
+
+DataCheckKit::CreditCard.valid?('4111 1111 1111 1111')      # true (Luhn check)
+DataCheckKit::CreditCard.mask('4111111111111111')           # '**** **** **** 1111'
+
+DataCheckKit::PostalCode.valid?('1011 AB', 'NL')             # true
+DataCheckKit::PostalCode.supported_countries                 # ['AT', 'CH', 'DE', ...]
+
+DataCheckKit::Slug.make('Café Müller & Söhne')               # 'cafe-muller-sohne'
+```
+
+## API
+
+- `DataCheckKit::Email.valid?`, `.normalize`
+- `DataCheckKit::Url.valid?`, `.normalize`
+- `DataCheckKit::Phone.valid?`, `.format_e164` — E.164-style numbers
+- `DataCheckKit::Iban.valid?`, `.format` — mod-97 (ISO 7064) checksum
+- `DataCheckKit::CreditCard.valid?`, `.mask` — Luhn algorithm
+- `DataCheckKit::PostalCode.valid?`, `.supported_countries` — NL, PL, DE, FR, IT, AT, CH, GB, ES, FI, US
+- `DataCheckKit::Slug.make`
+
+## Testing
+
+```bash
+bundle install
+rake test
+```
+
+## License
+
+MIT — see [LICENSE.txt](./LICENSE.txt).

data/lib/datacheck-kit/credit_card.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module DataCheckKit
+  module CreditCard
+    DIGITS_PATTERN = /\A\d{12,19}\z/.freeze
+
+    # Validates a credit/debit card number using the Luhn checksum algorithm.
+    def self.valid?(value)
+      return false unless value.is_a?(String)
+
+      digits = value.gsub(/[\s-]/, '')
+      return false unless digits =~ DIGITS_PATTERN
+
+      sum = 0
+      should_double = false
+      digits.reverse.each_char do |ch|
+        digit = ch.to_i
+        if should_double
+          digit *= 2
+          digit -= 9 if digit > 9
+        end
+        sum += digit
+        should_double = !should_double
+      end
+      (sum % 10).zero?
+    end
+
+    # Masks a card number, keeping only the last 4 digits visible,
+    # e.g. "4111111111111111" -> "**** **** **** 1111".
+    def self.mask(value)
+      return nil unless value.is_a?(String)
+
+      digits = value.gsub(/[\s-]/, '')
+      return nil unless digits =~ DIGITS_PATTERN
+
+      last4 = digits[-4..]
+      masked_length = digits.length - 4
+
+      groups = []
+      i = 0
+      while i < masked_length
+        n = [4, masked_length - i].min
+        groups << ('*' * n)
+        i += n
+      end
+      groups << last4
+
+      groups.join(' ')
+    end
+  end
+end

data/lib/datacheck-kit/email.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module DataCheckKit
+  module Email
+    # Pragmatic (not fully RFC 5322-compliant) email check that catches the
+    # mistakes that actually show up in real-world form input.
+    PATTERN = /\A[^\s@]+@[^\s@]+\.[^\s@]{2,}\z/.freeze
+
+    # Checks whether +value+ looks like a valid email address.
+    def self.valid?(value)
+      return false unless value.is_a?(String)
+
+      trimmed = value.strip
+      return false if trimmed.empty? || trimmed.length > 254
+      return false if trimmed.include?('..')
+
+      !!(trimmed =~ PATTERN)
+    end
+
+    # Normalizes an email address: trims whitespace and lower-cases it.
+    # Returns +nil+ for input that isn't a plausible email.
+    def self.normalize(value)
+      return nil unless valid?(value)
+
+      value.strip.downcase
+    end
+  end
+end

data/lib/datacheck-kit/iban.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DataCheckKit
+  module Iban
+    # Expected IBAN length per country, ISO 3166-1 alpha-2 keyed.
+    LENGTHS = {
+      'AT' => 20, 'BE' => 16, 'CH' => 21, 'DE' => 22, 'ES' => 24, 'FI' => 18, 'FR' => 27,
+      'GB' => 22, 'IT' => 27, 'NL' => 18, 'PL' => 28, 'PT' => 25, 'IE' => 22, 'LU' => 20
+    }.freeze
+
+    SHAPE_PATTERN = /\A[A-Z]{2}\d{2}[A-Z0-9]+\z/.freeze
+
+    # Validates an IBAN using the standard mod-97 checksum (ISO 7064).
+    def self.valid?(value)
+      return false unless value.is_a?(String)
+
+      iban = value.gsub(/\s+/, '').upcase
+      return false unless iban =~ SHAPE_PATTERN
+
+      country = iban[0, 2]
+      expected_length = LENGTHS[country]
+      return false if expected_length && iban.length != expected_length
+
+      # Move the first 4 characters to the end, then convert letters to
+      # numbers (A=10, B=11, ... Z=35) and check the result mod 97 == 1.
+      rearranged = iban[4..] + iban[0, 4]
+      numeric = rearranged.each_char.map { |c| c =~ /[A-Z]/ ? (c.ord - 55).to_s : c }.join
+
+      numeric.to_i % 97 == 1
+    end
+
+    # Formats an IBAN into groups of 4 characters for display,
+    # e.g. "NL91ABNA0417164300" -> "NL91 ABNA 0417 1643 00".
+    def self.format(value)
+      iban = value.gsub(/\s+/, '').upcase
+      iban.scan(/.{1,4}/).join(' ')
+    end
+  end
+end

data/lib/datacheck-kit/phone.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DataCheckKit
+  module Phone
+    SEPARATORS = /[\s\-().]/.freeze
+    E164_PATTERN = /\A\+?[1-9]\d{7,14}\z/.freeze
+
+    # Checks whether +value+ is a plausible international phone number
+    # (E.164-style: optional leading +, 8-15 digits).
+    def self.valid?(value)
+      return false unless value.is_a?(String)
+
+      digits = value.gsub(SEPARATORS, '')
+      !!(digits =~ E164_PATTERN)
+    end
+
+    # Formats a phone number into E.164 form (e.g. "+442071234567").
+    # Assumes the number already includes a country code.
+    # Returns +nil+ if the input isn't a plausible phone number.
+    def self.format_e164(value)
+      return nil unless valid?(value)
+
+      digits = value.gsub(SEPARATORS, '')
+      digits.start_with?('+') ? digits : "+#{digits}"
+    end
+  end
+end

data/lib/datacheck-kit/postal_code.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module DataCheckKit
+  module PostalCode
+    # A pragmatic (not exhaustive) set of postal code patterns for a
+    # handful of European countries.
+    PATTERNS = {
+      'NL' => /\A\d{4}\s?[A-Z]{2}\z/i,
+      'PL' => /\A\d{2}-\d{3}\z/,
+      'DE' => /\A\d{5}\z/,
+      'FR' => /\A\d{5}\z/,
+      'IT' => /\A\d{5}\z/,
+      'AT' => /\A\d{4}\z/,
+      'CH' => /\A\d{4}\z/,
+      'GB' => /\A[A-Z]{1,2}\d[A-Z\d]?\s?\d[A-Z]{2}\z/i,
+      'ES' => /\A\d{5}\z/,
+      'FI' => /\A\d{5}\z/,
+      'US' => /\A\d{5}(-\d{4})?\z/
+    }.freeze
+
+    # Validates a postal/ZIP code against the pattern for a given
+    # ISO 3166-1 alpha-2 country code.
+    def self.valid?(value, country_code)
+      return false unless value.is_a?(String) && country_code.is_a?(String)
+
+      pattern = PATTERNS[country_code.upcase]
+      return false unless pattern
+
+      !!(value.strip =~ pattern)
+    end
+
+    # Returns the list of country codes this module has a pattern for.
+    def self.supported_countries
+      PATTERNS.keys
+    end
+  end
+end

data/lib/datacheck-kit/slug.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DataCheckKit
+  module Slug
+    # Basic Latin diacritic map, enough for common Western/Northern European text.
+    DIACRITICS = {
+      'á' => 'a', 'à' => 'a', 'â' => 'a', 'ä' => 'a', 'ã' => 'a', 'å' => 'a',
+      'é' => 'e', 'è' => 'e', 'ê' => 'e', 'ë' => 'e',
+      'í' => 'i', 'ì' => 'i', 'î' => 'i', 'ï' => 'i',
+      'ó' => 'o', 'ò' => 'o', 'ô' => 'o', 'ö' => 'o', 'õ' => 'o',
+      'ú' => 'u', 'ù' => 'u', 'û' => 'u', 'ü' => 'u',
+      'ñ' => 'n', 'ç' => 'c', 'ý' => 'y', 'ß' => 'ss'
+    }.freeze
+
+    # Converts a string into a URL-friendly slug: lower-cases, strips
+    # diacritics, and replaces non-alphanumeric runs with a single hyphen.
+    def self.make(value)
+      return '' unless value.is_a?(String)
+
+      lowered = value.downcase
+      deaccented = lowered.each_char.map { |c| DIACRITICS[c] || c }.join
+
+      collapsed = deaccented.gsub(/[^a-z0-9]+/, '-')
+      collapsed.gsub(/\A-+|-+\z/, '')
+    end
+  end
+end

data/lib/datacheck-kit/url.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module DataCheckKit
+  module Url
+    # Checks whether +value+ is a syntactically valid http(s) URL.
+    def self.valid?(value)
+      return false unless value.is_a?(String)
+
+      trimmed = value.strip
+      return false if trimmed.empty?
+
+      uri = begin
+        URI.parse(trimmed)
+      rescue URI::InvalidURIError
+        nil
+      end
+      return false if uri.nil?
+
+      %w[http https].include?(uri.scheme) && !uri.host.nil?
+    end
+
+    # Normalizes a URL: adds https:// if the protocol is missing,
+    # lower-cases the host, and strips a bare trailing slash from the path.
+    # Returns +nil+ if the input can't be turned into a valid URL.
+    def self.normalize(value)
+      return nil unless value.is_a?(String)
+
+      trimmed = value.strip
+      return nil if trimmed.empty?
+
+      candidate = trimmed =~ %r{\Ahttps?://}i ? trimmed : "https://#{trimmed}"
+
+      uri = begin
+        URI.parse(candidate)
+      rescue URI::InvalidURIError
+        nil
+      end
+      return nil if uri.nil? || !%w[http https].include?(uri.scheme) || uri.host.nil?
+
+      uri.host = uri.host.downcase
+      uri.path = '' if uri.path == '/' && uri.query.nil? && uri.fragment.nil?
+
+      uri.to_s
+    end
+  end
+end

data/lib/datacheck-kit.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'datacheck-kit/email'
+require_relative 'datacheck-kit/url'
+require_relative 'datacheck-kit/phone'
+require_relative 'datacheck-kit/iban'
+require_relative 'datacheck-kit/credit_card'
+require_relative 'datacheck-kit/postal_code'
+require_relative 'datacheck-kit/slug'
+
+# DataCheckKit is a zero-dependency toolkit for validating and formatting
+# everyday data: emails, phone numbers, URLs, IBANs, credit card numbers,
+# postal codes and slugs.
+module DataCheckKit
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: datacheck-kit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Malboro
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Validates and formats emails, phone numbers, URLs, IBANs, credit card
+  numbers, postal codes and slugs — no runtime dependencies.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/datacheck-kit.rb
+- lib/datacheck-kit/credit_card.rb
+- lib/datacheck-kit/email.rb
+- lib/datacheck-kit/iban.rb
+- lib/datacheck-kit/phone.rb
+- lib/datacheck-kit/postal_code.rb
+- lib/datacheck-kit/slug.rb
+- lib/datacheck-kit/url.rb
+homepage: https://luckymisters.uk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://luckymisters.uk
+  source_code_uri: https://github.com/galvaonten-coder/datacheck-kit-ruby
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Zero-dependency toolkit for validating and formatting everyday data
+test_files: []