Update CHANGELOG.md and Configuration class to use LogLib2

- Added entry for version 1.1.7 in CHANGELOG.md
- Updated remote references for dependencies
- Changed logger implementation in Configuration class to use LogLib2

.github/workflows/ci.yml

@@ -1,145 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - 'master'
-  release:
-    types: [created]
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    container:
-      image: php:8.3
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Install dependencies
-        run: |
-          apt update -yqq
-          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
-
-      - name: Install phive
-        run: |
-          wget -O phive.phar https://phar.io/releases/phive.phar
-          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
-          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
-          gpg --verify phive.phar.asc phive.phar
-          chmod +x phive.phar
-          mv phive.phar /usr/local/bin/phive
-
-      - name: Install phab
-        run: |
-          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
-
-      - name: Install latest version of NCC
-        run: |
-          git clone https://git.n64.cc/nosial/ncc.git
-          cd ncc
-          make redist
-          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
-          if [ -z "$NCC_DIR" ]; then
-            echo "NCC build directory not found"
-            exit 1
-          fi
-          php "$NCC_DIR/INSTALL" --auto --install-composer
-          cd .. && rm -rf ncc
-
-      - name: Build project
-        run: |
-          ncc build --config release --log-level debug
-
-      - name: Upload build artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: ncc-build
-          path: build/release/net.nosial.configlib.ncc
-
-  test:
-    needs: build
-    runs-on: ubuntu-latest
-    container:
-      image: php:8.3
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Download build artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: ncc-build
-          path: ncc-build  # Adjust this to download the artifact directly under 'ncc-build'
-
-      - name: Install dependencies
-        run: |
-          apt update -yqq
-          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
-          curl -sSLf -o /usr/local/bin/install-php-extensions https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions
-          chmod +x /usr/local/bin/install-php-extensions
-          install-php-extensions zip
-
-      - name: Install phive
-        run: |
-          wget -O phive.phar https://phar.io/releases/phive.phar
-          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
-          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
-          gpg --verify phive.phar.asc phive.phar
-          chmod +x phive.phar
-          mv phive.phar /usr/local/bin/phive
-
-      - name: Install phab
-        run: |
-          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
-
-      - name: Install latest version of NCC
-        run: |
-          git clone https://git.n64.cc/nosial/ncc.git
-          cd ncc
-          make redist
-          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
-          if [ -z "$NCC_DIR" ]; then
-            echo "NCC build directory not found"
-            exit 1
-          fi
-          php "$NCC_DIR/INSTALL" --auto --install-composer
-          cd .. && rm -rf ncc
-
-      - name: Install NCC packages
-        run: |
-          ncc package install --package="ncc-build/net.nosial.configlib.ncc" --reinstall -y --log-level debug
-
-      - name: Run PHPUnit tests
-        run: |
-          wget https://phar.phpunit.de/phpunit-11.3.phar
-          php phpunit-11.3.phar --configuration phpunit.xml
-
-  release:
-    needs: [build, test]
-    permissions: write-all
-    runs-on: ubuntu-latest
-    container:
-      image: php:8.3
-    if: github.event_name == 'release'
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Download build artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: ncc-build
-          path: ncc-build
-
-      - name: Upload to GitHub Release
-        uses: softprops/action-gh-release@v1
-        with:
-          files: |
-            ncc-build/net.nosial.configlib.ncc
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ncc_workflow.yml

