tsubaki 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6670c698e5b096b76addb7bbd8ced4ea7c615543
-  data.tar.gz: 4e011f826744fc43867213bd393a2f7684d1b2f1
+  metadata.gz: 610420f558197c1c9c9caea8f6dc1ae4f6bc507b
+  data.tar.gz: 482b6a9fecb8cc423fdaa606242b26b5bfa53889
 SHA512:
-  metadata.gz: af07b276c392ad68c61b9ea826a8b383bbb8295c44c1a6381b4dbdc80499d19008c49cc0ab76b2bda9629f078464fdac06554f8fe301332ac820e7ec1e378a28
-  data.tar.gz: bcb7c76f100c94da586d05c07f74fc29161527fdb6aafa88d9a1c99e16f13c8e1c4ecf30321e9c9f878397afd34c87effa0f2b8863e3f00c5754b31b840514ed
+  metadata.gz: 9bc874bf0b0e19329bf29fc03a61e65e808847bf827c96a5d72b1cf594147eefc8e68206b00d2bf257ac00531d9bd7d5f1dd1b75f9eea917bad0b57da4ca1532
+  data.tar.gz: 5beea1081c4357a8cb759ab6788079e9433104e79129d769466809ed49140413885b75b9d7c50f599ab40be9fdf64779ec9e11535a5654063137503ba36c63c0

data/.rubocop.yml

@@ -13,4 +13,7 @@ Style/DoubleNegation:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 18
+  Max: 18
+
+Metrics/ClassLength:
+  Max: 200

data/README.md

@@ -1,13 +1,10 @@
 # Tsubaki
 
