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

Use normalization API to normalize #hexcode

Alexander Brandon Coles2443ee863e33
diff --git a/app/models/color.rb b/app/models/color.rb
index 6b683abc684..ff4dd8ae343 100644
--- a/app/models/color.rb
+++ b/app/models/color.rb
@@ -37,11 +37,10 @@ class Color < ApplicationRecord
class_name: "Type",
dependent: :nullify
- after_initialize :normalize_hexcode
- before_validation :normalize_hexcode
-
validates :name, :hexcode, presence: true
validates :name, length: { maximum: 255, unless: lambda { |e| e.name.blank? } }
validates :hexcode, format: { with: /\A#[0-9A-F]{6}\z/, unless: lambda { |e| e.hexcode.blank? } }
+
+ normalizes :hexcode, with: ::Colors::HexColor::Normalizer
end
diff --git a/app/models/colors/hex_color.rb b/app/models/colors/hex_color.rb
index 49f1073888a..f06dd82f179 100644
--- a/app/models/colors/hex_color.rb
+++ b/app/models/colors/hex_color.rb
@@ -113,20 +113,22 @@ module Colors
"#%<r>02x%<g>02x%<b>02x" % { r:, g:, b: }
end
- # rubocop:disable Metrics/AbcSize
- def normalize_hexcode
- return unless hexcode.present? && hexcode_changed?
-
- self.hexcode = hexcode.strip.upcase
-
- unless hexcode.starts_with? "#"
- self.hexcode = "##{hexcode}"
+ class Normalizer
+ def self.call(...)
+ new.call(...)
end
- if hexcode.size == 4 # =~ /#.../
- self.hexcode = hexcode.gsub(/([^#])/, '\1\1')
+ def call(hex)
+ hex = hex.strip.delete_prefix("#")
+ case hex
+ when /\A[0-9a-fA-F]{3}\z/ # short form: #abc
+ "##{hex.chars.map { |c| c * 2 }.join.upcase}"
+ when /\A[0-9a-fA-F]{6}\z/ # long form: #aabbcc
+ "##{hex.upcase}"
+ else # do nothing
+ hex
+ end
end
end
- # rubocop:enable Metrics/AbcSize
end
end
diff --git a/app/models/design_color.rb b/app/models/design_color.rb
index 5287913b5a3..aa1ca32d377 100644
--- a/app/models/design_color.rb
+++ b/app/models/design_color.rb
@@ -31,7 +31,6 @@
class DesignColor < ApplicationRecord
include ::Colors::HexColor
- before_validation :normalize_hexcode
after_commit -> do
# CustomStyle.current.updated_at determines the cache key for inline_css
# in which the CSS color variables will be overwritten. That is why we need
@@ -48,6 +47,8 @@ class DesignColor < ApplicationRecord
validates :hexcode, :variable, presence: true
validates :hexcode, format: { with: /\A#[0-9A-F]{6}\z/, unless: lambda { |e| e.hexcode.blank? } }
+ normalizes :hexcode, with: ::Colors::HexColor::Normalizer
+
class << self
def setables
overwritten_values = overwritten
diff --git a/spec/models/color_spec.rb b/spec/models/color_spec.rb
index d166c3161a4..e8e0f2d9dd2 100644
--- a/spec/models/color_spec.rb
+++ b/spec/models/color_spec.rb
@@ -58,6 +58,28 @@ RSpec.describe Color do
end
end
+ describe "normalization" do
+ it "does not normalize non-hexcodes, except to strip whitespace", :aggregate_failures do
+ expect(subject).to normalize(:hexcode).from("").to("")
+ expect(subject).to normalize(:hexcode).from(" ").to("")
+ expect(subject).to normalize(:hexcode).from("11").to("11")
+ expect(subject).to normalize(:hexcode).from("purple").to("purple")
+ expect(subject).to normalize(:hexcode).from("green ").to("green")
+ end
+
+ it "normalizes short hexcodes", :aggregate_failures do
+ expect(subject).to normalize(:hexcode).from(" fc3").to("#FFCC33")
+ expect(subject).to normalize(:hexcode).from("333 ").to("#333333")
+ expect(subject).to normalize(:hexcode).from("#fc3").to("#FFCC33")
+ end
+
+ it "normalizes full hexcodes", :aggregate_failures do
+ expect(subject).to normalize(:hexcode).from(" FFCC33").to("#FFCC33")
+ expect(subject).to normalize(:hexcode).from("#ffcc33 ").to("#FFCC33")
+ expect(subject).to normalize(:hexcode).from("#00CED1").to("#00CED1")
+ end
+ end
+
describe "- Validations" do
let(:attributes) do
{ name: "Color No. 1",
@@ -103,24 +125,6 @@ RSpec.describe Color do
expect(described_class.new(attributes.merge(hexcode: "white"))).not_to be_valid
end
- it "fixes some wrong formats of hexcode automatically" do
- color = described_class.new(attributes.merge(hexcode: "FFCC33"))
- expect(color).to be_valid
- expect(color.hexcode).to eq("#FFCC33")
-
- color = described_class.new(attributes.merge(hexcode: "#ffcc33"))
- expect(color).to be_valid
- expect(color.hexcode).to eq("#FFCC33")
-
- color = described_class.new(attributes.merge(hexcode: "fc3"))
- expect(color).to be_valid
- expect(color.hexcode).to eq("#FFCC33")
-
- color = described_class.new(attributes.merge(hexcode: "#fc3"))
- expect(color).to be_valid
- expect(color.hexcode).to eq("#FFCC33")
- end
-
it "is valid w/ proper hexcodes" do
expect(described_class.new(attributes.merge(hexcode: "#FFFFFF"))).to be_valid
expect(described_class.new(attributes.merge(hexcode: "#FF00FF"))).to be_valid
diff --git a/spec/models/design_color_spec.rb b/spec/models/design_color_spec.rb
index 6032cbfe6f3..4ca32ca2859 100644
--- a/spec/models/design_color_spec.rb
+++ b/spec/models/design_color_spec.rb
@@ -6,6 +6,28 @@ RSpec.describe DesignColor do
let(:default_primary) { OpenProject::CustomStyles::Design.variables["primary-button-color"] }
let(:primary_color) { create(:"design_color_primary-button-color") }
+ describe "normalization" do
+ it "does not normalize non-hexcodes, except to strip whitespace", :aggregate_failures do
+ expect(subject).to normalize(:hexcode).from("").to("")
+ expect(subject).to normalize(:hexcode).from(" ").to("")
+ expect(subject).to normalize(:hexcode).from("11").to("11")
+ expect(subject).to normalize(:hexcode).from("purple").to("purple")
+ expect(subject).to normalize(:hexcode).from("green ").to("green")
+ end
+
+ it "normalizes short hexcodes", :aggregate_failures do
+ expect(subject).to normalize(:hexcode).from(" ccc").to("#CCCCCC")
+ expect(subject).to normalize(:hexcode).from("333 ").to("#333333")
+ expect(subject).to normalize(:hexcode).from("#ddd").to("#DDDDDD")
+ end
+
+ it "normalizes full hexcodes", :aggregate_failures do
+ expect(subject).to normalize(:hexcode).from(" 800080").to("#800080")
+ expect(subject).to normalize(:hexcode).from("228b22 ").to("#228B22")
+ expect(subject).to normalize(:hexcode).from("#00CED1").to("#00CED1")
+ end
+ end
+
describe "#setables" do
it "returns an Array of instances" do
expect(described_class.setables).to be_a(Array)