@ultraq/icu-message-formatter 0.13.0 → 0.14.1

package/source/pluralTypeHandler.js

@@ -1,122 +0,0 @@
-/* 
- * Copyright 2019, Emanuel Rabina (http://www.ultraq.net.nz/)
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *     http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import {parseCases} from './utilities.js';
-
-let pluralFormatter;
-
-let keyCounter = 0;
-
-// All the special keywords that can be used in `plural` blocks for the various branches
-const ONE   = 'one';
-const OTHER = 'other';
-
-/**
- * @private
- * @param {string} caseBody
- * @param {number} value
- * @return {{caseBody: string, numberValues: object}}
- */
-function replaceNumberSign(caseBody, value) {
-	let i = 0;
-	let output = '';
-	let numBraces = 0;
-	const numberValues = {};
-
-	while (i < caseBody.length) {
-		if (caseBody[i] === '#' && !numBraces) {
-			let keyParam = `__hashToken${keyCounter++}`;
-			output += `{${keyParam}, number}`;
-			numberValues[keyParam] = value;
-		}
-		else {
-			output += caseBody[i];
-		}
-
-		if (caseBody[i] === '{') {
-			numBraces++;
-		}
-		else if (caseBody[i] === '}') {
-			numBraces--;
-		}
-
-		i++;
-	}
-
-	return {
-		caseBody: output,
-		numberValues
-	};
-}
-
-/**
- * Handler for `plural` statements within ICU message syntax strings.  Returns
- * a formatted string for the branch that closely matches the current value.
- * 
- * See https://formatjs.io/docs/core-concepts/icu-syntax#plural-format for more
- * details on how the `plural` statement works.
- *
- * @param {string} value
- * @param {string} matches
- * @param {string} locale
- * @param {Record<string,any>} values
- * @param {(message: string, values?: Record<string,any>) => any[]} process
- * @return {any | any[]}
- */
-export default function pluralTypeHandler(value, matches = '', locale, values, process) {
-	const {args, cases} = parseCases(matches);
-
-	let intValue = parseInt(value);
-
-	args.forEach((arg) => {
-		if (arg.startsWith('offset:')) {
-			intValue -= parseInt(arg.slice('offset:'.length));
-		}
-	});
-
-	const keywordPossibilities = [];
-
-	if ('PluralRules' in Intl) {
-		// Effectively memoize because instantiation of `Int.*` objects is expensive.
-		if (pluralFormatter === undefined || pluralFormatter.resolvedOptions().locale !== locale) {
-			pluralFormatter = new Intl.PluralRules(locale);
-		}
-
-		const pluralKeyword = pluralFormatter.select(intValue);
-
-		// Other is always added last with least priority, so we don't want to add it here.
-		if (pluralKeyword !== OTHER) {
-			keywordPossibilities.push(pluralKeyword);
-		}
-	}
-	if (intValue === 1) {
-		keywordPossibilities.push(ONE);
-	}
-	keywordPossibilities.push(`=${intValue}`, OTHER);
-
-	for (let i = 0; i < keywordPossibilities.length; i++) {
-		const keyword = keywordPossibilities[i];
-		if (keyword in cases) {
-			const {caseBody, numberValues} = replaceNumberSign(cases[keyword], intValue);
-			return process(caseBody, {
-				...values,
-				...numberValues
-			});
-		}
-	}
-
-	return value;
-}

package/source/pluralTypeHandler.test.js

