luhn 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: acc7be20238719d56f27cf60436232d6933aeca2
-  data.tar.gz: 351bc940bea52556e369602a546c5bcebdaf1e02
+SHA256:
+  metadata.gz: 48cccdf14be3fc83b329b2b7407ebd4410c889d62e5fc9e526b5beded1a4f137
+  data.tar.gz: 31fb9fa178dcfc3068a5e4563fecd2756786334ffcda5dcb1c02831a7c085030
 SHA512:
-  metadata.gz: 1c25701d9c3466526efc767fee9c0c0c7c384044c8894d84e635094b687aba5be016a1b99cfda8f0c7181693c7ac89a8cdd2d664263517d2b7132d0e1614c588
-  data.tar.gz: 6e0cff66c776898bb10ef90cb58129af34e64dfbef5b569af2f7998a8155c755c30d5ced4fd21f538f6f03d85e5cbb3930ea046b8752982e46723743a6cfae68
+  metadata.gz: 1ed8c51ba3cf801e1f2ec7eb17b244e7bd0fc06b40899ef7f5d1a230ddd327ff01376fe54d5af9ec15676261ac09844e0f0c747dda0acc8122be805bbcb55482
+  data.tar.gz: bce0cbb1eb0a0b31e8d77e6794935c01377424139c21252536419376e70a0116e81dbdab0645844a60bbb2c863ae570a738593f576329f37870d79c20eec4582

data/README.md

@@ -0,0 +1,55 @@
+# Ruby class for handling basic Luhn number generation and verification
+
+Includes a class to handle Swedish civic numbers (Personnummer).
+
+The interface supports checking validity (length, valid date and satisfies luhn),
+returning the sex, the control digit, and generating random civic numbers.
+
+## Install
+
+```shell
+$ gem install luhn
+```
+
+## Usage:
+
+### Basic Luhn
+
+```ruby
+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
+
+```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
+```
+
+## About the Luhn algorithm
+
+The following is an excerpt from [the Wikipedia article on the Luhn algorithm.](https://en.wikipedia.org/wiki/Luhn_algorithm)
+
+The Luhn algorithm or Luhn formula, also known as the "modulus 10" or "mod 10"
+algorithm, is a simple checksum formula used to validate a variety of
+identification numbers, such as credit card numbers, IMEI numbers,
+National Provider Identifier numbers in US and Canadian Social Insurance Numbers,
+and even South African ID numbers.
+
+It was created by IBM scientist Hans Peter Luhn and described in U.S. Patent
+No. 2,950,048, filed on January 6, 1954, and granted on August 23, 1960.
+
+## Copyright
+
+Copyright (c) 2010 Joel Junström. See [LICENSE](LICENSE) for details.

data/lib/luhn/civic_number.rb

@@ -2,14 +2,14 @@
 require 'ostruct'
 module Luhn
   class CivicNumber
-    attr_reader :civic_number
+    attr_reader :value
 
-    def initialize(string)
-      @civic_number = cleanup_string(string.to_s)
+    def initialize string
+      self.value = string
     end
 
     def valid?
-      @valid ||= civic_number.length == 10 && valid_date? && Luhn.valid?(civic_number)
+      @valid ||= value.length == 10 && valid_date? && Luhn.valid?(value)
     end
 
     def valid_date?
@@ -17,11 +17,11 @@ module Luhn
     end
 
     def control_digit
-      @control_digit ||= Luhn.control_digit(civic_number[0...9])
+      @control_digit ||= Luhn.control_digit(value[0...9])
     end
 
     def sex
-      @sex ||= valid? ? (civic_number[8...9].to_i.even? ? 'female' : 'male') : 'unknown'
+      valid? ? (value[8...9].to_i.even? ? 'female' : 'male') : 'unknown'
     end
 
     def female?
@@ -33,34 +33,38 @@ module Luhn
     end
 
     def birth_date
-      @date ||= OpenStruct.new({
-        :year  => civic_number[0...2].to_i,
-        :month => civic_number[2...4].to_i,
-        :day   => civic_number[4...6].to_i
+      OpenStruct.new({
+        :year  => value[0...2].to_i,
+        :month => value[2...4].to_i,
+        :day   => value[4...6].to_i
       })
     end
 
     def formatted
-      to_s.insert(civic_number.length - 4, "-")
+      return value if value.length < 10
+
+      value.insert(value.length - 4, "-")
     end
 
     def to_s
-      civic_number
+      value
     end
 
-    class << self
-      def 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"))
-      end
+    # For backwards compability
+    def civic_number
+      value
     end
 
-  private
-
-    def cleanup_string(string)
-      string.gsub!(/\D/, '')
-      string.length == 12 ? string[2...12] : string
+    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"))
     end
 
+    private
+
+    def value= string
+      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,3 @@
 module Luhn
-  Version = "1.0.0"
+  Version = "1.0.3"
 end

data/spec/spec_civic_number.rb

@@ -46,10 +46,18 @@ describe Luhn::CivicNumber do
     civic_number.birth_date.day.must_equal 1
   end
 
-  it "formats the civic number" do
-    civic_number = Luhn::CivicNumber.new('3001018194')
+  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 "300101-8194"
+      civic_number.formatted.must_equal "300101819"
+    end
   end
 
   it 'generates a valid random civic number' do

metadata

@@ -1,69 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: luhn
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Joel Junström
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.0
-description: 
 email:
 - joel.junstrom@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 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/extensions.rb
 - lib/luhn/version.rb
-- lib/luhn.rb
 - spec/helper.rb
 - spec/spec_civic_number.rb
 - spec/spec_extensions.rb
 - spec/spec_luhn.rb
-- LICENSE
-- README.rdoc
 homepage: http://github.com/joeljunstrom/ruby_luhn
 licenses: []
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
-signing_key: 
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A small implementation of the Luhn algorithm.
 test_files: []

data/README.rdoc

@@ -1,44 +0,0 @@
-= Ruby class for handling basic Luhn number generation and verification
-
-Includes a class to handle Swedish civic numbers (Personnummer)
-That interface supports checking validity (length, valid date and satisfies luhn),
-returning the sex, the control digit and generating random civic numbers.
-
-== Install
-
-  $ gem install luhn
-
-== Usage:
-
-=== Basic Luhn
-
-  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
-
-  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
-
-== About the Luhn algorithm (from http://en.wikipedia.org/wiki/Luhn_formula)
-
-The Luhn algorithm or Luhn formula, also known as the "modulus 10" or "mod 10"
-algorithm, is a simple checksum formula used to validate a variety of
-identification numbers, such as credit card numbers, IMEI numbers,
-National Provider Identifier numbers in US and Canadian Social Insurance Numbers.
-It was created by IBM scientist Hans Peter Luhn and described in U.S. Patent
-No. 2,950,048, filed on January 6, 1954, and granted on August 23, 1960.
-
-== Copyright
-
-Copyright (c) 2010 Joel Junström. See LICENSE for details.