Merge pull request #14 from itk-dev/feature/os2web_key

rimi-itk · web-flow · commit 0b5a0bbc0b0b · 2025-05-02T12:50:08.000+02:00
Support for os2web_key
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,25 @@
+#### Link to ticket
+
+Please add a link to the ticket being addressed by this change.
+
+#### Description
+
+Please include a short description of the suggested change and the reasoning behind the approach you have chosen.
+
+#### Screenshot of the result
+
+If your change affects the user interface you should include a screenshot of the result with the pull request.
+
+#### Checklist
+
+- [ ] My code is covered by test cases.
+- [ ] My code passes our test (all our tests).
+- [ ] My code passes our static analysis suite.
+- [ ] My code passes our continuous integration process.
+
+If your code does not pass all the requirements on the checklist you have to add a comment explaining why this change 
+should be exempt from the list.
+
+#### Additional comments or questions
+
+If you have any further comments or questions for the reviewer please add them here.
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -176,3 +176,14 @@ jobs:
           sed -i '/^\s*"require":/,/^\s*}/d' composer.json
           composer --no-interaction install
           composer code-analysis
+
+  coding-standards-markdown:
+    name: Markdown coding standards
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Coding standards
+        run: |
+          docker run --rm --volume $PWD:/md peterdavehello/markdownlint markdownlint --ignore vendor --ignore LICENSE.md '**/*.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/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ about writing changes to this log.
 
 ## [Unreleased]
 