@@ -1,188 +0,0 @@
-/* 
- * Copyright 2019, Emanuel Rabina (http://www.ultraq.net.nz/)
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *     http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/* eslint-env jest */
-import MessageFormatter from './MessageFormatter.js';
-import pluralTypeHandler from './pluralTypeHandler.js';
-
-/**
- * Tests for the `plural` handler.
- */
-describe('pluralTypeHandler', function() {
-
-	describe('Branch selection', function() {
-		const formatter = new MessageFormatter('en-NZ', {
-			plural: pluralTypeHandler
-		});
-		const message = `Stop thinking about {value, plural,
-			one {that donut}
-			=2 {that delicious duo of donuts}
-			=3 {that triumphant trio of donuts}
-			other {those donuts}
-		}`;
-
-		test('=n', function() {
-			let result = formatter.format(message, {value: 2});
-			expect(result).toBe('Stop thinking about that delicious duo of donuts');
-
-			result = formatter.format(message, {value: 3});
-			expect(result).toBe('Stop thinking about that triumphant trio of donuts');
-		});
-
-		test('other', function() {
-			let result = formatter.format(message, {value: 1000});
-			expect(result).toBe('Stop thinking about those donuts');
-		});
-
-		test('other fallback', function() {
-			let result = formatter.format(message);
-			expect(result).toBe('Stop thinking about those donuts');
-		});
-	});
-
-	describe('Fallback of emitting the value', function() {
-		const formatter = new MessageFormatter('en-NZ', {
-			plural: pluralTypeHandler
-		});
-
-		test('No matching branch', function() {
-			let message = 'I have {cows, plural, one {a cow} two {some cows}}';
-			let result = formatter.format(message, {cows: 7});
-			expect(result).toBe('I have 7');
-		});
-
-		test('Keyword without branch', function() {
-			let message = 'I have {cows, plural, other}';
-			let result = formatter.format(message, {cows: 7});
-			expect(result).toBe('I have 7');
-		});
-	});
-
-	describe('Special # token', function() {
-		let message = '{days, plural, one {# day} other {# days}}...';
-
-		test('Emit value without a registered number handler', function() {
-			let formatter = new MessageFormatter('en-NZ', {
-				plural: pluralTypeHandler
-			});
-			let result = formatter.format(message, {days: 7});
-			expect(result).toBe('7 days...');
-		});
-
-		test('Use the registered number handler', function() {
-			let numberTypeHandler = jest.fn((value, options, values, locale) => new Intl.NumberFormat(locale).format(value));
-			let formatter = new MessageFormatter('en-NZ', {
-				number: numberTypeHandler,
-				plural: pluralTypeHandler
-			});
-			let result = formatter.format(message, {days: 1000});
-			expect(result).toBe('1,000 days...');
-		});
-
-		test('Number signs for nested plurals doesnt apply top level count to inner sign', function() {
-			let formatter = new MessageFormatter('en-NZ', {
-				plural: pluralTypeHandler
-			});
-			let result = formatter.format(`{id, plural,
-				other {ID: # {count, plural,
-						other {Count: #}
-					}}
-			}`, {id: 5, count: 11});
-			expect(result).toBe('ID: 5 Count: 11');
-		});
-	});
-
-	describe('Supports offset argument', function() {
-		const formatter = new MessageFormatter('en-NZ', {
-			plural: pluralTypeHandler
-		});
-
-		test('If unspecified, offset is null', function() {
-			let message = '{days, plural, one {one day} =2 {two days} other {# days}}...';
-
-			let result = formatter.format(message, {days: 5});
-			expect(result).toBe('5 days...');
-		});
-
-		test('Specified offset will be applied via =X branch', function() {
-			let message = '{days, plural, offset:3 one {one day} =2 {two days} other {# days}}...';
-
-			let result = formatter.format(message, {days: 5});
-			expect(result).toBe('two days...');
-		});
-
-		test('Specified offset will be applied via number sign', function() {
-			let message = '{days, plural, offset:1 one {one day} =2 {two days} other {# days}}...';
-
-			let result = formatter.format(message, {days: 5});
-			expect(result).toBe('4 days...');
-		});
-
-		test('Specified offset will be applied via `one` keyword', function() {
-			let message = '{days, plural, offset:4 one {one day} =2 {two days} other {# days}}...';
-
-			let result = formatter.format(message, {days: 5});
-			expect(result).toBe('one day...');
-		});
-	});
-
-
-	describe('Intl PluralRules', function() {
-		const formatterAr = new MessageFormatter('ar', {
-			plural: pluralTypeHandler
-		});
-
-		const messageAr = `{value, plural,
-			zero {ZERO}
-			one {ONE}
-			two {TWO}
-			few {FEW}
-			other {OTHER}
-		}`;
-
-		test('zero', function() {
-			let result = formatterAr.format(messageAr, {value: 0});
-			expect(result).toBe('ZERO');
-		});
-
-		test('one', function() {
-			let result = formatterAr.format(messageAr, {value: 1});
-			expect(result).toBe('ONE');
-		});
-
-		test('two', function() {
-			let result = formatterAr.format(messageAr, {value: 2});
-			expect(result).toBe('TWO');
-		});
-
-		test('few', function() {
-			let result = formatterAr.format(messageAr, {value: 3});
-			expect(result).toBe('FEW');
-		});
-
-		test('other', function() {
-			let result = formatterAr.format(messageAr, {value: 17});
-			expect(result).toBe('OTHER');
-		});
-	});
-
-	describe('Empty matches', function() {
-		test('No matching branch', function() {
-			let result = pluralTypeHandler('some value');
-			expect(result).toBe('some value');
-		});
-	});
-});

