openproject/spec/models/attribute_help_text/work_package_spec.rb

# frozen_string_literal: true

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

RSpec.describe AttributeHelpText::WorkPackage do
  def create_cf_help_text(custom_field)
    # Need to clear the request store after every creation as the available attributes are cached
    RequestStore.clear!
    # need to clear the cache to free the memoized
    # Type.translated_work_package_form_attributes
    Rails.cache.clear
    create(:work_package_help_text, attribute_name: custom_field.attribute_name)
  end

  let(:wp_custom_field) { create(:text_wp_custom_field) }

  let(:cf_instance) do
    create_cf_help_text(wp_custom_field)
  end

  it_behaves_like "acts_as_attachable included" do
    let(:model_instance) { create(:work_package_help_text) }
    let(:project) { create(:project) }
  end

  describe ".available_attributes" do
    subject { described_class.available_attributes }

    it "returns an array of potential attributes" do
      expect(subject).to be_a Hash
    end
  end

  describe ".used_attributes" do
    let!(:instance) { create(:work_package_help_text) }

    subject { described_class.used_attributes instance.type }

    it "returns used attributes" do
      expect(subject).to eq([instance.attribute_name])
    end
  end

  describe ".visible" do
    let(:project) { create(:project) }
    let(:role) { create(:project_role, permissions:) }
    let(:user) do
      create(:user,
             member_with_roles: { project => role })
    end
    let(:permission) { [] }
    let(:static_instance) { create(:work_package_help_text, attribute_name: "project") }

    before do
      cf_instance
      static_instance
    end

    subject { described_class.visible(user) }

    context "user having no permission" do
      let(:user) do
        create(:user)
      end

      it "returns the help text for the static attribute but not the one for the custom field" do
        expect(subject)
          .to contain_exactly(static_instance)
      end
    end

    context "with a user having the `select_custom_fields` permission" do
      let(:permissions) { [:select_custom_fields] }

      it "returns the help text for the static and cf attribute" do
        expect(subject)
          .to contain_exactly(static_instance, cf_instance)
      end
    end

    context "user being member in a project with activated custom fields" do
      let(:permissions) { [] }
      let(:type) do
        type = create(:type)
        project.types << type

        type
      end
      let(:cf_instance_active) do
        custom_field = create(:text_wp_custom_field)
        project.work_package_custom_fields << custom_field
        type.custom_fields << custom_field
        create_cf_help_text(custom_field)
      end
      let(:cf_instance_inactive) do
        cf_instance
      end
      let(:cf_instance_inactive_no_type) do
        custom_field = create(:text_wp_custom_field)
        project.work_package_custom_fields << custom_field
        create_cf_help_text(custom_field)
      end
      let(:cf_instance_inactive_not_in_project) do
        custom_field = create(:text_wp_custom_field)
        type.custom_fields << custom_field
        create_cf_help_text(custom_field)
      end
      let(:cf_instance_for_all) do
        custom_field = create(:text_wp_custom_field, is_for_all: true)
        type.custom_fields << custom_field
        create_cf_help_text(custom_field)
      end

      before do
        cf_instance_active
        cf_instance_inactive
        cf_instance_inactive_no_type
        cf_instance_inactive_not_in_project
        cf_instance_for_all
      end

      it "returns the help text for the static and active cf attributes" do
        expect(subject)
          .to contain_exactly(static_instance, cf_instance_active, cf_instance_for_all)
      end
    end
  end

  describe ".cached" do
    let(:user) { create(:user) }
    let!(:wp_help_text) { create(:work_package_help_text, attribute_name: "status") }
    let!(:project_help_text) { create(:project_help_text, attribute_name: "status") }

    subject { described_class.cached(user) }

    it "returns only WorkPackage help texts, not Project help texts with the same attribute name" do
      expect(subject["status"]).to eq(wp_help_text)
      expect(subject["status"]).not_to eq(project_help_text)
      expect(subject["status"]).to be_a(described_class)
    end

    it "does not include help texts of other types" do
      expect(subject.values).to all(be_a(described_class))
    end
  end

  describe "validations" do
    before do
      allow(described_class).to receive(:available_attributes).and_return(status: "Status")
    end

    let(:attribute_name) { "status" }
    let(:help_text) { "foobar" }

    subject { described_class.new attribute_name:, help_text: }

    context "help_text is nil" do
      let(:help_text) { nil }

      it "validates presence of help text" do
        expect(subject.valid?).to be_falsey
        expect(subject.errors[:help_text].count).to be(1)
        expect(subject.errors[:help_text].first)
          .to eql(I18n.t("activerecord.errors.messages.blank"))
      end
    end

    context "attribute_name is nil" do
      let(:attribute_name) { nil }

      it "validates presence of attribute name" do
        expect(subject.valid?).to be_falsey
        expect(subject.errors[:attribute_name].count).to be(1)
        expect(subject.errors[:attribute_name].first)
          .to eql(I18n.t("activerecord.errors.messages.inclusion"))
      end
    end

    context "attribute_name is invalid" do
      let(:attribute_name) { "foobar" }

      it "validates inclusion of attribute name" do
        expect(subject.valid?).to be_falsey
        expect(subject.errors[:attribute_name].count).to be(1)
        expect(subject.errors[:attribute_name].first)
          .to eql(I18n.t("activerecord.errors.messages.inclusion"))
      end
    end
  end

  describe "normalization" do
    it "normalizes attribute_name" do
      expect(subject).to normalize(:attribute_name).from("category_id").to("category")
      expect(subject).to normalize(:attribute_name).from("status_id").to("status")
      expect(subject).to normalize(:attribute_name).from("author_id").to("author")
    end
  end

  describe "instance" do
    subject { build(:work_package_help_text) }

    it "provides a caption of its type" do
      expect(subject.attribute_scope).to eq "WorkPackage"
      expect(subject.type_caption).to eq I18n.t(:label_work_package)
    end
  end

  describe "destroy" do
    context "when the custom field is destroyed" do
      before do
        cf_instance
        wp_custom_field.destroy
      end

      it "also destroys the instance" do
        expect { cf_instance.reload }.to raise_error(ActiveRecord::RecordNotFound)
      end
    end
  end
end