php setup

.github/workflows/release.yml

@@ -0,0 +1,121 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+permissions:
+  contents: "write"
+
+jobs:
+  tests:
+    name: Release tests
+    uses: ./.github/workflows/tests.yml
+
+  build:
+    name: Build client
+    runs-on: ubuntu-latest
+    needs: tests
+    steps:
+      - name: Setup node
+        uses: actions/setup-node@v6
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Cache node modules
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Replace textdomains
+        run: find src -exec sed -i "s/http-bridge/forms-bridge/g" {} \;
+
+      - name: Build
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: forms-bridge/assets/plugin.bundle.js
+
+  package:
+    name: Prepare package
+    runs-on: ubuntu-latest
+    container:
+      image: codeccoop/wp-cli
+    env:
+      ZIP: "${{ github.ref_name }}.zip"
+    needs: build
+    steps:
+      - name: Setup node
+        uses: actions/setup-node@v6
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: build
+          path: forms-bridge/assets
+
+      - name: Install dist archive
+        run: wp package install wp-cli/dist-archive-command:@stable
+
+      - name: Replace textdomains
+        run: |
+          find forms-bridge/deps/plugin -name '*.php' -exec sed -i "s/wpct-plugin/forms-bridge/g" {} \;
+          find forms-bridge -name '*.php' -exec sed -i "s/wpct_plugin_/forms_bridge_plugin_/g" {} \;
+          find forms-bridge -name "*.php" -exec sed -i 's/WPCT_PLUGIN/FORMS_BRIDGE\\Plugin/g' {} \;
+          find forms-bridge/deps/http -name '*.php' -exec sed -i "s/http-bridge/forms-bridge/g" {} \;
+          find forms-bridge -name '*.php' -exec sed -i "s/http_bridge_/forms_bridge_http_/g" {} \;
+          find forms-bridge -name "*.php" -exec sed -i 's/HTTP_BRIDGE_/FORMS_BRIDGE_HTTP_/g' {} \;
+          find forms-bridge -name '*.php' -exec sed -i 's/HTTP_BRIDGE/FORMS_BRIDGE\\Http/g' {} \;
+
+      - name: Archive
+        run: wp dist-archive forms-bridge ./"$ZIP"
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: plugin-archive
+          path: ${{ env.ZIP }}
+
+  release:
+    name: Release pushed tag
+    runs-on: ubuntu-latest
+    needs: package
+    env:
+      ZIP: "${{ github.ref_name }}.zip"
+    steps:
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: plugin-archive
+
+      - name: Create release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TAG: ${{ github.ref_name }}
+        run: |
+          mv $ZIP forms-bridge.zip
+          gh release create "$TAG" \
+            --repo="$GITHUB_REPOSITORY" \
+            --title="$TAG" \
+            --generate-notes \
+            "forms-bridge.zip"

.github/workflows/tests.yml

