refactor: extract service classes and expand test coverage

- Extract BaseManagement, EditorAssignmentService, IssueRepository, and SubmissionFormHandler classes

- Refactor IssueManagement and SubmissionManagement to use extracted services

- Expand Cypress test coverage with TypeScript support

- Update GitHub Actions workflow configuration

- Add Prettier and jsconfig configuration

- Remove obsolete test screenshots

- Bump version to 1.6.0.4 with lazy-load enabled

Author: abenteuerzeit

.github/actions/tests.sh

@@ -2,6 +2,6 @@
 
 set -e
 
-npx cypress run  --headless --browser chrome  --config '{"specPattern":["plugins/generic/pluginTemplate/cypress/tests/functional/*.cy.js"]}'
+npx cypress run  --headless --browser chrome  --config '{"specPattern":["plugins/generic/issuePreselection/cypress/tests/functional/*.cy.js"]}'
 
 

.github/workflows/main.yml

@@ -1,30 +1,41 @@
-on: [push]
-name: pluginTemplate
+on: [push, pull_request]
+name: issuePreselection
 jobs:
-    pluginTemplate:
+    issuePreselection:
         runs-on: ubuntu-latest
         strategy:
             fail-fast: false
             matrix:
                 include:
-                    - application: ojs
-                      php-version: 8.3
-                      database: mysql
                     - application: ojs
                       php-version: 8.2
                       database: mysql
-                    - application: ojs
-                      php-version: 8.3
-                      database: pgsql
+                      ojs-version: stable-3_5_0
                     - application: ojs
                       php-version: 8.2
                       database: pgsql
+                      ojs-version: stable-3_5_0
 
-        name: pluginTemplate
+        name: ${{ matrix.application }} - PHP ${{ matrix.php-version }} - ${{ matrix.database }}
         steps:
-            - uses: pkp/pkp-github-actions@v1
+            - name: Checkout plugin
+              uses: actions/checkout@v4
+              with:
+                  path: issuePreselection
+
+            - name: Run PKP plugin tests
+              uses: pkp/pkp-github-actions@v1
               with:
                   node_version: 20
-                  branch: main
+                  branch: ${{ matrix.ojs-version }}
                   repository: pkp
-                  plugin: true
+                  plugin: issuePreselection
+
+            - name: Run Cypress tests
+              if: matrix.php-version == '8.2' && matrix.database == 'mysql'
+              working-directory: issuePreselection
+              run: |
+                  npm install
+                  npx cypress run
+              env:
+                  CYPRESS_BASE_URL: http://localhost

.prettierrc

@@ -7,5 +7,39 @@
     "trailingComma": "none",
     "phpVersion": "8.2",
     "braceStyle": "psr-2",
-    "embeddedLanguageFormatting": "auto"
+    "embeddedLanguageFormatting": "auto",
+    "endOfLine": "lf",
+    "useTabs": false,
+    "arrowParens": "always",
+    "bracketSpacing": true,
+    "htmlWhitespaceSensitivity": "css",
+    "overrides": [
+        {
+            "files": "*.vue",
+            "options": {
+                "parser": "vue"
+            }
+        },
+        {
+            "files": ["*.cy.js", "*.spec.js"],
+            "options": {
+                "printWidth": 100
+            }
+        },
+        {
+            "files": "*.tpl",
+            "options": {
+                "parser": "html",
+                "htmlWhitespaceSensitivity": "ignore"
+            }
+        },
+        {
+            "files": ["*.md", "*.mdx"],
+            "options": {
+                "printWidth": 80,
+                "proseWrap": "always",
+                "tabWidth": 2
+            }
+        }
+    ]
 }

IssuePreselectionPlugin.php

@@ -16,13 +16,21 @@
 use APP\core\Application;
 use APP\plugins\generic\issuePreselection\classes\IssueManagement;
 use APP\plugins\generic\issuePreselection\classes\SubmissionManagement;
