references/openproject
1
0
Fork 0
mirror of https://github.com/opf/openproject.git synced 2026-06-14 03:30:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

extract model changes to module Differ::Model

Browse Source
This commit is contained in:
Ivan Kuchin
2025-01-21 18:38:22 +01:00
parent de66820b59
commit dea41027db
7 changed files with 181 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/models/journable/with_historic_attributes.rb
+1 -1
View File
@@ -236,7 +236,7 @@ class Journable::WithHistoricAttributes < SimpleDelegator
return unless historic_journable
changes = ::Acts::Journalized::JournableDiffer.changes(__getobj__, historic_journable)
changes = ::Acts::Journalized::Differ::Model.changes(__getobj__, historic_journable)
# In the other occurrences of JournableDiffer.association_changes calls, we are using the plural
# of the association name (`custom_fields` in this instance), to map the association fields. That
lib_static/plugins/acts_as_journalized/lib/acts/journalized/differ/model.rb
+68
View File
@@ -0,0 +1,68 @@
# 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.
# ++
module Acts::Journalized::Differ
module Model
class << self
def changes(original, changed)
original_data = original ? normalize_newlines(journaled_attributes(original)) : {}
normalize_newlines(journaled_attributes(changed))
.to_h { |attribute, new_value| [attribute, [original_data[attribute], new_value]] }
.reject { |_, (old_value, new_value)| equal_ignoring_empty_string?(old_value, new_value) }
.with_indifferent_access
end
private
def journaled_attributes(object)
if object.is_a?(Journal::BaseJournal)
object.journaled_attributes.stringify_keys
else
object.attributes.slice(*object.class.journal_class.journaled_attributes.map(&:to_s))
end
end
def normalize_newlines(data)
data.transform_values do |value|
value.is_a?(String) ? value.gsub("\r\n", "\n") : value
end
end
def equal_ignoring_empty_string?(old_value, new_value)
ignoring_empty_string(old_value) == ignoring_empty_string(new_value)
end
def ignoring_empty_string(value)
value unless value == ""
end
end
end
end
lib_static/plugins/acts_as_journalized/lib/acts/journalized/journable_differ.rb
-31
View File
@@ -31,15 +31,6 @@
module Acts::Journalized
class JournableDiffer
class << self
def changes(original, changed)
original_data = original ? normalize_newlines(journaled_attributes(original)) : {}
normalize_newlines(journaled_attributes(changed))
.to_h { |attribute, new_value| [attribute, [original_data[attribute], new_value]] }
.reject { |_, (old_value, new_value)| equal_ignoring_empty_string?(old_value, new_value) }
.with_indifferent_access
end
def association_changes(original, changed, *)
get_association_changes(original, changed, *)
end
@@ -62,28 +53,6 @@ module Acts::Journalized
private
def normalize_newlines(data)
data.transform_values do |value|
value.is_a?(String) ? value.gsub("\r\n", "\n") : value
end
end
def equal_ignoring_empty_string?(old_value, new_value)
ignoring_empty_string(old_value) == ignoring_empty_string(new_value)
end
def ignoring_empty_string(value)
value unless value == ""
end
def journaled_attributes(object)
if object.is_a?(Journal::BaseJournal)
object.journaled_attributes.stringify_keys
else
object.attributes.slice(*object.class.journal_class.journaled_attributes.map(&:to_s))
end
end
def get_association_changes(original, changed, association, association_name, key, value)
original_journals = original&.send(association)&.map(&:attributes) || []
changed_journals = changed.send(association).map(&:attributes)
lib_static/plugins/acts_as_journalized/lib/acts_as_journalized.rb
+1 -1
View File
@@ -52,7 +52,7 @@ require "cause_of_change"
module Acts
end
Dir[File.expand_path("acts/journalized/*.rb", __dir__)].sort.each { |f| require f }
Dir[File.expand_path("acts/journalized/{,*/}*.rb", __dir__)].each { |f| require f }
module Acts
module Journalized
lib_static/plugins/acts_as_journalized/lib/journal_changes.rb
+1 -1
View File
@@ -50,7 +50,7 @@ module JournalChanges
end
def get_data_changes
::Acts::Journalized::JournableDiffer.changes(predecessor&.data, data)
::Acts::Journalized::Differ::Model.changes(predecessor&.data, data)
end
def get_attachments_changes
spec/lib/acts/journalized/differ/model_spec.rb
+110
View File
@@ -0,0 +1,110 @@
# 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 Acts::Journalized::Differ::Model do
describe ".changes" do
context "when the objects are work packages" do
let(:original) do
build_stubbed(:work_package,
subject: "The original work package title",
description: "The description\n",
assigned_to_id: nil,
schedule_manually: false,
ignore_non_working_days: true,
estimated_hours: 1)
end
let(:changed) do
build_stubbed(:work_package,
subject: "The changed work package title",
description: "The description\r\n",
priority: original.priority,
type: original.type,
project: original.project,
schedule_manually: nil,
ignore_non_working_days: false,
estimated_hours: nil)
end
it "returns the changes" do
expect(described_class.changes(original, changed))
.to eq(
"subject" => [original.subject, changed.subject],
"author_id" => [original.author_id, changed.author_id],
"status_id" => [original.status_id, changed.status_id],
"schedule_manually" => [false, nil],
"ignore_non_working_days" => [true, false],
"estimated_hours" => [1.0, nil]
)
end
end
context "when the objects are WorkPackageJournal" do
let(:original) do
build_stubbed(:journal_work_package_journal,
subject: "The original work package title",
description: nil,
priority_id: 5,
type_id: 89,
project_id: 12,
status_id: 45,
schedule_manually: nil,
ignore_non_working_days: false,
estimated_hours: nil)
end
let(:changed) do
build_stubbed(:journal_work_package_journal,
subject: "The changed work package title",
description: "",
priority_id: original.priority_id,
type_id: original.type_id,
project_id: original.project_id,
status_id: original.status_id + 12,
schedule_manually: false,
ignore_non_working_days: true,
estimated_hours: 1)
end
it "returns the changes" do
# The description field changes from nil to '', but we want filter those transitions out,
# hence the expected hash does not contain the description related change.
expect(described_class.changes(original, changed))
.to eq(
"subject" => [original.subject, changed.subject],
"status_id" => [original.status_id, changed.status_id],
"schedule_manually" => [nil, false],
"ignore_non_working_days" => [false, true],
"estimated_hours" => [nil, 1.0]
)
end
end
end
end
spec/lib/acts_as_journalized/journable_differ_spec.rb
-77
View File
@@ -31,83 +31,6 @@
require "spec_helper"
RSpec.describe Acts::Journalized::JournableDiffer do
describe ".changes" do
context "when the objects are work packages" do
let(:original) do
build_stubbed(:work_package,
subject: "The original work package title",
description: "The description\n",
assigned_to_id: nil,
schedule_manually: false,
ignore_non_working_days: true,
estimated_hours: 1)
end
let(:changed) do
build_stubbed(:work_package,
subject: "The changed work package title",
description: "The description\r\n",
priority: original.priority,
type: original.type,
project: original.project,
schedule_manually: nil,
ignore_non_working_days: false,
estimated_hours: nil)
end
it "returns the changes" do
expect(described_class.changes(original, changed))
.to eq(
"subject" => [original.subject, changed.subject],
"author_id" => [original.author_id, changed.author_id],
"status_id" => [original.status_id, changed.status_id],
"schedule_manually" => [false, nil],
"ignore_non_working_days" => [true, false],
"estimated_hours" => [1.0, nil]
)
end
end
context "when the objects are WorkPackageJournal" do
let(:original) do
build_stubbed(:journal_work_package_journal,
subject: "The original work package title",
description: nil,
priority_id: 5,
type_id: 89,
project_id: 12,
status_id: 45,
schedule_manually: nil,
ignore_non_working_days: false,
estimated_hours: nil)
end
let(:changed) do
build_stubbed(:journal_work_package_journal,
subject: "The changed work package title",
description: "",
priority_id: original.priority_id,
type_id: original.type_id,
project_id: original.project_id,
status_id: original.status_id + 12,
schedule_manually: false,
ignore_non_working_days: true,
estimated_hours: 1)
end
it "returns the changes" do
# The description field changes from nil to '', but we want filter those transitions out,
# hence the expected hash does not contain the description related change.
expect(described_class.changes(original, changed))
.to eq(
"subject" => [original.subject, changed.subject],
"status_id" => [original.status_id, changed.status_id],
"schedule_manually" => [nil, false],
"ignore_non_working_days" => [false, true],
"estimated_hours" => [nil, 1.0]
)
end
end
end
describe ".association_changes" do
context "when the objects are work packages" do
let(:original) do