@@ -0,0 +1,66 @@
+name: Tests
+
+on:
+  pull_request:
+    branches: [main]
+
+  workflow_call:
+
+jobs:
+  lint:
+    name: WordPress Coding Standards
+    runs-on: ubuntu-latest
+    container:
+      image: codeccoop/wp-test
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Composer install
+        run: composer -q install
+
+      - name: Lint and format
+        run: vendor/bin/phpcbf
+
+  phpunit:
+    name: PHP Unit Testing
+    runs-on: ubuntu-latest
+    container:
+      image: codeccoop/wp-test
+    steps:
+      - name: Start MariaDB
+        run: nohup docker-entrypoint.sh mariadbd 2>&1 >/dev/null &
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Cache composer
+        uses: actions/cache@v4
+        with:
+          path: vendor
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('composer.lock') }}
+
+      - name: Cache plugins
+        uses: actions/cache@v4
+        with:
+          path: /tmp/*.zip
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('bin/download-test-deps.sh') }}
+
+      - name: Composer install
+        run: composer -q install
+
+      - name: Wait for MariaDB
+        run: sleep 10
+
+      - name: Executable mode
+        run: chmod a+x bin/*
+
+      - name: Install tests suite
+        run: bin/install-wp-tests.sh
+
+      - name: Download deps
+        run: bin/download-test-deps.sh
+
+      - name: Unit testing
+        run: vendor/bin/phpunit -c phpunit.xml.dist

.gitignore

@@ -1,6 +1,8 @@
 .DS_Store
 phpcs.xml
 phpunit.xml
+.phpunit.result.cache
+.php-cs-fixer.cache
 Thumbs.db
 wp-cli.local.yml
 node_modules/

.gitlab-ci.yml

@@ -1,20 +1,6 @@
-workflow:
-  rules:
-    - if: $CI_COMMIT_BRANCH
-      changes:
-        - README.md
-        - .gitlab-ci.yml
-      when:
-        never
-        # Do no allow manually triggered pipelines to prevent duplicates!
-        # Instead rerun the pipeline created with the last push
-    - if: $CI_PIPELINE_SOURCE != "push"
-      when: never
-    # Only execute when a valid version tag like 1.0, 2.3-dev or similar is given
-    # Required is always one point like 1.0
-    - if: $CI_COMMIT_TAG =~ /^[0-9]+[.][0-9]+([.][0-9]+)?([-a-z])*$/
-
-stages: # List of stages for jobs, and their order of execution
+# List of stages for jobs, and their order of execution
+stages:
+  - test
   - build
   - package
   - upload
@@ -32,49 +18,113 @@ variables:
   GIT_SUBMODULE_STRATEGY: normal
   GIT_SUBMODULE_FORCE_HTTPS: "true"
 
+.release_job:
+  rules:
+    # Only execute when a valid version tag like 1.0, 2.3-dev or similar is given
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_TAG =~ /^[0-9]+[.][0-9]+([.][0-9]+)?([-a-z])*$/
+
+.test_job:
+  stage: test
+  image: codeccoop/wp-test
+  cache:
+    - key:
+        files:
+          - bin/download-test-deps.sh
+      paths:
+        - /tmp/*.zip
+
+    - key:
+        files:
+          - composer.lock
+      paths:
+        - vendor
+  rules:
+    # Only execute when a valid version tag like 1.0, 2.3-dev or similar is given
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_TAG =~ /^[0-9]+[.][0-9]+([.][0-9]+)?([-a-z])*$/
+    # Run always on MR pointing to master
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+
+lint:
+  extends: .test_job
+  before_script:
+    - composer -q install
+  script:
+    - vendor/bin/phpcbf
+
+phpunit:
+  extends: .test_job
+  before_script:
+    - nohup docker-entrypoint.sh mariadbd 2>&1 >/dev/null &
+    - composer -q install
+    - sleep 10
+    - chmod a+x bin/*
+    - bin/install-wp-tests.sh
+    - bin/download-test-deps.sh
+  script:
+    - vendor/bin/phpunit -c phpunit.xml.dist
+
 build:
+  extends: .release_job
   stage: build
   image: node:latest
+  cache:
+    - key:
+        files:
+          - package-lock.json
+      paths:
+        - node_modules
   script:
     - find src -exec sed -i "s/http-bridge/forms-bridge/g" {} \;
     - npm install && npm run build
-    - rm -rf node_modules
   artifacts:
     paths:
-      - assets/plugin.bundle.js
+      - forms-bridge/assets/plugin.bundle.js
 
 package:
+  extends: .release_job
   image: codeccoop/wp-cli:latest
   stage: package
+  dependencies: [build]
   script:
-    - find common -name '*.php' -exec sed -i "s/wpct-plugin/forms-bridge/g" {} \;
-    - find . -name '*.php' -exec sed -i "s/wpct_plugin_/forms_bridge_plugin_/g" {} \;
-    - find . -name "*.php" -exec sed -i 's/WPCT_PLUGIN/FORMS_BRIDGE\\Common/g' {} \;
-    - find deps/http -name '*.php' -exec sed -i "s/http-bridge/forms-bridge/g" {} \;
-    - find . -name '*.php' -exec sed -i "s/http_bridge_/forms_bridge_http_/g" {} \;
-    - find . -name "*.php" -exec sed -i 's/HTTP_BRIDGE_/FORMS_BRIDGE_HTTP_/g' {} \;
-    - find . -name '*.php' -exec sed -i 's/HTTP_BRIDGE/FORMS_BRIDGE\\Http/g' {} \;
-    - find deps/i18n -name '*.php' -exec sed -i "s/wpct-i18n/forms-bridge/g" {} \;
-    - find . -name '*.php' -exec sed -i "s/wpct_i18n_/forms_bridge_i18n_/g" {} \;
-    - find . -name '*.php' -exec sed -i 's/WPCT_I18N/FORMS_BRIDGE\\I18n/g' {} \;
-    - wp dist-archive . ./$ZIP
+    - find forms-bridge/deps/plugin -name '*.php' -exec sed -i "s/wpct-plugin/forms-bridge/g" {} \;
+    - find forms-bridge -name '*.php' -exec sed -i "s/wpct_plugin_/forms_bridge_plugin_/g" {} \;
+    - find forms-bridge -name "*.php" -exec sed -i 's/WPCT_PLUGIN/FORMS_BRIDGE\\Plugin/g' {} \;
+    - find forms-bridge/deps/http -name '*.php' -exec sed -i "s/http-bridge/forms-bridge/g" {} \;
+    - find forms-bridge -name '*.php' -exec sed -i "s/http_bridge_/forms_bridge_http_/g" {} \;
+    - find forms-bridge -name "*.php" -exec sed -i 's/HTTP_BRIDGE_/FORMS_BRIDGE_HTTP_/g' {} \;
+    - find forms-bridge -name '*.php' -exec sed -i 's/HTTP_BRIDGE/FORMS_BRIDGE\\Http/g' {} \;
+    - wp dist-archive forms-bridge ./$ZIP
   artifacts:
     paths:
       - $ZIP
 
 upload:
+  extends: .release_job
   stage: upload
   image: curlimages/curl:latest
+  dependencies: [package]
   script:
     - |
-      curl --header "JOB-TOKEN: ${CI_JOB_TOKEN}" --upload-file ${ZIP} ${PACKAGE_REGISTRY_URL}/${ZIP}
+      curl --header "JOB-TOKEN: ${CI_JOB_TOKEN}" \
+        --upload-file ${ZIP} \
+        ${PACKAGE_REGISTRY_URL}/${ZIP}
 
 release:
   # Caution, as of 2021-02-02 these assets links require a login, see:
   # https://gitlab.com/gitlab-org/gitlab/-/issues/299384
+  extends: .release_job
   stage: release
-  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  image: gitlab/glab:latest
+  dependencies: [package]
+  variables:
+    GITLAB_HOST: "$CI_SERVER_URL"
   script:
     - |
-      release-cli create --name "Release $CI_COMMIT_TAG" --tag-name $CI_COMMIT_TAG \
-        --assets-link "{\"name\":\"${ZIP}\",\"url\":\"${PACKAGE_REGISTRY_URL}\/${ZIP}\",\"link_type\":\"package\",\"filepath\":\"\/plugins\/bridges\/${ZIP}\"}"
+      glab auth login \
+        --job-token $CI_JOB_TOKEN \
+        --hostname $CI_SERVER_HOST \
+        --api-protocol $CI_SERVER_PROTOCOL
+    - |
+      glab release create $CI_COMMIT_TAG\
+        --name "Release $CI_COMMIT_TAG" \
+        --assets-links "[{\"name\":\"${ZIP}\",\"url\":\"${PACKAGE_REGISTRY_URL}\/${ZIP}\",\"link_type\":\"package\",\"direct_asset_path\":\"\/plugins\/bridges\/${ZIP}\"}]"

.gitmodules

@@ -1,9 +1,6 @@
-[submodule "common"]
-	path = common
-	url = https://git.coopdevs.org/codeccoop/wp/plugins/wpct-plugin-common.git
-[submodule "deps/http"]
-	path = deps/http
-	url = https://git.coopdevs.org/codeccoop/wp/plugins/bridges/http-bridge.git
-[submodule "deps/i18n"]
-	path = deps/i18n
-	url = https://git.coopdevs.org/codeccoop/wp/plugins/wpct-i18n.git
+[submodule "forms-bridge/plugin"]
+	path = forms-bridge/deps/plugin
+	url = https://gitlab.com/codeccoop/wp/plugins/wpct-plugin.git
+[submodule "forms-bridge/deps/http"]
+	path = forms-bridge/deps/http
+	url = https://gitlab.com/codeccoop/wp/plugins/http-bridge.git

.lintstagedrc.js

@@ -8,13 +8,13 @@ const buildPrettierCommand = (filenames) =>
     .map((f) => path.relative(process.cwd(), f))
     .join(" ")}`;
 
-const buildPrettierPhpCommand = (filenames) =>
-  `prettier --write --ignore-unknown --config .prettierrc-php ${filenames
+const buildPhpCbfCommand = (filenames) =>
+  `vendor/bin/phpcbf -n ${filenames
     .map((f) => path.relative(process.cwd(), f))
     .join(" ")}`;
 
 module.exports = {
-  // "src/**/*.{js,jsx,ts,tsx}": [buildEslintCommand],
-  "*.{json,js,ts,jsx,tsx,html,css}": [buildPrettierCommand],
-  "*.php": [buildPrettierPhpCommand],
+  "src/**/*.{js,jsx}": [buildEslintCommand],
+  "*.{json,js,jsx,html,css}": [buildPrettierCommand],
+  "*.php": [buildPhpCbfCommand],
 };