import $ from 'jquery'; import { insertMarkdownText, keypressNoteText } from '~/lib/utils/text_markdown'; import '~/lib/utils/jquery_at_who'; describe('init markdown', () => { let textArea; beforeAll(() => { textArea = document.createElement('textarea'); document.querySelector('body').appendChild(textArea); textArea.focus(); }); afterAll(() => { textArea.parentNode.removeChild(textArea); }); describe('insertMarkdownText', () => { it('will not error if selected text is a number', () => { const selected = 2; insertMarkdownText({ textArea, text: '', tag: '', blockTag: null, selected, wrap: false, }); expect(textArea.value).toBe(selected.toString()); }); }); describe('textArea', () => { describe('without selection', () => { it('inserts the tag on an empty line', () => { const initialValue = ''; textArea.value = initialValue; textArea.selectionStart = 0; textArea.selectionEnd = 0; insertMarkdownText({ textArea, text: textArea.value, tag: '- ', blockTag: null, selected: '', wrap: false, }); expect(textArea.value).toEqual(`${initialValue}- `); }); it('inserts dollar signs correctly', () => { const initialValue = ''; textArea.value = initialValue; textArea.selectionStart = 0; textArea.selectionEnd = 0; insertMarkdownText({ textArea, text: textArea.value, tag: '```suggestion:-0+0\n{text}\n```', blockTag: true, selected: '# Does not parse the `$` currently.', wrap: false, }); expect(textArea.value).toContain('# Does not parse the `$` currently.'); }); it('inserts the tag on a new line if the current one is not empty', () => { const initialValue = 'some text'; textArea.value = initialValue; textArea.setSelectionRange(initialValue.length, initialValue.length); insertMarkdownText({ textArea, text: textArea.value, tag: '- ', blockTag: null, selected: '', wrap: false, }); expect(textArea.value).toEqual(`${initialValue}\n- `); }); it('unescapes new line characters', () => { const initialValue = ''; textArea.value = initialValue; textArea.selectionStart = 0; textArea.selectionEnd = 0; insertMarkdownText({ textArea, text: textArea.value, tag: '```suggestion:-0+0\n{text}\n```', blockTag: true, selected: '# Does not %br parse the %br currently.', wrap: false, }); expect(textArea.value).toContain('# Does not \\n parse the \\n currently.'); }); it('inserts the tag on the same line if the current line only contains spaces', () => { const initialValue = ' '; textArea.value = initialValue; textArea.setSelectionRange(initialValue.length, initialValue.length); insertMarkdownText({ textArea, text: textArea.value, tag: '- ', blockTag: null, selected: '', wrap: false, }); expect(textArea.value).toEqual(`${initialValue}- `); }); it('inserts the tag on the same line if the current line only contains tabs', () => { const initialValue = '\t\t\t'; textArea.value = initialValue; textArea.setSelectionRange(initialValue.length, initialValue.length); insertMarkdownText({ textArea, text: textArea.value, tag: '- ', blockTag: null, selected: '', wrap: false, }); expect(textArea.value).toEqual(`${initialValue}- `); }); it('places the cursor inside the tags', () => { const start = 'lorem '; const end = ' ipsum'; const tag = '*'; textArea.value = `${start}${end}`; textArea.setSelectionRange(start.length, start.length); insertMarkdownText({ textArea, text: textArea.value, tag, blockTag: null, selected: '', wrap: true, }); expect(textArea.value).toEqual(`${start}**${end}`); // cursor placement should be between tags expect(textArea.selectionStart).toBe(start.length + tag.length); }); describe('Continuing markdown lists', () => { const enterEvent = new KeyboardEvent('keydown', { key: 'Enter' }); beforeEach(() => { gon.features = { markdownContinueLists: true }; }); it.each` text | expected ${'- item'} | ${'- item\n- '} ${'* item'} | ${'* item\n* '} ${'+ item'} | ${'+ item\n+ '} ${'- [ ] item'} | ${'- [ ] item\n- [ ] '} ${'- [x] item'} | ${'- [x] item\n- [ ] '} ${'- [X] item'} | ${'- [X] item\n- [ ] '} ${'- [ ] nbsp (U+00A0)'} | ${'- [ ] nbsp (U+00A0)\n- [ ] '} ${'- item\n - second'} | ${'- item\n - second\n - '} ${'- - -'} | ${'- - -'} ${'- --'} | ${'- --'} ${'* **'} | ${'* **'} ${' ** * ** * ** * **'} | ${' ** * ** * ** * **'} ${'- - -x'} | ${'- - -x\n- '} ${'+ ++'} | ${'+ ++\n+ '} ${'1. item'} | ${'1. item\n2. '} ${'1. [ ] item'} | ${'1. [ ] item\n2. [ ] '} ${'1. [x] item'} | ${'1. [x] item\n2. [ ] '} ${'1. [X] item'} | ${'1. [X] item\n2. [ ] '} ${'108. item'} | ${'108. item\n109. '} ${'108. item\n - second'} | ${'108. item\n - second\n - '} ${'108. item\n 1. second'} | ${'108. item\n 1. second\n 2. '} ${'non-item, will not change'} | ${'non-item, will not change'} `('adds correct list continuation characters', ({ text, expected }) => { textArea.value = text; textArea.setSelectionRange(text.length, text.length); textArea.addEventListener('keydown', keypressNoteText); textArea.dispatchEvent(enterEvent); expect(textArea.value).toEqual(expected); expect(textArea.selectionStart).toBe(expected.length); }); // test that when pressing Enter on an empty list item, the empty // list item text is selected, so that when the Enter propagates, // it's removed it.each` text | expected ${'- item\n- '} | ${'- item\n'} ${'- [ ] item\n- [ ] '} | ${'- [ ] item\n'} ${'- [x] item\n- [x] '} | ${'- [x] item\n'} ${'- [X] item\n- [X] '} | ${'- [X] item\n'} ${'- item\n - second\n - '} | ${'- item\n - second\n'} ${'1. item\n2. '} | ${'1. item\n'} ${'1. [ ] item\n2. [ ] '} | ${'1. [ ] item\n'} ${'1. [x] item\n2. [x] '} | ${'1. [x] item\n'} ${'1. [X] item\n2. [X] '} | ${'1. [X] item\n'} ${'108. item\n109. '} | ${'108. item\n'} ${'108. item\n - second\n - '} | ${'108. item\n - second\n'} ${'108. item\n 1. second\n 1. '} | ${'108. item\n 1. second\n'} `('adds correct list continuation characters', ({ text, expected }) => { textArea.value = text; textArea.setSelectionRange(text.length, text.length); textArea.addEventListener('keydown', keypressNoteText); textArea.dispatchEvent(enterEvent); expect(textArea.value.substr(0, textArea.selectionStart)).toEqual(expected); expect(textArea.selectionStart).toBe(expected.length); expect(textArea.selectionEnd).toBe(text.length); }); // test that when we're in the middle of autocomplete, we don't // add a new list item it.each` text | expected | atwho_selecting ${'- item @'} | ${'- item @'} | ${true} ${'- item @'} | ${'- item @\n- '} | ${false} `('behaves correctly during autocomplete', ({ text, expected, atwho_selecting }) => { jest.spyOn($.fn, 'atwho').mockReturnValue(atwho_selecting); textArea.value = text; textArea.setSelectionRange(text.length, text.length); textArea.addEventListener('keydown', keypressNoteText); textArea.dispatchEvent(enterEvent); expect(textArea.value).toEqual(expected); }); it.each` text | add_at | expected ${'1. one\n2. two\n3. three'} | ${13} | ${'1. one\n2. two\n2. \n3. three'} ${'108. item\n 5. second\n 6. six\n 7. seven'} | ${36} | ${'108. item\n 5. second\n 6. six\n 6. \n 7. seven'} `( 'adds correct numbered continuation characters when in middle of list', ({ text, add_at, expected }) => { textArea.value = text; textArea.setSelectionRange(add_at, add_at); textArea.addEventListener('keydown', keypressNoteText); textArea.dispatchEvent(enterEvent); expect(textArea.value).toEqual(expected); }, ); it('does nothing if feature flag disabled', () => { gon.features = { markdownContinueLists: false }; const text = '- item'; const expected = '- item'; textArea.value = text; textArea.setSelectionRange(text.length, text.length); textArea.addEventListener('keydown', keypressNoteText); textArea.dispatchEvent(enterEvent); expect(textArea.value).toEqual(expected); expect(textArea.selectionStart).toBe(expected.length); }); }); }); describe('with selection', () => { let text = 'initial selected value'; let selected = 'selected'; let selectedIndex; beforeEach(() => { textArea.value = text; selectedIndex = text.indexOf(selected); textArea.setSelectionRange(selectedIndex, selectedIndex + selected.length); }); it('applies the tag to the selected value', () => { const tag = '*'; insertMarkdownText({ textArea, text: textArea.value, tag, blockTag: null, selected, wrap: true, }); expect(textArea.value).toEqual(text.replace(selected, `*${selected}*`)); // cursor placement should be after selection + 2 tag lengths expect(textArea.selectionStart).toBe(selectedIndex + selected.length + 2 * tag.length); }); it('replaces the placeholder in the tag', () => { insertMarkdownText({ textArea, text: textArea.value, tag: '[{text}](url)', blockTag: null, selected, wrap: false, }); expect(textArea.value).toEqual(text.replace(selected, `[${selected}](url)`)); }); describe('surrounds selected text with matching character', () => { it.each` key | expected ${'['} | ${`[${selected}]`} ${'*'} | ${`**${selected}**`} ${"'"} | ${`'${selected}'`} ${'_'} | ${`_${selected}_`} ${'`'} | ${`\`${selected}\``} ${'"'} | ${`"${selected}"`} ${'{'} | ${`{${selected}}`} ${'('} | ${`(${selected})`} ${'<'} | ${`<${selected}>`} `('generates $expected when $key is pressed', ({ key, expected }) => { const event = new KeyboardEvent('keydown', { key }); gon.markdown_surround_selection = true; textArea.addEventListener('keydown', keypressNoteText); textArea.dispatchEvent(event); expect(textArea.value).toEqual(text.replace(selected, expected)); // cursor placement should be after selection + 2 tag lengths expect(textArea.selectionStart).toBe(selectedIndex + expected.length); }); it('does nothing if user preference disabled', () => { const event = new KeyboardEvent('keydown', { key: '[' }); gon.markdown_surround_selection = false; textArea.addEventListener('keydown', keypressNoteText); textArea.dispatchEvent(event); expect(textArea.value).toEqual(text); }); }); describe('and text to be selected', () => { const tag = '[{text}](url)'; const select = 'url'; it('selects the text', () => { insertMarkdownText({ textArea, text: textArea.value, tag, blockTag: null, selected, wrap: false, select, }); const expectedText = text.replace(selected, `[${selected}](url)`); expect(textArea.value).toEqual(expectedText); expect(textArea.selectionStart).toEqual(expectedText.indexOf(select)); expect(textArea.selectionEnd).toEqual(expectedText.indexOf(select) + select.length); }); it('selects the right text when multiple tags are present', () => { const initialValue = `${tag} ${tag} ${selected}`; textArea.value = initialValue; selectedIndex = initialValue.indexOf(selected); textArea.setSelectionRange(selectedIndex, selectedIndex + selected.length); insertMarkdownText({ textArea, text: textArea.value, tag, blockTag: null, selected, wrap: false, select, }); const expectedText = initialValue.replace(selected, `[${selected}](url)`); expect(textArea.value).toEqual(expectedText); expect(textArea.selectionStart).toEqual(expectedText.lastIndexOf(select)); expect(textArea.selectionEnd).toEqual(expectedText.lastIndexOf(select) + select.length); }); it('should support selected urls', () => { const expectedUrl = 'http://www.gitlab.com'; const expectedSelectionText = 'text'; const expectedText = `text [${expectedSelectionText}](${expectedUrl}) text`; const initialValue = `text ${expectedUrl} text`; textArea.value = initialValue; selectedIndex = initialValue.indexOf(expectedUrl); textArea.setSelectionRange(selectedIndex, selectedIndex + expectedUrl.length); insertMarkdownText({ textArea, text: textArea.value, tag, blockTag: null, selected: expectedUrl, wrap: false, select, }); expect(textArea.value).toEqual(expectedText); expect(textArea.selectionStart).toEqual(expectedText.indexOf(expectedSelectionText, 1)); expect(textArea.selectionEnd).toEqual( expectedText.indexOf(expectedSelectionText, 1) + expectedSelectionText.length, ); }); it('adds block tags on line above and below selection', () => { selected = 'this text\nis multiple\nlines'; text = `before \n${selected}\nafter `; textArea.value = text; selectedIndex = text.indexOf(selected); textArea.setSelectionRange(selectedIndex, selectedIndex + selected.length); insertMarkdownText({ textArea, text, tag: '', blockTag: '***', selected, wrap: true, }); expect(textArea.value).toEqual(`before \n***\n${selected}\n***\nafter `); }); it('removes block tags on line above and below selection', () => { selected = 'this text\nis multiple\nlines'; text = `before \n***\n${selected}\n***\nafter `; textArea.value = text; selectedIndex = text.indexOf(selected); textArea.setSelectionRange(selectedIndex, selectedIndex + selected.length); insertMarkdownText({ textArea, text, tag: '', blockTag: '***', selected, wrap: true, }); expect(textArea.value).toEqual(`before \n${selected}\nafter `); }); }); }); }); describe('Source Editor', () => { let editor; beforeEach(() => { editor = { getSelection: jest.fn().mockReturnValue({ startLineNumber: 1, startColumn: 1, endLineNumber: 2, endColumn: 2, }), getValue: jest.fn().mockReturnValue('this is text \n in two lines'), selectWithinSelection: jest.fn(), replaceSelectedText: jest.fn(), moveCursor: jest.fn(), }; }); it('replaces selected text', () => { insertMarkdownText({ text: editor.getValue, tag: '*', blockTag: null, selected: '', wrap: false, editor, }); expect(editor.replaceSelectedText).toHaveBeenCalled(); }); it('adds block tags on line above and below selection', () => { const selected = 'this text \n is multiple \n lines'; const text = `before \n ${selected} \n after`; insertMarkdownText({ text, tag: '', blockTag: '***', selected, wrap: true, editor, }); expect(editor.replaceSelectedText).toHaveBeenCalledWith(`***\n${selected}\n***\n`, undefined); }); it('removes block tags on line above and below selection', () => { const selected = 'this text\nis multiple\nlines'; const text = `before\n***\n${selected}\n***\nafter`; editor.getSelection = jest.fn().mockReturnValue({ startLineNumber: 2, startColumn: 1, endLineNumber: 4, endColumn: 2, setSelectionRange: jest.fn(), }); insertMarkdownText({ text, tag: '', blockTag: '***', selected, wrap: true, editor, }); expect(editor.replaceSelectedText).toHaveBeenCalledWith(`${selected}\n`, undefined); }); it('uses editor to navigate back tag length when nothing is selected', () => { editor.getSelection = jest.fn().mockReturnValue({ startLineNumber: 1, startColumn: 1, endLineNumber: 1, endColumn: 1, }); insertMarkdownText({ text: editor.getValue, tag: '*', blockTag: null, selected: '', wrap: true, editor, }); expect(editor.moveCursor).toHaveBeenCalledWith(-1); }); it('editor does not navigate back when there is selected text', () => { insertMarkdownText({ text: editor.getValue, tag: '*', blockTag: null, selected: 'foobar', wrap: true, editor, }); expect(editor.selectWithinSelection).not.toHaveBeenCalled(); }); }); });