+* [PR-14](https://github.com/OS2Forms/os2forms_get_organized/pull/14)
+  Added support for [Key](https://www.drupal.org/project/key)
 * [PR-22](https://github.com/OS2Forms/os2forms_get_organized/pull/22)
   Normalized `composer.json`
 
diff --git a/README.md b/README.md
@@ -11,24 +11,39 @@ vendor/bin/drush pm:enable os2forms_get_organized
 
 ## Settings
 
-Set GetOrganized `username`, `password` and `base url`
-on `/admin/os2forms_get_organized/settings`.
-
-You can also test that the provided
-details work on `/admin/os2forms_get_organized/settings`.
+Go to `/admin/os2forms_get_organized/settings` and configure the module.
 
 ## Coding standards
 
-Check coding standards:
+Our coding are checked by GitHub Actions (cf. [.github/workflows/pr.yml](.github/workflows/pr.yml)). Use the commands
+below to run the checks locally.
 
-```sh
-docker run --rm --interactive --tty --volume ${PWD}:/app itkdev/php8.1-fpm:latest composer install
-docker run --rm --interactive --tty --volume ${PWD}:/app itkdev/php8.1-fpm:latest composer coding-standards-check
+### PHP
+
+```shell
+# Update to make sure that we use the latest versions of tools.
+docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.3-fpm composer update
+# Fix (some) coding standards issues
+docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.3-fpm composer coding-standards-apply
+# Check that code adheres to the coding standards
+docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.3-fpm composer coding-standards-check
+```
+
+### Markdown
+
+```shell
+docker pull peterdavehello/markdownlint
+docker run --rm --volume $PWD:/md peterdavehello/markdownlint markdownlint --ignore vendor --ignore LICENSE.md '**/*.md' --fix
+docker run --rm --volume $PWD:/md peterdavehello/markdownlint markdownlint --ignore vendor --ignore LICENSE.md '**/*.md'
 ```
 
-Apply coding standards:
+## Code analysis
+
+We use [PHPStan](https://phpstan.org/) for static code analysis.
+
+Running statis code analysis on a standalone Drupal module is a bit tricky, so we use a helper script to run the
+analysis:
 
 ```shell
-docker run --rm --interactive --tty --volume ${PWD}:/app itkdev/php8.1-fpm:latest composer coding-standards-apply
-docker run --rm --interactive --tty --volume ${PWD}:/app node:18 yarn --cwd /app coding-standards-apply
+docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.3-fpm ./scripts/code-analysis
 ```
diff --git a/composer.json b/composer.json
@@ -11,6 +11,7 @@
     ],
     "require": {
         "drupal/advancedqueue": "^1.2",
+        "drupal/key": "^1.20",
         "drupal/webform": "^6.2",
         "itk-dev/getorganized-api-client-php": "^1.2.2",
         "os2forms/os2forms": "^3.17 || ^4.0",
diff --git a/drush.services.yml b/drush.services.yml
@@ -1,7 +1,12 @@
 services:
-  drush_command_example.commands:
-    class: \Drupal\os2forms_get_organized\Commands\ArchiveCommands
+  Drupal\os2forms_get_organized\Commands\ArchiveCommands:
+    arguments:
+      - '@Drupal\os2forms_get_organized\Helper\ArchiveHelper'
     tags:
       - { name: drush.command }
+
+  Drupal\os2forms_get_organized\Drush\Commands\GetOrganizedTestCommands:
     arguments:
       - '@Drupal\os2forms_get_organized\Helper\ArchiveHelper'
+    tags:
+      - { name: drush.command }
diff --git a/os2forms_get_organized.info.yml b/os2forms_get_organized.info.yml
@@ -4,9 +4,11 @@ description: 'GetOrganized integration'
 package: OS2Forms
 core_version_requirement: ^9 || ^10
 dependencies:
-  - drupal:webform
   - drupal:advancedqueue
+  - drupal:key
+  - drupal:webform
   - drupal:webform_entity_print_attachment
   - os2forms:os2forms_attachment
   - os2web:os2web_audit
+
 configure: os2forms_get_organized.admin.settings
diff --git a/os2forms_get_organized.install b/os2forms_get_organized.install
@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * @file
+ * Install hooks for os2forms_get_organized.
+ */
+
+/**
+ * Implements hook_update_N().
+ */
+function os2forms_get_organized_update_9001(): void {
+  \Drupal::service('module_installer')->install([
+    'key',
+  ], TRUE);
+}
diff --git a/os2forms_get_organized.services.yml b/os2forms_get_organized.services.yml
@@ -1,7 +1,8 @@
 services:
   Drupal\os2forms_get_organized\Helper\Settings:
     arguments:
-      - "@keyvalue"
+      - "@config.factory"
+      - "@key.repository"
 
   Drupal\os2forms_get_organized\Helper\ArchiveHelper:
     arguments:
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,11 @@
+parameters:
+  level: 6
+  paths:
+    - src
+
+  ignoreErrors:
+    - '#Unsafe usage of new static\(\).#'
+
+# Local Variables:
+# mode: yaml
+# End:
diff --git a/scripts/code-analysis b/scripts/code-analysis
@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+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
+
+cd "$script_dir" || exit
+
+drupal_composer() {
+  composer --working-dir="$drupal_dir" --no-interaction "$@"
+}
+
+# Create new Drupal 9 project
+if [ ! -f "$drupal_dir/composer.json" ]; then
+  composer --no-interaction create-project drupal/recommended-project:^9 "$drupal_dir"
+fi
+# Copy our code into the modules folder
+
+# Clean up
+rm -fr "${drupal_dir:?}/$module_path"
+
+# https://stackoverflow.com/a/15373763
+# rsync --archive --compress . --filter=':- .gitignore' --exclude "$drupal_dir" --exclude .git "$drupal_dir/$module_path"
+
+# The rsync command in not available in itkdev/php8.1-fpm
+
+git config --global --add safe.directory /app
+# Copy all module files not ignored by git into module path
+# (cf. https://stackoverflow.com/a/77197460)
+for f in $(git ls-files --cached --others --exclude-standard); do
+  mkdir -p "$drupal_dir/$module_path/$(dirname "$f")"
+  cp "$f" "$drupal_dir/$module_path/$f"
+done
+
+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/$module_path" && ../../../../vendor/bin/phpstan)
diff --git a/src/Drush/Commands/GetOrganizedTestCommands.php b/src/Drush/Commands/GetOrganizedTestCommands.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Drupal\os2forms_get_organized\Drush\Commands;
+
+use Drupal\os2forms_get_organized\Helper\ArchiveHelper;
+use Drush\Commands\DrushCommands;
+
+/**
+ * Test commands for get organized.
+ */
+class GetOrganizedTestCommands extends DrushCommands {
+
+  /**
+   * Constructor.
+   */
+  public function __construct(
+    private readonly ArchiveHelper $helper,
+  ) {
+  }
+
+  /**
+   * Test API access.
+   *
+   * @command os2forms-get-organized:test:api
+   * @usage os2forms-get-organized:test:api --help
+   */
+  public function testApi(): void {
+    try {
+      $this->helper->pingApi();
+      $this->io()->success('Successfully connected to Get Organized API');
+    }
+    catch (\Throwable $t) {
+      $this->io()->error($t->getMessage());
+    }
+
+  }
+
+}
diff --git a/src/Form/SettingsForm.php b/src/Form/SettingsForm.php
diff --git a/src/Helper/ArchiveHelper.php b/src/Helper/ArchiveHelper.php
diff --git a/src/Helper/Settings.php b/src/Helper/Settings.php
