openproject/spec/lib/api/v3/versions/version_representer_rendering_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 API::V3::Versions::VersionRepresenter, "rendering" do
  let(:workspace) { build_stubbed(:project) }
  let(:version) { build_stubbed(:version, project: workspace) }
  let(:permissions) { [:manage_versions] }
  let(:current_user) { build_stubbed(:user) }
  let(:embed_links) { true }
  let(:representer) { described_class.create(version, current_user:, embed_links:) }

  include API::V3::Utilities::PathHelper

  subject(:generated) { representer.to_json }

  before do
    mock_permissions_for(current_user) do |mock|
      mock.allow_in_project *permissions, project: workspace if workspace
    end
  end

  it "fulfills the documented schema" do
    expect(generated).to match_json_schema.from_docs("version_read_model")
  end

  it { is_expected.to include_json("Version".to_json).at_path("_type") }

  describe "links" do
    it { is_expected.to have_json_type(Object).at_path("_links") }

    describe "to self" do
      it_behaves_like "has a titled link" do
        let(:link) { "self" }
        let(:href) { api_v3_paths.version(version.id) }
        let(:title) { version.name }
      end
    end

    describe "to schema" do
      it_behaves_like "has an untitled link" do
        let(:link) { "schema" }
        let(:href) { api_v3_paths.version_schema }
      end
    end

    describe "to update" do
      context "if manage versions permissions are granted" do
        it_behaves_like "has an untitled link" do
          let(:link) { "update" }
          let(:href) { api_v3_paths.version_form(version.id) }
        end
      end

      describe "if manage versions permissions are lacking" do
        let(:permissions) { [] }

        it_behaves_like "has no link" do
          let(:link) { "update" }
        end
      end
    end

    describe "to updateImmediately" do
      context "if manage versions permissions are granted" do
        it_behaves_like "has an untitled link" do
          let(:link) { "updateImmediately" }
          let(:href) { api_v3_paths.version(version.id) }
        end
      end

      describe "if manage versions permissions are lacking" do
        let(:permissions) { [] }

        it_behaves_like "has no link" do
          let(:link) { "updateImmediately" }
        end
      end
    end

    describe "to the defining project" do
      it_behaves_like "has workspace linked" do
        let(:link) { :definingProject }
      end
    end

    describe "to available projects" do
      it_behaves_like "has an untitled link" do
        let(:link) { "availableInProjects" }
        let(:href) { api_v3_paths.workspaces_by_version(version.id) }
      end
    end

    context "custom value" do
      let(:custom_field) { build_stubbed(:version_custom_field, :list) }
      let(:custom_value) do
        build_stubbed(:custom_value, custom_field:, value: "1")
      end

      before do
        allow(version)
          .to receive(:available_custom_fields)
          .and_return([custom_field])

        allow(version)
          .to receive(:custom_value_for)
          .with(custom_field)
          .and_return(custom_value)
      end

      it "has property for the custom field" do
        expect(subject)
          .to be_json_eql(api_v3_paths.custom_option(custom_value.value).to_json)
          .at_path("_links/customField#{custom_field.id}/href")
      end
    end
  end

  describe "properties" do
    it { is_expected.to be_json_eql(version.id.to_json).at_path("id") }
    it { is_expected.to be_json_eql(version.name.to_json).at_path("name") }

    it_behaves_like "API V3 formattable", "description" do
      let(:format) { "plain" }
      let(:raw) { version.description }
    end

    it_behaves_like "has ISO 8601 date only" do
      let(:date) { version.start_date }
      let(:json_path) { "startDate" }
    end

    it_behaves_like "has ISO 8601 date only" do
      let(:date) { version.due_date }
      let(:json_path) { "endDate" }
    end

    it "has a status" do
      expect(subject)
        .to be_json_eql(version.status.to_json)
        .at_path("status")
    end

    it "has a sharing" do
      expect(subject)
        .to be_json_eql(version.sharing.to_json)
        .at_path("sharing")
    end

    it_behaves_like "has UTC ISO 8601 date and time" do
      let(:date) { version.created_at }
      let(:json_path) { "createdAt" }
    end

    it_behaves_like "has UTC ISO 8601 date and time" do
      let(:date) { version.updated_at }
      let(:json_path) { "updatedAt" }
    end

    context "custom value" do
      let(:custom_field) { build_stubbed(:version_custom_field) }
      let(:custom_value) do
        CustomValue.new(custom_field:,
                        value: "1234",
                        customized: version)
      end

      before do
        allow(version)
          .to receive(:available_custom_fields)
          .and_return([custom_field])

        allow(version)
          .to receive(custom_field.attribute_getter)
          .and_return(custom_value.value)
      end

      it "has property for the custom field" do
        expected = {
          format: "markdown",
          html: "<p class=\"op-uc-p\">#{custom_value.value}</p>",
          raw: custom_value.value
        }

        expect(subject)
          .to be_json_eql(expected.to_json)
          .at_path("customField#{custom_field.id}")
      end
    end
  end

  describe "_embedded" do
    describe "definingProject" do
      it_behaves_like "has workspace embedded" do
        let(:embedded_path) { "_embedded/definingProject" }
      end
    end
  end

  describe "caching" do
    it "is based on the representer's cache_key" do
      allow(OpenProject::Cache)
        .to receive(:fetch)
              .and_call_original

      representer.to_json

      expect(OpenProject::Cache)
        .to have_received(:fetch)
              .with(representer.json_cache_key)
    end

    describe "#json_cache_key" do
      let!(:former_cache_key) { representer.json_cache_key }

      it "includes the name of the representer class" do
        expect(representer.json_cache_key)
          .to include("API", "V3", "Versions", "VersionRepresenter")
      end

      it "changes when the locale changes" do
        I18n.with_locale(:fr) do
          expect(representer.json_cache_key)
            .not_to eql former_cache_key
        end
      end

      it "changes when the version is updated" do
        version.updated_at = Time.now + 20.seconds

        expect(representer.json_cache_key)
          .not_to eql former_cache_key
      end

      it "changes when the version's project is updated" do
        version.project.updated_at = Time.now + 20.seconds

        expect(representer.json_cache_key)
          .not_to eql former_cache_key
      end

      context "custom fields" do
        let(:version) do
          build_stubbed(:version).tap do |_v|
            # Use this to force the custom field to be defined before the former_cache_key is calculated
            custom_field
          end
        end
        let(:custom_field) { build_stubbed(:version_custom_field, created_at: Time.now, updated_at: Time.now) }

        before do
          allow(version)
            .to receive(:available_custom_fields)
            .and_return([custom_field])

          allow(version)
            .to receive(custom_field.attribute_getter)
            .and_return("123")
        end

        it "changes when a custom field changes" do
          custom_field.updated_at = Time.now + 20.seconds

          expect(representer.json_cache_key)
            .not_to eql former_cache_key
        end
      end
    end
  end
end