openproject/spec/models/work_package_planning_spec.rb

#-- copyright
# OpenProject is a project management system.
#
# Copyright (C) 2012-2013 the OpenProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# See doc/COPYRIGHT.rdoc for more details.
#++

require File.expand_path('../../spec_helper', __FILE__)

describe WorkPackage do
  let(:project) { FactoryGirl.create(:project_with_types) }
  let(:user)    { FactoryGirl.create(:user) }

  before do
    FactoryGirl.create :priority, is_default: true
    FactoryGirl.create :default_issue_status
  end

  describe '- Relations ' do
    describe '#project' do
      it 'can read the project w/ the help of the belongs_to association' do
        project          = FactoryGirl.create(:project)
        planning_element = FactoryGirl.create(:work_package,
                                              :project_id => project.id)

        planning_element.reload

        planning_element.project.should == project
      end

      it 'can read the responsible w/ the help of the belongs_to association' do
        user             = FactoryGirl.create(:user)
        planning_element = FactoryGirl.create(:work_package,
                                              :responsible_id => user.id)

        planning_element.reload

        planning_element.responsible.should == user
      end

      it 'can read the type w/ the help of the belongs_to association' do
        type             = project.types.first
        planning_element = FactoryGirl.create(:work_package,
                                                   :type_id => type.id,
                                                   :project => project)

        planning_element.reload

        planning_element.type.should == type
      end

      it 'can read the planning_element_status w/ the help of the belongs_to association' do
        status = FactoryGirl.create(:issue_status)
        work_package = FactoryGirl.create(:work_package,
                                          :status_id => status.id)

        work_package.reload

        work_package.status.should == status
      end
    end
  end

  describe '- Validations ' do
    let(:attributes) {
      {:subject    => 'workpackage No. 1',
       :start_date => Date.today,
       :due_date   => Date.today + 2.weeks,
       :project_id => project.id,
       :type       => project.types.first,
       :author     => user
      }
    }

    it { WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }.should be_valid }

    describe 'subject' do
      it 'is invalid w/o a subject' do
        attributes[:subject] = nil
        planning_element = WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }

        planning_element.should_not be_valid

        planning_element.errors[:subject].should be_present
        planning_element.errors[:subject].should == ["can't be blank"]
      end

      it 'is invalid w/ a subject longer than 255 characters' do
        attributes[:subject] = "A" * 500
        planning_element = WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }

        planning_element.should_not be_valid

        planning_element.errors[:subject].should be_present
        planning_element.errors[:subject].should == ["is too long (maximum is 255 characters)"]
      end
    end

    describe 'start_date' do
      it 'is valid w/o a start_date' do
        attributes[:start_date] = nil
        planning_element = WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }

        planning_element.should be_valid

        planning_element.errors[:start_date].should_not be_present
      end
    end

    describe 'due_date' do
      it 'is valid w/o a due_date' do
        attributes[:due_date] = nil
        planning_element = WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }

        planning_element.should be_valid

        planning_element.errors[:due_date].should_not be_present
      end

      it 'is invalid if start_date is after due_date' do
        attributes[:start_date] = Date.today
        attributes[:due_date]   = Date.today - 1.week
        planning_element = WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }

        planning_element.should_not be_valid

        planning_element.errors[:due_date].should be_present
        planning_element.errors[:due_date].should == ["must be greater than start date"]
      end

      it 'is invalid if planning_element is milestone and due_date is not on start_date' do
        attributes[:type] = FactoryGirl.build(:type, :is_milestone => true)
        attributes[:start_date]            = Date.today
        attributes[:due_date]              = Date.today + 1.week
        planning_element = WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }

        planning_element.should_not be_valid

        planning_element.errors[:due_date].should be_present
        planning_element.errors[:due_date].should == ["is not on start date, although this is required for milestones"]
      end
    end

    describe 'project' do
      it 'is invalid w/o a project' do
        attributes[:project_id] = nil
        planning_element = WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }

        planning_element.should_not be_valid

        planning_element.errors[:project].should be_present
        planning_element.errors[:project].should == ["can't be blank"]
      end
    end

    describe 'parent' do
      let (:de_message){ "darf kein Meilenstein sein"}
      let (:en_message){ "cannot be a milestone"}
      after(:each) do
        #proper reset of the locale after the test
        I18n.locale = "en"
      end

      it 'is invalid if parent is_milestone' do
        ["en","de"].each do |locale|
          I18n.with_locale(locale) do
            parent = WorkPackage.new.tap do |pe|
              pe.send(:assign_attributes, attributes.merge(:type => FactoryGirl.build(:type, :is_milestone => true)), :without_protection => true)
            end

            attributes[:parent] = parent
            planning_element = WorkPackage.new.tap { |pe| pe.send(:assign_attributes, attributes, :without_protection => true) }

            planning_element.should_not be_valid

            planning_element.errors[:parent].should be_present
            planning_element.errors[:parent].should == [self.send("#{I18n.locale}_message")]
          end

        end


      end
    end
  end

  describe 'derived attributes' do
    before do
      @pe1  = FactoryGirl.create(:work_package, :project_id => project.id)
      @pe11 = FactoryGirl.create(:work_package, :project_id => project.id, :parent_id => @pe1.id)
      @pe12 = FactoryGirl.create(:work_package, :project_id => project.id, :parent_id => @pe1.id)
    end

    describe 'start_date' do
      it 'equals the minimum start date of all children' do
        @pe11.reload
        @pe11.update_attributes(:start_date => Date.new(2000, 01, 20), :due_date => Date.new(2001, 01, 20))
        @pe12.reload
        @pe12.update_attributes(:start_date => Date.new(2000, 03, 20), :due_date => Date.new(2001, 03, 20))

        @pe1.reload
        @pe1.start_date.should == @pe11.start_date
      end
    end

    describe 'due_date' do
      it 'equals the maximum end date of all children' do
        @pe11.reload
        @pe11.update_attributes(:start_date => Date.new(2000, 01, 20), :due_date => Date.new(2001, 01, 20))
        @pe12.reload
        @pe12.update_attributes(:start_date => Date.new(2000, 03, 20), :due_date => Date.new(2001, 03, 20))

        @pe1.reload
        @pe1.due_date.should == @pe12.due_date
      end
    end
  end

  describe 'journal' do
    let(:responsible) { FactoryGirl.create(:user) }
    let(:type)        { project.types.first } # The type-validation, that now lives on work-package is more
                                              # strict than the previous validation on the planning-element
                                              # it also checks, that the type is available for the project the pe lives in.
    let(:pe_status)   { FactoryGirl.create(:issue_status) }

    let(:pe) { FactoryGirl.create(:work_package,
                                  :subject                         => "Plan A",
                                  :author                          => responsible,
                                  :description                     => "This won't work out",
                                  :start_date                      => Date.new(2012, 1, 24),
                                  :due_date                        => Date.new(2012, 1, 31),
                                  :project_id                      => project.id,
                                  :responsible_id                  => responsible.id,
                                  :type_id                         => type.id,
                                  :status_id                       => pe_status.id
                                  ) }

    it "has an initial journal, so that it's creation shows up in activity" do
      pe.journals.size.should == 1

      changes = pe.journals.first.changed_data.to_hash

      changes.size.should == 11

      changes.should include(:subject)
      changes.should include(:author_id)
      changes.should include(:description)
      changes.should include(:start_date)
      changes.should include(:due_date)
      changes.should include(:done_ratio)
      changes.should include(:status_id)
      changes.should include(:priority_id)
      changes.should include(:project_id)
      changes.should include(:responsible_id)
      changes.should include(:type_id)
    end

    it 'stores updates in journals' do
      pe.reload
      pe.update_attribute(:due_date, Date.new(2012, 2, 1))

      pe.journals.size.should == 2
      changes = pe.journals.last.changed_data.to_hash

      changes.size.should == 1

      changes.should include(:due_date)

      changes[:due_date].first.should == Date.new(2012, 1, 31)
      changes[:due_date].last.should  == Date.new(2012, 2, 1)
    end

    describe 'workpackage hierarchies' do
      let(:child_pe) { FactoryGirl.create(:work_package,
                                          :parent_id         => pe.id,
                                          :subject           => "Plan B",
                                          :description       => "This will work out",
                                          # interval is the same as parent, so that
                                          # dates are not updated
                                          :start_date        => Date.new(2012, 1, 24),
                                          :due_date          => Date.new(2012, 1, 31),
                                          :project_id        => project.id,
                                          :responsible_id    => responsible.id
                                         ) }

      it 'creates a journal in the parent when end date is changed indirectly' do
        child_pe # trigger creation of child and parent

        # sanity check
        child_pe.journals.size.should == 1
        pe.journals.size.should == 2

        # update child
        child_pe.reload
        child_pe.update_attribute(:start_date, Date.new(2012, 1, 1))

        # reload parent to avoid stale journal caches
        pe.reload

        pe.journals.size.should == 3
        changes = pe.journals.last.changed_data.to_hash

        changes.size.should == 1
        changes.should include(:start_date)
      end

    end
  end

  describe 'acts as paranoid trash' do
    before(:each) do
      @pe1 = FactoryGirl.create(:work_package,
                            :project_id => project.id,
                            :start_date => Date.new(2011, 1, 1),
                            :due_date   => Date.new(2011, 2, 1),
                            :subject    => "Numero Uno")
    end

    it 'should delete the object permanantly when using destroy' do
      @pe1.destroy

      WorkPackage.without_deleted.find_by_id(@pe1.id).should be_nil
      WorkPackage.find_by_id(@pe1.id).should be_nil
    end

    it 'destroys all child elements' do
      pe1   = FactoryGirl.create(:work_package, :project_id => project.id)
      pe11  = FactoryGirl.create(:work_package, :project_id => project.id, :parent_id => pe1.id)
      pe12  = FactoryGirl.create(:work_package, :project_id => project.id, :parent_id => pe1.id)
      pe121 = FactoryGirl.create(:work_package, :project_id => project.id, :parent_id => pe12.id)
      pe2   = FactoryGirl.create(:work_package, :project_id => project.id)

      pe1.destroy

      [pe1, pe11, pe12, pe121].each do |pe|
        WorkPackage.without_deleted.find_by_id(pe.id).should be_nil
        WorkPackage.find_by_id(pe.id).should be_nil
      end

      WorkPackage.without_deleted.find_by_id(pe2.id).should == pe2
    end
  end
end