From 6792ba7f6255f2878e84d4864aa0ddb944488098 Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Wed, 13 Jul 2016 16:58:44 +0100 Subject: [PATCH] Rename message content 'str' key to 'text' --- docs/LOOT Metadata Syntax.html | 8 ++++---- src/backend/metadata/message_content.cpp | 2 +- src/backend/metadata/message_content.h | 10 +++++----- src/gui/html/elements/loot-plugin-editor.html | 4 ++-- src/gui/html/js/events.js | 4 ++-- src/gui/html/js/game.js | 4 ++-- src/gui/html/js/plugin.js | 2 +- .../backend/metadata/message_content_test.h | 6 +++--- src/tests/backend/metadata/message_test.h | 18 +++++++++--------- .../html/elements/test_loot-plugin-card.html | 4 ++-- src/tests/gui/html/js/test_game.js | 6 +++--- src/tests/gui/html/js/test_plugin.js | 12 ++++++------ 12 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/LOOT Metadata Syntax.html b/docs/LOOT Metadata Syntax.html index 28bbd793..f1fd95a3 100644 --- a/docs/LOOT Metadata Syntax.html +++ b/docs/LOOT Metadata Syntax.html @@ -356,8 +356,8 @@ display: 'OBSE v18+' -
Key NameRequiredNotes
str✓The actual message content string. -
lang✓The language that str is written in, given as a POSIX language code. The languages LOOT supports are given in Language Codes. +
text✓The actual message content string. +
lang✓The language that text is written in, given as a POSIX language code. The languages LOOT supports are given in Language Codes.

Equality

