luhn 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ff23cbc7129b7601b34777ba537836b0208bf923e20dba0d487b0f6c3820b7d
-  data.tar.gz: ef77324153e382df6f5ca8acd7f4f463a2b26c112697125b46fb45ac5e0524a4
+  metadata.gz: bf4e123f559d73199fd452f9f768f7fbf6cfa224995946e4c73492265868d506
+  data.tar.gz: a9d036b18565b4f9ddda1d1812f300d9c629a7b5f4ae826caaa6663f1ef309f8
 SHA512:
-  metadata.gz: 68ff8abbceae4a45d326a514d5ada5353a6fc54db0c96cd5959aff186951dde6274fff7299f2d5caf6224c4ac52a2ea4331f217586e61589705b027a79fd0257
-  data.tar.gz: 4c3141f268fbdc1f6764e7ebb217e6e27c18d810ee9865882eabf49c8ea1c57cf9514d39a5b12eefbdc082c114b7a997793ef4c736030622d5beaa97d357d869
+  metadata.gz: 155f6543bfcf8effc9d5fea6c6319dd162d2f380409f52cdc95462d6d3b6907bc32296b7c3a8006227f6130e1ef7470713e6934c6894c954c4068cfe5a414e0c
+  data.tar.gz: 2aa60ea0ea0f5463db677b1486fb7e4693615cfc0c304a22f790b5f9062483ede9ad10442b878cff365d783401f4ac8e934b64c6eb9cf908efb67c6d0a0104ce

data/README.md

@@ -1,9 +1,9 @@
 # Ruby class for handling basic Luhn number generation and verification
 
-Includes a class to handle Swedish civic numbers (Personnummer).
+Includes a class to handle Swedish personal identity numbers (Personnummer).
 
 The interface supports checking validity (length, valid date and satisfies luhn),
-returning the sex, the control digit, and generating random civic numbers.
+returning the sex, the control digit, and generating random identity numbers.
 
 ## Install
 
@@ -16,25 +16,19 @@ $ gem install luhn
 ### Basic Luhn
 
 ```ruby
-Luhn.valid?('0465827879483596')       # true
-Luhn.control_digit('046582787948359') # 6
+Luhn.valid?("0465827879483596")       # true
+Luhn.control_digit("046582787948359") # 6
 Luhn.generate(n)                      # returns a random number of n length that satisfies luhn
-
-'0465827879483596'.valid_luhn? # true
-0465827879483596.valid_luhn?   # true
 ```
 
-### Swedish civic numbers
+### Swedish personal identity numbers
 
 ```ruby
-civic_number = Luhn::CivicNumber.new('19391030-3183')
-civic_number.valid?        # true
-civic_number.sex           # 'male'
-civic_number.male?         # true
-civic_number.control_digit # 3
-
-'391030-3183'.civic_number? # true
-3910303183.civic_number?    # true
+number = Luhn::PersonalIdentityNumber.new("19391030-3183")
+number.valid?        # true
+number.sex           # "male"
+number.male?         # true
+number.control_digit # 3
 ```
 
 ## About the Luhn algorithm

data/lib/luhn/{civic_number.rb → personal_identity_number.rb}

@@ -1,8 +1,11 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 module Luhn
-  class CivicNumber
+  class PersonalIdentityNumber
     attr_reader :value
 
+    BirthDate = Data.define(:year, :month, :day)
+
     def initialize string
       self.value = string
     end
@@ -12,7 +15,7 @@ module Luhn
     end
 
     def valid_date?
-      (1..12).include?(birth_date.month) && (1..31).include?(birth_date.day)
+      (1..12).cover?(birth_date.month) && (1..31).cover?(birth_date.day)
     end
 
     def control_digit
@@ -20,19 +23,20 @@ module Luhn
     end
 
     def sex
-      valid? ? (value[8...9].to_i.even? ? 'female' : 'male') : 'unknown'
+      return "unknown" unless valid?
+      (value[8...9].to_i.even? ? "female" : "male")
     end
 
     def female?
-      sex == 'female'
+      sex == "female"
     end
 
     def male?
