From 6bb90c2b8acdfa19371fafbf86bc004321037dae Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sat, 29 Oct 2016 18:51:06 +0100 Subject: [PATCH] Revert util -> utility in cleaning metadata structure --- CMakeLists.txt | 2 +- docs/metadata/changelog.rst | 1 - docs/metadata/data_structures/cleaning.rst | 6 +++--- src/backend/metadata/plugin_cleaning_data.cpp | 2 +- src/backend/metadata/plugin_cleaning_data.h | 8 ++++---- src/gui/html/elements/loot-plugin-editor.html | 4 ++-- src/tests/api/api_game_operations_test.h | 2 +- src/tests/api/database_interface_test.h | 4 ++-- src/tests/backend/masterlist_test.h | 2 +- .../backend/metadata/plugin_cleaning_data_test.h | 12 ++++++------ src/tests/backend/metadata/plugin_metadata_test.h | 14 +++++++------- 11 files changed, 28 insertions(+), 29 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index b2edaef5..be2c6494 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -101,7 +101,7 @@ set(PSEUDOSEM_INCLUDE_DIRS "${SOURCE_DIR}/include") ExternalProject_Add(testing-metadata PREFIX "external" - URL "https://github.com/loot/testing-metadata/archive/2.0.0.tar.gz" + URL "https://github.com/loot/testing-metadata/archive/1.1.0.tar.gz" CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND "") diff --git a/docs/metadata/changelog.rst b/docs/metadata/changelog.rst index 25213fcc..4e59e238 100644 --- a/docs/metadata/changelog.rst +++ b/docs/metadata/changelog.rst @@ -24,7 +24,6 @@ Changed * The ``file()`` condition function now also accepts a regular expression. * The ``active()`` condition function to also accept a regular expression. * Renamed the dirty info data structure to the cleaning data structure. -* Renamed the ``util`` key in the cleaning data structure to ``utility`` . Removed ------- diff --git a/docs/metadata/data_structures/cleaning.rst b/docs/metadata/data_structures/cleaning.rst index f8dc5ed4..b590d178 100644 --- a/docs/metadata/data_structures/cleaning.rst +++ b/docs/metadata/data_structures/cleaning.rst @@ -9,7 +9,7 @@ This structure holds information on which versions of a plugin are dirty or clea **Required.** The CRC-32 checksum of the plugin. If the plugin is dirty, this needs to be the CRC of the plugin before before cleaning. LOOT displays the CRCs of installed plugins in its report. The 8-character CRC should be preceded by ``0x`` so that it is interpreted correctly. -.. describe:: utility +.. describe:: util ``string`` @@ -50,7 +50,7 @@ Examples A dirty plugin:: crc: 0x3DF62ABC - utility: '[TES5Edit](http://www.nexusmods.com/skyrim/mods/25859) v3.1.1' + util: '[TES5Edit](http://www.nexusmods.com/skyrim/mods/25859) v3.1.1' info: 'A cleaning guide is available [here](http://www.creationkit.com/index.php?title=TES5Edit_Cleaning_Guide_-_TES5Edit).' itm: 4 udr: 160 @@ -58,4 +58,4 @@ A dirty plugin:: A clean plugin:: crc: 0x2ABC3DF6 - utility: '[TES5Edit](http://www.nexusmods.com/skyrim/mods/25859) v3.1.1' + util: '[TES5Edit](http://www.nexusmods.com/skyrim/mods/25859) v3.1.1' diff --git a/src/backend/metadata/plugin_cleaning_data.cpp b/src/backend/metadata/plugin_cleaning_data.cpp index cb93a296..4fe97c58 100644 --- a/src/backend/metadata/plugin_cleaning_data.cpp +++ b/src/backend/metadata/plugin_cleaning_data.cpp @@ -142,7 +142,7 @@ namespace YAML { Emitter& operator << (Emitter& out, const loot::PluginCleaningData& rhs) { out << BeginMap << Key << "crc" << Value << Hex << rhs.CRC() << Dec - << Key << "utility" << Value << YAML::SingleQuoted << rhs.CleaningUtility(); + << Key << "util" << Value << YAML::SingleQuoted << rhs.CleaningUtility(); if (!rhs.Info().empty()) { if (rhs.Info().size() == 1) diff --git a/src/backend/metadata/plugin_cleaning_data.h b/src/backend/metadata/plugin_cleaning_data.h index d345ceae..4e2a1ae5 100644 --- a/src/backend/metadata/plugin_cleaning_data.h +++ b/src/backend/metadata/plugin_cleaning_data.h @@ -76,7 +76,7 @@ struct convert { static Node encode(const loot::PluginCleaningData& rhs) { Node node; node["crc"] = rhs.CRC(); - node["utility"] = rhs.CleaningUtility(); + node["util"] = rhs.CleaningUtility(); node["info"] = rhs.Info(); if (rhs.ITMs() > 0) @@ -94,8 +94,8 @@ struct convert { throw RepresentationException(node.Mark(), "bad conversion: 'cleaning data' object must be a map"); if (!node["crc"]) throw RepresentationException(node.Mark(), "bad conversion: 'crc' key missing from 'cleaning data' object"); - if (!node["utility"]) - throw RepresentationException(node.Mark(), "bad conversion: 'utility' key missing from 'cleaning data' object"); + if (!node["util"]) + throw RepresentationException(node.Mark(), "bad conversion: 'util' key missing from 'cleaning data' object"); uint32_t crc = node["crc"].as(); int itm = 0, ref = 0, nav = 0; @@ -107,7 +107,7 @@ struct convert { if (node["nav"]) nav = node["nav"].as(); - std::string utility = node["utility"].as(); + std::string utility = node["util"].as(); std::vector info; if (node["info"]) { diff --git a/src/gui/html/elements/loot-plugin-editor.html b/src/gui/html/elements/loot-plugin-editor.html index 1fe0a3e8..d136bc15 100644 --- a/src/gui/html/elements/loot-plugin-editor.html +++ b/src/gui/html/elements/loot-plugin-editor.html @@ -268,7 +268,7 @@ loot-editor-close itm: rowData.itm, udr: rowData.udr, nav: rowData.nav, - utility: rowData.utility, + util: rowData.utility, }; }, @@ -351,7 +351,7 @@ loot-editor-close itm: dirtyInfo.itm, udr: dirtyInfo.udr, nav: dirtyInfo.nav, - utility: dirtyInfo.utility, + utility: dirtyInfo.util, }; }, diff --git a/src/tests/api/api_game_operations_test.h b/src/tests/api/api_game_operations_test.h index 01f0ee8f..c10fcff6 100644 --- a/src/tests/api/api_game_operations_test.h +++ b/src/tests/api/api_game_operations_test.h @@ -79,7 +79,7 @@ protected: << " content: '" << warningMessage << "'" << endl << " dirty:" << endl << " - crc: 0x7d22f9df" << endl - << " utility: TES4Edit" << endl + << " util: TES4Edit" << endl << " udr: 4" << endl << " - name: " << blankDifferentEsp << endl << " after:" << endl diff --git a/src/tests/api/database_interface_test.h b/src/tests/api/database_interface_test.h index ae3f38a9..b5afbf4b 100644 --- a/src/tests/api/database_interface_test.h +++ b/src/tests/api/database_interface_test.h @@ -36,7 +36,7 @@ protected: DatabaseInterfaceTest() : userlistPath_(localPath / "userlist.yaml"), url_("https://github.com/loot/testing-metadata.git"), - branch_("2.x"), + branch_("master"), minimalOutputPath_(localPath / "minimal.yml") {} void SetUp() { @@ -77,7 +77,7 @@ protected: << " - name: '" << blankDifferentEsm << "'" << endl << " dirty:" << endl << " - crc: 0x7d22f9df" << endl - << " utility: 'TES4Edit'" << endl + << " util: 'TES4Edit'" << endl << " udr: 4"; return expectedContent.str(); diff --git a/src/tests/backend/masterlist_test.h b/src/tests/backend/masterlist_test.h index 0962900f..ea166901 100644 --- a/src/tests/backend/masterlist_test.h +++ b/src/tests/backend/masterlist_test.h @@ -35,7 +35,7 @@ namespace test { class MasterlistTest : public CommonGameTestFixture { protected: MasterlistTest() : - repoBranch("2.x"), + repoBranch("master"), repoUrl("https://github.com/loot/testing-metadata.git"), masterlistPath(localPath / "masterlist.yaml") {} diff --git a/src/tests/backend/metadata/plugin_cleaning_data_test.h b/src/tests/backend/metadata/plugin_cleaning_data_test.h index 1cb00441..71a226ab 100644 --- a/src/tests/backend/metadata/plugin_cleaning_data_test.h +++ b/src/tests/backend/metadata/plugin_cleaning_data_test.h @@ -188,7 +188,7 @@ TEST_P(PluginCleaningDataTest, emittingAsYamlShouldOutputAllNonZeroCounts) { YAML::Emitter emitter; emitter << info; - EXPECT_STREQ("crc: 0x12345678\nutility: 'cleaner'\ninfo: 'info'\nitm: 2\nudr: 10\nnav: 30", emitter.c_str()); + EXPECT_STREQ("crc: 0x12345678\nutil: 'cleaner'\ninfo: 'info'\nitm: 2\nudr: 10\nnav: 30", emitter.c_str()); } TEST_P(PluginCleaningDataTest, emittingAsYamlShouldOmitAllZeroCounts) { @@ -196,7 +196,7 @@ TEST_P(PluginCleaningDataTest, emittingAsYamlShouldOmitAllZeroCounts) { YAML::Emitter emitter; emitter << info; - EXPECT_STREQ("crc: 0x12345678\nutility: 'cleaner'\ninfo: 'info'", emitter.c_str()); + EXPECT_STREQ("crc: 0x12345678\nutil: 'cleaner'\ninfo: 'info'", emitter.c_str()); } TEST_P(PluginCleaningDataTest, encodingAsYamlShouldOmitAllZeroCountFields) { @@ -205,7 +205,7 @@ TEST_P(PluginCleaningDataTest, encodingAsYamlShouldOmitAllZeroCountFields) { node = info; EXPECT_EQ(0x12345678, node["crc"].as()); - EXPECT_EQ("cleaner", node["utility"].as()); + EXPECT_EQ("cleaner", node["util"].as()); EXPECT_EQ(info_, node["info"].as>()); EXPECT_FALSE(node["itm"]); EXPECT_FALSE(node["udr"]); @@ -218,7 +218,7 @@ TEST_P(PluginCleaningDataTest, encodingAsYamlShouldOutputAllNonZeroCountFields) node = info; EXPECT_EQ(0x12345678, node["crc"].as()); - EXPECT_EQ("cleaner", node["utility"].as()); + EXPECT_EQ("cleaner", node["util"].as()); EXPECT_EQ(info_, node["info"].as>()); EXPECT_EQ(2, node["itm"].as()); EXPECT_EQ(10, node["udr"].as()); @@ -226,7 +226,7 @@ TEST_P(PluginCleaningDataTest, encodingAsYamlShouldOutputAllNonZeroCountFields) } TEST_P(PluginCleaningDataTest, decodingFromYamlShouldLeaveMissingFieldsWithZeroValues) { - YAML::Node node = YAML::Load("{crc: 0x12345678, utility: cleaner}"); + YAML::Node node = YAML::Load("{crc: 0x12345678, util: cleaner}"); PluginCleaningData info = node.as(); EXPECT_EQ(0x12345678, info.CRC()); @@ -238,7 +238,7 @@ TEST_P(PluginCleaningDataTest, decodingFromYamlShouldLeaveMissingFieldsWithZeroV } TEST_P(PluginCleaningDataTest, decodingFromYamlShouldStoreAllNonZeroCounts) { - YAML::Node node = YAML::Load("{crc: 0x12345678, utility: cleaner, info: info, itm: 2, udr: 10, nav: 30}"); + YAML::Node node = YAML::Load("{crc: 0x12345678, util: cleaner, info: info, itm: 2, udr: 10, nav: 30}"); PluginCleaningData info = node.as(); EXPECT_EQ(0x12345678, info.CRC()); diff --git a/src/tests/backend/metadata/plugin_metadata_test.h b/src/tests/backend/metadata/plugin_metadata_test.h index 522f5582..7aa3bbee 100644 --- a/src/tests/backend/metadata/plugin_metadata_test.h +++ b/src/tests/backend/metadata/plugin_metadata_test.h @@ -948,7 +948,7 @@ TEST_P(PluginMetadataTest, emittingAsYamlShouldOutputAPluginWithDirtyInfoCorrect EXPECT_STREQ("name: 'Blank.esp'\n" "dirty:\n" " - crc: 0x5\n" - " utility: 'utility'\n" + " util: 'utility'\n" " info: 'info'\n" " udr: 1\n" " nav: 2", emitter.c_str()); @@ -964,7 +964,7 @@ TEST_P(PluginMetadataTest, emittingAsYamlShouldOutputAPluginWithCleanInfoCorrect EXPECT_STREQ("name: 'Blank.esp'\n" "clean:\n" " - crc: 0x5\n" - " utility: 'utility'", emitter.c_str()); + " util: 'utility'", emitter.c_str()); } TEST_P(PluginMetadataTest, emittingAsYamlShouldOutputAPluginWithLocationsCorrectly) { @@ -1141,12 +1141,12 @@ TEST_P(PluginMetadataTest, decodingFromYamlShouldStoreAllGivenData) { " - Relev\n" "dirty:\n" " - crc: 0x5\n" - " utility: 'utility'\n" + " util: 'utility'\n" " udr: 1\n" " nav: 2\n" "clean:\n" " - crc: 0x6\n" - " utility: 'utility'\n" + " util: 'utility'\n" "url:\n" " - 'http://www.example.com'"); PluginMetadata plugin = node.as(); @@ -1184,7 +1184,7 @@ TEST_P(PluginMetadataTest, decodingFromYamlWithDirtyInfoInARegexPluginMetadataOb YAML::Node node = YAML::Load("name: 'Blank\\.esp'\n" "dirty:\n" " - crc: 0x5\n" - " utility: 'utility'\n" + " util: 'utility'\n" " udr: 1\n" " nav: 2"); @@ -1195,7 +1195,7 @@ TEST_P(PluginMetadataTest, decodingFromYamlWithCleanInfoInARegexPluginMetadataOb YAML::Node node = YAML::Load("name: 'Blank\\.esp'\n" "clean:\n" " - crc: 0x5\n" - " utility: 'utility'"); + " util: 'utility'"); EXPECT_THROW(node.as(), YAML::RepresentationException); } @@ -1204,7 +1204,7 @@ TEST_P(PluginMetadataTest, decodingFromYamlWithAnInvalidRegexNameShouldThrow) { YAML::Node node = YAML::Load("name: 'RagnvaldBook(Farengar(+Ragnvald)?)?\\.esp'\n" "dirty:\n" " - crc: 0x5\n" - " utility: 'utility'\n" + " util: 'utility'\n" " udr: 1\n" " nav: 2");