luhn-check 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33f175922b61819fcd65ab2081def3813d93827e
-  data.tar.gz: 054980845db991000adcdeb11b2800326f9e6592
+  metadata.gz: 38fde38a04d580ba1a409e99ccf4d3040ed3ab6c
+  data.tar.gz: ce07177a330063ee447a983a877372ebc36e1570
 SHA512:
-  metadata.gz: 836db051316d9ee9dd4ceb1bbb56342ae7e3881d3094a5a22306103fc550d048cf637bd971ebd1fe0eaf4fe765d084b494a78ef0565d79b8658e15572ecf388f
-  data.tar.gz: a3baa6b42f9766ba1a1d5f7bc0a67c24fa31521a216954add2620a1761f895e6b7f381860ae7c4862c0f038900bb0fe22bd77241a3353750d1ca3e05717fe1be
+  metadata.gz: c755af25e01c4fc9f1605f0a57503ec3918edf05fe80d3622eb1aa2664b0ec12caf1ebd6f24b5b35edef9a9b44cf2e69855285790425374cf68929ca90b5c7bf
+  data.tar.gz: 9315757d6e9df937d731ce557a742a6b939ff4873bb0e28f6d3129ec9d05f21948b990625d3d56c2866af3378543e5ea66851b093ca3000c51c567fdc6df27d7

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in luhn-check.gemspec
 gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'rspec'
+end

data/README.md

@@ -1,14 +1,18 @@
 # Luhn check
 
-With the luhn-check you can check a number with the Luhn algorithm.
+With the luhn-check gem you can validate a number with the Luhn algoritme.
 
 ## Installation
 ### Version
-`0.0.1`
+`0.0.3`
+
+###Gemfile
+
+Since that the namespace in the `lib` directory is different than the name of the gem. You need to require the namespace of the class defined in the `lib` directory. 
 
 Add this line to your application's Gemfile:
 
-    gem 'luhn-check'
+    gem 'luhn-check', '~> 0.0.3', require: 'luhn'
 
 And then execute:
 
@@ -20,17 +24,15 @@ Or install it yourself as:
 
 ## Usage
 
-After the gem is installed. There are some helpers available.
-
-To check if the number is valid with the Luhn algorithm:
+After the gem is installed. You can use this method to validate the number with the Luhn algoritme:
 
   ```ruby
   Luhn.valid?(number)
-  Luhn.calculate_check_digit(number)
-  Luhn.double_digits(number) # Array with digits for checksum
   ```
 
+
 ## Contributing
+Pretty standard:
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/Rakefile

@@ -1,7 +1,15 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  require 'bundler/gem_tasks'
+rescue LoadError
+  puts 'You must run `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new do |t|
-  t.libs   << 'test'
-  t.pattern = 'test/**/*_test.rb'
+RSpec::Core::RakeTask.new(:core) do |spec|
+  spec.rspec_opts = ['--backtrace']
 end
+
+task :default => [:core]

data/lib/luhn.rb

@@ -1,77 +1,4 @@
-require 'pry'
+require 'luhn/base'
 
 module Luhn
