Use <year>.<month>.<day> as a versioning system.

Author: agarny

CMakeLists.txt

@@ -14,8 +14,22 @@
 
 cmake_minimum_required(VERSION 3.15)
 
+# Some CMake policies.
+
+foreach(POLICY CMP0096 CMP0144)
+    if(POLICY ${POLICY})
+        cmake_policy(SET ${POLICY} NEW)
+    endif()
+endforeach()
+
+# Project details.
+
+string(TIMESTAMP CURRENT_YEAR "%Y")
+string(TIMESTAMP CURRENT_MONTH "%m")
+string(TIMESTAMP CURRENT_DAY "%d")
+
 project(libOpenCOR
-        VERSION 0.0.0)
+        VERSION "${CURRENT_YEAR}.${CURRENT_MONTH}.${CURRENT_DAY}")
 
 string(TOLOWER "${CMAKE_PROJECT_NAME}" CMAKE_PROJECT_NAME_LC)
 
@@ -25,13 +39,7 @@ set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
-# Some common CMake policies, functions, and macros.
-
-foreach(POLICY CMP0144)
-    if(POLICY ${POLICY})
-        cmake_policy(SET ${POLICY} NEW)
-    endif()
-endforeach()
+# Some common functions and macros.
 
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
 

setup.py

@@ -13,11 +13,16 @@
 # limitations under the License.
 
 
+import datetime
 from skbuild import setup
 
+year = datetime.datetime.now().year
+month = datetime.datetime.now().month
+day = datetime.datetime.now().day
+
 setup(
     name="libopencor",
-    version="0.0.0",
+    version=f"{year}.{month:02}.{day:02}",
     description="libOpenCOR is the backend library to OpenCOR, an open source cross-platform modelling environment.",
     author="libOpenCOR contributors",
     url="https://opencor.ws/libopencor",

src/CMakeLists.txt

@@ -59,13 +59,7 @@ endif()
 
 # Configure the version file.
 
-foreach(VERSION_PART PROJECT_VERSION_MAJOR PROJECT_VERSION_MINOR PROJECT_VERSION_PATCH)
-    if(${${VERSION_PART}} LESS 10)
-        set(${VERSION_PART}_PAD 0)
-    endif()
-endforeach()
-
-set(LIBOPENCOR_VERSION 0x${PROJECT_VERSION_MAJOR_PAD}${PROJECT_VERSION_MAJOR}${PROJECT_VERSION_MINOR_PAD}${PROJECT_VERSION_MINOR}${PROJECT_VERSION_PATCH_PAD}${PROJECT_VERSION_PATCH})
+set(LIBOPENCOR_VERSION 0x${PROJECT_VERSION_MAJOR}${PROJECT_VERSION_MINOR}${PROJECT_VERSION_PATCH})
 set(LIBOPENCOR_VERSION_STRING ${PROJECT_VERSION})
 
 set(VERSION_HEADER_FILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/version.h.in)

tests/api/version/tests.cpp

@@ -16,12 +16,37 @@ limitations under the License.
 
 #include "tests/utils.h"
 
+#include <array>
+#include <chrono>
 #include <libopencor>
 
 TEST(VersionTest, libOpenCOR)
 {
-    EXPECT_EQ(0x000000U, libOpenCOR::version());
-    EXPECT_EQ("0.0.0", libOpenCOR::versionString());
+    static const int TEN_THOUSAND = 10000;
+    static const int HUNDRED = 100;
+    static const int TEN = 10;
+
+    auto now = std::chrono::year_month_day {std::chrono::time_point_cast<std::chrono::days>(std::chrono::system_clock::now())};
+    auto year = static_cast<int>(now.year());
+    auto month = static_cast<int>(static_cast<unsigned>(now.month()));
+    auto day = static_cast<int>(static_cast<unsigned>(now.day()));
+    int version = 0;
+    int number = TEN_THOUSAND * year + HUNDRED * month + day;
+
+    for (int i = 0; number != 0; i += 4) {
+        version |= (number % TEN) << i; // NOLINT
+        number /= TEN;
+    }
+
+    static const size_t VERSION_STRING_SIZE = 11;
+
+    std::array<char, VERSION_STRING_SIZE> versionString {};
+
+    EXPECT_EQ(std::snprintf(versionString.data(), VERSION_STRING_SIZE, "%d.%02d.%02d", year, month, day), VERSION_STRING_SIZE - 1); // NOLINT
+    // Note: ideally, we would be using std::format(), but it is not available on some of the CI systems we are using.
+
+    EXPECT_EQ(version, libOpenCOR::version());
+    EXPECT_EQ(versionString.data(), libOpenCOR::versionString());
 }
 
 TEST(VersionTest, Clang)

tests/bindings/javascript/version.test.js

@@ -20,8 +20,25 @@ const libopencor = await libOpenCOR();
 
 describe("Version tests", () => {
   test("libOpenCOR", () => {
-    expect(libopencor.version()).toBe(0x000000);
-    expect(libopencor.versionString()).toBe("0.0.0");
+    const now = new Date();
+    const year = now.getFullYear();
+    const month = now.getMonth() + 1;
+    const day = now.getDate();
+
+    let version = 0;
+    let number = 10000 * year + 100 * month + day;
+    let i = 0;
+
+    while (number != 0) {
+      version |= number % 10 << i;
+      number = Math.floor(number / 10);
+      i += 4;
+    }
+
+    expect(libopencor.version()).toBe(version);
+    expect(libopencor.versionString()).toBe(
+      `${year}.${String(month).padStart(2, "0")}.${String(day).padStart(2, "0")}`,
+    );
   });
 
   test("libCellML", () => {

tests/bindings/python/test_version.py

@@ -13,19 +13,34 @@
 # limitations under the License.
 
 
+import datetime
 import libopencor as oc
 
 
+now = datetime.datetime.now()
+
+
 def test_version():
+    version = 0
+    number = 10000 * now.year + 100 * now.month + now.day
+    i = 0
+
+    while number != 0:
+        version |= (number % 10) << i
+        number //= 10
+        i += 4
+
     assert isinstance(oc.version(), int)
-    assert oc.version() == 0x000000
+    assert oc.version() == version
 
 
 def test_version_string():
-    assert oc.__version__ == "0.0.0"
+    version = f"{now.year}.{now.month:02}.{now.day:02}"
+
+    assert oc.__version__ == version
 
     assert isinstance(oc.version_string(), str)
-    assert oc.version_string() == "0.0.0"
+    assert oc.version_string() == version
 
 
 def test_clang_version():