refactor(dateFieldName): method accepts DateFieldNameOptions instead of string.

Moved the method to the cldr folder

Author: ggkrustev

src/cldr.d.ts

@@ -32,6 +32,51 @@ export interface DateFormatNameOptions {
  */
 export function dateFormatNames(locale: string, options: DateFormatNameOptions): any;
 
+/**
+ * Settings for the dateFieldName function.
+ */
+export interface DateFieldNameOptions {
+    /**
+     * Specifies the type of names.
+     */
+    type: 'dayPeriods'  |
+          'era'         |
+          'year'        |
+          'quarter'     |
+          'month'       |
+          'week'        |
+          'day'         |
+          'weekday'     |
+          'dayperiod'   |
+          'hour'        |
+          'minute'      |
+          'second'      |
+          'millisecond' |
+          'zone';
+
+    /**
+     * Specifies the names form.
+     */
+    nameType?: 'wide' | 'narrow' | 'short';
+}
+
+/**
+ * Returns a localized date field name based on a specific format specifier.
+ *
+ * @param formatSpecifier The dateFieldName options.
+ * @param locale The optional locale id. If not specified, the `"en"` locale id is used.
+ * @returns The localized date field name determined by the dateFieldName options.
+ *
+ * @example
+ * ```
+ * dateFieldName({ type: 'day' });                      //returns 'day';
+ * dateFieldName({ type: 'day', nameType: 'wide' });    //returns 'day';
+ * dateFieldName({ type: 'month', nameType: 'short' }); //returns 'mo.';
+ * dateFieldName({ type: 'month', nameType: 'wide' });  //returns 'month';
+ * ```
+ */
+export function dateFieldName(formatSpecifier: DateFieldNameOptions, locale?: string): string;
+
 /**
  * Returns the first day index starting from Sunday based on the specified locale.
  *

src/cldr.js

@@ -1,6 +1,7 @@
 export { default as load } from './cldr/load';
+export { default as dateFieldName } from './cldr/date-field-name';
 export { default as dateFormatNames } from './cldr/date-format-names';
 export { cldr, localeInfo } from './cldr/info';
 export { currencyDisplays, currencyDisplay, currencyFractionOptions, territoryCurrencyCode, localeCurrency } from './cldr/currency';
 export { default as firstDay } from './cldr/first-day';
-export { default as numberSymbols } from './cldr/number-symbols';
+export { default as numberSymbols } from './cldr/number-symbols';

src/cldr/date-field-name.js

@@ -0,0 +1,9 @@
+import { localeInfo } from './info';
+
+export default function(options, locale = "en") {
+    const info = localeInfo(locale);
+    const dateFields = info.calendar.dateFields || {};
+    const fieldNameInfo = dateFields[options.type] || {};
+
+    return fieldNameInfo[options.nameType] || fieldNameInfo['wide'];
+}

src/dates.d.ts

@@ -125,19 +125,3 @@ export interface DateFormatPart {
  * @returns The date format parts.
  */
 export function splitDateFormat(format: string|DateFormatOptions, locale?: string): DateFormatPart[];
-
-/**
- * Returns a localized date field name based on a specific format specifier.
- *
- * @param formatSpecifier The format specifier.
- * @param locale The optional locale id. If not specified, the `"en"` locale id is used.
- * @returns The localized date field name determined by the format specifier.
- *
- * @example
- * ```
- * dateFieldName('d'); //returns 'day';
- * dateFieldName('M'); //returns 'mo.';
- * dateFieldName('MMMM'); //returns 'month';
- * ```
- */
-export function dateFieldName(formatSpecifier: string, locale?: string): string;

src/dates.js

@@ -1,4 +1,3 @@
 export { default as formatDate } from './dates/format-date';
 export { default as parseDate } from './dates/parse-date';
 export { default as splitDateFormat } from './dates/split-date-format';
-export { default as dateFieldName } from './dates/date-field-name';

src/dates/date-field-name.js

@@ -1,4 +1,4 @@
-import { load, cldr, localeInfo, dateFormatNames, firstDay, localeCurrency, currencyDisplay, currencyFractionOptions, currencyDisplays, numberSymbols } from '../src/cldr';
+import { load, cldr, localeInfo, dateFieldName, dateFormatNames, firstDay, localeCurrency, currencyDisplay, currencyFractionOptions, currencyDisplays, numberSymbols } from '../src/cldr';
 import { errors } from '../src/errors';
 
 const likelySubtags = require("cldr-data/supplemental/likelySubtags.json");
@@ -366,6 +366,120 @@ describe('dateFormatNames', () => {
     });
 });
 
