Merge pull request #50 from brazzcore/feature/49-refactor-package-names

[feature/49] :: renamed package names and other adjustments

Author: wellfernandes

README.md

@@ -38,33 +38,29 @@ Basic Usage
 Import the library into your project and start generating mocks:
 
 ```go
-// specific
-translations.SetLanguage("ptbr")
-
-addr, err := address.GenerateAddress()
+// Create a Mocker instance for Portuguese
+ptMocker, err := mocai.NewMocker("ptbr", true)
 if err != nil {
-    log.Println(err)
+    log.Fatal(err)
 }
 
-addr.Street // returns street name
-```
+// Access mock data
+fmt.Printf("Address: %s\n", ptMocker.Address.Street)
+fmt.Printf("Phone: %s\n", ptMocker.Phone.Number)
 
-```go
-// mocker
-m, err := mocai.NewMocker("ptbr")
+// For data in a different language, create a new instance
+enMocker, err := mocai.NewMocker("en", true)
 if err != nil {
-    log.Println(err)
+    log.Fatal(err)
 }
-
-m.Address().Street // returns street name
-m.Phone().Number // returns phone number
 ```
-### Examples
-The ***examples*** folder contains samples of how to use the library, organized by approach:
 
-- `specific/`: Examples using direct calls to each of Mocaí's mockable entities (e.g., phone.GeneratePhone, etc).
+> **Important**: Each Mocker instance is immutable and contains data in the language specified at creation time. To get data in a different language, always create a new instance using NewMocker.
+
+### Examples
+The ***examples*** folder contains samples of how to use the library:
 
-- `mocker/`: Example using a main entry point `mocai.NewMocker("ptbr")` to generate mocks in a fluent and simplified way.
+- `mocker/`: Example using a main entry point `mocai.NewMocker(lang string, isFormatted bool)` to generate mocks in a fluent and simplified way.
 
 To run an example, navigate to the desired directory and run:
 ```

docs/localization/pt/README-PT.md

@@ -36,34 +36,29 @@ Uso Básico
 Importe a biblioteca em seu projeto e comece a gerar mocks:
 
 ```go
-// specific
-translations.SetLanguage("ptbr")
-
-addr, err := address.GenerateAddress()
+// Cria uma instância do Mocker para português
+ptMocker, err := mocai.NewMocker("ptbr", true)
 if err != nil {
-    log.Println(err)
+    log.Fatal(err)
 }
 
-addr.Street // retorna o nome da rua
-```
+// Acessa os dados mock
+fmt.Printf("Endereço: %s\n", ptMocker.Address.Street)
+fmt.Printf("Telefone: %s\n", ptMocker.Phone.Number)
 
-```go
-// mocker
-m, err := mocai.NewMocker("ptbr")
+// Para dados em outro idioma, crie uma nova instância
+enMocker, err := mocai.NewMocker("en", true)
 if err != nil {
-    log.Println(err)
+    log.Fatal(err)
 }
-
-m.Address().Street // retorna o nome da rua
-m.Phone().Number // retorna o número de telefone
 ```
 
-### Exemplos
-O diretório ***examples*** contém exemplos de comoo usar a biblioteca, organizados por abordagem:
+> **Importante**: Cada instância do Mocker é imutável e contém dados no idioma especificado no momento da criação. Para obter dados em um idioma diferente, sempre crie uma nova instância usando NewMocker.
 
-- `specific/`: Exemplos usando as funções diretas de cada entidade mockável do Mocaí (`phone.GeneratePhone`, etc).
+### Exemplos
+O diretório ***examples*** contém exemplos de como usar a biblioteca:
 
-- `mocker/`: Exemplo usando um ponto de entrada principal `mocai.NewMocker("ptbr")` para gerar mocks de maneira fluida e simplificada.
+- `mocker/`: Exemplo usando um ponto de entrada principal `mocai.NewMocker(lang string, isFormatted bool)` para gerar mocks de maneira fluida e simplificada.
 
 Para executar um exemplo, acesse o diretório desejado e execute:
 ```

examples/mocker/main.go

