@oracle/oraclejet-icu-l10n 16.0.0

package/test/l10nTest.js

@@ -0,0 +1,492 @@
+'use strict';
+const assert = require('assert');
+const path = require('path');
+const { build, isNlsDir } = require('../Bundler');
+const fsx = require('fs-extra');
+const vm = require('vm');
+const glob = require('glob');
+
+const rootDir = path.join(__dirname, 'resources/nls');
+const outputRoot = path.resolve(__dirname, 'built');
+
+function runTestCases(extractBundle) {
+  describe('Bundle files', () => {
+    it('creates the root bundle in English', () => {
+      const bundle = extractBundle(`app-strings.js`);
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard Content Area');
+      assert.equal(
+        bundle.pageIntro({ name: 'Dashboard' }),
+        'To change the content of this section, you will make edits to the Dashboard file located in the /js/views folder.'
+      );
+      assert.equal(bundle.alpha(), 'Alpha');
+      assert.equal(bundle.beta(), 'Beta');
+      assert.equal(bundle.delta(), 'Delta');
+      assert.equal(bundle.epsilon(), 'Epsilon');
+      assert.equal(bundle.blank(), '');
+    });
+
+    it('creates the azb bundle in Azerbaijani', () => {
+      const bundle = extractBundle('azb/app-strings.js');
+      assert.equal(bundle.welcome(), 'Xoş gəlmisiniz');
+    });
+
+    it('creates the azb-AZ bundle in Azerbaijani', () => {
+      const bundle = extractBundle('azb-AZ/app-strings.js');
+      assert.equal(bundle.welcome(), 'Xoş gəlmisiniz');
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard Məzmun sahəsi');
+    });
+
+    it('creates the ru bundle in Russian', () => {
+      const bundle = extractBundle(`ru/app-strings.js`);
+      // Derived value from root bundle--in English
+      assert.equal(bundle.welcome(), 'Welcome');
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard область содержимого');
+    });
+
+    it('creates the ru-RU bundle in Russian', () => {
+      const bundle = extractBundle(`ru-RU/app-strings.js`);
+      // Derived value from root bundle--in English
+      assert.equal(bundle.welcome(), 'Welcome');
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard область содержимого');
+      assert.equal(
+        bundle.pageIntro({ name: 'Dashboard' }),
+        'Чтобы изменить содержимое этого раздела, вы внесете изменения в файл Dashboard, расположенный в папке /js/views.'
+      );
+    });
+
+    it('creates the zh bundle in Russian', () => {
+      const bundle = extractBundle(`zh/app-strings.js`);
+      // Derived value from root bundle--in English
+      assert.equal(bundle.welcome(), '欢迎');
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard Content Area');
+    });
+
+    it('creates the zh-Hans bundle in Russian', () => {
+      const bundle = extractBundle(`zh-Hans/app-strings.js`);
+      // Derived value from root bundle--in English
+      assert.equal(bundle.welcome(), '欢迎');
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard Content Area');
+    });
+
+    it('creates the zh-Hans-CN bundle in Russian', () => {
+      const bundle = extractBundle(`zh-Hans-CN/app-strings.js`);
+      // Derived value from root bundle--in English
+      assert.equal(bundle.welcome(), '欢迎');
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard Content Area');
+    });
+
+    it('creates parameterized plural values', () => {
+      const bundle = extractBundle(`ru-RU/app-strings.js`);
+      assert.equal(
+        bundle.invitation({
+          host: 'Barbara',
+          guest: 'Phil',
+          gender_of_host: 'female',
+          num_guests: 0
+        }),
+        'Barbara does not give a party.'
+      );
+      assert.equal(
+        bundle.invitation({
+          host: 'Barbara',
+          guest: 'Phil',
+          gender_of_host: 'female',
+          num_guests: 1
+        }),
+        'Barbara invites Phil to her party.'
+      );
+      assert.equal(
+        bundle.invitation({
+          host: 'Barbara',
+          guest: 'Phil',
+          gender_of_host: 'female',
+          num_guests: 2
+        }),
+        'Barbara invites Phil and one other person to her party.'
+      );
+      assert.equal(
+        bundle.invitation({
+          host: 'Bob',
+          guest: 'Sue',
+          gender_of_host: 'male',
+          num_guests: 3
+        }),
+        'Bob invites Sue and 2 other people to his party.'
+      );
+    });
+
+    it('uses plural select rules for buckets', () => {
+      const enBundle = extractBundle(`app-strings.js`);
+      assert.equal(
+        enBundle.plural({
+          total_rows: 0
+        }),
+        'No rows'
+      );
+      assert.equal(
+        enBundle.plural({
+          total_rows: 1
+        }),
+        '1 row'
+      );
+      assert.equal(
+        enBundle.plural({
+          total_rows: 2
+        }),
+        '2 rows'
+      );
+
+      const ruBundle = extractBundle(`ru-RU/app-strings.js`);
+      assert.equal(
+        ruBundle.plural({
+          total_rows: 0
+        }),
+        'нет строк'
+      );
+      assert.equal(
+        ruBundle.plural({
+          total_rows: 1
+        }),
+        '1 ряд'
+      );
+      assert.equal(
+        ruBundle.plural({
+          total_rows: 2
+        }),
+        '2 ряда'
+      );
+    });
+  });
+
+  describe('Number formats', () => {
+    const bundle = extractBundle('app-strings.js');
+
+    it('formats date/time', () => {
+      const testDate = '2022-09-29 07:25 GMT';
+      assert.equal(
+        bundle.dateFormat({
+          date_time: testDate,
+          item: 'an alien',
+          planet: 5
+        }),
+        'At 25 past, on September 29, there was an alien on planet 5.'
+      );
+    });
+
+    it('formats currency', () => {
+      assert.equal(bundle.currencyFormat({ gbp: 99 }), 'The budget is +£99 and no more.');
+    });
+  });
+
+  describe('Metadata', () => {
+    const bundle = extractBundle('ro-MD/app-strings.js');
+
+    it('redefining parameter type should cause failure', () => {
+      let didFail = false;
+      try {
+        build({
+          rootDir: path.join(`${rootDir}-bad-metadata`),
+          locale: 'ro-MD',
+          bundleName: 'app-strings-bad-root.json',
+          outDir: path.join(outputRoot, 'nls-bad-metadata')
+        });
+      } catch (ex) {
+        didFail = !!ex.message.match(/While processing ro-MD\/app-strings-bad-root.json/);
+      }
+      assert(didFail === true);
+    })
+
+    it('metadata keys should not be in bundle', () => {
+      assert.strictEqual(Object.keys(bundle).every(k => !k.startsWith('@')), true);
+    });
+
+    it('metadata parameters present in locale bundle', () => {
+      const birthDate = '2022-09-29 07:25 GMT';
+      assert.equal(bundle.localeParams({
+        total: 1,
+        gender: 'male',
+        title: 'Mr.',
+        birthDate
+      }), 'Moldavian total: 1 unu, gender: male, title: Mr., birthDate: 29.09.2022');
+    });
+  });
+
+}
+
+describe('Custom hooks', () => {
+  it('can produce custom return types', () => {
+    const outDir = path.resolve(outputRoot, 'custom-hooks');
+    fsx.removeSync(outDir);
+    build({
+      rootDir,
+      bundleName: 'app-strings.json',
+      locale: 'en-US',
+      outDir,
+      hooks: require.resolve('./resources/custom-hooks.js'),
+      module: 'cjs'
+    });
+
+    const bundle = extractCjsBundle(outDir, 'app-strings.js').default;
+    expect(bundle.welcome().bundle).toEqual('app-strings.json');
+    expect(bundle.welcome().key).toEqual('welcome');
+    expect(bundle.welcome().params).toBeUndefined();
+    expect(bundle.welcome().value).toEqual('Welcome');
+  });
+
+  it('can produce custom return types without definition', () => {
+    const outDir = path.resolve(outputRoot, 'custom-hooks-no-def');
+    fsx.removeSync(outDir);
+    build({
+      rootDir,
+      bundleName: 'app-strings.json',
+      locale: 'en-US',
+      outDir,
+      hooks: require.resolve('./resources/custom-hooks-no-def.js'),
+      module: 'cjs'
+    });
+
+    const bundle = extractCjsBundle(outDir, 'app-strings.js').default;
+    expect(bundle.welcome().bundleId).toEqual('app-strings.json');
+    expect(bundle.welcome().id).toEqual('welcome');
+    expect(bundle.welcome().params).toBeUndefined();
+    expect(bundle.welcome().translation).toEqual('Welcome');
+  });
+});
+
+/**
+ * Read contents of CJS bundle
+ * @param {string} outDir
+ * @param {string} filePath
+ */
+function extractCjsBundle(outDir, filepath) {
+  return require(path.join(outDir, filepath));
+}
+
+describe('CJS default export', () => {
+  const outDir = path.resolve(outputRoot, 'cjs');
+
+  fsx.removeSync(outDir);
+  build({
+    rootDir,
+    bundleName: 'app-strings.json',
+    locale: 'en-US',
+    outDir,
+    module: 'cjs'
+  });
+
+  runTestCases((fp) => extractCjsBundle(outDir, fp).default);
+});
+
+describe('AMD', () => {
+  /**
+   * Read contents of ES6 file and convert to CommonJS export for Node testing
+   * @param {string} filepath
+   */
+  function extractBundle(filepath, exportType) {
+    const bundleContents = fsx.readFileSync(filepath).toString();
+    // Create a 'define' method in the context which returns the object passed in
+    const script = new vm.Script(bundleContents, '');
+    const context = vm.createContext({
+      define: function (rb) {
+        // define({ ... })
+        if (arguments.length === 1) {
+          return rb;
+        }
+        // define(['require', 'exports'], function(require, exports))
+        const exp = {};
+        // pass exports for every argument
+        const args = new Array(arguments[0].length);
+        const ret = arguments[1](...args.fill(exp));
+        // AMD may return the value or assign to 'exports'
+        const resource = ret || exp;
+        return exportType === 'default' ? resource.default : resource;
+      }
+    });
+    const rb = script.runInContext(context);
+    return rb;
+  }
+
+  function testAmd(exportType) {
+    const outDir = path.resolve(outputRoot, `amd-${exportType}`);
+
+    fsx.removeSync(outDir);
+    build({
+      rootDir,
+      bundleName: 'app-strings.json',
+      locale: 'en-US',
+      outDir,
+      module: 'amd',
+      exportType
+    });
+
+    runTestCases((fp) => extractBundle(path.join(outDir, fp), exportType));
+  }
+
+  describe('default output', () => {
+    testAmd('default');
+  });
+
+  describe('named output', () => {
+    testAmd('named');
+  });
+
+  describe('legacy-amd', () => {
+    const outDir = path.resolve(outputRoot, 'legacy-amd');
+
+    beforeAll(() => {
+      fsx.removeSync(outDir);
+      build({
+        rootDir,
+        bundleName: 'app-strings-legacy-keys.json',
+        locale: 'en-US',
+        outDir,
+        module: 'legacy-amd'
+      });
+    });
+
+    it('does not contain ts output', () => {
+      expect(glob.sync(path.join(outDir, '**', '*.ts'))).toEqual([]);
+    });
+
+    it('creates non-standard keys', () => {
+      const bundle = extractBundle(
+        path.join(outDir, 'app-strings-legacy-keys.js'),
+        'named'
+      );
+      expect(bundle['dot.key']()).toEqual('Dot key');
+      expect(bundle['.leading.dot.key']()).toEqual('Leading dot key');
+      expect(bundle['dash-key']()).toEqual('Dash key');
+    });
+  });
+});
+
+describe('Extra locales', () => {
+  const outDir = path.resolve(outputRoot, 'extra');
+  const additionalLocales = ['de', 'de-DE', 'fr-FR', 'ru', 'ru-RU'];
+  const allLocales = [
+    ...new Set(fsx.readdirSync(rootDir).filter(isNlsDir).concat(additionalLocales).sort())
+  ];
+
+  fsx.removeSync(outDir);
+  build({
+    rootDir,
+    bundleName: 'app-strings.json',
+    locale: 'en-US',
+    outDir,
+    module: 'cjs',
+    additionalLocales
+  });
+
+  const extractBundle = (fp) => extractCjsBundle(outDir, fp).default;
+  runTestCases(extractBundle);
+
+  it('creates the de bundle in English', () => {
+    const bundle = extractBundle('de/app-strings.js');
+    assert.equal(bundle.welcome(), 'Welcome');
+  });
+
+  it('creates the de-DE bundle in English', () => {
+    const bundle = extractBundle('de-DE/app-strings.js');
+    assert.equal(bundle.welcome(), 'Welcome');
+  });
+
+  it('creates the fr-FR bundle in English', () => {
+    const bundle = extractBundle('fr-FR/app-strings.js');
+    assert.equal(bundle.welcome(), 'Welcome');
+  });
+
+  it('exports the list of supported locales', () => {
+    const supportedLocales = extractBundle('supportedLocales.js');
+    assert.deepEqual(supportedLocales, allLocales);
+  });
+});
+
+describe('Override files', () => {
+  const outDir = path.resolve(outputRoot, 'override');
+  const extractBundle = (fp) => extractCjsBundle(outDir, fp).default;
+
+  describe('with root overrides', () => {
+    build({
+      rootDir,
+      bundleName: 'app-strings-x.json',
+      locale: 'en-US',
+      override: true,
+      additionalLocales: ['en', 'ru-RU'],
+      outDir,
+      module: 'cjs'
+    });
+
+    it('creates the root override bundle in English', () => {
+      const bundle = extractBundle(`app-strings-x.js`);
+      assert.equal(bundle.pageIntro(), 'root pageIntro');
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard root contentArea');
+    });
+
+    it('creates the en override bundle from root', () => {
+      const bundle = extractBundle(`en/app-strings-x.js`);
+      assert.equal(bundle.pageIntro(), 'root pageIntro');
+      assert.equal(bundle.contentArea({ name: 'Dashboard' }), 'Dashboard root contentArea');
+    });
+
+    it('creates the ru-RU override bundle in Russian', () => {
+      const bundle = extractBundle(`ru-RU/app-strings-x.js`);
+      assert.equal(Object.keys(bundle).length, 2, "override should have root keys");
+      assert.equal(
+        bundle.contentArea({ name: 'Dashboard' }), 'Dashboard ru-RU contentArea override');
+      assert.equal(bundle.pageIntro(), 'root pageIntro');
+    });
+
+    it('should not create overrides in any other locales', () => {
+      let exists = false;
+      try {
+        extractBundle('ru/app-strings-x.js');
+        exists = true;
+      } catch (ex) {}
+      try {
+        extractBundle('fr/app-strings-x.js');
+        exists = true;
+      } catch (ex) {}
+      expect(exists).toBeFalsy();
+    });
+  });
+
+  describe('without root overrides', () => {
+    build({
+      rootDir,
+      bundleName: 'extra-app-strings-x.json',
+      override: true,
+      additionalLocales: ['zh-Hans'],
+      outDir,
+      module: 'cjs'
+    });
+
+    it('creates only zh-Hans overrides', () => {
+      const generatedFiles = glob.sync(`${outDir}/**/extra-app-strings-x.js`);
+      expect(generatedFiles.length).toEqual(1);
+
+      const bundle = extractBundle('zh-Hans/extra-app-strings-x.js');
+      assert.equal(Object.keys(bundle).length, 1, "override should not have root keys");
+      assert.equal(
+        bundle.contentArea({ name: 'Dashboard' }), 'Dashboard zh-Hans contentArea override');
+    })
+  })
+
+})
+
+describe('extra keys', () => {
+  const outDir = path.resolve(outputRoot, 'extra-keys');
+
+  it('should fail if locale bundle has extra keys', () => {
+    let didFail = false;
+    try {
+      build({
+        rootDir: `${rootDir}-extra-keys`,
+        bundleName: 'app-bundle-bad.json',
+        outDir
+      });
+    } catch (ex) {
+      didFail = ex.message.indexOf('description') >= 0;
+    }
+    expect(didFail).toBeTruthy();
+  })
+})

