openproject/spec/models/custom_actions/actions/custom_field_spec.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 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 docs/COPYRIGHT.rdoc for more details.
#++
require 'spec_helper'
require_relative '../shared_expectations'

describe CustomActions::Actions::CustomField, type: :model do
  let(:list_custom_field) do
    FactoryBot.build_stubbed(:list_wp_custom_field,
                             custom_options: [FactoryBot.build_stubbed(:custom_option, value: 'A'),
                                              FactoryBot.build_stubbed(:custom_option, value: 'B')])
  end
  let(:list_multi_custom_field) do
    FactoryBot.build_stubbed(:list_wp_custom_field,
                             custom_options: [FactoryBot.build_stubbed(:custom_option, value: 'A'),
                                              FactoryBot.build_stubbed(:custom_option, value: 'B')],
                             multi_value: true)
  end
  let(:version_custom_field) do
    FactoryBot.build_stubbed(:version_wp_custom_field)
  end
  let(:bool_custom_field) do
    FactoryBot.build_stubbed(:bool_wp_custom_field)
  end
  let(:user_custom_field) do
    FactoryBot.build_stubbed(:user_wp_custom_field)
  end
  let(:int_custom_field) do
    FactoryBot.build_stubbed(:int_wp_custom_field)
  end
  let(:float_custom_field) do
    FactoryBot.build_stubbed(:float_wp_custom_field)
  end
  let(:text_custom_field) do
    FactoryBot.build_stubbed(:text_wp_custom_field)
  end
  let(:string_custom_field) do
    FactoryBot.build_stubbed(:string_wp_custom_field)
  end
  let(:date_custom_field) do
    FactoryBot.build_stubbed(:date_wp_custom_field)
  end

  let(:custom_field) do
    list_custom_field
  end
  let(:custom_fields) do
    [list_custom_field,
     version_custom_field,
     bool_custom_field,
     user_custom_field,
     int_custom_field,
     float_custom_field,
     text_custom_field,
     string_custom_field,
     date_custom_field]
  end
  let(:klass) do
    allow(WorkPackageCustomField)
      .to receive(:find_by)
      .with(id: custom_field.id.to_s)
      .and_return(custom_field)

    described_class.for(:"custom_field_#{custom_field.id}")
  end
  let(:instance) do
    klass.new
  end

  describe '.all' do
    before do
      allow(WorkPackageCustomField)
        .to receive(:order)
        .and_return(custom_fields)
    end

    it 'is an array with a list of subclasses for every custom_field' do
      expect(described_class.all.length)
        .to eql custom_fields.length

      expect(described_class.all.map(&:custom_field))
        .to match_array(custom_fields)

      expect(described_class.all.all? { |a| described_class >= a })
        .to be_truthy
    end
  end

  describe '.key' do
    it 'is the custom field accessor' do
      expect(klass.key)
        .to eql(:"custom_field_#{custom_field.id}")
    end
  end

  describe '#key' do
    it 'is the custom field accessor' do
      expect(instance.key)
        .to eql(:"custom_field_#{custom_field.id}")
    end
  end

  describe '#value' do
    it 'can be provided on initialization' do
      i = klass.new(1)

      expect(i.values)
        .to eql [1]
    end

    it 'can be set and read' do
      instance.values = [1]

      expect(instance.values)
        .to eql [1]
    end

    context 'for an list custom field' do
      let(:custom_field) { list_custom_field }

      it_behaves_like 'associated values transformation'
    end

    context 'for an int custom field' do
      let(:custom_field) { int_custom_field }

      it_behaves_like 'int values transformation'
    end

    context 'for a float custom field' do
      let(:custom_field) { float_custom_field }

      it_behaves_like 'float values transformation'
    end

    context 'for a string custom field' do
      let(:custom_field) { string_custom_field }

      it_behaves_like 'string values transformation'
    end

    context 'for a text custom field' do
      let(:custom_field) { text_custom_field }

      it_behaves_like 'text values transformation'
    end

    context 'for a date custom field' do
      let(:custom_field) { date_custom_field }

      it_behaves_like 'date values transformation'
    end
  end

  describe '#human_name' do
    it 'is the name of the custom field' do
      expect(instance.human_name)
        .to eql(custom_field.name)
    end
  end

  describe '#type' do
    context 'for a list custom field' do
      it 'is :associated_property' do
        expect(instance.type)
          .to eql(:associated_property)
      end
    end

    context 'for a list custom field allowing multiple values' do
      let(:custom_field) { list_multi_custom_field }

      it 'is :associated_property' do
        expect(instance.type)
          .to eql(:associated_property)
      end
    end

    context 'for a text custom field' do
      let(:custom_field) { text_custom_field }

      it 'is :text_property' do
        expect(instance.type)
          .to eql(:text_property)
      end
    end

    context 'for a string custom field' do
      let(:custom_field) { string_custom_field }

      it 'is :string_property' do
        expect(instance.type)
          .to eql(:string_property)
      end
    end

    context 'for a version custom field' do
      let(:custom_field) { version_custom_field }

      it 'is :associated_property' do
        expect(instance.type)
          .to eql(:associated_property)
      end
    end

    context 'for a bool custom field' do
      let(:custom_field) { bool_custom_field }

      it 'is :boolean' do
        expect(instance.type)
          .to eql(:boolean)
      end
    end

    context 'for a user custom field' do
      let(:custom_field) { user_custom_field }

      it 'is :associated_property' do
        expect(instance.type)
          .to eql(:associated_property)
      end
    end

    context 'for an int custom field' do
      let(:custom_field) { int_custom_field }

      it 'is :integer_property' do
        expect(instance.type)
          .to eql(:integer_property)
      end
    end

    context 'for a float custom field' do
      let(:custom_field) { float_custom_field }

      it 'is :float_property' do
        expect(instance.type)
          .to eql(:float_property)
      end
    end

    context 'for a date custom field' do
      let(:custom_field) { date_custom_field }

      it 'is :date_property' do
        expect(instance.type)
          .to eql(:date_property)
      end
    end
  end

  describe '#multi_value?' do
    context 'for a non multi value field' do
      it 'is false' do
        expect(instance)
          .not_to be_multi_value
      end
    end

    context 'for a non multi value field' do
      let(:custom_field) { list_multi_custom_field }

      it 'is true' do
        expect(instance)
          .to be_multi_value
      end
    end
  end

  describe '#allowed_values' do
    context 'for a list custom field' do
      let(:expected) do
        custom_field
          .custom_options
          .map { |o| { value: o.id, label: o.value } }
      end

      context 'for a non required field' do
        it 'is the list of options and an empty placeholder' do
          expect(instance.allowed_values)
            .to eql(expected.unshift(value: nil, label: '-'))
        end
      end

      context 'for a required field' do
        before do
          custom_field.is_required = true
        end

        it 'is the list of options' do
          expect(instance.allowed_values)
            .to eql(expected)
        end
      end
    end

    context 'for a version custom field' do
      let(:custom_field) { version_custom_field }
      let(:project) { FactoryBot.build_stubbed(:project) }
      let(:a_version) { FactoryBot.build_stubbed(:version, name: 'aaaaa', project: project) }
      let(:m_version) { FactoryBot.build_stubbed(:version, name: 'mmmmm', project: project) }
      let(:z_version) { FactoryBot.build_stubbed(:version, name: 'zzzzz', project: project) }
      let(:versions) { [z_version, a_version, m_version] }

      before do
        allow(Version)
          .to receive(:systemwide)
          .and_return(versions)
      end
      let(:expected) do
        # the versions will be sorted which by their name (and the project but that is the same for all of them)
        versions
          .sort
          .map { |o| { value: o.id, label: o.name } }
      end

      context 'for a non required field' do
        it 'is the list of options and an empty placeholder' do
          expect(instance.allowed_values)
            .to eql(expected.unshift(value: nil, label: '-'))
        end
      end

      context 'for a required field' do
        before do
          custom_field.is_required = true
        end

        it 'is the list of options' do
          expect(instance.allowed_values)
            .to eql(expected)
        end
      end
    end

    context 'for a user custom field' do
      let(:custom_field) { user_custom_field }
      let(:users) do
        [FactoryBot.build_stubbed(:user),
         FactoryBot.build_stubbed(:user),
         FactoryBot.build_stubbed(:user)]
      end

      before do
        allow(Principal)
          .to receive(:in_visible_project_or_me)
          .with(User.current)
          .and_return(users)
      end
      let(:expected) do
        users
          .map { |u| { value: u.id, label: u.name } }
      end

      context 'for a non required field' do
        it 'is the list of options and an empty placeholder' do
          expect(instance.allowed_values)
            .to eql(expected.unshift(value: nil, label: '-'))
        end
      end

      context 'for a required field' do
        before do
          custom_field.is_required = true
        end

        it 'is the list of options' do
          expect(instance.allowed_values)
            .to eql(expected)
        end
      end
    end

    context 'for a bool custom field' do
      let(:custom_field) { bool_custom_field }

      let(:expected) do
        [
          { label: I18n.t(:general_text_yes), value: OpenProject::Database::DB_VALUE_TRUE },
          { label: I18n.t(:general_text_no), value: OpenProject::Database::DB_VALUE_FALSE }
        ]
      end

      it 'is the list of options' do
        expect(instance.allowed_values)
          .to eql(expected)
      end
    end
  end

  describe '#validate' do
    context 'for a list custom field' do
      it_behaves_like 'associated custom action validations' do
        let(:allowed_values) do
          custom_field
            .custom_options
            .map { |o| { value: o.id, label: o.value } }
        end
      end
    end

    context 'for a multi list custom field' do
      it_behaves_like 'associated custom action validations' do
        let(:allowed_values) do
          custom_field
            .custom_options
            .map { |o| { value: o.id, label: o.value } }
        end
      end
    end

    context 'for a user custom field' do
      let(:custom_field) { user_custom_field }
      let(:users) do
        [FactoryBot.build_stubbed(:user),
         FactoryBot.build_stubbed(:user),
         FactoryBot.build_stubbed(:user)]
      end

      before do
        allow(Principal)
          .to receive(:in_visible_project_or_me)
          .with(User.current)
          .and_return(users)
      end

      it_behaves_like 'associated custom action validations' do
        let(:allowed_values) do
          users
            .map { |u| { value: u.id, label: u.name } }
        end
      end
    end

    context 'for a version custom field' do
      let(:custom_field) { version_custom_field }
      let(:project) { FactoryBot.build_stubbed(:project) }
      let(:versions) do
        [FactoryBot.build_stubbed(:version, project: project),
         FactoryBot.build_stubbed(:version, project: project),
         FactoryBot.build_stubbed(:version, project: project)]
      end

      before do
        allow(Version)
          .to receive(:systemwide)
          .and_return(versions)
      end
      it_behaves_like 'associated custom action validations' do
        let(:allowed_values) do
          versions
            .map { |o| { value: o.id, label: o.name } }
        end
      end
    end

    context 'for a bool custom field' do
      let(:custom_field) { bool_custom_field }

      it_behaves_like 'bool custom action validations' do
        let(:allowed_values) do
          [
            { true: OpenProject::Database::DB_VALUE_TRUE },
            { false: OpenProject::Database::DB_VALUE_FALSE }
          ]
        end
      end
    end

    context 'for an int custom field' do
      let(:custom_field) { int_custom_field }

      it_behaves_like 'int custom action validations'
    end

    context 'for a float custom field' do
      let(:custom_field) { float_custom_field }

      it_behaves_like 'float custom action validations'
    end

    context 'for a string custom field' do
      let(:custom_field) { string_custom_field }

      it_behaves_like 'string custom action validations'
    end

    context 'for a date custom field' do
      let(:custom_field) { date_custom_field }

      it_behaves_like 'date custom action validations'
    end
  end

  describe '#apply' do
    let(:work_package) { double('work_package') }

    %i[list
       version
       bool
       user
       int
       float
       text
       string
       date
       list_multi].each do |type|
      let(:custom_field) { send(:"#{type}_custom_field") }

      it "sets the value for #{type} custom fields" do
        expect(work_package)
          .to receive(:"custom_field_#{custom_field.id}=")
          .with([42])

        instance.values = 42

        instance.apply(work_package)
      end
    end

    context 'for a date custom field' do
      let(:custom_field) { date_custom_field }

      it "sets the value to today for a dynamic value" do
        expect(work_package)
          .to receive(:"custom_field_#{custom_field.id}=")
                .with(Date.today)

        instance.values = '%CURRENT_DATE%'

        instance.apply(work_package)
      end
    end
  end
end