Skip to content

update RoundingMode to be compatiable with already upgraded brick/math#588

Closed
kurund wants to merge 3 commits intoramsey:4.xfrom
kurund:roundingmode-update
Closed

update RoundingMode to be compatiable with already upgraded brick/math#588
kurund wants to merge 3 commits intoramsey:4.xfrom
kurund:roundingmode-update

Conversation

@kurund
Copy link
Copy Markdown

@kurund kurund commented Feb 19, 2025

Fixes #586

@kurund kurund requested a review from ramsey as a code owner February 19, 2025 12:35
@ramsey
Copy link
Copy Markdown
Owner

ramsey commented Mar 3, 2025

This seems like a BC break. I don't think I can include this in the current 4.x series without potentially breaking a lot of users' applications.

@ramsey ramsey mentioned this pull request May 25, 2025
Merged
7 tasks
@ramsey
Copy link
Copy Markdown
Owner

ramsey commented Jun 1, 2025 •
edited
Loading

@kurund, thanks for your contribution!

After more investigation, I don't think there's a need for this change, since this array performs the translation between this library's RoundingMode and brick/math's RoundingMode:

uuid/src/Math/BrickMathCalculator.php

Lines 34 to 45 in 7eec9c2

private const ROUNDING_MODE_MAP = [
RoundingMode::UNNECESSARY => BrickMathRounding::UNNECESSARY,
RoundingMode::UP => BrickMathRounding::UP,
RoundingMode::DOWN => BrickMathRounding::DOWN,
RoundingMode::CEILING => BrickMathRounding::CEILING,
RoundingMode::FLOOR => BrickMathRounding::FLOOR,
RoundingMode::HALF_UP => BrickMathRounding::HALF_UP,
RoundingMode::HALF_DOWN => BrickMathRounding::HALF_DOWN,
RoundingMode::HALF_CEILING => BrickMathRounding::HALF_CEILING,
RoundingMode::HALF_FLOOR => BrickMathRounding::HALF_FLOOR,
RoundingMode::HALF_EVEN => BrickMathRounding::HALF_EVEN,
];

That translation allows code like this to work on both older versions of brick/math and newer versions that have the enum:

uuid/src/Math/BrickMathCalculator.php

Lines 80 to 99 in 7eec9c2

public function divide(
int $roundingMode,
int $scale,
NumberInterface $dividend,
NumberInterface ...$divisors
): NumberInterface {
$brickRounding = $this->getBrickRoundingMode($roundingMode);
$quotient = BigDecimal::of($dividend->toString());
foreach ($divisors as $divisor) {
$quotient = $quotient->dividedBy($divisor->toString(), $scale, $brickRounding);
}
if ($scale === 0) {
return new IntegerObject((string) $quotient->toBigInteger());
}
return new Decimal((string) $quotient);
}

If we change this library's RoundingMode to be an enum, then this library will no longer be compatible with versions of brick/math earlier than 0.12.

@ramsey ramsey closed this Jun 1, 2025
@ramsey ramsey mentioned this pull request Jun 18, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ramsey ramsey Awaiting requested review from ramsey ramsey is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Outdated version of RoundingMode.php results in fatal

2 participants

@kurund @ramsey