preparation for semantic versioning

Author: Indenbirken, Marcel IT/HZA-TT

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Changed to new schema format on REXS hp
+- Preparation for semantic versioning (major.minor.patch)
 
 ## [2.1.0]
 

include/rexsapi/RexsVersion.hxx

@@ -40,24 +40,33 @@ namespace rexsapi
     explicit TRexsVersion(const std::string& version)
     {
       static std::regex regExpr{R"(^(\d+)\.(\d+)$)"};
+      static std::regex regExpr_semantic_versioning{R"(^(\d+)\.(\d+)\.(\d+)$)"};
       std::smatch match;
       if (std::regex_search(version, match, regExpr)) {
         m_Major = static_cast<uint32_t>(std::stoul(match[1]));
         m_Minor = static_cast<uint32_t>(std::stoul(match[2]));
-      } else {
+        m_Patch = 0;
+      }
+      else if (std::regex_search(version, match, regExpr_semantic_versioning)) {
+        m_Major = static_cast<uint32_t>(std::stoul(match[1]));
+        m_Minor = static_cast<uint32_t>(std::stoul(match[2]));
+        m_Patch = static_cast<uint32_t>(std::stoul(match[3]));
+      }
+      else {
         throw TException{fmt::format("not a valid version: '{}'", version)};
       }
     }
 
-    TRexsVersion(uint32_t major, uint32_t minor)
+    TRexsVersion(uint32_t major, uint32_t minor, uint32_t patch=0)
     : m_Major{major}
     , m_Minor{minor}
+    , m_Patch{patch}
     {
     }
 
     friend bool operator==(const TRexsVersion& lhs, const TRexsVersion& rhs) noexcept
     {
-      return lhs.getMajor() == rhs.getMajor() && lhs.getMinor() == rhs.getMinor();
+      return lhs.getMajor() == rhs.getMajor() && lhs.getMinor() == rhs.getMinor() && lhs.getPatch() == rhs.getPatch();
     }
 
     friend bool operator!=(const TRexsVersion& lhs, const TRexsVersion& rhs) noexcept
@@ -67,12 +76,12 @@ namespace rexsapi
 
     friend bool operator<(const TRexsVersion& lhs, const TRexsVersion& rhs) noexcept
     {
-      return lhs.getMajor() < rhs.getMajor() || (lhs.getMajor() == rhs.getMajor() && lhs.getMinor() < rhs.getMinor());
+      return lhs.getMajor() < rhs.getMajor() || (lhs.getMajor() == rhs.getMajor() && lhs.getMinor() < rhs.getMinor()) || (lhs.getMajor() == rhs.getMajor() && lhs.getMinor() < rhs.getMinor() && lhs.getPatch() < rhs.getPatch());
     }
 
     friend bool operator>(const TRexsVersion& lhs, const TRexsVersion& rhs) noexcept
     {
-      return lhs.getMajor() > rhs.getMajor() || (lhs.getMajor() == rhs.getMajor() && lhs.getMinor() > rhs.getMinor());
+      return lhs.getMajor() > rhs.getMajor() || (lhs.getMajor() == rhs.getMajor() && lhs.getMinor() > rhs.getMinor()) || (lhs.getMajor() == rhs.getMajor() && lhs.getMinor() > rhs.getMinor() && lhs.getPatch() > rhs.getPatch());
     }
 
     friend bool operator<=(const TRexsVersion& lhs, const TRexsVersion& rhs) noexcept
@@ -95,19 +104,25 @@ namespace rexsapi
       return m_Minor;
     }
 
+    uint32_t getPatch() const noexcept
+    {
+      return m_Patch;
+    }
+
     /**
      * @brief Returns string representation of the version.
      *
      * @return std::string containing a major and a minor version number separated with a dot
      */
     std::string asString() const
     {
-      return fmt::format("{}.{}", m_Major, m_Minor);
+      return (m_Major<=1) ? fmt::format("{}.{}", m_Major, m_Minor) : fmt::format("{}.{}.{}", m_Major, m_Minor, m_Patch);
     }
 
   private:
     uint32_t m_Major;
     uint32_t m_Minor;
+    uint32_t m_Patch;
   };
 }
 
@@ -122,7 +137,7 @@ namespace std
   struct hash<rexsapi::TRexsVersion> {
     std::size_t operator()(const rexsapi::TRexsVersion& version) const noexcept
     {
-      return std::hash<uint64_t>{}(static_cast<uint64_t>(version.getMajor()) * 100 + version.getMinor());
+      return std::hash<uint64_t>{}(static_cast<uint64_t>(version.getMajor()) * 10000 + static_cast<uint64_t>(version.getMinor()) * 100 + version.getPatch());
     }
   };
 }

test/RexsVersionTest.cxx

@@ -44,7 +44,7 @@ TEST_CASE("Rexs version test")
   SUBCASE("To string")
   {
     CHECK(rexsapi::TRexsVersion{"1.4"}.asString() == "1.4");
-    CHECK(rexsapi::TRexsVersion{"21.99"}.asString() == "21.99");
+    CHECK(rexsapi::TRexsVersion{"21.99"}.asString() == "21.99.0");
   }
 
   SUBCASE("Compare")