Don't store the IntlShape in CharacterDescriptionBuilder

Author: sbates-idrc

src/App.js

@@ -259,7 +259,7 @@ export class App extends React.Component<AppProps, AppState> {
 
         this.announcementBuilder = new AnnouncementBuilder(this.props.intl);
 
-        this.characterDescriptionBuilder = new CharacterDescriptionBuilder(this.props.intl);
+        this.characterDescriptionBuilder = new CharacterDescriptionBuilder();
 
         this.designModeCursorDescriptionBuilder = new DesignModeCursorDescriptionBuilder(this.props.intl);
 

src/CharacterAriaLive.js

@@ -71,7 +71,8 @@ class CharacterAriaLive extends React.Component<CharacterAriaLiveProps, {}> {
         text += this.props.characterDescriptionBuilder.buildDescription(
             this.props.characterState,
             this.props.world,
-            this.props.customBackground
+            this.props.customBackground,
+            this.props.intl
         );
 
         this.setLiveRegion(text);

src/CharacterAriaLive.test.js

@@ -45,7 +45,7 @@ const defaultCharacterAriaLiveProps = {
     world: 'Sketchpad',
     customBackground: emptyCustomBackground,
     customBackgroundDesignMode: false,
-    characterDescriptionBuilder: new CharacterDescriptionBuilder(intl),
+    characterDescriptionBuilder: new CharacterDescriptionBuilder(),
     designModeCursorDescriptionBuilder: new DesignModeCursorDescriptionBuilder(intl),
     message: null
 };

src/CharacterDescriptionBuilder.js

@@ -7,14 +7,9 @@ import { getBackgroundSquareDescription } from './Utils';
 import type { WorldName } from './Worlds';
 
 export default class CharacterDescriptionBuilder {
-    intl: IntlShape;
-
-    constructor(intl: IntlShape) {
-        this.intl = intl;
-    }
-
     buildDescription(characterState: CharacterState,
-        world: WorldName, customBackground: CustomBackground): string {
+        world: WorldName, customBackground: CustomBackground,
+        intl: IntlShape): string {
 
         const columnLabel = characterState.getColumnLabel();
         const rowLabel = characterState.getRowLabel();
@@ -25,13 +20,13 @@ export default class CharacterDescriptionBuilder {
             characterState.sceneDimensions,
             world,
             customBackground,
-            this.intl
+            intl
         );
 
-        const directionLabel = this.intl.formatMessage({id: `Direction.${characterState.direction}`});
+        const directionLabel = intl.formatMessage({id: `Direction.${characterState.direction}`});
 
         if (itemLabel) {
-            return this.intl.formatMessage(
+            return intl.formatMessage(
                 {
                     id:'CharacterDescriptionBuilder.positionAndDirectionAndItem'
                 },
@@ -43,7 +38,7 @@ export default class CharacterDescriptionBuilder {
                 }
             );
         } else {
-            return this.intl.formatMessage(
+            return intl.formatMessage(
                 {
                     id:'CharacterDescriptionBuilder.positionAndDirection'
                 },

src/CharacterDescriptionBuilder.test.js

@@ -17,94 +17,106 @@ const sceneDimensions = new SceneDimensions(1, 12, 1, 8);
 const emptyCustomBackground = new CustomBackground(sceneDimensions);
 
 test('All 8 directions', () => {
-    const builder = new CharacterDescriptionBuilder(intl);
+    const builder = new CharacterDescriptionBuilder();
 
     expect(builder.buildDescription(
         new CharacterState(1, 1, 0, [], sceneDimensions),
         'Sketchpad',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At A 1 facing up');
 
     expect(builder.buildDescription(
         new CharacterState(1, 1, 1, [], sceneDimensions),
         'Sketchpad',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At A 1 facing upper right');
 
     expect(builder.buildDescription(
         new CharacterState(1, 1, 2, [], sceneDimensions),
         'Sketchpad',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At A 1 facing right');
 
     expect(builder.buildDescription(
         new CharacterState(1, 1, 3, [], sceneDimensions),
         'Sketchpad',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At A 1 facing lower right');
 
     expect(builder.buildDescription(
         new CharacterState(1, 1, 4, [], sceneDimensions),
         'Sketchpad',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At A 1 facing down');
 
     expect(builder.buildDescription(
         new CharacterState(1, 1, 5, [], sceneDimensions),
         'Sketchpad',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At A 1 facing lower left');
 
     expect(builder.buildDescription(
         new CharacterState(1, 1, 6, [], sceneDimensions),
         'Sketchpad',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At A 1 facing left');
 
     expect(builder.buildDescription(
         new CharacterState(1, 1, 7, [], sceneDimensions),
         'Sketchpad',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At A 1 facing upper left');
 });
 
 test('Space, background description: no, custom background tile: no', () => {
-    const builder = new CharacterDescriptionBuilder(intl);
+    const builder = new CharacterDescriptionBuilder();
     expect(builder.buildDescription(
         new CharacterState(3, 2, 2, [], sceneDimensions),
         'Space',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At C 2 facing right');
 });
 
 test('Space, background description: no, custom background tile: yes', () => {
-    const builder = new CharacterDescriptionBuilder(intl);
+    const builder = new CharacterDescriptionBuilder();
     expect(builder.buildDescription(
         new CharacterState(3, 2, 2, [], sceneDimensions),
         'Space',
         new CustomBackground(sceneDimensions, [
             '0', '0', '0', '0', '0', '0', '0', '0', '0', '0', '0', '0',
             '0', '0', '1'
-        ])
+        ]),
+        intl
     )).toBe('At C 2 on wall facing right');
 });
 
 test('Space, background description: yes, custom background tile: no', () => {
-    const builder = new CharacterDescriptionBuilder(intl);
+    const builder = new CharacterDescriptionBuilder();
     expect(builder.buildDescription(
         new CharacterState(3, 1, 2, [], sceneDimensions),
         'Space',
-        emptyCustomBackground
+        emptyCustomBackground,
+        intl
     )).toBe('At C 1 on the Moon facing right');
 });
 
 test('Space, background description: yes, custom background tile: yes', () => {
-    const builder = new CharacterDescriptionBuilder(intl);
+    const builder = new CharacterDescriptionBuilder();
     expect(builder.buildDescription(
         new CharacterState(3, 1, 2, [], sceneDimensions),
         'Space',
         new CustomBackground(sceneDimensions, [
             '0', '0', '1'
-        ])
+        ]),
+        intl
     )).toBe('At C 1 on wall facing right');
 });

src/Scene.js

@@ -75,7 +75,8 @@ class Scene extends React.Component<SceneProps, {}> {
         const characterDescription = this.props.characterDescriptionBuilder.buildDescription(
             this.props.characterState,
             this.props.world,
-            this.props.customBackground
+            this.props.customBackground,
+            this.props.intl
         );
 
         return this.props.intl.formatMessage(

src/Scene.test.js

@@ -3,7 +3,7 @@
 import React from 'react';
 import Adapter from 'enzyme-adapter-react-16';
 import { configure, mount } from 'enzyme';
-import { createIntl, IntlProvider } from 'react-intl';
+import { IntlProvider } from 'react-intl';
 import messages from './messages.json';
 import Scene from './Scene';
 import type {SceneProps} from './Scene';
@@ -15,12 +15,6 @@ import DesignModeCursorState from './DesignModeCursorState';
 
 configure({ adapter: new Adapter() });
 
-const intl = createIntl({
-    locale: 'en',
-    defaultLocale: 'en',
-    messages: messages.en
-});
-
 const defaultDimensions = new SceneDimensions(1, 1, 1, 1);
 
 const defaultSceneProps = {
@@ -33,7 +27,7 @@ const defaultSceneProps = {
     customBackgroundDesignMode: false,
     startingX: 1,
     startingY: 2,
-    characterDescriptionBuilder: new CharacterDescriptionBuilder(intl)
+    characterDescriptionBuilder: new CharacterDescriptionBuilder()
 };
 
 function createMountScene(props) {