-[![Circle CI](https://circleci.com/gh/kakipo/tsubaki/tree/master.svg?style=svg)](https://circleci.com/gh/kakipo/tsubaki/tree/master)
+[![Circle CI](https://circleci.com/gh/kufu/tsubaki/tree/master.svg?style=svg)](https://circleci.com/gh/kufu/tsubaki/tree/master)
 
-Each resident in Japan will be notified of his or her own Individual Number (a.k.a. "My Number") beginning in October 2015.
+Each resident in Japan will be notified of his or her own Individual Number (a.k.a. "My Number") beginning in October 2015, and each company will be given its own Corporate Number likewise.
 
-A My Number consists of 12 digits & the last digit is used as a check digit.
-This gem provides My Number validator which inspects the format and (optionally) the check digit.  
-
-(We plan to implement other social security related code validators such as a basic pension number validator later.)
+This gem provides both My Number and Corporate Number validators which inspect the format and (optionally) the check digit.  
 
 ## Installation
 
@@ -27,38 +24,86 @@ Or install it yourself as:
 
 ## Usage
 
-Add the following to your model:
+
+### My Number
+
+A My Number consists of 12 digits & the last digit is used as a check digit.
+
+To validate the format of an attribute, add the following to your model:
 
 ```ruby
-validates :my_number, my_number: true
+# Verifies the format and its check digit with `strict` option:
+validates :digits, my_number: { strict: true }, allow_nil: true
+
+# Without strict option, it verifies only the length of the digits:
+validates :digits, my_number: true
+
+# Or if a My Number contains any dividers, specify it:
+validates :digits, my_number: { strict: true, divider: '-' } # => 4652-8126-6333 should be valid
 ```
 
-## Verify the check digit
+### Corporate Number
+
+A Corporate Number consists of 13 digits & the first digit is used as a check digit.
 
-In order to have stricter validation which verifies the check digit, enable strict mode.
+To validate the format of an attribute, add the following to your model:
 
 ```ruby
-validates :my_number, my_number: { strict: true }
+# Verifies the format and its check digit with `strict` option:
+validates :digits, corporate_number: { strict: true }, allow_nil: true
+
+# Without strict option, it verifies only the length of the digits:
+validates :digits, corporate_number: true
+
+# Or if a Corporate Number contains any dividers, specify it:
+validates :digits, corporate_number: { strict: true, divider: '-' } # => 5-8356-7825-6246 should be valid
 ```
 
-See: [行政手続における特定の個人を識別するための番号の利用等に関する法律の規定による通知カード及び個人番号カード並びに情報提供ネットワークシステムによる特定個人情報の提供等に関する省令](http://law.e-gov.go.jp/announce/H26F11001000085.html)
 
-## Divider
 
-If a My Number contains any dividers, specify it.
+## Goodies
+
+### Rspec matchers
+
+To ensure appropriate validations are specified, Tsubaki includes rspec matchers.
 
 ```ruby
-# 1111-2222-3333-4444 should be valid
-validates :my_number, my_number: { divider: '-' }
+# In spec_helper.rb, you'll need to require the matchers:
+require 'tsubaki/matchers'
+
+# And include the module:
+RSpec.configure do |config|
+  config.include Tsubaki::Shoulda::Matchers
+end
 ```
 
-## Goodies
+```ruby
+describe User do
+  # For My Number validation
+  it { should validate_my_number_of(:digits) }
+
+  # To ensure options:
+  it { should validate_validate_my_number_of(:digits).strict.with_divider('-').allow_nil }
+end
+
+describe Company do
+  # For Corporate Number validation
+  it { should validate_corporate_number_of(:digits) }
+
+  # To ensure options:
+  it { should validate_validate_corporate_number_of(:digits).strict.with_divider('-') }
+end
+```
+
+
+### Random number generators
 
-You can obtain a random yet having right check digit My Number.
+You can obtain a random yet having right check digit numbers.
 This is useful when creating dummy records.
 
 ```ruby
 Tsubaki::MyNumber.rand # => 765895492872
+Tsubaki::CorporateNumber.rand # => 5868731863533
 ```
 
 ## Development
@@ -69,7 +114,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kakipo/tsubaki.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kufu/tsubaki.
 
 
 ## License

data/lib/tsubaki/corporate_number.rb

@@ -0,0 +1,46 @@
+module Tsubaki
+  class CorporateNumber
+    def self.rand
+      digits = 12.times.map { Kernel.rand(10) }.join
+      check_digit = calc_check_digit(digits)
+      "#{check_digit}#{digits}"
+    end
+
+    def self.calc_check_digit(digits)
+      fail 'must be a 12 digit number' unless digits =~ /\A\d{12}\z/
+
+      arr = digits.chars.map(&:to_i).reverse!
+      rem = (1..12).inject(0) do |sum, n|
+        pn = arr[n - 1]
+        qn = n.odd? ? 1 : 2
+        sum + pn * qn
+      end % 9
+
+      9 - rem
+    end
+
+    def initialize(digits, options = {})
+      @digits = digits.to_s.freeze
+      @options = options
+    end
+
+    def valid?
+      @options[:strict] ? valid_check_digit? : valid_pattern?
+    end
+
+    def valid_pattern?
+      !!(plain_digits =~ /\A\d{13}\z/)
+    end
+
+    def valid_check_digit?
+      return false unless valid_pattern?
+      plain_digits[0].to_i == self.class.calc_check_digit(plain_digits[1, 12]).to_i
+    end
+
+    private
+
+    def plain_digits
+      @plain_digits ||= @digits.split(@options[:divider]).join('')
+    end
+  end
+end

data/lib/tsubaki/corporate_number_validator.rb

@@ -0,0 +1,13 @@
+require 'active_model'
+require 'active_model/validator'
+
+module Tsubaki
+  class CorporateNumberValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      return if Tsubaki::CorporateNumber.new(value, options).valid?
+      record.errors.add(attribute, options[:message] || :invalid)
+    end
+  end
+end
+
+ActiveModel::Validations::CorporateNumberValidator = Tsubaki::CorporateNumberValidator

data/lib/tsubaki/matchers/validate_corporate_number_of_matcher.rb

@@ -0,0 +1,157 @@
+module Tsubaki
+  module Shoulda
+    module Matchers
+      # Ensures that the given instance or class validates the format of
+      # the corporate number as specified.
+      #
+      # Example:
+      #   describe Corporation do
+      #     it { should validate_corporate_number_of(:digits)
+      #     it { should validate_corporate_number_of(:digits).strict.with_divider('-') }
+      #   end
+      def validate_corporate_number_of(attribute_name)
+        ValidateCorporateNumberOfMatcher.new(attribute_name)
+      end
+
+      class ValidateCorporateNumberOfMatcher
+        def initialize(attribute_name)
+          @attribute_name = attribute_name
+          @options = {}
+          @options[:strict] = nil
+          @options[:divider] = nil
+          @options[:allow_nil] = nil
+          @failure_messages = []
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          @subject = @subject.new if @subject.class == Class
+          (error_when_not_valid + no_error_when_valid).all?
+        end
+
+        def failure_message
+          @failure_messages.join("\n")
+        end
+
+        def description
+          result = 'ensure corporate number format'
+          result << " for #{@attribute_name}"
+          result << ' with strict mode' if @options[:strict].present?
+          result << " with divider '#{@options[:divider]}'" if @options[:divider].present?
+          result << ' and allow nil' if @options[:allow_nil].present?
+          result
+        end
+
+        def strict(strict = true)
+          @options[:strict] = strict
+          self
+        end
+
+        def with_divider(divider)
+          @options[:divider] = divider
+          self
+        end
+
+        def allow_nil(allow_nil = true)
+          @options[:allow_nil] = allow_nil
+          self
+        end
+
+        protected
+
+        def error_when_not_valid
+          [error_test_allow_nil, error_test_strict, error_test_divider, error_test]
+        end
+
+        def no_error_when_valid
+          [no_error_test_allow_nil, no_error_test_strict, no_error_test_divider, no_error_test]
+        end
+
+        private
+
+        def valid_attribute_with?(value)
+          dup_subject = @subject.dup
+          dup_subject.send("#{@attribute_name}=", value)
+          dup_subject.valid?
+          dup_subject.errors[@attribute_name].blank?
+        end
+
+        def error_test_allow_nil
+          true
+        end
+
+        def error_test_strict
+          return true if @options[:strict].nil?
+
+          if valid_attribute_with?('1111111111111')
+            @failure_messages << 'strict mode is not be specified'
+            false
+          else
+            true
+          end
+        end
+
+        def error_test_divider
+          return true if @options[:divider].nil?
+
+          dummy_divider = @options[:divider].succ
+          invalid_corporate_number = "7#{dummy_divider}1234#{dummy_divider}5678#{dummy_divider}9012"
+
+          if valid_attribute_with?(invalid_corporate_number)
+            @failure_messages << "divider is not be specified or is not '#{@options[:divider]}'"
+            false
+          else
+            true
+          end
+        end
+
+        def error_test
+          if valid_attribute_with?('xaaaabbbbcccc')
+            @failure_messages << 'corporate number validation is not specified'
+            false
+          else
+            true
+          end
+        end
+
+        def no_error_test_allow_nil
+          return true if @options[:allow_nil].nil?
+
+          if !valid_attribute_with?(nil)
+            @failure_messages << 'allow_nil is not be specified'
+            false
+          else
+            true
+          end
+        end
+
+        def no_error_test_strict
+          true
+        end
+
+        def no_error_test_divider
+          return true if @options[:divider].nil?
+
+          valid_corporate_number = "7#{@options[:divider]}1234#{@options[:divider]}5678#{@options[:divider]}9012"
+
+          if !valid_attribute_with?(valid_corporate_number)
+            @failure_messages << "divider is not be specified or is not '#{@options[:divider]}'"
+            false
+          else
+            true
+          end
+        end
+
+        def no_error_test
+          if !valid_attribute_with?('7123456789012')
+            @failure_messages << 'corporate number validation is not specified'
+            false
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tsubaki/matchers/validate_my_number_of_matcher.rb

@@ -0,0 +1,157 @@
+module Tsubaki
+  module Shoulda
+    module Matchers
+      # Ensures that the given instance or class validates the format of
+      # the my number as specified.
+      #
+      # Example:
+      #   describe User do
+      #     it { should validate_my_number_of(:digits)
+      #     it { should validate_my_number_of(:digits).strict.with_divider('-') }
+      #   end
+      def validate_my_number_of(attribute_name)
+        ValidateMyNumberOfMatcher.new(attribute_name)
+      end
+
+      class ValidateMyNumberOfMatcher
+        def initialize(attribute_name)
+          @attribute_name = attribute_name
+          @options = {}
+          @options[:strict] = nil
+          @options[:divider] = nil
+          @options[:allow_nil] = nil
+          @failure_messages = []
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          @subject = @subject.new if @subject.class == Class
+          (error_when_not_valid + no_error_when_valid).all?
+        end
+
+        def failure_message
+          @failure_messages.join("\n")
+        end
+
+        def description
+          result = 'ensure my number format'
+          result << " for #{@attribute_name}"
+          result << ' with   strict mode' if @options[:strict].present?
+          result << " with divider '#{@options[:divider]}'" if @options[:divider].present?
+          result << ' and allow nil' if @options[:allow_nil].present?
+          result
+        end
+
+        def strict(strict = true)
+          @options[:strict] = strict
+          self
+        end
+
+        def with_divider(divider)
+          @options[:divider] = divider
+          self
+        end
+
+        def allow_nil(allow_nil = true)
+          @options[:allow_nil] = allow_nil
+          self
+        end
+
+        protected
+
+        def error_when_not_valid
+          [error_test_allow_nil, error_test_strict, error_test_divider, error_test]
+        end
+
+        def no_error_when_valid
+          [no_error_test_allow_nil, no_error_test_strict, no_error_test_divider, no_error_test]
+        end
+
+        private
+
+        def valid_attribute_with?(value)
+          dup_subject = @subject.dup
+          dup_subject.send("#{@attribute_name}=", value)
+          dup_subject.valid?
+          dup_subject.errors[@attribute_name].blank?
+        end
+
+        def error_test_allow_nil
+          true
+        end
+
+        def error_test_strict
+          return true if @options[:strict].nil?
+
+          if valid_attribute_with?('111111111111')
+            @failure_messages << 'strict mode is not be specified'
+            false
+          else
+            true
+          end
+        end
+
+        def error_test_divider
+          return true if @options[:divider].nil?
+
+          dummy_divider = @options[:divider].succ
+          invalid_my_number = "9656#{dummy_divider}7219#{dummy_divider}7231"
+
+          if valid_attribute_with?(invalid_my_number)
+            @failure_messages << "divider is not be specified or is not '#{@options[:divider]}'"
+            false
+          else
+            true
+          end
+        end
+
+        def error_test
+          if valid_attribute_with?('aaaabbbbcccc')
+            @failure_messages << 'my number validation is not specified'
+            false
+          else
+            true
+          end
+        end
+
+        def no_error_test_allow_nil
+          return true if @options[:allow_nil].nil?
+
+          if !valid_attribute_with?(nil)
+            @failure_messages << 'allow_nil is not be specified'
+            false
+          else
+            true
+          end
+        end
+
+        def no_error_test_strict
+          true
+        end
+
+        def no_error_test_divider
+          return true if @options[:divider].nil?
+
+          valid_my_number = "9656#{@options[:divider]}7219#{@options[:divider]}7231"
+
+          if !valid_attribute_with?(valid_my_number)
+            @failure_messages << "divider is not be specified or is not '#{@options[:divider]}'"
+            false
+          else
+            true
+          end
+        end
+
+        def no_error_test
+          if !valid_attribute_with?('965672197231')
+            @failure_messages << 'my number validation is not specified'
+            false
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tsubaki/matchers.rb

@@ -0,0 +1,52 @@
+require 'tsubaki/matchers/validate_my_number_of_matcher'
+require 'tsubaki/matchers/validate_corporate_number_of_matcher'
+
+module Tsubaki
+  module Shoulda
+    # Provides RSpec-compatible & Test::Unit-compatible matchers for testing Tsubaki modules.
+    #
+    # *RSpec*
+    #
+    # In spec_helper.rb, you'll need to require the matchers:
+    #
+    #   require "tsubaki/matchers"
+    #
+    # And _include_ the module:
+    #
+    #   RSpec.configure do |config|
+    #     config.include Tsubaki::Shoulda::Matchers
+    #   end
+    #
+    # Example:
+    #   describe User do
+    #     it { should validate_my_number_of(:digits) }
+    #     it { should validate_validate_my_number_of(:digits).strict.with_divider('-') }
+    #   end
+    #
+    #
+    # *TestUnit*
+    #
+    # In test_helper.rb, you'll need to require the matchers as well:
+    #
+    #   require "tubaki/matchers"
+    #
+    # And _extend_ the module:
+    #
+    #   class ActiveSupport::TestCase
+    #     extend Tsubaki::Shoulda::Matchers
+    #
+    #     #...other initializers...#
+    #   end
+    #
+    # Example:
+    #   require 'test_helper'
+    #
+    #   class UserTest < ActiveSupport::TestCase
+    #     should validate_validate_my_number_of(:digits)
+    #     should validate_validate_my_number_of(:digits).strict.with_divider('-')
+    #   end
+    #
+    module Matchers
+    end
+  end
+end

data/lib/tsubaki/version.rb

@@ -1,3 +1,3 @@
 module Tsubaki
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/tsubaki.rb

@@ -1,7 +1,8 @@
 require 'tsubaki/version'
 require 'tsubaki/my_number'
 require 'tsubaki/my_number_validator'
+require 'tsubaki/corporate_number'
+require 'tsubaki/corporate_number_validator'
 
 module Tsubaki
-  # Your code goes here...
 end

data/tsubaki.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ['kakipo@gmail.com']
 
   spec.summary       = 'Japanese soocial security code validators.'
-  spec.description   = 'A gem provides several social security code validators such as My Number validator, Basic Pension Number validator.'
-  spec.homepage      = 'https://github.com/kakipo/tsubaki'
+  spec.description   = 'A gem provides My Number & Corporate Number validators'
+  spec.homepage      = 'https://github.com/kufu/tsubaki'
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tsubaki
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - kakipo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,8 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A gem provides several social security code validators such as My Number
-  validator, Basic Pension Number validator.
+description: A gem provides My Number & Corporate Number validators
 email:
 - kakipo@gmail.com
 executables: []
@@ -144,11 +143,16 @@ files:
 - bin/setup
 - circle.yml
 - lib/tsubaki.rb
+- lib/tsubaki/corporate_number.rb
+- lib/tsubaki/corporate_number_validator.rb
+- lib/tsubaki/matchers.rb
+- lib/tsubaki/matchers/validate_corporate_number_of_matcher.rb
+- lib/tsubaki/matchers/validate_my_number_of_matcher.rb
 - lib/tsubaki/my_number.rb
 - lib/tsubaki/my_number_validator.rb
 - lib/tsubaki/version.rb
 - tsubaki.gemspec
-homepage: https://github.com/kakipo/tsubaki
+homepage: https://github.com/kufu/tsubaki
 licenses:
 - MIT
 metadata: