1177 allow identifying assets in code from their path #1337

GalaxyCrush · 2024-09-29T15:44:46Z

Description

Changed the Assets::entry functions to search for assets using paths instead of uuids.
Changed the Assets::load to update the mID of the AnyAsset handle.

Checklist

Self-review changes.
Evaluate impact on the documentation.
Ensure test coverage.
Write new samples.
Add entry to the changelog's unreleased section.

https://github.com/GameDevTecnico/cubos into 1177-allow-identifying-assets-in-code-from-their-path

github-actions · 2024-09-29T15:46:19Z

PR Preview Action v1.4.8
🚀 Deployed preview to https://GameDevTecnico.github.io/cubos/preview/pr-1337/
on branch `gh-pages` at 2024-09-29 15:46 UTC

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (1/2)

github-actions · 2024-09-29T15:46:45Z

engine/include/cubos/engine/assets/asset.hpp

+        uuids::uuid mId;  ///< UUID of the asset.
+        void* mRefCount;  ///< Void pointer to avoid including `<atomic>` in the header.
+        int mVersion;     ///< Last known version of the asset.
+        std::string path; ///< Path of the asset.


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

std::string path; ///< Path of the asset.

std::string mPath; ///< Path of the asset.

github-actions · 2024-09-29T15:46:46Z

engine/include/cubos/engine/assets/asset.hpp

        asset.mId = mId;
        asset.mRefCount = mRefCount;
        asset.mVersion = mVersion;
+        asset.path = path;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

asset.path = path;

asset.path = mPath;

github-actions · 2024-09-29T15:46:46Z

engine/src/assets/assets.cpp

@@ -503,6 +512,22 @@ std::unique_lock<std::shared_mutex> Assets::lockWrite(const AnyAsset& handle) co
    abort();
 }

+std::string Assets::checkIdType(const std::string& id) const


⚠️ readability-convert-member-functions-to-static ⚠️
method checkIdType can be made static

Suggested change

std::string Assets::checkIdType(const std::string& id) const

std::string Assets::checkIdType(const std::string& id)

github-actions · 2024-09-29T15:46:46Z

engine/include/cubos/engine/assets/assets.hpp

+        /// @brief Checks if the given ID is of the correct type.
+        /// @param id ID to check.
+        /// @return The ID as a string.
+        std::string checkIdType(const std::string& id) const;


⚠️ readability-convert-member-functions-to-static ⚠️
method checkIdType can be made static

Suggested change

std::string checkIdType(const std::string& id) const;

static std::string checkIdType(const std::string& id) ;

github-actions · 2024-09-29T15:46:46Z

engine/src/assets/assets.cpp

+    {
+        return "UUID";
+    }
+    else if (id.find('/') != std::string::npos || id.find('\\') != std::string::npos)


⚠️ readability-else-after-return ⚠️
do not use else after return

Suggested change

else if (id.find('/') != std::string::npos || id.find('\\') != std::string::npos)

if (id.find('/') != std::string::npos || id.find('\\') != std::string::npos)

github-actions · 2024-09-29T15:46:46Z

engine/src/assets/assets.cpp

