taiwanese_id_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7bc7d3ead210e4f0ada15a66981b4b70fe58139
+  data.tar.gz: 0041fce3f39879b1cfd0bfe11fe3a3f6fdd18710
+SHA512:
+  metadata.gz: 15c3820088f346a230802ab6723407f3ee0fa177e4af31fea9af491ed8c5ce717cacb3cc09192903713c12227530df6a90f34089003bcf9f5129a32f6e00dde5
+  data.tar.gz: 47115e8e91c29985274f7d8a475e8aa426c9e52c11661a94cdd1866c76dbd57278f2d78fa575a99a727763559f543eea5240ba6ecc18c48de70beb46f50a819b

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.3
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Wayne Chu
+
+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,101 @@
+# Taiwanese Id Validator for Ruby on Rails
+
+[![Build Status](https://travis-ci.org/wayne5540/taiwanese_id_validator.svg?branch=master)](https://travis-ci.org/wayne5540/taiwanese_id_validator)
+
+台灣身分證字號 驗證&產生 的 Gem
+
+## Features
+
+* Rails model 內驗證 (Rails 3+/4)
+* Rails model 外驗證
+* 產生符合格式的身分證字號，可選擇男女
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'taiwanese_id_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install taiwanese_id_validator
+
+## Usage
+
+### Rails Model Validation
+
+#### 基本使用
+
+```ruby
+class User < ActiveRecord::Base
+  validates :twid, taiwanese_id: true
+end
+```
+
+#### Options
+
+* `allow_nil` or `allow_blank`
+
+```ruby
+class User < ActiveRecord::Base
+  validates :twid, taiwanese_id: { allow_nil: true }
+end
+```
+
+* Case sensitive, default is true
+
+```ruby
+class User < ActiveRecord::Base
+  validates :twid, taiwanese_id: { case_sensitive: false }
+end
+```
+
+
+### Validation outside the model
+
+#### 驗證身分證字號
+
+```ruby
+TwidValidator.valid?('A123456789') #=> true
+```
+
+```ruby
+TwidValidator.valid?('A123456777') #=> false
+```
+
+#### 產生假身分證字號
+
+```ruby
+TwidGenerator.generate #=> 隨機產生身分證字號
+```
+
+```ruby
+TwidGenerator.generate("male") #=> 男性的身分證字號
+```
+
+```ruby
+TwidGenerator.generate("female") #=> 女性的身分證字號
+```
+
+## Others
+
+[公式](https://zh.wikipedia.org/wiki/%E4%B8%AD%E8%8F%AF%E6%B0%91%E5%9C%8B%E5%9C%8B%E6%B0%91%E8%BA%AB%E5%88%86%E8%AD%89)
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/taiwanese_id_validator/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
+
+
+## LICENSE
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--format documentation --colour)
+end
+
+task :default => 'spec'

data/lib/taiwanese_id_validator.rb

@@ -0,0 +1,21 @@
+require "taiwanese_id_validator/twid_validator"
+
+class TaiwaneseIdValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if skip_check?
+
+    unless TwidValidator.valid?(value, case_sensitive?)
+      record.errors[attribute] << (options[:message] || "is not an valid ID")
+    end
+  end
+
+  private
+
+  def skip_check?
+    options[:allow_nil].present? || options[:allow_blank].present?
+  end
+
+  def case_sensitive?
+    options[:case_sensitive].nil? ? true : options[:case_sensitive]
+  end
+end

data/lib/taiwanese_id_validator/twid_generator.rb

@@ -0,0 +1,63 @@
+require 'taiwanese_id_validator/twid_mapping'
+
+module TwidGenerator
+  # TODO: Refactor this method first!
+  def self.generate(gender = nil)
+    sum = 0
+    twid = ""
+
+    first_letter = TwidMapping::TWID_LETTER.keys.sample
+
+    sum += TwidMapping::TWID_LETTER[first_letter][0] * TwidMapping::MULTIPLIER[0]
+    sum += TwidMapping::TWID_LETTER[first_letter][1] * TwidMapping::MULTIPLIER[1]
+
+
+    twid += first_letter.to_s
+
+    case gender
+    when "male"
+      second_letter = 1
+    when "female"
+      second_letter = 2
+    else
+      second_letter = [1, 2].sample
+    end
+    sum += second_letter * TwidMapping::MULTIPLIER[2]
+    twid += second_letter.to_s
+
+    6.times do |i|
+      letter = Random.rand(1..9)
+      sum += letter * TwidMapping::MULTIPLIER[i + 3]
+      twid += letter.to_s
+    end
+
+    if sum % 10 == 0
+      last_two_letter = Random.rand(1..9)
+      sum += last_two_letter
+      twid += last_two_letter.to_s
+
+      last_letter = 10 - last_two_letter
+      sum += last_letter
+      twid += last_letter.to_s
+    elsif sum % 10 == 9
+      last_two_letter = Random.rand(2..10)
+      sum += last_two_letter
+      twid += last_two_letter.to_s
+
+      last_letter = 11 - last_two_letter
+      sum += last_letter
+      twid += last_letter.to_s
+    else
+      max_range = 10 - (sum % 10) - 1
+      last_two_letter = Random.rand(1..max_range)
+      sum += last_two_letter
+      twid += last_two_letter.to_s
+
+      last_letter = max_range + 1 - last_two_letter
+      sum += last_letter
+      twid += last_letter.to_s
+    end
+
+    return twid
+  end
+end

data/lib/taiwanese_id_validator/twid_mapping.rb

@@ -0,0 +1,13 @@
+module TwidMapping
+  TWID_LETTER = {
+    "A" => [1, 0], "B" => [1, 1], "C" => [1, 2], "D" => [1, 3],
+    "E" => [1, 4], "F" => [1, 5], "G" => [1, 6], "H" => [1, 7],
+    "I" => [3, 4], "J" => [1, 8], "K" => [1, 9], "L" => [2, 0],
+    "M" => [2, 1], "N" => [2, 2], "O" => [3, 5], "P" => [2, 3],
+    "Q" => [2, 4], "R" => [2, 5], "S" => [2, 6], "T" => [2, 7],
+    "U" => [2, 8], "V" => [2, 9], "W" => [3, 2], "X" => [3, 0],
+    "Y" => [3, 1], "Z" => [3, 3]
+  }
+
+  MULTIPLIER = [1,9,8,7,6,5,4,3,2,1,1].freeze
+end

data/lib/taiwanese_id_validator/twid_validator.rb

@@ -0,0 +1,28 @@
+require 'taiwanese_id_validator/twid_mapping'
+
+module TwidValidator
+  def self.valid?(twid, case_sensitive = true)
+    twid = twid.upcase unless case_sensitive
+
+    return false if twid.length != 10
+    return false if !( /[A-Z](1|2)\d{8}\z/ =~ twid )
+
+    characters = twid.chars
+    digits = TwidMapping::TWID_LETTER[characters.shift] + characters.map(&:to_i)
+
+    weighted_sum = calculate_weighted_sum(digits)
+
+    return weighted_sum % 10 == 0
+  end
+
+  private
+
+  def self.calculate_weighted_sum(digits)
+    sum = 0
+    11.times do |i|
+      m = digits[i] * TwidMapping::MULTIPLIER[i]
+      sum += m
+    end
+    sum
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rspec'
+require 'active_model'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'taiwanese_id_validator'
+
+class TestModel
+  include ActiveModel::Validations
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

data/spec/taiwanese_id_validator/twid_generator_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require "taiwanese_id_validator/twid_generator"
+
+describe TwidGenerator do
+  describe "#generate" do
+    it "always generate valid ID" do
+      fake_ids = 1000.times.map do
+        TwidValidator.valid?(TwidGenerator.generate)
+      end
+
+      expect(fake_ids.all?{true}).to be true
+    end
+
+    describe "is able to fake male or female ID" do
+      context "when generate female ID" do
+        it "first number charactor should be 2" do
+          fake_id = TwidGenerator.generate("female")
+          first_number = fake_id.split(//)[1]
+
+          expect(first_number).to eq("2")
+        end
+      end
+
+      context "when generate male ID" do
+        it "first number charactor should be 1" do
+          fake_id = TwidGenerator.generate("male")
+          first_number = fake_id.split(//)[1]
+
+          expect(first_number).to eq("1")
+        end
+      end
+    end
+  end
+end
+
+

data/spec/taiwanese_id_validator/twid_validator_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe TwidValidator do
+
+  describe "#valid?" do
+    context "when id not valid" do
+      it "returns false if id too short" do
+        expect( TwidValidator.valid?("E123") ).to be false
+      end
+
+      it "returns false if id too long" do
+        expect( TwidValidator.valid?("Y144713411000") ).to be false
+      end
+
+      it "returns false if id calculation is wrong" do
+        expect( TwidValidator.valid?("Y144713412") ).to be false
+      end
+
+      it "returns false if format is wrong" do
+        expect( TwidValidator.valid?("YAC4713412") ).to be false
+      end
+    end
+
+    context "when id is valid" do
+      let(:id) { "Y144713411" }
+
+      it "returns true" do
+        expect( TwidValidator.valid?(id) ).to be true
+      end
+    end
+
+    pending "case sensative"
+  end
+
+end

data/spec/taiwanese_id_validator_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+class TestUser < TestModel
+  validates :twid, taiwanese_id: true
+end
+
+class TestUserAllowsNil < TestModel
+  validates :twid, taiwanese_id: { allow_nil: true }
+end
+
+class TestUserNoCaseSensitive < TestModel
+  validates :twid, taiwanese_id: { case_sensitive: false }
+end
+
+describe TaiwaneseIdValidator do
+  describe "validation" do
+    context "given the valid IDs" do
+      [
+        "Y144713411"
+      ].each do |twid|
+        it "#{twid} should be valid" do
+          expect(TestUser.new(twid: twid)).to be_valid
+        end
+
+        it "#{twid} should be valid" do
+          expect(TestUserAllowsNil.new(twid: nil)).to be_valid
+        end
+
+        it "#{twid} should be valid" do
+          expect(TestUserNoCaseSensitive.new(twid: twid.downcase)).to be_valid
+        end
+      end
+    end
+
+    context "given the invalid IDs" do
+      [
+        "Y144",
+        "Y1447134111",
+        "Ya44713411",
+        "Y144713410",
+        "y144713411"
+      ].each do |twid|
+        it "#{twid} should be valid" do
+          expect(TestUser.new(twid: twid)).not_to be_valid
+        end
+      end
+    end
+  end
+end

data/taiwanese_id_validator.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name          = "taiwanese_id_validator"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Wayne Chu"]
+  spec.email         = ["wayne.5540@gmail.com"]
+  spec.summary       = "Taiwanese Id Validator."
+  spec.description   = "Taiwanese Id Validator"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "activemodel"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: taiwanese_id_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wayne Chu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Taiwanese Id Validator
+email:
+- wayne.5540@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/taiwanese_id_validator.rb
+- lib/taiwanese_id_validator/twid_generator.rb
+- lib/taiwanese_id_validator/twid_mapping.rb
+- lib/taiwanese_id_validator/twid_validator.rb
+- spec/spec_helper.rb
+- spec/taiwanese_id_validator/twid_generator_spec.rb
+- spec/taiwanese_id_validator/twid_validator_spec.rb
+- spec/taiwanese_id_validator_spec.rb
+- taiwanese_id_validator.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Taiwanese Id Validator.
+test_files: []