Merge pull request #7518 from opf/feature/project-longtext-cf

Allow WYSIWYG in project/other long text formattible fields

[ci skip]

app/models/custom_value/formattable_strategy.rb

@@ -0,0 +1,42 @@
+#-- encoding: UTF-8
+#-- copyright
+# OpenProject is a project management system.
+# Copyright (C) 2012-2018 the OpenProject Foundation (OPF)
+#
+# 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.
+#++
+
+class
+  CustomValue::FormattableStrategy < CustomValue::FormatStrategy
+
+  def formatted_value
+    OpenProject::TextFormatting::Renderer.format_text value
+  end
+
+  def typed_value
+    value.to_s
+  end
+
+  def validate_type_of_value; end
+end

app/views/customizable/_form.html.erb

@@ -32,7 +32,7 @@ See docs/COPYRIGHT.rdoc for more details.
 <% form.object.custom_field_values.each do |value| %>
   <%= form.fields_for_custom_fields :custom_field_values, value do |value_form| %>
     <% required = value.custom_field.is_required? %>
-    <div class="form--field <%= required ? '-required' : '' %>">
+    <div class="form--field custom_field_<%= value.custom_field.id %> <%= required ? '-required' : '' %>">
       <%# display all fields OR only display required fields OR only display optional fields #%>
       <% if all_fields || (only_required && required) || (!only_required && !required) %>
         <%= value_form.custom_field(container_class: '-wide', required: required) %>

config/initializers/custom_field_format.rb

@@ -34,7 +34,8 @@ OpenProject::CustomFieldFormat.map do |fields|
                                                      order: 1)
   fields.register OpenProject::CustomFieldFormat.new('text',
                                                      label: :label_text,
-                                                     order: 2)
+                                                     order: 2,
+                                                     formatter: 'CustomValue::FormattableStrategy')
   fields.register OpenProject::CustomFieldFormat.new('int',
                                                      label: :label_integer,
                                                      order: 3,

lib/custom_field_form_builder.rb

@@ -31,6 +31,7 @@ require 'action_view/helpers/form_helper'
 
 class CustomFieldFormBuilder < TabularFormBuilder
   include ActionView::Context
+
   # Return custom field html tag corresponding to its format
   def custom_field(options = {})
     input = custom_field_input(options)
@@ -67,7 +68,7 @@ class CustomFieldFormBuilder < TabularFormBuilder
       input_options[:class] = (input_options[:class] || '') << ' -augmented-datepicker'
       text_field(field, input_options)
     when 'text'
-      text_area(field, input_options.merge(rows: 3))
+      text_area(field, input_options.merge(rows: 3, with_text_formatting: true))
     when 'bool'
       formatter = field_format.formatter.new(object)
       check_box(field, input_options.merge(checked: formatter.checked?))

lib/open_project/form_tag_helper.rb

@@ -85,7 +85,7 @@ module OpenProject
 
     ##
     # Create a wrapper for the text formatting toolbar for this field
-    def text_formatting_wrapper(target_id, options)
+    def text_formatting_wrapper(target_id, options = {})
       return ''.html_safe unless target_id.present?
 
       helper = ::OpenProject::TextFormatting::Formats.rich_helper.new(self)

spec/features/projects/copy_spec.rb

@@ -136,8 +136,8 @@ describe 'Projects copy',
     check 'only_wiki_page_attachments'
 
     # the value of the custom field should be preselected
-    expect(page)
-      .to have_field(project_custom_field.name, with: 'some text cf')
+    editor = ::Components::WysiwygEditor.new ".form--field.custom_field_#{project_custom_field.id}"
+    editor.expect_value 'some text cf'
 
     click_button 'Copy'
 
@@ -160,8 +160,8 @@ describe 'Projects copy',
                       selected: parent_project.name)
 
     # copies over the value of the custom field
-    expect(page)
-      .to have_field(project_custom_field.name, with: 'some text cf')
+    editor = ::Components::WysiwygEditor.new ".form--field.custom_field_#{project_custom_field.id}"
+    editor.expect_value 'some text cf'
 
     # has wp custom fields of original project active
     copied_settings_page.visit_tab!('custom_fields')

spec/features/projects/projects_custom_fields_spec.rb

@@ -54,12 +54,39 @@ describe 'Projects custom fields', type: :feature do
     end
   end
 
+  describe 'with long text CF' do
+    let!(:custom_field) do
+      FactoryBot.create(:text_project_custom_field)
+    end
+    let(:editor) { ::Components::WysiwygEditor.new ".form--field.custom_field_#{custom_field.id}" }
+
+    scenario 'allows settings the project boolean CF (regression #26313)', js: true do
+      visit settings_project_path(id: project.id)
+
+      # expect CF and description ckeditor
+      expect(page).to have_selector('.op-ckeditor--wrapper', count: 2)
+
+      # single hash autocomplete
+      editor.insert_link 'http://example.org/link with spaces'
+
+      # Save wiki page
+      click_on 'Save'
+
+      expect(page).to have_selector('.flash.notice')
+
+      project.reload
+      cv = project.custom_values.find_by(custom_field_id: custom_field.id).value
+
+      expect(cv).to include '[http://example.org/link with spaces](http://example.org/link%20with%20spaces)'
+      expect(page).to have_selector('a[href="http://example.org/link%20with%20spaces"]')
+    end
+  end
+
   describe 'with boolean CF' do
     let!(:custom_field) do
       FactoryBot.create(:bool_project_custom_field)
     end
 
-
     scenario 'allows settings the project boolean CF (regression #26313)', js: true do
       visit settings_project_path(id: project.id)
       expect(page).to have_no_checked_field identifier

spec/lib/custom_field_form_builder_spec.rb

@@ -103,7 +103,8 @@ describe CustomFieldFormBuilder do
           <textarea class="custom-class form--text-area"
                     id="user#{resource.custom_field_id}"
                     name="user[#{resource.custom_field_id}]"
-                    rows="3">
+                    rows="3"
+                    with_text_formatting="true">
           </textarea>
         }).at_path('textarea')
       end