@@ -15,21 +15,15 @@ func main() {
 
 	// Initialize mocai and set a supported language
 	// If the language is not available, the default language pt-BR will be set
-	m, err := mocai.NewMocker("ptbr")
+	m, err := mocai.NewMocker("ptbr", true)
 	if err != nil {
 		log.Println(err)
 	}
 	// Generate mock data
 	// You can select which entity attributes to use
 	// by accessing the entity and its fields
-	m.Person()  // m.Person().Age, m.Person().CPF...
-	m.Address() // m.Address().City, m.Address().Number...
-	m.Phone()   // m.Phone().AreaCode, m.Phone().Number
-
-	// Printing mocks example
-	addr := m.Address()
 	fmt.Printf("Address: %s, %d - %s, %s (%s) - %s\n",
-		addr.Street, addr.Number, addr.City, addr.State, addr.UF, addr.ZIP)
+		m.Address.Street, m.Address.Number, m.Address.City, m.Address.State, m.Address.UF, m.Address.ZIP)
 
 	fmt.Println(cli.Footer)
 }

examples/specific/main.go

@@ -23,9 +23,18 @@ type SlicesToCheck struct {
 	err  error
 }
 
+// NewAddress creates and returns a new Address with randomly generated data.
+func NewAddress() (*Address, error) {
+	addr, err := (&Address{}).generateAddress()
+	if err != nil {
+		return nil, err
+	}
+	return addr, nil
+}
+
 // GenerateAddress generates a mock address with random data.
 // It returns a pointer to an Address and an error if the generation fails.
