luhn-check 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38fde38a04d580ba1a409e99ccf4d3040ed3ab6c
-  data.tar.gz: ce07177a330063ee447a983a877372ebc36e1570
+  metadata.gz: 0db0669d522c8159314dfa37ca68366ae08aa1d7
+  data.tar.gz: 6f202f812d9322c4ebd2736b42fa5792071f7103
 SHA512:
-  metadata.gz: c755af25e01c4fc9f1605f0a57503ec3918edf05fe80d3622eb1aa2664b0ec12caf1ebd6f24b5b35edef9a9b44cf2e69855285790425374cf68929ca90b5c7bf
-  data.tar.gz: 9315757d6e9df937d731ce557a742a6b939ff4873bb0e28f6d3129ec9d05f21948b990625d3d56c2866af3378543e5ea66851b093ca3000c51c567fdc6df27d7
+  metadata.gz: f77af2183203a0f98f7bb2c988b2a1972831fc81672df84bd189ce70a5f8d04d3a1d7f41730080cc7b00e729f6329821aa842bdc72b3079dc29f03cd2a3d4626
+  data.tar.gz: 91181d2deaa16bccfc3ebfa4b349b755c483e0cb0bd62650b18d2c54bd45bc229f6f7fb6822968d5c4365e2dbe3251f1fbbe11290231db0232a7582700adc873

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: 'bundle exec rspec'
+env:
+  - TRAVIS_CI=true
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'pry'
+  gem 'pry', require: false
   gem 'rspec'
+  gem 'coveralls', require: false
 end

data/README.md

@@ -1,41 +1,48 @@
 # Luhn check
 