+describe('dateFieldName', () => {
+    it('should return placeholder for the era type', () => {
+        expect(dateFieldName({ type: 'era', nameType: 'wide' })).toEqual("era");
+        expect(dateFieldName({ type: 'era', nameType: 'narrow' })).toEqual("era");
+        expect(dateFieldName({ type: 'era', nameType: 'short' })).toEqual("era");
+    });
+
+    it('should return placeholder for the year type', () => {
+        expect(dateFieldName({ type: 'year', nameType: 'wide' })).toEqual("year");
+        expect(dateFieldName({ type: 'year', nameType: 'narrow' })).toEqual("yr.");
+        expect(dateFieldName({ type: 'year', nameType: 'short' })).toEqual("yr.");
+    });
+
+    it('should return placeholder for the quarter type', () => {
+        expect(dateFieldName({ type: 'quarter', nameType: 'wide' })).toEqual("quarter");
+        expect(dateFieldName({ type: 'quarter', nameType: 'narrow' })).toEqual("qtr.");
+        expect(dateFieldName({ type: 'quarter', nameType: 'short' })).toEqual("qtr.");
+    });
+
+    it('should return placeholder for the month type', () => {
+        expect(dateFieldName({ type: 'month', nameType: 'wide' })).toEqual("month");
+        expect(dateFieldName({ type: 'month', nameType: 'narrow' })).toEqual("mo.");
+        expect(dateFieldName({ type: 'month', nameType: 'short' })).toEqual("mo.");
+    });
+
+    it('should return placeholder for the month type', () => {
+        expect(dateFieldName({ type: 'month', nameType: 'wide' })).toEqual("month");
+        expect(dateFieldName({ type: 'month', nameType: 'narrow' })).toEqual("mo.");
+        expect(dateFieldName({ type: 'month', nameType: 'short' })).toEqual("mo.");
+    });
+
+    it('should return placeholder for the week type', () => {
+        expect(dateFieldName({ type: 'week', nameType: 'wide' })).toEqual("week");
+        expect(dateFieldName({ type: 'week', nameType: 'narrow' })).toEqual("wk.");
+        expect(dateFieldName({ type: 'week', nameType: 'short' })).toEqual("wk.");
+    });
+
+    it('should return placeholder for the day type', () => {
+        expect(dateFieldName({ type: 'day', nameType: 'wide' })).toEqual("day");
+        expect(dateFieldName({ type: 'day', nameType: 'narrow' })).toEqual("day");
+        expect(dateFieldName({ type: 'day', nameType: 'short' })).toEqual("day");
+    });
+
+    it('should return localized placeholder for the day type', () => {
+        expect(dateFieldName({ type: 'day', nameType: 'wide' }, 'bg')).toEqual("ден");
+        expect(dateFieldName({ type: 'day', nameType: 'narrow' }, 'bg')).toEqual("д");
+        expect(dateFieldName({ type: 'day', nameType: 'short' }, 'bg')).toEqual("д");
+    });
+
+    it('should return placeholder for the weekday type', () => {
+        expect(dateFieldName({ type: 'weekday', nameType: 'wide' })).toEqual("day of the week");
+        expect(dateFieldName({ type: 'weekday', nameType: 'narrow' })).toEqual("day of the week");
+        expect(dateFieldName({ type: 'weekday', nameType: 'short' })).toEqual("day of the week");
+    });
+
+    it('should return localized placeholder for the weekday type', () => {
+        expect(dateFieldName({ type: 'weekday', nameType: 'wide' }, 'bg')).toEqual("ден от седмицата");
+        expect(dateFieldName({ type: 'weekday', nameType: 'narrow' }, 'bg')).toEqual("ден от седмицата");
+        expect(dateFieldName({ type: 'weekday', nameType: 'short' }, 'bg')).toEqual("ден от седмицата");
+    });
+
+    it('should return placeholder for the dayperiod type', () => {
+        expect(dateFieldName({ type: 'dayperiod', nameType: 'wide' })).toEqual("AM/PM");
+        expect(dateFieldName({ type: 'dayperiod', nameType: 'narrow' })).toEqual("AM/PM");
+        expect(dateFieldName({ type: 'dayperiod', nameType: 'short' })).toEqual("AM/PM");
+    });
+
+    it('should return localized placeholder for the dayperiod type', () => {
+        expect(dateFieldName({ type: 'dayperiod', nameType: 'wide' }, 'bg')).toEqual("пр.об./сл.об.");
+        expect(dateFieldName({ type: 'dayperiod', nameType: 'narrow' }, 'bg')).toEqual("пр.об./сл.об.");
+        expect(dateFieldName({ type: 'dayperiod', nameType: 'short' }, 'bg')).toEqual("пр.об./сл.об.");
+    });
+
+    it('should return placeholder for hour type', () => {
+        expect(dateFieldName({ type: 'hour', nameType: 'wide' })).toEqual("hour");
+        expect(dateFieldName({ type: 'hour', nameType: 'narrow' })).toEqual("hr.");
+        expect(dateFieldName({ type: 'hour', nameType: 'short' })).toEqual("hr.");
+    });
+
+    it('should return localized placeholder for hour type', () => {
+        expect(dateFieldName({ type: 'hour', nameType: 'wide' }, 'bg')).toEqual("час");
+        expect(dateFieldName({ type: 'hour', nameType: 'narrow' }, 'bg')).toEqual("ч");
+        expect(dateFieldName({ type: 'hour', nameType: 'short' }, 'bg')).toEqual("ч");
+    });
+
+    it('should return placeholder for minute type', () => {
+        expect(dateFieldName({ type: 'minute', nameType: 'wide' })).toEqual("minute");
+        expect(dateFieldName({ type: 'minute', nameType: 'narrow' })).toEqual("min.");
+        expect(dateFieldName({ type: 'minute', nameType: 'short' })).toEqual("min.");
+    });
+
+    it('should return placeholder for second type', () => {
+        expect(dateFieldName({ type: 'second', nameType: 'wide' })).toEqual("second");
+        expect(dateFieldName({ type: 'second', nameType: 'narrow' })).toEqual("sec.");
+        expect(dateFieldName({ type: 'second', nameType: 'short' })).toEqual("sec.");
+    });
+
+    it('should return placeholder for zone type', () => {
+        expect(dateFieldName({ type: 'zone', nameType: 'wide' })).toEqual("time zone");
+        expect(dateFieldName({ type: 'zone', nameType: 'narrow' })).toEqual("time zone");
+        expect(dateFieldName({ type: 'zone', nameType: 'short' })).toEqual("time zone");
+    });
+
+    it('should return undefined for missing fieldName type', () => {
+        expect(dateFieldName({ type: 'millisecond', nameType: 'wide' })).toEqual(undefined);
+        expect(dateFieldName({ type: 'millisecond', nameType: 'narrow' })).toEqual(undefined);
+        expect(dateFieldName({ type: 'millisecond', nameType: 'short' })).toEqual(undefined);
+    });
+
+    it('should return wide placeholder by default', () => {
+        expect(dateFieldName({ type: 'year' })).toEqual('year');
+    });
+});
+
 describe('firstDay', () => {
     it('should return first day name based on locale', () => {
         expect(firstDay('en')).toBe(0);

test/cldr.js

@@ -1,13 +1,13 @@
 import { load, localeInfo, dateFormatNames } from '../src/cldr';
-import { dateFieldName, formatDate, parseDate, splitDateFormat } from '../src/dates';
+import { formatDate, parseDate, splitDateFormat } from '../src/dates';
 import { convertTimeZone } from '../src/dates/time-utils';
 import pad from '../src/common/pad';
 
 const likelySubtags = require("cldr-data/supplemental/likelySubtags.json");
 const timeZoneNames = require("cldr-data/main/bg/timeZoneNames.json");
 const calendar = require("cldr-data/main/bg/ca-gregorian.json");
 
-load(likelySubtags, timeZoneNames, calendar, require("cldr-data/main/ko/timeZoneNames.json"), require("cldr-data/main/ko/ca-gregorian.json"), require("cldr-data/supplemental/weekData.json"), require("cldr-data/main/ko/dateFields.json"));
+load(likelySubtags, timeZoneNames, calendar, require("cldr-data/main/ko/timeZoneNames.json"), require("cldr-data/main/ko/ca-gregorian.json"), require("cldr-data/supplemental/weekData.json"));
 
 Date.prototype.getTimezoneOffset = function() {
     return -120;
@@ -24,74 +24,6 @@ function date(year, month, day, hour, minute, second, millisecond) {
     return d;
 }
 
-describe('dateFieldName', () => {
-    it('should return placeholder for wide year name', () => {
-        expect(dateFieldName("yyyy")).toEqual("year");
-    });
-
-    it('should return placeholder for short year name', () => {
-        expect(dateFieldName("y")).toEqual("yr.");
-    });
-
-    it('should return placeholder for wide month name', () => {
-        expect(dateFieldName("MMMM")).toEqual("month");
-    });
-
-    it('should return placeholder for short month name', () => {
-        expect(dateFieldName("M")).toEqual("mo.");
-    });
-
-    it('should return placeholder for wide day name', () => {
-        expect(dateFieldName("EEEE")).toEqual("day of the week");
-        expect(dateFieldName("EEEE", "bg")).toEqual("ден от седмицата");
-    });
-
-    it('should return placeholder for short day name', () => {
-        expect(dateFieldName("d", "bg")).toEqual("д");
-    });
-
-    it('should return placeholder for short hour name', () => {
-        expect(dateFieldName("h")).toEqual("hr.");
-        expect(dateFieldName("h", "bg")).toEqual("ч");
-    });
-
-    it('should return placeholder for short minute name', () => {
-        expect(dateFieldName("m")).toEqual("min.");
-        expect(dateFieldName("m", "bg")).toEqual("мин");
-    });
-
-    it('should return placeholder for short second name', () => {
-        expect(dateFieldName("s")).toEqual("sec.");
-        expect(dateFieldName("s", "bg")).toEqual("с");
-    });
-
-    it('should return placeholder for day period', () => {
-        expect(dateFieldName("a")).toEqual("AM/PM");
-    });
-
-    it('should return placeholder for era', () => {
-        expect(dateFieldName("G")).toEqual("era");
-    });
-
-    it('should return placeholder for zone', () => {
-        expect(dateFieldName("x")).toEqual("time zone");
-        expect(dateFieldName("z")).toEqual("time zone");
-    });
-
-    it('should return placeholder for wide quarter name', () => {
-        expect(dateFieldName("QQQQ")).toEqual("quarter");
-    });
-
-    it('should return placeholder for short quarter name', () => {
-        expect(dateFieldName("q")).toEqual("qtr.");
-    });
-
-    it('should return placeholder for weekday', () => {
-        expect(dateFieldName("c")).toEqual("day of the week");
-        expect(dateFieldName("e")).toEqual("day of the week");
-    });
-});
-
 describe('date formatting', () => {
     it('returns value if it is not a date', () => {
         expect(formatDate("foo")).toEqual("foo");