v3 preparation

.github/workflows/build.yml

@@ -11,10 +11,8 @@ jobs:
     # Defines the compiler configurations for the other jobs.
     #
     #####
-    define-config:
+    define-matrix:
         runs-on: ubuntu-latest
-        outputs:
-            config: ${{ steps.output-config.outputs.config }}
         env:
             config: |
                 [
@@ -138,7 +136,7 @@ jobs:
                         "os": "macos-latest",
                         "compiler_name": "AppleClang",
                         "compiler_version": 18,
-                        "ldflags_workaround": "-L/opt/homebrew/opt/llvm/lib/c++ -L/opt/homebrew/opt/llvm/lib -lunwind",
+                        "ldflags_workaround": "-L/opt/homebrew/opt/llvm/lib/c++ -L/opt/homebrew/opt/llvm/lib/unwind -lunwind",
                         "asan": true
                     },
                     {
@@ -159,15 +157,45 @@ jobs:
                     }
                 ]
 
+        outputs:
+            config: ${{ steps.output-config.outputs.config }}
+            build_modes: ${{ steps.output-options.outputs.build_modes }}
+            cxx_versions: ${{ steps.output-options.outputs.cxx_versions }}
+
         steps:
             - name: Output configs
               id: output-config
               shell: bash
               run: |
-                  # seems to convert that to a single-line json and thus please the output step
-                  # wrap in single '!
-                  OUTPUT='${{ env.config }}'
-                  echo "config=$(echo $OUTPUT)" >> "$GITHUB_OUTPUT"
+                # seems to convert that to a single-line json and thus please the output step
+                # wrap in single '!
+                OUTPUT='${{ env.config }}'
+                echo "config=$(echo $OUTPUT)" >> "$GITHUB_OUTPUT"
+
+            # enables debug-mode and c++20 for all cases
+            - name: Enable base matrix
+              shell: bash
+              run: |
+                echo "BUILD_MODES=\"Debug\"" >> $GITHUB_ENV
+                echo "CXX_VERSIONS=20" >> $GITHUB_ENV
+
+             # if its a PR from development or the main branch in general, add release-mode and c++23
+            - name: Enable extended matrix
+              if: ${{
+                        (github.event_name == 'pull_request' && github.head_ref == 'development')
+                        || github.ref_name == 'main'
+                   }}
+              shell: bash
+              run: |
+                echo "BUILD_MODES=$(echo $BUILD_MODES, \"Release\")" >> $GITHUB_ENV
+                echo "CXX_VERSIONS=$(echo $CXX_VERSIONS, 23)" >> $GITHUB_ENV
+
+            - name: Output build-modes and c++-versions
+              id: output-options
+              shell: bash
+              run: |
+                 echo "build_modes=$(echo [ $BUILD_MODES ])" >> "$GITHUB_OUTPUT"
+                 echo "cxx_versions=$(echo [ $CXX_VERSIONS ])" >> "$GITHUB_OUTPUT"
 
     ############
     #
@@ -182,7 +210,7 @@ jobs:
     #
     #####
     run-unit-tests:
-        needs: define-config
+        needs: define-matrix
         name: |
             [UT]
             ${{ matrix.config.prefix }} 
@@ -195,11 +223,11 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                build_mode: [Debug, Release]
-                cxx_standard: [20, 23]
                 format_backend: [std, fmt]
                 str_matcher: [char, unicode]
-                config: ${{ fromJSON(needs.define-config.outputs.config) }}
+                build_mode: ${{ fromJSON(needs.define-matrix.outputs.build_modes) }}
+                cxx_standard: ${{ fromJSON(needs.define-matrix.outputs.cxx_versions) }}
+                config: ${{ fromJSON(needs.define-matrix.outputs.config) }}
 
                 exclude:
                     # all listed compilers do not support std's format header
@@ -216,18 +244,27 @@ jobs:
                         compiler_name: "AppleClang"
                         compiler_version: 16
 
+                    # The format_backend and str_matcher options are rather orthogonal.
+                    # To see, whether support both str_matcher variants, let's use the fmt backend,
+                    # as this is supported by all compilers.
+                    - format_backend: "std"
+                      str_matcher: "unicode"
+
         steps:
             - uses: actions/checkout@v4
 
             - name: Setup macOS
               if: startsWith(matrix.config.os, 'macOS')
               shell: bash
               run: |
+                env brew install ninja llvm
                 LLVM_NAME=llvm@${{ matrix.config.compiler_version }}