-With the luhn-check gem you can validate a number with the Luhn algoritme.
+[![Coverage Status](https://coveralls.io/repos/JanDintel/luhn-check/badge.png?branch=master)](https://coveralls.io/r/JanDintel/luhn-check?branch=master)
+[![Build Status](https://travis-ci.org/JanDintel/luhn-check.png?branch=master)](https://travis-ci.org/JanDintel/luhn-check)
+
+With the luhn-check gem you can validate a number with the Luhn algorithm.
+This is commonly used to check validity of creditcard numbers and others.
 
 ## Installation
-### Version
-`0.0.3`
 
-###Gemfile
+In your 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. 
+```ruby
+gem 'luhn-check', '~> 0.0.3', require: 'luhn'
+```
 
-Add this line to your application's Gemfile:
+Or:
 
-    gem 'luhn-check', '~> 0.0.3', require: 'luhn'
+    $ gem install luhn-check
 
-And then execute:
+## Usage
 
-    $ bundle
+Validate a number:
 
-Or install it yourself as:
+```ruby
+Luhn.valid?(number)              #=> true or false
+Luhn.valid?(4539085529167499)    #=> true
+```
 
-    $ gem install luhn-check
+## Troubleshooting
 
-## Usage
-
-After the gem is installed. You can use this method to validate the number with the Luhn algoritme:
+### Requirements of number
+```ruby
+LuhnError::RequirementError
+```
 
-  ```ruby
-  Luhn.valid?(number)
-  ```
+The number you want to validate must be a least:
 
+* From the `Fixnum` class
+* Positive
+* Not 0 (zero)
 
 ## Contributing
-Pretty standard:
-
-1. Fork it
+1. Fork
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new pull request

data/lib/luhn.rb

@@ -1,4 +1,11 @@
+require 'luhn/version'
 require 'luhn/base'
 
 module Luhn
+  class LuhnError < StandardError; end
+  class RequirementError < LuhnError; end
+
+  def self.valid?(number)
+    Luhn::Base.valid?(number)
+  end
 end

data/lib/luhn/base.rb

@@ -1,64 +1,80 @@
-class Base
-  attr_reader :number_to_validate
+module Luhn
+  class Base
+    attr_reader :number_to_validate
 
-  def initialize(number_to_validate)
-    @number_to_validate = number_to_validate
-  end
+    def initialize(number_to_validate)
+      @number_to_validate = number_to_validate
+      number_meets_requirements?
+    end
 
-  def self.valid?(number)
-    new(number).validate
-  end
+    def self.valid?(number)
+      new(number).validate
+    end
 
-  def validate
-    checksum % 10 == 0 if number_meets_requirements?
-  end
+    def validate
+      checksum % 10 == 0
+    end
 
-  def check_digit
-    checksum.to_s[-1].to_i
-  end
+    def check_digit
+      checksum.to_s[-1].to_i
+    end
 
-  def checksum
-    @checksum ||= double_digit_on_even_position.inject(:+)
-  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
+    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
-    total
-  end
 
-  private
+    private
 
-  def number_meets_requirements?
-    true unless number_to_validate.class == String ||
-                number_to_validate == 0
-  end
+    def number_meets_requirements?
+      raise_fixnum_error    unless number_to_validate.class == Fixnum
+      raise_zero_error      if number_to_validate.zero?
+      raise_negative_error  if 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 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 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 product_of_digit_exceeds_nine(digit)
+      multiply(digit) > 9
+    end
 
-  def multiply(digit)
-    digit * 2
+    def multiply(digit)
+      digit * 2
+    end
+
+    def raise_fixnum_error
+      raise(Luhn::RequirementError, 'Number must be of Fixnum')
+    end
+
+    def raise_zero_error
+      raise(Luhn::RequirementError, 'Number is not allowed to be 0 (zero)')
+    end
+
+    def raise_negative_error
+      raise(Luhn::RequirementError, 'Number is not allowed to be negative')
+    end
   end
 end

data/lib/luhn/version.rb

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

data/luhn-check.gemspec

@@ -1,24 +1,25 @@
-# coding: utf-8
+# encoding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'luhn/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "luhn-check"
+  spec.name          = 'luhn-check'
   spec.version       = Luhn::VERSION
-  spec.authors       = ["Jan van der Pas"]
-  spec.email         = ["janvanderpas@gmail.com"]
-  spec.description   = %q{Luhn algorithm checker}
-  spec.summary       = %q{Check a number with the Luhn algorithm}
-  spec.homepage      = "https://github.com/JanDintel/luhn-check"
-  spec.license       = "MIT"
+  spec.authors       = ['Jan van der Pas']
+  spec.email         = ['janvanderpas@gmail.com']
+  spec.description   = 'A Ruby gem to validate numbers with the Luhn algoritme'
+  spec.summary       = "With the luhn-check gem you can validate a number with the Luhn algorithm. This is commonly used to check validity of creditcard numbers and others."
+  spec.homepage      = 'https://github.com/JanDintel/luhn-check'
+  spec.license       = 'MIT'
   spec.platform      = Gem::Platform::RUBY
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(spec)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
 end

data/spec/lib/luhn/base_spec.rb

@@ -1,36 +1,32 @@
 require 'spec_helper'
 
-describe Base do
-  let(:base)    { described_class.new(12345) }
+describe Luhn::Base do
+  subject { 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
+  describe 'response to attributes' do
+    it { should respond_to :number_to_validate }
   end
 
   ## Class methods
   describe '.valid?' do
-    context 'validate numbers' do
+    context 'valid numbers' do
       # Different test creditcardnumbers from: Visa,
       # American Express, Diners Club and Mastercard
-      let(:validate_numbers) { [4556974027974373, 4539085529167499, 5247381631434707, 4111111111111111,
+      let(:valid_numbers) { [4556974027974373, 4539085529167499, 5247381631434707, 4111111111111111,
                                 5555555555554444, 5511828555531982, 371449635398431, 4716165622199,
                                 869940826641794, 180002230256255, 3096704907107219, 214937935327366,
                                 6011312159763625, 38442242218311] }
 
       it 'returns true' do
-        validate_numbers.each do |number|
+        valid_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']}
+      let(:invalid_numbers) {  [3844224221831, 601111111111117, 1234123412341234, 1234567890123456,
+                                111111, 22222222222000, 1111111111111111, 00010000]}
 
       it 'returns false' do
         invalid_numbers.each do |number|
@@ -41,34 +37,44 @@ describe Base do
   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 }
+  describe 'initializing' do
+    context 'number meets the requirements' do
+      specify { expect(subject).to be_true }
+    end
 
-        it 'returns true' do
-          expect(base.validate).to be_true
-        end
+    context 'number does NOT meet the requirements' do
+      context 'is not a Fixnum' do
+        specify { expect{ described_class.new(23.67) }.to raise_error(Luhn::RequirementError, 'Number must be of Fixnum') }
+        specify { expect{ described_class.new('123') }.to raise_error(Luhn::RequirementError, 'Number must be of Fixnum') }
       end
 
-      context 'modulo 10 is NOT equal to 0' do
-        before  { described_class.any_instance.
-                    stub(:checksum).and_return 12 }
+      context 'number is 0 (zero)' do
+        specify { expect{ described_class.new(0) }.to raise_error(Luhn::RequirementError, 'Number is not allowed to be 0 (zero)') }
+      end
 
-        it 'returns false' do
-          expect(base.validate).to be_false
-        end
+      context 'number is negative' do
+        specify { expect{ described_class.new(-123) }.to raise_error(Luhn::RequirementError, 'Number is not allowed to be negative') }
       end
     end
   end
 
+  describe '.validate' do
+    context 'modulo 10 is equal to 0' do
+      before  { described_class.any_instance.stub(:checksum).and_return 60 }
+      specify { expect(subject.validate).to be_true }
+    end
+
+    context 'modulo 10 is NOT equal to 0' do
+      before  { described_class.any_instance.stub(:checksum).and_return 12 }
+      specify { expect(subject.validate).to be_false }
+    end
+  end
+
   describe '.check_digit' do
-    before  { described_class.any_instance.
-                stub(:checksum).and_return 126 }
+    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
+      expect(subject.check_digit).to eql 6
     end
   end
 
@@ -78,7 +84,7 @@ describe Base do
                 and_return [1,2,3,4,5] }
 
     it 'sums up the double_digit_on_even_position' do
-      expect(base.checksum).to eql 15
+      expect(subject.checksum).to eql 15
     end
   end
 

data/spec/lib/luhn_spec.rb

@@ -2,7 +2,10 @@ require 'spec_helper'
 
 describe Luhn do
 
-  describe Base do
-    it { should be_true }
+  describe '.valid?' do
+    it 'delegates the method to the Base class' do
+      expect(Luhn::Base).to receive(:valid?).with(12345)
+      described_class.valid?(12345)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'luhn'
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luhn-check
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jan van der Pas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Luhn algorithm checker
+description: A Ruby gem to validate numbers with the Luhn algoritme
 email:
 - janvanderpas@gmail.com
 executables: []
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -81,7 +82,8 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Check a number with the Luhn algorithm
+summary: With the luhn-check gem you can validate a number with the Luhn algorithm.
+  This is commonly used to check validity of creditcard numbers and others.
 test_files:
 - spec/lib/luhn/base_spec.rb
 - spec/lib/luhn_spec.rb