package/source/selectTypeHandler.js

@@ -1,46 +0,0 @@
-/* 
- * Copyright 2019, Emanuel Rabina (http://www.ultraq.net.nz/)
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *     http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import {parseCases} from './utilities.js';
-
-const OTHER = 'other';
-
-/**
- * Handler for `select` statements within ICU message syntax strings.  Returns
- * a formatted string for the branch that closely matches the current value.
- * 
- * See https://formatjs.io/docs/core-concepts/icu-syntax#select-format for more
- * details on how the `select` statement works.
- * 
- * @param {string} value
- * @param {string} matches
- * @param {string} locale
- * @param {Record<string,any>} values
- * @param {(message: string, values?: Record<string,any>) => any[]} process
- * @return {any | any[]}
- */
-export default function selectTypeHandler(value, matches = '', locale, values, process) {
-	const {cases} = parseCases(matches);
-
-	if (value in cases) {
-		return process(cases[value], values);
-	}
-	else if (OTHER in cases) {
-		return process(cases[OTHER], values);
-	}
-
-	return value;
-}

package/source/selectTypeHandler.test.js

@@ -1,59 +0,0 @@
-/* 
- * Copyright 2019, Emanuel Rabina (http://www.ultraq.net.nz/)
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *     http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/* eslint-env jest */
-import MessageFormatter from './MessageFormatter.js';
-import selectTypeHandler from './selectTypeHandler.js';
-
-/**
- * Tests for the `select` handler.
- */
-describe('selectTypeHandler', function() {
-
-	const formatter = new MessageFormatter('en-NZ', {
-		select: selectTypeHandler
-	});
-
-	describe('Branch selection', function() {
-		let message = '{mood, select, happy {Good} sad {bad} other {Ambivalent}} morning';
-
-		test('Explicit branch', function() {
-			let result = formatter.format(message, {mood: 'happy'});
-			expect(result).toBe('Good morning');
-		});
-
-		test('Fallback branch', function() {
-			let result = formatter.format(message, {mood: 'angry'});
-			expect(result).toBe('Ambivalent morning');
-		});
-	});
-
-	describe('Fallback of emitting the value', function() {
-
-		test('No matching branch', function() {
-			let message = 'I am feeling {mood, select, happy {good}}';
-			let result = formatter.format(message, {mood: 'ambivalent'});
-			expect(result).toBe('I am feeling ambivalent');
-		});
-	});
-
-	describe('Empty matches', function() {
-		test('No matching branch', function() {
-			let result = selectTypeHandler('some value');
-			expect(result).toBe('some value');
-		});
-	});
-});

package/source/utilities.js

