Merge pull request #140 from bavix/develop

5.0.x - Arbitrary Precision Mathematics

Author: rez1dent3

.phpstorm.meta.php

@@ -2,6 +2,7 @@
 
 namespace PHPSTORM_META {
 
+    use Bavix\Wallet\Interfaces\Mathable;
     use Bavix\Wallet\Interfaces\Rateable;
     use Bavix\Wallet\Interfaces\Storable;
     use Bavix\Wallet\Models\Transaction;
@@ -13,7 +14,6 @@
     use Bavix\Wallet\Objects\Operation;
     use Bavix\Wallet\Services\CommonService;
     use Bavix\Wallet\Services\ExchangeService;
-    use Bavix\Wallet\Services\ProxyService;
     use Bavix\Wallet\Services\WalletService;
 
     override(\app(0), map([
@@ -23,11 +23,11 @@
         EmptyLock::class => EmptyLock::class,
         ExchangeService::class => ExchangeService::class,
         CommonService::class => CommonService::class,
-        ProxyService::class => ProxyService::class,
         WalletService::class => WalletService::class,
         Wallet::class => Wallet::class,
         Transfer::class => Transfer::class,
         Transaction::class => Transaction::class,
+        Mathable::class => Mathable::class,
         Rateable::class => Rateable::class,
         Storable::class => Storable::class,
     ]));

README.md

@@ -29,6 +29,9 @@ laravel-wallet - Easy work with virtual wallet.
 
 ### Upgrade Guide
 
+> Starting with version 5.x, support for Laravel 5 has been discontinued.
+> Update laravel or use version 4.x.
+
 To perform the migration, you will be [helped by the instruction](https://bavix.github.io/laravel-wallet/#/upgrade-guide).
 
 ### Extensions
@@ -98,7 +101,7 @@ class Item extends Model implements Product
         return true; 
     }
 
-    public function getAmountProduct(Customer $customer): int
+    public function getAmountProduct(Customer $customer)
     {
         return 100;
     }

changelog.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- add support "Arbitrary Precision Mathematics" (`ext-bcmath`) #139 #146
+- add `Mathable` service (helps switch quickly from bcmath to php computing)
+
+### Changed
+- add unit cases
+- upgrade composer packages
+- Now all casts are in the config, not in the model. If you use bcmath, then all values are reduced to a string.
+
+### Removed
+- Strong typing (models, interfaces, etc.)
+- all deprecated methods are removed
+- `nesbot/carbon` is no longer needed for the library to work
+
 ## [4.2.0] - 2020-03-08
 
 ### Added
@@ -142,7 +156,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Deprecated
 - class `Taxing`.
 
-### Remove
+### Removed
 - The ability to change the ratio  `coefficient`.
 - Removed private and protected methods, the traits turned out to be more clean.
 
@@ -453,7 +467,7 @@ The operation is now executed in the transaction and updates the new `refund` fi
 - Exceptions: AmountInvalid, BalanceIsEmpty.
 - Models: Transfer, Transaction.
 
-[Unreleased]: https://github.com/bavix/laravel-wallet/compare/4.2.0...HEAD
+[Unreleased]: https://github.com/bavix/laravel-wallet/compare/4.2.0...develop
 [4.2.0]: https://github.com/bavix/laravel-wallet/compare/4.1.2...4.2.0
 [4.1.2]: https://github.com/bavix/laravel-wallet/compare/4.1.1...4.1.2
 [4.1.1]: https://github.com/bavix/laravel-wallet/compare/4.1.0...4.1.1

composer.json

@@ -28,7 +28,6 @@
     "php": "^7.2|^8.0",
     "ext-pdo": "*",
     "illuminate/database": "^6.0|^7.0",
-    "nesbot/carbon": "^2.0",
     "doctrine/dbal": "^2.8",
     "ramsey/uuid": "^3.0"
   },
@@ -40,6 +39,7 @@
     "laravel/cashier": "^10.0"
   },
   "suggest": {
+    "ext-bcmath": "Used for accurate calculations of large numbers",
     "bavix/laravel-wallet-swap": "Addition to the laravel-wallet library for quick setting of exchange rates",
     "bavix/laravel-wallet-vacuum": "Addition to the laravel-wallet library for quick fix race condition"
   },
