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.

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

Align OL measure number format of tooltip to measure panel's one #3673

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
* Copyright 2019, GeoSolutions Sas.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/
const React = require('react');
const ReactDOM = require('react-dom');
const {createSink} = require('recompose');
const expect = require('expect');
const addI18NProps = require('../addI18NProps');
var Localized = require('../../Localized');


describe('addI18NProps enhancer', () => {
beforeEach((done) => {
document.body.innerHTML = '<div id="container"></div>';
setTimeout(done);
});
afterEach((done) => {
ReactDOM.unmountComponentAtNode(document.getElementById("container"));
document.body.innerHTML = '';
setTimeout(done);
});
it('addI18NProps format with no context', () => {
const Sink = addI18NProps(['formatNumber'])(createSink(props => {
expect(props).toExist();
expect(props.formatNumber).toExist();
// this is the default implementation.
expect(props.formatNumber(1.1)).toBe(1.1);
expect(props.formatNumber(1000)).toBe(1000);
}));
ReactDOM.render(<Sink />, document.getElementById("container"));
});
it('addI18NProps format numbers', () => {
const Sink = addI18NProps(['formatNumber'])(createSink( props => {
expect(props).toExist();
expect(props.formatNumber).toExist();
expect(typeof props.formatNumber(1)).toBe('string');
expect(props.formatNumber(1.1)).toBe("1.1");
expect(props.formatNumber(1000)).toBe("1,000");
}));
ReactDOM.render(<Localized locale="en-EN" messages={{}}>
<Sink />
</Localized>, document.getElementById("container"));
});
});
54 changes: 54 additions & 0 deletions web/client/components/I18N/enhancers/addI18NProps.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/*
* Copyright 2019, GeoSolutions Sas.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/
const {injectIntl} = require('react-intl');
const PropTypes = require('prop-types');
const {omit} = require('lodash');
const { compose, branch, getContext, withProps, withPropsOnChange, mapProps } = require('recompose');

const omitProps = keys => mapProps(props => omit(props, keys));

// TODO: provide better defaults
const defaults = {
locale: navigator && navigator.language,
formats: { },
messages: { },
defaultLocale: 'en',
defaultFormats: {},
formatDate: v => v,
formatTime: v => v,
formatRelative: v => v,
formatNumber: v => v,
formatPlural: v => v,
formatMessage: v => v,
formatHTMLMessage: v => v,
now: () => new Date()
};

/**
* Add i18n functionalities and properties as props. Useful to get format functions when the react-intl components can not be used (i.e. with wrapped libs)
* @name addI18NFormat
* @param {string[]} props add the props to format as props. Should be keys of of this interface https://github.com/yahoo/react-intl/wiki/API#intlshape
* @example
* addI18NProps(['formatNumber'])(MyCmp); // MyCmp will receive `formatNumber` from current locale Intl object as a property
*/
module.exports = (propsToAdd = []) => compose(
Copy link
Contributor

Choose a reason for hiding this comment

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

Not much readable for me.

Copy link
Member Author

Choose a reason for hiding this comment

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

I had to refactor it a bit to support existing tests and manage errors. Please take a look at it now, It could be more readable and better documented.

// check intl and inject (or add default dummy object)
getContext({intl: PropTypes.object}),
branch(
({intl}) => !!intl,
injectIntl,
withProps({intl: defaults})
),
// add propsToAdd properties from intl object
withPropsOnChange(['intl'], ({ intl = {} }) => propsToAdd.reduce((acc = {}, k) => ({
...acc,
[k]: intl[k]
}), {})),
// clean up intl property
omitProps(['intl'])
);
7 changes: 5 additions & 2 deletions web/client/components/map/openlayers/MeasurementSupport.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const PropTypes = require('prop-types');
const {round, isEqual, dropRight, pick} = require('lodash');
const assign = require('object-assign');
const ol = require('openlayers');

const wgs84Sphere = new ol.Sphere(6378137);
const {reprojectGeoJson, reproject, calculateAzimuth, calculateDistance, transformLineToArcs} = require('../../../utils/CoordinatesUtils');
const {convertUom, getFormattedBearingValue} = require('../../../utils/MeasureUtils');
Expand All @@ -30,6 +31,7 @@ class MeasurementSupport extends React.Component {
measurement: PropTypes.object,
enabled: PropTypes.bool,
uom: PropTypes.object,
formatNumber: PropTypes.func,
changeMeasurementState: PropTypes.func,
updateMeasures: PropTypes.func,
resetGeometry: PropTypes.func,
Expand All @@ -46,6 +48,7 @@ class MeasurementSupport extends React.Component {
resetGeometry: () => {},
updateMeasures: () => {},
changeGeometry: () => {},
formatNumber: n => n,
startEndPoint: {
startPointOptions: {
radius: 3,
Expand Down Expand Up @@ -451,7 +454,7 @@ class MeasurementSupport extends React.Component {
const length = calculateDistance(reprojectedCoords, props.measurement.lengthFormula);
const {label, unit} = props.uom && props.uom.length;
const output = round(convertUom(length, "m", unit), 2);
return output + " " + (label);
return this.props.formatNumber(output) + " " + (label);
};

/**
Expand All @@ -464,7 +467,7 @@ class MeasurementSupport extends React.Component {
const {label, unit} = props.uom && props.uom.area;
const output = round(convertUom(area, "sqm", unit), 2);

return output + " " + label;
return this.props.formatNumber(output) + " " + label;
};

removeHelpTooltip = () => {
Expand Down
6 changes: 5 additions & 1 deletion web/client/plugins/map/openlayers/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/
const addI18NProps = require('../../../components/I18N/enhancers/addI18NProps');

// number format localization for measurements
const addFormatNumber = addI18NProps(['formatNumber']);

module.exports = {
LMap: require('../../../components/map/openlayers/Map'),
Layer: require('../../../components/map/openlayers/Layer'),
Feature: require('../../../components/map/openlayers/Feature'),
Locate: require('../../../components/map/openlayers/Locate'),
MeasurementSupport: require('../../../components/map/openlayers/MeasurementSupport'),
MeasurementSupport: addFormatNumber(require('../../../components/map/openlayers/MeasurementSupport')),
Overview: require('../../../components/map/openlayers/Overview'),
ScaleBar: require('../../../components/map/openlayers/ScaleBar'),
DrawSupport: require('../../../components/map/openlayers/DrawSupport'),
Expand Down