Merge pull request #48 from brazzcore/feature/47-apply-the-camel-case-naming-convention

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

Author: wellfernandes

README.md

@@ -37,34 +37,36 @@ go get github.com/brazzcore/mocai
 Basic Usage
 Import the library into your project and start generating mocks:
 
-```
-package examples
-
-import (
-	"fmt"
-
-	"github.com/brazzcore/mocai/pkg/mocai/entities/person"
-	"github.com/brazzcore/mocai/pkg/mocai/translations"
-)
+```go
+// specific
+translations.SetLanguage("ptbr")
 
-func GenerateMockExample() {
-	translations.SetLanguage("ptbr")
-
-	p, err := person.GeneratePerson()
-	if err != nil {
-		fmt.Print(err)
-		return
-	}
+addr, err := address.GenerateAddress()
+if err != nil {
+    log.Println(err)
+}
 
-	fmt.Printf("Person: %s %s, %s, %d years old, CPF: %s\n",
-		p.FirstNameMale, p.LastName, p.Gender, p.Age, p.CPF)
+addr.Street // returns street name
+```
 
+```go
+// mocker
+m, err := mocai.NewMocker("ptbr")
+if err != nil {
+    log.Println(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. To run the examples, navigate to the root folder and execute:
+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).
+
+- `mocker/`: Example using a main entry point `mocai.NewMocker("ptbr")` to generate mocks in a fluent and simplified way.
 
+To run an example, navigate to the desired directory and run:
 ```
 go run main.go
 ```

docs/localization/pt/README-PT.md

@@ -35,34 +35,37 @@ go get github.com/brazzcore/mocai
 Uso Básico
 Importe a biblioteca em seu projeto e comece a gerar mocks:
 
-```
-package examples
-
-import (
-	"fmt"
-
-	"github.com/brazzcore/mocai/pkg/mocai/entities/person"
-	"github.com/brazzcore/mocai/pkg/mocai/translations"
-)
+```go
+// specific
+translations.SetLanguage("ptbr")
 
-func GenerateMockExample() {
-	translations.SetLanguage("ptbr")
-
-	p, err := person.GeneratePerson()
-	if err != nil {
-		fmt.Print(err)
-		return
-	}
+addr, err := address.GenerateAddress()
+if err != nil {
+    log.Println(err)
+}
 
-	fmt.Printf("Person: %s %s, %s, %d years old, CPF: %s\n",
-		p.FirstNameMale, p.LastName, p.Gender, p.Age, p.CPF)
+addr.Street // retorna o nome da rua
+```
 
+```go
+// mocker
+m, err := mocai.NewMocker("ptbr")
+if err != nil {
+    log.Println(err)
 }
+
+m.Address().Street // retorna o nome da rua
+m.Phone().Number // retorna o número de telefone
 ```
 
 ### Exemplos
-A pasta ***examples*** contém exemplos de como usar a biblioteca. Para executar os exemplos, navegue até a pasta raiz e execute:
+O diretório ***examples*** contém exemplos de comoo usar a biblioteca, organizados por abordagem:
+
+- `specific/`: Exemplos usando as funções diretas de cada entidade mockável do Mocaí (`phone.GeneratePhone`, etc).
+
+- `mocker/`: Exemplo usando um ponto de entrada principal `mocai.NewMocker("ptbr")` para gerar mocks de maneira fluida e simplificada.
 
+Para executar um exemplo, acesse o diretório desejado e execute:
 ```
 go run main.go
 ```

examples/mocker/main.go

@@ -0,0 +1,35 @@
+package main
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/brazzcore/mocai/internal/cli"
+	"github.com/brazzcore/mocai/pkg/mocai"
+)
+
+func main() {
+
+	fmt.Println(cli.HeaderMain)
+	fmt.Println(cli.SubHeader)
+
+	// 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")
+	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)
+
+	fmt.Println(cli.Footer)
+}

examples/mock_example.go examples/specific/main.goexamples/mock_example.go renamed to examples/specific/main.go

@@ -1,9 +1,9 @@
-package examples
+package main
 
 import (
 	"fmt"
 
-	"github.com/brazzcore/mocai/pkg/mocai/constants"
+	"github.com/brazzcore/mocai/internal/cli"
 	"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,11 +61,11 @@ func GenerateMockExample() {
 		return
 	}
 
-	fmt.Println(constants.HeaderMain)
-	fmt.Println(constants.SubHeader)
+	fmt.Println(cli.HeaderMain)
+	fmt.Println(cli.SubHeader)
 
 	fmt.Printf("Person: %s %s, %s, %d years old, CPF: %s\n",
-		p.FirstNameMale, p.LastName, p.Gender, p.Age, p.CPF)
+		p.FirstNameMale, p.LastName, *p.Gender, p.Age, p.CPF)
 
 	fmt.Printf("RG: %s, State: %s, Issuing Body: %s\n",
 		nid.BrazilianRG.Number, nid.BrazilianRG.State, nid.BrazilianRG.IssuingBody)
@@ -92,5 +92,5 @@ func GenerateMockExample() {
 		vr.BrazilianVoteRegistration.Section, vr.BrazilianVoteRegistration.Zone,
 		vr.BrazilianVoteRegistration.Number)
 
-	fmt.Println(constants.Footer)
+	fmt.Println(cli.Footer)
 }

pkg/mocai/constants/cli_constants.go internal/cli/cli_constants.gopkg/mocai/constants/cli_constants.go renamed to internal/cli/cli_constants.go

@@ -1,8 +1,4 @@
-package constants
-
-import (
-	"github.com/brazzcore/mocai/pkg/mocai"
-)
+package cli
 
 // 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"

pkg/mocai/utils.go internal/cli/utils.gopkg/mocai/utils.go renamed to internal/cli/utils.go

@@ -1,4 +1,4 @@
-package mocai
+package cli
 
 import (
 	"os"

main.go

@@ -67,14 +67,12 @@ func GenerateAddress() (*Address, error) {
 	state := states[rand.Intn(len(states))]
 	zip := zips[rand.Intn(len(zips))]
 
-	createdAddress := &Address{
+	return &Address{
 		Street: street,
 		Number: rand.Intn(9999),
 		City:   city,
 		State:  state,
 		UF:     uf,
 		ZIP:    zip,
-	}
-
-	return createdAddress, nil
+	}, nil
 }

pkg/mocai/entities/address/generator.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/brazilian_company.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")
 )