2.0

.github/workflows/tests.yml

@@ -58,7 +58,7 @@ jobs:
         run: composer update --prefer-stable --prefer-dist --no-interaction
 
       - name: Execute tests
-        run: vendor/bin/pest --coverage-clover=reports/coverage/clover.xml
+        run: vendor/bin/pest --coverage-clover=reports/coverage/test-coverage-clover.xml
 
       - name: Execute type coverage tests
         run: vendor/bin/pest --type-coverage --type-coverage-json=reports/coverage/pest-types-coverage.json

README.md

@@ -49,9 +49,15 @@ This package would give "1 234,56 kr", while most other solutions probably would
 composer require pelmered/filament-money-field
 ```
 
-## Configure your locale
+## Upgrade to 2.* from 1.*
 
-### Set the default currency and locale
+See [upgrade guide](UPGRADE.md).
+
+## Configuration
+
+### Configure your locale
+
+#### Set the default currency and locale
 
 **Set the default options for currency and locale so that you don't have to set them for every field.**
 
@@ -67,7 +73,7 @@ php artisan vendor:publish --provider="Pelmered\FilamentMoneyField\FilamentMoney
 ```
 
 
-### Decimals and significant digits
+#### Decimals and significant digits
 
 The number of decimals and significant digits can be set in the config file. Defaults to 2.
 
@@ -78,6 +84,7 @@ MONEY_DECIMAL_DIGITS=2 // Gives 2 decimals, e.g. $1,234.56
 ```
 
 For significant digits, use negative values. For example -2 will give you 2 significant digits. 
+This is only for displaying the amount. The amount will always be saved with full precision. 
 
 ```env
 //with input 12345678
@@ -93,6 +100,15 @@ MoneyEntry::make('price')->decimals(2);
 MoneyColumn::make('price')->decimals(-2);
 ```
 
+### Configuration for saving currency per field in database (Recommended, especially for multi-currency applications) 
+
+#### Migrations
+
+TODO: Add docs
+
+#### Casts
+
+TODO: Add docs
 
 ## Usage
 
@@ -137,7 +153,19 @@ MoneyColumn::make('price')
     ->locale('sv_SE'),
 
 MoneyColumn::make('price')
-    ->short(), // Short fromat, e.g. $1.23M instead of $1,234,567.89
+    ->short(), // Short format, e.g. $1.23M instead of $1,234,567.89
+
+MoneyColumn::make('price')
+    ->short()
+    ->hideCurrencySymbol(), // Short format without currency symbol, e.g. 1.23M instead of $1.23M
+
+MoneyColumn::make('price')
+    ->decimals(4)
+    ->short(), // $1.2345M
+
+MoneyColumn::make('price')
+    ->decimals(-3) // 3 significant digits
+    ->short(), // $1.23K or $23.1M
 ```
 
 ### InfoList

UPGRADE.md

@@ -0,0 +1,20 @@
+
+# Upgrade from 1.*
+
+### For full support, add Money casts for your money fields.
+
+Each money column needs a corresponding currency column with the name {money_column}_currency
+
+For new columns
+```
+Schema::table('tablename', function (Blueprint $table) {
+    $table->money('price'); // This will create two columns, 'price' (integer) and 'price_currency' (char(3))
+});
+```
+For changing existing columns, in this case a column called `price`.
+```
+Schema::table('tablename', function (Blueprint $table) {
+    $table->char('price_currency', 3)->after('price')->change();
+    $this->index(['price', 'price_currency']);
+});
+```

composer.json

