[11.x] Method to trim '0' digits after decimal point of a given number

[gdebrauwer]

What

A method on the Number class that trims zero digits after decimal point of a given number

Number::trim(12.0); // => 12

Use case

When a calculated number is returned in a JSON response and the number does not have any digits after the decimal point, then the JSON response will contain an integer instead of a decimal number.

response()->json(['average_rating' => (float) Review::query()->average('rating')]); // = 4.0

Results in

{"average_rating": 4}

When trying to assert that using assertJsonPath, this causes issues because the expected value is still a float while the JSON response contains an integer

// This fails because "4 !== 4.0"
$response->assertJsonPath('average_rating', $relevantReviews->average('rating'));

You can not just convert the expected number to an integer, because the expected number might have digits after the decimal points in other cases. The only way to fix this is JSON-encoding the expected number and then decoding it again.

// This does not fail anymore
$response->assertJsonPath('average_rating', json_decode(json_encode($relevantReviews->average('rating'))));

But this does not look very nice. That is where this new Number::trim($number) method comes into play:

// This does not fail
$response->assertJsonPath('average_rating', Number::trim($relevantReviews->average('rating')));