From fc601539a3b6fb96c4e437b9e6b03904ba13957c Mon Sep 17 00:00:00 2001 From: Carlos Castillo Date: Tue, 10 Dec 2024 11:58:16 +0100 Subject: [PATCH] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Rename=20category=20attrib?= =?UTF-8?q?utes=20and=20name=20to=20be=20CitizenCategory?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 +++--- cmd/generate-npc/main.go | 2 +- examples/catalog-name-generator/main.go | 2 +- examples/custom-name-generator/main.go | 2 +- examples/generate-pilot/main.go | 2 +- pkg/generator/character.go | 10 +++++----- pkg/generator/citizen_category.go | 18 ++++++++--------- pkg/generator/citizen_category_auto.go | 2 +- pkg/generator/generate_character_request.go | 12 +++++------ .../generate_character_request_auto.go | 20 +++++++++---------- pkg/generator/npc_generator.go | 4 ++-- pkg/generator/npc_generator_test.go | 20 +++++++++---------- 12 files changed, 50 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 40152ce..d12c2c3 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ func main() { } request := generator.NewGenerateCharacterRequestBuilder(). - Category(generator.CategoryAboveAverage). + CitizenCategory(generator.CitizenCategoryAboveAverage). Experience(generator.ExperienceRookie). Role(generator.RolePilot). Gender(generator.GenderUnspecified). @@ -151,7 +151,7 @@ func main() { for _, gender := range generator.GenderValues() { request := generator.NewGenerateCharacterRequestBuilder(). - Category(generator.CategoryExceptional). + CitizenCategory(generator.CitizenCategoryExceptional). Experience(generator.ExperienceVeteran). Role(generator.RoleLeader). Gender(gender). @@ -218,7 +218,7 @@ func main() { role := pickRandomItem(generator.RoleValues()) request := generator.NewGenerateCharacterRequestBuilder(). - Category(category). + CitizenCategory(category). Experience(experience). Role(role). Gender(gender). diff --git a/cmd/generate-npc/main.go b/cmd/generate-npc/main.go index cf44196..71d56c3 100644 --- a/cmd/generate-npc/main.go +++ b/cmd/generate-npc/main.go @@ -21,7 +21,7 @@ func main() { role := readRole(opts) gender := readGender(opts) newCharacterRequest := generator.NewGenerateCharacterRequestBuilder(). - Category(category). + CitizenCategory(category). Experience(experience). Role(role). Gender(gender). diff --git a/examples/catalog-name-generator/main.go b/examples/catalog-name-generator/main.go index b1e9cd3..2b3dbe4 100644 --- a/examples/catalog-name-generator/main.go +++ b/examples/catalog-name-generator/main.go @@ -30,7 +30,7 @@ func main() { role := pickRandomItem(generator.RoleValues()) request := generator.NewGenerateCharacterRequestBuilder(). - Category(category). + CitizenCategory(category). Experience(experience). Role(role). Gender(gender). diff --git a/examples/custom-name-generator/main.go b/examples/custom-name-generator/main.go index 1f8e7c5..c15a25d 100644 --- a/examples/custom-name-generator/main.go +++ b/examples/custom-name-generator/main.go @@ -17,7 +17,7 @@ func main() { for _, gender := range generator.GenderValues() { request := generator.NewGenerateCharacterRequestBuilder(). - Category(generator.CategoryExceptional). + CitizenCategory(generator.CitizenCategoryExceptional). Experience(generator.ExperienceVeteran). Role(generator.RoleLeader). Gender(gender). diff --git a/examples/generate-pilot/main.go b/examples/generate-pilot/main.go index 501d399..47fffa6 100644 --- a/examples/generate-pilot/main.go +++ b/examples/generate-pilot/main.go @@ -14,7 +14,7 @@ func main() { } request := generator.NewGenerateCharacterRequestBuilder(). - Category(generator.CategoryAboveAverage). + CitizenCategory(generator.CitizenCategoryAboveAverage). Experience(generator.ExperienceRookie). Role(generator.RolePilot). Gender(generator.GenderUnspecified). diff --git a/pkg/generator/character.go b/pkg/generator/character.go index cf285a0..c610b0e 100644 --- a/pkg/generator/character.go +++ b/pkg/generator/character.go @@ -9,7 +9,7 @@ type Character struct { firstName string surname string role Role - category CitizenCategory + citizenCategory CitizenCategory experience Experience skills []string characteristics map[npc.Characteristic]int @@ -31,8 +31,8 @@ func (c Character) Role() Role { return c.role } -func (c Character) Category() CitizenCategory { - return c.category +func (c Character) CitizenCategory() CitizenCategory { + return c.citizenCategory } func (c Character) Experience() Experience { @@ -56,6 +56,6 @@ func (c Character) Characteristics() map[Characteristic]int { // String returns a string representation of the character. It is prone to change so you should not rely on it. func (c Character) String() string { - return fmt.Sprintf("Character{firstName: %v, surname: %v, role: %v, category: %v, experience: %v, skills: %v, characteristics: %v}", - c.firstName, c.surname, c.role, c.category, c.experience, c.skills, c.characteristics) + return fmt.Sprintf("Character{firstName: %v, surname: %v, role: %v, citizenCategory: %v, experience: %v, skills: %v, characteristics: %v}", + c.firstName, c.surname, c.role, c.citizenCategory, c.experience, c.skills, c.characteristics) } diff --git a/pkg/generator/citizen_category.go b/pkg/generator/citizen_category.go index 149e6b4..d99c478 100644 --- a/pkg/generator/citizen_category.go +++ b/pkg/generator/citizen_category.go @@ -2,19 +2,19 @@ package generator import "github.com/carloscasalar/traveller-npc-generator/internal/npc" -//go:generate enumer -type=CitizenCategory -output=citizen_category_auto.go -trimprefix=Category -transform=snake +//go:generate enumer -type=CitizenCategory -output=citizen_category_auto.go -trimprefix=CitizenCategory -transform=snake type CitizenCategory int func (i CitizenCategory) toNpcCitizenCategory() npc.CitizenCategory { switch i { - case CategoryBelowAverage: + case CitizenCategoryBelowAverage: return npc.CategoryBelowAverage - case CategoryAverage: + case CitizenCategoryAverage: return npc.CategoryAverage - case CategoryAboveAverage: + case CitizenCategoryAboveAverage: return npc.CategoryAboveAverage - case CategoryExceptional: + case CitizenCategoryExceptional: return npc.CategoryExceptional default: return npc.CitizenCategory(i) @@ -22,8 +22,8 @@ func (i CitizenCategory) toNpcCitizenCategory() npc.CitizenCategory { } const ( - CategoryBelowAverage CitizenCategory = iota - CategoryAverage - CategoryAboveAverage - CategoryExceptional + CitizenCategoryBelowAverage CitizenCategory = iota + CitizenCategoryAverage + CitizenCategoryAboveAverage + CitizenCategoryExceptional ) diff --git a/pkg/generator/citizen_category_auto.go b/pkg/generator/citizen_category_auto.go index b2c98c0..27c80f2 100644 --- a/pkg/generator/citizen_category_auto.go +++ b/pkg/generator/citizen_category_auto.go @@ -1,4 +1,4 @@ -// Code generated by "enumer -type=CitizenCategory -output=citizen_category_auto.go -trimprefix=Category -transform=snake"; DO NOT EDIT. +// Code generated by "enumer -type=CitizenCategory -output=citizen_category_auto.go -trimprefix=CitizenCategory -transform=snake"; DO NOT EDIT. package generator diff --git a/pkg/generator/generate_character_request.go b/pkg/generator/generate_character_request.go index 0f3ce13..a0a4cbd 100644 --- a/pkg/generator/generate_character_request.go +++ b/pkg/generator/generate_character_request.go @@ -5,15 +5,15 @@ import "errors" //go:generate gonstructor -type=GenerateCharacterRequest -constructorTypes=builder -output=generate_character_request_auto.go type GenerateCharacterRequest struct { - category CitizenCategory - experience Experience - role Role - gender Gender + citizenCategory CitizenCategory + experience Experience + role Role + gender Gender } func (r GenerateCharacterRequest) Validate() error { - if !r.category.IsACitizenCategory() { - return errors.New("invalid category") + if !r.citizenCategory.IsACitizenCategory() { + return errors.New("invalid citizen category") } if !r.experience.IsAExperience() { return errors.New("invalid experience") diff --git a/pkg/generator/generate_character_request_auto.go b/pkg/generator/generate_character_request_auto.go index 78b38d9..71b90af 100644 --- a/pkg/generator/generate_character_request_auto.go +++ b/pkg/generator/generate_character_request_auto.go @@ -3,18 +3,18 @@ package generator type GenerateCharacterRequestBuilder struct { - category CitizenCategory - experience Experience - role Role - gender Gender + citizenCategory CitizenCategory + experience Experience + role Role + gender Gender } func NewGenerateCharacterRequestBuilder() *GenerateCharacterRequestBuilder { return &GenerateCharacterRequestBuilder{} } -func (b *GenerateCharacterRequestBuilder) Category(category CitizenCategory) *GenerateCharacterRequestBuilder { - b.category = category +func (b *GenerateCharacterRequestBuilder) CitizenCategory(citizenCategory CitizenCategory) *GenerateCharacterRequestBuilder { + b.citizenCategory = citizenCategory return b } @@ -35,9 +35,9 @@ func (b *GenerateCharacterRequestBuilder) Gender(gender Gender) *GenerateCharact func (b *GenerateCharacterRequestBuilder) Build() *GenerateCharacterRequest { return &GenerateCharacterRequest{ - category: b.category, - experience: b.experience, - role: b.role, - gender: b.gender, + citizenCategory: b.citizenCategory, + experience: b.experience, + role: b.role, + gender: b.gender, } } diff --git a/pkg/generator/npc_generator.go b/pkg/generator/npc_generator.go index cb87497..a7bfecc 100644 --- a/pkg/generator/npc_generator.go +++ b/pkg/generator/npc_generator.go @@ -14,14 +14,14 @@ func (g *NpcGenerator) Generate(request GenerateCharacterRequest) (*Character, e role := request.role.toNpcRole() experience := request.experience.toNpcExperience() skills := role.Skills(experience) - category := request.category.toNpcCitizenCategory() + category := request.citizenCategory.toNpcCitizenCategory() characteristic := role.RandomCharacteristic(category) return &Character{ firstName: firstName, surname: surname, role: request.role, - category: request.category, + citizenCategory: request.citizenCategory, experience: request.experience, skills: skills, characteristics: characteristic, diff --git a/pkg/generator/npc_generator_test.go b/pkg/generator/npc_generator_test.go index 914d4ed..89a0ae0 100644 --- a/pkg/generator/npc_generator_test.go +++ b/pkg/generator/npc_generator_test.go @@ -12,7 +12,7 @@ import ( func Test_resulting_character_should_have_same_category_experience_and_role_as_request(t *testing.T) { request := generator.NewGenerateCharacterRequestBuilder(). - Category(generator.CategoryExceptional). + CitizenCategory(generator.CitizenCategoryExceptional). Experience(generator.ExperienceRecruit). Role(generator.RoleDiplomat). Build() @@ -21,7 +21,7 @@ func Test_resulting_character_should_have_same_category_experience_and_role_as_r character, err := npcGenerator.Generate(*request) require.NoError(t, err) - assert.Equal(t, generator.CategoryExceptional, character.Category()) + assert.Equal(t, generator.CitizenCategoryExceptional, character.CitizenCategory()) assert.Equal(t, generator.ExperienceRecruit, character.Experience()) assert.Equal(t, generator.RoleDiplomat, character.Role()) } @@ -91,16 +91,16 @@ func Test_number_of_skills_generated_for(t *testing.T) { func Test_characteristic_array_for_citizen_category(t *testing.T) { allCategories := generator.CitizenCategoryValues() expectedCharacteristicArray := map[generator.CitizenCategory][]int{ - generator.CategoryBelowAverage: {8, 7, 6, 6, 5, 4}, - generator.CategoryAverage: {9, 8, 7, 7, 6, 5}, - generator.CategoryAboveAverage: {10, 9, 8, 8, 7, 6}, - generator.CategoryExceptional: {11, 10, 9, 9, 8, 7}, + generator.CitizenCategoryBelowAverage: {8, 7, 6, 6, 5, 4}, + generator.CitizenCategoryAverage: {9, 8, 7, 7, 6, 5}, + generator.CitizenCategoryAboveAverage: {10, 9, 8, 8, 7, 6}, + generator.CitizenCategoryExceptional: {11, 10, 9, 9, 8, 7}, } for _, category := range allCategories { t.Run(fmt.Sprintf("%v should be %v", category, expectedCharacteristicArray[category]), func(t *testing.T) { request := generator.NewGenerateCharacterRequestBuilder(). - Category(category). + CitizenCategory(category). Build() npcGenerator, _ := newGenerator() @@ -115,14 +115,14 @@ func Test_characteristic_array_for_citizen_category(t *testing.T) { func Test_when_category_is_invalid_it_returns_error(t *testing.T) { nonValidCategory := generator.CitizenCategory(99) request := generator.NewGenerateCharacterRequestBuilder(). - Category(nonValidCategory). + CitizenCategory(nonValidCategory). Build() npcGenerator, _ := newGenerator() _, err := npcGenerator.Generate(*request) assert.Error(t, err) - assert.Equal(t, "invalid category", err.Error()) + assert.Equal(t, "invalid citizen category", err.Error()) } func Test_when_experience_is_invalid_it_returns_error(t *testing.T) { @@ -180,7 +180,7 @@ func getSortedArray(characteristics map[generator.Characteristic]int) []int { func exceptionalRecruitDiplomatRequest() *generator.GenerateCharacterRequest { return generator.NewGenerateCharacterRequestBuilder(). - Category(generator.CategoryExceptional). + CitizenCategory(generator.CitizenCategoryExceptional). Experience(generator.ExperienceRecruit). Role(generator.RoleDiplomat). Build()