dixon 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd4287564dded1221c414b3d82f74530a455bc32
-  data.tar.gz: 354729bdd37756951627dda36db658f57e07c009
+  metadata.gz: a4aa8e4b5a9dc6293366fae03a4c2fb867859edf
+  data.tar.gz: e624ff4bbf6c43dbf331641e1786dd5816600524
 SHA512:
-  metadata.gz: 4fac674805c6df5e41ffdf367c56568c4abe746ebde49ae664f0c132e52434f7f21c73f57f68eb5d9ee29f51008622c8695c0599ba574a71a995813b02a3c5af
-  data.tar.gz: 766eabfa151d89352b72ba8cca0f0ee75953cc95e01021e0abfda90225353d977a54eb60b51148b162972610092b540d0a79e0a01ee1b00d8d131f97269bb37b
+  metadata.gz: ef071bc29ab77ef85174416f105e97bd7d7629f165bba2f33114605f3eaf5696a552d9019df25a132f20f7f167044b9eecb924591571702e8f35accca8ad1397
+  data.tar.gz: 628aa11550933d7e0df1efde482639811b7028df5259765441928397c116659a7625c805dfba9c6839771765632c36f900c64a1793cf2a1237127fab804d691e

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.pryrc
+.pryrc
+*.rb~

data/README.md

@@ -1,4 +1,4 @@
-# Dixon
+# Dixon [![Gem Version](https://badge.fury.io/rb/dixon.png)](http://badge.fury.io/rb/dixon)
 
 [Frank] Dixon checks your ID number.
 
@@ -41,10 +41,6 @@ Provides three instance methods: `checks`, `gender`, and `issued_by`.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## TODO
-
-* add tests.
-
 ## Author
 
 Juanito Fatas

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/dixon.gemspec

@@ -25,6 +25,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
+  # spec.add_dependency "add-your-runtime-dependency"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/lib/dixon.rb

@@ -1,3 +1,3 @@
 require 'dixon/version'
-require 'dixon/validators/helpers'
+require 'dixon/validators/helper'
 require 'dixon/validators/taiwan'

data/lib/dixon/validators/taiwan.rb

