luhn_util 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 573af37dfcd3390628a8a9d191a156231ab35c56158751c21545ed2db1ad9209
-  data.tar.gz: 9d59acbae76b661d8cd941b1c41cd8bfdfd66f5bebd9a04acc19f76e63795abf
+  metadata.gz: de11d9f613bff6a60e8a0171b12d6ac314896effa2b2ff9b71bb4ebb3fe4acfa
+  data.tar.gz: 791ac942326d80198704a456fca3942d8d967530d283e01691bf4203f8a28bea
 SHA512:
-  metadata.gz: 393e76ca8b691b48e4f5b049a9059122c953773ee59ddea184caa58bf7916dea997d07d21ec1500a35c0f56db994d2e9ff437eb11f530893d5e7e6ac6b02dee9
-  data.tar.gz: 8148996383ffe0c7cb82280b53bec88e2a6e0ffdfe7c0472133f716a0dfb3400bd6ee24d34ca43b8f74e0878ddc021e879ace0ec102530f95cfbf1d0cc9bc646
+  metadata.gz: 3016fc85a49a12b87197c1935b6569390331b151c9832831adc8af817f299d6373583efa0721ab2f11ba82b2e31f0c3266384fee9e7648cb87e3cc1afa988bac
+  data.tar.gz: 494ff51979775268613b1cf183e2b9afff08e64a02fa2f2d297351f07fc904fcb793ae3b556446e08495d39c8b1c18a8809b318280fbf639261c71646e69db7e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    luhn_util (0.1.0)
+    luhn_util (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,10 +1,11 @@
 # luhn_util
 
-This is a simple gem to generate and validate using Luhn algorithm.
+A simple Ruby utility to validate and generate Luhn-compliant numbers.
 
-`luhn_util` is a gem that is able to:
+`luhn_util` is able to:
 - Validate an input according to the Luhn algorithm
-- Generate random Luhn number based on any valid length
+- Calculate the check digit for a given numeric input
+- Generate random Luhn number based on any valid length and prefix
 
 The algorithm followed is based on [Luhn Algorithm](https://en.wikipedia.org/wiki/Luhn_algorithm).
 
@@ -32,6 +33,11 @@ To check if input is valid:
 $ Luhn.valid?('5185443765446305')
 $ true
 ```
+To calculate the check digit:
+```shell
+$ Luhn.check_digit('1234567890')
+$ 3
+```
 The `generate` method returns a 16-character number by default:
 ```shell
 $ Luhn.generate
@@ -42,6 +48,14 @@ Length may also be specified:
 $ Luhn.generate(length: 8)
 $ 29974938
 ```
+Prefix may also be supplied:
+```shell
+$ Luhn.generate(prefix: '88')
+$ 8821951428417137
+
+$ Luhn.generate(length: 8, prefix: '88')
+$ 88405022
+```
 
 ## Development
 
@@ -51,7 +65,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/luhn_util. 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/[USERNAME]/luhn_util/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/katpadi/luhn_util. 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/[USERNAME]/luhn_util/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -59,4 +73,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the luhn_util project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/luhn_util/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the luhn_util project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/katpadi/luhn_util/blob/main/CODE_OF_CONDUCT.md).

data/lib/luhn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Luhn
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/luhn.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Luhn
+  MIN_LENGTH = 2
   class << self
     def valid?(digits)
       return false unless numeric_string?(digits)
@@ -10,12 +11,19 @@ module Luhn
       sum = checksum + non_checksum
       sum % 10 == 0
     end
+    def check_digit(partial_num)
+      (10 - (non_checksum_sum(partial_num) % 10)) % 10
+    end
+
+    def generate(length: 16, prefix: nil)
+      raise ArgumentError, 'length must be more than minimum' unless length.to_i > MIN_LENGTH
 
-    def generate(length = 16)
-      raise ArgumentError, 'length must be valid' if length.nil? || length < 2
+      raise ArgumentError, 'prefix length invalid' if prefix && (prefix.to_s.length + MIN_LENGTH >= length)
 
-      partial_num = ''
-      (length - 1).times do
+      raise ArgumentError, 'prefix must be numeric' if prefix && !numeric_string?(prefix)
+
+      partial_num = (prefix&.empty? ? '' : prefix).to_s
+      (length - 1 - partial_num.length).times do
         partial_num += rand(10).to_s
       end
       mod = 10 - (non_checksum_sum(partial_num) % 10)
@@ -25,16 +33,14 @@ module Luhn
 
     private
 
-    def numeric_string?(str)
-      !!(str =~ /\A[-+]?[0-9]+\z/)
-    end
+    def numeric_string?(str) = !!(str =~ /\A[-+]?[0-9]+\z/)
 
     def non_checksum_sum(partial_num)
       sum = 0
       partial_num.chars.map(&:to_i).reverse.each_with_index do |num, i|
         if i.even?
           num *= 2
-          num = num > 9 ? num - 9 : num
+          num -= 9 if num > 9
         end
         sum += num
       end

data/luhn_util.gemspec

@@ -8,15 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors = ["Kat Padilla"]
   spec.email = ["hello@katpadi.ph"]
   spec.summary = "A simple Luhn algorithm implementation using Ruby."
-  spec.description = "A simple Luhn algorithm implementation using Ruby to validate and generate Luhn numbers"
+  spec.description = "A simple Ruby utility to validate and generate Luhn-compliant numbers"
   spec.homepage = 'https://rubygems.org/gems/luhn_util'
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0.0"
 
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
   spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  spec.metadata["source_code_uri"] = 'https://github.com/katpadi/luhn_util'
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: luhn_util
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kat Padilla
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies: []
-description: A simple Luhn algorithm implementation using Ruby to validate and generate
-  Luhn numbers
+description: A simple Ruby utility to validate and generate Luhn-compliant numbers
 email:
 - hello@katpadi.ph
 executables: []
@@ -38,6 +37,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://rubygems.org/gems/luhn_util
+  source_code_uri: https://github.com/katpadi/luhn_util
 post_install_message:
 rdoc_options: []
 require_paths: