Merge branch 'release/0.2.0'

jekuaitk · jekuaitk · commit bd66afe97c0e · 2025-02-17T12:41:05.000+01:00
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -80,7 +80,7 @@ jobs:
           composer install --no-interaction --no-progress
       - name: PHPCS
         run: |
-          composer coding-standards-check/phpcs
+          docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer coding-standards-check
 
   php-code-analysis:
     name: PHP code analysis
@@ -111,27 +111,12 @@ jobs:
         run: |
           ./scripts/code-analysis
 
-  markdownlint:
+  markdown-lint:
+    name: Markdown lint
     runs-on: ubuntu-latest
-    name: markdownlint
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-      - name: Cache yarn packages
-        uses: actions/cache@v2
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-      - name: Yarn install
-        uses: actions/setup-node@v2
-        with:
-          node-version: '20'
-      - run: yarn install
-      - name: markdownlint
-        run: yarn coding-standards-check/markdownlint
+        uses: actions/checkout@v4
+
+      - name: Markdown lint
+        run: docker run --rm --volume "$PWD:/md" itkdev/markdownlint markdownlint --ignore vendor '**/*.md'
diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc
@@ -0,0 +1,13 @@
+{
+	"default": true,
+	// https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
+	"line-length": {
+		"line_length": 120,
+		"code_blocks": false,
+		"tables": false
+	},
+	// https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
+	"no-duplicate-heading": {
+		"siblings_only": true
+	}
+}
diff --git a/.markdownlintignore b/.markdownlintignore
@@ -0,0 +1,7 @@
+# https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#ignoring-files
+vendor/
+LICENSE.md
+
+# Local Variables:
+# mode: gitignore
+# End:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2025-02-17
+
+- Used account name as fallback in user logging
+- Add Drush 13 compatibility
+- Add linting and code analysis to readme
+- Add markdown linting
+
 ## [0.1.6] - 2024-12-16
 
 - Fixed missing queue error during installation.
@@ -52,7 +59,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - First version of the module
 - Added submodule to log user CUD events.
 
-[Unreleased]: https://github.com/OS2web/os2web_audit/compare/0.1.6...HEAD
+[Unreleased]: https://github.com/OS2web/os2web_audit/compare/0.2.0...HEAD
+[0.2.0]: https://github.com/OS2web/os2web_audit/compare/0.1.6...0.2.0
 [0.1.6]: https://github.com/OS2web/os2web_audit/compare/0.1.5...0.1.6
 [0.1.5]: https://github.com/OS2web/os2web_audit/compare/0.1.4...0.1.5
 [0.1.4]: https://github.com/OS2web/os2web_audit/compare/0.1.3...0.1.4
diff --git a/README.md b/README.md
@@ -72,3 +72,36 @@ drush advancedqueue:queue:list
 
 or go to `/admin/config/system/queues/jobs/os2web_audit` for a
 graphical overview of jobs in the queue.
+
+### Coding standards
+
+#### PHP files (PHP_CodeSniffer)
+
+Check PHP coding standards
+
+```shell
+docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer install
+docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer coding-standards-check
+```
+
+Apply coding standard changes
+
+```shell
+docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer install
+docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer coding-standards-apply
+```
+
+### Code analysis
+
+phpstan is used to perform static analysis of the code. Run the following script:
+
+```sh
+./scripts/code-analysis
+```
+
+#### Markdown files
+
+```shell
+docker run --interactive --rm --volume "$PWD:/md" itkdev/markdownlint markdownlint '**/*.md' --fix
+docker run --interactive --rm --volume "$PWD:/md" itkdev/markdownlint markdownlint '**/*.md'
+```
diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
         "ext-curl": "*",
         "php": "^8.1",
         "drupal/advancedqueue": "^1.2",
-        "drush/drush": "^11.5|^12.5"
+        "drush/drush": "^11|^12|^13"
     },
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",
diff --git a/drush.services.yml b/drush.services.yml
diff --git a/modules/os2web_audit_user/os2web_audit_user.module b/modules/os2web_audit_user/os2web_audit_user.module
@@ -15,7 +15,7 @@ use Drupal\user\UserInterface;
 function os2web_audit_user_user_insert(EntityInterface $entity): void {
   /** @var \Drupal\user\Entity\User $entity */
   $msg = sprintf('User created with rolles: %s', implode(', ', $entity->getRoles()));
-  os2web_audit_user_log($msg, $entity->getEmail());
+  os2web_audit_user_log($msg, $entity->getEmail() ?? $entity->getAccountName());
 }
 
 /**
@@ -24,29 +24,29 @@ function os2web_audit_user_user_insert(EntityInterface $entity): void {
 function os2web_audit_user_user_update(EntityInterface $entity): void {
   /** @var \Drupal\user\Entity\User $entity */
   $msg = sprintf('User updated with rolles: %s', implode(', ', $entity->getRoles()));
-  os2web_audit_user_log($msg, $entity->getEmail());
+  os2web_audit_user_log($msg, $entity->getEmail() ?? $entity->getAccountName());
 }
 
 /**
  * Implements hook_ENTITY_TYPE_delete().
  */
 function os2web_audit_user_user_delete(EntityInterface $entity): void {
   /** @var \Drupal\user\Entity\User $entity */
-  os2web_audit_user_log('User deleted', $entity->getEmail());
+  os2web_audit_user_log('User deleted', $entity->getEmail() ?? $entity->getAccountName());
 }
 
 /**
  * Implements hook_user_login().
  */
 function os2web_audit_user_user_login(UserInterface $account): void {
-  os2web_audit_user_log('User logged in', $account->getEmail());
+  os2web_audit_user_log('User logged in', $account->getEmail() ?? $account->getAccountName());
 }
 
 /**
  * Implements hook_user_logout().
  */
 function os2web_audit_user_user_logout(AccountInterface $account): void {
-  os2web_audit_user_log('User logged out', $account->getEmail());
+  os2web_audit_user_log('User logged out', $account->getEmail() ?? $account->getAccountName());
 }
 
 /**
diff --git a/package.json b/package.json
diff --git a/scripts/.env b/scripts/.env
@@ -0,0 +1,2 @@
+COMPOSE_PROJECT_NAME=drupal-module
+MODULE_NAME=os2web_audit
diff --git a/scripts/base b/scripts/base
@@ -0,0 +1,98 @@
+#!/usr/bin/env bash
+set -o errexit -o errtrace -o noclobber -o nounset -o pipefail
+IFS=$'\n\t'
+
+execute_name=execute
+
+usage() {
+  (cat >&2 <<EOF
+--------------------------------------------------------------------------------
+
+Example usage:
+
+#!/usr/bin/env bash
+set -o errexit -o errtrace -o noclobber -o nounset -o pipefail
+IFS=$'\n\t'
+
+script_dir=\$(cd "\$(dirname "\${BASH_SOURCE[0]}")" && pwd)
+
+# The $execute_name function will be invoked in the root of a Drupal 10 installation.
+$execute_name() {
+  echo "Executing!"
+  echo "module_path: \$module_path"
+}
+
+source "\$script_dir/base"
+
+EOF
+  )
+
+  exit 1
+}
+
+# @see https://stackoverflow.com/a/28776166
+if ! (return 0 2>/dev/null); then
+  (cat >&2 <<EOF
+This script (${BASH_SOURCE[0]}) must be sourced!
+
+EOF
+)
+
+  usage
+fi
+
+if [[ $(type -t "$execute_name") != function ]]; then
+  (cat >&2 <<EOF
+Function $execute_name does not exist!
+EOF
+)
+
+  usage
+fi
+
+compose() {
+  docker compose "$@"
+}
+
+shell() {
+  compose exec drupal "$@"
+}
+
+composer() {
+  shell composer "$@"
+}
+
+drush() {
+  shell vendor/bin/drush "$@"
+}
+
+# Extract the module path from the service.
+module_path=$(compose run --rm drupal sh -c 'echo $MODULE_PATH')
+module_name=$(basename "$module_path")
+
+# https://www.man7.org/linux/man-pages/man1/trap.1p.html
+trap teardown EXIT
+
+setup() {
+  compose down --remove-orphans
+  compose pull
+  compose up --detach --remove-orphans --wait
+  composer config --no-plugins allow-plugins true
+  composer config extra.merge-plugin.include "$module_path/composer.json"
+  composer require drush/drush wikimedia/composer-merge-plugin
+  # Reset Drupal installation
+  compose exec drupal sh -c 'find . -name .ht.sqlite -ls -delete; rm web/sites/default/settings.php' || true
+  drush site:install --db-url='sqlite://sites/default/files/.ht.sqlite?module=sqlite' --yes
+  drush pm:install "$module_name"
+}
+
+teardown() {
+  # Remove EXIT trap
+  trap - EXIT
+
+  compose down --remove-orphans
+}
+
+setup
+execute
+teardown
diff --git a/scripts/code-analysis b/scripts/code-analysis
@@ -1,36 +1,13 @@
 #!/usr/bin/env bash
+set -o errexit -o errtrace -o noclobber -o nounset -o pipefail
+IFS=$'\n\t'
 
-script_dir=$(pwd)
-module_name=$(basename "$script_dir")
-drupal_dir=vendor/drupal-module-code-analysis
-# Relative to $drupal_dir
-module_path=web/modules/contrib/$module_name
+script_dir=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+cd "$script_dir"
 
-cd "$script_dir" || exit
-
-drupal_composer() {
-  composer --working-dir="$drupal_dir" --no-interaction "$@"
+execute() {
+  composer require --dev symfony/phpunit-bridge
+  shell vendor/bin/phpstan --configuration="$module_path/phpstan.neon" --memory-limit=256M
 }
 
-# Create new Drupal 10 project
-if [ ! -f "$drupal_dir/composer.json" ]; then
-  composer --no-interaction create-project drupal/recommended-project:^10 "$drupal_dir"
-fi
-# Copy our code into the modules folder
-mkdir -p "$drupal_dir/$module_path"
-# https://stackoverflow.com/a/15373763
-rsync --archive --compress . --filter=':- .gitignore' --exclude "$drupal_dir" --exclude .git "$drupal_dir/$module_path"
-
-drupal_composer config minimum-stability dev
-
-# Allow ALL plugins
-# https://getcomposer.org/doc/06-config.md#allow-plugins
-drupal_composer config --no-plugins allow-plugins true
-
-drupal_composer require wikimedia/composer-merge-plugin
-drupal_composer config extra.merge-plugin.include "$module_path/composer.json"
-# https://www.drupal.org/project/drupal/issues/3220043#comment-14845434
-drupal_composer require --dev symfony/phpunit-bridge
-
-# Run PHPStan
-(cd "$drupal_dir" && vendor/bin/phpstan --configuration="$module_path/phpstan.neon")
+source "$script_dir/base"
diff --git a/scripts/compose.yaml b/scripts/compose.yaml
@@ -0,0 +1,20 @@
+# https://hub.docker.com/_/drupal/
+
+services:
+  drupal:
+    image: drupal:10-apache
+    ports:
+      - 80
+    volumes:
+      - /var/www/html/modules
+      - /var/www/html/profiles
+      - /var/www/html/themes
+      # this takes advantage of the feature in Docker that a new anonymous
+      # volume (which is what we're creating here) will be initialized with the
+      # existing content of the image at the same location
+      - /var/www/html/sites
+      # Mount our code into the web/modules/contrib folder
+      - ../:/opt/drupal/web/modules/contrib/$MODULE_NAME
+    environment:
+      # Let the module path, i.e. the mounted path, be known in the container
+      MODULE_PATH: web/modules/contrib/$MODULE_NAME
diff --git a/src/Commands/AuditLogDrushCommands.php b/src/Commands/AuditLogDrushCommands.php
diff --git a/src/Drush/Commands/Commands.php b/src/Drush/Commands/Commands.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+COMPOSE_PROJECT_NAME=drupal-module`
	`2`	`+MODULE_NAME=os2web_audit`