-      sex == 'male'
+      sex == "male"
     end
 
     def birth_date
-      Data.define(:year, :month, :day).new(
+      BirthDate.new(
         value[0...2].to_i,
         value[2...4].to_i,
         value[4...6].to_i
@@ -49,21 +53,16 @@ module Luhn
       value
     end
 
-    # For backwards compability
-    def civic_number
-      value
-    end
-
     def self.generate
-      date = Time.local(Time.now.year - rand(100) - 1, rand(12) + 1, rand(31) + 1)
-      Luhn.generate(10, :prefix => date.strftime("%y%m%d"))
+      date = Time.local(Time.now.year - rand(1..99), rand(1..12), rand(1..31))
+      Luhn.generate(10, prefix: date.strftime("%y%m%d"))
     end
 
     private
 
     def value= string
-      val = string.to_s.gsub(/\D/, '')
-      @value = val.length == 12 ? val[2...12] : val
+      val = string.to_s.gsub(/\D/, "")
+      @value = ((val.length == 12) ? val[2...12] : val)
     end
   end
 end

data/lib/luhn/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Luhn
-  Version = "2.0.0"
+  VERSION = "3.0.0"
 end

data/lib/luhn.rb

@@ -1,5 +1,4 @@
-# encoding: UTF-8
-require "luhn/extensions"
+# frozen_string_literal: true
 
 module Luhn
   def self.valid? value
@@ -22,10 +21,10 @@ module Luhn
     end
 
     def self.generate size, options = {}
-      generated = options[:prefix] || ''
+      generated = options[:prefix] || ""
       (size - generated.size - 1).times { |i| generated += rand(10).to_s }
 
-      generated + self.new(generated).control_digit.to_s
+      generated + new(generated).control_digit.to_s
     end
 
     def valid?
@@ -46,14 +45,14 @@ module Luhn
     def checksum(operation)
       i = 0
       compare_method = (operation == :even) ? :== : :>
-      self.number.reverse.split("").inject(0) do |sum, c|
+      number.reverse.chars.inject(0) do |sum, c|
         n = c.to_i
         weight = (i % 2).send(compare_method, 0) ? n * 2 : n
         i += 1
-        sum += weight < 10 ? weight : weight - 9
+        sum + ((weight < 10) ? weight : (weight - 9))
       end
     end
   end
 end
 
-require "luhn/civic_number"
+require "luhn/personal_identity_number"

data/spec/helper.rb

@@ -1,7 +1,9 @@
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
-require 'rubygems'
-gem 'minitest'
-require 'luhn'
-require 'minitest/benchmark' if ENV["BENCH"]
-require 'minitest/spec'
-require 'minitest/autorun'
+# frozen_string_literal: true
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+require "rubygems"
+gem "minitest"
+require "luhn"
+require "minitest/benchmark" if ENV["BENCH"]
+require "minitest/spec"
+require "minitest/autorun"

data/spec/spec_luhn.rb

@@ -1,35 +1,37 @@
-require 'helper'
+# frozen_string_literal: true
+
+require "helper"
 
 describe Luhn do
   it "identifies if the number is valid" do
-    Luhn.valid?('1111111116').must_equal true
+    Luhn.valid?("1111111116").must_equal true
   end
 
-  it 'identifies if the number is invalid' do
-    Luhn.valid?('1111111111').must_equal false
+  it "identifies if the number is invalid" do
+    Luhn.valid?("1111111111").must_equal false
   end
 
-  it 'requires numbers' do
-    Luhn.valid?('frefre').must_equal false
+  it "requires numbers" do
+    Luhn.valid?("frefre").must_equal false
   end
 
-  it 'generates a number string that satisfies luhn' do
-    luhn_string = Luhn.generate(rand(32)+1)
+  it "generates a number string that satisfies luhn" do
+    luhn_string = Luhn.generate(rand(1..32))
     Luhn.valid?(luhn_string).must_equal true
   end
 
-  it 'generate a number string with the size of the argument' do
+  it "generate a number string with the size of the argument" do
     luhn_string = Luhn.generate(5)
     luhn_string.size.must_equal 5
   end
 
-  it 'generate a a valid luhn with a given prefix' do
-    luhn_string = Luhn.generate(10, :prefix => '00001')
-    luhn_string.must_match /^00001/
+  it "generate a a valid luhn with a given prefix" do
+    luhn_string = Luhn.generate(10, prefix: "00001")
+    luhn_string.must_match(/^00001/)
     Luhn.valid?(luhn_string).must_equal true
   end
 
-  it 'calculates the control digit' do
-    Luhn.control_digit('111111111').must_equal 6
+  it "calculates the control digit" do
+    Luhn.control_digit("111111111").must_equal 6
   end
 end

data/spec/spec_personal_identity_number.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "helper"
+
+describe Luhn::PersonalIdentityNumber do
+  it "identifies if the personal identity number is valid" do
+    Luhn::PersonalIdentityNumber.new("3910304298").valid?.must_equal true
+
+    Luhn::PersonalIdentityNumber.new("193910304298").valid?.must_equal true
+  end
+
+  it "identifies if the personal identity number is invalid" do
+    Luhn::PersonalIdentityNumber.new("3910304290").valid?.must_equal false
+  end
+
+  it "requires a length of 10 to be valid" do
+    luhn_string = Luhn.generate(8, prefix: "391030")
+    Luhn::PersonalIdentityNumber.new(luhn_string).valid?.must_equal false
+  end
+
+  it "requires the personal identity number to be a valid date" do
+    luhn_string = Luhn.generate(10, prefix: "3999")
+    Luhn::PersonalIdentityNumber.new(luhn_string).valid?.must_equal false
+  end
+
+  it "calculates the control digit for a valid personal identity number" do
+    Luhn::PersonalIdentityNumber.new("3910304298").control_digit.must_equal 8
+  end
+
+  it "calculates the correct control digit for an invalid personal identity number" do
+    Luhn::PersonalIdentityNumber.new("3910304290").control_digit.must_equal 8
+  end
+
+  it "identifies if the personal identity number belongs to a male" do
+    Luhn::PersonalIdentityNumber.new("3910304298").sex.must_equal "male"
+  end
+
+  it "identifies if the personal identity number belongs to a female" do
+    Luhn::PersonalIdentityNumber.new("3910303183").sex.must_equal "female"
+  end
+
+  it "cleans up personal identity number with the full year supplied" do
+    Luhn::PersonalIdentityNumber.new("19391030-3183").to_s.must_equal "3910303183"
+  end
+
+  it "knows the date of birth" do
+    personal_identity_number = Luhn::PersonalIdentityNumber.new("3001018194")
+    personal_identity_number.birth_date.year.must_equal 30
+    personal_identity_number.birth_date.month.must_equal 1
+    personal_identity_number.birth_date.day.must_equal 1
+  end
+
+  describe "#formatted" do
+    it "formats the personal identity number" do
+      personal_identity_number = Luhn::PersonalIdentityNumber.new("3001018194")
+
+      personal_identity_number.formatted.must_equal "300101-8194"
+    end
+
+    it "returns the origial if the personal identity number is to short" do
+      personal_identity_number = Luhn::PersonalIdentityNumber.new("300101819")
+
+      personal_identity_number.formatted.must_equal "300101819"
+    end
+  end
+
+  it "generates a valid random personal identity number" do
+    personal_identity_number = Luhn::PersonalIdentityNumber.generate
+    Luhn::PersonalIdentityNumber.new(personal_identity_number).valid?.must_equal true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: luhn
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Joel Junström
@@ -32,15 +32,11 @@ files:
 - LICENSE
 - README.md
 - lib/luhn.rb
-- lib/luhn/civic_number.rb
-- lib/luhn/extensions.rb
-- lib/luhn/extensions/numeric.rb
-- lib/luhn/extensions/string.rb
+- lib/luhn/personal_identity_number.rb
 - lib/luhn/version.rb
 - spec/helper.rb
-- spec/spec_civic_number.rb
-- spec/spec_extensions.rb
 - spec/spec_luhn.rb
+- spec/spec_personal_identity_number.rb
 homepage: http://github.com/joeljunstrom/ruby_luhn
 licenses: []
 metadata: {}

data/lib/luhn/extensions/numeric.rb

@@ -1,11 +0,0 @@
-# encoding: UTF-8
-class Numeric
-
-  def valid_luhn?
-    self.to_s.valid_luhn?
-  end
-
-  def civic_number?
-    self.to_s.civic_number?
-  end
-end

data/lib/luhn/extensions/string.rb

@@ -1,10 +0,0 @@
-# encoding: UTF-8
-class String
-  def valid_luhn?
-    Luhn.valid?(self)
-  end
-
-  def civic_number?
-    Luhn::CivicNumber.new(self).valid?
-  end
-end

data/lib/luhn/extensions.rb

@@ -1,3 +0,0 @@
-# encoding: UTF-8
-require 'luhn/extensions/string'
-require 'luhn/extensions/numeric'

data/spec/spec_civic_number.rb

@@ -1,67 +0,0 @@
-require 'helper'
-
-describe Luhn::CivicNumber do
-  it 'identifies if the civic number is valid' do
-    Luhn::CivicNumber.new('3910304298').valid?.must_equal true
-  end
-
-  it 'identifies if the civic number is invalid' do
-    Luhn::CivicNumber.new('3910304290').valid?.must_equal false
-  end
-
-  it 'requires a length of 10 to be valid' do
-    luhn_string = Luhn.generate(8, :prefix => '391030')
-    Luhn::CivicNumber.new(luhn_string).valid?.must_equal false
-  end
-
-  it 'requires the civic number to be a valid date' do
-    luhn_string = Luhn.generate(10, :prefix => '3999')
-    Luhn::CivicNumber.new(luhn_string).valid?.must_equal false
-  end
-
-  it 'calculates the control digit for a valid civic number' do
-    Luhn::CivicNumber.new('3910304298').control_digit.must_equal 8
-  end
-
-  it 'calculates the correct control digit for an invalid civic number' do
-    Luhn::CivicNumber.new('3910304290').control_digit.must_equal 8
-  end
-
-  it 'identifies if the civic number belongs to a male' do
-    Luhn::CivicNumber.new('3910304298').sex.must_equal 'male'
-  end
-
-  it 'identifies if the civic number belongs to a female' do
-    Luhn::CivicNumber.new('3910303183').sex.must_equal 'female'
-  end
-
-  it 'cleans up civic number with the full year supplied' do
-    Luhn::CivicNumber.new('19391030-3183').civic_number.must_equal '3910303183'
-  end
-
-  it 'knows the date of birth' do
-    civic_number = Luhn::CivicNumber.new('3001018194')
-    civic_number.birth_date.year.must_equal 30
-    civic_number.birth_date.month.must_equal 1
-    civic_number.birth_date.day.must_equal 1
-  end
-
-  describe "#formatted" do
-    it "formats the civic number" do
-      civic_number = Luhn::CivicNumber.new('3001018194')
-
-      civic_number.formatted.must_equal "300101-8194"
-    end
-
-    it "returns the origial if the civic number is to short" do
-      civic_number = Luhn::CivicNumber.new('300101819')
-
-      civic_number.formatted.must_equal "300101819"
-    end
-  end
-
-  it 'generates a valid random civic number' do
-    civic_number = Luhn::CivicNumber.generate
-    Luhn::CivicNumber.new(civic_number).valid?.must_equal true
-  end
-end

data/spec/spec_extensions.rb

@@ -1,21 +0,0 @@
-require 'helper'
-
-describe String do
-  it 'knows if it is a valid luhn' do
-    '3910304298'.valid_luhn?.must_equal true
-  end
-
-  it 'knows if it is an civic number' do
-    '3910304298'.civic_number?.must_equal true
-  end
-end
-
-describe Numeric do
-  it 'knows if it is a valid luhn' do
-    3910304298.valid_luhn?.must_equal true
-  end
-
-  it 'knows if it is an civic number' do
-    3910304298.civic_number?.must_equal true
-  end
-end