feat: updated to 2.0.1

Author: AlexandreMunsch

.cppcheck.suppress

@@ -1,4 +1,3 @@
 cstyleCast
-missingIncludeSystem
 missingInclude
 *:./include/keypop/reader/cpp/Any.hpp

.github/doxygen/Doxyfile

@@ -1,50 +1,14 @@
-name: Build and test code
+name: Build and Test code
 
 on:
   push:
     branches:
       - main
   pull_request:
 
-jobs:
-  build:
-
-    strategy:
-      matrix:
-        env:
-          - toolchain: "toolchain/gcc-linux.cmake"
-            runner: ubuntu-latest
-            generator: ""
-          - toolchain: "toolchain/clang-macos.cmake"
-            runner: macos-latest
-            generator: ""
-          - toolchain: "\"toolchain/clang-windows.cmake\""
-            runner: windows-latest
-            generator: "-G \"Visual Studio 17 2022\""
-
-    runs-on: ${{ matrix.env.runner }}
-
-    steps:
-      - name: Check out repository
-        uses: actions/checkout@v4
 
-      - name: Install Linux reqs
-        if: ${{ matrix.env.runner == 'ubuntu-latest' }}
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y clang cmake cppcheck clang-format clang-tidy gcc pre-commit
-
-      - name: Install macOS reqs
-        if: ${{ matrix.env.runner == 'macos-latest' }}
-        run: |
-          brew install llvm cppcheck clang-format gcc pre-commit
-
-      - name: Build
-        run: |
-          cmake ${{ matrix.env.generator }} -B build -S . -DCMAKE_TOOLCHAIN_FILE=${{ matrix.env.toolchain }}
-          cmake --build build -j8
-
-      - name: Run Linux/macOS tests
-        if: ${{ matrix.env.runner == 'ubuntu-latest' || matrix.env.runner == 'macos-latest' }}
-        run: |
-          ./build/bin/keypopreader_ut
+jobs:
+  call-reusable-workflow:
+    uses: eclipse-keypop/keypop-actions/.github/workflows/reusable-cpp-build-and-test.yml@main # NOSONAR - Same organization, trusted source
+    with:
+      test_executable_name: './build/bin/keypopreader_ut'

.github/workflows/build-and-test.yml

@@ -2,18 +2,13 @@ name: Publish API documentation (release)
 on:
   release:
     types: [published]
-  workflow_dispatch:
-    inputs:
-      version:
-        description: 'Version tag (ex: 1.0.0)'
-        required: true
 
 permissions:
   checks: write
 
 jobs:
   publish-doc-release:
-    uses: eclipse-keypop/keypop-actions/.github/workflows/reusable-publish-doxygen.yml@main
+    uses: eclipse-keypop/keypop-actions/.github/workflows/reusable-publish-doxygen.yml@main # NOSONAR - Same organization, trusted source
     with:
       version: ${{ github.event.inputs.version || github.ref_name }}
-    secrets: inherit
+    secrets: inherit # NOSONAR - Same organization, trusted source

.github/workflows/publish-doc-release.yml

@@ -10,5 +10,5 @@ permissions:
 
 jobs:
   publish-doc-snapshot:
-    uses: eclipse-keypop/keypop-actions/.github/workflows/reusable-publish-doxygen.yml@main
-    secrets: inherit
+    uses: eclipse-keypop/keypop-actions/.github/workflows/reusable-publish-doxygen.yml@main # NOSONAR - Same organization, trusted source
+    secrets: inherit # NOSONAR - Same organization, trusted source

.github/workflows/publish-doc-snapshot.yml

@@ -11,7 +11,7 @@
 CMAKE_MINIMUM_REQUIRED(VERSION 3.5)
 
 PROJECT(KeypopReaderCppApi
-        VERSION 2.0.0
+        VERSION 2.0.1
         LANGUAGES C CXX)
 
 SET(PACKAGE_NAME "keypop-reader-cpp-api")

CMakeLists.txt

@@ -11,6 +11,7 @@
 #pragma once
 
 #include <memory>
+#include <ostream>
 #include <string>
 
 #include "keypop/reader/selection/ScheduledCardSelectionsResponse.hpp"
@@ -100,5 +101,35 @@ class CardReaderEvent {
     getScheduledCardSelectionsResponse() const = 0;
 };
 
+/**
+ * Operator << for CardReaderEvent::Type enum to enable readable logging.
+ *
+ * @param os The output stream.
+ * @param type The event type.
+ * @return The output stream.
+ */
+inline std::ostream&
+operator<<(std::ostream& os, const CardReaderEvent::Type type)
+{
+    switch (type) {
+    case CardReaderEvent::Type::CARD_INSERTED:
+        os << "CARD_INSERTED";
+        break;
+    case CardReaderEvent::Type::CARD_MATCHED:
+        os << "CARD_MATCHED";
+        break;
+    case CardReaderEvent::Type::CARD_REMOVED:
+        os << "CARD_REMOVED";
+        break;
+    case CardReaderEvent::Type::UNAVAILABLE:
+        os << "UNAVAILABLE";
+        break;
+    default:
+        os << "UNKNOWN_TYPE(" << static_cast<int>(type) << ")";
+        break;
+    }
+    return os;
+}
+
 } /* namespace reader */
 } /* namespace keypop */

include/keypop/reader/CardReaderEvent.hpp

@@ -50,9 +50,10 @@ class CardSelector : public CardSelectorBase {
      *
      * <p>The protocol is identified by its <b>logical name</b>.
      *
-     * <p><b>Prerequisites</b>: the reader must be of type keypop::reader::ConfigurableCardReader
-     * and the targeted card protocol(s) must be activated via the
-     * keypop::reader::ConfigurableCardReader#activateProtocol(const
+     * <p><b>Prerequisites</b>: the reader must be of type
+     * keypop::reader::ConfigurableCardReader and the targeted card protocol(s)
+     * must be activated via the keypop::reader
+     * ::ConfigurableCardReader#activateProtocol(const
      * std::string&, const std::string&) method and associated with the logical
      * name used as a filter.
      *

include/keypop/reader/selection/CardSelector.hpp

@@ -42,8 +42,7 @@ class IsoSmartCard : public SmartCard {
      * @return Null if no selection application has been performed.
      * @since 1.0.0
      */
-    virtual const std::vector<uint8_t>&
-    getSelectApplicationResponse() const = 0;
+    virtual std::vector<std::uint8_t> getSelectApplicationResponse() const = 0;
 };
 
 } /* namespace spi */