Skip to content

Issue 924: add support for arrays in scientificMetadata #925

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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Issue 924: add support for arrays in scientificMetadata #925

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
71e7a84
add support for arrays in scientificMetadata
jkotan Nov 30, 2023
30c3a11
apply fixes for #926
jkotan Dec 1, 2023
07167cf
rollback unwanted changes
jkotan Dec 1, 2023
2073097
use SI unit also for empty tables
jkotan Dec 1, 2023
4f29306
change tabs to spaces
jkotan Dec 1, 2023
a5e5380
remove empty lines
jkotan Dec 1, 2023
548a4ac
slit long lines
jkotan Dec 1, 2023
acfc8f2
add a comment about the mathjs issue
jkotan Dec 4, 2023
cf05544
Merge branch 'master' into issue_924
nitrosx Dec 5, 2023
46e00f3
Merge branch 'master' into issue_924
nitrosx Dec 5, 2023
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
41 changes: 38 additions & 3 deletions src/common/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,36 @@ import {
} from "./interfaces/common.interface";
import { ScientificRelation } from "./scientific-relation.enum";

export const convertArrayToSI = (
inputValue: number[],
inputUnit: string,
): { valueSI: number[]; unitSI: string } => {
try {
const newUnit = unit(inputUnit).toSI().toJSON().unit;
Copy link
Contributor

Choose a reason for hiding this comment

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

can add a comment for this workaround, so that we can easier find to roll back these changes once upstream mathjs has fixed that behaviour ( and if possible reference a mathjs bug report as well)

Copy link
Contributor

Choose a reason for hiding this comment

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

#1005 bumped to version with fixed mathjs (see https://github.com/josdejong/mathjs/blob/develop/HISTORY.md#2024-01-12-1230) so we could drop the workaround now.

if (inputValue && inputValue.length) {
const value = Array.from(
inputValue,
(iValue) => unit(iValue, inputUnit).to(newUnit).toJSON().value,
);
return { valueSI: value, unitSI: newUnit };
} else {
return { valueSI: inputValue, unitSI: newUnit };
}
} catch (error) {
console.error(error);
return { valueSI: inputValue, unitSI: inputUnit };
}
};

export const convertToSI = (
inputValue: number,
inputUnit: string,
): { valueSI: number; unitSI: string } => {
try {
const quantity = unit(inputValue, inputUnit).toSI().toJSON();
// Workaround related to a bug reported at https://github.com/josdejong/mathjs/issues/3097 and https://github.com/josdejong/mathjs/issues/2499
const quantity = unit(inputValue, inputUnit)
.to(unit(inputUnit).toSI().toJSON().unit)
.toJSON();
return { valueSI: Number(quantity.value), unitSI: quantity.unit };
} catch (error) {
console.error(error);
Expand Down Expand Up @@ -45,8 +69,19 @@ export const appendSIUnitToPhysicalQuantity = <T extends object>(object: T) => {
] as unknown as number;
}
});

if (value !== undefined && unit && unit.length > 0) {
if (
value !== undefined &&
Array.isArray(value) &&
unit &&
unit.length > 0
) {
const { valueSI, unitSI } = convertArrayToSI(value, unit);
updatedObject[key as keyof T] = {
...instance,
valueSI,
unitSI,
};
} else if (value !== undefined && unit && unit.length > 0) {
const { valueSI, unitSI } = convertToSI(value, unit);
updatedObject[key as keyof T] = {
...instance,
Expand Down