package/test/resources/CustomMessageType.d.ts

@@ -0,0 +1,6 @@
+export declare type CustomMessageType = {
+  bundle: string;
+  key: string;
+  params: { [key: string]: any } | undefined;
+  value: string;
+};

package/test/resources/custom-hooks-no-def.js

@@ -0,0 +1,3 @@
+module.exports = {
+  convertor: '(args: ParamsType) => args'
+};

package/test/resources/custom-hooks.js

@@ -0,0 +1,8 @@
+module.exports = {
+  typeImport: {
+    CustomMessageType: 'import { CustomMessageType } from "../../resources/CustomMessageType";'
+  },
+  otherImports: 'import { escape } from "../../resources/escape-util";',
+  // remap some of the parameter names to different keys
+  convertor: '(args: ParamsType): CustomMessageType => ({bundle: args.bundleId, key: args.id, params: args.params, value: escape(args.translation)})'
+};

package/test/resources/escape-util.js

@@ -0,0 +1,3 @@
+module.exports = {
+  escape: (s) => s
+};

package/test/resources/nls/app-strings-legacy-keys.json

@@ -0,0 +1,5 @@
+{
+  "dot.key": "Dot key",
+  ".leading.dot.key": "Leading dot key",
+  "dash-key": "Dash key"
+}

