gitlab-org--gitlab-foss/spec/javascripts/line_highlighter_spec.js

266 lines
7.4 KiB
JavaScript
Raw Normal View History

2018-10-09 14:03:09 -04:00
/* eslint-disable no-var, prefer-template, no-else-return, dot-notation, no-return-assign, no-new, no-underscore-dangle */
2016-07-24 16:45:11 -04:00
import $ from 'jquery';
2017-12-15 07:57:08 -05:00
import LineHighlighter from '~/line_highlighter';
2016-07-24 16:45:11 -04:00
2018-10-17 03:13:26 -04:00
describe('LineHighlighter', function() {
var clickLine;
preloadFixtures('static/line_highlighter.html.raw');
clickLine = function(number, eventData = {}) {
if ($.isEmptyObject(eventData)) {
return $('#L' + number).click();
} else {
const e = $.Event('click', eventData);
return $('#L' + number).trigger(e);
}
};
beforeEach(function() {
loadFixtures('static/line_highlighter.html.raw');
this['class'] = new LineHighlighter();
this.css = this['class'].highlightLineClass;
return (this.spies = {
__setLocationHash__: spyOn(this['class'], '__setLocationHash__').and.callFake(function() {}),
});
});
describe('behavior', function() {
it('highlights one line given in the URL hash', function() {
new LineHighlighter({ hash: '#L13' });
expect($('#LC13')).toHaveClass(this.css);
});
it('highlights one line given in the URL hash with given CSS class name', function() {
const hiliter = new LineHighlighter({ hash: '#L13', highlightLineClass: 'hilite' });
expect(hiliter.highlightLineClass).toBe('hilite');
expect($('#LC13')).toHaveClass('hilite');
expect($('#LC13')).not.toHaveClass('hll');
});
it('highlights a range of lines given in the URL hash', function() {
var line;
new LineHighlighter({ hash: '#L5-25' });
expect($('.' + this.css).length).toBe(21);
for (line = 5; line <= 25; line += 1) {
expect($('#LC' + line)).toHaveClass(this.css);
2016-07-24 16:45:11 -04:00
}
});
2018-10-17 03:13:26 -04:00
it('scrolls to the first highlighted line on initial load', function() {
var spy;
spy = spyOn($, 'scrollTo');
new LineHighlighter({ hash: '#L5-25' });
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect(spy).toHaveBeenCalledWith('#L5', jasmine.anything());
});
2018-10-17 03:13:26 -04:00
it('discards click events', function() {
var spy;
spy = spyOnEvent('a[data-line-number]', 'click');
clickLine(13);
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect(spy).toHaveBeenPrevented();
});
2018-10-17 03:13:26 -04:00
it('handles garbage input from the hash', function() {
var func;
func = function() {
return new LineHighlighter({ fileHolderSelector: '#blob-content-holder' });
};
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect(func).not.toThrow();
});
});
2018-10-17 03:13:26 -04:00
describe('clickHandler', function() {
it('handles clicking on a child icon element', function() {
var spy;
spy = spyOn(this['class'], 'setHash').and.callThrough();
$('#L13 i')
.mousedown()
.click();
expect(spy).toHaveBeenCalledWith(13);
expect($('#LC13')).toHaveClass(this.css);
});
describe('without shiftKey', function() {
it('highlights one line when clicked', function() {
clickLine(13);
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect($('#LC13')).toHaveClass(this.css);
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
it('unhighlights previously highlighted lines', function() {
2016-07-24 16:45:11 -04:00
clickLine(13);
2018-10-17 03:13:26 -04:00
clickLine(20);
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect($('#LC13')).not.toHaveClass(this.css);
expect($('#LC20')).toHaveClass(this.css);
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
it('sets the hash', function() {
var spy;
spy = spyOn(this['class'], 'setHash').and.callThrough();
clickLine(13);
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect(spy).toHaveBeenCalledWith(13);
2016-07-24 16:45:11 -04:00
});
});
2018-10-17 03:13:26 -04:00
describe('with shiftKey', function() {
it('sets the hash', function() {
2016-07-24 16:45:11 -04:00
var spy;
2018-10-17 03:13:26 -04:00
spy = spyOn(this['class'], 'setHash').and.callThrough();
clickLine(13);
clickLine(20, {
shiftKey: true,
});
2018-10-09 14:03:09 -04:00
2016-07-24 16:45:11 -04:00
expect(spy).toHaveBeenCalledWith(13);
2018-10-17 03:13:26 -04:00
expect(spy).toHaveBeenCalledWith(13, 20);
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
describe('without existing highlight', function() {
it('highlights the clicked line', function() {
clickLine(13, {
shiftKey: true,
});
2018-10-09 14:03:09 -04:00
expect($('#LC13')).toHaveClass(this.css);
2018-10-17 03:13:26 -04:00
expect($('.' + this.css).length).toBe(1);
2016-07-24 16:45:11 -04:00
});
2018-10-09 14:03:09 -04:00
it('sets the hash', function() {
2016-07-24 16:45:11 -04:00
var spy;
2018-10-17 03:13:26 -04:00
spy = spyOn(this['class'], 'setHash');
clickLine(13, {
shiftKey: true,
});
2018-10-09 14:03:09 -04:00
expect(spy).toHaveBeenCalledWith(13);
2016-07-24 16:45:11 -04:00
});
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
describe('with existing single-line highlight', function() {
it('uses existing line as last line when target is lesser', function() {
var line;
clickLine(20);
clickLine(15, {
shiftKey: true,
2016-07-24 16:45:11 -04:00
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect($('.' + this.css).length).toBe(6);
for (line = 15; line <= 20; line += 1) {
expect($('#LC' + line)).toHaveClass(this.css);
}
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
it('uses existing line as first line when target is greater', function() {
var line;
clickLine(5);
clickLine(10, {
shiftKey: true,
2016-07-24 16:45:11 -04:00
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect($('.' + this.css).length).toBe(6);
for (line = 5; line <= 10; line += 1) {
expect($('#LC' + line)).toHaveClass(this.css);
}
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
});
2018-10-17 03:13:26 -04:00
describe('with existing multi-line highlight', function() {
beforeEach(function() {
clickLine(10, {
shiftKey: true,
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
clickLine(13, {
shiftKey: true,
2016-07-24 16:45:11 -04:00
});
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
it('uses target as first line when it is less than existing first line', function() {
var line;
clickLine(5, {
shiftKey: true,
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
expect($('.' + this.css).length).toBe(6);
for (line = 5; line <= 10; line += 1) {
expect($('#LC' + line)).toHaveClass(this.css);
}
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
it('uses target as last line when it is greater than existing first line', function() {
var line;
clickLine(15, {
shiftKey: true,
2016-07-24 16:45:11 -04:00
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect($('.' + this.css).length).toBe(6);
for (line = 10; line <= 15; line += 1) {
expect($('#LC' + line)).toHaveClass(this.css);
}
2016-07-24 16:45:11 -04:00
});
});
});
2018-10-17 03:13:26 -04:00
});
2018-10-17 03:13:26 -04:00
describe('hashToRange', function() {
beforeEach(function() {
this.subject = this['class'].hashToRange;
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
it('extracts a single line number from the hash', function() {
expect(this.subject('#L5')).toEqual([5, null]);
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
it('extracts a range of line numbers from the hash', function() {
expect(this.subject('#L5-15')).toEqual([5, 15]);
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
it('returns [null, null] when the hash is not a line number', function() {
expect(this.subject('#foo')).toEqual([null, null]);
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
});
2018-10-17 03:13:26 -04:00
describe('highlightLine', function() {
beforeEach(function() {
this.subject = this['class'].highlightLine;
});
2018-10-17 03:13:26 -04:00
it('highlights the specified line', function() {
this.subject(13);
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect($('#LC13')).toHaveClass(this.css);
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
it('accepts a String-based number', function() {
this.subject('13');
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect($('#LC13')).toHaveClass(this.css);
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:13:26 -04:00
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
describe('setHash', function() {
beforeEach(function() {
this.subject = this['class'].setHash;
});
2018-10-17 03:13:26 -04:00
it('sets the location hash for a single line', function() {
this.subject(5);
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect(this.spies.__setLocationHash__).toHaveBeenCalledWith('#L5');
});
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
it('sets the location hash for a range', function() {
this.subject(5, 15);
2018-10-09 14:03:09 -04:00
2018-10-17 03:13:26 -04:00
expect(this.spies.__setLocationHash__).toHaveBeenCalledWith('#L5-15');
2016-07-24 16:45:11 -04:00
});
});
2018-10-17 03:13:26 -04:00
});