@@ -373,9 +373,9 @@ display: 'OBSE v18+' condition: 'file("foo.esp")' content: - lang: en - str: 'An example link: <http://www.example.com>' + text: 'An example link: <http://www.example.com>' - lang: ru - str: 'Это пример ссылки: <http://www.example.com>' + text: 'Это пример ссылки: <http://www.example.com>' would be displayed as
diff --git a/src/backend/metadata/message_content.cpp b/src/backend/metadata/message_content.cpp index 6c8f2d1f..986d3381 100644 --- a/src/backend/metadata/message_content.cpp +++ b/src/backend/metadata/message_content.cpp @@ -56,7 +56,7 @@ Emitter& operator << (Emitter& out, const loot::MessageContent& rhs) { out << Key << "lang" << Value << loot::Language(rhs.GetLanguage()).GetLocale(); - out << Key << "str" << Value << YAML::SingleQuoted << rhs.GetText(); + out << Key << "text" << Value << YAML::SingleQuoted << rhs.GetText(); out << EndMap; diff --git a/src/backend/metadata/message_content.h b/src/backend/metadata/message_content.h index a1203421..ce55ad5b 100644 --- a/src/backend/metadata/message_content.h +++ b/src/backend/metadata/message_content.h @@ -52,7 +52,7 @@ template<> struct convert { static Node encode(const loot::MessageContent& rhs) { Node node; - node["str"] = rhs.GetText(); + node["text"] = rhs.GetText(); node["lang"] = loot::Language(rhs.GetLanguage()).GetLocale(); return node; @@ -61,15 +61,15 @@ struct convert { static bool decode(const Node& node, loot::MessageContent& rhs) { if (!node.IsMap()) throw RepresentationException(node.Mark(), "bad conversion: 'message content' object must be a map"); - if (!node["str"]) - throw RepresentationException(node.Mark(), "bad conversion: 'str' key missing from 'message content' object"); + if (!node["text"]) + throw RepresentationException(node.Mark(), "bad conversion: 'text' key missing from 'message content' object"); if (!node["lang"]) throw RepresentationException(node.Mark(), "bad conversion: 'lang' key missing from 'message content' object"); - std::string str = node["str"].as(); + std::string text = node["text"].as(); loot::Language::Code lang = loot::Language(node["lang"].as()).GetCode(); - rhs = loot::MessageContent(str, lang); + rhs = loot::MessageContent(text, lang); return true; } diff --git a/src/gui/html/elements/loot-plugin-editor.html b/src/gui/html/elements/loot-plugin-editor.html index 1e34115c..411103bc 100644 --- a/src/gui/html/elements/loot-plugin-editor.html +++ b/src/gui/html/elements/loot-plugin-editor.html @@ -267,7 +267,7 @@ loot-editor-close return { type: rowData.type, content: [{ - str: rowData.content, + text: rowData.content, lang: rowData.language, }], condition: rowData.condition, @@ -362,7 +362,7 @@ loot-editor-close _messageToRowData(message) { return { type: message.type, - content: message.content[0].str, + content: message.content[0].text, condition: message.condition, language: message.content[0].lang, }; diff --git a/src/gui/html/js/events.js b/src/gui/html/js/events.js index a83a7a3c..2fa14466 100644 --- a/src/gui/html/js/events.js +++ b/src/gui/html/js/events.js @@ -121,8 +121,8 @@ function onSortPlugins() { if (!result.plugins) { const message = result.globalMessages.find(item => ( - item.content[0].str.startsWith('Cyclic interaction detected' - ))).content[0].str; + item.content[0].text.startsWith('Cyclic interaction detected' + ))).content[0].text; throw new Error(loot.l10n.translate(`Failed to sort plugins. Details: ${message}`)); } diff --git a/src/gui/html/js/game.js b/src/gui/html/js/game.js index f999dc6f..b8c67853 100644 --- a/src/gui/html/js/game.js +++ b/src/gui/html/js/game.js @@ -260,7 +260,7 @@ if (this.globalMessages) { messages = this.globalMessages.map(message => ({ type: message.type, - content: message.content[0].str, + content: message.content[0].text, })); } if (this.plugins) { @@ -379,7 +379,7 @@ const li = document.createElement('li'); li.className = message.type; /* Use the Marked library for Markdown formatting support. */ - li.innerHTML = marked(message.content[0].str); + li.innerHTML = marked(message.content[0].text); generalMessagesList.appendChild(li); }); } diff --git a/src/gui/html/js/plugin.js b/src/gui/html/js/plugin.js index 83579bff..0cd7fec6 100644 --- a/src/gui/html/js/plugin.js +++ b/src/gui/html/js/plugin.js @@ -63,7 +63,7 @@ this._messages = plugin.messages.map(message => ({ type: message.type, - content: message.content[0].str, + content: message.content[0].text, })).filter(filters.messageFilter, filters); } diff --git a/src/tests/backend/metadata/message_content_test.h b/src/tests/backend/metadata/message_content_test.h index 150d8cce..b0fd9fb6 100644 --- a/src/tests/backend/metadata/message_content_test.h +++ b/src/tests/backend/metadata/message_content_test.h @@ -79,7 +79,7 @@ TEST(MessageContent, emittingAsYamlShouldOutputDataCorrectly) { emitter << content; EXPECT_EQ("lang: " + Language(content.GetLanguage()).GetLocale() + - "\nstr: '" + content.GetText() + "'", emitter.c_str()); + "\ntext: '" + content.GetText() + "'", emitter.c_str()); } TEST(MessageContent, encodingAsYamlShouldOutputDataCorrectly) { @@ -87,12 +87,12 @@ TEST(MessageContent, encodingAsYamlShouldOutputDataCorrectly) { YAML::Node node; node = content; - EXPECT_EQ(content.GetText(), node["str"].as()); + EXPECT_EQ(content.GetText(), node["text"].as()); EXPECT_EQ(Language(Language::Code::french).GetLocale(), node["lang"].as()); } TEST(MessageContent, decodingFromYamlShouldSetDataCorrectly) { - YAML::Node node = YAML::Load("{str: content, lang: de}"); + YAML::Node node = YAML::Load("{text: content, lang: de}"); MessageContent content = node.as(); EXPECT_EQ("content", content.GetText()); diff --git a/src/tests/backend/metadata/message_test.h b/src/tests/backend/metadata/message_test.h index f57349e5..c6325ad7 100644 --- a/src/tests/backend/metadata/message_test.h +++ b/src/tests/backend/metadata/message_test.h @@ -212,9 +212,9 @@ TEST_P(MessageTest, emittingAsYamlShouldOutputMultipleContentStringsAsAList) { EXPECT_STREQ("type: say\n" "content:\n" " - lang: en\n" - " str: 'content1'\n" + " text: 'content1'\n" " - lang: de\n" - " str: 'content2'", emitter.c_str()); + " text: 'content2'", emitter.c_str()); } TEST_P(MessageTest, encodingAsYamlShouldStoreNoteMessageTypeCorrectly) { @@ -339,9 +339,9 @@ TEST_P(MessageTest, decodingFromYamlShouldStoreAListOfContentStringsCorrectly) { YAML::Node node = YAML::Load("type: say\n" "content:\n" " - lang: en\n" - " str: content1\n" + " text: content1\n" " - lang: de\n" - " str: content2"); + " text: content2"); Message message = node.as(); EXPECT_EQ(MessageContents({ @@ -354,7 +354,7 @@ TEST_P(MessageTest, decodingFromYamlShouldNotThrowIfTheOnlyContentStringIsNotEng YAML::Node node = YAML::Load("type: say\n" "content:\n" " - lang: fr\n" - " str: content1"); + " text: content1"); EXPECT_NO_THROW(Message message = node.as()); } @@ -363,9 +363,9 @@ TEST_P(MessageTest, decodingFromYamlShouldThrowIfMultipleContentStringsAreGivenA YAML::Node node = YAML::Load("type: say\n" "content:\n" " - lang: de\n" - " str: content1\n" + " text: content1\n" " - lang: fr\n" - " str: content2"); + " text: content2"); EXPECT_THROW(node.as(), YAML::RepresentationException); } @@ -384,9 +384,9 @@ TEST_P(MessageTest, decodingFromYamlShouldApplySubstitutionsToAllContentStrings) YAML::Node node = YAML::Load("type: say\n" "content:\n" " - lang: en\n" - " str: content1 %1%\n" + " text: content1 %1%\n" " - lang: de\n" - " str: content2 %1%\n" + " text: content2 %1%\n" "subs:\n" " - sub"); Message message = node.as(); diff --git a/src/tests/gui/html/elements/test_loot-plugin-card.html b/src/tests/gui/html/elements/test_loot-plugin-card.html index e315b955..12ac1d49 100644 --- a/src/tests/gui/html/elements/test_loot-plugin-card.html +++ b/src/tests/gui/html/elements/test_loot-plugin-card.html @@ -60,12 +60,12 @@ messages: [{ type: 'say', content: [{ - str: 'This is a *test* note.', + text: 'This is a *test* note.', }], }, { type: 'warn', content: [{ - str: 'This is a **test** warning.', + text: 'This is a **test** warning.', }], }], }), diff --git a/src/tests/gui/html/js/test_game.js b/src/tests/gui/html/js/test_game.js index 354f66b3..27f9ff7a 100644 --- a/src/tests/gui/html/js/test_game.js +++ b/src/tests/gui/html/js/test_game.js @@ -379,7 +379,7 @@ describe('Game', () => { condition: 'file("foo.esp")', content: [{ lang: 'fr', - str: 'Bonjour le monde', + text: 'Bonjour le monde', }], }]; game._plugins = [{ @@ -400,7 +400,7 @@ describe('Game', () => { condition: 'file("bar.esp")', content: [{ lang: 'en', - str: 'Hello world', + text: 'Hello world', }], }], tags: ['invalidStructure'], @@ -414,7 +414,7 @@ describe('Game', () => { game.getContent().should.deepEqual({ messages: [{ type: game._globalMessages[0].type, - content: game._globalMessages[0].content[0].str, + content: game._globalMessages[0].content[0].text, }], plugins: [{ name: game._plugins[0].name, diff --git a/src/tests/gui/html/js/test_plugin.js b/src/tests/gui/html/js/test_plugin.js index 79731b84..9e3f4863 100644 --- a/src/tests/gui/html/js/test_plugin.js +++ b/src/tests/gui/html/js/test_plugin.js @@ -1087,14 +1087,14 @@ describe('PluginCardContent', () => { { type: 'say', content: [{ - str: 'test message', + text: 'test message', lang: 'en', }], }, { type: 'warn', content: [{ - str: 'do not clean', + text: 'do not clean', lang: 'en', }], }, @@ -1270,11 +1270,11 @@ describe('PluginCardContent', () => { plugin.getCardContent(filters).messages.should.deepEqual([ { type: plugin.messages[0].type, - content: plugin.messages[0].content[0].str, + content: plugin.messages[0].content[0].text, }, { type: plugin.messages[1].type, - content: plugin.messages[1].content[0].str, + content: plugin.messages[1].content[0].text, }, ]); }); @@ -1283,7 +1283,7 @@ describe('PluginCardContent', () => { filters.hideNotes = true; plugin.getCardContent(filters).messages.should.deepEqual([{ type: plugin.messages[1].type, - content: plugin.messages[1].content[0].str, + content: plugin.messages[1].content[0].text, }]); }); @@ -1291,7 +1291,7 @@ describe('PluginCardContent', () => { filters.hideDoNotCleanMessages = true; plugin.getCardContent(filters).messages.should.deepEqual([{ type: plugin.messages[0].type, - content: plugin.messages[0].content[0].str, + content: plugin.messages[0].content[0].text, }]); });