A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
module JsonApiKitSpec
class MiddleTimelineChange < JsonApiKit::VersionChange
version "2026-11-15"
description "The middle change on the timeline."
end
class LatestTimelineChange < JsonApiKit::VersionChange
version "2027-01-05"
description "The latest change on the timeline."
end
end
RSpec.describe JsonApiKit::Timeline do
let(:first) { described_class::FIRST_RELEASE }
let(:middle) { JsonApiKit::ApiVersion.parse("2026-11-15") }
let(:latest) { JsonApiKit::ApiVersion.parse("2027-01-05") }
let(:changes) do
[
JsonApiKitSpec::MiddleTimelineChange.new(__FILE__),
JsonApiKitSpec::LatestTimelineChange.new(__FILE__),
]
end
let(:version_changes) { JsonApiKit::VersionChanges.new(changes) }
before do
freeze_time(Date.new(2027, 1, 20))
allow(JsonApiKit::VersionChanges).to receive(:core).and_return(version_changes)
end
describe ".first" do
it "returns the first release" do
expect(described_class.first).to eq(first)
end
end
describe ".current" do
it "returns the version of the latest change" do
expect(described_class.current).to eq(latest)
end
context "when there is no change" do
let(:changes) { [] }
it "returns the first release" do
expect(described_class.current).to eq(first)
end
end
end
describe ".resolve" do
subject(:version) { described_class.resolve(raw) }
let(:raw) { middle.to_s }
context "when the date is a published version" do
it "returns that version" do
expect(version).to eq(middle)
end
end
context "when the date falls between two versions" do
let(:raw) { "2026-12-01" }
it "returns the newest version before it" do
expect(version).to eq(middle)
end
end
context "when the date is later than every version but not in the future" do
let(:raw) { "2027-01-10" }
it "returns the latest version" do
expect(version).to eq(latest)
end
end
context "when there is no date" do
let(:raw) { nil }
it { expect { version }.to raise_error(JsonApiKit::ApiVersion::Required) }
end
context "when the date is earlier than the first version" do
let(:raw) { (first.date - 1.day).to_s }
it { expect { version }.to raise_error(JsonApiKit::ApiVersion::Unknown) }
end
context "when the date is in the future" do
let(:raw) { (Time.zone.today + 1.day).to_s }
it { expect { version }.to raise_error(JsonApiKit::ApiVersion::InTheFuture) }
end
context "when the date is invalid" do
let(:raw) { "yesterday" }
it { expect { version }.to raise_error(JsonApiKit::ApiVersion::NotADate) }
end
end
end