-
-  class << self
-
-    def ping
-      'pong'
-    end
-
-    def valid?(number)
-      checksum(number)
-    end
-
-    def calculate_check_digit(number)
-      number_without_check_digit = number.to_s[0...-1] + '0'
-      doubles = double_digits(number_without_check_digit.to_i)
-      sum = sum_of_all(doubles) unless null?(doubles)
-      product = sum * 9
-      get_check_digit(product)
-    end
-
-    def get_check_digit(number)
-      number.to_s[-1].to_i
-    end
-
-    def double_digits(number)
-      doubles = []
-      digits = all_digits(number).reverse
-      digits.each_with_index do |d, i|
-        if i.odd?
-          sum = d * 2
-          if sum && sum > 9
-            split_sum   = sum.to_s.split(//).map(&:to_i)
-            make_sum    = split_sum.inject { |sum, n| sum + n }
-            doubles     << make_sum
-          else
-            doubles << sum
-          end
-        else
-          doubles << d
-        end
-      end
-      return doubles
-    end
-
-    protected
-
-    def checksum(number)
-      if null?(number)
-        return false
-      else
-        doubles = double_digits(number)
-        sum = sum_of_all(doubles)
-        sum % 10 == 0 ? true : false
-      end
-    end
-
-    def sum_of_all(doubles)
-      doubles.inject { |sum, n| sum + n }
-    end
-
-    def all_digits(number)
-      number.to_s.split(//).map(&:to_i)
-    end
-
-    def null?(number)
-      checked_number = all_digits(number).reject! { |d| d.eql?(0) }
-      if checked_number.nil?
-        return false
-      else
-        checked_number.empty? ? true : false
-      end
-    end
-
-  end
 end

data/lib/luhn/base.rb

@@ -0,0 +1,64 @@
+class Base
+  attr_reader :number_to_validate
+
+  def initialize(number_to_validate)
+    @number_to_validate = number_to_validate
+  end
+
+  def self.valid?(number)
+    new(number).validate
+  end
+
+  def validate
+    checksum % 10 == 0 if number_meets_requirements?
+  end
+
+  def check_digit
+    checksum.to_s[-1].to_i
+  end
+
+  def checksum
+    @checksum ||= double_digit_on_even_position.inject(:+)
+  end
+
+  def double_digit_on_even_position
+    total = []
+    # Offset of 1, so you can call even? instead of odd? on a number_position
+    digits_of_number_to_validate.to_enum.with_index(1).each do |digit, number_position|
+      if number_position.even? && product_of_digit_exceeds_nine(digit)
+        digits_of_product = split_to_number_array multiply(digit)
+        total << digits_of_product.inject(:+)
+      elsif number_position.even? && !product_of_digit_exceeds_nine(digit)
+        total << multiply(digit)
+      else
+        total << digit
+      end
+    end
+    total
+  end
+
+  private
+
+  def number_meets_requirements?
+    true unless number_to_validate.class == String ||
+                number_to_validate == 0
+  end
+
+  def digits_of_number_to_validate
+    # Reverse number_to_validate to start
+    # the itteration from right to left
+    split_to_number_array(number_to_validate).reverse
+  end
+
+  def split_to_number_array(numbers)
+    numbers.to_s.split(//).map(&:to_i)
+  end
+
+  def product_of_digit_exceeds_nine(digit)
+    multiply(digit) > 9
+  end
+
+  def multiply(digit)
+    digit * 2
+  end
+end

data/lib/luhn/version.rb

@@ -1,3 +1,3 @@
 module Luhn
-  VERSION = "0.0.2"
+  VERSION = '0.0.4'
 end

data/luhn-check.gemspec

@@ -16,11 +16,9 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'minitest'
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/spec/lib/luhn/base_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Base do
+  let(:base)    { described_class.new(12345) }
+
+  describe 'attributes' do
+    it 'responds to attribute' do
+      [:number_to_validate].each do |attr|
+        expect(base).to respond_to attr
+      end
+    end
+  end
+
+  ## Class methods
+  describe '.valid?' do
+    context 'validate numbers' do
+      # Different test creditcardnumbers from: Visa,
+      # American Express, Diners Club and Mastercard
+      let(:validate_numbers) { [4556974027974373, 4539085529167499, 5247381631434707, 4111111111111111,
+                                5555555555554444, 5511828555531982, 371449635398431, 4716165622199,
+                                869940826641794, 180002230256255, 3096704907107219, 214937935327366,
+                                6011312159763625, 38442242218311] }
+
+      it 'returns true' do
+        validate_numbers.each do |number|
+          expect(described_class.valid?(number)).to be_true
+        end
+      end
+    end
+
+    context 'invalid numbers' do
+      let(:invalid_numbers) {  [3844224221831, 601111111111117, 1234123412341234, 1234567890123456, 111111,
+                                22222222222000, 1111111111111111, 00010000, 23.67, 0000000000000000, '123']}
+
+      it 'returns false' do
+        invalid_numbers.each do |number|
+          expect(described_class.valid?(number)).to be_false
+        end
+      end
+    end
+  end
+
+  ## Instance methods
+  describe '.validate' do
+    describe 'validates the checksum' do
+      context 'modulo 10 is equal to 0' do
+        before  { described_class.any_instance.
+                    stub(:checksum).and_return 60 }
+
+        it 'returns true' do
+          expect(base.validate).to be_true
+        end
+      end
+
+      context 'modulo 10 is NOT equal to 0' do
+        before  { described_class.any_instance.
+                    stub(:checksum).and_return 12 }
+
+        it 'returns false' do
+          expect(base.validate).to be_false
+        end
+      end
+    end
+  end
+
+  describe '.check_digit' do
+    before  { described_class.any_instance.
+                stub(:checksum).and_return 126 }
+
+    it 'calculates the check_digit out of the checksum' do
+      expect(base.check_digit).to eql 6
+    end
+  end
+
+  describe '.checksum' do
+    before  { described_class.any_instance.
+                stub(:double_digit_on_even_position).
+                and_return [1,2,3,4,5] }
+
+    it 'sums up the double_digit_on_even_position' do
+      expect(base.checksum).to eql 15
+    end
+  end
+
+  describe '.double_digit_on_even_position' do
+    subject { described_class.new(7992739871).double_digit_on_even_position }
+
+    describe 'reverses the numberset and on a even position of a digit' do
+      it 'doubles and sums number' do
+        expect(subject).to eql [1, 5, 8, 9, 3, 5, 2, 9, 9, 5]
+      end
+
+      context 'number ends with 0' do
+        subject { described_class.new(8960).double_digit_on_even_position }
+
+        it 'keeps the 0, doubles and sums number' do
+          expect(subject).to eql [0,3,9,7]
+        end
+      end
+    end
+  end
+end

data/spec/lib/luhn_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Luhn do
+
+  describe Base do
+    it { should be_true }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'luhn'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.order = 'random'
+end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: luhn-check
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Jan van der Pas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,15 +46,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/luhn.rb
+- lib/luhn/base.rb
 - lib/luhn/version.rb
 - luhn-check.gemspec
-- test/luhn_test.rb
-- test/test_helper.rb
+- spec/lib/luhn/base_spec.rb
+- spec/lib/luhn_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/JanDintel/luhn-check
 licenses:
 - MIT
@@ -103,10 +78,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Check a number with the Luhn algorithm
 test_files:
-- test/luhn_test.rb
-- test/test_helper.rb
+- spec/lib/luhn/base_spec.rb
+- spec/lib/luhn_spec.rb
+- spec/spec_helper.rb

data/test/luhn_test.rb

@@ -1,102 +0,0 @@
-require 'test_helper'
-
-describe 'Luhn' do
-
-  it 'returns pong' do
-    Luhn.ping.must_equal('pong')
-  end
-
-  describe 'check_digit' do
-
-    describe 'only for valid numbers' do
-
-      describe '.calculate_check_digit' do
-
-        it 'computes the check digit' do
-          Luhn.calculate_check_digit(79927398713).must_equal(3)
-          Luhn.calculate_check_digit(4539085529167499).must_equal(9)
-          Luhn.calculate_check_digit(6011312159763625).must_equal(5)
-          Luhn.calculate_check_digit(4111111111111111).must_equal(1)
-          Luhn.calculate_check_digit(180002230256255).must_equal(5)
-          Luhn.calculate_check_digit(6011312159763625).must_equal(5)
-        end
-      end
-    end
-
-    describe 'for all numbers' do
-
-      describe '.get_check_digit' do
-
-        it 'get last digit of number' do
-          Luhn.get_check_digit(123).must_equal(3)
-          Luhn.get_check_digit(7992739871).must_equal(1)
-          Luhn.get_check_digit(492965255140195).must_equal(5)
-          Luhn.get_check_digit(402400711116634).must_equal(4)
-          Luhn.get_check_digit(199600).must_equal(0)
-          Luhn.get_check_digit(4556974027974373).must_equal(3)
-        end
-      end
-    end
-  end
-
-  describe '.double_digits' do
-
-    describe 'sum is greater than 9' do
-
-      it 'computes the sum the digits of the sum' do
-        Luhn.double_digits(50).must_equal([0,1])
-        Luhn.double_digits(60).must_equal([0,3])
-        Luhn.double_digits(9).must_equal([9])
-        Luhn.double_digits(90).must_equal([0,9])
-        Luhn.double_digits(123).must_equal([3,4,1])
-        Luhn.double_digits(4992739871).must_equal([1, 5, 8, 9, 3, 5, 2, 9, 9, 8])
-        Luhn.double_digits(7992739871).must_equal([1, 5, 8, 9, 3, 5, 2, 9, 9, 5])
-      end
-    end
-
-    describe 'sum is less or equal than 9' do
-
-      it 'computes the double of the digit' do
-        Luhn.double_digits(10).must_equal([0,2])
-        Luhn.double_digits(40).must_equal([0,8])
-        Luhn.double_digits(50531).must_equal([1,6,5,0,5])
-      end
-    end
-
-  end
-
-  describe 'all 0' do
-
-    it 'rejects number with all 0' do
-      Luhn.valid?(0000000000000000).must_equal(false)
-    end
-  end
-
-  describe '.valid?' do
-
-    describe 'valid number' do
-      valid_numbers =  [4556974027974373, 4539085529167499, 5247381631434707, 4111111111111111, 5555555555554444,
-                        5511828555531982, 371449635398431, 4716165622199, 869940826641794, 180002230256255,
-                        3096704907107219, 214937935327366, 6011312159763625, 38442242218311]
-      it 'is valid' do
-        valid_numbers.each do |n|
-          Luhn.valid?(n).must_equal(true)
-        end
-      end
-
-    end
-
-    describe 'invalid number' do
-      invalid_numbers =  [3844224221831, 601111111111117, 1234123412341234, 1234567890123456, 111111, 22222222222000,
-                          1111111111111111, 00010000, 23.67, 0000000000000000]
-
-      it 'is invalid' do
-        invalid_numbers.each do |n|
-          Luhn.valid?(n).must_equal(false)
-        end
-      end
-
-    end
-  end
-
-end

data/test/test_helper.rb

@@ -1,6 +0,0 @@
-require 'luhn'
-require 'minitest/unit'
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'pry'