adding character truncated deaths list indicator (#276)

* add AreDeathsTruncated to the Character struct
* add tests
* renaming AreDeathsTruncated to DeathsTruncated
* fix v3 characters documentation

---------

Co-authored-by: Tobias Lindberg <tobias.ehlert@gmail.com>

Author: phenpessoa

src/TIbiaDataDocsV3.go

@@ -40,8 +40,16 @@ func tibiaCharactersCharacterV3() bool {
 	return false
 }
 
+type CharacterV3 struct {
+	CharacterInfo      CharacterInfo      `json:"character"`                     // The character's information.
+	AccountBadges      []AccountBadges    `json:"account_badges,omitempty"`      // The account's badges.
+	Achievements       []Achievements     `json:"achievements,omitempty"`        // The character's achievements.
+	Deaths             []Deaths           `json:"deaths,omitempty"`              // The character's deaths.
+	AccountInformation AccountInformation `json:"account_information,omitempty"` // The account information.
+	OtherCharacters    []OtherCharacters  `json:"other_characters,omitempty"`    // The account's other characters.
+}
 type CharacterResponseV3 struct {
-	Characters  Character     `json:"characters"`
+	Characters  CharacterV3   `json:"characters"`
 	Information InformationV3 `json:"information"`
 }
 

src/TibiaCharactersCharacter.go

@@ -105,6 +105,7 @@ type Character struct {
 	AccountBadges      []AccountBadges    `json:"account_badges,omitempty"`      // The account's badges.
 	Achievements       []Achievements     `json:"achievements,omitempty"`        // The character's achievements.
 	Deaths             []Deaths           `json:"deaths,omitempty"`              // The character's deaths.
+	DeathsTruncated    bool               `json:"deaths_truncated"`              // Whether the character's deaths were truncated or not.
 	AccountInformation AccountInformation `json:"account_information,omitempty"` // The account information.
 	OtherCharacters    []OtherCharacters  `json:"other_characters,omitempty"`    // The account's other characters.
 }
@@ -135,6 +136,7 @@ func TibiaCharactersCharacterImpl(BoxContentHTML string) (CharacterResponse, err
 		DeathsData             []Deaths
 		AccountInformationData AccountInformation
 		OtherCharactersData    []OtherCharacters
+		DeathsTruncated        bool
 
 		// Errors
 		characterNotFound bool
@@ -229,7 +231,7 @@ func TibiaCharactersCharacterImpl(BoxContentHTML string) (CharacterResponse, err
 					AnchorQuery := s.Find("a")
 					HouseName := AnchorQuery.Nodes[0].FirstChild.Data
 					HouseHref := AnchorQuery.Nodes[0].Attr[0].Val
-					//substring from houseid= to &character in the href for the house
+					// substring from houseid= to &character in the href for the house
 					HouseId := HouseHref[strings.Index(HouseHref, "houseid")+8 : strings.Index(HouseHref, "&character")]
 					HouseRawData := RowNameQuery.Nodes[0].NextSibling.LastChild.Data
 					HouseTown := HouseRawData[strings.Index(HouseRawData, "(")+1 : strings.Index(HouseRawData, ")")]
@@ -244,7 +246,7 @@ func TibiaCharactersCharacterImpl(BoxContentHTML string) (CharacterResponse, err
 				case "Guild Membership:":
 					CharacterInfoData.Guild.Rank = strings.TrimSuffix(RowData, " of the ")
 
-					//TODO: I don't understand why the unicode nbsp is there...
+					// TODO: I don't understand why the unicode nbsp is there...
 					CharacterInfoData.Guild.GuildName = TibiaDataSanitizeStrings(RowNameQuery.Nodes[0].NextSibling.LastChild.LastChild.Data)
 				case "Last Login:":
 					if RowData != "never logged in" {
@@ -256,8 +258,8 @@ func TibiaCharactersCharacterImpl(BoxContentHTML string) (CharacterResponse, err
 					stringBuilder := strings.Builder{}
 					for node != nil {
 						if node.DataAtom == Br {
-							//It appears we can ignore br because either the encoding or goquery adds an \n for us
-							//stringBuilder.WriteString("\n")
+							// It appears we can ignore br because either the encoding or goquery adds an \n for us
+							// stringBuilder.WriteString("\n")
 						} else {
 							stringBuilder.WriteString(node.Data)
 						}
@@ -388,6 +390,7 @@ func TibiaCharactersCharacterImpl(BoxContentHTML string) (CharacterResponse, err
 				dataNoTags := RemoveHtmlTag(CharacterListHTML)
 
 				if strings.HasPrefix(dataNoTags, "There happened more character deaths in the last 30 days than we can display here.") {
+					DeathsTruncated = true
 					return false
 				}
 
@@ -609,6 +612,7 @@ func TibiaCharactersCharacterImpl(BoxContentHTML string) (CharacterResponse, err
 		AccountBadgesData,
 		AchievementsData,
 		DeathsData,
+		DeathsTruncated,
 		AccountInformationData,
 		OtherCharactersData,
 	}

src/TibiaCharactersCharacter_test.go

@@ -101,7 +101,7 @@ func TestNumber2(t *testing.T) {
 	assert.Equal("Testa de Ferro do Lejonhjartat ;)", character.Comment)
 	assert.Equal("Premium Account", character.AccountStatus)
 
-	//validate other characters
+	// validate other characters
 	assert.Equal(7, len(characterJson.Character.OtherCharacters))
 
 	onlineMainCharacter := characterJson.Character.OtherCharacters[3]
@@ -179,14 +179,14 @@ func TestNumber4(t *testing.T) {
 
 	assert.Equal("Riley No Hands", character.Name)
 
-	//validate former names
+	// validate former names
 	assert.Equal(4, len(character.FormerNames))
 	assert.Equal("Dura Malandro", character.FormerNames[0])
 	assert.Equal("Letsgo Brandon", character.FormerNames[1])
-	assert.Equal("Letsgo Brandon", character.FormerNames[2]) //yes, this name is listed twice
+	assert.Equal("Letsgo Brandon", character.FormerNames[2]) // yes, this name is listed twice
 	assert.Equal("Nataraya Soldrac", character.FormerNames[3])
 
-	//validate death data
+	// validate death data
 	assert.Equal(79, len(characterJson.Character.Deaths))
 
 	firstDeath := characterJson.Character.Deaths[0]
@@ -327,7 +327,6 @@ func TestNumber4(t *testing.T) {
 				{Name: "Suprldo", Player: true, Traded: false, Summon: ""},
 			},
 			Killers: []Killers{
-
 				{Name: "Jupa Infinity", Player: true, Traded: false, Summon: ""},
 				{Name: "Okiba Kay", Player: true, Traded: false, Summon: ""},
 				{Name: "Jahziel Hardcori", Player: true, Traded: false, Summon: ""},
@@ -364,7 +363,6 @@ func TestNumber4(t *testing.T) {
 		},
 		{
 			Assists: []Killers{
-
 				{Name: "May Thirtieth", Player: true, Traded: false, Summon: ""},
 				{Name: "Guichin Killzejk Boom", Player: true, Traded: false, Summon: ""},
 				{Name: "Kanabionoia", Player: true, Traded: false, Summon: ""},
@@ -2815,7 +2813,7 @@ func TestNumber5(t *testing.T) {
 	assert.Empty(characterJson.Character.Achievements)
 	assert.Empty(characterJson.Character.AccountInformation.LoyaltyTitle)
 
-	//validate other characters
+	// validate other characters
 	assert.Equal(4, len(characterJson.Character.OtherCharacters))
 
 	positionCharacter := characterJson.Character.OtherCharacters[1]
@@ -3055,8 +3053,9 @@ func TestNumber11(t *testing.T) {
 	character := characterJson.Character.CharacterInfo
 
 	assert.Equal("Orca Kaoksh", character.Name)
+	assert.False(characterJson.Character.DeathsTruncated)
 
-	//validate death data
+	// validate death data
 	assert.Equal(2, len(characterJson.Character.Deaths))
 	deaths := characterJson.Character.Deaths
 
@@ -3112,7 +3111,6 @@ func TestNumber11(t *testing.T) {
 			idx, tc.Time, deaths[idx].Time,
 		)
 	}
-
 }
 
 func TestNumber12(t *testing.T) {
@@ -3136,6 +3134,7 @@ func TestNumber12(t *testing.T) {
 	character := characterJson.Character.CharacterInfo
 
 	assert.Equal("Stalone Matador", character.Name)
+	assert.True(characterJson.Character.DeathsTruncated)
 	assert.Equal(55, len(characterJson.Character.Deaths))
 }