openproject/lib/plugins/acts_as_journalized/test/changes_test.rb

#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2013 the OpenProject Foundation (OPF)
#
# 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 doc/COPYRIGHT.rdoc for more details.
#++

#-- encoding: UTF-8
require File.join(File.dirname(__FILE__), 'test_helper')

class ChangesTest < Test::Unit::TestCase
  context "A journal's changes" do
    setup do
      @user = User.create(:name => 'Steve Richert')
      @user.update_attribute(:last_name, 'Jobs')
      @changes = @user.journals.last.changed_data
    end

    should 'be a hash' do
      assert_kind_of Hash, @changes
    end

    should 'not be empty' do
      assert !@changes.empty?
    end

    should 'have string keys' do
      @changes.keys.each do |key|
        assert_kind_of String, key
      end
    end

    should 'have array values' do
      @changes.values.each do |value|
        assert_kind_of Array, value
      end
    end

    should 'have two-element values' do
      @changes.values.each do |value|
        assert_equal 2, value.size
      end
    end

    should 'have unique-element values' do
      @changes.values.each do |value|
        assert_equal value.uniq, value
      end
    end

    should "equal the model's changes" do
      @user.first_name = 'Stephen'
      model_changes = @user.changed_data
      @user.save
      changes = @user.journals.last.changed_data
      assert_equal model_changes, changes
    end
  end

  context 'A hash of changes' do
    setup do
      @changes = {'first_name' => ['Steve', 'Stephen']}
      @other = {'first_name' => ['Catie', 'Catherine']}
    end

    should 'properly append other changes' do
      expected = {'first_name' => ['Steve', 'Catherine']}
      changes = @changes.append_changes(@other)
      assert_equal expected, changes
      @changes.append_changes!(@other)
      assert_equal expected, @changes
    end

    should 'properly prepend other changes' do
      expected = {'first_name' => ['Catie', 'Stephen']}
      changes = @changes.prepend_changes(@other)
      assert_equal expected, changes
      @changes.prepend_changes!(@other)
      assert_equal expected, @changes
    end

    should 'be reversible' do
      expected = {'first_name' => ['Stephen', 'Steve']}
      changes = @changes.reverse_changes
      assert_equal expected, changes
      @changes.reverse_changes!
      assert_equal expected, @changes
    end
  end

  context 'The changes between two journals' do
    setup do
      name = 'Steve Richert'
      @user = User.create(:name => name)              # 1
      @user.update_attribute(:last_name, 'Jobs')      # 2
      @user.update_attribute(:first_name, 'Stephen')  # 3
      @user.update_attribute(:last_name, 'Richert')   # 4
      @user.update_attribute(:name, name)             # 5
      @version = @user.version
    end

    should 'be a hash' do
      1.upto(@version) do |i|
        1.upto(@version) do |j|
          changes = @user.changes_between(i, j)
          assert_kind_of Hash, changes
        end
      end
    end

    should 'have string keys' do
      1.upto(@version) do |i|
        1.upto(@version) do |j|
          changes = @user.changes_between(i, j)
          changes.keys.each do |key|
            assert_kind_of String, key
          end
        end
      end
    end

    should 'have array values' do
      1.upto(@version) do |i|
        1.upto(@version) do |j|
          changes = @user.changes_between(i, j)
          changes.values.each do |value|
            assert_kind_of Array, value
          end
        end
      end
    end

    should 'have two-element values' do
      1.upto(@version) do |i|
        1.upto(@version) do |j|
          changes = @user.changes_between(i, j)
          changes.values.each do |value|
            assert_equal 2, value.size
          end
        end
      end
    end

    should 'have unique-element values' do
      1.upto(@version) do |i|
        1.upto(@version) do |j|
          changes = @user.changes_between(i, j)
          changes.values.each do |value|
            assert_equal value.uniq, value
          end
        end
      end
    end

    should 'be empty between identical versions' do
      assert @user.changes_between(1, @version).empty?
      assert @user.changes_between(@version, 1).empty?
    end

    should 'be should reverse with direction' do
      1.upto(@version) do |i|
        i.upto(@version) do |j|
          up    = @user.changes_between(i, j)
          down  = @user.changes_between(j, i)
          assert_equal up, down.reverse_changes
        end
      end
    end

    should 'be empty with invalid arguments' do
      1.upto(@version) do |i|
        assert @user.changes_between(i, nil)
        assert @user.changes_between(nil, i)
      end
    end
  end
end