-                env brew install ninja $LLVM_NAME
+                env brew install $LLVM_NAME
                 LLVM_PATH="$(brew --prefix $LLVM_NAME)"
                 echo "CC=$(echo $LLVM_PATH/bin/clang)" >> $GITHUB_ENV
                 echo "CXX=$(echo $LLVM_PATH/bin/clang++)" >> $GITHUB_ENV
+
+                # solves this issue: https://github.com/Homebrew/homebrew-core/issues/178435
                 echo "LDFLAGS=$(echo $LDFLAGS ${{ matrix.config.ldflags_workaround }})" >> $GITHUB_ENV
 
                 echo "CMAKE_CONFIG_EXTRA=$(echo $CMAKE_CONFIG_EXTRA -DCMAKE_BUILD_TYPE=${{ matrix.build_mode }})" >> $GITHUB_ENV
@@ -320,7 +357,7 @@ jobs:
     #
     #####
     run-adapter-tests:
-        needs: define-config
+        needs: define-matrix
         name: |
             [AT]
             ${{ matrix.config.prefix }} 
@@ -333,17 +370,9 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                build_mode: [Debug, Release]
-                cxx_standard: [20, 23]
-                config: ${{ fromJSON(needs.define-config.outputs.config) }}
-
-                exclude:
-                    # This compiler does work, but fails compiling something from boost::filesystem, which is indirectly required
-                    # by the BoostAdapter-Test.
-                    # Maybe, we can find a workaround for this in the future.
-                    - config:
-                        compiler_name: "AppleClang"
-                        compiler_version: 16
+                build_mode: ${{ fromJSON(needs.define-matrix.outputs.build_modes) }}
+                cxx_standard: ${{ fromJSON(needs.define-matrix.outputs.cxx_versions) }}
+                config: ${{ fromJSON(needs.define-matrix.outputs.config) }}
 
         steps:
             - uses: actions/checkout@v4
@@ -352,8 +381,9 @@ jobs:
               if: startsWith(matrix.config.os, 'macOS')
               shell: bash
               run: |
+                env brew install ninja llvm
                 LLVM_NAME=llvm@${{ matrix.config.compiler_version }}
-                env brew install ninja $LLVM_NAME
+                env brew install $LLVM_NAME
                 LLVM_PATH="$(brew --prefix $LLVM_NAME)"
                 echo "CC=$(echo $LLVM_PATH/bin/clang)" >> $GITHUB_ENV
                 echo "CXX=$(echo $LLVM_PATH/bin/clang++)" >> $GITHUB_ENV

CMakeLists.txt

@@ -1,12 +1,16 @@
+#          Copyright Dominic (DNKpp) Koepke 2024 - 2024.
+# Distributed under the Boost Software License, Version 1.0.
+#    (See accompanying file LICENSE_1_0.txt or copy at
+#          https://www.boost.org/LICENSE_1_0.txt)
+
 cmake_minimum_required(VERSION 3.15)
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
-include(get_cpm)
 
 project(
 	mimicpp
 	LANGUAGES		CXX
-	VERSION			2
+	VERSION			3
 	DESCRIPTION		"A modern and (mostly) macro free mocking-framework"
 	HOMEPAGE_URL	"https://github.com/DNKpp/mimicpp"
 )
@@ -40,7 +44,12 @@ target_compile_features(
 	cxx_std_${CMAKE_CXX_STANDARD}
 )
 
-include(mimic++-configuration-options)
+include(EnableConfigOptions)
+target_link_libraries(
+	mimicpp
+	INTERFACE
+	mimicpp::internal::config-options
+)
 
 if (CMAKE_SOURCE_DIR STREQUAL mimicpp_SOURCE_DIR)
 	set(IS_TOP_LEVEL_PROJECT ON)

README.md

