aurelia/aurelia

import {
  I18nConfiguration,
  TranslationBindBindingCommand,
  TranslationBindBindingInstruction,
  TranslationBindBindingRenderer,
  TranslationBinding,
  TranslationBindingCommand,
  TranslationBindingInstruction,
  TranslationBindingRenderer,
  TranslationBindInstructionType,
  TranslationInstructionType,
} from '@aurelia/i18n';
import { Registration } from '@aurelia/kernel';
import { IExpressionParser } from '@aurelia/expression-parser';
import {
  IObserverLocator,
} from '@aurelia/runtime';
import {
  IBinding,
  IRenderer,
  IHydratableController,
  StandardConfiguration,
  IPlatform,
  BindingMode,
  AttrMapper,
} from '@aurelia/runtime-html';
import {
  AttrSyntax,
  BindingCommand,
  IAttrMapper,
  PropertyBindingInstruction,
  InstructionType,
} from '@aurelia/template-compiler';
import { assert, PLATFORM, createContainer } from '@aurelia/testing';

const noopLocator = {} as unknown as IObserverLocator;

describe('i18n/t/translation-renderer.spec.ts', function () {

  describe('TranslationBindingCommand', function () {
    function createFixture(aliases?: string[]) {
      aliases = aliases || [];
      const container = createContainer().register(
        BindingCommand.define({ name: 't', aliases }, TranslationBindingCommand)
      );
      if (!aliases.includes('t')) {
        aliases.push('t');
      }
      return aliases.reduce(
        (acc: TranslationBindingCommand[], alias) => {
          acc.push(
            container.get<TranslationBindingCommand>(BindingCommand.keyFrom(alias)),
          );
          return acc;
        },
        []);
    }

    it('registers alias commands when provided', function () {
      const aliases = ['t', 'i18n'];
      const suts = createFixture(aliases);

      assert.equal(suts.length, aliases.length);
      assert.equal(
        suts.every((sut) => sut instanceof TranslationBindingCommand),
        true);
    });

    it('compiles the binding to a TranslationBindingInstruction', function () {
      const [sut] = createFixture();
      const syntax: AttrSyntax = { command: 't', rawName: 't', rawValue: 'obj.key', target: '', parts: [] };
      const actual = sut.build({
        node: { nodeName: 'abc' } as unknown as Element,
        attr: syntax,
        bindable: null,
        def: null,
      }, null, { map: (_, name) => name } as any);

      assert.instanceOf(actual, TranslationBindingInstruction);
    });
  });

  describe('TranslationBindingRenderer', function () {

    function createFixture() {
      return createContainer(StandardConfiguration, I18nConfiguration);
    }

    it('instantiated with instruction type', function () {
      const sut: IRenderer = new TranslationBindingRenderer();
      assert.equal(sut.target, TranslationInstructionType);
    });

    it('#render instantiates TranslationBinding - simple string literal', function () {
      const container = createFixture();
      const sut: IRenderer = new TranslationBindingRenderer();
      const expressionParser = container.get(IExpressionParser);
      const controller = ({ container, bindings: [], addBinding(binding) { (controller.bindings as unknown as IBinding[]).push(binding); } } as unknown as IHydratableController);

      const from = expressionParser.parse('simple.key', 'IsCustom');
      const callBindingInstruction: PropertyBindingInstruction = { type: InstructionType.propertyBinding, from, to: 'value', mode: BindingMode.oneTime };
      sut.render(
        controller,
        PLATFORM.document.createElement('span'),
        callBindingInstruction,
        PLATFORM,
        expressionParser,
        noopLocator,
      );

      assert.instanceOf(controller.bindings[0], TranslationBinding);
    });

    it('#render adds expr to the existing TranslationBinding for the target element', function () {
      const container = createFixture();
      const sut: IRenderer = new TranslationBindingRenderer();
      const expressionParser = container.get(IExpressionParser);
      const targetElement = PLATFORM.document.createElement('span');
      const binding = new TranslationBinding({ state: 0 }, container, {} as unknown as IObserverLocator, container.get(IPlatform), targetElement);
      const controller = ({ container, bindings: [binding], addBinding(binding) { (controller.bindings as unknown as IBinding[]).push(binding); } } as unknown as IHydratableController);

      const from = expressionParser.parse('simple.key', 'IsCustom');
      const callBindingInstruction: PropertyBindingInstruction = { type: InstructionType.propertyBinding, from, to: 'value', mode: BindingMode.oneTime };
      sut.render(
        controller,
        targetElement,
        callBindingInstruction,
        PLATFORM,
        expressionParser,
        noopLocator
      );

      assert.equal(binding.ast, from);
    });
  });

  describe('TranslationBindBindingCommand', function () {
    function createFixture(aliases?: string[]) {
      aliases = aliases || [];
      aliases = aliases.map(alias => `${alias}.bind`);
      const container = createContainer().register(
        BindingCommand.define({ name: 't.bind', aliases }, TranslationBindBindingCommand),
        Registration.singleton(IAttrMapper, AttrMapper),
      );
      if (!aliases.includes('t.bind')) {
        aliases.push('t.bind');
      }
      return {
        container,
        parser: container.get(IExpressionParser),
        mapper: container.get(IAttrMapper),
        suts: aliases.map(alias => container.get<TranslationBindBindingCommand>(BindingCommand.keyFrom(alias)))
      };
    }

    it('registers alias commands when provided', function () {
      const aliases = ['t', 'i18n'];
      const { suts} = createFixture(aliases);

      assert.equal(suts.length, aliases.length);
      assert.equal(
        suts.every((sut) => sut instanceof TranslationBindBindingCommand),
        true);
    });

    it('compiles the binding to a TranslationBindBindingInstruction', function () {
      const { parser, mapper, suts: [sut] } = createFixture();
      const syntax: AttrSyntax = { command: 't.bind', rawName: 't.bind', rawValue: 'obj.key', target: 'bind', parts: [] };
      const actual = sut.build({
        node: { nodeName: 'abc' } as unknown as Element,
        attr: syntax,
        bindable: null,
        def: null,
      }, parser, mapper);

      assert.instanceOf(actual, TranslationBindBindingInstruction);
    });
  });

  describe('TranslationBindBindingRenderer', function () {

    function createFixture() {
      const container = createContainer();
      container.register(StandardConfiguration, I18nConfiguration);
      return container;
    }

    it('instantiated with instruction type', function () {
      const sut: IRenderer = new TranslationBindBindingRenderer();
      assert.equal(sut.target, TranslationBindInstructionType);
    });

    it('#render instantiates TranslationBinding - simple string literal', function () {
      const container = createFixture();
      const sut: IRenderer = new TranslationBindBindingRenderer();
      const expressionParser = container.get(IExpressionParser);
      const controller = ({ container, bindings: [], addBinding(binding) { (controller.bindings as unknown as IBinding[]).push(binding); } } as unknown as IHydratableController);

      const from = expressionParser.parse('simple.key', 'IsProperty');
      const callBindingInstruction: PropertyBindingInstruction = { type: InstructionType.propertyBinding, from, to: 'value', mode: BindingMode.oneTime };
      sut.render(
        controller,
        PLATFORM.document.createElement('span'),
        callBindingInstruction,
        PLATFORM,
        expressionParser,
        noopLocator,
      );

      assert.instanceOf(controller.bindings[0], TranslationBinding);
    });

    it('#render instantiates TranslationBinding - .bind expr', function () {
      const container = createFixture();
      const sut: IRenderer = new TranslationBindBindingRenderer();
      const expressionParser = container.get(IExpressionParser);
      const controller = ({ container, bindings: [], addBinding(binding) { (controller.bindings as unknown as IBinding[]).push(binding); } } as unknown as IHydratableController);

      const from = expressionParser.parse('simple.key', 'IsProperty');
      const callBindingInstruction: PropertyBindingInstruction = { type: InstructionType.propertyBinding, from, to: 'value', mode: BindingMode.oneTime };
      sut.render(
        controller,
        PLATFORM.document.createElement('span'),
        callBindingInstruction,
        PLATFORM,
        expressionParser,
        noopLocator,
      );

      assert.instanceOf(controller.bindings[0], TranslationBinding);
    });

    it('#render adds expr to the existing TranslationBinding for the target element', function () {
      const container = createFixture();
      const sut: IRenderer = new TranslationBindBindingRenderer();
      const expressionParser = container.get(IExpressionParser);
      const targetElement = PLATFORM.document.createElement('span');
      const binding = new TranslationBinding({ state: 0 }, container, {} as unknown as IObserverLocator, container.get(IPlatform), targetElement);
      const controller = ({ container, bindings: [binding], addBinding(binding) { (controller.bindings as unknown as IBinding[]).push(binding); } } as unknown as IHydratableController);

      const from = expressionParser.parse('simple.key', 'IsProperty');
      const callBindingInstruction: PropertyBindingInstruction = { type: InstructionType.propertyBinding, from, to: 'value', mode: BindingMode.oneTime };
      sut.render(
        controller,
        targetElement,
        callBindingInstruction,
        PLATFORM,
        expressionParser,
        noopLocator,
      );

      assert.equal(binding.ast, from);
    });
  });
});