rn 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 2.0.0@rn

data/.travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree
+  - jruby-head
+  - jruby-19mode
+  - jruby-18mode
+  - rbx-19mode
+  - rbx-18mode
+gemfile:
+  - gemfiles/3.2.gemfile
+  - gemfiles/4.0.gemfile
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/4.0.gemfile
+    - rvm: 1.8.7
+      gemfile: gemfiles/4.0.gemfile
+    - rvm: ree
+      gemfile: gemfiles/4.0.gemfile
+    - rvm: jruby-18mode
+      gemfile: gemfiles/4.0.gemfile
+    - rvm: rbx-18mode
+      gemfile: gemfiles/4.0.gemfile

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rn.gemspec
+gemspec
+
+gem 'activemodel', '~> 4.0.0.beta1'

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ralph Rooding
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+[![Build Status](https://travis-ci.org/rrooding/rn.png?branch=master)](https://travis-ci.org/rrooding/rn)
+[![Code Climate](https://codeclimate.com/github/rrooding/rn.png)](https://codeclimate.com/github/rrooding/rn)
+
+# Rn
+
+This gem adds a validator for the Belgium government registration numbers (also known as *rijksregisternummer* or *RN* for short). You can use it to check if the registration number is a valid number, you can also optionally check against a users birthday.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rn'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rn
+
+## Usage
+
+Using the RnValidator:
+
+	class User < ActiveRecord::Base
+		validates :number, rn: true
+	end
+
+This will only check if the number conforms to the rules specified by the Belgian government.
+
+You can also validate against the users birthday:
+
+	class User < ActiveRecord::Base
+		validates :number, rn: { birthday: true }
+	end
+
+This will look for the users birthday in the `birthday` property which has to be a `Date`. If you want to use another method or column, you can do that as follows:
+
+	class User < ActiveRecord::Base
+		validates :number, rn: { birthday: true, birthday_column: :date_of_birth }
+	end
+	
+## I18n
+
+Add the following to your locale file:
+
+	en:
+		activemodel:
+			errors:
+				models:
+					MODEL:
+						attributes:
+							ATTRIBUTE:
+								invalid_registration_number: 'is not a valid registration number'
+								no_matching_birthday: 'does not match birthday'
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run rspec'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/gemfiles/3.2.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 3.2.13'
+gem 'rn', :path => '../'
+
+gemspec :path => '../'

data/gemfiles/4.0.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 4.0.0.beta1'
+gem 'rn', :path => '../'
+
+gemspec :path => '../'

data/lib/rn.rb

@@ -0,0 +1,3 @@
+require 'rn/version'
+require 'rn/registration_number'
+require 'rn/validator'

data/lib/rn/registration_number.rb

@@ -0,0 +1,46 @@
+require 'date'
+
+module Rn
+  class RegistrationNumber
+    def initialize(registration_number)
+      raise ArgumentError.new('cannot be empty') if registration_number.nil? || registration_number.empty?
+      raise ArgumentError.new('must be 11 characters') if registration_number.length != 11
+      raise ArgumentError.new('can only contain 0-9') unless (registration_number =~ /\D/).nil?
+
+      @number = registration_number
+
+      @year, @month, @day, @follow, @control = @number.scan(/\A(\d{2})(\d{2})(\d{2})(\d{3})(\d{2})\z/).flatten
+    end
+
+    def birthday
+      @birthday ||= parse_birthday
+    end
+
+    def valid?
+      pre_2000_control? || post_2000_control?
+    end
+
+    private
+
+    def parse_birthday
+      base = pre_2000_control? ? 1900 : 2000
+      Date.new(@year.to_i + base, @month.to_i, @day.to_i)
+    end
+
+    def pre_2000_control?
+      @control.to_i == 97 - (control_sequence.to_i % 97)
+    end
+
+    def post_2000_control?
+      @control.to_i == 97 - (extended_control_sequence.to_i % 97)
+    end
+
+    def control_sequence
+      [@year, @month, @day, @follow].join
+    end
+
+    def extended_control_sequence
+      ['2', control_sequence].join
+    end
+  end
+end

data/lib/rn/validator.rb

@@ -0,0 +1,22 @@
+require 'active_model'
+require 'active_model/validations'
+
+class RnValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    check_birthday = options.fetch(:birthday, false)
+    birthday_accessor = options.fetch(:birthday_column, :birthday)
+
+    begin
+      number = Rn::RegistrationNumber.new(value)
+
+      record.errors.add(attribute, :invalid_registration_number, options) unless number.valid?
+
+      if check_birthday
+        birthday = record.send(birthday_accessor)
+        record.errors.add(attribute, :no_matching_birthday, options) if number.birthday != birthday
+      end
+    rescue ArgumentError => e
+      record.errors.add(attribute, e.message, options)
+    end
+  end
+end

data/lib/rn/version.rb

@@ -0,0 +1,3 @@
+module Rn
+  VERSION = "0.0.1"
+end

data/rn.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rn/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rn"
+  gem.version       = Rn::VERSION
+  gem.authors       = ["Ralph Rooding"]
+  gem.email         = ["ralph@izerion.com"]
+  gem.description   = %q{Rails validations for Belgian Government Registration Numbers (Rijksregisternummer)}
+  gem.summary       = %q{Rails validations for Belgian Government Registration Numbers (Rijksregisternummer)}
+  gem.homepage      = "https://github.com/rrooding/rn"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard-rspec'
+end

data/spec/rn/registration_number_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Rn::RegistrationNumber do
+  subject { described_class.new(number) }
+
+  let(:number) { '86100500176' }
+
+  context 'invalid arguments' do
+    describe 'nil' do
+      it 'raises an argument error' do
+        expect { described_class.new(nil) }.to raise_error(ArgumentError, 'cannot be empty')
+      end
+    end
+
+    describe 'empty string' do
+      it 'raises an argument error' do
+        expect { described_class.new('') }.to raise_error(ArgumentError, 'cannot be empty')
+      end
+    end
+
+    describe 'with non numeric characters' do
+      it 'raises an argument error' do
+        expect { described_class.new('1234567aa89') }.to raise_error(ArgumentError, 'can only contain 0-9')
+      end
+    end
+
+    describe 'too short' do
+      it 'raises an argument error' do
+        expect { described_class.new('1234567890') }.to raise_error(ArgumentError, 'must be 11 characters')
+      end
+    end
+
+    describe 'too long' do
+      it 'raises an argument error' do
+        expect { described_class.new('123456789012') }.to raise_error(ArgumentError, 'must be 11 characters')
+      end
+    end
+  end
+
+  describe '#birthday' do
+    context '< 2000' do
+      it 'is extracted' do
+        expect(subject.birthday).to eq Date.parse('05-10-1986')
+      end
+    end
+
+    context '= 2000' do
+      let(:number) { '00100500145' }
+
+      it 'is extracted' do
+        expect(subject.birthday).to eq Date.parse('05-10-2000')
+      end
+    end
+
+    context '> 2000' do
+      let(:number) { '10100500161' }
+
+      it 'is extracted' do
+        expect(subject.birthday).to eq Date.parse('05-10-2010')
+      end
+    end
+  end
+
+  describe '#valid?' do
+    context '< 2000' do
+      context 'valid registration number' do
+        it 'returns true' do
+          expect(subject).to be_valid
+        end
+      end
+
+      context 'invalid registration number' do
+        let(:number) { '86100500177' } # control + 1
+
+        it 'returns false' do
+          expect(subject).to_not be_valid
+        end
+      end
+    end
+
+    context '= 2000' do
+      context 'valid registration number' do
+        let(:number) { '00100500145' }
+
+        it 'returns true' do
+          expect(subject).to be_valid
+        end
+      end
+
+      context 'invalid registration number' do
+        let(:number) { '00100500146' } # control + 1
+
+        it 'returns false' do
+          expect(subject).to_not be_valid
+        end
+      end
+    end
+
+    context '> 2000' do
+      context 'valid registration number' do
+        let(:number) { '10100500161' }
+
+        it 'returns true' do
+          expect(subject).to be_valid
+        end
+      end
+
+      context 'invalid registration number' do
+        let(:number) { '10100500162' } # control + 1
+
+        it 'returns false' do
+          expect(subject).to_not be_valid
+        end
+      end
+    end
+  end
+end

data/spec/rn_validator_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+class RnValidatorBase
+  include ActiveModel::Validations
+  attr_accessor :number
+end
+
+class RnValidatorTest < RnValidatorBase
+  validates :number, :rn => true
+end
+
+class RnValidatorBirthday < RnValidatorBase
+  attr_accessor :birthday
+  validates :number, :rn => { :birthday => true }
+end
+
+describe RnValidator do
+  subject { RnValidatorTest.new }
+
+  context 'valid number' do
+    before do
+      subject.number = '86100500176'
+    end
+
+    it 'is valid' do
+      expect(subject).to be_valid
+    end
+  end
+
+  context 'invalid control' do
+    before do
+      subject.number = '86100500177' # control + 1
+
+      subject.valid?
+    end
+
+    it 'is invalid' do
+      expect(subject).to_not be_valid
+    end
+
+    it 'adds an error on :number' do
+      expect(subject.errors[:number]).to be_present
+    end
+  end
+
+  context 'invalid number' do
+    before do
+      subject.number = '1234'
+
+      subject.valid?
+    end
+
+    it 'is invalid' do
+      expect(subject).to_not be_valid
+    end
+
+    it 'adds an error on :number' do
+      expect(subject.errors[:number]).to be_present
+    end
+  end
+
+  context 'blank number' do
+    before do
+      subject.number = ''
+
+      subject.valid?
+    end
+
+    it 'is invalid' do
+      expect(subject).to_not be_valid
+    end
+
+    it 'adds an error on :number' do
+      expect(subject.errors[:number]).to be_present
+    end
+  end
+
+  context 'nil number' do
+    before do
+      subject.number = nil
+
+      subject.valid?
+    end
+
+    it 'is invalid' do
+      expect(subject).to_not be_valid
+    end
+
+    it 'adds an error on :number' do
+      expect(subject.errors[:number]).to be_present
+    end
+  end
+
+  context 'with birthday check' do
+    subject { RnValidatorBirthday.new }
+
+    before do
+      subject.number = '86100500176'
+    end
+
+    context 'with matching birthday' do
+      before do
+        subject.birthday = Date.parse('05-10-1986')
+      end
+
+      it 'is valid' do
+        expect(subject).to be_valid
+      end
+    end
+
+    context 'with different birthday' do
+      before do
+        subject.birthday = Date.parse('06-10-1986')
+
+        subject.valid?
+      end
+
+      it 'is invalid' do
+        expect(subject).to_not be_valid
+      end
+
+      it 'adds an error on :number' do
+        expect(subject.errors[:number]).to be_present
+      end
+    end
+
+    context 'with empty birthday' do
+      before do
+        subject.birthday = nil
+
+        subject.valid?
+      end
+
+      it 'is invalid' do
+        expect(subject).to_not be_valid
+      end
+
+      it 'adds an error on :number' do
+        expect(subject.errors[:number]).to be_present
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'rspec'
+require 'rn'
+
+RSpec.configure do |config|
+  config.before :each do
+  end
+
+  config.after :each do
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ralph Rooding
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails validations for Belgian Government Registration Numbers (Rijksregisternummer)
+email:
+- ralph@izerion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/3.2.gemfile
+- gemfiles/4.0.gemfile
+- lib/rn.rb
+- lib/rn/registration_number.rb
+- lib/rn/validator.rb
+- lib/rn/version.rb
+- rn.gemspec
+- spec/rn/registration_number_spec.rb
+- spec/rn_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rrooding/rn
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rails validations for Belgian Government Registration Numbers (Rijksregisternummer)
+test_files:
+- spec/rn/registration_number_spec.rb
+- spec/rn_validator_spec.rb
+- spec/spec_helper.rb