Fixes #11 - Remove trailing zeros from formatted price (#18)

* Remove trailing zeros from formatted price

* Add setting for how to handle trailing decimal zeros

* Write tests

* Fix code style

* Rewrite function description

* Change test name

* Add empty line at end of file

* rename deleteTrailingDecimalZeros to trimTrailingDecimalZeros

* Fix grammar

* Remove unnecessary parameter declarations

* fix test name

* fix comment grammar

* fix docblock grammar

Co-authored-by: Samuel Štancl <samuel@archte.ch>

src/Currency.php

@@ -40,6 +40,9 @@ class Currency implements Arrayable, JsonSerializable
     /** How many decimals of the currency's values should get rounded. */
     protected int $rounding;
 
+    /** Should trailing decimal zeros be trimmed. */
+    protected bool $trimTrailingDecimalZeros;
+
     /** Create a new Currency instance. */
     public function __construct(
         string $code = null,
@@ -52,6 +55,7 @@ class Currency implements Arrayable, JsonSerializable
         int $rounding = null,
         string $decimalSeparator = null,
         string $thousandsSeparator = null,
+        bool $trimTrailingDecimalZeros = null,
     ) {
         $this->code = $code ?? $this->code ?? '';
         $this->name = $name ?? $this->name ?? '';
@@ -63,6 +67,7 @@ class Currency implements Arrayable, JsonSerializable
         $this->decimalSeparator = $decimalSeparator ?? $this->decimalSeparator ?? '.';
         $this->thousandsSeparator = $thousandsSeparator ?? $this->thousandsSeparator ?? ',';
         $this->rounding = $rounding ?? $this->rounding ?? $this->mathDecimals;
+        $this->trimTrailingDecimalZeros = $trimTrailingDecimalZeros ?? $this->trimTrailingDecimalZeros ?? false;
 
         $this->check();
     }
@@ -133,6 +138,12 @@ class Currency implements Arrayable, JsonSerializable
         return $this->rounding;
     }
 
+    /** Get the currency's setting for trimming trailing decimal zeros. */
+    public function trimTrailingDecimalZeros(): bool
+    {
+        return $this->trimTrailingDecimalZeros;
+    }
+
     /** Convert the currency to a string (returns the code). */
     public function __toString()
     {
@@ -153,6 +164,7 @@ class Currency implements Arrayable, JsonSerializable
             'rounding' => $this->rounding,
             'decimalSeparator' => $this->decimalSeparator,
             'thousandsSeparator' => $this->thousandsSeparator,
+            'trimTrailingDecimalZeros' => $this->trimTrailingDecimalZeros,
         ];
     }
 

src/PriceFormatter.php

@@ -23,6 +23,14 @@ class PriceFormatter
             $currency->thousandsSeparator(),
         );
 
+        if ($currency->trimTrailingDecimalZeros()) {
+            // Remove trailing zeros from the formatted string
+            $decimal = rtrim($decimal, '0');
+            
+            // Once there are no more decimal values, remove the decimal separator as well
+            $decimal = rtrim($decimal, $currency->decimalSeparator());
+        }
+
         return $currency->prefix() . $decimal . $currency->suffix();
     }
 

tests/Currencies/SEK.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ArchTech\Money\Tests\Currencies;
+
+use ArchTech\Money\Currency;
+
+class SEK extends Currency
+{
+    protected string $code = 'SEK';
+    protected string $name = 'Swedish crown';
+    protected float $rate = 9.94;
+    protected int $mathDecimals = 4;
+    protected int $displayDecimals = 2;
+    protected int $rounding = 0;
+    protected string $suffix = ' kr';
+    protected bool $trimTrailingDecimalZeros = true;
+}

tests/Pest/CurrencyTest.php

@@ -28,6 +28,7 @@ test('currencies can be serialized to JSON', function () {
         'rounding' => 2,
         'decimalSeparator' => ',',
         'thousandsSeparator' => '.',
+        'trimTrailingDecimalZeros' => false,
     ]);
 });
 

tests/Pest/FormattingTest.php

@@ -5,8 +5,9 @@ use ArchTech\Money\Currency;
 use ArchTech\Money\Money;
 use ArchTech\Money\Tests\Currencies\CZK;
 use ArchTech\Money\Tests\Currencies\EUR;
+use ArchTech\Money\Tests\Currencies\SEK;
 
-beforeEach(fn () => currencies()->add([CZK::class, EUR::class]));
+beforeEach(fn () => currencies()->add([CZK::class, EUR::class, SEK::class]));
 
 test('prefixes are applied', function () {
     expect(Money::fromDecimal(10.00, USD::class)->formatted())->toBe('$10.00');
@@ -45,3 +46,15 @@ test('the format method accepts overrides', function () {
     expect(Money::fromDecimal(10.45)->formatted(['decimalSeparator' => ',', 'prefix' => '$$$']))->toBe('$$$10,45');
     expect(Money::fromDecimal(10.45)->formatted(decimalSeparator: ',', suffix: ' USD'))->toBe('$10,45 USD');
 });
+
+test('decimal zeros can be trimmed', function () {
+    // SEK uses decimal zero trimming
+    expect(Money::fromDecimal(10.00, SEK::class)->formatted())->toBe('10 kr');
+    expect(Money::fromDecimal(10.10, SEK::class)->formatted())->toBe('10.1 kr');
+    expect(Money::fromDecimal(10.12, SEK::class)->formatted())->toBe('10.12 kr');
+
+    // EUR does not use decimal zero trimming
+    expect(Money::fromDecimal(10.00, EUR::class)->formatted())->toBe('10.00 €');
+    expect(Money::fromDecimal(10.10, EUR::class)->formatted())->toBe('10.10 €');
+    expect(Money::fromDecimal(10.12, EUR::class)->formatted())->toBe('10.12 €');
+});