openproject/spec/lib/custom_field_form_builder_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"
require "ostruct"

RSpec.describe CustomFieldFormBuilder do
  include Capybara::RSpecMatchers

  let(:helper) { ActionView::Base.new(ActionView::LookupContext.new(""), {}, @controller) }
  let(:builder) { described_class.new(:user, resource, helper, builder_options) }
  let(:builder_options) do
    {
      custom_value:,
      custom_field:
    }
  end

  describe "#custom_field" do
    let(:options) { { class: "custom-class" } }

    let(:field_format) { "bool" }
    let(:custom_field) do
      build_stubbed(:custom_field, field_format:)
    end
    let(:custom_value) do
      build_stubbed(:custom_value, customized: resource, custom_field:)
    end
    let(:typed_value) do
      custom_value.typed_value
    end

    let(:resource) do
      build_stubbed(:user)
    end

    let(:scope) { instance_double(ActiveRecord::Relation) }

    before do
      without_partial_double_verification do
        allow(resource)
          .to receive(custom_field.attribute_getter)
                .and_return(typed_value)
      end
    end

    subject(:output) do
      builder.cf_form_field options
    end

    it_behaves_like "labelled by default"
    it_behaves_like "wrapped in field-container by default" do
      let(:container_count) { 2 }
    end

    context "for a bool custom field" do
      it_behaves_like "wrapped in container", "check-box-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(%{
          <input class="custom-class form--check-box"
                 id="user#{custom_field.id}"
                 name="user[#{custom_field.id}]"
                 type="checkbox"
                 value="1" />
        }).at_path("input:nth-of-type(2)")
      end
    end

    context "for a date custom field" do
      let(:field_format) { "date" }

      it_behaves_like "wrapped in container", "field-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(
          <<~HTML
            <opce-basic-single-date-picker
              class="custom-class"
              data-value="null"
              data-id='"user_custom_field_#{custom_field.id}"'
              data-name='"user[#{custom_field.id}]"'
            ></opce-basic-single-date-picker>
          HTML
        ).at_path("opce-basic-single-date-picker")
      end
    end

    context "for a text custom field" do
      let(:field_format) { "text" }

      it_behaves_like "wrapped in container", "text-area-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(%{
          <textarea class="custom-class form--text-area"
                    id="user#{custom_field.id}"
                    name="user[#{custom_field.id}]"
                    with_text_formatting="true"
                    editor_type="constrained"
                    macros="false">
          </textarea>
        }).at_path("textarea")
      end
    end

    context "for a string custom field" do
      let(:field_format) { "string" }

      it_behaves_like "wrapped in container", "text-field-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(%{
          <input class="custom-class form--text-field"
                 id="user#{custom_field.id}"
                 name="user[#{custom_field.id}]"
                 type="text"
                 value="" />
        }).at_path("input")
      end
    end

    context "for an int custom field" do
      let(:field_format) { "int" }

      it_behaves_like "wrapped in container", "text-field-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(%{
          <input class="custom-class form--text-field"
                 id="user#{custom_field.id}"
                 name="user[#{custom_field.id}]"
                 type="text" />
        }).at_path("input")
      end
    end

    context "for a float custom field" do
      let(:field_format) { "float" }

      it_behaves_like "wrapped in container", "text-field-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(%{
          <input class="custom-class form--text-field"
                 id="user#{custom_field.id}"
                 name="user[#{custom_field.id}]"
                 type="text" />
        }).at_path("input")
      end
    end

    context "for a list custom field" do
      let(:custom_field) do
        create(:list_wp_custom_field,
               custom_options: [custom_option])
      end
      let(:custom_option) do
        create(:custom_option, value: "my_option")
      end

      it_behaves_like "wrapped in container", "select-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(%{
          <select class="custom-class form--select"
                  id="user#{custom_field.id}"
                  name="user[#{custom_field.id}]"
                  no_label="true"><option
                  value="" label=" "></option>
                  <option value="#{custom_option.id}">my_option</option></select>
        }).at_path("select")
      end

      context "which is required and has no default value" do
        before do
          custom_field.update(is_required: true)
        end

        it "outputs element" do
          expect(output).to be_html_eql(%{
            <select class="custom-class form--select"
                    id="user#{custom_field.id}"
                    name="user[#{custom_field.id}]"
                    no_label="true"><option value="">---
                    Please select ---</option>
                    <option value="#{custom_option.id}">my_option</option></select>
          }).at_path("select")
        end
      end

      context "which is required and a default value" do
        before do
          custom_field.update(is_required: true)
          custom_option.update(default_value: true)
        end

        it "outputs element" do
          expect(output).to be_html_eql(%{
            <select class="custom-class form--select"
                    id="user#{custom_field.id}"
                    name="user[#{custom_field.id}]"
                    no_label="true"><option
                    value="#{custom_option.id}">my_option</option></select>
          }).at_path("select")
        end
      end
    end

    context "for a user custom field" do
      let(:field_format) { "user" }

      let(:project) { build_stubbed(:project) }
      let(:user1) { build_stubbed(:user) }
      let(:user2) { build_stubbed(:user) }

      let(:resource) { project }

      before do
        without_partial_double_verification do
          allow(project)
            .to receive(custom_field.attribute_getter)
            .and_return typed_value
        end

        allow(project)
          .to receive(:principals)
                .and_return(scope)

        allow(scope)
          .to receive_messages(
            select: [user1, user2],
            includes: scope
          )
      end

      it_behaves_like "wrapped in container", "select-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(%{
          <select class="custom-class form--select"
                  id="user#{custom_field.id}"
                  name="user[#{custom_field.id}]"
                  no_label="true">
            <option value="" label=" "></option>
            <option value="#{user1.id}">#{user1.name}</option>
            <option value="#{user2.id}">#{user2.name}</option>
          </select>
        }).at_path("select")
      end

      context "which is required and has no default value" do
        before do
          custom_field.is_required = true
        end

        it "outputs element" do
          expect(output).to be_html_eql(%{
            <select class="custom-class form--select"
                    id="user#{custom_field.id}"
                    name="user[#{custom_field.id}]"
                    no_label="true">
              <option value="">--- Please select ---</option>
              <option value="#{user1.id}">#{user1.name}</option>
              <option value="#{user2.id}">#{user2.name}</option>
            </select>
          }).at_path("select")
        end
      end
    end

    context "for a version custom field" do
      let(:field_format) { "version" }

      let(:project) { build_stubbed(:project) }
      let(:version1) { build_stubbed(:version) }
      let(:version2) { build_stubbed(:version) }

      let(:resource) { project }

      before do
        without_partial_double_verification do
          allow(project)
            .to receive(custom_field.attribute_getter)
                  .and_return typed_value

          allow(project)
            .to receive(:shared_versions)
                  .and_return(scope)

          allow(scope)
            .to receive(:references)
                  .and_return([version1, version2])
        end
      end

      it_behaves_like "wrapped in container", "select-container" do
        let(:container_count) { 2 }
      end

      it "outputs element" do
        expect(output).to be_html_eql(%{
          <select class="custom-class form--select"
                  id="user#{custom_field.id}"
                  name="user[#{custom_field.id}]"
                  no_label="true">
            <option value="" label=" "></option>
            <optgroup label="#{version1.project.name}">
              <option value="#{version1.id}">#{version1.name}</option>
            </optgroup>
            <optgroup label="#{version2.project.name}">
              <option value="#{version2.id}">#{version2.name}</option>
            </optgroup>
          </select>
        }).at_path("select")
      end

      context "which is required and has no default value" do
        before do
          custom_field.is_required = true
        end

        it "outputs element" do
          expect(output).to be_html_eql(%{
            <select class="custom-class form--select"
                    id="user#{custom_field.id}"
                    name="user[#{custom_field.id}]"
                    no_label="true">
              <option value="">--- Please select ---</option>
              <optgroup label="#{version1.project.name}">
                <option value="#{version1.id}">#{version1.name}</option>
              </optgroup>
              <optgroup label="#{version2.project.name}">
                <option value="#{version2.id}">#{version2.name}</option>
              </optgroup>
            </select>
          }).at_path("select")
        end
      end
    end
  end
end