pest-plugin-money
This package is a plugin for Pest PHP. It allows you to write tests against monetary values provided by either brick/money or moneyphp/money using the same declarative syntax you're used to with Pest's expectation syntax.
Installation
To get started, install the plugin using composer:
composer require lukeraymonddowning/pest-plugin-money --dev
This package requires the following:
- Pest PHP
- Either the Brick Money or MoneyPHP Money libraries
- PHP 7.4 or greater
Usage
Using the plugin is simple! Here are examples of the expectations made available by this plugin. We will use Brick Money for all of our examples, but they work exactly the same with MoneyPHP.
toBeMoney
To simply assert that an object is a monetary value, use the toBeMoney method:
expect(Money::of(100, "GBP"))->toBeMoney();
expect("Hello World")->not->toBeMoney();
toCost
To check that a monetary value is equal to a certain amount, use the toCost method:
expect(Money::of(150, "GBP"))->toCost(150, 'GBP');
expect(Money::of(150, "GBP"))->toCost($anotherMoneyObject);
expect(Money::of(150, "GBP"))->not->toCost(100, 'GBP');
toCostLessThan
To check that a monetary value is less than a certain amount, use the toCostLessThan method:
expect(Money::of(150, "GBP"))->toCostLessThan(160, 'GBP');
expect(Money::of(150, "GBP"))->toCostLessThan($anotherMoneyObject);
expect(Money::of(150, "GBP"))->not->toCostLessThan(140, 'GBP');
toCostMoreThan
To check that a monetary value is more than a certain amount, use the toCostMoreThan method:
expect(Money::of(150, "GBP"))->toCostMoreThan(140, 'GBP');
expect(Money::of(150, "GBP"))->toCostMoreThan($anotherMoneyObject);
expect(Money::of(150, "GBP"))->not->toCostMoreThan(160, 'GBP');
Choosing a money library
This package uses Brick Money as a default, but you can change that using the useMoneyLibrary function. Pass the class name of the relevant money package:
useMoneyLibrary(\Money\Money::class); // Use the MoneyPHP library
useMoneyLibrary(\Brick\Money\Money::class); // Use the Brick Money library
Setting a default currency
If your application primarily uses a single currency, it can be annoying having to declare it as the second argument for each expectation. By setting a default, you can omit the currency and just provide the amount:
useCurrency('GBP');
expect($money)->toCost('100'); // Uses Great British Pounds
useCurrency('USD');
expect($money)->toCost('100'); // Uses US Dollars
329 Dec 27, 2022
1 Dec 1, 2021
2.3k Dec 23, 2022
62 Apr 1, 2022
341 Dec 25, 2022
403 Dec 20, 2022
6 Dec 25, 2022
1 Jan 3, 2022
7 Dec 10, 2021
1 Oct 26, 2022
143 Nov 18, 2022
4 Jun 22, 2021
96 Apr 14, 2022
50 Dec 26, 2022
1 Nov 3, 2021
1.3k Jan 5, 2023
24 Nov 21, 2022
17 Jun 16, 2022
1.6k Dec 22, 2022