fix: deprecate axe.commons.utils namespace (#1330)

dequelabs · Jan 25, 2019 · df93272 · df93272
1 parent f53479b
commit df93272
Show file tree

Hide file tree

Showing 23 changed files with 62 additions and 69 deletions.
diff --git a/build/tasks/langs.js b/build/tasks/langs.js
@@ -43,7 +43,7 @@ module.exports = function(grunt) {
 			'/**\n',
 			' * Returns array of valid language codes\n',
 			' * @method validLangs\n',
-			' * @memberof axe.commons.utils\n',
+			' * @memberof axe.utils\n',
 			' * @instance\n',
 			' * @return {Array<Sting>} Valid language codes\n',
 			' */\n',

diff --git a/lib/checks/aria/required-children.js b/lib/checks/aria/required-children.js
@@ -1,6 +1,6 @@
 const requiredOwned = axe.commons.aria.requiredOwned;
 const implicitNodes = axe.commons.aria.implicitNodes;
-const matchesSelector = axe.commons.utils.matchesSelector;
+const matchesSelector = axe.utils.matchesSelector;
 const idrefs = axe.commons.dom.idrefs;
 const reviewEmpty =
 	options && Array.isArray(options.reviewEmpty) ? options.reviewEmpty : [];

diff --git a/lib/checks/aria/required-parent.js b/lib/checks/aria/required-parent.js
@@ -49,7 +49,7 @@ function getAriaOwners(element) {
 
 	while (element) {
 		if (element.getAttribute('id')) {
-			const id = axe.commons.utils.escapeSelector(element.getAttribute('id'));
+			const id = axe.utils.escapeSelector(element.getAttribute('id'));
 			let doc = axe.commons.dom.getRootNode(element);
 			o = doc.querySelector(`[aria-owns~=${id}]`);
 			if (o) {

diff --git a/lib/checks/forms/fieldset.js b/lib/checks/forms/fieldset.js
@@ -2,7 +2,7 @@ var failureCode,
 	self = this;
 
 function getUnrelatedElements(parent, name) {
-	return axe.commons.utils.toArray(
+	return axe.utils.toArray(
 		parent.querySelectorAll(
 			'select,textarea,button,input:not([name="' +
 				name +
@@ -58,17 +58,17 @@ function checkARIAGroup(group, name) {
 }
 
 function spliceCurrentNode(nodes, current) {
-	return axe.commons.utils.toArray(nodes).filter(function(candidate) {
+	return axe.utils.toArray(nodes).filter(function(candidate) {
 		return candidate !== current;
 	});
 }
 
 function runCheck(virtualNode) {
-	const name = axe.commons.utils.escapeSelector(virtualNode.actualNode.name);
+	const name = axe.utils.escapeSelector(virtualNode.actualNode.name);
 	const root = axe.commons.dom.getRootNode(virtualNode.actualNode);
 	const matchingNodes = root.querySelectorAll(
 		'input[type="' +
-			axe.commons.utils.escapeSelector(virtualNode.actualNode.type) +
+			axe.utils.escapeSelector(virtualNode.actualNode.type) +
 			'"][name="' +
 			name +
 			'"]'

diff --git a/lib/checks/forms/group-labelledby.js b/lib/checks/forms/group-labelledby.js
@@ -1,7 +1,7 @@
-const { dom, text, utils } = axe.commons;
+const { dom, text } = axe.commons;
 
-const type = utils.escapeSelector(node.type);
-const name = utils.escapeSelector(node.name);
+const type = axe.utils.escapeSelector(node.type);
+const name = axe.utils.escapeSelector(node.name);
 const doc = dom.getRootNode(node);
 const data = {
 	name: node.name,

diff --git a/lib/checks/label/explicit.js b/lib/checks/label/explicit.js
@@ -1,6 +1,6 @@
 if (node.getAttribute('id')) {
 	const root = axe.commons.dom.getRootNode(node);
-	const id = axe.commons.utils.escapeSelector(node.getAttribute('id'));
+	const id = axe.utils.escapeSelector(node.getAttribute('id'));
 	const label = root.querySelector(`label[for="${id}"]`);
 
 	if (label) {

diff --git a/lib/checks/label/hidden-explicit-label.js b/lib/checks/label/hidden-explicit-label.js
@@ -1,6 +1,6 @@
 if (node.getAttribute('id')) {
 	const root = axe.commons.dom.getRootNode(node);
-	const id = axe.commons.utils.escapeSelector(node.getAttribute('id'));
+	const id = axe.utils.escapeSelector(node.getAttribute('id'));
 	const label = root.querySelector(`label[for="${id}"]`);
 
 	if (label && !axe.commons.dom.isVisible(label, true)) {

diff --git a/lib/checks/label/multiple-label.js b/lib/checks/label/multiple-label.js
@@ -1,4 +1,4 @@
-const id = axe.commons.utils.escapeSelector(node.getAttribute('id'));
+const id = axe.utils.escapeSelector(node.getAttribute('id'));
 let labels = Array.from(document.querySelectorAll(`label[for="${id}"]`));
 let parent = node.parentNode;
 

diff --git a/lib/checks/language/valid-lang.js b/lib/checks/language/valid-lang.js
@@ -1,16 +1,14 @@
 var langs, invalid;
 
-langs = (options ? options : axe.commons.utils.validLangs()).map(
-	axe.commons.utils.getBaseLang
-);
+langs = (options ? options : axe.utils.validLangs()).map(axe.utils.getBaseLang);
 
 invalid = ['lang', 'xml:lang'].reduce(function(invalid, langAttr) {
 	var langVal = node.getAttribute(langAttr);
 	if (typeof langVal !== 'string') {
 		return invalid;
 	}
 
-	var baselangVal = axe.commons.utils.getBaseLang(langVal);
+	var baselangVal = axe.utils.getBaseLang(langVal);
 
 	// Edge sets lang to an empty string when xml:lang is set
 	// so we need to ignore empty strings here

diff --git a/lib/checks/language/xml-lang-mismatch.js b/lib/checks/language/xml-lang-mismatch.js
@@ -1,4 +1,4 @@
-const { getBaseLang } = axe.commons.utils;
+const { getBaseLang } = axe.utils;
 const primaryLangValue = getBaseLang(node.getAttribute('lang'));
 const primaryXmlLangValue = getBaseLang(node.getAttribute('xml:lang'));
 

diff --git a/lib/checks/parsing/duplicate-id.js b/lib/checks/parsing/duplicate-id.js
@@ -6,7 +6,7 @@ if (!id) {
 }
 const root = axe.commons.dom.getRootNode(node);
 const matchingNodes = Array.from(
-	root.querySelectorAll(`[id="${axe.commons.utils.escapeSelector(id)}"]`)
+	root.querySelectorAll(`[id="${axe.utils.escapeSelector(id)}"]`)
 ).filter(foundNode => foundNode !== node);
 
 if (matchingNodes.length) {

diff --git a/lib/commons/text/label-virtual.js b/lib/commons/text/label-virtual.js
@@ -19,9 +19,7 @@ text.labelVirtual = function(node) {
 
 	// explicit label
 	if (node.actualNode.id) {
-		const id = axe.commons.utils.escapeSelector(
-			node.actualNode.getAttribute('id')
-		);
+		const id = axe.utils.escapeSelector(node.actualNode.getAttribute('id'));
 		doc = axe.commons.dom.getRootNode(node.actualNode);
 		ref = doc.querySelector('label[for="' + id + '"]');
 		candidate = ref && text.visible(ref, true);

diff --git a/lib/commons/utils/get-base-lang.js → lib/core/utils/get-base-lang.js b/lib/commons/utils/get-base-lang.js → lib/core/utils/get-base-lang.js
@@ -1,8 +1,7 @@
-/* global axe */
 /**
  * Convenience function to extract primary language subtag from a given value
  * @method getBaseLang
- * @memberof axe.commons.utils
+ * @memberof axe.utils
  * @instance
  * @param {String} value value specified as lang or xml:lang attribute
  * @return {String}

diff --git a/lib/commons/utils/is-html-element.js → lib/core/utils/is-html-element.js b/lib/commons/utils/is-html-element.js → lib/core/utils/is-html-element.js
@@ -122,7 +122,7 @@ const htmlTags = [
 /**
  * Verifies that if a given html tag is valid
  * @method isHtmlElement
- * @memberof axe.commons.utils
+ * @memberof axe.utils
  * @instance
  * @param htmlTag htmlTag to check if valid
  * @return {Boolean} true/ false

diff --git a/lib/commons/utils/token-list.js → lib/core/utils/token-list.js b/lib/commons/utils/token-list.js → lib/core/utils/token-list.js
@@ -1,8 +1,7 @@
-/* global axe */
 /**
  * Converts space delimited token list to an Array
  * @method tokenList
- * @memberof axe.commons.utils
+ * @memberof axe.utils
  * @instance
  * @param  {String} str
  * @return {Array}

diff --git a/lib/commons/utils/valid-input-type.js → lib/core/utils/valid-input-type.js b/lib/commons/utils/valid-input-type.js → lib/core/utils/valid-input-type.js
@@ -1,9 +1,7 @@
-/* global axe */
-
 /**
  * Returns array of valid input type values
  * @method validInputTypes
- * @memberof axe.commons.utils
+ * @memberof axe.utils
  * @instance
  * @return {Array<Sting>}
  */

diff --git a/lib/commons/utils/valid-langs.js → lib/core/utils/valid-langs.js b/lib/commons/utils/valid-langs.js → lib/core/utils/valid-langs.js
@@ -1,6 +1,5 @@
-/* global axe */
 /*eslint quotes: 0*/
-var langs = [
+const langs = [
 	'aa',
 	'ab',
 	'ae',
@@ -8144,7 +8143,7 @@ var langs = [
 /**
  * Returns array of valid language codes
  * @method validLangs
- * @memberof axe.commons.utils
+ * @memberof axe.utils
  * @instance
  * @return {Array<Sting>} Valid language codes
  */

diff --git a/lib/rules/color-contrast-matches.js b/lib/rules/color-contrast-matches.js
@@ -78,7 +78,7 @@ if (nodeName === 'LABEL' || nodeParentLabel) {
 
 // label of disabled control associated w/ aria-labelledby
 if (node.getAttribute('id')) {
-	const id = axe.commons.utils.escapeSelector(node.getAttribute('id'));
+	const id = axe.utils.escapeSelector(node.getAttribute('id'));
 	let doc = axe.commons.dom.getRootNode(node);
 	var candidate = doc.querySelector('[aria-labelledby~=' + id + ']');
 	if (candidate && candidate.disabled) {

diff --git a/lib/rules/xml-lang-mismatch-matches.js b/lib/rules/xml-lang-mismatch-matches.js
@@ -1,7 +1,7 @@
 // using -> "selector": "html[lang][xml\\:lang]" to narrow down html with lang and xml:lang attributes
 
 // get primary base language for each of the attributes
-const { getBaseLang } = axe.commons.utils;
+const { getBaseLang } = axe.utils;
 const primaryLangValue = getBaseLang(node.getAttribute('lang'));
 const primaryXmlLangValue = getBaseLang(node.getAttribute('xml:lang'));
 

diff --git a/test/commons/utils/token-list.js b/test/commons/utils/token-list.js
diff --git a/test/commons/utils/get-base-lang.js → test/core/utils/get-base-lang.js b/test/commons/utils/get-base-lang.js → test/core/utils/get-base-lang.js
@@ -1,30 +1,30 @@
-describe('utils.getBaseLang', function() {
+describe('axe.utils.getBaseLang', function() {
 	'use strict';
 
 	it('returns base lang as peanut for argument peanut-BUTTER', function() {
-		var actual = axe.commons.utils.getBaseLang('peanut-BUTTER');
+		var actual = axe.utils.getBaseLang('peanut-BUTTER');
 		assert.equal(actual, 'peanut');
 	});
 
 	it('returns base lang as fr for argument FR-CA', function() {
-		var actual = axe.commons.utils.getBaseLang('FR-CA');
+		var actual = axe.utils.getBaseLang('FR-CA');
 		assert.strictEqual(actual, 'fr');
 	});
 
 	it('returns base lang which is the prefix string before the first - (hyphen)', function() {
-		var actual = axe.commons.utils.getBaseLang('en-GB');
+		var actual = axe.utils.getBaseLang('en-GB');
 		assert.equal(actual, 'en');
 	});
 
 	it('returns primary language subtag as base lang for multi hyphenated argument', function() {
-		var actual = axe.commons.utils.getBaseLang('SOME-random-lang');
+		var actual = axe.utils.getBaseLang('SOME-random-lang');
 		assert.strictEqual(actual, 'some');
 	});
 
 	it('returns an empty string when argument is null or undefined', function() {
-		var actualNull = axe.commons.utils.getBaseLang(null);
-		var actualUndefined = axe.commons.utils.getBaseLang(undefined);
-		var actualEmpty = axe.commons.utils.getBaseLang();
+		var actualNull = axe.utils.getBaseLang(null);
+		var actualUndefined = axe.utils.getBaseLang(undefined);
+		var actualEmpty = axe.utils.getBaseLang();
 		assert.strictEqual(actualNull, '');
 		assert.strictEqual(actualUndefined, '');
 		assert.strictEqual(actualEmpty, '');

diff --git a/test/commons/utils/is-html-element.js → test/core/utils/is-html-element.js b/test/commons/utils/is-html-element.js → test/core/utils/is-html-element.js
@@ -1,5 +1,5 @@
 /* global axe */
-describe('utils.isHtmlElement', function() {
+describe('axe.utils.isHtmlElement', function() {
 	it('returns true if given ul', function() {
 		var node = document.createElement('ul');
 		assert.isTrue(axe.utils.isHtmlElement(node));

diff --git a/test/core/utils/token-list.js b/test/core/utils/token-list.js
@@ -0,0 +1,27 @@
+describe('axe.utils.tokenList', function() {
+	'use strict';
+
+	it('should split by space', function() {
+		assert.deepEqual(axe.utils.tokenList('bananas monkeys 42'), [
+			'bananas',
+			'monkeys',
+			'42'
+		]);
+	});
+
+	it('should trim first', function() {
+		assert.deepEqual(axe.utils.tokenList(' \r   bananas monkeys 42	\n  '), [
+			'bananas',
+			'monkeys',
+			'42'
+		]);
+	});
+
+	it('should collapse whitespace', function() {
+		assert.deepEqual(axe.utils.tokenList(' \r   bananas \r \n	monkeys		42	\n  '), [
+			'bananas',
+			'monkeys',
+			'42'
+		]);
+	});
+});