+use Exception;
 use PKP\plugins\GenericPlugin;
 use PKP\plugins\Hook;
 
 class IssuePreselectionPlugin extends GenericPlugin
 {
     /**
      * @copydoc GenericPlugin::register()
+     *
+     * @param string $category The category of the plugin
+     * @param string $path The path to the plugin
+     * @param int|null $mainContextId The main context ID
+     *
+     * @return bool True if registration was successful
+     * @throws Exception
      */
     public function register($category, $path, $mainContextId = null): bool
     {
@@ -40,37 +48,55 @@ public function register($category, $path, $mainContextId = null): bool
     }
 
     /**
-     * @copydoc Plugin::getDisplayName()
-     * @noinspection PhpUnused
+     * Register hooks used in normal plugin setup and in CLI tools
+     *
+     * Initializes the management classes and registers all necessary hooks
+     * for both issue and submission functionality.
+     *
+     * @return void
+     * @throws Exception
      */
-    public function getDisplayName(): object|array|string|null
+    private function _init(): void
     {
-        return __("plugins.generic.issuePreselection.displayName");
-    }
+        $issueManagement = new IssueManagement($this);
+        $submissionManagement = new SubmissionManagement($this);
 
-    /**
-     * @copydoc Plugin::getDescription()
-     * @noinspection PhpUnused
-     */
-    public function getDescription(): object|array|string|null
-    {
-        return __("plugins.generic.issuePreselection.description");
+        $this->registerIssueHooks($issueManagement);
+        $this->registerSubmissionHooks($submissionManagement);
     }
 
     /**
-     * Rgister hooks used in normal plugin setup and in CLI tools.
+     * Register hooks for issue management functionality
+     *
+     * Registers all hooks related to issue schema, forms, and data handling.
+     *
+     * @param IssueManagement $issueManagement The issue management instance
+     *
+     * @return void
+     * @throws Exception
      */
-    private function _init() : void
+    private function registerIssueHooks(IssueManagement $issueManagement): void
     {
-        $issueManagement = new IssueManagement($this);
-        $submissionManagement = new SubmissionManagement($this);
-
         Hook::add("Schema::get::issue", [$issueManagement, "addToIssueSchema"]);
         Hook::add("Templates::Editor::Issues::IssueData::AdditionalMetadata", [$issueManagement, "addIssueFormFields"]);
         Hook::add("issueform::readuservars", [$issueManagement, "readIssueFormData"]);
         Hook::add("issueform::execute", [$issueManagement, "saveIssueFormData"]);
         Hook::add("Issue::edit", [$issueManagement, "beforeIssueEdit"]);
+    }
 
+    /**
+     * Register hooks for submission management functionality
+     *
+     * Registers all hooks related to submission schema, forms, validation,
+     * and editor assignment.
+     *
+     * @param SubmissionManagement $submissionManagement The submission management instance
+     *
+     * @return void
+     * @throws Exception
+     */
+    private function registerSubmissionHooks(SubmissionManagement $submissionManagement): void
+    {
         Hook::add("Schema::get::submission", [$submissionManagement, "addToSubmissionSchema"]);
         Hook::add("Form::config::after", [$submissionManagement, "addToSubmissionForm"]);
         Hook::add("Submission::getSubmissionsListProps", [$submissionManagement, "addSubmissionListProps"]);
@@ -80,6 +106,30 @@ private function _init() : void
         ]);
         Hook::add("Submission::validateSubmit", [$submissionManagement, "handleSubmissionValidate"]);
     }
+
+    /**
+     * Get the display name of this plugin
+     *
+     * @copydoc Plugin::getDisplayName()
+     *
+     * @return object|array|string|null Localized plugin display name
+     */
+    public function getDisplayName(): object|array|string|null
+    {
+        return __("plugins.generic.issuePreselection.displayName");
+    }
+
+    /**
+     * Get the description of this plugin
+     *
+     * @copydoc Plugin::getDescription()
+     *
+     * @return object|array|string|null Localized plugin description
+     */
+    public function getDescription(): object|array|string|null
+    {
+        return __("plugins.generic.issuePreselection.description");
+    }
 }
 
 // For backwards compatibility -- expect this to be removed approx. OJS/OMP/OPS 3.6

README.md

@@ -21,21 +21,28 @@
 
 ## Overview
 
-The Issue Preselection Plugin allows authors to select which journal issue their submission should be assigned to during the submission process. Editors can configure which issues are open for submissions and pre-assign guest editors who will automatically be assigned to incoming submissions.
+The Issue Preselection Plugin allows authors to select which journal issue their
+submission should be assigned to during the submission process. Editors can
+configure which issues are open for submissions and pre-assign guest editors who
+will automatically be assigned to incoming submissions.
 
 ## Features
 
 ### For Authors
 
