Files

264 lines
12 KiB
PHP

<?php
declare(strict_types=1);
/**
* This file is part of the Carbon package.
*
* (c) Brian Nesbitt <brian@nesbot.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Tests\Carbon;
use Carbon\Carbon;
use Carbon\CarbonInterval;
use DateInterval;
use InvalidArgumentException;
use Tests\AbstractTestCase;
class RoundTest extends AbstractTestCase
{
public function testRoundWithDefaultUnit()
{
$dt = Carbon::create(2315, 7, 18, 22, 42, 17.643971);
$copy = $dt->copy();
$ref = $copy->round();
$this->assertSame($ref, $copy);
$this->assertCarbon($ref, 2315, 7, 18, 22, 42, 18, 0);
$this->assertCarbon($dt->copy()->round(5), 2315, 7, 18, 22, 42, 20, 0);
$this->assertCarbon($dt->copy()->floor()->round(5), 2315, 7, 18, 22, 42, 15, 0);
$this->assertCarbon($dt->copy()->round(3), 2315, 7, 18, 22, 42, 18, 0);
$this->assertCarbon($dt->copy()->round(4), 2315, 7, 18, 22, 42, 16, 0);
$this->assertCarbon($dt->copy()->round(10), 2315, 7, 18, 22, 42, 20, 0);
$this->assertCarbon($dt->copy()->round(0.5), 2315, 7, 18, 22, 42, 17, 500000);
$this->assertCarbon($dt->copy()->round(0.25), 2315, 7, 18, 22, 42, 17, 750000);
$this->assertCarbon($dt->copy()->round(3.8), 2315, 7, 18, 22, 42, 19, 800000);
$this->assertCarbon($dt->copy()->floor(5), 2315, 7, 18, 22, 42, 15, 0);
$this->assertCarbon($dt->copy()->floor()->floor(5), 2315, 7, 18, 22, 42, 15, 0);
$this->assertCarbon($dt->copy()->floor(3), 2315, 7, 18, 22, 42, 15, 0);
$this->assertCarbon($dt->copy()->floor(4), 2315, 7, 18, 22, 42, 16, 0);
$this->assertCarbon($dt->copy()->floor(10), 2315, 7, 18, 22, 42, 10, 0);
$this->assertCarbon($dt->copy()->floor(0.5), 2315, 7, 18, 22, 42, 17, 500000);
$this->assertCarbon($dt->copy()->floor(0.25), 2315, 7, 18, 22, 42, 17, 500000);
$this->assertCarbon($dt->copy()->floor(3.8), 2315, 7, 18, 22, 42, 15, 0);
$this->assertCarbon($dt->copy()->ceil(5), 2315, 7, 18, 22, 42, 20, 0);
$this->assertCarbon($dt->copy()->floor()->ceil(5), 2315, 7, 18, 22, 42, 20, 0);
$this->assertCarbon($dt->copy()->ceil(3), 2315, 7, 18, 22, 42, 18, 0);
$this->assertCarbon($dt->copy()->ceil(4), 2315, 7, 18, 22, 42, 20, 0);
$this->assertCarbon($dt->copy()->ceil(10), 2315, 7, 18, 22, 42, 20, 0);
$this->assertCarbon($dt->copy()->ceil(0.5), 2315, 7, 18, 22, 42, 18, 0);
$this->assertCarbon($dt->copy()->ceil(0.25), 2315, 7, 18, 22, 42, 17, 750000);
$this->assertCarbon($dt->copy()->ceil(3.8), 2315, 7, 18, 22, 42, 19, 800000);
}
public function testRoundWithStrings()
{
$dt = Carbon::create(2315, 7, 18, 22, 42, 17.643971);
$this->assertCarbon($dt->copy()->round('minute'), 2315, 7, 18, 22, 42, 0, 0);
$this->assertCarbon($dt->copy()->floor('5 minutes'), 2315, 7, 18, 22, 40, 0, 0);
$this->assertCarbon($dt->copy()->ceil('5 minutes'), 2315, 7, 18, 22, 45, 0, 0);
}
public function testRoundWithStringsException()
{
$this->expectExceptionObject(new InvalidArgumentException(
'Rounding is only possible with single unit intervals.',
));
Carbon::create(2315, 7, 18, 22, 42, 17.643971)->round('2 hours 5 minutes');
}
public function testRoundWithInterval()
{
$dt = Carbon::create(2315, 7, 18, 22, 42, 17.643971);
$this->assertCarbon($dt->copy()->round(CarbonInterval::minute()), 2315, 7, 18, 22, 42, 0, 0);
$this->assertCarbon($dt->copy()->floor(CarbonInterval::minutes(5)), 2315, 7, 18, 22, 40, 0, 0);
$this->assertCarbon($dt->copy()->ceil(new DateInterval('PT5M')), 2315, 7, 18, 22, 45, 0, 0);
}
public function testRoundWithIntervalException()
{
$this->expectExceptionObject(new InvalidArgumentException(
'Rounding is only possible with single unit intervals.',
));
Carbon::create(2315, 7, 18, 22, 42, 17.643971)->round(CarbonInterval::day()->minutes(5));
}
public function testRoundWithBaseUnit()
{
$dt = Carbon::create(2315, 7, 18, 22, 42, 17.643971);
$copy = $dt->copy();
$ref = $copy->roundSecond();
$this->assertSame($ref, $copy);
$this->assertCarbon($ref, 2315, 7, 18, 22, 42, 18, 0);
$this->assertCarbon($dt->copy()->roundDay(), 2315, 7, 19, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->roundDay(5), 2315, 7, 21, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->ceilDay(), 2315, 7, 19, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->floorDay(), 2315, 7, 18, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->roundYear(), 2316, 1, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->subMonths(2)->roundYear(), 2315, 1, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->roundYear(2), 2315, 1, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->floorYear(2), 2315, 1, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->ceilYear(2), 2317, 1, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->roundMonth(), 2315, 8, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->floorMonth(), 2315, 7, 1, 0, 0, 0, 0);
for ($i = 1; $i <= Carbon::MONTHS_PER_YEAR; $i++) {
$dt = Carbon::parse("2021-$i-01")->endOfMonth()->floorMonth();
$this->assertCarbon($dt, 2021, $i, 1, 0, 0, 0, 0);
}
}
public function testFloorYear()
{
$date = Carbon::create(2022)->endOfYear()->floorYear();
$this->assertCarbon($date, 2022, 1, 1, 0, 0, 0, 0);
$date = Carbon::create(2022)->endOfYear()->floorDay()->floorYear();
$this->assertCarbon($date, 2022, 1, 1, 0, 0, 0, 0);
$date = Carbon::create(2022)->endOfYear()->floorYear();
$this->assertCarbon($date, 2022, 1, 1, 0, 0, 0, 0);
$date = Carbon::create(2022)->addMonths(6)->floorYear();
$this->assertCarbon($date, 2022, 1, 1, 0, 0, 0, 0);
}
public function testCeilYear()
{
$date = Carbon::create(2022)->addMonths(6)->ceilYear();
$this->assertCarbon($date, 2023, 1, 1, 0, 0, 0, 0);
$date = Carbon::create(2022)->endOfYear()->ceilYear();
$this->assertCarbon($date, 2023, 1, 1, 0, 0, 0, 0);
$date = Carbon::create(2022)->ceilYear();
$this->assertCarbon($date, 2022, 1, 1, 0, 0, 0, 0);
$date = Carbon::create(2022)->addMicrosecond()->ceilYear();
$this->assertCarbon($date, 2023, 1, 1, 0, 0, 0, 0);
}
public function testRoundWithMetaUnit()
{
$dt = Carbon::create(2315, 7, 18, 22, 42, 17.643971);
$copy = $dt->copy();
$ref = $copy->roundSecond();
$this->assertSame($ref, $copy);
$this->assertCarbon($ref, 2315, 7, 18, 22, 42, 18, 0);
$this->assertCarbon($dt->copy()->roundMillisecond(), 2315, 7, 18, 22, 42, 17, 644000);
$this->assertCarbon($dt->copy()->roundMillennium(), 2001, 1, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->roundQuarter(), 2315, 7, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->roundQuarters(2), 2315, 7, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->subMonth()->floorQuarter(), 2315, 4, 1, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->subMonth()->floorQuarters(2), 2315, 1, 1, 0, 0, 0, 0);
}
public function testRoundWeek()
{
$dt = Carbon::create(2315, 7, 18, 22, 42, 17.643971);
$copy = $dt->copy();
$ref = $copy->roundSecond();
$this->assertSame($ref, $copy);
$this->assertCarbon($ref, 2315, 7, 18, 22, 42, 18, 0);
$this->assertCarbon($dt->copy()->floorWeek(), 2315, 7, 12, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->ceilWeek(), 2315, 7, 19, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->roundWeek(), 2315, 7, 19, 0, 0, 0, 0);
$dt = Carbon::create(2315, 7, 19, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->floorWeek(), 2315, 7, 19, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->ceilWeek(), 2315, 7, 19, 0, 0, 0, 0);
$this->assertCarbon($dt->copy()->roundWeek(), 2315, 7, 19, 0, 0, 0, 0);
}
public function testCeilMonth()
{
$this->assertCarbon(Carbon::parse('2021-01-29')->ceilMonth(), 2021, 2, 1, 0, 0, 0);
$this->assertCarbon(Carbon::parse('2021-01-31')->ceilMonth(), 2021, 2, 1, 0, 0, 0);
$this->assertCarbon(Carbon::parse('2021-12-17')->ceilMonth(), 2022, 1, 1, 0, 0, 0);
}
public function testFloorMonth()
{
$this->assertCarbon(Carbon::parse('2021-05-31')->floorMonth(3), 2021, 4, 1, 0, 0, 0);
}
public function testRoundInvalidArgument()
{
$this->expectExceptionObject(new InvalidArgumentException(
'Unknown unit \'foobar\'.',
));
Carbon::now()->roundUnit('foobar');
}
public function testRoundWithNumericPrecisionCarry()
{
// A numeric precision >= 60s must carry, like the equivalent string unit.
$dt = Carbon::create(2026, 1, 1, 14, 21, 37);
$this->assertCarbon($dt->copy()->round(3600), 2026, 1, 1, 14, 0, 0, 0);
$this->assertTrue($dt->copy()->round(3600)->eq($dt->copy()->round('hour')));
$this->assertCarbon($dt->copy()->round(120), 2026, 1, 1, 14, 22, 0, 0);
$this->assertTrue($dt->copy()->round(120)->eq($dt->copy()->round('2 minutes')));
$this->assertCarbon($dt->copy()->round(86400), 2026, 1, 2, 0, 0, 0, 0);
$this->assertTrue($dt->copy()->round(86400)->eq($dt->copy()->round('day')));
// floor() with numeric precision must also carry, not just clamp within the minute.
$almostNextHour = Carbon::create(2026, 1, 1, 14, 59, 59);
$this->assertCarbon($almostNextHour->copy()->floor(3600), 2026, 1, 1, 14, 0, 0, 0);
$this->assertTrue($almostNextHour->copy()->floor(3600)->eq($almostNextHour->copy()->floor('hour')));
// ceil() with numeric precision must carry across the hour boundary.
$halfPastHour = Carbon::create(2026, 1, 1, 14, 30, 0);
$this->assertCarbon($halfPastHour->copy()->ceil(3600), 2026, 1, 1, 15, 0, 0, 0);
$this->assertTrue($halfPastHour->copy()->ceil(3600)->eq($halfPastHour->copy()->ceil('hour')));
// Carry across a month boundary via a day-level numeric precision.
$monthEnd = Carbon::create(2026, 1, 31, 20, 0, 0);
$this->assertCarbon($monthEnd->copy()->round(86400), 2026, 2, 1, 0, 0, 0, 0);
// Sub-minute numeric precision must keep rounding within the second field, unchanged.
$this->assertCarbon($dt->copy()->round(30), 2026, 1, 1, 14, 21, 30, 0);
}
public function testNumericPrecisionCarryFromAnyUnit(): void
{
$dt = Carbon::parse('2026-01-01 14:21:03');
// A precision counting minutes spans a whole day just as one counting
// seconds does, so it has to carry the same way.
$this->assertCarbon($dt->copy()->roundMinutes(24 * 60), 2026, 1, 2, 0, 0, 0, 0);
$this->assertTrue($dt->copy()->roundMinutes(24 * 60)->eq($dt->copy()->round('day')));
$this->assertCarbon($dt->copy()->roundHours(24), 2026, 1, 2, 0, 0, 0, 0);
$this->assertTrue($dt->copy()->roundHours(24)->eq($dt->copy()->round('day')));
$this->assertCarbon($dt->copy()->roundMinutes(60), 2026, 1, 1, 14, 0, 0, 0);
$this->assertTrue($dt->copy()->roundMinutes(60)->eq($dt->copy()->round('hour')));
$this->assertCarbon(Carbon::parse('2026-08-20')->roundMonths(12), 2027, 1, 1, 0, 0, 0, 0);
$this->assertTrue(Carbon::parse('2026-08-20')->roundMonths(12)->eq(Carbon::parse('2026-08-20')->round('year')));
// A precision that stays inside its own unit is untouched.
$this->assertCarbon($dt->copy()->roundMinutes(30), 2026, 1, 1, 14, 30, 0, 0);
$this->assertCarbon($dt->copy()->roundSeconds(30), 2026, 1, 1, 14, 21, 0, 0);
}
}