taiwanese_id_validator 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d7bc7d3ead210e4f0ada15a66981b4b70fe58139
-  data.tar.gz: 0041fce3f39879b1cfd0bfe11fe3a3f6fdd18710
+SHA256:
+  metadata.gz: 4369f6bf917fbd32056fcb9084fd6640a083f6cea7449d0212e3d87c5830f35e
+  data.tar.gz: 9bd602649636f06c50ca11a22930f7621a414285ab1a447f5927a6113946b9dd
 SHA512:
-  metadata.gz: 15c3820088f346a230802ab6723407f3ee0fa177e4af31fea9af491ed8c5ce717cacb3cc09192903713c12227530df6a90f34089003bcf9f5129a32f6e00dde5
-  data.tar.gz: 47115e8e91c29985274f7d8a475e8aa426c9e52c11661a94cdd1866c76dbd57278f2d78fa575a99a727763559f543eea5240ba6ecc18c48de70beb46f50a819b
+  metadata.gz: 8350403c7f2e5d6e80d62a193aa2d5fb46d896c07b0914309c6c718e8919123496a72550b8c321cd8596bf56cb93f09dfb197cb0738ed160c4f16cf9bcee5598
+  data.tar.gz: 11e07f4a93b054b8c47487a8d7e1891f880f1c35be44640e707f17f9abfb2af5c0d03b2477376b43a0556ad7d4329b49fbf8bc0cfc4ee840eddd927d56484c50

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## V0.0.3
+
+- Fix `TwidValidator.valid?(nil)` raise Error problem [PR#3](https://github.com/wayne5540/taiwanese_id_validator/pull/3)
+
+## V0.0.2
+
+- Support new International ID format [PR#1](https://github.com/wayne5540/taiwanese_id_validator/pull/1)
+- Upgrade bundler dependency, now requires version >= 2.2.33
+
+## V0.0.1
+
+First version

data/DEVELOPMENT.md

@@ -0,0 +1,37 @@
+## Get Started
+
+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
+
+## Run Tests
+
+`rspec`
+
+## Build the gem
+
+Build the gem:
+
+```
+gem build taiwanese_id_validator.gemspec
+```
+
+Install the gem, change the version name if needed
+
+```
+gem install ./taiwanese_id_validator-0.0.3.gem
+```
+
+Push to RubyGem
+
+```
+gem push ./taiwanese_id_validator-0.0.3.gem
+```
+
+More details about how to make the gem including build, install, push can be found [here](https://guides.rubygems.org/make-your-own-gem/)
+
+## TODOs
+
+- Support Chinese ID Validation

data/README.md

@@ -6,10 +6,10 @@
 
 ## Features
 
-* Rails model 內驗證 (Rails 3+/4)
-* Rails model 外驗證
-* 產生符合格式的身分證字號，可選擇男女
-
+- Rails model 內驗證 (Rails 3+/4/5/6/7)
+- Rails model 外驗證
+- 新式統一證號驗證
+- 產生符合格式的身分證字號，可選擇男女
 
 ## Installation
 
@@ -39,7 +39,7 @@ end
 
 #### Options
 
-* `allow_nil` or `allow_blank`
+- `allow_nil` or `allow_blank`
 
 ```ruby
 class User < ActiveRecord::Base
@@ -47,7 +47,7 @@ class User < ActiveRecord::Base
 end
 ```
 
-* Case sensitive, default is true
+- Case sensitive, default is true
 
 ```ruby
 class User < ActiveRecord::Base
@@ -55,7 +55,6 @@ class User < ActiveRecord::Base
 end
 ```
 
-
 ### Validation outside the model
 
 #### 驗證身分證字號
@@ -70,10 +69,16 @@ TwidValidator.valid?('A123456777') #=> false
 
 #### 產生假身分證字號
 
+Generator 是沒有被自動 require 的，所以要使用前要先 require:
+
 ```ruby
+require 'taiwanese_id_validator/twid_generator'
+
 TwidGenerator.generate #=> 隨機產生身分證字號
 ```
 
+可以指定要產生男性或是女性的身分證字號
+
 ```ruby
 TwidGenerator.generate("male") #=> 男性的身分證字號
 ```
@@ -82,20 +87,25 @@ TwidGenerator.generate("male") #=> 男性的身分證字號
 TwidGenerator.generate("female") #=> 女性的身分證字號
 ```
 
-## Others
+#### 驗證統一證號
+
+```ruby
+ItidValidator.valid?('A800000014') #=> true
+```
 
-[公式](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)
+```ruby
+ItidValidator.valid?('A800000015') #=> false
+```
 
+## Others
 
-## Contributing
+- [身分證公式](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)
+- [新式統一證號](https://zh.wikipedia.org/wiki/%E4%B8%AD%E8%8F%AF%E6%B0%91%E5%9C%8B%E5%B1%85%E7%95%99%E8%AD%89)
 
-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
+## Contributing
 
+Check [DEVELOPMENT.md](DEVELOPMENT.md)
 
 ## LICENSE
 
-This project rocks and uses MIT-LICENSE.
+This project rocks and uses MIT-LICENSE.

data/lib/international_id_validator/itid_mapping.rb

@@ -0,0 +1,13 @@
+module ItidMapping
+  ITID_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].freeze
+end

data/lib/international_id_validator/itid_validator.rb

@@ -0,0 +1,32 @@
+require 'international_id_validator/itid_mapping'
+
+module ItidValidator
+  def self.valid?(itid, case_sensitive = true, allow_old = false)
+    return false if !itid
+    return false if !itid.is_a?(String)
+
+    itid = itid.upcase unless case_sensitive
+
+    return false if itid.length != 10
+    return true if allow_old && itid.match?(/\A[A-Z][ABCD]\d{8}\z/)
+    return false unless itid.match?(/[A-Z](8|9)\d{8}\z/)
+
+    characters = itid.chars
+    digits = ItidMapping::ITID_LETTER[characters.shift] + characters.map(&:to_i)
+
+    checked_num = calculate_checked_num(digits)
+
+    return checked_num == digits.last
+  end
+
+  private
+
+  def self.calculate_checked_num(digits)
+    sum = 0
+    10.times do |i|
+      m = digits[i] * ItidMapping::MULTIPLIER[i]
+      sum += (m % 10)
+    end
+    10 - (sum % 10)
+  end
+end

data/lib/international_id_validator.rb

@@ -0,0 +1,25 @@
+require "international_id_validator/itid_validator"
+
+class InternationalIdValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if skip_check?
+
+    unless ItidValidator.valid?(value, case_sensitive?, allow_old?)
+      record.errors.add(attribute, (options[:message] || "is not a 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
+
+  def allow_old?
+    options[:allow_old].nil? ? false : options[:allow_old]
+  end
+end

data/lib/taiwanese_id_validator/twid_validator.rb

@@ -2,6 +2,9 @@ require 'taiwanese_id_validator/twid_mapping'
 
 module TwidValidator
   def self.valid?(twid, case_sensitive = true)
+    return false if !twid
+    return false if !twid.is_a?(String)
+
     twid = twid.upcase unless case_sensitive
 
     return false if twid.length != 10

data/lib/taiwanese_id_validator.rb

@@ -5,7 +5,7 @@ class TaiwaneseIdValidator < ActiveModel::EachValidator
     return if skip_check?
 
     unless TwidValidator.valid?(value, case_sensitive?)
-      record.errors[attribute] << (options[:message] || "is not an valid ID")
+      record.errors.add(attribute, (options[:message] || "is not a valid ID"))
     end
   end
 

data/spec/international_id_validator/itid_validator_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe ItidValidator do
+
+  describe "#valid?" do
+    context "when id not valid" do
+      it "returns false if id too short" do
+        expect( ItidValidator.valid?("A8000") ).to be false
+      end
+
+      it "returns false if id too long" do
+        expect( ItidValidator.valid?("A800000014111") ).to be false
+      end
+
+      it "returns false if id calculation is wrong" do
+        expect( ItidValidator.valid?("A800000013") ).to be false
+      end
+
+      it "returns false if format is wrong" do
+        expect( ItidValidator.valid?("YAC4713412") ).to be false
+      end
+
+      it "returns false if id is nil" do
+        expect( ItidValidator.valid?(nil) ).to be false
+      end
+
+      it "returns false if id is nil" do
+        expect( ItidValidator.valid?(1) ).to be false
+      end
+    end
+
+    context "when id is valid" do
+      let(:id) { "A800000014" }
+
+      it "returns true" do
+        expect( ItidValidator.valid?(id) ).to be true
+      end
+    end
+  end
+end

data/spec/international_id_validator_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+class ItTestUser < TestModel
+  validates :itid, international_id: true
+end
+
+class ItTestUserAllowsNil < TestModel
+  validates :itid, international_id: { allow_nil: true }
+end
+
+class ItTestUserNoCaseSensitive < TestModel
+  validates :itid, international_id: { case_sensitive: false }
+end
+
+class ItTestUserAllowOld < TestModel
+  validates :itid, international_id: { allow_old: true }
+end
+
+describe InternationalIdValidator do
+  describe "validation" do
+    context "given the valid new IDs" do
+      [
+        "A800000014"
+      ].each do |itid|
+        it "#{itid} should be valid" do
+          expect(ItTestUser.new(itid: itid)).to be_valid
+        end
+
+        it "#{itid} should be valid" do
+          expect(ItTestUserAllowsNil.new(itid: nil)).to be_valid
+        end
+
+        it "#{itid} should be valid" do
+          expect(ItTestUserNoCaseSensitive.new(itid: itid.downcase)).to be_valid
+        end
+
+        it "#{itid} should be valid" do
+          expect(ItTestUserNoCaseSensitive.new(itid: itid.downcase)).to be_valid
+        end
+      end
+    end
+
+    context "given the valid old IDs" do
+      [
+        "AD00000016"
+      ].each do |itid|
+        it "#{itid} should not be valid" do
+          expect(ItTestUser.new(itid: itid)).not_to be_valid
+        end
+
+        it "#{itid} should be valid" do
+          expect(ItTestUserAllowOld.new(itid: itid)).to be_valid
+        end
+      end
+    end
+
+    context "given the invalid IDs" do
+      [
+        "A8000014",
+        "A80000001411",
+        "Aa00000014",
+        "A800000015",
+        "a800000014"
+      ].each do |itid|
+        it "#{itid} should not be valid" do
+          expect(ItTestUser.new(itid: itid)).not_to be_valid
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'taiwanese_id_validator'
+require 'international_id_validator'
 
 class TestModel
   include ActiveModel::Validations
@@ -17,4 +18,4 @@ class TestModel
   def read_attribute_for_validation(key)
     @attributes[key]
   end
-end
+end

data/spec/taiwanese_id_validator/twid_validator_spec.rb

@@ -19,6 +19,14 @@ describe TwidValidator do
       it "returns false if format is wrong" do
         expect( TwidValidator.valid?("YAC4713412") ).to be false
       end
+
+      it "returns false if id is nil" do
+        expect( TwidValidator.valid?(nil) ).to be false
+      end
+
+      it "returns false if id is nil" do
+        expect( TwidValidator.valid?(1) ).to be false
+      end
     end
 
     context "when id is valid" do
@@ -28,8 +36,5 @@ describe TwidValidator do
         expect( TwidValidator.valid?(id) ).to be true
       end
     end
-
-    pending "case sensative"
   end
-
-end
+end

data/spec/taiwanese_id_validator_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-class TestUser < TestModel
+class TwTestUser < TestModel
   validates :twid, taiwanese_id: true
 end
 
-class TestUserAllowsNil < TestModel
+class TwTestUserAllowsNil < TestModel
   validates :twid, taiwanese_id: { allow_nil: true }
 end
 
-class TestUserNoCaseSensitive < TestModel
+class TwTestUserNoCaseSensitive < TestModel
   validates :twid, taiwanese_id: { case_sensitive: false }
 end
 
@@ -19,15 +19,15 @@ describe TaiwaneseIdValidator do
         "Y144713411"
       ].each do |twid|
         it "#{twid} should be valid" do
-          expect(TestUser.new(twid: twid)).to be_valid
+          expect(TwTestUser.new(twid: twid)).to be_valid
         end
 
         it "#{twid} should be valid" do
-          expect(TestUserAllowsNil.new(twid: nil)).to be_valid
+          expect(TwTestUserAllowsNil.new(twid: nil)).to be_valid
         end
 
         it "#{twid} should be valid" do
-          expect(TestUserNoCaseSensitive.new(twid: twid.downcase)).to be_valid
+          expect(TwTestUserNoCaseSensitive.new(twid: twid.downcase)).to be_valid
         end
       end
     end
@@ -40,10 +40,10 @@ describe TaiwaneseIdValidator do
         "Y144713410",
         "y144713411"
       ].each do |twid|
-        it "#{twid} should be valid" do
-          expect(TestUser.new(twid: twid)).not_to be_valid
+        it "#{twid} should not be valid" do
+          expect(TwTestUser.new(twid: twid)).not_to be_valid
         end
       end
     end
   end
-end
+end

data/taiwanese_id_validator.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taiwanese_id_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Wayne Chu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2024-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 2.2.33
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 2.2.33
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,24 +75,31 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
+- DEVELOPMENT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/international_id_validator.rb
+- lib/international_id_validator/itid_mapping.rb
+- lib/international_id_validator/itid_validator.rb
 - 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/international_id_validator/itid_validator_spec.rb
+- spec/international_id_validator_spec.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: ''
+homepage: https://github.com/wayne5540/taiwanese_id_validator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,9 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Taiwanese Id Validator.
 test_files: []