(EditorMacrosService),
@@ -63,7 +60,6 @@ export class OpenProjectPluginContext {
public readonly classes = {
modals: {
passwordConfirmation: PasswordConfirmationModal,
- attributeHelpTexts: AttributeHelpTextModal,
dynamicContent: DynamicContentModal,
},
HalResource: HalResource,
diff --git a/frontend/src/app/modules/work_packages/openproject-work-packages.module.ts b/frontend/src/app/modules/work_packages/openproject-work-packages.module.ts
index 4651b5f24bf..d838799f7ca 100644
--- a/frontend/src/app/modules/work_packages/openproject-work-packages.module.ts
+++ b/frontend/src/app/modules/work_packages/openproject-work-packages.module.ts
@@ -165,8 +165,6 @@ import {WorkPackageSettingsButtonComponent} from "core-components/wp-buttons/wp-
import {BackButtonComponent} from "core-app/modules/common/back-routing/back-button.component";
import {DatePickerModal} from "core-components/datepicker/datepicker.modal";
import {WorkPackagesTableComponent} from "core-components/wp-table/wp-table.component";
-import {AttributeHelpTextComponent} from "core-app/modules/common/help-texts/attribute-help-text.component";
-import {AttributeHelpTextModal} from "core-app/modules/common/help-texts/attribute-help-text.modal";
@NgModule({
imports: [
@@ -372,9 +370,7 @@ import {AttributeHelpTextModal} from "core-app/modules/common/help-texts/attribu
WorkPackageSingleCardComponent,
WorkPackageViewToggleButton,
- // Help texts
- AttributeHelpTextComponent,
- AttributeHelpTextModal,
+
],
exports: [
WorkPackagesTableComponent,
@@ -409,10 +405,6 @@ import {AttributeHelpTextModal} from "core-app/modules/common/help-texts/attribu
WorkPackageSingleViewComponent,
WorkPackageSplitViewComponent,
BackButtonComponent,
-
- // Help texts
- AttributeHelpTextComponent,
- AttributeHelpTextModal,
]
})
export class OpenprojectWorkPackagesModule {
diff --git a/frontend/src/global_styles/openproject/_mixins.sass b/frontend/src/global_styles/openproject/_mixins.sass
index f7c70172463..f9d34e6fa3f 100644
--- a/frontend/src/global_styles/openproject/_mixins.sass
+++ b/frontend/src/global_styles/openproject/_mixins.sass
@@ -200,4 +200,17 @@ $scrollbar-size: 10px
visibility: hidden
@mixin d_n_d--preview
- box-shadow: 0 0 10px 5px rgba(0, 0, 0, 0.1)
\ No newline at end of file
+ box-shadow: 0 0 10px 5px rgba(0, 0, 0, 0.1)
+
+@mixin macro--text-style
+ @media screen
+ // Ensure width of contents is wrapped
+ display: inline-block
+ background: rgba(218,223,225,0.19)
+ border: 1px solid transparent
+ padding: 2px
+
+ &:hover
+ cursor: default
+ border-color: #c7c7c7
+ background: rgba(218,223,225,0.75)
diff --git a/lib/open_project/text_formatting/filters/pattern_matcher_filter.rb b/lib/open_project/text_formatting/filters/pattern_matcher_filter.rb
index df7feefbacc..af071670b68 100644
--- a/lib/open_project/text_formatting/filters/pattern_matcher_filter.rb
+++ b/lib/open_project/text_formatting/filters/pattern_matcher_filter.rb
@@ -37,7 +37,8 @@ module OpenProject::TextFormatting
def self.matchers
[
OpenProject::TextFormatting::Matchers::ResourceLinksMatcher,
- OpenProject::TextFormatting::Matchers::WikiLinksMatcher
+ OpenProject::TextFormatting::Matchers::WikiLinksMatcher,
+ OpenProject::TextFormatting::Matchers::AttributeMacros
]
end
diff --git a/lib/open_project/text_formatting/matchers/attribute_macros.rb b/lib/open_project/text_formatting/matchers/attribute_macros.rb
new file mode 100644
index 00000000000..8b0f6142c33
--- /dev/null
+++ b/lib/open_project/text_formatting/matchers/attribute_macros.rb
@@ -0,0 +1,71 @@
+#-- encoding: UTF-8
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 2012-2020 the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2017 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# See docs/COPYRIGHT.rdoc for more details.
+#++
+
+module OpenProject::TextFormatting
+ module Matchers
+ # OpenProject attribute macros syntax
+ # Examples:
+ # workPackageLabel:1234:subject # Outputs work package label attribute "Subject" + help text
+ # workPackageValue:1234:subject # Outputs the actual subject of #1234
+ #
+ # projectLabel:statusExplanation # Outputs current project label attribute "Status description" + help text
+ # projectValue:statusExplanation # Outputs current project value for "Status description"
+ class AttributeMacros < RegexMatcher
+ def self.regexp
+ %r{
+ (\w+)(Label|Value) # The model type we try to reference
+ (?::(?:([^"\s]+)|"([^"]+)"))? # Optional: An ID or subject reference
+ (?::([^"\s.]+|"([^".]+)")) # The attribute name we're trying to reference
+ }x
+ end
+
+ ##
+ # Faster inclusion check before the regex is being applied
+ def self.applicable?(content)
+ content.include?('Label:') || content.include?('Value:')
+ end
+
+ def self.process_match(m, matched_string, context)
+ # Leading string before match
+ macro_attributes = {
+ model: m[1],
+ id: m[4] || m[3],
+ attribute: m[6] || m[5]
+ }
+ type = m[2].downcase
+
+ ApplicationController.helpers.content_tag :macro,
+ '',
+ class: "macro--attribute-#{type}",
+ data: macro_attributes
+ end
+ end
+ end
+end
diff --git a/lib/open_project/text_formatting/matchers/link_handlers/work_packages.rb b/lib/open_project/text_formatting/matchers/link_handlers/work_packages.rb
index 8759f3df072..737d8a9880c 100644
--- a/lib/open_project/text_formatting/matchers/link_handlers/work_packages.rb
+++ b/lib/open_project/text_formatting/matchers/link_handlers/work_packages.rb
@@ -50,11 +50,22 @@ module OpenProject::TextFormatting::Matchers
# prohibits links to things like #0123
return if wp_id.to_s != matcher.identifier
- render_work_package_link(wp_id)
+ if matcher.sep == '##' || matcher.sep == '###'
+ render_work_package_macro(wp_id, detailed: (matcher.sep === '###'))
+ else
+ render_work_package_link(wp_id)
+ end
end
private
+ def render_work_package_macro(wp_id, detailed: false)
+ ApplicationController.helpers.content_tag :macro,
+ '',
+ class: "macro--wp-quickinfo",
+ data: { id: wp_id, detailed: detailed }
+ end
+
def render_work_package_link(wp_id)
link_to("##{wp_id}",
work_package_path_or_url(id: wp_id, only_path: context[:only_path]),
diff --git a/spec/features/wysiwyg/macros/attribute_macros_spec.rb b/spec/features/wysiwyg/macros/attribute_macros_spec.rb
new file mode 100644
index 00000000000..6008149e6e8
--- /dev/null
+++ b/spec/features/wysiwyg/macros/attribute_macros_spec.rb
@@ -0,0 +1,107 @@
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 2012-2020 the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2017 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# See docs/COPYRIGHT.rdoc for more details.
+#++
+
+require 'spec_helper'
+
+describe 'Wysiwyg attribute macros', type: :feature, js: true do
+ using_shared_fixtures :admin
+ let(:user) { admin }
+ let!(:project) { FactoryBot.create(:project, identifier: 'some-project', enabled_module_names: %w[wiki work_package_tracking]) }
+ let!(:work_package) { FactoryBot.create(:work_package, subject: "Foo Bar", project: project) }
+ let(:editor) { ::Components::WysiwygEditor.new }
+
+ let(:markdown) {
+ <<~MD
+ # My headline
+
+
+
+
+ | Label |
+ Value |
+
+
+
+
+ | workPackageLabel:"Foo Bar":subject |
+ workPackageValue:"Foo Bar":subject |
+
+
+ | projectLabel:identifier |
+ projectValue:identifier |
+
+
+ | invalid subject workPackageValue:"Invalid":subject |
+ invalid project projectValue:"does not exist":identifier |
+
+
+
+ MD
+ }
+
+ before do
+ login_as(user)
+ end
+
+ describe 'in wikis' do
+ describe 'creating a wiki page' do
+ before do
+ visit project_wiki_path(project, :wiki)
+ end
+
+ it 'can add and save multiple code blocks (Regression #28350)' do
+ editor.in_editor do |container,|
+ editor.set_markdown markdown
+ expect(container).to have_selector('table')
+ end
+
+ click_on 'Save'
+
+ expect(page).to have_selector('.flash.notice')
+
+ # Expect output widget
+ within('#content') do
+ expect(page).to have_selector('td', text: 'Subject')
+ expect(page).to have_selector('td', text: 'Foo Bar')
+ expect(page).to have_selector('td', text: 'Identifier')
+ expect(page).to have_selector('td', text: 'some-project')
+
+ expect(page).to have_selector('td', text: 'invalid subject Cannot expand macro: Requested resource could not be found')
+ expect(page).to have_selector('td', text: 'invalid project Cannot expand macro: Requested resource could not be found')
+ end
+
+ # Edit page again
+ click_on 'Edit'
+
+ editor.in_editor do |container,|
+ expect(container).to have_selector('tbody td', count: 6)
+ end
+ end
+ end
+ end
+end
diff --git a/spec/features/wysiwyg/macros/quicklink_macros_spec.rb b/spec/features/wysiwyg/macros/quicklink_macros_spec.rb
new file mode 100644
index 00000000000..7d02743a584
--- /dev/null
+++ b/spec/features/wysiwyg/macros/quicklink_macros_spec.rb
@@ -0,0 +1,93 @@
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 2012-2020 the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2017 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# See docs/COPYRIGHT.rdoc for more details.
+#++
+
+require 'spec_helper'
+
+describe 'Wysiwyg work package quicklink macros', type: :feature, js: true do
+ using_shared_fixtures :admin
+ let(:user) { admin }
+ let!(:project) { FactoryBot.create(:project, identifier: 'some-project', enabled_module_names: %w[wiki work_package_tracking]) }
+ let!(:work_package) {
+ FactoryBot.create(:work_package, subject: "Foo Bar", project: project, start_date: '2020-01-01', due_date: '2020-02-01')
+ }
+ let(:editor) { ::Components::WysiwygEditor.new }
+
+ let(:markdown) {
+ <<~MD
+ # My headline
+
+ ###{work_package.id}
+
+ ####{work_package.id}
+ MD
+ }
+
+ before do
+ login_as(user)
+ end
+
+ describe 'in wikis' do
+ describe 'creating a wiki page' do
+ before do
+ visit project_wiki_path(project, :wiki)
+ end
+
+ it 'can add and save multiple code blocks (Regression #28350)' do
+ editor.in_editor do |container,|
+ editor.set_markdown markdown
+ expect(container).to have_selector('p', text: "###{work_package.id}")
+ expect(container).to have_selector('p', text: "####{work_package.id}")
+ end
+
+ click_on 'Save'
+
+ expect(page).to have_selector('.flash.notice')
+
+ # Expect output widget
+ within('#content') do
+ expect(page).to have_selector('macro', count: 2)
+ expect(page).to have_selector('span', text: 'Foo Bar', count: 2)
+ expect(page).to have_selector('span', text: work_package.type.name.upcase, count: 2)
+ expect(page).to have_selector('span', text: work_package.status.name, count: 1)
+ # Dates are being rendered in two nested spans
+ expect(page).to have_selector('span', text: '01/01/2020', count: 2)
+ expect(page).to have_selector('span', text: '02/01/2020', count: 2)
+ expect(page).to have_selector('.work-package--quickinfo.preview-trigger', text: "##{work_package.id}", count: 2)
+ end
+
+ # Edit page again
+ click_on 'Edit'
+
+ editor.in_editor do |container,|
+ expect(container).to have_selector('p', text: "###{work_package.id}")
+ expect(container).to have_selector('p', text: "####{work_package.id}")
+ end
+ end
+ end
+ end
+end
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
new file mode 100644
index 00000000000..56cffbb068f
--- /dev/null
+++ b/spec/lib/open_project/text_formatting/markdown/attribute_macros_spec.rb
@@ -0,0 +1,119 @@
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 2012-2020 the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2017 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# See docs/COPYRIGHT.rdoc for more details.
+#++
+
+require 'spec_helper'
+
+describe OpenProject::TextFormatting,
+ 'Attribute macros',
+ # Speeds up the spec by avoiding event mailers to be processed
+ with_settings: { notified_events: [] } do
+
+ subject do
+ ::OpenProject::TextFormatting::Renderer.format_text(raw)
+ end
+
+ describe 'attribute label macros' do
+ let(:raw) do
+ <<~RAW
+ # My headline
+
+ Inline reference to WP by ID: workPackageLabel:1234:subject
+
+ Inline reference to WP by subject: workPackageLabel:"Some subject":"Some custom field with spaces"
+
+ Inline reference to project: projectLabel:status
+
+ Inline reference to project with id: projectLabel:"some id":status
+ RAW
+ end
+
+ let(:expected) do
+ <<~EXPECTED
+
+ My headline
+
+
+ Inline reference to WP by ID:
+
+
+ Inline reference to WP by subject:
+
+
+ Inline reference to project:
+
+
+ Inline reference to project with id:
+
+ EXPECTED
+ end
+
+ it 'should match' do
+ expect(subject).to be_html_eql(expected)
+ end
+ end
+
+ describe 'attribute value macros' do
+ let(:raw) do
+ <<~RAW
+ # My headline
+
+ Inline reference to WP by ID: workPackageValue:1234:subject
+
+ Inline reference to WP by subject: workPackageValue:"Some subject":"Some custom field with spaces"
+
+ Inline reference to project: projectValue:status
+
+ Inline reference to project with id: projectValue:"some id":status
+ RAW
+ end
+
+ let(:expected) do
+ <<~EXPECTED
+
+ My headline
+
+
+ Inline reference to WP by ID:
+
+
+ Inline reference to WP by subject:
+
+
+ Inline reference to project:
+
+
+ Inline reference to project with id:
+
+ EXPECTED
+ end
+
+ it 'should match' do
+ expect(subject).to be_html_eql(expected)
+ end
+ end
+end
diff --git a/spec/lib/open_project/text_formatting/markdown/markdown_spec.rb b/spec/lib/open_project/text_formatting/markdown/markdown_spec.rb
index b7fe9e28c4c..ccb03fe6b56 100644
--- a/spec/lib/open_project/text_formatting/markdown/markdown_spec.rb
+++ b/spec/lib/open_project/text_formatting/markdown/markdown_spec.rb
@@ -43,27 +43,27 @@ describe OpenProject::TextFormatting,
end
describe '.format_text' do
- let(:project) { FactoryBot.create :valid_project }
+ shared_let(:project) { FactoryBot.create :valid_project }
let(:identifier) { project.identifier }
- let(:role) do
+ shared_let(:role) do
FactoryBot.create :role,
permissions: %i(view_work_packages edit_work_packages
browse_repository view_changesets view_wiki_pages)
end
- let(:project_member) do
+ shared_let(:project_member) do
FactoryBot.create :user,
member_in_project: project,
member_through_role: role
end
- let(:issue) do
+ shared_let(:issue) do
FactoryBot.create :work_package,
project: project,
author: project_member,
type: project.types.first
end
- let!(:non_member) do
+ shared_let(:non_member) do
FactoryBot.create(:non_member)
end
@@ -237,6 +237,29 @@ describe OpenProject::TextFormatting,
}
end
+ describe 'double hash issue link' do
+ let(:issue_link) do
+ content_tag :macro,
+ '',
+ class: "macro--wp-quickinfo",
+ data: { id: '1234', detailed: 'false' }
+ end
+ subject { format_text("foo (bar ##1234)") }
+
+ it { is_expected.to be_html_eql("foo (bar #{issue_link})
") }
+ end
+
+ describe 'triple hash issue link' do
+ let(:issue_link) do
+ content_tag :macro,
+ '',
+ class: "macro--wp-quickinfo",
+ data: { id: '1234', detailed: 'true' }
+ end
+ subject { format_text("foo (bar ###1234)") }
+
+ it { is_expected.to be_html_eql("foo (bar #{issue_link})
") }
+ end
context 'Escaping issue link' do
subject { format_text("Some leading text. !##{issue.id}. Some following") }
diff --git a/spec/requests/api/v3/work_package_resource_spec.rb b/spec/requests/api/v3/work_package_resource_spec.rb
index a7a46de02ec..32e886443c7 100644
--- a/spec/requests/api/v3/work_package_resource_spec.rb
+++ b/spec/requests/api/v3/work_package_resource_spec.rb
@@ -286,7 +286,7 @@ describe 'API v3 Work package resource',
# resolves links
expect(subject['html'])
- .to have_selector("a[href='/work_packages/#{other_wp.id}']")
+ .to have_selector("macro.macro--wp-quickinfo[data-id='#{other_wp.id}']")
# resolves macros
is_expected.to have_text('Table of contents')
end