openproject/spec/models/journal_manager_spec.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2020 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-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.
#++

require 'spec_helper'

describe JournalManager, type: :model do
  describe '#self.changed?' do
    let(:journable) do
      FactoryBot.create(:work_package, description: old).tap do |journable|
        # replace newline character and apply another change
        journable.assign_attributes description: changed
      end
    end

    context 'when only the newline character representation has changed' do
      let(:old) { "Description\nContains newline character" }
      let(:changed) { old.gsub("\n", "\r\n") }

      subject { JournalManager.changed? journable }

      it { is_expected.to be_falsey }
    end

    context 'when old value is nil and changed value is an empty string' do
      let(:old) { nil }
      let(:changed) { '' }

      subject { JournalManager.changed? journable }

      it { is_expected.to be_falsey }
    end

    context 'when changed value is nil and old value is an empty string' do
      let(:old) { '' }
      let(:changed) { nil }

      subject { JournalManager.changed? journable }

      it { is_expected.to be_falsey }
    end

    context 'when changed value has a value and old value is an empty string' do
      let(:old) { '' }
      let(:changed) { 'Changed text' }

      subject { JournalManager.changed? journable }

      it { is_expected.to be_truthy }
    end

    context 'when changed value has a value and old value is nil' do
      let(:old) { nil }
      let(:changed) { 'Changed text' }

      subject { JournalManager.changed? journable }

      it { is_expected.to be_truthy }
    end

    context 'when changed value is nil and old value was some text' do
      let(:old) { 'Old text' }
      let(:changed) { nil }

      subject { JournalManager.changed? journable }

      it { is_expected.to be_truthy }
    end

    context 'when changed value is an empty string and old value was some text' do
      let(:old) { 'Old text' }
      let(:changed) { '' }

      subject { JournalManager.changed? journable }

      it { is_expected.to be_truthy }
    end
  end

  describe '.update_user_references' do
    let!(:work_package) { FactoryBot.create :work_package }
    let!(:doomed_user) { work_package.author }
    let!(:data1) do
      FactoryBot.build(:journal_work_package_journal,
                       subject: work_package.subject,
                       status_id: work_package.status_id,
                       type_id: work_package.type_id,
                       author_id: doomed_user.id,
                       project_id: work_package.project_id)
    end
    let!(:data2) do
      FactoryBot.build(:journal_work_package_journal,
                       subject: work_package.subject,
                       status_id: work_package.status_id,
                       type_id: work_package.type_id,
                       author_id: doomed_user.id,
                       project_id: work_package.project_id)
    end
    let!(:doomed_user_journal) do
      FactoryBot.create :work_package_journal,
                        notes: '1',
                        user: doomed_user,
                        journable_id: work_package.id,
                        data: data1
    end
    let!(:some_other_journal) do
      FactoryBot.create :work_package_journal,
                        notes: '2',
                        journable_id: work_package.id,
                        data: data2
    end

    before do
      doomed_user.destroy
    end

    it "should mark the user's journal as deleted" do
      expect(doomed_user_journal.reload.user.is_a?(DeletedUser)).to be_truthy
    end

    it "should not mark an unrelated journal's user as deleted" do
      expect(some_other_journal.reload.user.is_a?(DeletedUser)).to be_falsey
    end
  end

  describe '.changes_on_association' do
    context 'with one of the values having a newline' do
      let(:current) { { id: 2, value: 'some value', custom_field_id: 123 }.with_indifferent_access }
      let(:predecessor) { { id: 1, value: "some value\n", custom_field_id: 123 }.with_indifferent_access }

      it 'does not identify a change' do
        changes = JournalManager.changes_on_association([current], [predecessor], 'custom_fields', :custom_field_id, :value)

        expect(changes)
          .to be_empty
      end
    end
  end

  describe '.with_send_notifications' do
    let!(:send_notification_before) { described_class.send_notification }
    let(:proc_called_counter) { OpenStruct.new called: false, send_notifications: !send_notification_before }
    let(:proc) { Proc.new { proc_called_counter.called = true } }

    it 'executes the block' do
      described_class.with_send_notifications !send_notification_before, &proc

      expect(proc_called_counter.called)
        .to be_truthy
    end

    it 'uses the provided send_notifications value within the proc' do
      described_class.with_send_notifications !send_notification_before, &proc

      expect(proc_called_counter.send_notifications)
        .to eql !send_notification_before
    end

    it 'resets the send_notifications to the value before' do
      described_class.with_send_notifications !send_notification_before, &proc

      expect(described_class.send_notification)
        .to eql send_notification_before
    end

    context 'with an exception being raised within the block' do
      it 'raises the exception but always resets the notification value' do
        expect { described_class.with_send_notifications(!send_notification_before) { raise ArgumentError } }
          .to raise_error ArgumentError

        expect(described_class.send_notification)
          .to eql send_notification_before
      end
    end
  end
end