package/test/resources/nls/app-strings-x.json

@@ -0,0 +1,4 @@
+{
+  "pageIntro": "root pageIntro",
+  "contentArea": "{name} root contentArea"
+}

package/test/resources/nls/app-strings.json

@@ -0,0 +1,48 @@
+{
+  "@count": {
+    "type": "number"
+  },
+  "@@x-base-bundle": true,
+  "welcome": "Welcome",
+  "contentArea": "{name} Content Area",
+  "pageIntro": "To change the content of this section, you will make edits to the {name} file located in the /js/views folder.",
+  "invitation": "{gender_of_host, select, female {{num_guests, plural, offset:1 =0 {{host} does not give a party.} =1 {{host} invites {guest} to her party.} =2 {{host} invites {guest} and one other person to her party.} other {{host} invites {guest} and # other people to her party.}}} male {{num_guests, plural, offset:1 =0 {{host} does not give a party.} =1 {{host} invites {guest} to his party.} =2 {{host} invites {guest} and one other person to his party.} other {{host} invites {guest} and # other people to his party.}}} other {{num_guests, plural, offset:1 =0 {{host} does not give a party.} =1 {{host} invites {guest} to their party.} =2 {{host} invites {guest} and one other person to their party.} other {{host} invites {guest} and # other people to their party.}}}}",
+  "plural": "{total_rows, plural, offset:0 =0 {No rows} one {# row} other {# rows}}",
+  "dateFormat": "At {date_time,time,::jmm} past, on {date_time,date,::dMMMM}, there was {item} on planet {planet,number,integer}.",
+  "currencyFormat": "The budget is {gbp, number, :: +! K currency/GBP} and no more.",
+  "@@locale": "en",
+  "alpha": "Alpha",
+  "beta": "Beta",
+  "another_button": "Another button",
+  "@another_button": {
+    "description": "anything"
+  },
+  "delta": "Delta",
+  "epsilon": "Epsilon",
+  "blank": "",
+  "testPlural": "You have {itemCount, plural, =0 {no items} one {item} other {{itemCount} items}}",
+  "localeParams": "Other locale params besides this {one}",
+  "@localeParams": {
+    "placeholders": {
+      "total": {
+        "type": "plural",
+        "description": "first param is used in dev English bundle"
+      },
+      "gender": {
+        "type": "select",
+        "description": "This is an extra one that might be used in other languages"
+      },
+      "title": {
+        "type": "text",
+        "description": "Person's title, Mr., Mrs., etc."
+      },
+      "birthDate": {
+        "type": "date",
+        "description": "Your b-day"
+      },
+      "one": {
+        "description": "{one} param is described here without redefining the type. should be ok."
+      }
+    }
+  }
+}

