openproject/spec/lib/api/contracts/model_contract_spec.rb

#-- encoding: UTF-8

#-- 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-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'

describe ModelContract do
  let(:model) do
    double('The model',
           child_attribute: nil,
           grand_child_attribute: nil,
           overwritten_attribute: nil,
           changed: [],
           valid?: true,
           errors: ActiveModel::Errors.new(nil))
  end
  let(:child_contract) { ChildContract.new(model, nil) }
  let(:grand_child_contract) { GrandChildContract.new(model, nil) }

  before do
    child_contract.child_value = 0
    grand_child_contract.child_value = 0
  end

  describe 'child' do
    class ChildContract < ModelContract
      attr_accessor :child_value

      attribute :child_attribute
      attribute :overwritten_attribute do
        @child_value = 1
      end
    end

    it 'should collect its own writable attributes' do
      expect(child_contract.writable_attributes).to include('child_attribute',
                                                            'overwritten_attribute')
    end

    it 'should collect its own attribute validations' do
      child_contract.validate
      expect(child_contract.child_value).to eq(1)
    end
  end

  describe 'grand_child' do
    class GrandChildContract < ChildContract
      attr_accessor :grand_child_value

      attribute :grand_child_attribute
      attribute :overwritten_attribute do
        @grand_child_value = 2
      end
    end

    it 'should consider its ancestor writable attributes' do
      expect(grand_child_contract.writable_attributes).to include('child_attribute',
                                                                  'overwritten_attribute',
                                                                  'grand_child_attribute')
    end

    it 'should not contain the same attribute twice, but also has the _id variant' do
      expect(grand_child_contract.writable_attributes.count).to eq(6)
    end

    it 'should execute all the validations' do
      grand_child_contract.validate
      expect(grand_child_contract.child_value).to eq(1)
      expect(grand_child_contract.grand_child_value).to eq(2)
    end
  end
end