[feature/28] :: create mock for id registration pt br

README.md

@@ -1,6 +1,6 @@
 # Mocai
 
-![mocai](img/mocai-mascot.png)
+![mocai](img/mocai.svg)
 
 #### [README-PT](/docs/localization/pt/README-PT.md)
 

docs/localization/pt/README-PT.md

@@ -1,6 +1,6 @@
 # Mocai
 
-![mocai](../../.././img/mocai-mascot.png)
+![mocai](../../.././img/mocai.svg)
 
 Uma biblioteca Go para geração de dados de teste, permitindo criar mocks de entidades de forma simples e eficiente.
 

examples/mock_example.go

@@ -7,6 +7,7 @@ import (
 	"github.com/brazzcore/mocai/pkg/mocai/entities/address"
 	"github.com/brazzcore/mocai/pkg/mocai/entities/certificate"
 	"github.com/brazzcore/mocai/pkg/mocai/entities/company"
+	"github.com/brazzcore/mocai/pkg/mocai/entities/national_id"
 	"github.com/brazzcore/mocai/pkg/mocai/entities/person"
 	"github.com/brazzcore/mocai/pkg/mocai/entities/phone"
 	"github.com/brazzcore/mocai/pkg/mocai/entities/vote_registration"
@@ -51,25 +52,42 @@ func GenerateMockExample() {
 		return
 	}
 
+	nationalID_mock, err := national_id.GenerateNationalID(false)
+	if err != nil {
+		fmt.Print(err)
+		return
+	}
+
 	fmt.Println(constants.HeaderMain)
 	fmt.Println(constants.SubHeader)
 
 	fmt.Printf("Person: %s %s, %s, %d years old, CPF: %s\n",
 		person_mock.FirstNameMale, person_mock.LastName, person_mock.Gender, person_mock.Age, person_mock.CPF)
 
-	fmt.Printf("Birth Certificate: %s\n", certificate_mock.BrazilianCertificates.BirthCertificate.CertificateNumber)
+	fmt.Printf("RG: %s, State: %s, Issuing Body: %s\n",
+		nationalID_mock.BrazilianRG.Number, nationalID_mock.BrazilianRG.State, nationalID_mock.BrazilianRG.IssuingBody)
+
+	fmt.Printf("Birth Certificate: %s\n",
+		certificate_mock.BrazilianCertificates.BirthCertificate.CertificateNumber)
 
-	fmt.Printf("Marriage Certificate: %s\n", certificate_mock.BrazilianCertificates.MarriageCertificate.CertificateNumber)
+	fmt.Printf("Marriage Certificate: %s\n",
+		certificate_mock.BrazilianCertificates.MarriageCertificate.CertificateNumber)
 
-	fmt.Printf("Death Certificate: %s\n", certificate_mock.BrazilianCertificates.DeathCertificate.CertificateNumber)
+	fmt.Printf("Death Certificate: %s\n",
+		certificate_mock.BrazilianCertificates.DeathCertificate.CertificateNumber)
 
-	fmt.Printf("Company: %s, CNPJ: %s\n", company_mock.BrazilianCompany.CompanyName, company_mock.BrazilianCompany.CNPJ)
+	fmt.Printf("Company: %s, CNPJ: %s\n",
+		company_mock.BrazilianCompany.CompanyName, company_mock.BrazilianCompany.CNPJ)
 
 	fmt.Printf("Address: %s, %d - %s, %s (%s) - %s\n",
 		address_mock.Street, address_mock.Number, address_mock.City, address_mock.State, address_mock.UF, address_mock.ZIP)
-	fmt.Printf("Phone: (%s) %s\n", phone_mock.AreaCode, phone_mock.Number)
 
-	fmt.Printf("Voter Registration Card: Section: %s, Zone: %s, Registration: %s\n", vote_registration_mock.BrazilianVoteRegistration.Section, vote_registration_mock.BrazilianVoteRegistration.Zone, vote_registration_mock.BrazilianVoteRegistration.Number)
+	fmt.Printf("Phone: (%s) %s\n",
+		phone_mock.AreaCode, phone_mock.Number)
+
+	fmt.Printf("Voter Registration Card: Section: %s, Zone: %s, Registration: %s\n",
+		vote_registration_mock.BrazilianVoteRegistration.Section, vote_registration_mock.BrazilianVoteRegistration.Zone,
+		vote_registration_mock.BrazilianVoteRegistration.Number)
 
 	fmt.Println(constants.Footer)
 }

