Merge pull request #4 from telerik/exception-handling

Improve error handling

Author: ggkrustev

docs/cldr/index.md

@@ -18,7 +18,7 @@ The table below lists the data which is required for number and date formatting
 
 | FORMATS            | REQUIRED DATA                          |
 |:---                |:---                                    |
-| Any                | `cldr/supplemental/likelySubtags.json` |   
+| Any                | `cldr/supplemental/likelySubtags.json` |
 | Basic numbers      | `cldr/main/locale/numbers.json`        |
 | Currency           | `cldr/main/locale/currencies.json` and `cldr/supplemental/currencyData.json` |
 | Basic dates        | `cldr/main/locale/ca-gregorian.json`   |
@@ -30,6 +30,34 @@ Unicode CLDR is available as JSON at [https://github.com/unicode-cldr/](https://
 
 It is also available as a single [cldr-data](https://www.npmjs.com/package/cldr-data) package.
 
+## Loading CLDR Data
+
+Load the CLDR data using the [`load`]({% cldrapi_internalization %}#load) method.
+
+```
+import { cldr, load } from '@telerik/kendo-intl';
+
+const likelySubtags = require("cldr-data/supplemental/likelySubtags.json");
+const numbers = require("cldr-data/main/bg/numbers.json");
+const timeZoneNames = require("cldr-data/main/bg/timeZoneNames.json");
+const calendar = require("cldr-data/main/bg/ca-gregorian.json");
+const currencies = require("cldr-data/main/bg/currencies.json");
+const weekData = require("cldr-data/supplemental/weekData.json");
+const currencyData = require("cldr-data/supplemental/currencyData.json");
+
+load(
+    likelySubtags,
+    weekData,
+    currencyData,
+    numbers,
+    currencies,
+    calendar,
+    timeZoneNames
+);
+
+//the `cldr` object will consist the loaded data
+```
+
 ## Suggested Links
 
 * [API Reference of the CLDR Module]({% slug cldrapi_internalization %})

docs/errors.md

@@ -0,0 +1,32 @@
+---
+title: Errors
+page_title: Errors | Kendo UI Internationalization Package
+description: "List of possible exceptions that the package could throw."
+slug: errors_internalization_kendoui
+position: 6
+---
+
+# Errors list
+
+Below is the list of all controlled errors that could be thrown:
+
+| Type                         | Message
+|:---                          |:---
+|`NoLocaleError`               | Missing locale info for {locale}
+|`NoCurrencyError`             | Cannot determine currency information. Please load the locale currencies data.
+|`NoSupplementalCurrencyError` | Cannot determine currency. Please load the supplemental currencyData.
+|`NoCurrencyRegionError`       | No currency data for region ${territory}
+|`NoCurrencyDisplay`           | Cannot determine currency display information. Please load the locale currencies data. The default culture does not include the all currencies data.
+|`NoGMTInfoError`              | Cannot determine locale GMT format. Please load the locale timeZoneNames data.
+|`NoWeekDataError`             | Cannot determine locale first day of week. Please load the supplemental weekData.
+|`NoFirstDayError`             | Cannot determine locale first day of week. The default culture data includes only en-US first day info. Please load the supplemental weekData.
+
+## Suggested Links
+
+Articles on the Kendo UI Internationalization components:
+
+* [Get Started with CLDR]({% slug cldrdata_overview_internalization %})
+* [Get Started with Date Parsing]({% slug dateparsing_internalization %})
+* [Get Started with Date Formatting]({% slug dateformatting_internalization %})
+* [Get Started with Number Parsing]({% slug numberparsing_internalization %})
+* [Get Started with Number Formatting]({% slug numbeformatting_internalization %})

src/cldr/currency.js

@@ -1,5 +1,13 @@
 import { cldr, getLocaleInfo } from './info';
 import localeTerritory from './territory';
+import { errors } from '../errors';
+
+const {
+    NoCurrency,
+    NoCurrencyDisplay,
+    NoSupplementalCurrency,
+    NoCurrencyRegion
+} = errors;
 
 const DEFAULT_CURRENCY_FRACTIONS = 2;
 const SYMBOL = "symbol";
@@ -8,10 +16,16 @@ function getCurrencyInfo(locale, currency) {
     const info = getLocaleInfo(locale);
     const currencies = info.numbers.currencies;
     if (!currencies) {
-        throw new Error("Cannot determine currency information. Please load the locale currencies data.");
+        throw NoCurrency.error();
+    }
+
+    const currencyDisplayInfo = currencies[currency];
+
+    if (!currencyDisplayInfo) {
+        throw NoCurrencyDisplay.error();
     }
 
-    return currencies[currency];
+    return currencyDisplayInfo;
 }
 
 function lengthComparer(a, b) {
@@ -74,12 +88,12 @@ export function currencyFractionOptions(code) {
 export function territoryCurrencyCode(territory) {
     const currencyData = cldr.supplemental.currencyData;
     if (!currencyData) {
-        throw new Error("Cannot determine currency. Please load the supplemental currencyData.");
+        throw NoSupplementalCurrency.error();
     }
 
     const regionCurrencies = currencyData.region[territory];
     if (!regionCurrencies) {
-        throw new Error("No currency data for region " + territory);
+        throw NoCurrencyRegion.error();
     }
     const currencyCode = Object.keys(regionCurrencies[regionCurrencies.length - 1])[0];
 

src/cldr/first-day.js

@@ -1,16 +1,24 @@
 import { cldr, getLocaleInfo } from './info';
 import localeTerritory from './territory';
 
+import { errors } from '../errors';
+
+const { NoWeekData, NoFirstDay } = errors;
+
 const DAYS = [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ];
 
 export default function firstDay(locale) {
     const weekData = cldr.supplemental.weekData;
     if (!weekData) {
-        throw new Error("Cannot determine locale first day of week. Please load the supplemental weekData.");
+        throw NoWeekData.error();
     }
 
     const info = getLocaleInfo(locale);
     const firstDay = weekData.firstDay[localeTerritory(info)];
 
+    if (!firstDay) {
+        throw NoFirstDay.error();
+    }
+
     return DAYS.indexOf(firstDay);
-}
+}

src/cldr/info.js

@@ -1,4 +1,5 @@
 import defaultData from './default-data';
+import { errors } from '../errors';
 
 function availableLocaleInfo(fullName, suffixes) {
     const parts = fullName.split("-");
@@ -53,5 +54,5 @@ export function localeInfo(locale) {
         }
     }
 
-    throw new Error("Missing locale info for: " + locale);
-}
+    throw errors.NoLocale.error(locale);
+}

src/cldr/territory.js

@@ -29,4 +29,4 @@ export default function localeTerritory(info) {
     info.territory = territory;
 
     return territory;
-}
+}

src/dates/parse-date.js

@@ -1,5 +1,6 @@
 import { adjustDST, convertTimeZone } from './time-utils';
 import { localeInfo } from '../cldr';
+import { errors } from '../errors';
 import formatNames from './format-names';
 import datePattern from './date-pattern';
 import round from '../common/round';
@@ -112,7 +113,7 @@ function checkLiteral(state) {
 function calendarGmtFormats(calendar) {
     const { gmtFormat, gmtZeroFormat } = calendar;
     if (!gmtFormat) {
-        throw new Error("Cannot determine locale GMT format. Please load the locale timeZoneNames data.");
+        throw errors.NoGMTInfo.error();
     }
 
     return [ gmtFormat.replace(PLACEHOLDER, "").toLowerCase(), gmtZeroFormat.replace(PLACEHOLDER, "").toLowerCase() ];
@@ -549,4 +550,4 @@ export default function parseDate(value, formats, locale = "en") {
     }
 
     return date;
-}
+}

src/error-details.js

@@ -0,0 +1,13 @@
+//The error is represented by unique name and corresponding message
+//The message can contain placeholders with index, e.g. {0}, {1}
+
+export default {
+    "NoLocale": "Missing locale info for '{0}'",
+    "NoCurrency": "Cannot determine currency information. Please load the locale currencies data.",
+    "NoSupplementalCurrency": "Cannot determine currency. Please load the supplemental currencyData.",
+    "NoCurrencyRegion": "No currency data for region '{0}'",
+    "NoCurrencyDisplay": "Cannot determine currency display information. Please load the locale currencies data. The default culture does not include the all currencies data.",
+    "NoGMTInfo": "Cannot determine locale GMT format. Please load the locale timeZoneNames data.",
+    "NoWeekData": "Cannot determine locale first day of week. Please load the supplemental weekData.",
+    "NoFirstDay": "Cannot determine locale first day of week. Please load the supplemental weekData. The default culture includes only the 'en-US' first day info."
+};

src/errors.d.ts

@@ -0,0 +1,11 @@
+declare class IntlError {
+    name: string;
+    message: string;
+    constructor(error: { name: string, message: string });
+    formatMessage(...values: any[]): string;
+    error(...values: any[]): Error;
+}
+declare const errors: any;
+declare const toIntlErrors: (errors: { [x: string]: string; }) => { [x: string]: IntlError };
+
+export { errors, IntlError, toIntlErrors };

src/errors.js

@@ -0,0 +1,52 @@
+import errorDetails from './error-details';
+
+const formatRegExp = /\{(\d+)}?\}/g;
+
+class IntlError {
+    name = "";
+    message = "";
+
+    constructor({ name, message }) {
+        if (!name || !message) {
+            throw new Error("{ name: string, message: string } object is required!");
+        }
+
+        this.name = name;
+        this.message = message;
+    }
+
+    formatMessage(...values) {
+        const flattenValues = flatten(values);
+
+        const formattedMessage = this.message.replace(formatRegExp, function(match, index) {
+            return flattenValues[parseInt(index, 10)];
+        });
+
+        return `${this.name}: ${formattedMessage}`;
+    }
+
+    error(...values) {
+        return new Error(this.formatMessage(values));
+    }
+}
+
+const flatten = function(arr) {
+    return arr.reduce((a, b) => a.concat(b), []);
+};
+
+const mapErrors = function(errors) {
+    const predicate = function(prev, name) {
+        prev[name] = new IntlError({ name, message: errors[name] });
+        return prev;
+    };
+
+    return Object.keys(errors).reduce(predicate, {});
+};
+
+const errors = mapErrors(errorDetails);
+
+export {
+    errors,
+    mapErrors,
+    IntlError
+};