@@ -54,6 +54,9 @@
     }
   },
   "extra": {
+    "branch-alias": {
+      "dev-develop": "5.0.x-dev"
+    },
     "laravel": {
       "providers": [
         "Bavix\\Wallet\\WalletServiceProvider"

config/config.php

@@ -6,23 +6,37 @@
 use Bavix\Wallet\Objects\Operation;
 use Bavix\Wallet\Services\ExchangeService;
 use Bavix\Wallet\Services\CommonService;
-use Bavix\Wallet\Services\ProxyService;
 use Bavix\Wallet\Services\WalletService;
 use Bavix\Wallet\Services\LockService;
 use Bavix\Wallet\Models\Transaction;
 use Bavix\Wallet\Models\Transfer;
 use Bavix\Wallet\Models\Wallet;
 use Bavix\Wallet\Simple\Rate;
 use Bavix\Wallet\Simple\Store;
+use Bavix\Wallet\Simple\BCMath;
+use Bavix\Wallet\Simple\Math;
+
+$bcLoaded = extension_loaded('bcmath');
 
 return [
+    /**
+     * This parameter is necessary for more accurate calculations.
+     * PS, Arbitrary Precision Calculations
+     */
+    'math' => [
+        'scale' => 64,
+    ],
+
     /**
      * The parameter is used for fast packet overload.
      * You do not need to search for the desired class by code, the library will do it itself.
      */
     'package' => [
         'rateable' => Rate::class,
         'storable' => Store::class,
+        'mathable' => $bcLoaded ?
+            BCMath::class :
+            Math::class,
     ],
 
     /**
@@ -60,7 +74,6 @@
     'services' => [
         'exchange' => ExchangeService::class,
         'common' => CommonService::class,
-        'proxy' => ProxyService::class,
         'wallet' => WalletService::class,
         'lock' => LockService::class,
     ],
@@ -78,7 +91,9 @@
     'transaction' => [
         'table' => 'transactions',
         'model' => Transaction::class,
-        'casts' => [],
+        'casts' => [
+            'amount' => $bcLoaded ? 'string' : 'int',
+        ],
     ],
 
     /**
@@ -87,7 +102,9 @@
     'transfer' => [
         'table' => 'transfers',
         'model' => Transfer::class,
-        'casts' => [],
+        'casts' => [
+            'fee' => $bcLoaded ? 'string' : 'int',
+        ],
     ],
 
     /**
@@ -96,7 +113,9 @@
     'wallet' => [
         'table' => 'wallets',
         'model' => Wallet::class,
-        'casts' => [],
+        'casts' => [
+            'balance' => $bcLoaded ? 'string' : 'int',
+        ],
         'default' => [
             'name' => 'Default Wallet',
             'slug' => 'default',

database/migrations_v1/2018_11_06_222923_create_transactions_table.php

@@ -18,7 +18,7 @@ class CreateTransactionsTable extends Migration
     public function up(): void
     {
         Schema::create($this->table(), function (Blueprint $table) {
-            $table->increments('id');
+            $table->bigIncrements('id');
             $table->morphs('payable');
             $table->enum('type', ['deposit', 'withdraw'])->index();
             $table->bigInteger('amount');

database/migrations_v1/2018_11_07_192923_create_transfers_table.php

@@ -15,11 +15,11 @@ class CreateTransfersTable extends Migration
     public function up(): void
     {
         Schema::create($this->table(), function (Blueprint $table) {
-            $table->increments('id');
+            $table->bigIncrements('id');
             $table->morphs('from');
             $table->morphs('to');
-            $table->unsignedInteger('deposit_id');
-            $table->unsignedInteger('withdraw_id');
+            $table->unsignedBigInteger('deposit_id');
+            $table->unsignedBigInteger('withdraw_id');
             $table->uuid('uuid')->unique();
             $table->timestamps();
 

database/migrations_v2/2018_11_15_124230_create_wallets_table.php

@@ -2,7 +2,6 @@
 
 use Bavix\Wallet\Models\Transaction;
 use Bavix\Wallet\Models\Wallet;
-use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
@@ -26,7 +25,7 @@ protected function table(): string
     public function up(): void
     {
         Schema::create($this->table(), function (Blueprint $table) {
-            $table->increments('id');
+            $table->bigIncrements('id');
             $table->morphs('holder');
             $table->string('name');
             $table->string('slug')->index();
@@ -48,8 +47,8 @@ public function up(): void
             ->selectRaw('? as name', [$default])
             ->selectRaw('? as slug', [$slug])
             ->selectRaw('sum(amount) as balance')
-            ->selectRaw('? as created_at', [Carbon::now()])
-            ->selectRaw('? as updated_at', [Carbon::now()])
+            ->selectRaw('? as created_at', [DB::raw('now()')])
+            ->selectRaw('? as updated_at', [DB::raw('now()')])
             ->groupBy('holder_type', 'holder_id')
             ->orderBy('holder_type');
 

database/migrations_v2/2018_11_19_164609_update_transactions_table.php

@@ -33,7 +33,7 @@ protected function walletTable(): string
     public function up(): void
     {
         Schema::table($this->table(), function (Blueprint $table) {
-            $table->unsignedInteger('wallet_id')
+            $table->unsignedBigInteger('wallet_id')
                 ->nullable()
                 ->after('payable_id');
 

docs/basic-usage.md

@@ -62,7 +62,7 @@ class Item extends Model implements Product
         return true; 
     }
 
-    public function getAmountProduct(Customer $customer): int
+    public function getAmountProduct(Customer $customer)
     {
         return 100;
     }