kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-06 18:35:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add a longForm option to format-duration

Browse Source
This commit is contained in:
Michael Lange
2018-09-24 20:01:42 -07:00
parent f5eaffe59c
commit 9a6d2bee10
3 changed files with 26 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
ui/app/helpers/format-duration.js
View File

@@ -1,8 +1,8 @@
import Helper from '@ember/component/helper';
import formatDuration from '../utils/format-duration';
function formatDurationHelper([duration], { units }) {
return formatDuration(duration, units);
function formatDurationHelper([duration], { units, longForm }) {
return formatDuration(duration, units, longForm);
}
export default Helper.helper(formatDurationHelper);

27
ui/app/utils/format-duration.js
View File

@@ -4,15 +4,26 @@ const allUnits = [
{ name: 'years', suffix: 'year', inMoment: true, pluralizable: true },
{ name: 'months', suffix: 'month', inMoment: true, pluralizable: true },
{ name: 'days', suffix: 'day', inMoment: true, pluralizable: true },
{ name: 'hours', suffix: 'h', inMoment: true, pluralizable: false },
{ name: 'minutes', suffix: 'm', inMoment: true, pluralizable: false },
{ name: 'seconds', suffix: 's', inMoment: true, pluralizable: false },
{ name: 'hours', suffix: 'h', longSuffix: 'hour', inMoment: true, pluralizable: false },
{ name: 'minutes', suffix: 'm', longSuffix: 'minute', inMoment: true, pluralizable: false },
{ name: 'seconds', suffix: 's', longSuffix: 'second', inMoment: true, pluralizable: false },
{ name: 'milliseconds', suffix: 'ms', inMoment: true, pluralizable: false },
{ name: 'microseconds', suffix: 'µs', inMoment: false, pluralizable: false },
{ name: 'nanoseconds', suffix: 'ns', inMoment: false, pluralizable: false },
];
export default function formatDuration(duration = 0, units = 'ns') {
const pluralizeUnits = (amount, unit, longForm) => {
let suffix;
if (longForm && unit.longSuffix) {
suffix = amount === 1 ? unit.longSuffix : unit.longSuffix.pluralize();
} else {
suffix = amount === 1 || !unit.pluralizable ? unit.suffix : unit.suffix.pluralize();
}
const addSpace = unit.pluralizable || (longForm && unit.longSuffix);
return `${amount}${addSpace ? ' ' : ''}${suffix}`;
};
export default function formatDuration(duration = 0, units = 'ns', longForm = false) {
const durationParts = {};
// Moment only handles up to millisecond precision.
@@ -46,9 +57,7 @@ export default function formatDuration(duration = 0, units = 'ns') {
const displayParts = allUnits.reduce((parts, unitType) => {
if (durationParts[unitType.name]) {
const count = durationParts[unitType.name];
const suffix =
count === 1 || !unitType.pluralizable ? unitType.suffix : unitType.suffix.pluralize();
parts.push(`${count}${unitType.pluralizable ? ' ' : ''}${suffix}`);
parts.push(pluralizeUnits(count, unitType, longForm));
}
return parts;
}, []);
@@ -58,7 +67,5 @@ export default function formatDuration(duration = 0, units = 'ns') {
}
// When the duration is 0, show 0 in terms of `units`
const unitTypeForUnits = allUnits.findBy('suffix', units);
const suffix = unitTypeForUnits.pluralizable ? units.pluralize() : units;
return `0${unitTypeForUnits.pluralizable ? ' ' : ''}${suffix}`;
return pluralizeUnits(0, allUnits.findBy('suffix', units), longForm);
}

7
ui/tests/unit/utils/format-duration-test.js
View File

@@ -26,3 +26,10 @@ test('When duration is 0, 0 is shown in terms of the units provided to the funct
assert.equal(formatDuration(0), '0ns', 'formatDuration(0) -> 0ns');
assert.equal(formatDuration(0, 'year'), '0 years', 'formatDuration(0, "year") -> 0 years');
});
test('The longForm option expands suffixes to words', function(assert) {
const expectation1 = '3 seconds 20ms';
const expectation2 = '5 hours 59 minutes';
assert.equal(formatDuration(3020, 'ms', true), expectation1, expectation1);
assert.equal(formatDuration(60 * 5 + 59, 'm', true), expectation2, expectation2);
});