Welcome to mirror list, hosted at ThFree Co, Russian Federation.

po_to_json_spec.js « frontend « scripts « frontend « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 47d5ccfefd4c1cd6bc93818ed851d66bfb028974 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
import { join } from 'path';
import { tmpdir } from 'os';
import { readFile, rm, mkdtemp, stat } from 'fs/promises';
import {
  convertPoToJed,
  convertPoFileForLocale,
  main,
} from '../../../../scripts/frontend/po_to_json';

describe('PoToJson', () => {
  const LOCALE = 'de';
  const LOCALE_DIR = join(__dirname, '__fixtures__/locale');
  const PO_FILE = join(LOCALE_DIR, LOCALE, 'gitlab.po');
  const CONVERTED_FILE = join(LOCALE_DIR, LOCALE, 'converted.json');
  let DE_CONVERTED = null;

  beforeAll(async () => {
    DE_CONVERTED = Object.freeze(JSON.parse(await readFile(CONVERTED_FILE, 'utf-8')));
  });

  describe('tests writing to the file system', () => {
    let resultDir = null;

    afterEach(async () => {
      if (resultDir) {
        await rm(resultDir, { recursive: true, force: true });
      }
    });

    beforeEach(async () => {
      resultDir = await mkdtemp(join(tmpdir(), 'locale-test'));
    });

    describe('#main', () => {
      it('throws without arguments', () => {
        return expect(main()).rejects.toThrow(/doesn't seem to be a folder/);
      });

      it('throws if outputDir does not exist', () => {
        return expect(
          main({
            localeRoot: LOCALE_DIR,
            outputDir: 'i-do-not-exist',
          }),
        ).rejects.toThrow(/doesn't seem to be a folder/);
      });

      it('throws if localeRoot does not exist', () => {
        return expect(
          main({
            localeRoot: 'i-do-not-exist',
            outputDir: resultDir,
          }),
        ).rejects.toThrow(/doesn't seem to be a folder/);
      });

      it('converts folder of po files to app.js files', async () => {
        expect((await stat(resultDir)).isDirectory()).toBe(true);
        await main({ localeRoot: LOCALE_DIR, outputDir: resultDir });

        const resultFile = join(resultDir, LOCALE, 'app.js');
        expect((await stat(resultFile)).isFile()).toBe(true);

        window.translations = null;
        await import(resultFile);
        expect(window.translations).toEqual(DE_CONVERTED);
      });
    });

    describe('#convertPoFileForLocale', () => {
      it('converts simple PO to app.js, which exposes translations on the window', async () => {
        await convertPoFileForLocale({ locale: 'de', localeFile: PO_FILE, resultDir });

        const resultFile = join(resultDir, 'app.js');
        expect((await stat(resultFile)).isFile()).toBe(true);

        window.translations = null;
        await import(resultFile);
        expect(window.translations).toEqual(DE_CONVERTED);
      });
    });
  });

  describe('#convertPoToJed', () => {
    it('converts simple PO to JED compatible JSON', async () => {
      const poContent = await readFile(PO_FILE, 'utf-8');

      expect(convertPoToJed(poContent, LOCALE).jed).toEqual(DE_CONVERTED);
    });

    it('returns null for empty string', () => {
      const poContent = '';

      expect(convertPoToJed(poContent, LOCALE).jed).toEqual(null);
    });

    describe('PO File headers', () => {
      it('parses headers properly', () => {
        const poContent = `
msgid ""
msgstr ""
"Project-Id-Version: gitlab-ee\\n"
"Report-Msgid-Bugs-To: \\n"
"X-Crowdin-Project: gitlab-ee\\n"
`;

        expect(convertPoToJed(poContent, LOCALE).jed).toEqual({
          domain: 'app',
          locale_data: {
            app: {
              '': {
                'Project-Id-Version': 'gitlab-ee',
                'Report-Msgid-Bugs-To': '',
                'X-Crowdin-Project': 'gitlab-ee',
                domain: 'app',
                lang: LOCALE,
              },
            },
          },
        });
      });

      // JED needs that property, hopefully we could get
      // rid of this in a future iteration
      it("exposes 'Plural-Forms' as 'plural_forms' for `jed`", () => {
        const poContent = `
msgid ""
msgstr ""
"Plural-Forms: nplurals=2; plural=(n != 1);\\n"
`;

        expect(convertPoToJed(poContent, LOCALE).jed).toEqual({
          domain: 'app',
          locale_data: {
            app: {
              '': {
                'Plural-Forms': 'nplurals=2; plural=(n != 1);',
                plural_forms: 'nplurals=2; plural=(n != 1);',
                domain: 'app',
                lang: LOCALE,
              },
            },
          },
        });
      });

      it('removes POT-Creation-Date', () => {
        const poContent = `
msgid ""
msgstr ""
"Plural-Forms: nplurals=2; plural=(n != 1);\\n"
`;

        expect(convertPoToJed(poContent, LOCALE).jed).toEqual({
          domain: 'app',
          locale_data: {
            app: {
              '': {
                'Plural-Forms': 'nplurals=2; plural=(n != 1);',
                plural_forms: 'nplurals=2; plural=(n != 1);',
                domain: 'app',
                lang: LOCALE,
              },
            },
          },
        });
      });
    });

    describe('escaping', () => {
      it('escapes quotes in translation', () => {
        const poContent = `
# Escaped quotes in msgid and msgstr
msgid "Changes the title to \\"%{title_param}\\"."
msgstr "Ändert den Titel in \\"%{title_param}\\"."
`;

        expect(convertPoToJed(poContent, LOCALE).jed).toEqual({
          domain: 'app',
          locale_data: {
            app: {
              '': {
                domain: 'app',
                lang: LOCALE,
              },
              'Changes the title to "%{title_param}".': [
                'Ändert den Titel in \\"%{title_param}\\".',
              ],
            },
          },
        });
      });

      it('escapes backslashes in translation', () => {
        const poContent = `
# Escaped backslashes in msgid and msgstr
msgid "Example: ssh\\\\:\\\\/\\\\/"
msgstr "Beispiel: ssh\\\\:\\\\/\\\\/"
`;

        expect(convertPoToJed(poContent, LOCALE).jed).toEqual({
          domain: 'app',
          locale_data: {
            app: {
              '': {
                domain: 'app',
                lang: LOCALE,
              },
              'Example: ssh\\:\\/\\/': ['Beispiel: ssh\\\\:\\\\/\\\\/'],
            },
          },
        });
      });

      // This is potentially faulty behavior but demands further investigation
      // See also the escapeMsgstr method
      it('escapes \\n and \\t in translation', () => {
        const poContent = `
# Escaped \\n
msgid "Outdent line"
msgstr "Désindenter la ligne\\n"

# Escaped \\t
msgid "Headers"
msgstr "Cabeçalhos\\t"
`;

        expect(convertPoToJed(poContent, LOCALE).jed).toEqual({
          domain: 'app',
          locale_data: {
            app: {
              '': {
                domain: 'app',
                lang: LOCALE,
              },
              Headers: ['Cabeçalhos\\t'],
              'Outdent line': ['Désindenter la ligne\\n'],
            },
          },
        });
      });
    });
  });
});