pkg/mocai/entities/national_id/countries/brazilian_national_id.go

@@ -0,0 +1,77 @@
+package countries
+
+import (
+	"fmt"
+	"math/rand"
+	"strconv"
+	"time"
+)
+
+var globalRand = rand.New(rand.NewSource(time.Now().UnixNano()))
+
+type RG struct {
+	Number      string
+	State       string
+	IssuingBody string
+}
+
+// GenerateBrazilianNationalID generates a valid Brazilian national ID [RG] for São Paulo.
+func GenerateBrazilianNationalID(formatted bool) (*RG, error) {
+	rgNumber, err := calculateSPRGDigit()
+	if err != nil {
+		return nil, err
+	}
+	if formatted {
+		rgNumber = formatRG(rgNumber)
+	}
+	return &RG{
+		Number:      rgNumber,
+		State:       "SP",
+		IssuingBody: "SSP - Secretaria de Seguranca Publica",
+	}, nil
+}
+
+// calculateSPRGDigit generates a valid Brazilian national ID [RG] for São Paulo.
+func calculateSPRGDigit() (string, error) {
+	// generate a random base until 8 digits
+	base := globalRand.Intn(100000000)
+	baseStr := fmt.Sprintf("%08d", base)
+
+	// slice contains the digits
+	d := make([]int, 8)
+	for i := range 8 {
+		val, err := strconv.Atoi(string(baseStr[i]))
+		if err != nil {
+			return "", ErrToConvertDigit
+		}
+		d[i] = val
+	}
+
+	// wheights from right to left: 9, 8, 7, 6, 5, 4, 3, 2
+	wheights := []int{2, 3, 4, 5, 6, 7, 8, 9}
+
+	// calculate sum
+	sum := 0
+	for i := range 8 {
+		sum += d[7-i] * wheights[i]
+	}
+
+	// calculate check digit
+	checkDigit := sum % 11
+	var dvStr string
+	if checkDigit == 10 {
+		dvStr = "X"
+	} else {
+		dvStr = strconv.Itoa(checkDigit)
+	}
+
+	full := fmt.Sprintf("%s%s", baseStr, dvStr)
+	return full, nil
+}
+
+func formatRG(rgNumber string) string {
+	if len(rgNumber) != 9 {
+		return rgNumber
+	}
+	return fmt.Sprintf("%s.%s.%s-%s", rgNumber[0:3], rgNumber[3:6], rgNumber[6:8], rgNumber[8:])
+}

pkg/mocai/entities/national_id/countries/errors.go

@@ -0,0 +1,8 @@
+package countries
+
+import "errors"
+
+var (
+	ErrGeneratingBrazilianNationalID = errors.New("error generating brazilian national id")
+	ErrToConvertDigit                = errors.New("error converting digit")
+)

pkg/mocai/entities/national_id/generator.go

@@ -0,0 +1,19 @@
+package national_id
+
+import "github.com/brazzcore/mocai/pkg/mocai/entities/national_id/countries"
+
+type NationalID struct {
+	BrazilianRG *countries.RG
+}
+
+// GenerateNationalID generates a Brazilian national ID [RG].
+// If formatted is true, the Brazilian national ID will be returned in the format XX.XXX.XXX-X.
+// if formatted is false, the Brazilian national ID will be returned as a plain string.
+func GenerateNationalID(formatted bool) (*NationalID, error) {
+	rg, err := countries.GenerateBrazilianNationalID(formatted)
+	if err != nil {
+		return nil, err
+	}
+
+	return &NationalID{BrazilianRG: rg}, nil
+}