package/test/resources/nls/azb/app-strings.json

@@ -0,0 +1,3 @@
+{
+  "welcome": "Xoş gəlmisiniz"
+}

package/test/resources/nls/azb-AZ/app-strings.json

@@ -0,0 +1,3 @@
+{
+  "contentArea": "{name} Məzmun sahəsi"
+}

package/test/resources/nls/ro-MD/app-strings.json

@@ -0,0 +1,3 @@
+{
+  "localeParams": "Moldavian total: {total, plural, offset:0 =0 {nici unul} one {# unu} other {# alte}}, gender: {gender}, title: {title}, birthDate: {birthDate, date}"
+}

package/test/resources/nls/ru/app-strings.json

@@ -0,0 +1,4 @@
+{
+  "contentArea": "{name} область содержимого",
+  "plural": "{total_rows, plural, offset:0 =0 {нет строк} one {# ряд} other {# ряда}}"
+}

package/test/resources/nls/ru-RU/app-strings-x.json

@@ -0,0 +1,3 @@
+{
+  "contentArea": "{name} ru-RU contentArea override"
+}

package/test/resources/nls/ru-RU/app-strings.json

@@ -0,0 +1,3 @@
+{
+  "pageIntro": "Чтобы изменить содержимое этого раздела, вы внесете изменения в файл {name}, расположенный в папке /js/views."
+}

