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

Use error objects #38

Merged
merged 2 commits into from
Apr 24, 2019
Merged

Use error objects #38

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
41a8e6a
use error objects
calvinmetcalf Apr 24, 2019
7a85d76
add tests
calvinmetcalf Apr 24, 2019
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
33 changes: 18 additions & 15 deletions mgrs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,23 @@ export function forward(ll, accuracy) {
accuracy = accuracy || 5; // default accuracy 1m

if (!Array.isArray(ll)) {
throw ('forward did not receive an array');
throw new TypeError('forward did not receive an array');
}

if (typeof ll[0] === 'string' || typeof ll[1] === 'string') {
throw ('forward received an array of strings, but it only accepts an array of numbers.');
throw new TypeError('forward received an array of strings, but it only accepts an array of numbers.');
}

const [ lon, lat ] = ll;
if (lon < -180 || lon > 180) {
throw (`forward received an invalid longitude of ${lon}`);
throw new TypeError(`forward received an invalid longitude of ${lon}`);
}
if (lat < -90 || lat > 90) {
throw (`forward received an invalid latitude of ${lat}`);
throw new TypeError(`forward received an invalid latitude of ${lat}`);
}

if (lat < -80 || lat > 84) {
throw (`forward received a latitude of ${lat}, but this library does not support conversions of points in polar regions below 80°S and above 84°N`);
throw new TypeError(`forward received a latitude of ${lat}, but this library does not support conversions of points in polar regions below 80°S and above 84°N`);
}

return encode(LLtoUTM({ lat, lon }), accuracy);
Expand All @@ -87,7 +87,7 @@ export function inverse(mgrs) {

export function toPoint(mgrs) {
if (mgrs === '') {
throw (`toPoint received a blank string`);
throw new TypeError(`toPoint received a blank string`);
}
const bbox = UTMtoLL(decode(mgrs.toUpperCase()));
if (bbox.lat && bbox.lon) {
Expand Down Expand Up @@ -503,7 +503,7 @@ function getLetter100kID(column, row, parm) {
function decode(mgrsString) {

if (mgrsString && mgrsString.length === 0) {
throw ('MGRSPoint coverting from nothing');
throw new TypeError('MGRSPoint coverting from nothing');
}

const length = mgrsString.length;
Expand All @@ -516,7 +516,7 @@ function decode(mgrsString) {
// get Zone number
while (!(/[A-Z]/).test(testChar = mgrsString.charAt(i))) {
if (i >= 2) {
throw (`MGRSPoint bad conversion from: ${mgrsString}`);
throw new Error(`MGRSPoint bad conversion from: ${mgrsString}`);
}
sb += testChar;
i++;
Expand All @@ -527,14 +527,14 @@ function decode(mgrsString) {
if (i === 0 || i + 3 > length) {
// A good MGRS string has to be 4-5 digits long,
// ##AAA/#AAA at least.
throw (`MGRSPoint bad conversion from ${mgrsString}`);
throw new Error(`MGRSPoint bad conversion from ${mgrsString}`);
}

const zoneLetter = mgrsString.charAt(i++);

// Should we check the zone letter here? Why not.
if (zoneLetter <= 'A' || zoneLetter === 'B' || zoneLetter === 'Y' || zoneLetter >= 'Z' || zoneLetter === 'I' || zoneLetter === 'O') {
throw (`MGRSPoint zone letter ${zoneLetter} not handled: ${mgrsString}`);
throw new Error(`MGRSPoint zone letter ${zoneLetter} not handled: ${mgrsString}`);
}

hunK = mgrsString.substring(i, i += 2);
Expand All @@ -556,7 +556,10 @@ function decode(mgrsString) {
const remainder = length - i;

if (remainder % 2 !== 0) {
throw (`MGRSPoint has to have an even number \nof digits after the zone letter and two 100km letters - front \nhalf for easting meters, second half for \nnorthing meters ${mgrsString}`);
throw new Error(`MGRSPoint has to have an even number
of digits after the zone letter and two 100km letters - front
half for easting meters, second half for
northing meters ${mgrsString}`);
}

const sep = remainder / 2;
Expand Down Expand Up @@ -611,7 +614,7 @@ function getEastingFromChar(e, set) {
}
if (curCol > Z) {
if (rewindMarker) {
throw (`Bad character: ${e}`);
throw new Error(`Bad character: ${e}`);
}
curCol = A;
rewindMarker = true;
Expand Down Expand Up @@ -641,7 +644,7 @@ function getEastingFromChar(e, set) {
function getNorthingFromChar(n, set) {

if (n > 'V') {
throw (`MGRSPoint given invalid Northing ${n}`);
throw new TypeError(`MGRSPoint given invalid Northing ${n}`);
}

// rowOrigin is the letter at the origin of the set for the
Expand All @@ -662,7 +665,7 @@ function getNorthingFromChar(n, set) {
// when 'n' is a wrong character
if (curRow > V) {
if (rewindMarker) { // making sure that this loop ends
throw (`Bad character: ${n}`);
throw new Error(`Bad character: ${n}`);
}
curRow = A;
rewindMarker = true;
Expand Down Expand Up @@ -753,7 +756,7 @@ function getMinNorthing(zoneLetter) {
return northing;
}
else {
throw (`Invalid zone letter: ${zoneLetter}`);
throw new TypeError(`Invalid zone letter: ${zoneLetter}`);
}

}
26 changes: 19 additions & 7 deletions test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,44 +50,56 @@ describe ('data validation', () => {
it('toPoint throws an error when a blank string is passed in', () => {
try {
mgrs.toPoint('');
false.should.be.true; // to make sure it errors
} catch (error) {
error.should.equal('toPoint received a blank string');
error.should.be.a('error');
error.message.should.equal('toPoint received a blank string');
}
});
it('forward throws an error when array of strings passed in', () => {
try {
mgrs.forward(['40', '40']);
false.should.be.true; // to make sure it errors
} catch (error) {
error.should.equal('forward received an array of strings, but it only accepts an array of numbers.');
error.should.be.a('error');
error.message.should.equal('forward received an array of strings, but it only accepts an array of numbers.');
}
});
it('forward throws an error when longitude is outside bounds', () => {
try {
mgrs.forward([90, 180]);
false.should.be.true; // to make sure it errors
} catch (error) {
error.should.equal('forward received an invalid latitude of 180');
error.should.be.a('error');
error.message.should.equal('forward received an invalid latitude of 180');
}
});
it('forward throws an error when latitude is outside bounds', () => {
try {
mgrs.forward([90, 270]);
false.should.be.true; // to make sure it errors
} catch (error) {
error.should.equal('forward received an invalid latitude of 270');
error.should.be.a('error');
error.message.should.equal('forward received an invalid latitude of 270');
}
});
it('forward throws an error when latitude is near the north pole', () => {
try {
mgrs.forward([45, 88]);
false.should.be.true; // to make sure it errors
} catch (error) {
error.should.equal('forward received a latitude of 88, but this library does not support conversions of points in polar regions below 80°S and above 84°N');
error.should.be.a('error');
error.message.should.equal('forward received a latitude of 88, but this library does not support conversions of points in polar regions below 80°S and above 84°N');
}
});
it('forward throws an error when latitude is near the south pole', () => {
try {
mgrs.forward([45, -88]);
false.should.be.true; // to make sure it errors
} catch (error) {
error.should.equal('forward received a latitude of -88, but this library does not support conversions of points in polar regions below 80°S and above 84°N');
error.should.be.a('error');
error.message.should.equal('forward received a latitude of -88, but this library does not support conversions of points in polar regions below 80°S and above 84°N');
}
});
});
});
});