@@ -0,0 +1,552 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          apt update -yqq
+          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
+
+      - name: Install phive
+        run: |
+          wget -O phive.phar https://phar.io/releases/phive.phar
+          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
+          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
+          gpg --verify phive.phar.asc phive.phar
+          chmod +x phive.phar
+          mv phive.phar /usr/local/bin/phive
+
+      - name: Install phab
+        run: |
+          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
+
+      - name: Install latest version of NCC
+        run: |
+          git clone https://git.n64.cc/nosial/ncc.git
+          cd ncc
+          make redist
+          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
+          if [ -z "$NCC_DIR" ]; then
+            echo "NCC build directory not found"
+            exit 1
+          fi
+          php "$NCC_DIR/INSTALL" --auto
+          cd .. && rm -rf ncc
+
+      - name: Build project
+        run: |
+          ncc build --config release --build-source --log-level debug
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: release
+          path: build/release/net.nosial.configlib.ncc
+  debug:
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          apt update -yqq
+          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
+
+      - name: Install phive
+        run: |
+          wget -O phive.phar https://phar.io/releases/phive.phar
+          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
+          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
+          gpg --verify phive.phar.asc phive.phar
+          chmod +x phive.phar
+          mv phive.phar /usr/local/bin/phive
+
+      - name: Install phab
+        run: |
+          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
+
+      - name: Install latest version of NCC
+        run: |
+          git clone https://git.n64.cc/nosial/ncc.git
+          cd ncc
+          make redist
+          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
+          if [ -z "$NCC_DIR" ]; then
+            echo "NCC build directory not found"
+            exit 1
+          fi
+          php "$NCC_DIR/INSTALL" --auto
+          cd .. && rm -rf ncc
+
+      - name: Build project
+        run: |
+          ncc build --config debug --build-source --log-level debug
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: debug
+          path: build/debug/net.nosial.configlib.ncc
+  release-executable:
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          apt update -yqq
+          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
+
+      - name: Install phive
+        run: |
+          wget -O phive.phar https://phar.io/releases/phive.phar
+          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
+          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
+          gpg --verify phive.phar.asc phive.phar
+          chmod +x phive.phar
+          mv phive.phar /usr/local/bin/phive
+
+      - name: Install phab
+        run: |
+          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
+
+      - name: Install latest version of NCC
+        run: |
+          git clone https://git.n64.cc/nosial/ncc.git
+          cd ncc
+          make redist
+          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
+          if [ -z "$NCC_DIR" ]; then
+            echo "NCC build directory not found"
+            exit 1
+          fi
+          php "$NCC_DIR/INSTALL" --auto
+          cd .. && rm -rf ncc
+
+      - name: Build project
+        run: |
+          ncc build --config release-executable --build-source --log-level debug
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-executable
+          path: build/release/release_executable_gz
+  debug-executable:
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          apt update -yqq
+          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
+
+      - name: Install phive
+        run: |
+          wget -O phive.phar https://phar.io/releases/phive.phar
+          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
+          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
+          gpg --verify phive.phar.asc phive.phar
+          chmod +x phive.phar
+          mv phive.phar /usr/local/bin/phive
+
+      - name: Install phab
+        run: |
+          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
+
+      - name: Install latest version of NCC
+        run: |
+          git clone https://git.n64.cc/nosial/ncc.git
+          cd ncc
+          make redist
+          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
+          if [ -z "$NCC_DIR" ]; then
+            echo "NCC build directory not found"
+            exit 1
+          fi
+          php "$NCC_DIR/INSTALL" --auto
+          cd .. && rm -rf ncc
+
+      - name: Build project
+        run: |
+          ncc build --config debug-executable --build-source --log-level debug
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: debug-executable
+          path: build/debug/debug_executable_gz
+  release_executable:
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          apt update -yqq
+          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
+
+      - name: Install phive
+        run: |
+          wget -O phive.phar https://phar.io/releases/phive.phar
+          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
+          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
+          gpg --verify phive.phar.asc phive.phar
+          chmod +x phive.phar
+          mv phive.phar /usr/local/bin/phive
+
+      - name: Install phab
+        run: |
+          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
+
+      - name: Install latest version of NCC
+        run: |
+          git clone https://git.n64.cc/nosial/ncc.git
+          cd ncc
+          make redist
+          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
+          if [ -z "$NCC_DIR" ]; then
+            echo "NCC build directory not found"
+            exit 1
+          fi
+          php "$NCC_DIR/INSTALL" --auto
+          cd .. && rm -rf ncc
+
+      - name: Build project
+        run: |
+          ncc build --config release_executable --build-source --log-level debug
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: release_executable
+          path: build/release/ConfigLib
+  debug_executable:
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          apt update -yqq
+          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
+
+      - name: Install phive
+        run: |
+          wget -O phive.phar https://phar.io/releases/phive.phar
+          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
+          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
+          gpg --verify phive.phar.asc phive.phar
+          chmod +x phive.phar
+          mv phive.phar /usr/local/bin/phive
+
+      - name: Install phab
+        run: |
+          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
+
+      - name: Install latest version of NCC
+        run: |
+          git clone https://git.n64.cc/nosial/ncc.git
+          cd ncc
+          make redist
+          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
+          if [ -z "$NCC_DIR" ]; then
+            echo "NCC build directory not found"
+            exit 1
+          fi
+          php "$NCC_DIR/INSTALL" --auto
+          cd .. && rm -rf ncc
+
+      - name: Build project
+        run: |
+          ncc build --config debug_executable --build-source --log-level debug
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: debug_executable
+          path: build/debug/ConfigLib
+
+
+  # Checking for phpunit.xml
+  check-phpunit:
+    runs-on: ubuntu-latest
+    outputs:
+      phpunit-exists: ${{ steps.check.outputs.phpunit-exists }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Check for phpunit.xml
+        id: check
+        run: |
+          if [ -f phpunit.xml ]; then
+            echo "phpunit-exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "phpunit-exists=false" >> $GITHUB_OUTPUT
+          fi
+  # Checking for phpdoc.dist.xml
+  check-phpdoc:
+    runs-on: ubuntu-latest
+    outputs:
+      phpdoc-exists: ${{ steps.check.outputs.phpdoc-exists }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Check for phpdoc.dist.xml
+        id: check
+        run: |
+          if [ -f phpdoc.dist.xml ]; then
+            echo "phpdoc-exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "phpdoc-exists=false" >> $GITHUB_OUTPUT
+          fi
+  generate-phpdoc:
+    needs: [release, check-phpdoc]
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+    if: needs.check-phpdoc.outputs.phpdoc-exists == 'true'
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          apt update -yqq
+          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
+
+      - name: Download PHPDocumentor
+        run: |
+          wget https://phpdoc.org/phpDocumentor.phar
+          chmod +x phpDocumentor.phar
+
+      - name: Generate PHPDoc
+        run: |
+          php phpDocumentor.phar -d src -t docs
+
+      - name: Archive PHPDoc
+        run: |
+          zip -r docs.zip docs
+
+      - name: Upload PHPDoc
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs.zip
+
+  test:
+    needs: [release, debug, release-executable, debug-executable, release_executable, debug_executable, check-phpunit]
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+    if: needs.check-phpunit.outputs.phpunit-exists == 'true'
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: release
+          path: release
+
+      - name: Install dependencies
+        run: |
+          apt update -yqq
+          apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
+          curl -sSLf -o /usr/local/bin/install-php-extensions https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions
+          chmod +x /usr/local/bin/install-php-extensions
+          install-php-extensions zip
+
+      - name: Install phive
+        run: |
+          wget -O phive.phar https://phar.io/releases/phive.phar
+          wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
+          gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
+          gpg --verify phive.phar.asc phive.phar
+          chmod +x phive.phar
+          mv phive.phar /usr/local/bin/phive
+
+      - name: Install phab
+        run: |
+          phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
+
+      - name: Install latest version of NCC
+        run: |
+          git clone https://git.n64.cc/nosial/ncc.git
+          cd ncc
+          make redist
+          NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
+          if [ -z "$NCC_DIR" ]; then
+            echo "NCC build directory not found"
+            exit 1
+          fi
+          php "$NCC_DIR/INSTALL" --auto
+          cd .. && rm -rf ncc
+
+      - name: Install NCC packages
+        run: |
+          ncc package install --package="release/net.nosial.configlib.ncc" --build-source --reinstall -y --log-level debug
+
+      - name: Run PHPUnit tests
+        run: |
+          wget https://phar.phpunit.de/phpunit-11.3.phar
+          php phpunit-11.3.phar --configuration phpunit.xml --log-junit reports/junit.xml --log-teamcity reports/teamcity --testdox-html reports/testdox.html --testdox-text reports/testdox.txt
+
+      - name: Upload test reports
+        uses: actions/upload-artifact@v4
+        with:
+          name: reports
+          path: reports
+
+
+  release-documentation:
+    needs: generate-phpdoc
+    permissions: write-all
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+    if: github.event_name == 'release'
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Download documentation artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: documentation
+          path: documentation
+
+      - name: Upload documentation artifact
+        uses: softprops/action-gh-release@v1
+        with:
+            files: |
+                documentation/*
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+
+  release-artifacts:
+    needs: [release, debug, release-executable, debug-executable, release_executable, debug_executable]
+    permissions: write-all
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.3
+    if: github.event_name == 'release'
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Download release artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: release
+          path: release
+      - name: Upload release artifact to release
+        uses: softprops/action-gh-release@v1
+        with:
+            files: |
+                release/*
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Download debug artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: debug
+          path: debug
+      - name: Upload debug artifact to release
+        uses: softprops/action-gh-release@v1
+        with:
+            files: |
+                debug/*
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Download release-executable artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: release-executable
+          path: release-executable
+      - name: Upload release-executable artifact to release
+        uses: softprops/action-gh-release@v1
+        with:
+            files: |
+                release-executable/*
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Download debug-executable artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: debug-executable
+          path: debug-executable
+      - name: Upload debug-executable artifact to release
+        uses: softprops/action-gh-release@v1
+        with:
+            files: |
+                debug-executable/*
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Download release_executable artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: release_executable
+          path: release_executable
+      - name: Upload release_executable artifact to release
+        uses: softprops/action-gh-release@v1
+        with:
+            files: |
+                release_executable/*
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Download debug_executable artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: debug_executable
+          path: debug_executable
+      - name: Upload debug_executable artifact to release
+        uses: softprops/action-gh-release@v1
+        with:
+            files: |
+                debug_executable/*
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,2 +1,5 @@
 build/
 /.idea/php-test-framework.xml
+/.idea/gbrowser_project.xml
+/.phpunit.result.cache
+/reports

.idea/ConfigLib.iml

@@ -5,6 +5,7 @@
       <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
       <excludeFolder url="file://$MODULE_DIR$/build" />
+      <excludeFolder url="file://$MODULE_DIR$/reports" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />

.idea/php.xml

@@ -11,20 +11,23 @@
   </component>
   <component name="PhpIncludePathManager">
     <include_path>
+      <path value="/var/ncc/packages/net.nosial.optslib=1.1.2" />
+      <path value="/var/ncc/packages/net.nosial.loglib2=1.0.2" />
+      <path value="/var/ncc/packages/com.symfony.yaml=v7.1.5" />
+      <path value="/var/ncc/packages/net.nosial.loglib=2.0.4" />
+      <path value="/var/ncc/packages/com.symfony.polyfill_mbstring=v1.31.0" />
+      <path value="/var/ncc/packages/com.symfony.polyfill_ctype=v1.31.0" />
       <path value="/usr/share/ncc" />
-      <path value="/var/ncc/packages/net.nosial.loglib=1.1.0" />
-      <path value="/var/ncc/packages/com.symfony.yaml=2.0.7" />
-      <path value="/var/ncc/packages/com.symfony.process=2.0.7" />
       <path value="/usr/share/php" />
     </include_path>
   </component>
-  <component name="PhpProjectSharedConfiguration" php_language_level="8.2" />
+  <component name="PhpProjectSharedConfiguration" php_language_level="8.3" />
   <component name="PhpStanOptionsConfiguration">
     <option name="transferred" value="true" />
   </component>
   <component name="PhpUnit">
     <phpunit_settings>
-      <PhpUnitSettings load_method="PHPUNIT_PHAR" custom_loader_path="$USER_HOME$/phpunit.phar" phpunit_phar_path="$USER_HOME$/phpunit.phar" />
+      <PhpUnitSettings load_method="PHPUNIT_PHAR" custom_loader_path="$PROJECT_DIR$/../phpunit.phar" phpunit_phar_path="$PROJECT_DIR$/../phpunit.phar" />
     </phpunit_settings>
   </component>
   <component name="PsalmOptionsConfiguration">

CHANGELOG.md

@@ -5,6 +5,89 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.7] - 2025-03-14
+
+This update introduces minor changes
+
+### Changed
+ - Updated remote references for dependencies
+ - Updated Library to use net.nosial.loglib2 instead of the now deprecated net.nosial.loglib
+
+
+## [1.1.6] - 2025-01-07
+
+This update introduces minor improvements
+
+### Changed
+ - Changed properties to become typed properties
+
+### Added
+ - Added a new constructor parameter called `path` which is an optional parameter that allows you to specify the path to
+   the configuration files directory. If not specified the library will proceed with resolving
+   the path to the configuration files directory using the default method. This will override
+   the `CONFIGLIB_PATH` environment variable if it is set.
+
+
+## [1.1.5] - 2024-12-27
+
+This update introduces minor improvements
+
+### Added
+ - Add support for CONFIGLIB_PATH environment variable to specify the path to the configuration files directory
+
+
+## [1.1.4] - 2024-10-29
+
+This update introduces a minor bug fix
+
+### Fixed
+- Fixed regex pattern for configuration properties being considered invalid when they contain an underscore.
+
+
+
+## [1.1.3] - 2024-10-13
+
+This update introduces a new build system
+
+
+
+## [1.1.2] - 2024-09-27
+
+ > This change has been reverted
+
+This update fixes a critical bug where configuration files may not be found when using different user accounts,
+especially when the configuration file is located in a directory that is not accessible by the user account running the
+application. This was fixed by changing the way the configuration file path is resolved including by adding a setup
+execution unit that will be executed post-installation to ensure that the configuration file is accessible by the user
+account running the application.
+
+
+## [1.1.1] - 2024-09-26
+
+This update introduces a minor bug fix
+
+### Fixed
+ - Fixed issue where keys containing underscores are considered to be invalid
+
+
+## [1.1.0] - 2024-09-23
+
+This update introduces changes for PHP 8.3 & NCC 2.1.0+ compatibility
+
+### Added
+ - Added PhpUnit tests for the library
+ - Added new option `--path` to the CLI interface to display the path to the configuration file
+
+### Changed
+ - Updated the codebase to be compatible with PHP 8.3
+ - Updated the codebase to be compatible with NCC 2.1.0+
+ - Updated Makefile
+
+### Fixed
+ - Fixed regex patterns to be more robust
+
+
+
 ## [1.0.4] - 2023-08-12
 
 This update introduces minor improvements

Makefile

@@ -1,8 +1,33 @@
-build:
+# Variables
-	ncc build --config="release" --log-level debug
+DEFAULT_CONFIGURATION ?= release
+LOG_LEVEL = debug
 
-install:
+# Default Target
-	sudo ncc package install --package="build/release/net.nosial.configlib.ncc" --skip-dependencies --reinstall -y --log-level debug
+all: release debug release-executable debug-executable release_executable debug_executable
+
+# Build Steps
+release:
+	ncc build --config=release --log-level $(LOG_LEVEL)
+debug:
+	ncc build --config=debug --log-level $(LOG_LEVEL)
+release-executable:
+	ncc build --config=release-executable --log-level $(LOG_LEVEL)
+debug-executable:
+	ncc build --config=debug-executable --log-level $(LOG_LEVEL)
+release_executable:
+	ncc build --config=release_executable --log-level $(LOG_LEVEL)
+debug_executable:
+	ncc build --config=debug_executable --log-level $(LOG_LEVEL)
+
+
+install: release
+	ncc package install --package=build/release/net.nosial.configlib.ncc --skip-dependencies --build-source --reinstall -y --log-level $(LOG_LEVEL)
+
+test: release
+	[ -f phpunit.xml ] || { echo "phpunit.xml not found"; exit 1; }
+	phpunit
 
 clean:
 	rm -rf build
+
+.PHONY: all install test clean release debug release-executable debug-executable release_executable debug_executable

README.md

@@ -9,10 +9,25 @@ be configured more easily by following the documented instructions on how to alt
 could use a builtin editor to edit the configuration file manually.
 
 
+## Community
+
+This project and many others from Nosial are available on multiple publicly available and free git repositories at
+
+- [n64](https://git.n64.cc/nosial/configlib)
+- [GitHub](https://github.com/nosial/configlib)
+- [Codeberg](https://codeberg.org/nosial/configlib)
+
+Issues & Pull Requests are frequently checked and to be referenced accordingly in commits and changes, Nosial remains
+dedicated to keep these repositories up to date when possible.
+
+For questions & discussions see the public Telegram community at [@NosialDiscussions](https://t.me/NosialDiscussions).
+We do encourage community support and discussions, please be respectful and follow the rules of the community.
+
 ## Table of contents
 
 <!-- TOC -->
 * [ConfigLib](#configlib)
+  * [Community](#community)
   * [Table of contents](#table-of-contents)
   * [Installation](#installation)
   * [Compile from source](#compile-from-source)

main

@@ -1,6 +1,24 @@
 <?php
 
-    require('ncc');
+    if (PHP_SAPI !== 'cli')
-    import('net.nosial.configlib', 'latest');
+    {
+        print('net.nosial.configlib must be run from the command line.' . PHP_EOL);
+        exit(1);
+    }
 
-    \ConfigLib\Program::main();
+    if(!isset($argv))
+    {
+        if(isset($_SERVER['argv']))
+        {
+            $argv = $_SERVER['argv'];
+        }
+        else
+        {
+            print('net.nosial.configlib failed to run, no $argv found.' . PHP_EOL);
+            exit(1);
+        }
+    }
+
+    require('ncc');
+    \ncc\Classes\Runtime::import('net.nosial.configlib', 'latest');
+	exit(\ConfigLib\Program::main($argv));

phpdoc.dist.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdocumentor configVersion="3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.phpdoc.org" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd">
+    <paths>
+        <output>build/docs</output>
+        <cache>build/cache</cache>
+    </paths>
+    <version number="latest">
+        <api>
+            <source dsn=".">
+                <path>src/ConfigLib</path>
+            </source>
+            <default-package-name>ConfigLib</default-package-name>
+        </api>
+    </version>
+</phpdocumentor>

project.json

@@ -5,6 +5,9 @@
             "minimum_version": "8.0",
             "maximum_version": "8.2"
         },
+        "options": {
+            "create_symlink": true
+        },
         "update_source": {
             "source": "nosial/libs.config@n64",
             "repository": {
@@ -13,67 +16,48 @@
                 "host": "git.n64.cc",
                 "ssl": true
             }
-        },
-        "options": {
-            "create_symlink": true
         }
     },
-    "execution_policies":[
-        {
-            "name": "main",
-            "runner": "php",
-            "execute": {
-                "target": "main",
-                "working_directory": "%CWD%",
-                "tty": true
-            }
-        }
-    ],
     "assembly": {
         "name": "ConfigLib",
         "package": "net.nosial.configlib",
+        "description": "ConfigLib is a library for reading and writing configuration files via the NCC Runtime API",
         "company": "Nosial",
         "copyright": "Copyright (c) 2022-2023 Nosial",
-        "description": "ConfigLib is a library for reading and writing configuration files via the NCC Runtime API",
+        "version": "1.1.7",
-        "version": "1.1.0",
         "uuid": "9347259e-8e4d-11ed-85a7-fd07cf28ef35"
     },
     "build": {
         "source_path": "src",
         "default_configuration": "release",
-        "main": "main",
+        "main": "main_policy",
         "define_constants": {
-            "version": "%ASSEMBLY.VERSION%"
+            "VERSION": "%ASSEMBLY.VERSION%"
         },
         "dependencies": [
             {
                 "name": "net.nosial.optslib",
                 "version": "latest",
-                "source_type": "remote",
+                "source": "nosial/optslib=latest@github"
-                "source": "nosial/libs.opts=latest@n64"
             },
             {
-                "name": "net.nosial.loglib",
+                "name": "net.nosial.loglib2",
                 "version": "latest",
-                "source_type": "remote",
+                "source": "nosial/loglib2=latest@github"
-                "source": "nosial/libs.log=latest@n64"
             },
             {
                 "name": "com.symfony.filesystem",
                 "version": "latest",
-                "source_type": "remote",
                 "source": "symfony/filesystem=latest@packagist"
             },
             {
                 "name": "com.symfony.yaml",
                 "version": "latest",
-                "source_type": "remote",
                 "source": "symfony/yaml=latest@packagist"
             },
             {
                 "name": "com.symfony.process",
                 "version": "latest",
-                "source_type": "remote",
                 "source": "symfony/process=latest@packagist"
             }
         ],
@@ -90,7 +74,68 @@
                 "define_constants": {
                     "DEBUG": "1"
                 }
+            },
+            {
+                "name": "release-executable",
+                "build_type": "executable",
+                "output": "build/release/release_executable_gz",
+                "options": {
+                    "ncc_configuration": "release"
+                }
+            },
+            {
+                "name": "debug-executable",
+                "build_type": "executable",
+                "output": "build/debug/debug_executable_gz",
+                "options": {
+                    "ncc_configuration": "debug"
+                }
+            },
+            {
+                "name": "release_executable",
+                "build_type": "executable",
+                "output": "build/release/%ASSEMBLY.NAME%",
+                "options": {
+                    "ncc_configuration": "release"
+                }
+            },
+            {
+                "name": "debug_executable",
+                "build_type": "executable",
+                "output": "build/debug/%ASSEMBLY.NAME%",
+                "options": {
+                    "ncc_configuration": "debug"
+                },
+                "define_constants": {
+                    "DEBUG": "1"
+                }
+            }
+        ]
+    },
+    "execution_policies": [
+        {
+            "name": "main",
+            "runner": "php",
+            "execute": {
+                "working_directory": "%CWD%",
+                "silent": false,
+                "tty": true,
+                "timeout": null,
+                "idle_timeout": null,
+                "target": "main"
+            }
+        },
+        {
+            "name": "main_policy",
+            "runner": "php",
+            "execute": {
+                "working_directory": "%CWD%",
+                "silent": false,
+                "tty": true,
+                "timeout": null,
+                "idle_timeout": null,
+                "target": "main"
+            }
         }
     ]
 }
-}

setup

@@ -0,0 +1,14 @@
+<?php
+
+    $global_directory = $path = DIRECTORY_SEPARATOR . 'etc' . DIRECTORY_SEPARATOR . 'configlib';
+
+    //try creating the directory if it doesn't exist
+    if(!file_exists($global_directory))
+    {
+        if(!mkdir($global_directory, 0777, true))
+        {
+            exit('Failed to create global directory');
+        }
+
+        chmod($global_directory, 0777);
+    }

src/ConfigLib/Configuration.php

@@ -1,11 +1,9 @@
 <?php
 
-    /** @noinspection PhpMissingFieldTypeInspection */
-
     namespace ConfigLib;
 
     use Exception;
-    use LogLib\Log;
+    use LogLib2\Logger;
     use RuntimeException;
     use Symfony\Component\Filesystem\Filesystem;
     use Symfony\Component\Yaml\Yaml;
@@ -13,45 +11,51 @@
     class Configuration
     {
         /**
-         * The name of the configuration
+         * The logger of the class
-         *
+         * @var Logger
-         * @var string
          */
-        private $name;
+        private Logger $logger;
+
+        /**
+         * The name of the configuration
+         * @var string|array
+         */
+        private string|array $name;
 
         /**
          * The path to the configuration file
-         *
+         * @var string|null
-         * @var string
          */
-        private $path;
+        private ?string $path;
 
         /**
          * The configuration data
-         *
          * @var array
          */
-        private $configuration;
+        private array $configuration;
 
         /**
          * Indicates if the current instance is modified
-         *
          * @var bool
          */
-        private $modified;
+        private bool $modified;
 
         /**
          * Public Constructor
          *
          * @param string $name The name of the configuration (e.g. "MyApp" or "net.example.myapp")
+         * @param string|null $path The directory where the configuration file will be stored
          */
-        public function __construct(string $name='default')
+        public function __construct(string $name='default', ?string $path=null)
         {
+            $this->logger = new Logger('net.nosial.configlib');
+
             // Sanitize $name for a file path
             $name = strtolower($name);
             $name = str_replace(array('/', '\\', '.'), '_', $name);
-
             $env = getenv(sprintf("CONFIGLIB_%s", strtoupper($name)));
+            $this->path = null;
+
             if($env !== false)
             {
                 if(file_exists($env))
@@ -60,13 +64,36 @@
                 }
                 else
                 {
-                    Log::warning('net.nosial.configlib', sprintf('Environment variable "%s" points to a non-existent file, resorting to default/builtin configuration', $env));
+                    $this->logger->warning(sprintf('Environment variable "%s" points to a non-existent file, resorting to default/builtin configuration', $env));
                 }
             }
 
+            if($path !== null)
+            {
+                if(!is_dir(dirname($path)))
+                {
+                    throw new RuntimeException(sprintf('Directory "%s" does not exist', dirname($path)));
+                }
+
+                if(!is_writable(dirname($path)))
+                {
+                    throw new RuntimeException(sprintf('Directory "%s" is not writable', dirname($path)));
+                }
+
+                $this->path = $path;
+            }
+
             if ($this->path === null)
             {
                 $filePath = $name . '.conf';
+
+                // If the CONFIGLIB_PATH environment variable is set, use it as the configuration path
+                if(getenv('CONFIGLIB_PATH'))
+                {
+                    $configDir = getenv('CONFIGLIB_PATH');
+                }
+                else
+                {
                     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN')
                     {
                         $configDir = getenv('APPDATA') ?: getenv('LOCALAPPDATA');
@@ -112,10 +139,11 @@
 
                         if (!$configDir)
                         {
-                        Log::warning('net.nosial.configlib', sprintf('Unable to find a proper directory to store configuration paths in, using temporary directory instead: %s', sys_get_temp_dir()));
+                            $this->logger->warning(sprintf('Unable to find a proper directory to store configuration paths in, using temporary directory instead: %s', sys_get_temp_dir()));
                             $configDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'configlib';
                         }
                     }
+                }
 
                 // Ensure the directory exists
                 if (!file_exists($configDir))
@@ -143,7 +171,7 @@
                 }
                 catch(Exception $e)
                 {
-                    Log::error('net.nosial.configlib', sprintf('Unable to load configuration "%s", %s', $this->name, $e->getMessage()));
+                    $this->logger->error(sprintf('Unable to load configuration "%s", %s', $this->name, $e->getMessage()), $e);
                     throw new RuntimeException(sprintf('Unable to load configuration "%s"', $this->name), $e);
                 }
             }
@@ -161,9 +189,7 @@
          */
         private static function validateKey(string $input): bool
         {
-            $pattern = '/^([a-zA-Z0-9]+\.?)+$/';
+            if (preg_match('/^[a-zA-Z0-9_]+(\.[a-zA-Z0-9_]+)*$/', $input))
-
-            if (preg_match($pattern, $input))
             {
                 return true;
             }
@@ -337,7 +363,7 @@
             }
 
             $this->modified = false;
-            Log::debug('net.nosial.configlib', sprintf('Configuration "%s" saved', $this->name));
+            $this->logger->debug(sprintf('Configuration "%s" saved', $this->name));
         }
 
         /**
@@ -419,7 +445,7 @@
             }
 
             $this->modified = false;
-            Log::debug('net.nosial.configlib', 'Loaded configuration file: ' . $this->path);
+            $this->logger->debug('Loaded configuration file: ' . $this->path);
         }
 
         /**
@@ -477,7 +503,7 @@
                 }
                 catch(Exception $e)
                 {
-                    Log::error('net.nosial.configlib', sprintf('Unable to save configuration "%s" to disk, %s', $this->name, $e->getMessage()));
+                    $this->logger->error(sprintf('Unable to save configuration "%s" to disk, %s', $this->name, $e->getMessage()), $e);
                 }
             }
         }

src/ConfigLib/Program.php

@@ -4,20 +4,18 @@
 
     use Exception;
     use JetBrains\PhpStorm\NoReturn;
-    use ncc\Exceptions\InvalidPackageNameException;
-    use ncc\Exceptions\InvalidScopeException;
-    use ncc\Exceptions\PackageLockException;
-    use ncc\Exceptions\PackageNotFoundException;
-    use ncc\Runtime;
     use OptsLib\Parse;
     use RuntimeException;
     use Symfony\Component\Filesystem\Filesystem;
     use Symfony\Component\Process\Process;
     use Symfony\Component\Yaml\Exception\ParseException;
     use Symfony\Component\Yaml\Yaml;
+    use function trigger_error;
 
     class Program
     {
+        private static ?string $version = null;
+
         /**
          * Main entry point of the program
          *
@@ -40,6 +38,7 @@
                 $editor = $args['editor'] ?? @$args['e'] ?? null;
                 $export = $args['export'] ?? null;
                 $import = $args['import'] ?? null;
+                $path = $args['path'] ?? null;
 
                 if($configuration_name === null)
                 {
@@ -53,9 +52,16 @@
                 if(!file_exists($configuration->getPath()))
                 {
                     print(sprintf('Configuration \'%s\' does not exist, aborting' . PHP_EOL, $configuration->getName()));
+
                     exit(1);
                 }
 
+                if($path !== null)
+                {
+                    print($configuration->getPath() . PHP_EOL);
+                    exit(0);
+                }
+
                 if($import !== null)
                 {
                     try
@@ -145,7 +151,7 @@
          */
         #[NoReturn] private static function help(): void
         {
-            print('ConfigLib v' . Runtime::getConstant('net.nosial.configlib', 'version') . PHP_EOL . PHP_EOL);
+            print('ConfigLib v' . self::getVersion() . PHP_EOL . PHP_EOL);
 
             print('Usage: configlib [options]' . PHP_EOL);
             print('  -h, --help                        Displays the help menu' . PHP_EOL);
@@ -155,6 +161,7 @@
             print('  -e, --editor <editor>             (Optional) The editor to use (eg; nano, vim, notepad) (External)' . PHP_EOL);
             print('  --export <file>                   (Optional) Exports the configuration to a file' . PHP_EOL);
             print('  --import <file>                   (Optional) Imports the configuration from a file' . PHP_EOL);
+            print('  --path                            (Optional) Displays the configuration storage path' . PHP_EOL);
             print('  --nc                              (Optional) Disables type casting (eg; \'true\' > True) will always be a string' . PHP_EOL);
 
             print('Examples:' . PHP_EOL . PHP_EOL);
@@ -164,6 +171,7 @@
             print(' configlib --conf test --editor nano             Edit the configuration' . PHP_EOL);
             print(' configlib --conf test --export out.json         Export the configuration' . PHP_EOL);
             print(' configlib --conf test --import in.json          Import a configuration' . PHP_EOL);
+            print(' configlib --conf test --path                    Displays the configuration storage path' . PHP_EOL);
 
             exit(0);
         }
@@ -174,10 +182,6 @@
          * @param array $args
          * @param Configuration $configuration
          * @return void
-         * @throws InvalidPackageNameException
-         * @throws InvalidScopeException
-         * @throws PackageLockException
-         * @throws PackageNotFoundException
          */
         #[NoReturn] private static function edit(array $args, Configuration $configuration): void
         {
@@ -196,21 +200,22 @@
             }
             else
             {
-                if(!file_exists(Runtime::getDataPath('net.nosial.configlib') . DIRECTORY_SEPARATOR . 'tmp'))
+                $temporary_directory = sys_get_temp_dir();
+                if(!file_exists($temporary_directory . DIRECTORY_SEPARATOR . 'configlib'))
                 {
-                    if (!mkdir($concurrentDirectory = Runtime::getDataPath('net.nosial.configlib') . DIRECTORY_SEPARATOR . 'tmp', 0777, true) && !is_dir($concurrentDirectory))
+                    if (!mkdir($concurrentDirectory = $temporary_directory . DIRECTORY_SEPARATOR . 'configlib', 0777, true) && !is_dir($concurrentDirectory))
                     {
                         throw new RuntimeException(sprintf('Directory "%s" was not created', $concurrentDirectory));
                     }
 
-                    if(!file_exists(Runtime::getDataPath('net.nosial.configlib') . DIRECTORY_SEPARATOR . 'tmp'))
+                    if(!file_exists($temporary_directory . DIRECTORY_SEPARATOR . 'configlib'))
                     {
                         print('Unable to create the temporary path to use' . PHP_EOL);
                         exit(1);
                     }
                 }
 
-                $tempPath = Runtime::getDataPath('net.nosial.configlib') . DIRECTORY_SEPARATOR . 'tmp';
+                $tempPath = $temporary_directory . DIRECTORY_SEPARATOR . 'configlib';
             }
 
             $fs = new Filesystem();
@@ -276,4 +281,30 @@
 
             exit(0);
         }
