11399087130

Committed 18 Oct 2024 07:05AM UTC coverage: 86.915% (-0.02%) from 86.935%

Build # 11399087130

Build Type

Pull #2436

github

Committed by

web-flow

Commit Message

Merge 553960bc2 into f8021b4be

Pull Request Pull Request #2436: refacto: migrate Crs to typescript

Run Details

2797 of 3715 branches covered (75.29%)

Branch coverage included in aggregate %.

178 of 185 new or added lines in 1 file covered. (96.22%)

69 existing lines in 11 files now uncovered.

24371 of 27543 relevant lines covered (88.48%)

1021.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.01

/src/Core/Geographic/Crs.ts

import proj4 from 'proj4';

import type { ProjectionDefinition } from 'proj4';

proj4.defs('EPSG:4978', '+proj=geocent +datum=WGS84 +units=m +no_defs');

/**
 * A projection as a CRS identifier string.
 */
export type ProjectionLike = string;

function isString(s: unknown): s is string {
    return typeof s === 'string' || s instanceof String;
}

function mustBeString(crs: string) {
    if (!isString(crs)) {
        throw new Error(`Crs parameter value must be a string: '${crs}'`);
    }
}

function isTms(crs: string) {
    return isString(crs) && crs.startsWith('TMS');
}

function isEpsg(crs: string) {
    return isString(crs) && crs.startsWith('EPSG');
}

function formatToTms(crs: string) {
    mustBeString(crs);
    return isTms(crs) ? crs : `TMS:${crs.match(/\d+/)?.[0]}`;
}

function formatToEPSG(crs: string) {
    mustBeString(crs);
    return isEpsg(crs) ? crs : `EPSG:${crs.match(/\d+/)?.[0]}`;
}

const UNIT = {
    DEGREE: 1,
    METER: 2,
} as const;

function is4326(crs: ProjectionLike) {
    return crs === 'EPSG:4326';
}

function isGeocentric(crs: ProjectionLike) {
    mustBeString(crs);
    const projection = proj4.defs(crs);
    return !projection ? false : projection.projName == 'geocent';
}

function _unitFromProj4Unit(proj: ProjectionDefinition) {
    if (proj.units === 'degrees') {
        return UNIT.DEGREE;
    } else if (proj.units === 'm') {
        return UNIT.METER;
    } else if (proj.units === undefined && proj.to_meter === undefined) {
        // See https://proj.org/en/9.4/usage/projections.html [17/10/2024]
        // > The default unit for projected coordinates is the meter.
        return UNIT.METER;
    } else {
        return undefined;
    }
}

function toUnit(crs: ProjectionLike) {
    mustBeString(crs);
    const p = proj4.defs(formatToEPSG(crs));
    if (!p) {
        return undefined;
    }
    return _unitFromProj4Unit(p);
}

/**
 * This module provides basic methods to manipulate a CRS.
 */
export default {
    /**
     * Units that can be used for a CRS.
     */
    UNIT,

    /**
     * Assert that the CRS is a valid one.
     *
     * @param crs - The CRS to validate.
     *
     * @throws {@link Error} if the CRS is not valid.
     */
    isValid(crs: ProjectionLike) {
        const proj = proj4.defs(crs);
        if (!proj) {
            throw new Error(`Undefined crs '${crs}'. Add it with proj4.defs('${crs}', string)`);
        }
        if (!_unitFromProj4Unit(proj)) {
            throw new Error(`No valid unit found for crs '${crs}', found ${proj.units}`);
        }
    },

    /**
     * Assert that the CRS is geographic.
     *
     * @param crs - The CRS to validate.
     * @throws {@link Error} if the CRS is not valid.
     */
    isGeographic(crs: ProjectionLike) {
        return (toUnit(crs) == UNIT.DEGREE);
    },

    /**
     * Assert that the CRS is using metric units.
     *
     * @param crs - The CRS to validate.
     * @throws {@link Error} if the CRS is not valid.
     */
    isMetricUnit(crs: ProjectionLike) {
        return (toUnit(crs) == UNIT.METER);
    },

    /**
     * Get the unit to use with the CRS.
     *
     * @param crs - The CRS to get the unit from.
     * @returns Either `UNIT.METER`, `UNIT.DEGREE` or `undefined`.
     */
    toUnit,

    /**
     * Is the CRS EPSG:4326?
     *
     * @param crs - The CRS to test.
     */
    is4326,
    /**
     * Is the CRS geocentric?
     * if crs isn't defined the method returns false.
     *
     * @param crs - The CRS to test.
     */
    isGeocentric,

    /**
     * Give a reasonnable epsilon to use with this CRS.
     *
     * @param crs - The CRS to use.
     * @returns 0.01 if the CRS is EPSG:4326, 0.001 otherwise.
     */
    reasonnableEpsilon(crs: ProjectionLike) {
        if (is4326(crs)) {
            return 0.01;
        } else {
            return 0.001;
        }
    },
    /**
     * Format crs to European Petroleum Survey Group notation: EPSG:XXXX.
     *
     * @param crs - The crs to format
     * @returns formated crs
     */
    formatToEPSG,
    /**
     * Format crs to tile matrix set notation: TMS:XXXX.
     *
     * @param crs - The crs to format
     * @returns formated crs
     */
    formatToTms,
    isTms,
    isEpsg,
    tms_3857: 'TMS:3857',
    tms_4326: 'TMS:4326',
    /**
     * Define a proj4 projection as a string and reference.
     *
     * @param code - projection's SRS code (only used internally by the Proj4js
     * library)
     * @param proj4def - Proj4 definition string for the projection to use
     */
    defs: (code: string, proj4def: string) => proj4.defs(code, proj4def),
};

