mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-06-20 17:15:51 +02:00
Improve parameter parsing (#583)
* DigiKey: Skip empty values * Move improved range detection from LCSCProvider to ParameterDTO class Improve numeric value detection by moving extra info to value_text * ParameterDTO: Add micro unit prefix * Bring $value_text2 to a defined state * ParameterDTO: Don't overwrite $unit if it's not empty * ParameterDTO: Don't overwrite $unit if it's not empty * Correct some inaccuacies in comments * Added tests and fixed certain edge cases in parsing parameters * Added more tests for parameter parsing --------- Co-authored-by: Jan Böhmer <mail@jan-boehmer.de>
This commit is contained in:
frank-f
GitHub
parent
fdf64f9e9a
commit
7a6b045030
4 changed files with 141 additions and 34 deletions
|
|
@ -44,7 +44,10 @@ class ParameterDTO
|
|||
|
||||
/**
|
||||
* This function tries to decide on the value, if it is a numerical value (which is then stored in one of the value_*) fields) or a text value (which is stored in value_text).
|
||||
* It is possible to give ranges like 1...2 here, which will be parsed as value_min: 1.0, value_max: 2.0.
|
||||
* It is possible to give ranges like 1...2 (or 1~2) here, which will be parsed as value_min: 1.0, value_max: 2.0.
|
||||
*
|
||||
* For certain expressions (like ranges) the unit is automatically extracted from the value, if no unit is given
|
||||
* @TODO Rework that, so that the difference between parseValueField and parseValueIncludingUnit is clearer or merge them
|
||||
* @param string $name
|
||||
* @param string|float $value
|
||||
* @param string|null $unit
|
||||
|
|
@ -54,23 +57,66 @@ class ParameterDTO
|
|||
*/
|
||||
public static function parseValueField(string $name, string|float $value, ?string $unit = null, ?string $symbol = null, ?string $group = null): self
|
||||
{
|
||||
if (is_float($value) || is_numeric($value)) {
|
||||
return new self($name, value_typ: (float) $value, unit: $unit, symbol: $symbol, group: $group);
|
||||
//If we encounter something like 2.5@text, then put the "@text" into text_value and continue with the number parsing
|
||||
if (is_string($value) && preg_match('/^(.+)(@.+)$/', $value, $matches) === 1) {
|
||||
$value = $matches[1];
|
||||
$value_text = $matches[2];
|
||||
} else {
|
||||
$value_text = null;
|
||||
}
|
||||
|
||||
//Try to parse as range
|
||||
if (str_contains($value, '...')) {
|
||||
$parts = explode('...', $value);
|
||||
if (count($parts) === 2) {
|
||||
//If the value is just a number, we assume thats the typical value
|
||||
if (is_float($value) || is_numeric($value)) {
|
||||
return new self($name, value_text: $value_text, value_typ: (float) $value, unit: $unit, symbol: $symbol,
|
||||
group: $group);
|
||||
}
|
||||
|
||||
//Ensure that both parts are numerical
|
||||
if (is_numeric($parts[0]) && is_numeric($parts[1])) {
|
||||
return new self($name, value_min: (float) $parts[0], value_max: (float) $parts[1], unit: $unit, symbol: $symbol, group: $group);
|
||||
//If the attribute contains "..." or a tilde we assume it is a range
|
||||
if (preg_match('/(\.{3}|~)/', $value) === 1) {
|
||||
$parts = preg_split('/\s*(\.{3}|~)\s*/', $value);
|
||||
if (count($parts) === 2) {
|
||||
//Try to extract number and unit from value (allow leading +)
|
||||
if (empty($unit)) {
|
||||
[$number, $unit] = self::splitIntoValueAndUnit(ltrim($parts[0], " +")) ?? [$parts[0], null];
|
||||
} else {
|
||||
$number = $parts[0];
|
||||
}
|
||||
|
||||
// If the second part has some extra info, we'll save that into value_text
|
||||
if (!empty($unit) && preg_match('/^(.+' . preg_quote($unit, '/') . ')\s*(.+)$/', $parts[1], $matches) > 0) {
|
||||
$parts[1] = $matches[1];
|
||||
$value_text2 = $matches[2];
|
||||
} else {
|
||||
$value_text2 = null;
|
||||
}
|
||||
[$number2, $unit2] = self::splitIntoValueAndUnit(ltrim($parts[1], " +")) ?? [$parts[1], $unit];
|
||||
|
||||
//If both parts have the same unit and both values are numerical, we'll save it as range
|
||||
if ($unit === $unit2 && is_numeric($number) && is_numeric($number2)) {
|
||||
return new self(name: $name, value_text: $value_text2, value_min: (float) $number,
|
||||
value_max: (float) $number2, unit: $unit, symbol: $symbol, group: $group);
|
||||
}
|
||||
}
|
||||
//If it's a plus/minus value, we'll also treat it as a range
|
||||
} elseif (str_starts_with($value, '±')) {
|
||||
[$number, $unit] = self::splitIntoValueAndUnit(ltrim($value, " ±")) ?? [ltrim($value, ' ±'), $unit];
|
||||
if (is_numeric($number)) {
|
||||
return new self(name: $name, value_min: -abs((float) $number), value_max: abs((float) $number), unit: $unit, symbol: $symbol, group: $group);
|
||||
}
|
||||
}
|
||||
|
||||
return new self($name, value_text: $value, unit: $unit, symbol: $symbol, group: $group);
|
||||
//If no unit was passed to us, try to extract it from the value
|
||||
if (empty($unit)) {
|
||||
[$value, $unit] = self::splitIntoValueAndUnit($value) ?? [$value, null];
|
||||
}
|
||||
|
||||
//Were we successful in trying to reduce the value to a number?
|
||||
if ($value_text !== null && is_numeric($value)) {
|
||||
return new self($name, value_text: $value_text, value_typ: (float) $value, unit: $unit, symbol: $symbol,
|
||||
group: $group);
|
||||
}
|
||||
|
||||
return new self($name, value_text: $value.$value_text, unit: $unit, symbol: $symbol, group: $group);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -106,7 +152,7 @@ class ParameterDTO
|
|||
*/
|
||||
public static function splitIntoValueAndUnit(string $value): ?array
|
||||
{
|
||||
if (preg_match('/^(?<value>-?[0-9\.]+)\s*(?<unit>[%Ω°℃a-z_\/]+\s?\w{0,4})$/iu', $value, $matches)) {
|
||||
if (preg_match('/^(?<value>-?[0-9\.]+)\s*(?<unit>[%Ωµ°℃a-z_\/]+\s?\w{0,4})$/iu', $value, $matches)) {
|
||||
$value = $matches['value'];
|
||||
$unit = $matches['unit'];
|
||||
|
||||
|
|
|
|||
|
|
@ -210,6 +210,10 @@ class DigikeyProvider implements InfoProviderInterface
|
|||
$footprint_name = $parameter['Value'];
|
||||
}
|
||||
|
||||
if (in_array(trim($parameter['Value']), array('', '-'), true)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$results[] = ParameterDTO::parseValueIncludingUnit($parameter['Parameter'], $parameter['Value']);
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -323,27 +323,6 @@ class LCSCProvider implements InfoProviderInterface
|
|||
//Skip this attribute if it's empty
|
||||
if (in_array(trim($attribute['paramValueEn']), array('', '-'), true)) {
|
||||
continue;
|
||||
//If the attribute contains a tilde we assume it is a range
|
||||
} elseif (str_contains($attribute['paramValueEn'], '~')) {
|
||||
$parts = explode('~', $attribute['paramValueEn']);
|
||||
if (count($parts) === 2) {
|
||||
//Try to extract number and unit from value (allow leading +)
|
||||
[$number, $unit] = ParameterDTO::splitIntoValueAndUnit(ltrim($parts[0], " +")) ?? [$parts[0], null];
|
||||
[$number2, $unit2] = ParameterDTO::splitIntoValueAndUnit(ltrim($parts[1], " +")) ?? [$parts[1], null];
|
||||
|
||||
//If both parts have the same unit and both values are numerical, we assume it is a range
|
||||
if ($unit === $unit2 && is_numeric($number) && is_numeric($number2)) {
|
||||
$result[] = new ParameterDTO(name: $attribute['paramNameEn'], value_min: (float) $number, value_max: (float) $number2, unit: $unit, group: null);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
//If it's a plus/minus value, we'll also it like a range
|
||||
} elseif (str_starts_with($attribute['paramValueEn'], '±')) {
|
||||
[$number, $unit] = ParameterDTO::splitIntoValueAndUnit(ltrim($attribute['paramValueEn'], " ±")) ?? [$attribute['paramValueEn'], null];
|
||||
if (is_numeric($number)) {
|
||||
$result[] = new ParameterDTO(name: $attribute['paramNameEn'], value_min: -abs((float) $number), value_max: abs((float) $number), unit: $unit, group: null);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
$result[] = ParameterDTO::parseValueIncludingUnit(name: $attribute['paramNameEn'], value: $attribute['paramValueEn'], group: null);
|
||||
|
|
|
|||
|
|
@ -67,6 +67,56 @@ class ParameterDTOTest extends TestCase
|
|||
'm',
|
||||
'test'
|
||||
];
|
||||
|
||||
//Test ranges with tilde
|
||||
yield [
|
||||
new ParameterDTO('test', value_min: -1.0, value_max: 2.0, unit: 'kg', symbol: 'm', group: 'test'),
|
||||
'test',
|
||||
'-1.0~+2.0', //Leading signs are parsed correctly
|
||||
'kg',
|
||||
'm',
|
||||
'test'
|
||||
];
|
||||
|
||||
//Test ranges with comment
|
||||
yield [
|
||||
new ParameterDTO('test', value_text: "Test", value_min: -1.0, value_max: 2.0, unit: 'kg', symbol: 'm',
|
||||
group: 'test'),
|
||||
'test',
|
||||
'-1.0~+2.0 kg Test', //Leading signs are parsed correctly
|
||||
'kg',
|
||||
'm',
|
||||
'test'
|
||||
];
|
||||
|
||||
//Test @comment
|
||||
yield [
|
||||
new ParameterDTO('test', value_text: "@comment", value_typ: 1.0, unit: 'kg', symbol: 'm', group: 'test'),
|
||||
'test',
|
||||
'1.0@comment',
|
||||
'kg',
|
||||
'm',
|
||||
'test'
|
||||
];
|
||||
|
||||
//Test plus minus range (without unit)
|
||||
yield [
|
||||
new ParameterDTO('test', value_min: -1.0, value_max: +1.0, unit: 'kg', symbol: 'm', group: 'test'),
|
||||
'test',
|
||||
'±1.0',
|
||||
'kg',
|
||||
'm',
|
||||
'test'
|
||||
];
|
||||
|
||||
yield [ //And with unit
|
||||
new ParameterDTO('test', value_min: -1.0, value_max: +1.0, unit: 'kg', symbol: 'm', group: 'test'),
|
||||
'test',
|
||||
'±1.0kg',
|
||||
'kg',
|
||||
'm',
|
||||
'test'
|
||||
];
|
||||
}
|
||||
|
||||
public function parseValueIncludingUnitDataProvider(): \Generator
|
||||
|
|
@ -142,6 +192,33 @@ class ParameterDTOTest extends TestCase
|
|||
'm',
|
||||
'test'
|
||||
];
|
||||
|
||||
//Test ranges with tilde
|
||||
yield [
|
||||
new ParameterDTO('test', value_min: -1.0, value_max: 2.0, unit: 'kg', symbol: 'm', group: 'test'),
|
||||
'test',
|
||||
'-1.0kg~+2.0kg', //Leading signs are parsed correctly
|
||||
'm',
|
||||
'test'
|
||||
];
|
||||
|
||||
//Test @comment
|
||||
yield [
|
||||
new ParameterDTO('test', value_text: "@comment", value_typ: 1.0, unit: 'kg', symbol: 'm', group: 'test'),
|
||||
'test',
|
||||
'1.0 kg@comment',
|
||||
'm',
|
||||
'test'
|
||||
];
|
||||
|
||||
//Test plus minus range (without unit)
|
||||
yield [
|
||||
new ParameterDTO('test', value_min: -1.0, value_max: +1.0, unit: 'kg', symbol: 'm', group: 'test'),
|
||||
'test',
|
||||
'±1.0 kg',
|
||||
'm',
|
||||
'test'
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -175,6 +252,7 @@ class ParameterDTOTest extends TestCase
|
|||
$this->assertEquals(["70", "℃"], ParameterDTO::splitIntoValueAndUnit("70℃"));
|
||||
|
||||
$this->assertEquals(["-5.0", "kg"], ParameterDTO::splitIntoValueAndUnit("-5.0 kg"));
|
||||
$this->assertEquals(["-5.0", "µg"], ParameterDTO::splitIntoValueAndUnit("-5.0 µg"));
|
||||
|
||||
$this->assertNull(ParameterDTO::splitIntoValueAndUnit('kg'));
|
||||
$this->assertNull(ParameterDTO::splitIntoValueAndUnit('Test'));
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue