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

[#66736] PDF export fails for cover page and CustomStyle with cover_text_color

as-op12f595747b36
diff --git a/app/models/exports/pdf/components/cover.rb b/app/models/exports/pdf/components/cover.rb
index 0a06b6766de..0b778249b74 100644
--- a/app/models/exports/pdf/components/cover.rb
+++ b/app/models/exports/pdf/components/cover.rb
@@ -29,6 +29,8 @@
#++
module Exports::PDF::Components::Cover
+ PRAWN_RGB_HEX_FORMAT = /\A[0-9A-F]{6}\z/
+
def write_cover_page!
write_cover_logo
write_cover_hr
@@ -89,12 +91,14 @@ module Exports::PDF::Components::Cover
hexcode = CustomStyle.current.export_cover_text_color
return nil if hexcode.blank?
- color = Color.new({ hexcode: })
- color.normalize_hexcode
- return nil if color.hexcode.blank?
+ normalized = ::Colors::HexColor::Normalizer.new.call(hexcode)
+ return nil if normalized.blank?
# pdf hex colors are defined without leading hash
- color.hexcode.sub("#", "")
+ color = normalized.tr("#", "")
+ return nil unless PRAWN_RGB_HEX_FORMAT.match?(color)
+
+ color
end
def write_hero_title(top, width)
diff --git a/spec/models/exports/pdf/components/cover_spec.rb b/spec/models/exports/pdf/components/cover_spec.rb
new file mode 100644
index 00000000000..ff10f09e26d
--- /dev/null
+++ b/spec/models/exports/pdf/components/cover_spec.rb
@@ -0,0 +1,64 @@
+# 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 Exports::PDF::Components::Cover do
+ let(:cover) { Class.new { extend Exports::PDF::Components::Cover } }
+
+ describe "#cover_text_color and #validate_cover_text_color" do
+ it "returns nil when no CustomStyle is present" do
+ allow(CustomStyle).to receive(:current).and_return(nil)
+ expect(cover.cover_text_color).to be_nil
+ end
+
+ it "returns nil when the cover text color is blank" do
+ allow(CustomStyle).to receive(:current).and_return(instance_double(CustomStyle, export_cover_text_color: ""))
+ expect(cover.cover_text_color).to be_nil
+ end
+
+ it "returns nil when the cover text color is invalid" do
+ allow(CustomStyle).to receive(:current).and_return(instance_double(CustomStyle, export_cover_text_color: "#abcdefg"))
+ expect(cover.cover_text_color).to be_nil
+ end
+
+ it "returns a hex color without leading # when valid" do
+ cs = instance_double(CustomStyle, export_cover_text_color: "#112233")
+ allow(CustomStyle).to receive(:current).and_return(cs)
+ expect(cover.cover_text_color).to eq "112233"
+ end
+
+ it "returns a normalized hex color without leading # when valid" do
+ cs = instance_double(CustomStyle, export_cover_text_color: "#000")
+ allow(CustomStyle).to receive(:current).and_return(cs)
+ expect(cover.cover_text_color).to eq "000000"
+ end
+ end
+end