Merge pull request #141 from rollbar/fixed/issue-136-composer-dependencies-conflict-with-other-plugins

Fixed #138 Added PHP-Scoper to build to prevent dependency conflicts.

Author: danielmorell

.github/workflows/php_unit.yml

@@ -28,6 +28,7 @@ jobs:
           - '8.2'
           - '8.3'
           - '8.4'
+          - '8.5'
         wordpress:
           - '6.5'
           - '6.7'
@@ -76,4 +77,50 @@ jobs:
       - name: Running unit tests
         run: |
           set -o pipefail
-          npm run test
+          npm run test
+
+      # ------------------------------------------------ #
+      # Build Plugin and Run Tests on Built Distribution #
+      # ------------------------------------------------ #
+
+      - name: Stop Docker environment
+        # Remove this check when https://github.com/humbug/php-scoper/issues/1139 is resolved.
+        if: matrix.php != '8.5'
+        run: npm run wp-env stop
+
+      - name: Build Plugin
+        if: matrix.php != '8.5'
+        run: bin/build.sh
+
+      - name: Copy Test Files
+        if: matrix.php != '8.5'
+        run: |
+          cp .wp-env.json dist/.wp-env.json
+          cp package.json dist/package.json
+          cp package-lock.json dist/package-lock.json
+          cp phpcs.xml dist/phpcs.xml
+          cp phpunit.xml dist/phpunit.xml
+          cp -r tests dist/tests
+
+      - name: Install Dist Composer Dependencies
+        if: matrix.php != '8.5'
+        working-directory: dist
+        run: composer install --no-interaction --no-progress --no-suggest --optimize-autoloader
+
+      - name: Start Dist Docker environment
+        if: matrix.php != '8.5'
+        working-directory: dist
+        run: npm run wp-env start
+
+      - name: Log running Dist Docker containers
+        if: matrix.php != '8.5'
+        working-directory: dist
+        run: docker ps -a
+
+      - name: Running Dist unit tests
+        if: matrix.php != '8.5'
+        working-directory: dist
+        # We don't run phpcs here because the dist files are modified by the build script.
+        run: |
+          set -o pipefail
+          npm run test:php

.gitignore

@@ -43,3 +43,5 @@ intermediate
 cache
 node_modules
 vendor
+dist
+build

README.md

@@ -346,13 +346,13 @@ This is only for contributors with committer access:
     1. Fetch the latest contents of Subversion repo with `svn update`.
     2. Remove the contents of `trunk/` with `rm -Rf trunk`.
     3. Update the contents of `trunk/` with a clone of the tag you created in step 2.
-        1. `git clone https://github.com/rollbar/rollbar-php-wordpress.git trunk`
-        2. `cd trunk && git checkout tags/v[version number] && cd ..`
-        3. `rm -Rf trunk/.git`
+        1. Checkout the tag you created in step 2: `git checkout tags/v[version number]`
+        2. Run `bin/build.sh` to build the plugin.
+        3. Copy the contents of `dist/` to `trunk/`
         4. `svn add trunk --force`
-        5. `svn commit -m"Sync with GitHub repo"`
+        5. `svn commit -m "Sync with GitHub repo"`
     4. Create the Subversion tag:
-       `svn copy https://plugins.svn.wordpress.org/rollbar/trunk https://plugins.svn.wordpress.org/rollbar/tags/[version number] -m"Tag [version number]"`.
+       `svn copy https://plugins.svn.wordpress.org/rollbar/trunk https://plugins.svn.wordpress.org/rollbar/tags/[version number] -m "Tag [version number]"`.
        Notice the version number in Subversion doesn't include the "v" prefix.
 
 ## Disclaimer

bin/build.sh

@@ -0,0 +1,36 @@
+#! /bin/sh
+
+set -e
+
+echo "Building plugin ..."
+
+ROOT_DIR=$(realpath "$(dirname "$(dirname "$0")")")
+
+rm -rf "$ROOT_DIR/build"
+mkdir -p "$ROOT_DIR/build"
+
+echo " - Copying files to build/ ..."
+
+cp -r "$ROOT_DIR/mu-plugin/" "$ROOT_DIR/build/mu-plugin/"
+cp -r "$ROOT_DIR/public/" "$ROOT_DIR/build/public/"
+cp -r "$ROOT_DIR/src/" "$ROOT_DIR/build/src/"
+cp -r "$ROOT_DIR/templates/" "$ROOT_DIR/build/templates/"
+cp "$ROOT_DIR/composer.json" "$ROOT_DIR/build/"
+cp "$ROOT_DIR/composer.lock" "$ROOT_DIR/build/"
+cp "$ROOT_DIR/LICENSE" "$ROOT_DIR/build/"
+cp "$ROOT_DIR/README.md" "$ROOT_DIR/build/"
+cp "$ROOT_DIR/readme.txt" "$ROOT_DIR/build/"
+cp "$ROOT_DIR/rollbar.php" "$ROOT_DIR/build/"
+
+echo " - Installing dependencies with Composer ..."
+
+cd "$ROOT_DIR/build"
+
+composer install --no-dev --optimize-autoloader
+
+echo " - Namespace prefixing with PHP-Scoper ..."
+
+cd "$ROOT_DIR"
+
+rm -rf "$ROOT_DIR/dist"
+vendor/bin/php-scoper add-prefix "$ROOT_DIR/build"

composer.json

@@ -12,7 +12,8 @@
         "squizlabs/php_codesniffer": "^3.5",
         "phpcompatibility/php-compatibility": "^9.3",
         "wp-coding-standards/wpcs": "^2.2",
-        "sirbrillig/phpcs-variable-analysis": "^2.8"
+        "sirbrillig/phpcs-variable-analysis": "^2.8",
+        "humbug/php-scoper": "^0.18.7"
     },
     "license": "GPL-2.0-or-later",
     "authors": [