-func GenerateAddress() (*Address, error) {
+func (a *Address) generateAddress() (*Address, error) {
 	lang := translations.GetLanguage()
 
 	// Get the list of streets, cities, states, and ZIP codes

pkg/mocai/entities/address/generator.go

@@ -47,31 +47,31 @@ type DeathCertificate struct {
 
 // BrazilianCertificates represents all brazilian certificates
 type BrazilianCertificates struct {
-	BirthCertificate    *BirthCertificate
-	MarriageCertificate *MarriageCertificate
-	DeathCertificate    *DeathCertificate
+	BirthCertificate    BirthCertificate
+	MarriageCertificate MarriageCertificate
+	DeathCertificate    DeathCertificate
 }
 
 // GenerateBrazilianCertificates generates a valid brazilian certificates
 // If formatted is true, returns the number with separators (-)
 // Returns a pointer to BrazilianCertificates and error if any validation fails
-func GenerateBrazilianCertificates(formatted bool) (*BrazilianCertificates, error) {
+func GenerateBrazilianCertificates(formatted bool) (BrazilianCertificates, error) {
 	createdBirthCertificate, err := generateBirthCertificate(formatted)
 	if err != nil {
-		return nil, err
+		return BrazilianCertificates{}, err
 	}
 
 	createdMarriageCertificate, err := generateMarriageCertificate(formatted)
 	if err != nil {
-		return nil, err
+		return BrazilianCertificates{}, err
 	}
 
 	createdDeathCertificate, err := generateDeathCertificate(formatted)
 	if err != nil {
-		return nil, err
+		return BrazilianCertificates{}, err
 	}
 
-	createdBrazilianCertificates := &BrazilianCertificates{
+	createdBrazilianCertificates := BrazilianCertificates{
 		BirthCertificate:    createdBirthCertificate,
 		MarriageCertificate: createdMarriageCertificate,
 		DeathCertificate:    createdDeathCertificate,
@@ -84,12 +84,12 @@ func GenerateBrazilianCertificates(formatted bool) (*BrazilianCertificates, erro
 // If formatted is true, returns the number with separators (-)
 // certificateType is the type of certificate [1 - for birth certificate, 2 - for marriage certificate, 3 - for death certificate]
 // Returns a pointer to BaseCertificate and error if any validation fails
-func generateCertificate(formatted bool, certificateType int) (*BaseCertificate, error) {
+func generateCertificate(formatted bool, certificateType int) (BaseCertificate, error) {
 	// Registry Office
 	// 1. Vital Records Office [6 digits]
 	vitalRecordsOffice := generateRandomNumber(100000, 899999)
 	if vitalRecordsOffice < 0 {
-		return nil, ErrInvalidVitalRecordsOffice
+		return BaseCertificate{}, ErrInvalidVitalRecordsOffice
 	}
 
 	// 2. Archive [2 digits]
@@ -107,26 +107,26 @@ func generateCertificate(formatted bool, certificateType int) (*BaseCertificate,
 	// 6. Book number [5 digits]
 	bookNumber := generateRandomNumber(10000, 89999)
 	if bookNumber < 0 {
-		return nil, ErrInvalidBookNumber
+		return BaseCertificate{}, ErrInvalidBookNumber
 	}
 
 	// 7. Page number [3 digits]
 	pageNumber := generateRandomNumber(100, 899)
 	if pageNumber < 0 {
-		return nil, ErrInvalidPageNumber
+		return BaseCertificate{}, ErrInvalidPageNumber
 	}
 
 	// 8. Term number [7 digits]
 	termNumber := generateRandomNumber(1000000, 8999999)
 	if termNumber < 0 {
-		return nil, ErrInvalidTermNumber
+		return BaseCertificate{}, ErrInvalidTermNumber
 	}
 
 	// Number without check digits [30 digits]
 	numberWithoutCheckDigits := fmt.Sprintf("%06d%02d%02d%04d%d%05d%03d%07d",
 		vitalRecordsOffice, archiveCode, serviceType, birthYear, certificateType, bookNumber, pageNumber, termNumber)
 	if len(numberWithoutCheckDigits) != 30 {
-		return nil, ErrInvalidNumberWithoutCheckDigits
+		return BaseCertificate{}, ErrInvalidNumberWithoutCheckDigits
 	}
 
 	// 9. Check digits calculation [2 digits]
@@ -139,10 +139,10 @@ func generateCertificate(formatted bool, certificateType int) (*BaseCertificate,
 	}
 
 	if certificateNumber == "" {
-		return nil, ErrInvalidCertificate
+		return BaseCertificate{}, ErrInvalidCertificate
 	}
 
-	createdBaseCertificate := &BaseCertificate{
+	createdBaseCertificate := BaseCertificate{
 		VitalRecordsOffice: vitalRecordsOffice,
 		ArchiveCode:        archiveCode,
 		ServiceType:        serviceType,
@@ -159,42 +159,42 @@ func generateCertificate(formatted bool, certificateType int) (*BaseCertificate,
 }
 
 // generateBirthCertificate generates a valid Brazilian birth certificate
-func generateBirthCertificate(formatted bool) (*BirthCertificate, error) {
+func generateBirthCertificate(formatted bool) (BirthCertificate, error) {
 	base, err := generateCertificate(formatted, brazilianBirthCertificateType)
 	if err != nil {
-		return nil, err
+		return BirthCertificate{}, err
 	}
 
-	createdBirthCertificate := &BirthCertificate{
-		BaseCertificate: *base,
+	createdBirthCertificate := BirthCertificate{
+		BaseCertificate: base,
 	}
 
 	return createdBirthCertificate, nil
 }
 
 // generateMarriageCertificate generates a valid Brazilian marriage certificate
-func generateMarriageCertificate(formatted bool) (*MarriageCertificate, error) {
+func generateMarriageCertificate(formatted bool) (MarriageCertificate, error) {
 	base, err := generateCertificate(formatted, brazilianMarriageCertificateType)
 	if err != nil {
-		return nil, err
+		return MarriageCertificate{}, err
 	}
 
-	createdMarriageCertificate := &MarriageCertificate{
-		BaseCertificate: *base,
+	createdMarriageCertificate := MarriageCertificate{
+		BaseCertificate: base,
 	}
 
 	return createdMarriageCertificate, nil
 }
 
 // generateDeathCertificate generates a valid Brazilian death certificate
-func generateDeathCertificate(formatted bool) (*DeathCertificate, error) {
+func generateDeathCertificate(formatted bool) (DeathCertificate, error) {
 	base, err := generateCertificate(formatted, brazilianDeathCertificateType)
 	if err != nil {
-		return nil, err
+		return DeathCertificate{}, err
 	}
 
-	createdDeathCertificate := &DeathCertificate{
-		BaseCertificate: *base,
+	createdDeathCertificate := DeathCertificate{
+		BaseCertificate: base,
 	}
 
 	return createdDeathCertificate, nil