simple-subtitle-parser/source/Parsers/Parser/index.spec.ts

_(previously, subtitle-parsing-tool)_

import Parser from "./";

describe("Parser", () => {
  describe("processStringToArray should", () => {
    test("split the 2 line string into an array of 2 items", () => {
      const string = `Something was written
on the stone`;
      const result = Parser.processStringToArray(string);

      expect(result).toEqual(["Something was written", "on the stone"]);
    });
  });

  describe("processArrayToArrayBlocks should", () => {
    test("recognise the empty breaks in the SRT sample and output an array of arrays", () => {
      const multiline = [
        "1",
        "00:01:48,108 --> 00:01:51,443",
        "Text",
        "",
        "2",
        "00:01:56,699 --> 00:01:59,827",
        "More text",
      ];
      const result = Parser.processArrayToArrayBlocks(multiline);

      expect(result).toEqual([
        ["1", "00:01:48,108 --> 00:01:51,443", "Text"],
        ["2", "00:01:56,699 --> 00:01:59,827", "More text"],
      ]);
    });

    test("recognise the empty breaks in the WebVTT sample and output an array of arrays", () => {
      const multiline = [
        "WEBVTT",
        "",
        "STYLE",
        "::cue {",
        "\tbackground-image: linear-gradient(to bottom, dimgray, lightgray);",
        "\tcolor: papayawhip;",
        "}",
        '/* Style blocks cannot use blank lines nor "dash dash greater than" */',
        "",
        "NOTE comment blocks can be used between style blocks.",
        "",
        "STYLE",
        "::cue(b) {",
        "\tcolor: peachpuff;",
        "}",
        "",
        "1",
        "00:00:00.000 --> 00:00:10.000",
        "- Hello <b>world</b>.",
        "",
        "NOTE style blocks cannot appear after the first cue.",
      ];
      const result = Parser.processArrayToArrayBlocks(multiline);

      expect(result).toEqual([
        ["WEBVTT"],
        [
          "STYLE",
          "::cue {",
          "\tbackground-image: linear-gradient(to bottom, dimgray, lightgray);",
          "\tcolor: papayawhip;",
          "}",
          '/* Style blocks cannot use blank lines nor "dash dash greater than" */',
        ],
        ["NOTE comment blocks can be used between style blocks."],
        ["STYLE", "::cue(b) {", "\tcolor: peachpuff;", "}"],
        ["1", "00:00:00.000 --> 00:00:10.000", "- Hello <b>world</b>."],
        ["NOTE style blocks cannot appear after the first cue."],
      ]);
    });
  });

  describe("dropEmptyArrayBlocks", () => {
    test("should drop empty raw cues", () => {
      const result = Parser.dropEmptyArrayBlocks([
        ["1", "00:01:48,108 --> 00:01:51,443", "Text"],
        [],
        ["2", "00:01:56,699 --> 00:01:59,827", "More text"],
        [],
        [],
      ]);

      expect(result).toEqual([
        ["1", "00:01:48,108 --> 00:01:51,443", "Text"],
        ["2", "00:01:56,699 --> 00:01:59,827", "More text"],
      ]);
    });
  });

  describe("processArrayBlocksToCues should", () => {
    test("map the array of arrays into an array of objects, with the properties correctly identified", () => {
      const result = Parser.processArrayBlocksToCues(
        [
          ["1", "00:01:48,108 --> 00:01:51,443", "Text"],
          ["2", "00:01:56,699 --> 00:01:59,827", "More text"],
        ],
        "-->"
      );

      expect(result).toEqual([
        {
          sequence: 0,
          startTime: {
            hours: 0,
            minutes: 1,
            seconds: 48,
            ms: 108,
            totals: { inSeconds: 108.108 },
          },
          endTime: {
            hours: 0,
            minutes: 1,
            seconds: 51,
            ms: 443,
            totals: { inSeconds: 111.443 },
          },
          text: ["Text"],
        },
        {
          sequence: 1,
          startTime: {
            hours: 0,
            minutes: 1,
            seconds: 56,
            ms: 699,
            totals: { inSeconds: 116.699 },
          },
          endTime: {
            hours: 0,
            minutes: 1,
            seconds: 59,
            ms: 827,
            totals: { inSeconds: 119.827 },
          },
          text: ["More text"],
        },
      ]);
    });

    test("Should not confuse a numeric caption for a sequence marker", () => {
      const result = Parser.processArrayBlocksToCues(
        [["1", "00:01:48,108 --> 00:01:51,443", "12"]],
        "-->"
      );

      expect(result).toEqual([
        {
          sequence: 0,
          startTime: {
            hours: 0,
            minutes: 1,
            seconds: 48,
            ms: 108,
            totals: { inSeconds: 108.108 },
          },
          endTime: {
            hours: 0,
            minutes: 1,
            seconds: 51,
            ms: 443,
            totals: { inSeconds: 111.443 },
          },
          text: ["12"],
        },
      ]);
    });

    test("correctly map if the WebVTT does not include the optional cue identifier", () => {
      const result = Parser.processArrayBlocksToCues(
        [
          ["00:01:48,108 --> 00:01:51,443", "Text"],
          ["00:01:56,699 --> 00:01:59,827", "More text"],
        ],
        "-->"
      );

      expect(result).toEqual([
        {
          sequence: 0,
          startTime: {
            hours: 0,
            minutes: 1,
            seconds: 48,
            ms: 108,
            totals: { inSeconds: 108.108 },
          },
          endTime: {
            hours: 0,
            minutes: 1,
            seconds: 51,
            ms: 443,
            totals: { inSeconds: 111.443 },
          },
          text: ["Text"],
        },
        {
          sequence: 1,
          startTime: {
            hours: 0,
            minutes: 1,
            seconds: 56,
            ms: 699,
            totals: { inSeconds: 116.699 },
          },
          endTime: {
            hours: 0,
            minutes: 1,
            seconds: 59,
            ms: 827,
            totals: { inSeconds: 119.827 },
          },
          text: ["More text"],
        },
      ]);
    });

    test("Throw error if the start time is greater than the end time", () => {
      expect(() => {
        Parser.processArrayBlocksToCues(
          [["1", "00:01:51,443 --> 00:01:48,108", "Text"]],
          "-->"
        );
      }).toThrowError();
    });

    test("Throw error if the start time is the same as the end time", () => {
      expect(() => {
        Parser.processArrayBlocksToCues([["1", "0 --> 0", "Text"]], "-->");
      }).toThrowError();
    });
  });
});