+
+        /**
+         * Retrieves the current version of the library. If the version is not set, it checks
+         * if the CONFIGLIB_VERSION constant is defined. If neither is available, it returns 'Unknown'
+         * and triggers a user warning.
+         *
+         * @return string The current version of the library.
+         * @noinspection PhpUndefinedConstantInspection
+         */
+        public static function getVersion(): string
+        {
+            if(self::$version !== null)
+            {
+                return self::$version;
+            }
+
+            if(defined('CONFIGLIB_VERSION'))
+            {
+                self::$version = CONFIGLIB_VERSION;
+                return self::$version;
+            }
+
+            self::$version = 'Unknown';
+            trigger_error('ConfigLib version is unknown', E_USER_WARNING);
+            return self::$version;
+        }
     }

tests/ConfigLib/ConfigurationTest.php

@@ -9,8 +9,12 @@ class ConfigurationTest extends TestCase
     public static function setUpBeforeClass(): void
     {
         $config = new Configuration('test');
+
+        if(file_exists($config->getPath()))
+        {
             unlink($config->getPath());
         }
+    }
 
     public function testConstruct(): void
     {
@@ -24,6 +28,7 @@ class ConfigurationTest extends TestCase
 
         $this->assertTrue($config->set('key1.key2', 'value', true));
         $this->assertEquals('value', $config->get('key1.key2'));
+
     }
 
     public function testSetNotExists(): void
@@ -52,8 +57,10 @@ class ConfigurationTest extends TestCase
     public function testGetMethodWithValidKey(): void
     {
         $config = new Configuration('test');
-        $config->set('key1.key2', 'value');
+        $this->assertTrue($config->set('key1.key2', 'value', true));
         $this->assertEquals('value', $config->get('key1.key2'));
+        $this->assertTrue($config->set('foo.fizz_buzz', 'value', true));
+        $this->assertEquals('value', $config->get('foo.fizz_buzz'));
     }
 
     /**