[feature/47] :: applied the camelcase naming convention

README.md

@@ -63,7 +63,7 @@ func GenerateMockExample() {
 ```
 
 ### Examples
-The ***examples*** folder contains samples of how to use the library. To run the examples, navigate to the root folder and execute:
+The ***examples*** folder contains samples of how to use the library. To run the examples, navigate to the *examples* folder and execute:
 
 ```
 go run main.go

pkg/mocai/constants/cli_constants.go → cmd/mocai/cli_constants.go

@@ -1,8 +1,4 @@
-package constants
-
-import (
-	"github.com/brazzcore/mocai/pkg/mocai"
-)
+package mocai
 
 // ANSI Escape Codes
 var (
@@ -22,7 +18,7 @@ var (
 
 func init() {
 	// Checks if the terminal supports ANSI
-	if mocai.SupportsANSI() {
+	if SupportsANSI() {
 		CyanBold = "\033[1;36m"
 		BlueBold = "\033[1;34m"
 		Italic = "\033[3m"

docs/localization/pt/README-PT.md

@@ -61,7 +61,7 @@ func GenerateMockExample() {
 ```
 
 ### Exemplos
-A pasta ***examples*** contém exemplos de como usar a biblioteca. Para executar os exemplos, navegue até a pasta raiz e execute:
+A pasta ***examples*** contém exemplos de como usar a biblioteca. Para executar os exemplos, navegue até a pasta *examples* e execute:
 
 ```
 go run main.go

examples/mock_example.go → examples/main.go

@@ -1,9 +1,9 @@
-package examples
+package main
 
 import (
 	"fmt"
 
-	"github.com/brazzcore/mocai/pkg/mocai/constants"
+	"github.com/brazzcore/mocai/cmd/mocai"
 	"github.com/brazzcore/mocai/pkg/mocai/entities/address"
 	"github.com/brazzcore/mocai/pkg/mocai/entities/certificate"
 	"github.com/brazzcore/mocai/pkg/mocai/entities/company"
@@ -14,7 +14,7 @@ import (
 	"github.com/brazzcore/mocai/pkg/mocai/translations"
 )
 
-func GenerateMockExample() {
+func main() {
 	// Set the language to pt-BR
 	translations.SetLanguage("ptbr")
 
@@ -61,8 +61,8 @@ func GenerateMockExample() {
 		return
 	}
 
-	fmt.Println(constants.HeaderMain)
-	fmt.Println(constants.SubHeader)
+	fmt.Println(mocai.HeaderMain)
+	fmt.Println(mocai.SubHeader)
 
 	fmt.Printf("Person: %s %s, %s, %d years old, CPF: %s\n",
 		p.FirstNameMale, p.LastName, p.Gender, p.Age, p.CPF)
@@ -92,5 +92,5 @@ func GenerateMockExample() {
 		vr.BrazilianVoteRegistration.Section, vr.BrazilianVoteRegistration.Zone,
 		vr.BrazilianVoteRegistration.Number)
 
-	fmt.Println(constants.Footer)
+	fmt.Println(mocai.Footer)
 }

pkg/mocai/entities/company/countries/brazilian_company.go

@@ -1,7 +1,6 @@
 package countries
 
 import (
-	"errors"
 	"fmt"
 	"math/rand"
 	"strings"
@@ -27,7 +26,7 @@ func GenerateBrazilianCompany(formatted bool) (*BrazilianCompany, error) {
 
 	// Validate data
 	if len(companyNames) == 0 {
-		return nil, errors.New("no company names available")
+		return nil, ErrNoCompanyNamesAvailable
 	}
 
 	// Choose a random company name

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

@@ -8,4 +8,5 @@ import "errors"
 var (
 	ErrGeneratingBrazilianCompany = errors.New("error generating brazilian company")
 	ErrGeneratingCNPJ             = errors.New("error generating CNPJ")
+	ErrNoCompanyNamesAvailable    = errors.New("no company names available")
 )

pkg/mocai/entities/company/countries/generator_test.go

@@ -9,7 +9,7 @@ import (
 func TestGenerateCompany(t *testing.T) {
 	company, err := GenerateBrazilianCompany(false)
 	if err != nil {
-		t.Fatalf("Failed to generate company: %v", err)
+		t.Errorf("Failed to generate company: %v", err)
 	}
 
 	if company.CompanyName == "" || company.CNPJ == "" {
@@ -20,7 +20,7 @@ func TestGenerateCompany(t *testing.T) {
 func TestIfCompanyHasAValidCNPJ(t *testing.T) {
 	company, err := GenerateBrazilianCompany(false)
 	if err != nil {
-		t.Fatalf("Failed to generate company: %v", err)
+		t.Errorf("Failed to generate company: %v", err)
 	}
 
 	if !cnpj.ValidateCNPJ(company.CNPJ) {

pkg/mocai/entities/company/generator.go

@@ -10,7 +10,6 @@ type Company struct {
 // GenerateCompany generates all companies available.
 func GenerateCompany(formatted bool) (*Company, error) {
 	createdCompanyBrazilian, err := countries.GenerateBrazilianCompany(formatted)
-
 	if err != nil {
 		return nil, err
 	}

pkg/mocai/entities/cpf/generator.go

@@ -1,7 +1,6 @@
 package cpf
 
 import (
-	"errors"
 	"fmt"
 	"math/rand"
 	"strings"
@@ -34,7 +33,7 @@ func GenerateCPF(formatted bool) (string, error) {
 	// Format the CPF if requested
 	if formatted {
 		if len(cpf) != 11 {
-			return "", errors.New(ErrInvalidCPF.Error())
+			return "", ErrInvalidCPF
 		}
 		return cpf[:3] + "." + cpf[3:6] + "." + cpf[6:9] + "-" + cpf[9:], nil
 	}

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

@@ -24,6 +24,7 @@ func GenerateBrazilianNationalID(formatted bool) (*RG, error) {
 	if formatted {
 		rgNumber = formatRG(rgNumber)
 	}
+
 	return &RG{
 		Number:      rgNumber,
 		State:       "SP",
@@ -64,14 +65,15 @@ func calculateSPRGDigit() (string, error) {
 	} 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/person/errors.go

@@ -1,10 +1,12 @@
 package person
 
+import "errors"
+
 // Error constants for person-related data generation failures.
 // These errors represent specific failure scenarios and should be wrapped with additional
 // context when returned.
-const (
-	ERROR_GENERATING_PERSON = "error generating person"
-	ERROR_NO_FIRST_NAMES    = "no data available for first names"
-	ERROR_NO_LAST_NAMES     = "no data available for last names"
+var (
+	ErrGeneratingPerson = errors.New("error generating person")
+	ErrNoFirstNames     = errors.New("no data available for first names")
+	ErrNoLastNames      = errors.New("no data available for last names")
 )

pkg/mocai/entities/person/generator.go

@@ -1,7 +1,6 @@
 package person
 
 import (
-	"errors"
 	"fmt"
 	"math/rand"
 	"strings"
@@ -33,11 +32,11 @@ func GeneratePerson() (*Person, error) {
 
 	// Validate data
 	if len(firstNamesMale) == 0 || len(firstNamesFemale) == 0 {
-		return nil, errors.New(ERROR_NO_FIRST_NAMES)
+		return nil, ErrNoFirstNames
 	}
 
 	if len(lastNames) == 0 {
-		return nil, errors.New(ERROR_NO_LAST_NAMES)
+		return nil, ErrNoLastNames
 	}
 
 	// Choose random values
@@ -60,17 +59,15 @@ func GeneratePerson() (*Person, error) {
 	// Validate required fields
 	if firstNameMale == "" || firstNameFemale == "" || lastName == "" {
 		return nil, fmt.Errorf("%s: missing required data (firstNameMale: %s, firstNameFemale: %s, lastName: %s)",
-			ERROR_GENERATING_PERSON, firstNameMale, firstNameFemale, lastName)
+			ErrGeneratingPerson, firstNameMale, firstNameFemale, lastName)
 	}
 
-	createdPerson := &Person{
+	return &Person{
 		FirstNameMale:   firstNameMale,
 		FirstNameFemale: firstNameFemale,
 		LastName:        lastName,
 		Gender:          gender,
 		Age:             rand.Intn(80) + 18,
 		CPF:             cpf,
-	}
-
-	return createdPerson, nil
+	}, nil
 }

pkg/mocai/entities/phone/errors.go

@@ -1,9 +1,11 @@
 package phone
 
+import "errors"
+
 // Error constants used for phone number generation failures.
 // These errors represent specific failure scenarios and should be wrapped with additional
 // context when returned.
-const (
-	ERROR_GENERATING_PHONE = "error generating phone"
-	ERROR_NO_AREA_CODES    = "no data available for area codes"
+var (
+	ErrGeneratingPhone = errors.New("error generating phone")
+	ErrNoAreaCodes     = errors.New("no data available for area codes")
 )

pkg/mocai/entities/phone/generator.go

@@ -22,13 +22,13 @@ func GeneratePhone() (*Phone, error) {
 	// Get the list of area codes
 	areaCodeStr := translations.Get(lang, "phone_area_code")
 	if areaCodeStr == "" {
-		return nil, fmt.Errorf(ERROR_NO_AREA_CODES+" for: %s", lang)
+		return nil, fmt.Errorf(ErrNoAreaCodes.Error()+" for: %s", lang)
 	}
 	areaCodes := strings.Split(areaCodeStr, ",")
 
 	// Validate data
 	if len(areaCodes) == 0 {
-		return nil, fmt.Errorf(ERROR_NO_AREA_CODES+" for: %s", lang)
+		return nil, fmt.Errorf(ErrNoAreaCodes.Error()+" for: %s", lang)
 	}
 	areaCode := areaCodes[rand.Intn(len(areaCodes))]
 
@@ -37,13 +37,11 @@ func GeneratePhone() (*Phone, error) {
 
 	if areaCode == "" || number == "" {
 		return nil, fmt.Errorf("%s: missing required data (areaCode: %s, number: %s)",
-			ERROR_GENERATING_PHONE, areaCode, number)
+			ErrGeneratingPhone, areaCode, number)
 	}
 
-	createdPhone := &Phone{
+	return &Phone{
 		AreaCode: areaCode,
 		Number:   number,
-	}
-
-	return createdPhone, nil
+	}, nil
 }

pkg/mocai/entities/vote_registration/countries/brazilian_vote_registration.go

@@ -55,13 +55,11 @@ func GenerateBrazilianVoteRegistration(formatted bool) (*BrazilianVoteRegistrati
 		number = fmt.Sprintf("%s %s %s", number[:4], number[4:8], number[8:])
 	}
 
-	createdBrazilianVoteRegistration := &BrazilianVoteRegistration{
+	return &BrazilianVoteRegistration{
 		Section: section,
 		Zone:    zone,
 		Number:  number,
-	}
-
-	return createdBrazilianVoteRegistration, nil
+	}, nil
 }
 
 // randomInt generates a random integer between min and max