@@ -33,12 +33,12 @@
     "require-dev": {
         "filament/filament": "^3.2",
         "orchestra/testbench": "^9.0",
-        "phpstan/phpstan": "^1.12.2",
         "nunomaduro/collision": "^8.0",
         "laravel/pint": "^1.16",
         "pestphp/pest": "^3.0",
         "pestphp/pest-plugin-drift": "^3.0",
-        "pestphp/pest-plugin-type-coverage": "^3.0"
+        "pestphp/pest-plugin-type-coverage": "^3.0",
+        "larastan/larastan": "^2.0"
     },
     "extra": {
         "laravel": {
@@ -72,6 +72,9 @@
         "coverage": [
             "@php vendor/bin/pest --testsuite=default --coverage-clover=coverage.xml --coverage-filter=src --path-coverage"
         ],
+        "types": [
+            "@php vendor/bin/pest --type-coverage"
+        ],
         "check" : [
             "composer lint",
             "composer test"

phpstan.neon

@@ -0,0 +1,11 @@
+
+includes:
+  - vendor/larastan/larastan/extension.neon
+
+parameters:
+
+  paths:
+    - src/
+
+  # Level 9 is the highest level
+  level: 8

src/Casts/CurrencyCast.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Pelmered\FilamentMoneyField\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use Illuminate\Database\Eloquent\Model;
+use Money\Currency;
+use Money\Money;
+use Spatie\LaravelData\Casts\Cast;
+
+/**
+ * @implements CastsAttributes<Currency, Currency>
+ */
+class CurrencyCast implements CastsAttributes
+{
+    /**
+     * Cast the given value.
+     *
+     * @param  ?non-empty-string  $value
+     * @param  array<string, mixed>  $attributes
+     */
+    public function get(Model $model, string $key, mixed $value, array $attributes): ?Currency
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        return new Currency($value);
+    }
+
+    /**
+     * Prepare the given value for storage.
+     *
+     * @param  Currency|string  $value
+     * @param  array<string, mixed>  $attributes
+     */
+    public function set(Model $model, string $key, mixed $value, array $attributes): string
+    {
+        if ($value instanceof Currency) {
+            return $value->getCode();
+        }
+
+        return $value;
+    }
+}

src/Casts/MoneyCast.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Pelmered\FilamentMoneyField\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use Illuminate\Database\Eloquent\Model;
+use Money\Currency;
+use Money\Money;
+use Spatie\LaravelData\Casts\Cast;
+
+/**
+ * @implements CastsAttributes<Money, Money>
+ */
+class MoneyCast implements CastsAttributes
+{
+    /**
+     * Cast the given value.
+     *
+     * @param  ?int  $value
+     * @param  array<string, mixed>  $attributes
+     */
+    public function get(Model $model, string $key, mixed $value, array $attributes): ?Money
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        return new Money($value, $this->getCurrencyFromModel($model, $key));
+    }
+
+    /**
+     * Prepare the given value for storage.
+     *
+     * @param  Money|string|null  $value
+     * @param  array<string, mixed>  $attributes
+     */
+    public function set(Model $model, string $key, mixed $value, array $attributes): ?string
+    {
+        if ($value instanceof Money) {
+            //$model->{$key.'_currency'} = $value->getCurrency();
+            return $value->getAmount();
+        }
+
+        return $value;
+    }
+
+    public function getCurrencyFromModel(Model $model, string $name): Currency
+    {
+        $currency = $model->{$name.'_currency'} ?? (string) (config('filament-money-field.default_currency'));
+
+        return $currency instanceof Currency ? $currency : new Currency($currency);
+    }
+}

src/Casts/MoneySynthesizer.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Pelmered\FilamentMoneyField\Casts;
+
+use Livewire\Mechanisms\HandleComponents\Synthesizers\Synth;
+use Money\Currency;
+use Money\Money;
+
+class MoneySynthesizer extends Synth
+{
+    public static string $key = 'money';
+
+    public static function match(mixed $target): bool
+    {
+        return $target instanceof Money;
+    }
+
+    /**
+     * @return array<int, array<string, Currency|string>>
+     */
+    public function dehydrate(Money $target): array
+    {
+        return [[
+            'amount'   => $target->getAmount(),
+            'currency' => $target->getCurrency(),
+        ], []];
+    }
+
+    /**
+     * @param  ?array<string, string>  $value*
+     */
+    public function hydrate(?array $value): ?string
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        return $value['amount'];
+
+        /*
+        return new Money(
+            $value['amount'],
+            new Currency($value['currency'])
+        );
+        */
+    }
+    /*
+    public function hydrate($value): ?Money
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        return new Money(
+            $value['amount'],
+            new Currency($value['currency'])
+        );
+    }
+    */
+
+    /*
+    public function get(&$target, $key)
+    {
+        //dd($target, $key);
+        return $target->{$key};
+    }
+
+    public function set(&$target, $key, $value)
+    {
+        //dd($target, $key, $value);
+        $target->{$key} = $value;
+    }
+    */
+}

src/FilamentMoneyFieldServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace Pelmered\FilamentMoneyField;
 
+use Livewire\Livewire;
+use Pelmered\FilamentMoneyField\Casts\MoneySynthesizer;
 use Illuminate\Database\Schema\Blueprint;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
@@ -22,11 +24,14 @@ public function boot(): void
             __DIR__.'/../config/filament-money-field.php' => config_path('filament-money-field.php'),
         ], 'config');
 
+        Livewire::propertySynthesizer(MoneySynthesizer::class);
+
         Blueprint::macro('money', function (string $name, ?string $indexName = null) {
             $this->unsignedBigInteger($name);
             $this->string("{$name}_currency");
 
             $this->index([$name, "{$name}_currency"], $indexName);
         });
+
     }
 }