openproject/spec/lib/api/v3/support/date_time_examples.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 COPYRIGHT and LICENSE files for more details.
#++

require 'spec_helper'

shared_examples_for 'has ISO 8601 date only' do
  it 'exists' do
    is_expected.to have_json_path(json_path)
  end

  it 'indicates date only as ISO 8601' do
    called_with_expected = false
    expect(::API::V3::Utilities::DateTimeFormatter).to receive(:format_date) do |actual, *_|
      called_with_expected = true if actual.eql? date
    end.at_least(:once)

    subject # we need to resolve the subject for calls to occur
    expect(called_with_expected).to be_truthy
  end
end

shared_examples_for 'has UTC ISO 8601 date and time' do
  it 'exists' do
    is_expected.to have_json_path(json_path)
  end

  it 'indicates date and time as ISO 8601' do
    called_with_expected = false
    expect(::API::V3::Utilities::DateTimeFormatter).to receive(:format_datetime) do |actual, *_|
      # ActiveSupport flaws :eql? we circumvent that by calling utc (which is equally valid)
      called_with_expected = true if actual.utc.eql? date.utc
    end.at_least(:once)

    subject # we need to resolve the subject for calls to occur
    expect(called_with_expected).to be_truthy
  end
end