package/test/resources/nls/zh/app-strings.json

@@ -0,0 +1,3 @@
+{
+  "welcome": "欢迎"
+}

package/test/resources/nls/zh-Hans/app-strings.json

@@ -0,0 +1,2 @@
+{
+}

package/test/resources/nls/zh-Hans/extra-app-strings-x.json

@@ -0,0 +1,3 @@
+{
+  "contentArea": "{name} zh-Hans contentArea override"
+}

package/test/resources/nls/zh-Hans-CN/app-strings.json

@@ -0,0 +1,2 @@
+{
+}

package/test/resources/nls-bad-metadata/app-strings-bad-root.json

@@ -0,0 +1,11 @@
+{
+  "welcome": "welcome {name}",
+  "@welcome": {
+    "placeholders": {
+      "name": {
+        "type": "number",
+        "description": "This redefinition should cause the builder to fail"
+      }
+    }
+  }
+}

package/test/resources/nls-extra-keys/README.md

@@ -0,0 +1,3 @@
+#
+
+This folder contains a root and locale bundle file, but the bundle file contains more keys than are in the root. This should cause the bundle builder to fail.

package/test/resources/nls-extra-keys/app-bundle-bad.json

@@ -0,0 +1,4 @@
+{
+  "welcome": "Welcome",
+  "intro": "Intro"
+}

package/test/resources/nls-extra-keys/en/app-bundle-bad.json

@@ -0,0 +1,3 @@
+{
+  "description": "This key should cause the bundle builder to fail."
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "strict": true
+  },
+  "include": [ "**/*.ts" ]
+}