import { setHTMLFixture, resetHTMLFixture } from 'helpers/fixtures';
import {
addClassIfElementExists,
canScrollUp,
canScrollDown,
getContentWrapperHeight,
parseBooleanDataAttributes,
isElementVisible,
getParents,
getParentByTagName,
setAttributes,
} from '~/lib/utils/dom_utils';
const TEST_MARGIN = 5;
describe('DOM Utils', () => {
describe('addClassIfElementExists', () => {
const className = 'biology';
const fixture = `
');
element = document.querySelector('[data-foo-bar]');
});
afterEach(() => {
resetHTMLFixture();
});
it('throws if not given an element', () => {
expect(() => parseBooleanDataAttributes(null, ['baz'])).toThrow();
});
it('throws if not given an array of dataset names', () => {
expect(() => parseBooleanDataAttributes(element)).toThrow();
});
it('returns an empty object if given an empty array of names', () => {
expect(parseBooleanDataAttributes(element, [])).toEqual({});
});
it('correctly parses boolean-like data attributes', () => {
expect(
parseBooleanDataAttributes(element, [
'fooBar',
'foobar',
'baz',
'qux',
'doesNotExist',
'toString',
]),
).toEqual({
fooBar: true,
foobar: false,
baz: true,
qux: true,
doesNotExist: false,
// Ensure prototype properties aren't false positives
toString: false,
});
});
});
describe.each`
offsetWidth | offsetHeight | clientRectsLength | visible
${0} | ${0} | ${0} | ${false}
${1} | ${0} | ${0} | ${true}
${0} | ${1} | ${0} | ${true}
${0} | ${0} | ${1} | ${true}
`('isElementVisible', ({ offsetWidth, offsetHeight, clientRectsLength, visible }) => {
const element = {
offsetWidth,
offsetHeight,
getClientRects: () => new Array(clientRectsLength),
};
const paramDescription = `offsetWidth=${offsetWidth}, offsetHeight=${offsetHeight}, and getClientRects().length=${clientRectsLength}`;
describe('isElementVisible', () => {
it(`returns ${visible} when ${paramDescription}`, () => {
expect(isElementVisible(element)).toBe(visible);
});
});
});
describe('getParents', () => {
it('gets all parents of an element', () => {
const el = document.createElement('div');
el.innerHTML = '
hello world';
expect(getParents(el.querySelector('mark'))).toEqual([
el.querySelector('strong'),
el.querySelector('span'),
el.querySelector('p'),
el,
]);
});
});
describe('getParentByTagName', () => {
const el = document.createElement('div');
el.innerHTML = 'hello world';
it.each`
tagName | parent
${'strong'} | ${el.querySelector('strong')}
${'span'} | ${el.querySelector('span')}
${'p'} | ${el.querySelector('p')}
${'pre'} | ${undefined}
`('gets a parent by tag name', ({ tagName, parent }) => {
expect(getParentByTagName(el.querySelector('mark'), tagName)).toBe(parent);
});
});
describe('setAttributes', () => {
it('sets multiple attribues on element', () => {
const div = document.createElement('div');
setAttributes(div, { class: 'test', title: 'another test' });
expect(div.getAttribute('class')).toBe('test');
expect(div.getAttribute('title')).toBe('another test');
});
});
describe('getContentWrapperHeight', () => {
const fixture = `
`;
beforeEach(() => {
setHTMLFixture(fixture);
});
afterEach(() => {
resetHTMLFixture();
});
it('returns the height of an element that exists', () => {
expect(getContentWrapperHeight('.content-wrapper')).toBe('0px');
});
it('returns an empty string for a class that does not exist', () => {
expect(getContentWrapperHeight('.does-not-exist')).toBe('');
});
});
});