From 2beb411e5e53b65509cb874782c8925658e76cfb Mon Sep 17 00:00:00 2001 From: as-op Date: Wed, 28 Aug 2024 12:49:22 +0200 Subject: [PATCH 1/5] [#57024] Macros for work package descriptions which are relative to respective work packages https://community.openproject.org/work_packages/57024 --- docs/user-guide/wysiwyg/README.md | 194 ++++++++++++------ .../matchers/attribute_macros.rb | 27 ++- .../wysiwyg/macros/attribute_macros_spec.rb | 5 +- .../markdown/attribute_macros_spec.rb | 16 +- 4 files changed, 164 insertions(+), 78 deletions(-) diff --git a/docs/user-guide/wysiwyg/README.md b/docs/user-guide/wysiwyg/README.md index 971a84c7b5f7..af00d7c384ea 100644 --- a/docs/user-guide/wysiwyg/README.md +++ b/docs/user-guide/wysiwyg/README.md @@ -7,24 +7,25 @@ keywords: WYSIWYG, CKEditor, Links to OpenProject resources # Rich text (WYSIWYG) editor in OpenProject -Starting with version 8.0.0, OpenProject features a quasi-WYSIWYG editor, powered by [CKSource CKEditor5](https://ckeditor5.github.io/). The underlying format is GitHub-flavored CommonMark ([GFM](https://github.github.com/gfm/)). All previous textile-based content will be migrated when upgrading to OpenProject 8.0. +OpenProject features a quasi-WYSIWYG editor, powered by [CKSource CKEditor5](https://ckeditor5.github.io/). The underlying format is GitHub-flavored CommonMark ([GFM](https://github.github.com/gfm/)) with additional HTML for e.g. mentions and image sizing. -> **Please note:** In some resources such as work packages or comments, the editor does not exhibit all functionality such as macros or image upload. -> In the work package split screen view (details view) you may have to use the three vertical dots to access additional features of the editor. +> [!NOTE] +> In some resources, such as work packages or comments, the editor does not exhibit all functionality, such as macros or image uploads. +> In the work package split screen view (details view), you may have to use the three vertical dots to access additional features of the editor. -| Topic | Content | -| ------------------------------------------------------------ | -------------------------------------------------------- | -| [Basic formatting](#basic-formatting) | Basic formatting elements in the WYSIWYG editor | -| [Image handling](#image-handling) | How to add images in the WYSIWYG editor. | -| [Keyboard shortcuts](#keyboard-shortcuts) | Working with keyboard shortcuts in the WYSIWYG editor. | -| [Macros](#macros) | Available macros in the WYSIWYG editor | -| [Links to OpenProject resources](#links-to-openproject-resources) | How to link to resources like wikis, projects, meetings. | -| [Embedding of work package attributes and project attributes](#embedding-of-work-package-attributes-and-project-attributes) | How to embed attributes and attribute help texts. | +| Topic | Content | +|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| +| [Basic formatting](#basic-formatting) | Basic formatting elements in the WYSIWYG editor | +| [Image handling](#image-handling) | How to add images in the WYSIWYG editor. | +| [Keyboard shortcuts](#keyboard-shortcuts) | Working with keyboard shortcuts in the WYSIWYG editor. | +| [Macros](#macros) | Available macros in the WYSIWYG editor | +| [Links to OpenProject resources](#links-to-openproject-resources) | How to link to resources like wikis, projects and meetings. | +| [Embedding of work package attributes and project attributes](#embedding-of-work-package-attributes-and-project-attributes) | How to embed attributes and attribute help texts. | ## Basic formatting The CKEditor5 build in OpenProject supports basic text styles, such as bold and italic formatting, headings, -strike-through, inline code, and quotes as well as inline image handling. Pasting content such as images or rich text is also supported, while unsupported styling will be stripped by the editor. +strike-through, inline code, and quotes, as well as inline image handling. Pasting content such as images or rich text is also supported, while unsupported styling will be stripped by the editor. ### Line breaks @@ -36,7 +37,7 @@ Create hyperlinks by pressing the tool-bar (optionally with some selected text), ### Widgets and Newlines -CKEditor uses widgets to display block elements such as images, tables, and other elements that are not inline. You can select most widgets by pressing on it - The only exception to that is the table widget, it has a little select knob at the top left to select the entire table. +CKEditor uses widgets to display block elements such as images, tables, and other elements that are not inline. You can select most widgets by pressing on them - The only exception to that is the table widget, it has a little select knob at the top left to select the entire table. When you have a widget selected, you can remove or cut it. You can create a newline below it by selecting the widget and pressing `ENTER` or `↓ (ARROW DOWN)`, or a newline above it by pressing `SHIFT+enter` or `↑ (ARROW UP)`. This is especially needed when the widget is the first or last element on the page to insert a line below or above it. @@ -46,7 +47,7 @@ As CKEditor5 currently does not provide support for code blocks, OpenProject can ### Tables -The GFM extension of the CommonMark specs adds a definition for table syntax which the CKEditor of OpenProject supports. This definition requires all tables to have a heading row. For tables created with CKEditor without heading rows, a HTML table is output instead. This matches the behavior of, e.g., GitHub. +The GFM extension of the CommonMark specs adds a definition for table syntax, which the CKEditor of OpenProject supports. This definition requires all tables to have a heading row. For tables created with CKEditor without heading rows, a HTML table is output instead. This matches the behavior of, e.g., GitHub. ### Autoformatting @@ -75,13 +76,13 @@ CKEditor has a wide variety of keyboard shortcuts you can use. You can find a li On top of that, OpenProject adds the following shortcut: -| Shortcut (Windows / Linux) | Shortcut (Mac) | Action | -| -------------------------- | -------------- | ------------------------------------------------------------ | +| Shortcut (Windows / Linux) | Shortcut (Mac) | Action | +|----------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | CTRL + ENTER | CMD + ENTER | **Save changes.**
For inline-editable fields, save the field and close it.
For pages with a full WYSIWYG (meetings, wiki pages), submit the form. | ## Macros -OpenProject has supported macros on textile formatted pages and continues to do so with the WYSIWYG editor. Note that macros are not expanded while editing the page, instead a placeholder is shown. +OpenProject has supported macros on textile formatted pages and continues to do so with the WYSIWYG editor. Note that macros are not expanded while editing the page, instead, a placeholder is shown. You can find the macros here in the text editor: ![Macros text editor](image-20201109183018255.png) @@ -112,87 +113,144 @@ Use it to embed views in other pages, create reporting of multiple results, or t As with the textile formatting syntax, you can link to other resources within OpenProject using the same shortcuts as before. Create links to a: -- **wiki page**: `[[Wiki page]]` -- **wiki page with separate link name**: `[[Wiki page|The text of the link]]` -- **wiki page in the Sandbox project**: `[[Sandbox:Wiki page]]` -- **work package with ID12**: `#12` -- **work package with ID 12 with subject and type**: `##12` -- **work package with ID 12 with subject, type, status, and dates**: `###12` -- **version by ID or name**: `version#3`, `version:"Release 1.0.0"` -- **project by ID/name**: `project#12` , `project:"My project name"` -- **attachment by filename**: `attachment:filename.zip` -- **meeting by ID/name**: `meeting#12` , `meeting:"My meeting name"` -- **document by ID/name**: `document#12` , `document:"My document name"` -- **user by id or login**: `user#4` , `user:"johndoe"` -- **a forum message by ID**: `message#1218` -- **repository revision 43**: `r43` -- **commit by hash:** `commit:f30e13e4` -- **To a source file in the repository**: `source:"some/file"` +| **Link target** | Usage example | +|---------------------------------------------------------------|-----------------------------------------------| +| Wiki page | `[[Wiki page]]` | +| Wiki page with separate link name | `[[Wiki page\|The text of the link]]` | +| Wiki page in the Sandbox project | `[[Sandbox:Wiki page]]` | +| Work package with ID12 | `#12` | +| Work package with ID 12 with subject and type | `##12` | +| Work package with ID 12 with subject, type, status, and dates | `###12` | +| Version by ID or name | `version#3`, `version:"Release 1.0.0"` | +| Project by ID/name | `project#12` , `project:"My project name"` | +| Attachment by filename | `attachment:filename.zip` | +| Meeting by ID/name | `meeting#12` , `meeting:"My meeting name"` | +| Document by ID/name | `document#12` , `document:"My document name"` | +| User by ID or login | `user#4` , `user:"johndoe"` | +| Forum message by ID | `message#1218` | +| Repository revision 43 | `r43` | +| Commit by hash | `commit:f30e13e4` | +| Source file in the repository | `source:"some/file"` | To avoid processing these items, preceding them with a bang `!` character such as `!#12` will prevent linking to a work package with ID 12. -> **Please note**: All these macros need to be written as a new word (i.e., with at least one space before it or at the beginning of a paragraph/sentence. Macros contained within a word such as `somethingmeeting#4` will not be parsed. +> [!NOTE] +> All these macros need to be written as a new word (i.e., with at least one space before it or at the beginning of a paragraph/sentence). Macros contained within a word such as `somethingmeeting#4` will not be parsed. ### Autocompletion for work packages and users -For work packages and users, typing `#` or `@` will open an autocompleter for visible work packages and users, respectively. +For work packages and users, typing `#` or `@` will open an autocomplete dropdown for visible work packages and users, respectively. ## Embedding of work package attributes and project attributes -You can embed specific attributes of work packages or projects using a certain syntax. -Examples: +> [!NOTE] +> These macros will only be expanded in the frontend. For each individual user, the correct permissions will be checked and +> the macro will result in an error if the user is not allowed to view the respective resource. -- **Linking to the subject of work package with id #1234**: `workPackageValue:1234:subject` (this also works for other attributes, too. See table below.) -- **Linking to the current project's status**: `projectValue:status` -- **Linking to the subject of work package with subject "Project start"**: `workPackageValue:"Project start":subject` +### Embedding of a work package value by work package ID -> **Please note**: Referencing a work package by subject results in only looking for work packages with that given subject in the current project (if any). If you need to cross-reference work packages, use their ID to pinpoint the work package you want to reference. +Use the `workPackageValue:ID:attribute` macros to embed attributes of a work package by its [work package ID](../work-packages). +See the [table below](#available-attributes-for-work-packages) for available attributes. -### Embedding attribute help texts +Example: + +**Linking to the subject of work package with ID #1234**: `workPackageValue:1234:subject` + +### Embedding of a work package value by work package subject + +Use the `workPackageValue:"Project name":attribute` macros to embed attributes of a work package by its subject. +See the [table below](#available-attributes-for-work-packages) for available attributes. + +Example: + +**Linking to the assignee of work package with subject "Project start"**: `workPackageValue:"Project start":assignee` + +> [!NOTE] +> Referencing a work package by subject results in only looking for work packages with that given subject in the current project (if any). +> If you need to cross-reference work packages, use their ID to pinpoint the work package you want to reference. +> We recommend against using subjects as references, as they are not updated when the referenced subject changes. + +### Relative embedding of a work package value + +Use the `workPackageValue:attribute` macros to embed attributes of the current work package. + +If you are editing a work package description or a rich text custom field belonging to a work package you can omit the ID if you want to reference it. +You must include the work package ID if you are editing e.g. a wiki page or a meeting description. +See the [table below](#available-attributes-for-work-packages) for available attributes. + +Example: -You can also embed attribute values and [their help texts](../../system-admin-guide/attribute-help-texts/) by using `workPackageLabel` instead of: `workPackageLabel:1234:status` which would output the translated label for "Status" and (if exists), the corresponding help text for it. +**Linking to the assigned person of the current work package**: `workPackageValue:assignee` + +### Embedding of a project value by project ID + +Use the `projectValue:ID:attribute` macros to embed attributes of a project by its project ID. +See the [table below](#available-attributes-for-projects) for available attributes. + +Example: + +**Linking to the project's status with the ID 1234**: `projectValue:1234:status` + +### Relative embedding of a project value + +Use the `projectValue:attribute` macros to embed attributes of the current project. +See the [table below](#available-attributes-for-projects) for available attributes. + +Example: + +**Linking to the current project's status**: `projectValue:status` + +### Embedding attribute help texts -> **Please note**: These macros will only be expanded in the frontend. For each individual user, the correct permissions will be checked and the macro will result in an error if the user is not allowed to view the respective resource. +You can also embed attribute values and [their help texts](../../system-admin-guide/attribute-help-texts/) by using `workPackageLabel` or `projectLabel`. +For example`workPackageLabel:1234:status` would output the translated label for "Status" and (if exists), the corresponding help text for it. ## Attributes The following lists show the supported attributes for work packages and projects. -> **Please note**: If you are using a language different than English, a translation of the commands can only be used in the text editor if the language of all the users of an instance is set to the same language (for example German). In this case, only the attribute to which the command refers is translated, e.g. (`workPackageValue:1234:"translated attribute"`). We recommend against using translated attributes, as they might break in future versions due to fixes or changes to texts. +> [!NOTE] +> If you are using a language different than English, a translation of the commands can only be used in the text editor if the language of all the users of an instance is set to the same language (for example German). +> In this case, only the attribute to which the command refers is translated, e.g. (`workPackageValue:1234:"translated attribute"`). +> We recommend against using translated attributes, as they might break in future versions due to fixes or changes to texts. ### Available attributes for work packages -The following list contains all supported attribute names for the `workPackageValue` and `workPackageLabel` macros, where `1234` stands for the [work package ID](../work-packages). +The following list contains all supported attribute names for the `workPackageValue` and `workPackageLabel` macros, +where `1234` stands for the [work package ID](../work-packages). -| **Attribute** | Usage example | -| ------------------- | ------------------------------------------------------------ | +| **Attribute** | Usage example | +|---------------------|-----------------------------------------------------------------| | *Custom Fields* | `workPackageValue:1234:"Name of the work package custom field"` | -| Assignee | `workPackageValue:1234:assignee` | -| Author | `workPackageValue:1234:author` | -| Category | `workPackageValue:1234:category` | -| Creation date | `workPackageValue:1234:createdAt` | -| Description | `workPackageValue:1234:description` | -| Estimated time | `workPackageValue:1234:estimatedTime` | -| Finish date | `workPackageValue:1234:dueDate` | -| Parent work package | `workPackageValue:1234:parent` | -| Priority | `workPackageValue:1234:priority` | -| Project | `workPackageValue:1234:project` | -| Remaining hours | `workPackageValue:1234:remainingTime` (sic!) | -| Responsible user | `workPackageValue:1234:responsible` | -| Spent time | `workPackageValue:1234:spentTime` | -| Start date | `workPackageValue:1234:startDate` | -| Status | `workPackageValue:1234:status` | -| Subject / Title | `workPackageValue:1234:subject` | -| Work package type | `workPackageValue:1234:type` | -| Date of last update | `workPackageValue:1234:updatedAt` | -| Version | `workPackageValue:1234:version` | +| Assignee | `workPackageValue:1234:assignee` | +| Author | `workPackageValue:1234:author` | +| Category | `workPackageValue:1234:category` | +| Creation date | `workPackageValue:1234:createdAt` | +| Description | `workPackageValue:1234:description` | +| Estimated time | `workPackageValue:1234:estimatedTime` | +| Finish date | `workPackageValue:1234:dueDate` | +| Parent work package | `workPackageValue:1234:parent` | +| Priority | `workPackageValue:1234:priority` | +| Project | `workPackageValue:1234:project` | +| Remaining hours | `workPackageValue:1234:remainingTime` | +| Accountable | `workPackageValue:1234:responsible` | +| Spent time | `workPackageValue:1234:spentTime` | +| Start date | `workPackageValue:1234:startDate` | +| Status | `workPackageValue:1234:status` | +| Subject / Title | `workPackageValue:1234:subject` | +| Work package type | `workPackageValue:1234:type` | +| Date of last update | `workPackageValue:1234:updatedAt` | +| Version | `workPackageValue:1234:version` | + +> [!NOTE] +> Recursive embedding of rich text is not supported. For example, you cannot embed a work package description in itself with `workPackageValue:description`. ### Available attributes for projects The following list contains all supported attribute names for the `projectValue` and `projectLabel` macros. The examples all show references to the _current_ project the document is rendered in. They can also reference another project with `projectValue:"Identifier of the project":attribute`. | **Attribute** | Usage example | -| ------------------------- | ------------------------------------------------- | +|---------------------------|---------------------------------------------------| | *Custom Fields* | `projectValue:"Name of the project custom field"` | | Project active? (boolean) | `projectValue:active` | | Description | `projectValue:description` | diff --git a/lib/open_project/text_formatting/matchers/attribute_macros.rb b/lib/open_project/text_formatting/matchers/attribute_macros.rb index 82b50100cd7e..81aecdeae099 100644 --- a/lib/open_project/text_formatting/matchers/attribute_macros.rb +++ b/lib/open_project/text_formatting/matchers/attribute_macros.rb @@ -30,7 +30,9 @@ module OpenProject::TextFormatting module Matchers # OpenProject attribute macros syntax # Examples: + # workPackageLabel:subject # Outputs work package label attribute "Subject" + help text # workPackageLabel:1234:subject # Outputs work package label attribute "Subject" + help text + # workPackageValue:subject # Outputs the actual subject of #1234 of the current work package 1234 if applicable # workPackageValue:1234:subject # Outputs the actual subject of #1234 # # projectLabel:statusExplanation # Outputs current project label attribute "Status description" + help text @@ -50,14 +52,29 @@ def self.applicable?(content) content.include?("Label:") || content.include?("Value:") end - def self.process_match(m, _matched_string, _context) + def self.work_package_context?(context) + context[:object].is_a?(WorkPackage) || context[:object].is_a?(API::V3::WorkPackages::WorkPackageEagerLoadingWrapper) + end + + def self.relative_work_package_embed?(macro_attributes) + macro_attributes[:id].nil? && macro_attributes[:model] == "workPackage" + end + + def self.process_match(match, _matched_string, context) # Leading string before match macro_attributes = { - model: m[1], - id: m[4] || m[3], - attribute: m[6] || m[5] + model: match[1], + id: match[4] || match[3], + attribute: match[6] || match[5] } - type = m[2].downcase + type = match[2].downcase + + # If no ID is given, try to use the current work package ID if applicable + # workPackageValue can be used in e.g. wiki and meeting notes without a work package, + # relative embedding is not supported in these cases + if relative_work_package_embed?(macro_attributes) && work_package_context?(context) + macro_attributes[:id] = context[:object].try(:id) + end ApplicationController.helpers.content_tag "opce-macro-attribute-#{type}", "", diff --git a/spec/features/wysiwyg/macros/attribute_macros_spec.rb b/spec/features/wysiwyg/macros/attribute_macros_spec.rb index 7ce04c358335..5bbf1c05b606 100644 --- a/spec/features/wysiwyg/macros/attribute_macros_spec.rb +++ b/spec/features/wysiwyg/macros/attribute_macros_spec.rb @@ -54,15 +54,14 @@ invalid subject workPackageValue:"Invalid":subject + invalid relative subject workPackageValue:subject invalid project projectValue:"does not exist":identifier - work package start date workPackageValue:"Foo Bar":startDate work package due date workPackageValue:"Foo Bar":dueDate work package date workPackageValue:"Foo Bar":date - milestone start date workPackageValue:"Milestone":startDate milestone due date workPackageValue:"Milestone":dueDate @@ -125,6 +124,8 @@ expect(page).to have_css("td", text: "some-project") expect(page).to have_css("td", text: "invalid subject Cannot expand macro: Requested resource could not be found") + expect(page).to have_css("td", + text: "invalid relative subject Cannot expand macro: Requested resource could not be found") expect(page).to have_css("td", text: "invalid project Cannot expand macro: Requested resource could not be found") expect(page).to have_css("td", text: "work package start date 01/01/2023") diff --git a/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb index a449c84a0555..011244b37642 100644 --- a/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb +++ b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb @@ -32,6 +32,9 @@ RSpec.describe OpenProject::TextFormatting, "Attribute macros" do include_context "expected markdown modules" + shared_let(:project) { create(:valid_project) } + let(:work_package) { create(:work_package, project:, id: 1234) } + let(:options) { { project:, object: work_package } } describe "attribute label macros" do it_behaves_like "format_text produces" do @@ -39,6 +42,8 @@ <<~RAW # My headline + Inline reference to WP: workPackageLabel:subject + Inline reference to WP by ID: workPackageLabel:1234:subject Inline reference to WP by subject: workPackageLabel:"Some subject":"Some custom field with spaces" @@ -55,6 +60,9 @@ My headline +

+ Inline reference to WP: +

Inline reference to WP by ID:

@@ -64,9 +72,6 @@

Inline reference to project:

-

- Inline reference to project with id: -

EXPECTED end end @@ -78,6 +83,8 @@ <<~RAW # My headline + Inline reference to WP: workPackageValue:subject + Inline reference to WP by ID: workPackageValue:1234:subject Inline reference to WP by subject: workPackageValue:"Some subject":"Some custom field with spaces" @@ -94,6 +101,9 @@ My headline +

+ Inline reference to WP: +

Inline reference to WP by ID:

From ce598af09f1963029685b8920186d942de0506e3 Mon Sep 17 00:00:00 2001 From: as-op Date: Thu, 29 Aug 2024 10:12:49 +0200 Subject: [PATCH 2/5] fix missing expected --- .../text_formatting/markdown/attribute_macros_spec.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb index 011244b37642..23c7ff244cdb 100644 --- a/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb +++ b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb @@ -72,6 +72,9 @@

Inline reference to project:

+

+ Inline reference to project with id: +

EXPECTED end end From b10caed5b3c85f8133205b6170d26e8af7b4fc4a Mon Sep 17 00:00:00 2001 From: as-op Date: Mon, 2 Sep 2024 12:45:03 +0200 Subject: [PATCH 3/5] add project id of project embeds to macro node, so frontend does not need to search; Closes https://github.com/opf/openproject/pull/16542#discussion_r1736053003 --- .../matchers/attribute_macros.rb | 25 +++++++++++++------ .../markdown/attribute_macros_spec.rb | 24 ++++++++++++------ 2 files changed, 35 insertions(+), 14 deletions(-) diff --git a/lib/open_project/text_formatting/matchers/attribute_macros.rb b/lib/open_project/text_formatting/matchers/attribute_macros.rb index 81aecdeae099..9d21b035a0c5 100644 --- a/lib/open_project/text_formatting/matchers/attribute_macros.rb +++ b/lib/open_project/text_formatting/matchers/attribute_macros.rb @@ -53,11 +53,21 @@ def self.applicable?(content) end def self.work_package_context?(context) + # workPackageValue can be used in e.g. wiki and meeting notes without a work package, + # relative embedding is not supported in these cases context[:object].is_a?(WorkPackage) || context[:object].is_a?(API::V3::WorkPackages::WorkPackageEagerLoadingWrapper) end - def self.relative_work_package_embed?(macro_attributes) - macro_attributes[:id].nil? && macro_attributes[:model] == "workPackage" + def self.work_package_embed?(macro_attributes) + macro_attributes[:model] == "workPackage" + end + + def self.project_embed?(macro_attributes) + macro_attributes[:model] == "project" + end + + def self.relative_embed?(macro_attributes) + macro_attributes[:id].nil? end def self.process_match(match, _matched_string, context) @@ -69,11 +79,12 @@ def self.process_match(match, _matched_string, context) } type = match[2].downcase - # If no ID is given, try to use the current work package ID if applicable - # workPackageValue can be used in e.g. wiki and meeting notes without a work package, - # relative embedding is not supported in these cases - if relative_work_package_embed?(macro_attributes) && work_package_context?(context) - macro_attributes[:id] = context[:object].try(:id) + if relative_embed?(macro_attributes) + if project_embed?(macro_attributes) && context[:project].present? + macro_attributes[:id] = context[:project].try(:id) + elsif work_package_embed?(macro_attributes) && work_package_context?(context) + macro_attributes[:id] = context[:object].try(:id) + end end ApplicationController.helpers.content_tag "opce-macro-attribute-#{type}", diff --git a/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb index 23c7ff244cdb..476ed7156a04 100644 --- a/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb +++ b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb @@ -32,7 +32,7 @@ RSpec.describe OpenProject::TextFormatting, "Attribute macros" do include_context "expected markdown modules" - shared_let(:project) { create(:valid_project) } + shared_let(:project) { create(:valid_project, id: 4321) } let(:work_package) { create(:work_package, project:, id: 1234) } let(:options) { { project:, object: work_package } } @@ -50,7 +50,9 @@ Inline reference to project: projectLabel:status - Inline reference to project with id: projectLabel:"some id":status + Inline reference to project with id: projectLabel:4321:status + + Inline reference to project with name: projectLabel:"some name":status RAW end @@ -70,10 +72,13 @@ Inline reference to WP by subject:

- Inline reference to project: + Inline reference to project: +

+

+ Inline reference to project with id:

- Inline reference to project with id: + Inline reference to project with name:

EXPECTED end @@ -94,7 +99,9 @@ Inline reference to project: projectValue:status - Inline reference to project with id: projectValue:"some id":status + Inline reference to project with id: projectValue:4321:status + + Inline reference to project with name: projectValue:"some name":status RAW end @@ -114,10 +121,13 @@ Inline reference to WP by subject:

- Inline reference to project: + Inline reference to project: +

+

+ Inline reference to project with id:

- Inline reference to project with id: + Inline reference to project with name:

EXPECTED end From e9fa439e071b9700c06886c0a61d90ecfadaa6de Mon Sep 17 00:00:00 2001 From: as-op Date: Mon, 2 Sep 2024 13:17:00 +0200 Subject: [PATCH 4/5] obey rubocop --- .../text_formatting/matchers/attribute_macros.rb | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/lib/open_project/text_formatting/matchers/attribute_macros.rb b/lib/open_project/text_formatting/matchers/attribute_macros.rb index 9d21b035a0c5..09511d88f34a 100644 --- a/lib/open_project/text_formatting/matchers/attribute_macros.rb +++ b/lib/open_project/text_formatting/matchers/attribute_macros.rb @@ -70,6 +70,14 @@ def self.relative_embed?(macro_attributes) macro_attributes[:id].nil? end + def self.relative_id(macro_attributes, context) + if project_embed?(macro_attributes) && context[:project].present? + context[:project].try(:id) + elsif work_package_embed?(macro_attributes) && work_package_context?(context) + context[:object].try(:id) + end + end + def self.process_match(match, _matched_string, context) # Leading string before match macro_attributes = { @@ -79,13 +87,7 @@ def self.process_match(match, _matched_string, context) } type = match[2].downcase - if relative_embed?(macro_attributes) - if project_embed?(macro_attributes) && context[:project].present? - macro_attributes[:id] = context[:project].try(:id) - elsif work_package_embed?(macro_attributes) && work_package_context?(context) - macro_attributes[:id] = context[:object].try(:id) - end - end + macro_attributes[:id] = relative_id(macro_attributes, context) if relative_embed?(macro_attributes) ApplicationController.helpers.content_tag "opce-macro-attribute-#{type}", "", From a1d5c82a62523d838fcfcb70be556208c4e1a48e Mon Sep 17 00:00:00 2001 From: as-op Date: Tue, 17 Sep 2024 12:40:33 +0200 Subject: [PATCH 5/5] add test for WorkPackageEagerLoadingWrapper text formatting; addresses https://github.com/opf/openproject/pull/16542#discussion_r1736049674 --- .../matchers/attribute_macros.rb | 3 +- .../markdown/attribute_macros_spec.rb | 31 ++++++++++++++----- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/lib/open_project/text_formatting/matchers/attribute_macros.rb b/lib/open_project/text_formatting/matchers/attribute_macros.rb index 09511d88f34a..92aeffe1ae81 100644 --- a/lib/open_project/text_formatting/matchers/attribute_macros.rb +++ b/lib/open_project/text_formatting/matchers/attribute_macros.rb @@ -55,7 +55,8 @@ def self.applicable?(content) def self.work_package_context?(context) # workPackageValue can be used in e.g. wiki and meeting notes without a work package, # relative embedding is not supported in these cases - context[:object].is_a?(WorkPackage) || context[:object].is_a?(API::V3::WorkPackages::WorkPackageEagerLoadingWrapper) + # work package list view or the work package fullscreen view use the wrapper via API calls, not the WorkPackage model + context[:object].is_a?(API::V3::WorkPackages::WorkPackageEagerLoadingWrapper) || context[:object].is_a?(WorkPackage) end def self.work_package_embed?(macro_attributes) diff --git a/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb index 476ed7156a04..769f26bcaf6c 100644 --- a/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb +++ b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb @@ -29,13 +29,7 @@ require "spec_helper" require_relative "expected_markdown" -RSpec.describe OpenProject::TextFormatting, - "Attribute macros" do - include_context "expected markdown modules" - shared_let(:project) { create(:valid_project, id: 4321) } - let(:work_package) { create(:work_package, project:, id: 1234) } - let(:options) { { project:, object: work_package } } - +RSpec.shared_examples_for "resolving macros" do describe "attribute label macros" do it_behaves_like "format_text produces" do let(:raw) do @@ -134,3 +128,26 @@ end end end + +RSpec.describe OpenProject::TextFormatting, "Attribute macros" do + include_context "expected markdown modules" + shared_let(:project) { create(:valid_project, id: 4321) } + let(:work_package) { create(:work_package, project:, id: 1234) } + + context "with work package" do + it_behaves_like "resolving macros" do + let(:options) { { project:, object: work_package } } + end + end + + context "with eager loading work package wrapper" do + it_behaves_like "resolving macros" do + let(:options) do + { + project:, + object: API::V3::WorkPackages::WorkPackageEagerLoadingWrapper.wrap_one(work_package, nil) + } + end + end + end +end