-- **Issue Selection During Submission** - Select from available future issues when submitting
-- **Direct Response to Calls for Papers** - Submit directly to specific themed issues
+- **Issue Selection During Submission** - Select from available future issues
+  when submitting
+- **Direct Response to Calls for Papers** - Submit directly to specific themed
+  issues
 - **Filtered Issue List** - Only see issues that editors have marked as open
 
 ### For Editors
 
 - **Issue Configuration** - Mark issues as open/closed for author selection
-- **Editor Pre-assignment** - Assign guest editors to issues for automatic workflow assignment
-- **Automatic Workflow** - Submissions automatically assigned to configured editors with notifications
+- **Editor Pre-assignment** - Assign guest editors to issues for automatic
+  workflow assignment
+- **Automatic Workflow** - Submissions automatically assigned to configured
+  editors with notifications
 
 ## Requirements
 
@@ -47,9 +54,11 @@ The Issue Preselection Plugin allows authors to select which journal issue their
 
 ### Method 1: Manual Installation
 
-1. Download the latest release from the [releases page](https://github.com/abenteuerzeit/ojs-issue-preselection/releases)
+1. Download the latest release from the
+   [releases page](https://github.com/abenteuerzeit/ojs-issue-preselection/releases)
 2. Extract the archive
-3. Copy the `issuePreselection` folder to `plugins/generic/` in your OJS installation
+3. Copy the `issuePreselection` folder to `plugins/generic/` in your OJS
+   installation
 4. Log in to OJS as Administrator
 5. Navigate to **Settings > Website > Plugins**
 6. Find "Issue Preselection Plugin" under Generic Plugins
@@ -80,7 +89,8 @@ Click **Create** or **Edit** on an issue you want to configure
 
 <img width="800" alt="Create or Edit Issue" src="https://github.com/user-attachments/assets/87174d46-2cea-44f8-a2a1-17da128cb721" />
 
-**Edit** is shown after expanding the view by clicking on the triangular bullet to the left of the issue. You can also click on the name directly.
+**Edit** is shown after expanding the view by clicking on the triangular bullet
+to the left of the issue. You can also click on the name directly.
 
 <img width="800" alt="Issue Options" src="https://github.com/user-attachments/assets/a5bb768d-a66b-4de7-861f-681eea1ec99f" />
 
@@ -90,8 +100,13 @@ You'll see two new fields under **Issue Data**
 
 <img width="800" alt="Issue Data Fields" src="https://github.com/user-attachments/assets/cfa5bb5e-c359-44a3-bddd-73e04fbc0d60" />
 
-- **Enable for Submission**: Check to make this issue available for author selection
-- **Assigned Editors (Optional)**: Select one or more editors to automatically assign to submissions
+- **Enable for Submission**: Check to make this issue available for author
+  selection
+- **Assigned Editors (Optional)**: Select one or more editors to automatically
+  assign to submissions
+
+> Updates to editor assignments under the issue data tab apply to all active
+> submissions assigned to an issue and not scheduled for publication.
 
 **Step 4: Save Changes**
 
@@ -158,7 +173,8 @@ The plugin uses OJS's hook system exclusively for integration:
 - **Schema Hooks**: Extend issue and submission schemas with custom fields
 - **Form Hooks**: Add UI elements to issue and submission forms
 - **Template Hooks**: Display selected issue in review section
-- **Validation Hooks**: Process issue assignment and editor assignment on submission
+- **Validation Hooks**: Process issue assignment and editor assignment on
+  submission
 
 ### Data Storage
 
@@ -215,8 +231,10 @@ The plugin logs extensively with `[IssuePreselection]` prefix.
 
 ## Support
 
-- **Issues**: [GitHub Issues](https://github.com/yourusername/ojs-issue-preselection/issues)
-- **Documentation**: [Wiki](https://github.com/yourusername/ojs-issue-preselection/wiki)
+- **Issues**:
+  [GitHub Issues](https://github.com/abenteuerzeit/ojs-issue-preselection/issues)
+- **Documentation**:
+  [Wiki](https://github.com/abenteuerzeit/ojs-issue-preselection/wiki)
 - **OJS Forum**: [PKP Community Forum](https://forum.pkp.sfu.ca/)
 
 ## Contributing
@@ -230,4 +248,5 @@ Contributions are welcome! Please:
 
 ## License
 
-This plugin is licensed under the GNU General Public License v3.0. See [LICENSE](LICENSE) for details.
+This plugin is licensed under the GNU General Public License v3.0. See
+[LICENSE](LICENSE) for details.