@@ -48,7 +48,7 @@ As I'm mainly working on template or functional-style code, I wanted something s
 So, ``mimicpp::Mock`` objects can directly be used as functional objects, but they can also be used as member objects and thus serve as actual member functions.
 
 If you are curious, have a look at the [documentation](https://dnkpp.github.io/mimicpp/), investigate the examples folder or play around online at
-[godbolt.org](https://godbolt.org/z/nfhT9xa4E).
+[godbolt.org](https://godbolt.org/z/o3Thdcr7T).
 
 ### Core Design
 
@@ -62,7 +62,8 @@ So, Mocks and Expectations are going together hand in hand.
 
 ### Examples
 
-#### Mocks as function objects
+<details>
+<summary>Mocks as function objects</summary>
 
 As already said, ``mimicpp::Mock``s are already function objects.
 
@@ -117,7 +118,10 @@ TEST_CASE("Mocks can be overloaded.")
 }
 ```
 
-#### Mocks as member functions
+</details>
+
+<details>
+<summary>Mocks as member functions</summary>
 
 ``mimicpp::Mock``s can also serve as member functions. Sure, there are some limitations, but for the most cases it works well.
 
@@ -148,7 +152,10 @@ TEST_CASE("Mocks can be used as member functions.")
 }
 ```
 
-#### Mocking interfaces
+</details>
+
+<details>
+<summary>Mocking interfaces</summary>
 
 ``mimic++`` also provides helpers for interface mocking.
 
@@ -235,6 +242,42 @@ TEST_CASE("Interface overload-sets are directly supported.")
 }
 ```
 
+</details>
+
+<details>
+<summary>Watching object-instances</summary>
+
+``mimicpp::Watched`` helper can report destruction and relocations of object-instances.
+
+```cpp
+#include <mimic++/mimic++.hpp>
+
+namespace expect = mimicpp::expect;
+namespace then = mimicpp::then;
+
+TEST_CASE("LifetimeWatcher and RelocationWatcher can trace object instances.")
+{
+    mimicpp::Watched<
+        mimicpp::Mock<void()>,
+        mimicpp::LifetimeWatcher,
+        mimicpp::RelocationWatcher> watched{};
+
+    SCOPED_EXP watched.expect_destruct();
+    int relocationCounter{};
+    SCOPED_EXP watched.expect_relocate()
+                and then::invoke([&] { ++relocationCounter; })
+                and expect::at_least(1);
+
+    std::optional wrapped{std::move(watched)};  // satisfies one relocate-expectation
+    std::optional other{std::move(wrapped)};    // satisfies a second relocate-expectation
+    wrapped.reset();                            // won't require a destruct-expectation, as moved-from objects are considered dead
+    other.reset();                              // fulfills the destruct-expectation
+    REQUIRE(2 == relocationCounter);            // let's see, how often the instance has been relocated
+}
+```
+
+</details>
+
 ### Other Choices
 
 #### Always Stay Within The Language Definition
@@ -365,6 +408,10 @@ Official adapters exist for the following frameworks:
 ``mimic++`` utilizes a strict testing policy, thus each official feature is well tested. The effect of those test-cases are always tracked by the extensive ci,
 which checks the compilation success, test cases outcomes and coverage on dozens of different os, compiler and build configurations.
 
+For the test builds the flags ``-Wall -Wextra -Wpedantic -Werror`` (on MSVC ``/W4 /WX``) are set.
+This is done to make sure, that ``mimic++`` won't flood your build output with endless warnings (or even worse: break your builds),
+if you enable these flags in your own projects.
+
 The coverage is generated via ``gcov`` and evaluated by
 [codacy](https://app.codacy.com/gh/DNKpp/mimicpp),
 [codecov](https://codecov.io/gh/DNKpp/mimicpp) and
@@ -376,7 +423,8 @@ The goal is to be close to 100% as possible.
 On the other hand-side, there is a whole range of code which doesn't even get investigated by these tools: templates (and macros).
 ``mimic++`` has **a lot** of templating code at the very heart, which is at least of equal effort to get right (and tested). So, treat the coverage percentage with a grain of salt.
 
-### CI Tests
+<details>
+<summary>CI Tests</summary>
 
 The listed configurations are explicitly tested, but other do probably work, too.
 As new compilers become available, they will be added to the workflow, but older compilers will probably never be supported.
@@ -410,11 +458,11 @@ As new compilers become available, they will be added to the workflow, but older
 
 | Compiler          | libstdc++ | libc++ | c++-20 | c++-23 | std-format | fmt |
 |-------------------|:---------:|:------:|:------:|:------:|:----------:|:---:|
-| AppleClang-16.0.6^1^ |     ?     |    x   |    x   |    x   |      x     |  x  |
+| AppleClang-16.0.6 |     ?     |    x   |    x   |    x   |      x     |  x  |
 | AppleClang-17.0.6 |     ?     |    x   |    x   |    x   |      x     |  x  |
 | AppleClang-18.1.6 |     ?     |    x   |    x   |    x   |      x     |  x  |
 
-^1^ There is an issue with AppleClang-16 and ``boost::filesystem`` on the current ``macos-latest``, but this is just for the boost-test-adapter. Everything else works fine.
+</details>
 
 ---