Rename the messages prop to bundles

stasm · stasm · commit 7346f9501bbd · 2018-08-20T15:30:01.000+02:00
diff --git a/fluent-react/CHANGELOG.md b/fluent-react/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+  - Rename the `messages` prop to `bundles`. (#222)
+
+    `<LocalizationProvider>` now expects an iterable of `FluentBundles` to be
+    passed as the `bundles` prop, rather than `messages`.
+
   - Drop support for IE and old evergreen browsers. (#133)
 
     Currently supported are: Firefox 52+, Chrome 55+, Edge 15+, Safari 10.1+,
diff --git a/fluent-react/examples/async-messages/src/l10n.js b/fluent-react/examples/async-messages/src/l10n.js
@@ -23,7 +23,7 @@ async function createMessagesGenerator(currentLocales) {
     (obj, cur) => Object.assign(obj, cur)
   );
 
-  return function* generateMessages() {
+  return function* generateBundles() {
     for (const locale of currentLocales) {
       const bundle = new FluentBundle(locale);
       bundle.addMessages(messages[locale]);
@@ -51,21 +51,21 @@ export class AppLocalizationProvider extends Component {
 
   async componentWillMount() {
     const { currentLocales } = this.state;
-    const generateMessages  = await createMessagesGenerator(currentLocales);
-    this.setState({ messages: generateMessages() });
+    const generateBundles  = await createMessagesGenerator(currentLocales);
+    this.setState({ bundles: generateBundles() });
   }
 
   render() {
     const { children } = this.props;
-    const { messages } = this.state;
+    const { bundles } = this.state;
 
-    if (!messages) {
+    if (!bundles) {
       // Show a loader.
       return <div>…</div>;
     }
 
     return (
-      <LocalizationProvider messages={messages}>
+      <LocalizationProvider bundles={bundles}>
         {children}
       </LocalizationProvider>
     );
diff --git a/fluent-react/examples/change-language/src/l10n.js b/fluent-react/examples/change-language/src/l10n.js
@@ -18,7 +18,7 @@ change = Change to { $locale }
   `,
 };
 
-function* generateMessages(currentLocales) {
+function* generateBundles(currentLocales) {
   for (const locale of currentLocales) {
     const bundle = new FluentBundle(locale);
     bundle.addMessages(MESSAGES_ALL[locale]);
@@ -59,7 +59,7 @@ export class AppLocalizationProvider extends Component {
     };
 
     return (
-      <LocalizationProvider messages={generateMessages(currentLocales)}>
+      <LocalizationProvider bundles={generateBundles(currentLocales)}>
         { cloneElement(child, l10nProps) }
       </LocalizationProvider>
     );
diff --git a/fluent-react/examples/fallback-sync/src/index.js b/fluent-react/examples/fallback-sync/src/index.js
@@ -3,11 +3,11 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import { LocalizationProvider } from 'fluent-react/compat';
 
-import { generateMessages } from './l10n';
+import { generateBundles } from './l10n';
 import App from './App';
 
 ReactDOM.render(
-  <LocalizationProvider messages={generateMessages()}>
+  <LocalizationProvider bundles={generateBundles()}>
     <App />
   </LocalizationProvider>,
   document.getElementById('root')
diff --git a/fluent-react/examples/fallback-sync/src/l10n.js b/fluent-react/examples/fallback-sync/src/l10n.js
@@ -11,7 +11,7 @@ bar = Bar in English
   `,
 };
 
-export function* generateMessages() {
+export function* generateBundles() {
   for (const locale of ['pl', 'en-US']) {
     const bundle = new FluentBundle(locale);
     bundle.addMessages(MESSAGES_ALL[locale]);
diff --git a/fluent-react/examples/hello-world/src/index.js b/fluent-react/examples/hello-world/src/index.js
@@ -3,11 +3,11 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import { LocalizationProvider } from 'fluent-react/compat';
 
-import { generateMessages } from './l10n';
+import { generateBundles } from './l10n';
 import App from './App';
 
 ReactDOM.render(
-  <LocalizationProvider messages={generateMessages(navigator.languages)}>
+  <LocalizationProvider bundles={generateBundles(navigator.languages)}>
     <App />
   </LocalizationProvider>,
   document.getElementById('root')
diff --git a/fluent-react/examples/hello-world/src/l10n.js b/fluent-react/examples/hello-world/src/l10n.js
@@ -13,7 +13,7 @@ today-is = Today is { DATETIME($date, month: "long", day: "numeric") }.
   `,
 };
 
-export function* generateMessages(userLocales) {
+export function* generateBundles(userLocales) {
   // Choose locales that are best for the user.
   const currentLocales = negotiateLanguages(
     userLocales,
diff --git a/fluent-react/examples/higher-order/src/index.js b/fluent-react/examples/higher-order/src/index.js
@@ -3,11 +3,11 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import { LocalizationProvider } from 'fluent-react/compat';
 
-import { generateMessages } from './l10n';
+import { generateBundles } from './l10n';
 import App from './App';
 
 ReactDOM.render(
-  <LocalizationProvider messages={generateMessages(navigator.languages)}>
+  <LocalizationProvider bundles={generateBundles(navigator.languages)}>
     <App />
   </LocalizationProvider>,
   document.getElementById('root')
diff --git a/fluent-react/examples/higher-order/src/l10n.js b/fluent-react/examples/higher-order/src/l10n.js
@@ -13,7 +13,7 @@ button-show-alert = Click me
   `,
 };
 
-export function* generateMessages(userLocales) {
+export function* generateBundles(userLocales) {
   // Choose locales that are best for the user.
   const currentLocales = negotiateLanguages(
     userLocales,
diff --git a/fluent-react/examples/html-markup/src/index.js b/fluent-react/examples/html-markup/src/index.js
@@ -3,11 +3,11 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import { LocalizationProvider } from 'fluent-react/compat';
 
-import { generateMessages } from './l10n';
+import { generateBundles } from './l10n';
 import App from './App';
 
 ReactDOM.render(
-  <LocalizationProvider messages={generateMessages(navigator.languages)}>
+  <LocalizationProvider bundles={generateBundles(navigator.languages)}>
     <App />
   </LocalizationProvider>,
   document.getElementById('root')
diff --git a/fluent-react/examples/html-markup/src/l10n.js b/fluent-react/examples/html-markup/src/l10n.js
@@ -21,7 +21,7 @@ agree-alert = Cool, agreed.
   `,
 };
 
-export function* generateMessages(userLocales) {
+export function* generateBundles(userLocales) {
   // Choose locales that are best for the user.
   const currentLocales = negotiateLanguages(
     userLocales,
diff --git a/fluent-react/examples/redux-async/src/actions.js b/fluent-react/examples/redux-async/src/actions.js
@@ -29,7 +29,7 @@ export function changeLocales(userLocales) {
       (obj, cur) => Object.assign(obj, cur)
     );
 
-    const generateMessages = function* () {
+    const generateBundles = function* () {
       for (const locale of currentLocales) {
         const bundle = new FluentBundle(locale);
         bundle.addMessages(messages[locale]);
@@ -41,7 +41,7 @@ export function changeLocales(userLocales) {
       type: 'CHANGE_LOCALES_RESPONSE',
       userLocales,
       currentLocales,
-      messages: generateMessages()
+      bundles: generateBundles()
     });
   };
 }
diff --git a/fluent-react/examples/redux-async/src/l10n.js b/fluent-react/examples/redux-async/src/l10n.js
@@ -13,22 +13,22 @@ class AppLocalizationProvider extends Component {
   }
 
   render() {
-    const { messages, children } = this.props;
+    const { bundles, children } = this.props;
 
-    if (!messages) {
+    if (!bundles) {
       // Show a loader
       return <div>…</div>;
     }
 
     return (
-      <LocalizationProvider messages={messages}>
+      <LocalizationProvider bundles={bundles}>
         {children}
       </LocalizationProvider>
     );
   }
 }
 
-const mapStateToProps = state => ({ messages: state.messages });
+const mapStateToProps = state => ({ bundles: state.bundles });
 const mapDispatchToProps = { changeLocales };
 
 export default connect(mapStateToProps, mapDispatchToProps)(
diff --git a/fluent-react/examples/redux-async/src/reducer.js b/fluent-react/examples/redux-async/src/reducer.js
@@ -2,7 +2,7 @@ export default function reducer(state = {
   isFetching: false,
   userLocales: ['en-US'],
   currentLocales: ['en-US'],
-  messages: null
+  bundles: null
 }, action) {
   switch (action.type) {
     case 'CHANGE_LOCALES_REQUEST': {
@@ -12,13 +12,13 @@ export default function reducer(state = {
       };
     }
     case 'CHANGE_LOCALES_RESPONSE': {
-      const { userLocales, currentLocales, messages } = action;
+      const { userLocales, currentLocales, bundles } = action;
       return {
         ...state,
         isFetching: false,
         userLocales,
         currentLocales,
-        messages
+        bundles
       };
     }
     default:
diff --git a/fluent-react/examples/redux-sync/src/actions.js b/fluent-react/examples/redux-sync/src/actions.js
@@ -21,7 +21,7 @@ export function changeLocales(userLocales) {
     { defaultLocale: 'en-US' }
   );
 
-  const generateMessages = function* () {
+  const generateBundles = function* () {
     for (const locale of currentLocales) {
       const bundle = new FluentBundle(locale);
       bundle.addMessages(MESSAGES_ALL[locale]);
@@ -33,6 +33,6 @@ export function changeLocales(userLocales) {
     type: 'CHANGE_LOCALES',
     userLocales,
     currentLocales,
-    messages: generateMessages()
+    bundles: generateBundles()
   };
 }
diff --git a/fluent-react/examples/redux-sync/src/l10n.js b/fluent-react/examples/redux-sync/src/l10n.js
@@ -12,22 +12,22 @@ class AppLocalizationProvider extends Component {
   }
 
   render() {
-    const { messages, children } = this.props;
+    const { bundles, children } = this.props;
 
-    if (!messages) {
+    if (!bundles) {
       // Show a loader
       return <div>…</div>;
     }
 
     return (
-      <LocalizationProvider messages={messages}>
+      <LocalizationProvider bundles={bundles}>
         {children}
       </LocalizationProvider>
     );
   }
 }
 
-const mapStateToProps = state => ({ messages: state.messages });
+const mapStateToProps = state => ({ bundles: state.bundles });
 const mapDispatchToProps = { changeLocales };
 
 export default connect(mapStateToProps, mapDispatchToProps)(
diff --git a/fluent-react/examples/redux-sync/src/reducer.js b/fluent-react/examples/redux-sync/src/reducer.js
@@ -1,16 +1,16 @@
 export default function reducer(state = {
   userLocales: ['en-US'],
   currentLocales: ['en-US'],
-  messages: null
+  bundles: null
 }, action) {
   switch (action.type) {
     case 'CHANGE_LOCALES': {
-      const { userLocales, currentLocales, messages } = action;
+      const { userLocales, currentLocales, bundles } = action;
       return {
         ...state,
         userLocales,
         currentLocales,
-        messages
+        bundles
       };
     }
     default:
diff --git a/fluent-react/examples/text-input/src/index.js b/fluent-react/examples/text-input/src/index.js
@@ -3,11 +3,11 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import { LocalizationProvider } from 'fluent-react/compat';
 
-import { generateMessages } from './l10n';
+import { generateBundles } from './l10n';
 import App from './App';
 
 ReactDOM.render(
-  <LocalizationProvider messages={generateMessages(navigator.languages)}>
+  <LocalizationProvider bundles={generateBundles(navigator.languages)}>
     <App />
   </LocalizationProvider>,
   document.getElementById('root')
diff --git a/fluent-react/examples/text-input/src/l10n.js b/fluent-react/examples/text-input/src/l10n.js
@@ -17,7 +17,7 @@ type-name =
   `,
 };
 
-export function* generateMessages(userLocales) {
+export function* generateBundles(userLocales) {
   // Choose locales that are best for the user.
   const currentLocales = negotiateLanguages(
     userLocales,
diff --git a/fluent-react/src/index.js b/fluent-react/src/index.js
@@ -7,7 +7,7 @@
  * React's Components system and the virtual DOM.  Translations are exposed to
  * components via the provider pattern.
  *
- *     <LocalizationProvider messages={…}>
+ *     <LocalizationProvider bundles={…}>
  *         <Localized id="hello-world">
  *             <p>{'Hello, world!'}</p>
  *         </Localized>
diff --git a/fluent-react/src/localization.js b/fluent-react/src/localization.js
@@ -11,33 +11,33 @@ import { CachedSyncIterable } from "cached-iterable";
  *
  * `Localized` components must subscribe to the changes of the
  * `ReactLocalization`'s fallback chain.  When the fallback chain changes (the
- * `messages` iterable is set anew), all subscribed compontent must relocalize.
+ * `bundles` iterable is set anew), all subscribed compontent must relocalize.
  *
  * The `ReactLocalization` class instances are exposed to `Localized` elements
  * via the `LocalizationProvider` component.
  */
 export default class ReactLocalization {
-  constructor(messages) {
-    this.bundles = CachedSyncIterable.from(messages);
+  constructor(bundles) {
+    this.bundles = CachedSyncIterable.from(bundles);
     this.subs = new Set();
   }
 
   /*
-   * Subscribe a `Localized` component to changes of `messages`.
+   * Subscribe a `Localized` component to changes of `bundles`.
    */
   subscribe(comp) {
     this.subs.add(comp);
   }
 
   /*
-   * Unsubscribe a `Localized` component from `messages` changes.
+   * Unsubscribe a `Localized` component from `bundles` changes.
    */
   unsubscribe(comp) {
     this.subs.delete(comp);
   }
 
   /*
-   * Set a new `messages` iterable and trigger the retranslation.
+   * Set a new `bundles` iterable and trigger the retranslation.
    */
   setBundles(bundles) {
     this.bundles = CachedSyncIterable.from(bundles);
diff --git a/fluent-react/src/provider.js b/fluent-react/src/provider.js
diff --git a/fluent-react/test/localized_change_test.js b/fluent-react/test/localized_change_test.js
diff --git a/fluent-react/test/localized_valid_test.js b/fluent-react/test/localized_valid_test.js
diff --git a/fluent-react/test/provider_change_test.js b/fluent-react/test/provider_change_test.js
diff --git a/fluent-react/test/provider_context_test.js b/fluent-react/test/provider_context_test.js
diff --git a/fluent-react/test/provider_valid_test.js b/fluent-react/test/provider_valid_test.js
diff --git a/fluent-react/test/with_localization_test.js b/fluent-react/test/with_localization_test.js