1	import proj4 from 'proj4';	1✔
2		1✔
3	import type { ProjectionDefinition } from 'proj4';	1✔
4		1✔
5	proj4.defs('EPSG:4978', '+proj=geocent +datum=WGS84 +units=m +no_defs');	1✔
6		1✔
7	/**	1✔
8	* A projection as a CRS identifier string.	1✔
9	*/	1✔
10	export type ProjectionLike = string;	1✔
11		1✔
12	function isString(s: unknown): s is string {	2,847✔
13	return typeof s === 'string' \|\| s instanceof String;	2,847!
14	}	2,847✔
15		1✔
16	function mustBeString(crs: string) {	1,442✔
17	if (!isString(crs)) {	1,442!
NEW 18	throw new Error(`Crs parameter value must be a string: '${crs}'`);	×
NEW 19	}	×
20	}	1,442✔
21		1✔
22	function isTms(crs: string) {	1,039✔
23	return isString(crs) && crs.startsWith('TMS');	1,039✔
24	}	1,039✔
25		1✔
26	function isEpsg(crs: string) {	366✔
27	return isString(crs) && crs.startsWith('EPSG');	366✔
28	}	366✔
29		1✔
30	function formatToTms(crs: string) {	431✔
31	mustBeString(crs);	431✔
32	return isTms(crs) ? crs : `TMS:${crs.match(/\d+/)?.[0]}`;	431✔
33	}	431✔
34		1✔
35	function formatToEPSG(crs: string) {	366✔
36	mustBeString(crs);	366✔
37	return isEpsg(crs) ? crs : `EPSG:${crs.match(/\d+/)?.[0]}`;	366✔
38	}	366✔
39		1✔
40	const UNIT = {	1✔
41	DEGREE: 1,	1✔
42	METER: 2,	1✔
43	} as const;	1✔
44		1✔
45	function is4326(crs: ProjectionLike) {	3,137✔
46	return crs === 'EPSG:4326';	3,137✔
47	}	3,137✔
48		1✔
49	function isGeocentric(crs: ProjectionLike) {	619✔
50	mustBeString(crs);	619✔
51	const projection = proj4.defs(crs);	619✔
52	return !projection ? false : projection.projName == 'geocent';	619!
53	}	619✔
54		1✔
55	function _unitFromProj4Unit(proj: ProjectionDefinition) {	1,338✔
56	if (proj.units === 'degrees') {	1,338✔
57	return UNIT.DEGREE;	801✔
58	} else if (proj.units === 'm') {	1,338✔
59	return UNIT.METER;	535✔
60	} else if (proj.units === undefined && proj.to_meter === undefined) {	537!
NEW 61	// See https://proj.org/en/9.4/usage/projections.html [17/10/2024]	×
NEW 62	// > The default unit for projected coordinates is the meter.	×
NEW 63	return UNIT.METER;	×
64	} else {	2✔
65	return undefined;	2✔
66	}	2✔
67	}	1,338✔
68		1✔
69	function toUnit(crs: ProjectionLike) {	26✔
70	mustBeString(crs);	26✔
71	const p = proj4.defs(formatToEPSG(crs));	26✔
72	if (!p) {	26!
NEW 73	return undefined;	×
NEW 74	}	×
75	return _unitFromProj4Unit(p);	26✔
76	}	26✔
77		1✔
78	/**	1✔
79	* This module provides basic methods to manipulate a CRS.	1✔
80	*/	1✔
81	export default {	1✔
82	/**	1✔
83	* Units that can be used for a CRS.	1✔
84	*/	1✔
85	UNIT,	1✔
86		1✔
87	/**	1✔
88	* Assert that the CRS is a valid one.	1✔
89	*	1✔
90	* @param crs - The CRS to validate.	1✔
91	*	1✔
92	* @throws {@link Error} if the CRS is not valid.	1✔
93	*/	1✔
94	isValid(crs: ProjectionLike) {	1✔
95	const proj = proj4.defs(crs);	1,313✔
96	if (!proj) {	1,313✔
97	throw new Error(`Undefined crs '${crs}'. Add it with proj4.defs('${crs}', string)`);	1✔
98	}	1✔
99	if (!_unitFromProj4Unit(proj)) {	1,313✔
100	throw new Error(`No valid unit found for crs '${crs}', found ${proj.units}`);	1✔
101	}	1✔
102	},	1✔
103		1✔
104	/**	1✔
105	* Assert that the CRS is geographic.	1✔
106	*	1✔
107	* @param crs - The CRS to validate.	1✔
108	* @throws {@link Error} if the CRS is not valid.	1✔
109	*/	1✔
110	isGeographic(crs: ProjectionLike) {	1✔
111	return (toUnit(crs) == UNIT.DEGREE);	17✔
112	},	1✔
113		1✔
114	/**	1✔
115	* Assert that the CRS is using metric units.	1✔
116	*	1✔
117	* @param crs - The CRS to validate.	1✔
118	* @throws {@link Error} if the CRS is not valid.	1✔
119	*/	1✔
120	isMetricUnit(crs: ProjectionLike) {	1✔
121	return (toUnit(crs) == UNIT.METER);	4✔
122	},	1✔
123		1✔
124	/**	1✔
125	* Get the unit to use with the CRS.	1✔
126	*	1✔
127	* @param crs - The CRS to get the unit from.	1✔
128	* @returns Either `UNIT.METER`, `UNIT.DEGREE` or `undefined`.	1✔
129	*/	1✔
130	toUnit,	1✔
131		1✔
132	/**	1✔
133	* Is the CRS EPSG:4326?	1✔
134	*	1✔
135	* @param crs - The CRS to test.	1✔
136	*/	1✔
137	is4326,	1✔
138	/**	1✔
139	* Is the CRS geocentric?	1✔
140	* if crs isn't defined the method returns false.	1✔
141	*	1✔
142	* @param crs - The CRS to test.	1✔
143	*/	1✔
144	isGeocentric,	1✔
145		1✔
146	/**	1✔
147	* Give a reasonnable epsilon to use with this CRS.	1✔
148	*	1✔
149	* @param crs - The CRS to use.	1✔
150	* @returns 0.01 if the CRS is EPSG:4326, 0.001 otherwise.	1✔
151	*/	1✔
152	reasonnableEpsilon(crs: ProjectionLike) {	1✔
153	if (is4326(crs)) {	2✔
154	return 0.01;	1✔
155	} else {	1✔
156	return 0.001;	1✔
157	}	1✔
158	},	1✔
159	/**	1✔
160	* Format crs to European Petroleum Survey Group notation: EPSG:XXXX.	1✔
161	*	1✔
162	* @param crs - The crs to format	1✔
163	* @returns formated crs	1✔
164	*/	1✔
165	formatToEPSG,	1✔
166	/**	1✔
167	* Format crs to tile matrix set notation: TMS:XXXX.	1✔
168	*	1✔
169	* @param crs - The crs to format	1✔
170	* @returns formated crs	1✔
171	*/	1✔
172	formatToTms,	1✔
173	isTms,	1✔
174	isEpsg,	1✔
175	tms_3857: 'TMS:3857',	1✔
176	tms_4326: 'TMS:4326',	1✔
177	/**	1✔
178	* Define a proj4 projection as a string and reference.	1✔
179	*	1✔
180	* @param code - projection's SRS code (only used internally by the Proj4js	1✔
181	* library)	1✔
182	* @param proj4def - Proj4 definition string for the projection to use	1✔
183	*/	1✔
184	defs: (code: string, proj4def: string) => proj4.defs(code, proj4def),	1✔
185	};	1✔

iTowns / itowns / 11399087130

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous