Skip to content

Proof of concept: Use a trait for parsers #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gmponos wants to merge 14 commits into from
Closed

Proof of concept: Use a trait for parsers #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
90d52eb
Made all the parsers use the same code for parsing decimals proving t…
gmponos Dec 5, 2018
937ee7f
Use trait for decimal parser
gmponos Dec 5, 2018
0da5047
Use trait for parsing decimals
gmponos Dec 5, 2018
ca90a4f
Add forgotten return
gmponos Dec 5, 2018
4ff2a64
Fix style issues
gmponos Dec 5, 2018
dffa4c9
Merged with master
gmponos Dec 28, 2019
2c9371b
Merged with master
gmponos Dec 28, 2019
0f01d7f
Update src/Parser/DecimalParserTrait.php
gmponos Dec 28, 2019
d3009bb
Update uses of trait
gmponos Dec 28, 2019
4fdae14
Fix phpcs
gmponos Dec 28, 2019
42d35a0
updated docblocks for phpstan
gmponos Dec 28, 2019
1068bd1
fix codestyle
gmponos Dec 28, 2019
0a75907
Convert static attribute to protected
gmponos Dec 28, 2019
3505234
make IntlLocalizedDecimalParser use the DecimalParser trait
gmponos Dec 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 3 additions & 22 deletions src/Parser/BitcoinMoneyParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
use Money\Currencies\BitcoinCurrencies;
use Money\Currency;
use Money\Exception\ParserException;
use Money\Money;
use Money\MoneyParser;

/**
Expand All @@ -15,6 +14,8 @@
*/
final class BitcoinMoneyParser implements MoneyParser
{
use DecimalParser;

/**
* @var int
*/
Expand Down Expand Up @@ -56,27 +57,7 @@ public function parse($money, $forceCurrency = null)
}

$decimal = str_replace(BitcoinCurrencies::SYMBOL, '', $money);
$decimalSeparator = strpos($decimal, '.');

if (false !== $decimalSeparator) {
$decimal = rtrim($decimal, '0');
$lengthDecimal = strlen($decimal);
$decimal = str_replace('.', '', $decimal);
$decimal .= str_pad('', ($lengthDecimal - $decimalSeparator - $this->fractionDigits - 1) * -1, '0');
} else {
$decimal .= str_pad('', $this->fractionDigits, '0');
}

if (substr($decimal, 0, 1) === '-') {
$decimal = '-'.ltrim(substr($decimal, 1), '0');
} else {
$decimal = ltrim($decimal, '0');
}

if ('' === $decimal) {
$decimal = '0';
}

return new Money($decimal, $currency);
return $this->parseDecimal($decimal, $this->fractionDigits, $currency);
}
}
54 changes: 6 additions & 48 deletions src/Parser/DecimalMoneyParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
use Money\Currencies;
use Money\Currency;
use Money\Exception\ParserException;
use Money\Money;
use Money\MoneyParser;
use Money\Number;

/**
* Parses a decimal string into a Money object.
Expand All @@ -16,8 +14,13 @@
*/
final class DecimalMoneyParser implements MoneyParser
{
/**
* @deprecated This is here for BC reasons. Should not rely on this constant and will be removed on version 4.x
*/
const DECIMAL_PATTERN = '/^(?P<sign>-)?(?P<digits>0|[1-9]\d*)?\.?(?P<fraction>\d+)?$/';
Copy link
Copy Markdown
Collaborator

@sagikazarmark sagikazarmark Dec 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that removing this constant is probably a BC break.

Copy link
Copy Markdown
Contributor Author

@gmponos gmponos Dec 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reverted


use DecimalParser;

/**
* @var Currencies
*/
Expand Down Expand Up @@ -56,53 +59,8 @@ public function parse($money, $forceCurrency = null)
$currency = new Currency($currency);
}

$decimal = trim($money);

if ($decimal === '') {
return new Money(0, $currency);
}

$subunit = $this->currencies->subunitFor($currency);

if (!preg_match(self::DECIMAL_PATTERN, $decimal, $matches) || !isset($matches['digits'])) {
throw new ParserException(sprintf(
'Cannot parse "%s" to Money.',
$decimal
));
}

$negative = isset($matches['sign']) && $matches['sign'] === '-';

$decimal = $matches['digits'];

if ($negative) {
$decimal = '-'.$decimal;
}

if (isset($matches['fraction'])) {
$fractionDigits = strlen($matches['fraction']);
$decimal .= $matches['fraction'];
$decimal = Number::roundMoneyValue($decimal, $subunit, $fractionDigits);

if ($fractionDigits > $subunit) {
$decimal = substr($decimal, 0, $subunit - $fractionDigits);
} elseif ($fractionDigits < $subunit) {
$decimal .= str_pad('', $subunit - $fractionDigits, '0');
}
} else {
$decimal .= str_pad('', $subunit, '0');
}

if ($negative) {
$decimal = '-'.ltrim(substr($decimal, 1), '0');
} else {
$decimal = ltrim($decimal, '0');
}

if ($decimal === '' || $decimal === '-') {
$decimal = '0';
}

return new Money($decimal, $currency);
return $this->parseDecimal($money, $subunit, $currency);
}
}
76 changes: 76 additions & 0 deletions src/Parser/DecimalParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?php

namespace Money\Parser;

use Money\Currency;
use Money\Exception\ParserException;
use Money\Money;
use Money\Number;

/**
* Common decimal parsing logic extracted from DecimalMoneyParser for reuse.
*
* @internal
*/
trait DecimalParser
{
/**
* @var string
*/
protected static $decimalPattern = '/^(?P<sign>-)?(?P<digits>0|[1-9]\d*)?\.?(?P<fraction>\d+)?$/';

/**
* @param string $decimal
* @param int $subunit
* @param Currency $currency
* @return Money
*/
protected function parseDecimal($decimal, $subunit, Currency $currency)
{
$decimal = trim($decimal);
if ($decimal === '') {
return new Money(0, $currency);
}

if (!preg_match(self::$decimalPattern, $decimal, $matches) || !isset($matches['digits'])) {
throw new ParserException(sprintf(
'Cannot parse "%s" to Money.',
$decimal
));
}

$negative = isset($matches['sign']) && $matches['sign'] === '-';

$decimal = $matches['digits'];

if ($negative) {
$decimal = '-'.$decimal;
}

if (isset($matches['fraction'])) {
$fractionDigits = strlen($matches['fraction']);
$decimal .= $matches['fraction'];
$decimal = Number::roundMoneyValue($decimal, $subunit, $fractionDigits);

if ($fractionDigits > $subunit) {
$decimal = substr($decimal, 0, $subunit - $fractionDigits);
} elseif ($fractionDigits < $subunit) {
$decimal .= str_pad('', $subunit - $fractionDigits, '0');
}
} else {
$decimal .= str_pad('', $subunit, '0');
}

if ($negative) {
$decimal = '-'.ltrim(substr($decimal, 1), '0');
} else {
$decimal = ltrim($decimal, '0');
}

if ($decimal === '' || $decimal === '-') {
$decimal = '0';
}

return new Money($decimal, $currency);
}
}
32 changes: 3 additions & 29 deletions src/Parser/IntlLocalizedDecimalParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
use Money\Currencies;
use Money\Currency;
use Money\Exception\ParserException;
use Money\Money;
use Money\MoneyParser;
use Money\Number;

/**
* Parses a string into a Money object using intl extension.
Expand All @@ -16,6 +14,8 @@
*/
final class IntlLocalizedDecimalParser implements MoneyParser
{
use DecimalParser;

/**
* @var \NumberFormatter
*/
Expand Down Expand Up @@ -70,33 +70,7 @@ public function parse($money, $forceCurrency = null)

$decimal = (string) $decimal;
$subunit = $this->currencies->subunitFor($forceCurrency);
$decimalPosition = strpos($decimal, '.');

if (false !== $decimalPosition) {
$decimalLength = strlen($decimal);
$fractionDigits = $decimalLength - $decimalPosition - 1;
$decimal = str_replace('.', '', $decimal);
$decimal = Number::roundMoneyValue($decimal, $subunit, $fractionDigits);

if ($fractionDigits > $subunit) {
$decimal = substr($decimal, 0, $decimalPosition + $subunit);
} elseif ($fractionDigits < $subunit) {
$decimal .= str_pad('', $subunit - $fractionDigits, '0');
}
} else {
$decimal .= str_pad('', $subunit, '0');
}

if ('-' === $decimal[0]) {
$decimal = '-'.ltrim(substr($decimal, 1), '0');
} else {
$decimal = ltrim($decimal, '0');
}

if ('' === $decimal) {
$decimal = '0';
}

return new Money($decimal, $forceCurrency);
return $this->parseDecimal($decimal, $subunit, $forceCurrency);
}
}
32 changes: 3 additions & 29 deletions src/Parser/IntlMoneyParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
use Money\Currencies;
use Money\Currency;
use Money\Exception\ParserException;
use Money\Money;
use Money\MoneyParser;
use Money\Number;

/**
* Parses a string into a Money object using intl extension.
Expand All @@ -16,6 +14,8 @@
*/
final class IntlMoneyParser implements MoneyParser
{
use DecimalParser;

/**
* @var \NumberFormatter
*/
Expand Down Expand Up @@ -71,33 +71,7 @@ public function parse($money, $forceCurrency = null)

$decimal = (string) $decimal;
$subunit = $this->currencies->subunitFor($currency);
$decimalPosition = strpos($decimal, '.');

if (false !== $decimalPosition) {
$decimalLength = strlen($decimal);
$fractionDigits = $decimalLength - $decimalPosition - 1;
$decimal = str_replace('.', '', $decimal);
$decimal = Number::roundMoneyValue($decimal, $subunit, $fractionDigits);

if ($fractionDigits > $subunit) {
$decimal = substr($decimal, 0, $decimalPosition + $subunit);
} elseif ($fractionDigits < $subunit) {
$decimal .= str_pad('', $subunit - $fractionDigits, '0');
}
} else {
$decimal .= str_pad('', $subunit, '0');
}

if ('-' === $decimal[0]) {
$decimal = '-'.ltrim(substr($decimal, 1), '0');
} else {
$decimal = ltrim($decimal, '0');
}

if ('' === $decimal) {
$decimal = '0';
}

return new Money($decimal, $currency);
return $this->parseDecimal($decimal, $subunit, $currency);
}
}