@@ -1,174 +0,0 @@
-/* 
- * Copyright 2019, Emanuel Rabina (http://www.ultraq.net.nz/)
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *     http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * @typedef ParseCasesResult
- * @property {string[]} args
- *   A list of prepended arguments.
- * @property {Record<string,string>} cases
- *   A map of all cases.
- */
-
-/**
- * Most branch-based type handlers are based around "cases".  For example,
- * `select` and `plural` compare compare a value to "case keys" to choose a
- * subtranslation.
- * 
- * This util splits "matches" portions provided to the aforementioned handlers
- * into case strings, and extracts any prepended arguments (for example,
- * `plural` supports an `offset:n` argument used for populating the magic `#`
- * variable).
- * 
- * @param {string} string
- * @return {ParseCasesResult}
- */
-export function parseCases(string) {
-	const isWhitespace = ch => /\s/.test(ch);
-
-	const args = [];
-	const cases = {};
-
-	let currTermStart = 0;
-	let latestTerm = null;
-	let inTerm = false;
-
-	let i = 0;
-	while (i < string.length) {
-		// Term ended
-		if (inTerm && (isWhitespace(string[i]) || string[i] === '{')) {
-			inTerm = false;
-			latestTerm = string.slice(currTermStart, i);
-
-			// We want to process the opening char again so the case will be properly registered.
-			if (string[i] === '{') {
-				i--;
-			}
-		}
-
-		// New term
-		else if (!inTerm && !isWhitespace(string[i])) {
-			const caseBody = string[i] === '{';
-
-			// If there's a previous term, we can either handle a whole
-			// case, or add that as an argument.
-			if (latestTerm && caseBody) {
-				const branchEndIndex = findClosingBracket(string, i);
-
-				if (branchEndIndex === -1) {
-					throw new Error(`Unbalanced curly braces in string: "${string}"`);
-				}
-
-				cases[latestTerm] = string.slice(i + 1, branchEndIndex);  // Don't include the braces
-
-				i = branchEndIndex; // Will be moved up where needed at end of loop.
-				latestTerm = null;
-			}
-			else {
-				if (latestTerm) {
-					args.push(latestTerm);
-					latestTerm = null;
-				}
-
-				inTerm = true;
-				currTermStart = i;
-			}
-		}
-		i++;
-	}
-
-	if (inTerm) {
-		latestTerm = string.slice(currTermStart);
-	}
-
-	if (latestTerm) {
-		args.push(latestTerm);
-	}
-
-	return {
-		args,
-		cases
-	};
-}
-
-/**
- * Finds the index of the matching closing curly bracket, including through
- * strings that could have nested brackets.
- * 
- * @param {string} string
- * @param {number} fromIndex
- * @return {number}
- *   The index of the matching closing bracket, or -1 if no closing bracket
- *   could be found.
- */
-export function findClosingBracket(string, fromIndex) {
-	let depth = 0;
-	for (let i = fromIndex + 1; i < string.length; i++) {
-		let char = string.charAt(i);
-		if (char === '}') {
-			if (depth === 0) {
-				return i;
-			}
-			depth--;
-		}
-		else if (char === '{') {
-			depth++;
-		}
-	}
-	return -1;
-}
-
-/**
- * Split a `{key, type, format}` block into those 3 parts, taking into account
- * nested message syntax that can exist in the `format` part.
- * 
- * @param {string} block
- * @return {string[]}
- *   An array with `key`, `type`, and `format` items in that order, if present
- *   in the formatted argument block.
- */
-export function splitFormattedArgument(block) {
-	return split(block.slice(1, -1), ',', 3);
-}
-
-/**
- * Like `String.prototype.split()` but where the limit parameter causes the
- * remainder of the string to be grouped together in a final entry.
- * 
- * @private
- * @param {string} string
- * @param {string} separator
- * @param {number} limit
- * @param {string[]} accumulator
- * @return {string[]}
- */
-function split(string, separator, limit, accumulator = []) {
-	if (!string) {
-		return accumulator;
-	}
-	if (limit === 1) {
-		accumulator.push(string);
-		return accumulator;
-	}
-	let indexOfDelimiter = string.indexOf(separator);
-	if (indexOfDelimiter === -1) {
-		accumulator.push(string);
-		return accumulator;
-	}
-	let head = string.substring(0, indexOfDelimiter).trim();
-	let tail = string.substring(indexOfDelimiter + separator.length + 1).trim();
-	accumulator.push(head);
-	return split(tail, separator, limit - 1, accumulator);
-}