validator-nric 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a138d8840913e8bc431d4ca286c3fdf5fe35c265
+  data.tar.gz: 915f6c91440240d59a2dc1cfef77571ac6d377eb
+SHA512:
+  metadata.gz: b33edd940a4c26cd6949410e57710a6bdab1d232721c0a4d4ebc42665f7479a28d1274a0862a33623bff05a6dce8bd96cabd3c7af865d71f13d1f4b31a427771
+  data.tar.gz: f038c423f9d61015a064159dc72f91a3f560f842d351957686ba48c31d30fe6964360c55f327f4aebb5e71cc346e8e1875d6118d99702d57b5f30adc1a2344ed

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Exclude:
+    - .bundle/**
+    - validator-nric.gemspec
+
+Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in validator-nric.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 mech
+
+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,41 @@
+# Validator for Singapore NRIC
+
+A standalone NRIC validator as well as ActiveModel validator for use in your Rails models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validator-nric'
+```
+
+## Usage
+
+As a standalone validator:
+
+```ruby
+Validator::Nric.check('SXXXXXXXC') # => true or false
+```
+
+Use with ActiveModel model:
+
+```ruby
+class User < ActiveRecord::Base
+  validates :identity_card, nric: true, presence: true, uniqueness: true
+end
+```
+
+## Credits
+
+* [Wiki on NRIC](http://en.wikipedia.org/wiki/National_Registration_Identity_Card)
+* [Fun with numbers](http://www.ngiam.net/NRIC/)
+* [All about NRIC number in Singapore](http://www.arjun.com.np/blog/all-about-nric-number-in-singapore/)
+
+## Contributing
+
+1. Fork it ( https://github.com/mech/validator-nric/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/validator/nric/nric_validator.rb

@@ -0,0 +1,10 @@
+module Validator
+  module Nric
+    class NricValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        record.errors[attribute] << (options[:message] || 'is not an NRIC') \
+          unless Validator::Nric.check(value)
+      end
+    end
+  end
+end

data/lib/validator/nric/version.rb

@@ -0,0 +1,5 @@
+module Validator
+  module Nric
+    VERSION = '0.0.1'
+  end
+end

data/lib/validator/nric.rb

@@ -0,0 +1,51 @@
+require 'validator/nric/version'
+
+if defined?(ActiveModel)
+  require 'validator/nric/nric_validator'
+
+  # Play nice with ActiveModel custom validator expectation
+  NricValidator = Validator::Nric::NricValidator
+end
+
+module Validator
+  module Nric
+    module_function
+
+    # The multiplier for each individual digit
+    WEIGHT = [2, 7, 6, 5, 4, 3, 2]
+
+    # Century prefix lookup tables
+    #
+    # S - Born before 2000. S is the 19th alphabet denoting (1900 - 1999)
+    # T - Born in 2000 and beyong. (2000 - 2099??)
+    # F - Foreigners with pass issued before 2000
+    # G - Foreigners with pass issued after 2000
+    #
+    # Notice the it is backward of ABCDEFGHIZJ
+    # For T and G, there is a shift of 4 places
+    S_TABLE = %w(J Z I H G F E D C B A)
+    T_TABLE = %w(G F E D C B A J Z I H)
+    F_TABLE = %w(X W U T R Q P N M L K)
+    G_TABLE = %w(R Q P N M L K X W U T)
+
+    def mod(value)
+      ic_array = value.each_char.map(&:to_i)
+      ic_array.zip(Validator::Nric::WEIGHT).map { |a, b| a * b }.inject(:+) % 11
+    end
+
+    def lookup(century_prefix, position)
+      module_eval("#{century_prefix}_TABLE")[position]
+    end
+
+    def check(nric)
+      return false if nric.nil? || nric.size != 9
+      nric.upcase!
+
+      century_prefix = nric[0, 1]
+      ic_number = nric[1, 7]
+      check_character = nric[8, 1]
+
+      lookup(century_prefix, mod(ic_number)) == check_character
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require 'validator/nric'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+end

data/spec/validator/nric_spec.rb

@@ -0,0 +1,39 @@
+RSpec.describe Validator::Nric do
+
+  describe 'check' do
+    it 'returns false if nric is nil' do
+      expect(subject.check(nil)).to be false
+    end
+
+    it 'returns false if nric has less than 9 characters' do
+      expect(subject.check('ABC')).to be false
+    end
+  end
+
+  describe 'mod' do
+    it 'sums the product of IC number with weighted array and % 11' do
+      expect(subject.mod('1111111')).to eq 7
+    end
+
+    it 'sums the product of IC number with weighted array and % 11' do
+      expect(subject.mod('1234567')).to eq 7
+    end
+  end
+
+  describe 'lookup' do
+    it 'retrieves the compared character from lookup table' do
+      expect(subject.lookup('S', 0)).to eq 'J'
+      expect(subject.lookup('S', 1)).to eq 'Z'
+      expect(subject.lookup('S', 2)).to eq 'I'
+      expect(subject.lookup('S', 3)).to eq 'H'
+      expect(subject.lookup('S', 4)).to eq 'G'
+      expect(subject.lookup('S', 5)).to eq 'F'
+      expect(subject.lookup('S', 6)).to eq 'E'
+      expect(subject.lookup('S', 7)).to eq 'D'
+      expect(subject.lookup('S', 8)).to eq 'C'
+      expect(subject.lookup('S', 9)).to eq 'B'
+      expect(subject.lookup('S', 10)).to eq 'A'
+    end
+  end
+
+end

data/validator-nric.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validator/nric/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'validator-nric'
+  spec.version       = Validator::Nric::VERSION
+  spec.authors       = ['mech']
+  spec.email         = ['mech@me.com']
+  spec.summary       = 'Validates Singapore NRIC'
+  spec.description   = 'Global validator as well as ActiveModel validator'
+  spec.homepage      = 'https://github.com/mech/validator-nric'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: validator-nric
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: Global validator as well as ActiveModel validator
+email:
+- mech@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/validator/nric.rb
+- lib/validator/nric/nric_validator.rb
+- lib/validator/nric/version.rb
+- spec/spec_helper.rb
+- spec/validator/nric_spec.rb
+- validator-nric.gemspec
+homepage: https://github.com/mech/validator-nric
+licenses:
+- MIT
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Validates Singapore NRIC
+test_files:
+- spec/spec_helper.rb
+- spec/validator/nric_spec.rb