Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

[#65925] Make #join_flash_messages return String

Alexander Brandon Colesca8f69641cc8
diff --git a/app/helpers/flash_messages_output_safety_helper.rb b/app/helpers/flash_messages_output_safety_helper.rb
index 782aa009a41..f0112cb9c69 100644
--- a/app/helpers/flash_messages_output_safety_helper.rb
+++ b/app/helpers/flash_messages_output_safety_helper.rb
@@ -36,10 +36,6 @@ module FlashMessagesOutputSafetyHelper
end
def join_flash_messages(messages)
- if messages.respond_to?(:join)
- safe_join(messages, "<br />".html_safe)
- else
- messages
- end
+ safe_join(Array(messages), "<br />".html_safe)
end
end
diff --git a/spec/helpers/flash_messages_output_safety_helper_spec.rb b/spec/helpers/flash_messages_output_safety_helper_spec.rb
new file mode 100644
index 00000000000..7e847cdbaaa
--- /dev/null
+++ b/spec/helpers/flash_messages_output_safety_helper_spec.rb
@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 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-2013 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 COPYRIGHT and LICENSE files for more details.
+#++
+
+require "spec_helper"
+
+RSpec.describe FlashMessagesOutputSafetyHelper do
+ subject { helper.join_flash_messages(flash_messages) }
+
+ shared_examples "HTML safety" do
+ it "returns an HTML-safe string" do
+ expect(subject).to be_html_safe
+ end
+ end
+
+ context "when flash_messages is a non-empty Array" do
+ let(:flash_messages) { ["Flash message #1", "Flash message #2"] }
+
+ it "joins the two flash messages" do
+ expect(subject).to eq "Flash message #1<br />Flash message #2"
+ end
+
+ include_examples "HTML safety"
+ end
+
+ context "when flash_messages is a nested Array" do
+ let(:flash_messages) { ["Flash message #1", ["Flash message #2", "Flash message #3"]] }
+
+ it "joins the three flash messages" do
+ expect(subject).to eq "Flash message #1<br />Flash message #2<br />Flash message #3"
+ end
+
+ include_examples "HTML safety"
+ end
+
+ context "when flash_messages is an empty Array" do
+ let(:flash_messages) { [] }
+
+ it "returns an empty String" do
+ expect(subject).to eq ""
+ end
+
+ include_examples "HTML safety"
+ end
+
+ context "when flash_messages is a String" do
+ let(:flash_messages) { "Flash message #1" }
+
+ it "returns the String" do
+ expect(subject).to eq "Flash message #1"
+ end
+
+ include_examples "HTML safety"
+ end
+
+ context "when flash_messages is nil" do
+ let(:flash_messages) { nil }
+
+ it "returns an empty String" do
+ expect(subject).to eq ""
+ end
+
+ include_examples "HTML safety"
+ end
+end