tal7aouy/pest-datetime-plugin

📅 A lightweight DateTime plugin for Pest PHP testing framework, with fluent assertions using Carbon.

v1.0.1 2024-07-07 16:26 UTC

Requires

• php: ^8.1
• nesbot/carbon: ^3.6
• pestphp/pest-plugin: ^2.1

Requires (Dev)

• laravel/pint: ^1.16.1
• pestphp/pest: ^2.34
• phpstan/phpstan: ^1.11.6
• rector/rector: ^1.2.0

MIT

• tal7aouy

• framework
• php
• testing
• plugin
• test
• unit
• datetime
• pest

README

PestDateTime is a plugin for Pest PHP testing framework that provides intuitive date and time assertions using Carbon.

Installation

Install via Composer:

composer require tal7aouy/pest-datetime-plugin

Usage

Example: Checking if Date is Today

use Carbon\Carbon;

test('Check if date is today', function (): void {
    expect(Carbon::now())->toBeToday();
});

Available Assertions

• toBeToday(): Asserts that the date matches today's date.
• toBeInThePast(): Asserts that the date is in the past.
• toBeInTheFuture(): Asserts that the date is in the future.
• toBeSameDayAs($date): Asserts that the date is the same day as the given $date.
• toBeWithinLastDays($days): Asserts that the date is within the last $days.
• toBeWithinNextDays($days): Asserts that the date is within the next $days.
• toBeOnWeekend(): Asserts that the date falls on a weekend.
• toBeOnWeekday(): Asserts that the date falls on a weekday.
• toBeBetweenDates($startDate, $endDate): Asserts that the date falls between $startDate and $endDate.

Contributing

Contributions and feedback are welcome! Please feel free to open issues or submit pull requests.

License

This project is licensed under the MIT License.