+    CUBOS_INFO("Assets::entry 1 Current ID type: {}", checkIdType(id));
+    if (Assets::checkIdType(id) == "Path")
+    {
+        for (auto asset : mEntries)


⚠️ performance-for-range-copy ⚠️
loop variable is copied but only used as const reference; consider making it a const reference

Suggested change

for (auto asset : mEntries)

for (const auto& asset : mEntries)

github-actions · 2024-09-29T15:46:46Z

engine/src/assets/assets.cpp

+    uuids::uuid uuid = uuids::uuid{};
+    if (Assets::checkIdType(id) == "Path")
+    {
+        for (auto asset : mEntries)


⚠️ performance-for-range-copy ⚠️
loop variable is copied but only used as const reference; consider making it a const reference

Suggested change

for (auto asset : mEntries)

for (const auto& asset : mEntries)

github-actions · 2024-09-29T15:46:46Z

engine/include/cubos/engine/assets/asset.hpp

+        uuids::uuid mId;  ///< UUID of the asset.
+        void* mRefCount;  ///< Void pointer to avoid including `<atomic>` in the header.
+        int mVersion;     ///< Last known version of the asset.
+        std::string path; ///< Path of the asset.


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

std::string path; ///< Path of the asset.

std::string mPath; ///< Path of the asset.

github-actions · 2024-09-29T15:46:46Z

engine/include/cubos/engine/assets/asset.hpp

        asset.mId = mId;
        asset.mRefCount = mRefCount;
        asset.mVersion = mVersion;
+        asset.path = path;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

asset.path = path;

asset.mPath = mPath;

github-actions · 2024-09-29T15:46:47Z

engine/include/cubos/engine/assets/asset.hpp

+        uuids::uuid mId;  ///< UUID of the asset.
+        void* mRefCount;  ///< Void pointer to avoid including `<atomic>` in the header.
+        int mVersion;     ///< Last known version of the asset.
+        std::string path; ///< Path of the asset.


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

std::string path; ///< Path of the asset.

std::string mPath; ///< Path of the asset.

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (2/2)

github-actions · 2024-09-29T15:46:58Z

engine/include/cubos/engine/assets/asset.hpp

        asset.mId = mId;
        asset.mRefCount = mRefCount;
        asset.mVersion = mVersion;
+        asset.path = path;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

asset.path = path;

asset.path = mPath;

github-actions · 2024-09-29T15:46:58Z

engine/src/assets/asset.cpp

+        if (str.find('/') != std::string::npos || str.find('\\') != std::string::npos)
+        {
+            idOrPath = str;
+            path = str;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

path = str;

mPath = str;

github-actions · 2024-09-29T15:46:58Z

engine/src/assets/asset.cpp

    , mId(other.mId)
    , mRefCount(other.mRefCount)
    , mVersion(other.mVersion)
+    , path(other.path)


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

, path(other.path)

, mPath(other.mPath)

github-actions · 2024-09-29T15:46:58Z

engine/src/assets/asset.cpp

    , mId(other.mId)
    , mRefCount(other.mRefCount)
    , mVersion(other.mVersion)
+    , path(other.path)


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

, path(other.path)

, mPath(other.mPath)

github-actions · 2024-09-29T15:46:58Z

engine/src/assets/asset.cpp

    mId = other.mId;
    mRefCount = other.mRefCount;
    mVersion = other.mVersion;
+    path = other.path;
    this->incRef();
    return *this;
 }

 AnyAsset& AnyAsset::operator=(AnyAsset&& other) noexcept


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

AnyAsset& AnyAsset::operator=(AnyAsset&& other) noexcept

mPath = other.mPath;

github-actions · 2024-09-29T15:46:58Z

engine/src/assets/asset.cpp

@@ -96,22 +109,27 @@

 int AnyAsset::getVersion() const
 {


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

{

mPath = other.mPath;

github-actions · 2024-09-29T15:46:59Z

engine/src/assets/asset.cpp

 }

 bool AnyAsset::isStrong() const
 {
-    return reflectedId == mId && mRefCount != nullptr;
+    return uuids::uuid::from_string(idOrPath) == mId && mRefCount != nullptr;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member path

Suggested change

return uuids::uuid::from_string(idOrPath) == mId && mRefCount != nullptr;

return mPath;

github-actions · 2024-09-29T15:46:59Z

engine/src/assets/asset.cpp

 {
    this->incRef();
 }

 AnyAsset::AnyAsset(AnyAsset&& other) noexcept
-    : reflectedId(other.reflectedId)
+    : idOrPath(other.idOrPath)


⚠️ performance-move-constructor-init ⚠️
move constructor initializes class member by calling a copy constructor

codecov · 2024-09-29T15:58:23Z

Codecov Report

Attention: Patch coverage is 0% with 84 lines in your changes missing coverage. Please review.

Project coverage is 42.41%. Comparing base (3a4258d) to head (c41711b).
Report is 30 commits behind head on main.

Files with missing lines	Patch %	Lines
engine/src/assets/assets.cpp	0.00%	52 Missing ⚠️
engine/src/assets/asset.cpp	0.00%	20 Missing ⚠️
engine/src/render/mesh/plugin.cpp	0.00%	9 Missing ⚠️
engine/include/cubos/engine/assets/asset.hpp	0.00%	2 Missing ⚠️
engine/src/scene/bridge.cpp	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1337      +/-   ##
==========================================
+ Coverage   36.18%   42.41%   +6.23%     
==========================================
  Files         402      409       +7     
  Lines       32096    29284    -2812     
==========================================
+ Hits        11614    12421     +807     
+ Misses      20482    16863    -3619

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

GalaxyCrush added 4 commits September 28, 2024 20:46

Still works fine with uuids(sometimes), debbuging the ids as paths

4e54728

Needs some review, stuck on a mutex

38414b3

feat(assets): add use paths instead of UUIDs to identifying assets

b2d8aaf

Merge branch '1177-allow-identifying-assets-in-code-from-their-path' of

c41711b

https://github.com/GameDevTecnico/cubos into 1177-allow-identifying-assets-in-code-from-their-path

GalaxyCrush requested review from RiscadoA and a team as code owners September 29, 2024 15:44

GalaxyCrush linked an issue Sep 29, 2024 that may be closed by this pull request

Allow identifying assets in code from their path #1177

Open

GalaxyCrush requested review from fallenatlas and Scarface1809 September 29, 2024 15:44

github-actions bot added A-Engine B-Assets D-Good-First-Issue Easy but interesting labels Sep 29, 2024

github-actions bot reviewed Sep 29, 2024

View reviewed changes

GalaxyCrush closed this Sep 29, 2024

GalaxyCrush deleted the 1177-allow-identifying-assets-in-code-from-their-path branch September 29, 2024 23:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1177 allow identifying assets in code from their path #1337

1177 allow identifying assets in code from their path #1337

GalaxyCrush commented Sep 29, 2024

github-actions bot commented Sep 29, 2024

github-actions bot left a comment

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot left a comment

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

github-actions bot Sep 29, 2024

codecov bot commented Sep 29, 2024 •

edited

Loading

	std::string path; ///< Path of the asset.
	std::string mPath; ///< Path of the asset.

	std::string Assets::checkIdType(const std::string& id) const
	std::string Assets::checkIdType(const std::string& id)

	std::string checkIdType(const std::string& id) const;
	static std::string checkIdType(const std::string& id) ;

	else if (id.find('/') != std::string::npos \|\| id.find('\\') != std::string::npos)
	if (id.find('/') != std::string::npos \|\| id.find('\\') != std::string::npos)

	for (auto asset : mEntries)
	for (const auto& asset : mEntries)

	AnyAsset& AnyAsset::operator=(AnyAsset&& other) noexcept
	mPath = other.mPath;

	return uuids::uuid::from_string(idOrPath) == mId && mRefCount != nullptr;
	return mPath;

1177 allow identifying assets in code from their path #1337

1177 allow identifying assets in code from their path #1337

Conversation

GalaxyCrush commented Sep 29, 2024

Description

Checklist

github-actions bot commented Sep 29, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

github-actions bot Sep 29, 2024

Choose a reason for hiding this comment

codecov bot commented Sep 29, 2024 • edited Loading

Codecov Report

codecov bot commented Sep 29, 2024 •

edited

Loading