@@ -5,6 +5,7 @@ module Dixon
       INVALID_MESSAGE = 'Invalid ID number.'
 
       LETTER_ISSUED_BY = {
+        ##
         # Active Letters
         'A' => 'Taipei City'     , 'B' => 'Taichung City',
         'C' => 'Keelung City'    , 'D' => 'Tainan City',
@@ -17,6 +18,7 @@ module Dixon
         'T' => 'Pingtung County' , 'U' => 'Hualien County',
         'V' => 'Taitung County'  , 'W' => 'Kinmen County',
         'X' => 'Penghu County'   , 'Z' => 'Lienchiang County',
+        ##
         # Letters no longer issued
         'L' => 'Taichung County' ,
         'R' => 'Tainan County'   ,
@@ -35,7 +37,8 @@ module Dixon
 
       RULE_NUMBERS = [1, 9, 8, 7, 6, 5, 4, 3, 2, 1, 1]
 
-      ## Check if a given ID is valid.
+      ##
+      # Check if a given ID is valid.
       # `id` must be a string, case is insensitive.
       # First convert ID into all numbers, then multiply to RULE_NUMBERS
       # element by element. Sum up and take a 10 modulo then check
@@ -49,11 +52,11 @@ module Dixon
         # sum 1, 45,  8, 14, 43, 15, 12, 21, 10,  7, 5
         # => 180
         # 180 mod 10, is the remainder equal to zero? If so, return true.
-        #
         return (mapcar(-> (a,b) { a * b }, converted, RULE_NUMBERS).reduce(:+).divmod 10)[1] == 0
       end
 
-      ## Returns gender for given ID.
+      ##
+      # Returns gender for given ID.
       # By check the second digit of ID.
       # 1 is male, 2 is female.
       def gender(id)
@@ -64,19 +67,22 @@ module Dixon
         end
       end
 
-      ## Returns local agencies who issued your id.
+      ##
+      # Returns local agencies who issued your id.
       def issued_by(id)
         LETTER_ISSUED_BY[id[0]]
       end
 
       private
 
-      ## Convert array of strings into integer array.
+      ##
+      # Convert array of strings into integer array.
       def to_i_array(str_arr)
         str_arr.map(&:to_i)
       end
 
-      ## Convert an identification number to array of strings
+      ##
+      # Convert an identification number to array of strings
       # First letter conversion rules is defined in LETTER_NUMBERS
       # `convert 'F127337575'` will result in
       # [1, 5, 1, 2, 7, 3, 3, 7, 5, 7, 5]
@@ -84,8 +90,14 @@ module Dixon
         to_i_array((LETTER_NUMBERS[id[0]] + id[1..-1]).split(''))
       end
 
-      ## mapcar operates on successive elements of the arrays.
-      # fn is applied to the first element of each array, then to the second element of each array, and so on. The iteration terminates when the shortest array runs out, and excess elements in other arrays are ignored. The value returned by mapcar is a array of the results of successive calls to function
+      ##
+      # mapcar operates on successive elements of the arrays.
+      # fn is applied to the first element of each array,
+      # then to the secondf element of each array, and so on.
+      # The iteration terminates when the shortest array runs out,
+      # and excess elements in other arrays are ignored.
+      # The value returned by mapcar is a array of the results of
+      # successive calls to function.
       def mapcar(fn, *arrs)
         return [] if arrs.empty? or arrs.include? []
         transposed = if arrs.element_of_same_size
@@ -103,20 +115,38 @@ end
 
 module ValidateFormat
 
+  ##
+  # A123456789
   TAIWAN_ID_REGEXP = /[a-zA-Z][1|2][0-9]+/i
 
-  ## Check if given id's format is valid.
+  ##
+  # Check if given id's format is valid.
   # The current ID number has exact 10 digits
   # The first digit is one capital English letter and
   # is followed by nine Arabic numerals.
-  def valid_format?(id)
-    return true if id =~ TAIWAN_ID_REGEXP and id.size == 10
-    puts 'Invalid ID number.'
-    false
+  # returns
+  #   'Empty ID.' for empty string
+  #   'Valid ID.' if the format is correct.
+  #   otherwise, 'Invalid ID number.'
+  def validate_id_format(id)
+    id_str = id.to_s
+    return 'Empty ID.' if id_str.empty?
+    return 'Valid ID.' if id_str =~ TAIWAN_ID_REGEXP and id_str.size == 10
+    return Dixon::Validators::Taiwan::INVALID_MESSAGE
   end
 
+  ##
+  # Add a before_hook for methods that
+  # defined in literal symbol array.
   %i(checks gender issued_by convert).each do |m|
-    define_method(m) { |id| super(id) if valid_format? id }
+    define_method(m) do |id|
+      is_it_valid = validate_id_format id
+      if is_it_valid == 'Valid ID.'
+        super(id)
+      else
+        return is_it_valid
+      end
+    end
   end
 
   private :convert

data/lib/dixon/version.rb

@@ -1,3 +1,3 @@
 module Dixon
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+Bundler.require(:default)
+require 'minitest/autorun'
+require 'minitest/pride'
+require_relative '../lib/dixon'

data/test/validators/taiwan_test.rb

@@ -0,0 +1,34 @@
+  require_relative '../test_helper'
+
+class TaiwanTest < Minitest::Unit::TestCase
+
+  def setup
+    @taiwan = Dixon::Validators::Taiwan.new
+  end
+
+  def test_checks_for_empty_id
+    empty_id = ''
+    assert_equal 'Empty ID.', @taiwan.checks(empty_id)
+  end
+
+  def test_checks_for_bad_format_id
+    bad_format_id = "A12345678"
+    assert_equal 'Invalid ID number.', @taiwan.checks(bad_format_id)
+  end
+
+  def test_checks_for_gender_out_of_range_id
+    gender_out_of_range_id = "A324567945"
+    assert_equal 'Invalid ID number.', @taiwan.checks(gender_out_of_range_id)
+  end
+
+  def test_checks_for_invalid_id
+    invalid_id = "A123456788"
+    assert_equal false, @taiwan.checks(invalid_id)
+  end
+
+  def test_checks_for_valid_id
+    valid_id = 'A123456789'
+    assert_equal true, @taiwan.checks(valid_id)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dixon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Juanito Fatas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: Dixon checks your identification number!
 email:
 - katehuang0320@gmail.com
@@ -52,9 +66,11 @@ files:
 - Rakefile
 - dixon.gemspec
 - lib/dixon.rb
-- lib/dixon/validators/helpers.rb
+- lib/dixon/validators/helper.rb
 - lib/dixon/validators/taiwan.rb
 - lib/dixon/version.rb
+- test/test_helper.rb
+- test/validators/taiwan_test.rb
 homepage: https://github.com/JuanitoFatas/dixon
 licenses:
 - MIT
@@ -79,5 +95,7 @@ rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Dixon checks your identification number!
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/validators/taiwan_test.rb
 has_rdoc: