video.js/test/unit/tracks/text-track-settings.test.js

/* eslint-env qunit */
import TextTrackSettings from '../../../src/js/tracks/text-track-settings.js';
import TestHelpers from '../test-helpers.js';
import * as Events from '../../../src/js/utils/events.js';
import safeParseTuple from 'safe-json-parse/tuple';
import window from 'global/window';

const tracks = [{
  kind: 'captions',
  label: 'test'
}];

const defaultSettings = {
  backgroundColor: '#000',
  backgroundOpacity: '1',
  color: '#FFF',
  fontFamily: 'proportionalSansSerif',
  textOpacity: '1',
  windowColor: '#000',
  windowOpacity: '0'
};

QUnit.module('Text Track Settings', {
  beforeEach() {
    window.localStorage.clear();
  }
});

QUnit.test('should update settings', function() {
  const player = TestHelpers.makePlayer({
    tracks,
    persistTextTrackSettings: true
  });
  const newSettings = {
    backgroundOpacity: '0.5',
    textOpacity: '0.5',
    windowOpacity: '0.5',
    edgeStyle: 'raised',
    fontFamily: 'monospaceSerif',
    color: '#F00',
    backgroundColor: '#FFF',
    windowColor: '#FFF',
    fontPercent: 1.25
  };

  player.textTrackSettings.setValues(newSettings);
  QUnit.deepEqual(player.textTrackSettings.getValues(),
                  newSettings,
                  'values are updated');

  QUnit.equal(player.$('.vjs-fg-color > select').selectedIndex,
              2,
              'fg-color is set to new value');
  QUnit.equal(player.$('.vjs-bg-color > select').selectedIndex,
              1,
              'bg-color is set to new value');
  QUnit.equal(player.$('.window-color > select').selectedIndex,
              1,
              'window-color is set to new value');
  QUnit.equal(player.$('.vjs-text-opacity > select').selectedIndex,
              1,
              'text-opacity is set to new value');
  QUnit.equal(player.$('.vjs-bg-opacity > select').selectedIndex,
              1,
              'bg-opacity is set to new value');
  QUnit.equal(player.$('.vjs-window-opacity > select').selectedIndex,
              1,
              'window-opacity is set to new value');
  QUnit.equal(player.$('.vjs-edge-style select').selectedIndex,
              1,
              'edge-style is set to new value');
  QUnit.equal(player.$('.vjs-font-family select').selectedIndex,
              3,
              'font-family is set to new value');
  QUnit.equal(player.$('.vjs-font-percent select').selectedIndex,
              3,
              'font-percent is set to new value');

  Events.trigger(player.$('.vjs-done-button'), 'click');
  QUnit.deepEqual(safeParseTuple(
                    window.localStorage.getItem('vjs-text-track-settings'))[1],
                  newSettings,
                  'values are saved');

  player.dispose();
});

QUnit.test('should restore default settings', function() {
  const player = TestHelpers.makePlayer({
    tracks,
    persistTextTrackSettings: true
  });

  player.$('.vjs-fg-color > select').selectedIndex = 1;
  player.$('.vjs-bg-color > select').selectedIndex = 1;
  player.$('.window-color > select').selectedIndex = 1;
  player.$('.vjs-text-opacity > select').selectedIndex = 1;
  player.$('.vjs-bg-opacity > select').selectedIndex = 1;
  player.$('.vjs-window-opacity > select').selectedIndex = 1;
  player.$('.vjs-edge-style select').selectedIndex = 1;
  player.$('.vjs-font-family select').selectedIndex = 1;
  player.$('.vjs-font-percent select').selectedIndex = 3;

  Events.trigger(player.$('.vjs-done-button'), 'click');
  Events.trigger(player.$('.vjs-default-button'), 'click');
  Events.trigger(player.$('.vjs-done-button'), 'click');

  QUnit.deepEqual(player.textTrackSettings.getValues(),
                  defaultSettings,
                  'values are defaulted');
  // TODO:
  // MikeA: need to figure out how to modify saveSettings
  // to factor in defaults are no longer null
  // QUnit.deepEqual(window.localStorage.getItem('vjs-text-track-settings'),
  //                 defaultSettings,
  //                 'values are saved');

  QUnit.equal(player.$('.vjs-fg-color > select').selectedIndex,
              0,
              'fg-color is set to default value');
  QUnit.equal(player.$('.vjs-bg-color > select').selectedIndex,
              0,
              'bg-color is set to default value');
  QUnit.equal(player.$('.window-color > select').selectedIndex,
              0,
              'window-color is set to default value');
  QUnit.equal(player.$('.vjs-text-opacity > select').selectedIndex,
              0,
              'text-opacity is set to default value');
  QUnit.equal(player.$('.vjs-bg-opacity > select').selectedIndex,
              0,
              'bg-opacity is set to default value');
  QUnit.equal(player.$('.vjs-window-opacity > select').selectedIndex,
              0,
              'window-opacity is set to default value');
  QUnit.equal(player.$('.vjs-edge-style select').selectedIndex,
              0,
              'edge-style is set to default value');
  QUnit.equal(player.$('.vjs-font-family select').selectedIndex,
              0,
              'font-family is set to default value');
  QUnit.equal(player.$('.vjs-font-percent select').selectedIndex,
              2,
              'font-percent is set to default value');

  player.dispose();
});

