Skip to content
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

Jump to bottom

Universal Sentence Formatting #3411

Merged
merged 2 commits into from
May 14, 2018
Merged

Universal Sentence Formatting #3411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8b82d0
Updates all widget dynamic sentences to have consistent sig figs and …
01painadam May 14, 2018
cde6e15
Fixes intact cover % and plantations cover to lower case
01painadam May 14, 2018
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
6 changes: 3 additions & 3 deletions app/javascript/components/widgets/widgets/climate/emissions/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ export const getSentence = createSelector(
typeof accumulator !== 'object'
? accumulator
: accumulator.emissions
.map(a => a.value)
.reduce((iSum, value) => iSum + value);
.map(a => a.value)
.reduce((iSum, value) => iSum + value);
const itemCount = item.emissions
.map(a => a.value)
.reduce((iSum, value) => iSum + value);
Expand All @@ -137,7 +137,7 @@ export const getSentence = createSelector(
percentage:
Math.abs(emissionFraction) < 0.1
? '<0.1%'
: `${format('.1f')(Math.abs(emissionFraction))}%`,
: `${format('.2r')(Math.abs(emissionFraction))}%`,
value: `${format('.3s')(
Math.abs(emissionsCount / (endYear - startYear))
)}tCO₂e/yr`,
Expand Down
9 changes: 5 additions & 4 deletions app/javascript/components/widgets/widgets/forest-change/glad-ranked/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ export const parseData = createSelector(
return {
id: k,
color: colors.main,
percentage: countsAreaPerc,
percentage:
countsAreaPerc >= 0.1 ? `${format('.2r')(countsAreaPerc)}%` : '<0.1%',
countsPerHa,
count: counts,
area: countsArea,
Expand Down Expand Up @@ -109,11 +110,11 @@ export const getSentence = createSelector(
const params = {
timeframe: options.weeks.find(w => w.value === settings.weeks).label,
count: format(',')(sumBy(data, 'count')),
area: `${format('.2s')(sumBy(data, 'area'))}ha`,
topPercent: `${format('.2s')(topCount)}%`,
area: `${format('.3s')(sumBy(data, 'area'))}ha`,
topPercent: `${format('.2r')(topCount)}%`,
topRegions: percentileLength,
location: currentLabel,
indicator: `${indicator ? `${indicator.label} in ` : ''}`
indicator: `${indicator ? `${indicator.label.toLowerCase()} in ` : ''}`
};
return { sentence: initial, params };
}
Expand Down
6 changes: 3 additions & 3 deletions app/javascript/components/widgets/widgets/forest-change/tree-cover-gain/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@ export const getSentence = createSelector(
location: currentLabel === 'global' ? 'globally' : currentLabel,
gain: `${format('.3s')(gain)}ha`,
indicator: (indicator && indicator.label.toLowerCase()) || 'region-wide',
percent: areaPercent >= 0.1 ? `${format('.1f')(areaPercent)}%` : '<0.1%',
percent: areaPercent >= 0.1 ? `${format('.2r')(areaPercent)}%` : '<0.1%',
globalPercent:
globalPercent >= 0.1 ? `${format('.1f')(globalPercent)}%` : '<0.1%',
globalPercent >= 0.1 ? `${format('.2r')(globalPercent)}%` : '<0.1%',
gainPercent:
gainPercent >= 0.1 ? `${format('.1f')(gainPercent)}%` : '<0.1%',
gainPercent >= 0.1 ? `${format('.2r')(gainPercent)}%` : '<0.1%',
extentYear: settings.extentYear,
parent: parent && parent.label
};
Expand Down
8 changes: 4 additions & 4 deletions app/javascript/components/widgets/widgets/forest-change/tree-gain-located/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,18 +98,18 @@ export const getSentence = createSelector(
}

const params = {
indicator: indicator && indicator.value,
indicator: indicator && indicator.value.toLowerCase(),
location: currentLabel,
topGain: `${format('.0f')(topGain)}%`,
topGain: `${format('.2r')(topGain)}%`,
percentileLength,
region: percentileLength > 1 ? topRegion.label : 'This region',
value:
topRegion.percentage > 1 && settings.unit === '%'
? `${format('.0f')(topRegion.percentage)}%`
? `${format('.2r')(topRegion.percentage)}%`
: `${format('.3s')(topRegion.gain)}ha`,
average:
topRegion.percentage > 1 && settings.unit === '%'
? `${format('.0f')(avgGainPercentage)}%`
? `${format('.2r')(avgGainPercentage)}%`
: `${format('.3s')(avgGain)}ha`
};

Expand Down
2 changes: 1 addition & 1 deletion app/javascript/components/widgets/widgets/forest-change/tree-loss-global/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ export const getSentence = createSelector(
startYear,
endYear,
loss: `${format('.3s')(totalLoss)}ha`,
percent: `${format('.1f')(percentageLoss)}%`,
percent: `${format('.2r')(percentageLoss)}%`,
emissions: `${format('.3s')(totalEmissions)}t`,
extentYear
};
Expand Down
8 changes: 4 additions & 4 deletions app/javascript/components/widgets/widgets/forest-change/tree-loss-located/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,20 +110,20 @@ export const getSentence = createSelector(
}

const params = {
indicator: indicator && indicator.label,
indicator: indicator && indicator.label.toLowerCase(),
location: currentLabel,
startYear,
endYear,
topLoss: `${format('.0f')(topLoss)}%`,
topLoss: `${format('.2r')(topLoss)}%`,
percentileLength,
region: percentileLength > 1 ? topRegion.label : 'This region',
value:
topRegion.percentage > 1 && settings.unit === '%'
? `${format('.0f')(topRegion.percentage)}%`
? `${format('.2r')(topRegion.percentage)}%`
: `${format('.3s')(topRegion.loss)}ha`,
average:
topRegion.percentage > 1 && settings.unit === '%'
? `${format('.0f')(avgLossPercentage)}%`
? `${format('.2r')(avgLossPercentage)}%`
: `${format('.3s')(avgLoss)}ha`
};

Expand Down
2 changes: 1 addition & 1 deletion app/javascript/components/widgets/widgets/forest-change/tree-loss-plantations/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export const getSentence = createSelector(
startYear,
endYear,
lossPhrase,
value: `${format('.2s')(totalOutsideLoss)}t of CO<sub>2</sub> emissions`
value: `${format('.3s')(totalOutsideLoss)}t of CO<sub>2</sub> emissions`
};

return {
Expand Down
4 changes: 2 additions & 2 deletions app/javascript/components/widgets/widgets/forest-change/tree-loss-ranked/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,9 @@ export const getSentence = createSelector(
startYear,
endYear,
loss: loss ? `${format('.3s')(loss)}ha` : '0ha',
percent: areaPercent >= 0.1 ? `${format('.1f')(areaPercent)}%` : '<0.1%',
percent: areaPercent >= 0.1 ? `${format('.2r')(areaPercent)}%` : '<0.1%',
globalPercent:
globalPercent >= 0.1 ? `${format('.1f')(globalPercent)}%` : '<0.1%',
globalPercent >= 0.1 ? `${format('.2r')(globalPercent)}%` : '<0.1%',
extentYear: settings.extentYear
};

Expand Down
4 changes: 2 additions & 2 deletions app/javascript/components/widgets/widgets/forest-change/tree-loss/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export const parseConfig = createSelector([getColors], colors => ({
{
key: 'percentage',
unit: '%',
unitFormat: value => format('.1f')(value)
unitFormat: value => format('.2r')(value)
}
]
}));
Expand Down Expand Up @@ -100,7 +100,7 @@ export const getSentence = createSelector(
startYear,
endYear,
loss: `${format('.3s')(totalLoss)}ha`,
percent: `${format('.1f')(percentageLoss)}%`,
percent: `${format('.2r')(percentageLoss)}%`,
emissions: `${format('.3s')(totalEmissions)}t`,
extentYear
};
Expand Down
12 changes: 8 additions & 4 deletions app/javascript/components/widgets/widgets/land-cover/fao-cover/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,21 @@ export const getSentence = createSelector(
if (isEmpty(data)) return null;
const { initial, noPrimary, globalInitial, globalNoPrimary } = sentences;
const { area_ha, extent, forest_primary } = data;
const primaryPercent =
forest_primary > 0
? forest_primary / area_ha * 100
: extent / area_ha * 100;

const params = {
location: currentLabel || 'globally',
extent: `${format('.3s')(extent)}ha`,
primaryPercent:
forest_primary > 0
? `${format('.0f')(forest_primary / area_ha * 100)}%`
: `${format('.0f')(extent / area_ha * 100)}%`
primaryPercent >= 0.1 ? `${format('.2r')(primaryPercent)}%` : '<0.1%'
};
let sentence = forest_primary > 0 ? initial : noPrimary;
if (!currentLabel) { sentence = forest_primary > 0 ? globalInitial : globalNoPrimary; }
if (!currentLabel) {
sentence = forest_primary > 0 ? globalInitial : globalNoPrimary;
}
return {
sentence,
params
Expand Down
2 changes: 1 addition & 1 deletion app/javascript/components/widgets/widgets/land-cover/intact-tree-cover/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export const getSentence = createSelector(
percentage:
intactPercentage < 0.1
? '<0.1%'
: `${format('.0f')(intactPercentage)}%`,
: `${format('.2r')(intactPercentage)}%`,
intact: 'intact forest'
};

Expand Down
2 changes: 1 addition & 1 deletion app/javascript/components/widgets/widgets/land-cover/primary-forest/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export const getSentence = createSelector(
percentage:
primaryPercentage < 0.1
? '<0.1%'
: `${format('.0f')(primaryPercentage)}%`,
: `${format('.2r')(primaryPercentage)}%`,
primary: 'primary forest',
extentYear: settings.extentYear
};
Expand Down
6 changes: 3 additions & 3 deletions app/javascript/components/widgets/widgets/land-cover/ranked-plantations/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const getSentences = state => state.config.sentences || null;
const getPlanationKeys = createSelector(
[getPlantations],
plantations =>
plantations ? Object.keys(groupBy(plantations, 'label')) : null
(plantations ? Object.keys(groupBy(plantations, 'label')) : null)
);

export const parseData = createSelector(
Expand Down Expand Up @@ -116,14 +116,14 @@ export const getSentence = createSelector(
),
'value'
);
const plantationLabel = topPlantation.label;
const plantationLabel = topPlantation.label.toLowerCase();
const isPlural = endsWith(plantationLabel, 's');

const params = {
location: currentLabel,
region: topRegion.region,
topType: `${plantationLabel}${isPlural ? 's' : ''} plantations`,
percentage: `${format('.1f')(data[0].total)}%`
percentage: `${format('.2r')(data[0].total)}%`
};

return {
Expand Down
9 changes: 4 additions & 5 deletions app/javascript/components/widgets/widgets/land-cover/tree-cover-located/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@ export const getSentence = createSelector(
const params = {
location: currentLabel === 'global' ? 'Globally' : currentLabel,
region: topRegion.label,
indicator: indicator && indicator.label,
percentage: topExtent ? `${format('.0f')(topExtent)}%` : '0%',
indicator: indicator && indicator.label.toLowerCase(),
percentage: topExtent ? `${format('.2r')(topExtent)}%` : '0%',
value:
settings.unit === '%'
? `${format('.0f')(topRegion.percentage)}%`
? `${format('.2r')(topRegion.percentage)}%`
: `${format('.3s')(topRegion.extent)}ha`,
average:
settings.unit === '%'
? `${format('.0f')(avgExtentPercentage)}%`
? `${format('.2r')(avgExtentPercentage)}%`
: `${format('.3s')(avgExtent)}ha`,
count: percentileLength,
metric: settings.unit === '%' ? 'relative tree cover' : 'tree cover'
Expand All @@ -101,7 +101,6 @@ export const getSentence = createSelector(
} else if (indicator) {
sentence = currentLabel === 'global' ? globalWithIndicator : hasIndicator;
}

return {
sentence,
params
Expand Down
8 changes: 4 additions & 4 deletions app/javascript/components/widgets/widgets/land-cover/tree-cover-plantations/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ export const getSentence = createSelector(

const params = {
location: currentLabel,
firstSpecies: top[0].label,
secondSpecies: top.length > 1 && top[1].label,
firstSpecies: top[0].label.toLowerCase(),
secondSpecies: top.length > 1 && top[1].label.toLowerCase(),
type: settings.type === 'bound2' ? 'species' : 'type',
extent: `${format('.2s')(sumBy(top, 'value'))}ha`,
other: `${format('.2s')(sumBy(data.slice(2), 'value'))}ha`,
extent: `${format('.3s')(sumBy(top, 'value'))}ha`,
other: `${format('.3s')(sumBy(data.slice(2), 'value'))}ha`,
count: data.length - top.length,
topType: `${top[0].label}${endsWith(top[0].label, 's') ? '' : 's'}`
};
Expand Down
4 changes: 2 additions & 2 deletions app/javascript/components/widgets/widgets/land-cover/tree-cover-ranked/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ export const getSentence = createSelector(
extentYear: settings.extentYear,
location: currentLocation.label,
extent: `${extent ? format('.3s')(extent) : '0'}ha`,
indicator: indicator && indicator.value,
indicator: indicator && indicator.value.toLowerCase(),
percentage:
areaPercent >= 0.1 ? `${format('.1f')(areaPercent)}%` : '<0.1%'
areaPercent >= 0.1 ? `${format('.2r')(areaPercent)}%` : '<0.1%'
};

const sentence = indicator ? withInd : initial;
Expand Down
4 changes: 2 additions & 2 deletions app/javascript/components/widgets/widgets/land-cover/tree-cover/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ export const getSentence = createSelector(
const params = {
year: settings.extentYear,
location: currentLabel || 'global',
indicator: indicator && indicator.label,
indicator: indicator && indicator.label.toLowerCase(),
percentage:
percentCover >= 0.1 ? `${format('.1f')(percentCover)}%` : '<0.1%',
percentCover >= 0.1 ? `${format('.2r')(percentCover)}%` : '<0.1%',
value: `${format('.3s')(data.cover)}ha`
};
let sentence = indicator ? withIndicator : initial;
Expand Down
5 changes: 4 additions & 1 deletion app/javascript/components/widgets/widgets/people/economic-impact/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,10 @@ export const getSentence = createSelector(
currentLocation &&
currentLocation.label}'s`,
value: `${formatUSD(selectedFAO[0].net_usd, false)} USD`,
percentage: `${format('.2f')(selectedFAO[0].net_perc)}%`,
percentage:
selectedFAO[0].net_perc >= 0.1
? `${format('2r')(selectedFAO[0].net_perc)}%`
: '<0.1%',
year: settings.year
};

Expand Down
3 changes: 2 additions & 1 deletion app/javascript/components/widgets/widgets/people/forestry-employment/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,14 @@ export const getSentence = createSelector(
: selectedFAO.male;
females = parseInt(selectedFAO.female, 10);
}
const percentage = 100 * females / employees;

const params = {
location: `${currentLocation &&
currentLocation &&
currentLocation.label}'s`,
value: `${employees ? format('.3s')(employees) : 'no'}`,
percent: `${format('.2s')(100 * females / employees)}%`,
percent: percentage >= 0.1 ? `${format('.2r')(percentage)}%` : '<0.1%',
year
};

Expand Down