feat: added USA ssn module (#83)

* added USA ssn module

* missing file

* added 0 padding

* updated tests with check macro. Added ssn len test

* update tests for older versions of nim

Co-authored-by: Josh Jones <[email protected]>

Author: fishnibble

src/faker/provider.nim

@@ -17,6 +17,7 @@ import provider/misc
 import provider/person
 import provider/phone_number
 import provider/user_agent
+import provider/ssn
 
 export address
 export automotive
@@ -32,3 +33,4 @@ export misc
 export person
 export phone_number
 export user_agent
+export ssn

src/faker/provider/ssn.nim

@@ -0,0 +1,18 @@
+# ----------------------------------------------- #
+# This module was generated by 'generator' tool . #
+# See 'tools/generator'.                          #
+# ----------------------------------------------- #
+
+import ../base
+import ssn/ssn_en_US
+export base
+
+proc ssn*(f: Faker): string =
+  ## Generates random job.
+  runnableExamples:
+    let f = newFaker()
+    echo f.ssn()
+
+  case f.locale
+  of "en_US": ssn_en_US.ssn(f)
+  else: ssn_en_US.ssn(f)

src/faker/provider/ssn/interfaces.nim

@@ -0,0 +1,16 @@
+# interfaces はプロシージャの定義のみをまとめたモジュール。
+# C言語でいうヘッダファイルのように使用する。
+#
+# このモジュールをincludeしたモジュールは、このモジュールに定義しているプロシー
+# ジャを全て実装しないと、コンパイルが通らない。
+
+import random
+import std/strutils
+import strformat
+import ../../base
+export base
+
+proc ssn*(f: Faker): string
+proc areaNumber(f: Faker): string
+proc groupNumber(f: Faker): string
+proc serialNumber(f: Faker): string

src/faker/provider/ssn/ssn_en_US.nim

@@ -0,0 +1,20 @@
+include interfaces
+
+proc areaNumber(f: Faker): string =
+  var aNum = f.rand.rand(1..899)
+  if aNum == 666:
+    (if f.rand.rand(0..1) == 1: inc(aNum) else: dec(aNum))
+  return fmt"{aNum:>03}"
+
+proc groupNumber(f: Faker): string =
+  var gNum = f.rand.rand(1..99)
+  return fmt"{gNum:>02}"
+
+
+proc serialNumber(f: Faker): string =
+  let sNum = f.rand.rand(0..9999)
+  return fmt"{sNum:>04}"
+
+proc ssn*(f: Faker): string =
+  return [ $areaNumber(f), $groupNumber(f), $serialNumber(f) ].join("-")
+

tests/test_ssn_en_US.nim

@@ -0,0 +1,20 @@
+import std/unittest
+import faker
+import std/strscans
+import strutils
+
+test "SSN":
+  block:
+      checkpoint "it generates a valid ssn"
+      let fake = newFaker()
+      let ssn = fake.ssn()
+      let ssnArr = ssn.split("-")
+
+      let aNum = ssnArr[0]
+      let gNum = ssnArr[1]
+      let sNum = ssnArr[2]
+
+      check len(aNum) == 3
+      check len(gNum) == 2
+      check len(sNum) == 4
+      check len(ssn) == 11