QUnit.test('should open on click', function() {
  const player = TestHelpers.makePlayer({
    tracks
  });

  Events.trigger(player.$('.vjs-texttrack-settings'), 'click');
  QUnit.ok(!player.textTrackSettings.hasClass('vjs-hidden'), 'settings open');

  player.dispose();
});

QUnit.test('should close on done click', function() {
  const player = TestHelpers.makePlayer({
    tracks
  });

  Events.trigger(player.$('.vjs-texttrack-settings'), 'click');
  Events.trigger(player.$('.vjs-done-button'), 'click');
  QUnit.ok(player.textTrackSettings.hasClass('vjs-hidden'), 'settings closed');

  player.dispose();
});

QUnit.test('if persist option is set, restore settings on init', function() {
  const oldRestoreSettings = TextTrackSettings.prototype.restoreSettings;
  let restore = 0;

  TextTrackSettings.prototype.restoreSettings = function() {
    restore++;
  };

  const player = TestHelpers.makePlayer({
    tracks,
    persistTextTrackSettings: true
  });

  QUnit.equal(restore, 1, 'restore was called');

  TextTrackSettings.prototype.restoreSettings = oldRestoreSettings;

  player.dispose();
});

QUnit.test('if persist option is set, save settings when "done"', function() {
  const player = TestHelpers.makePlayer({
    tracks,
    persistTextTrackSettings: true
  });
  const oldSaveSettings = TextTrackSettings.prototype.saveSettings;
  let save = 0;

  TextTrackSettings.prototype.saveSettings = function() {
    save++;
  };

  Events.trigger(player.$('.vjs-done-button'), 'click');

  QUnit.equal(save, 1, 'save was called');

  TextTrackSettings.prototype.saveSettings = oldSaveSettings;

  player.dispose();
});

QUnit.test('do not try to restore or save settings if persist option is not set', function() {
  const oldRestoreSettings = TextTrackSettings.prototype.restoreSettings;
  const oldSaveSettings = TextTrackSettings.prototype.saveSettings;
  let save = 0;
  let restore = 0;

  TextTrackSettings.prototype.restoreSettings = function() {
    restore++;
  };
  TextTrackSettings.prototype.saveSettings = function() {
    save++;
  };

  const player = TestHelpers.makePlayer({
    tracks,
    persistTextTrackSettings: false
  });

  QUnit.equal(restore, 0, 'restore was not called');

  Events.trigger(player.$('.vjs-done-button'), 'click');

  // saveSettings is called but does nothing
  QUnit.equal(save, 1, 'save was not called');

  TextTrackSettings.prototype.saveSettings = oldSaveSettings;
  TextTrackSettings.prototype.restoreSettings = oldRestoreSettings;

  player.dispose();
});

QUnit.test('should restore saved settings', function() {
  const newSettings = {
    backgroundOpacity: '0.5',
    textOpacity: '0.5',
    windowOpacity: '0.5',
    edgeStyle: 'raised',
    fontFamily: 'monospaceSerif',
    color: '#F00',
    backgroundColor: '#FFF',
    windowColor: '#FFF',
    fontPercent: 1.25
  };

  window.localStorage.setItem('vjs-text-track-settings', JSON.stringify(newSettings));

  const player = TestHelpers.makePlayer({
    tracks,
    persistTextTrackSettings: true
  });

  QUnit.deepEqual(player.textTrackSettings.getValues(), newSettings);

  player.dispose();
});

QUnit.test('should not restore saved settings', function() {
  const newSettings = {
    backgroundOpacity: '0.5',
    textOpacity: '0.5',
    windowOpacity: '0.5',
    edgeStyle: 'raised',
    fontFamily: 'monospaceSerif',
    color: '#F00',
    backgroundColor: '#FFF',
    windowColor: '#FFF',
    fontPercent: 1.25
  };

  window.localStorage.setItem('vjs-text-track-settings', JSON.stringify(newSettings));

  const player = TestHelpers.makePlayer({
    tracks,
    persistTextTrackSettings: false
  });

  QUnit.deepEqual(player.textTrackSettings.getValues(), defaultSettings);

  player.dispose();
});