@cypress/unique-selector 1.2.0 → 2.0.0

package/lib/getAttribute.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 Object.defineProperty(exports, "__esModule", {
   value: true
@@ -7,19 +7,20 @@ Object.defineProperty(exports, "__esModule", {
  * Returns the {attr} selector of the element
  * @param  { Element } el - The element.
  * @param  { String } attribute - The attribute name.
+ * @param { Function } filter
  * @return { String | null } - The {attr} selector of the element.
  */
-var getAttributeSelector = exports.getAttributeSelector = function getAttributeSelector(el, attribute) {
+var getAttributeSelector = exports.getAttributeSelector = function getAttributeSelector(el, attribute, filter) {
   var attributeValue = el.getAttribute(attribute);
 
-  if (attributeValue === null) {
+  if (attributeValue === null || filter && !filter('attribute', attribute, attributeValue)) {
     return null;
   }
 
   if (attributeValue) {
     // if we have value that needs quotes
-    return "[" + attribute + "=\"" + attributeValue + "\"]";
+    return '[' + attribute + '="' + attributeValue + '"]';
   }
 
-  return "[" + attribute + "]";
+  return '[' + attribute + ']';
 };

package/lib/getAttributes.js

@@ -22,7 +22,7 @@ function getAttributes(el) {
   var attrs = [].concat(_toConsumableArray(attributes));
 
   return attrs.reduce(function (sum, next) {
-    if (!(attributesToIgnore.indexOf(next.nodeName) > -1) && (!filter || filter('attributes', next.nodeName, next.value))) {
+    if (!(attributesToIgnore.indexOf(next.nodeName) > -1) && (!filter || filter('attribute', next.nodeName, next.value))) {
       sum.push('[' + next.nodeName + '="' + next.value + '"]');
     }
     return sum;

package/lib/getClasses.js

@@ -22,7 +22,7 @@ function getClasses(el, filter) {
 
   try {
     return Array.prototype.slice.call(el.classList).filter(function (cls) {
-      return !filter || filter('class', 'class', cls);
+      return !filter || filter('attribute', 'class', cls);
     });
   } catch (e) {
     var className = el.getAttribute('class');

package/lib/getID.js

@@ -16,7 +16,7 @@ require('css.escape');
 function getID(el, filter) {
   var id = el.getAttribute('id');
 
-  if (id !== null && id !== '' && (!filter || filter('id', 'id', id))) {
+  if (id !== null && id !== '' && (!filter || filter('attribute', 'id', id))) {
     return '#' + CSS.escape(id);
   }
   return null;

package/lib/getName.js

@@ -13,7 +13,7 @@ exports.getName = getName;
 function getName(el, filter) {
   var name = el.getAttribute('name');
 
-  if (name !== null && name !== '' && (!filter || filter('name', 'name', name))) {
+  if (name !== null && name !== '' && (!filter || filter('attribute', 'name', name))) {
     return '[name="' + name + '"]';
   }
   return null;

package/lib/index.js

@@ -32,12 +32,21 @@ function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr
 var dataRegex = /^data-.+/;
 var attrRegex = /^attribute:(.+)/m;
 
+/**
+ * @typedef Filter
+ * @type {Function}
+ * @param {string} type - the trait being considered ('attribute', 'tag', 'nth-child').
+ * @param {string} key - your trait key (for 'attribute' will be the attribute name, for others will typically be the same as 'type').
+ * @param {string} value - the trait value.
+ * @returns {boolean} whether this trait can be used when building the selector (true = allow). Defaults to 'true' if no value returned.
+ */
+
 /**
  * Returns all the selectors of the element
  * @param  { Object } element
  * @return { Object }
  */
-function getAllSelectors(el, selectors, attributesToIgnore, filters) {
+function getAllSelectors(el, selectors, attributesToIgnore, filter) {
   var consolidatedAttributesToIgnore = [].concat(_toConsumableArray(attributesToIgnore));
   var nonAttributeSelectors = [];
   var _iteratorNormalCompletion = true;
@@ -73,22 +82,22 @@ function getAllSelectors(el, selectors, attributesToIgnore, filters) {
 
   var funcs = {
     'tag': function tag(elem) {
-      return (0, _getTag.getTag)(elem, filters.tag);
+      return (0, _getTag.getTag)(elem, filter);
     },
     'nth-child': function nthChild(elem) {
-      return (0, _getNthChild.getNthChild)(elem, filters.nthChild);
+      return (0, _getNthChild.getNthChild)(elem, filter);
     },
     'attributes': function attributes(elem) {
-      return (0, _getAttributes.getAttributes)(elem, consolidatedAttributesToIgnore, filters.attributes);
+      return (0, _getAttributes.getAttributes)(elem, consolidatedAttributesToIgnore, filter);
     },
     'class': function _class(elem) {
-      return (0, _getClasses.getClassSelectors)(elem, filters.class);
+      return (0, _getClasses.getClassSelectors)(elem, filter);
     },
     'id': function id(elem) {
-      return (0, _getID.getID)(elem, filters.id);
+      return (0, _getID.getID)(elem, filter);
     },
     'name': function name(elem) {
-      return (0, _getName.getName)(elem, filters.name);
+      return (0, _getName.getName)(elem, filter);
     }
   };
 
@@ -160,10 +169,10 @@ function getUniqueCombination(element, items, tag) {
  * @param  { Array } options
  * @return { String }
  */
-function getUniqueSelector(element, selectorTypes, attributesToIgnore, filters) {
+function getUniqueSelector(element, selectorTypes, attributesToIgnore, filter) {
   var foundSelector = void 0;
 
-  var elementSelectors = getAllSelectors(element, selectorTypes, attributesToIgnore, filters);
+  var elementSelectors = getAllSelectors(element, selectorTypes, attributesToIgnore, filter);
 
   var _iteratorNormalCompletion2 = true;
   var _didIteratorError2 = false;
@@ -180,12 +189,10 @@ function getUniqueSelector(element, selectorTypes, attributesToIgnore, filters)
       var isAttributeSelectorType = !isDataAttributeSelectorType && attrRegex.test(selectorType);
       if (isDataAttributeSelectorType || isAttributeSelectorType) {
         var attributeToQuery = isDataAttributeSelectorType ? selectorType : selectorType.replace(attrRegex, '$1');
-        var attributeValue = element.getAttribute(attributeToQuery);
-        var attributeFilter = filters[selectorType];
-
+        var attributeSelector = (0, _getAttribute.getAttributeSelector)(element, attributeToQuery, filter);
         // if we found a selector via attribute
-        if (attributeValue !== null && (!attributeFilter || attributeFilter(selectorType, attributeToQuery, attributeValue))) {
-          selector = (0, _getAttribute.getAttributeSelector)(element, attributeToQuery);
+        if (attributeSelector) {
+          selector = attributeSelector;
           selectorType = 'attribute';
         }
       }
@@ -243,10 +250,7 @@ function getUniqueSelector(element, selectorTypes, attributesToIgnore, filters)
  * @param {Object} options (optional) Customize various behaviors of selector generation
  * @param {String[]} options.selectorTypes Specify the set of traits to leverage when building selectors in precedence order
  * @param {String[]} options.attributesToIgnore Specify a set of attributes to *not* leverage when building selectors
- * @param {Object} options.filters Specify a set of filter functions to conditionally reject various traits when building selectors. Keys correspond to a `selectorTypes` entry, values should be a function accepting three parameters:
- * * selectorType: The selector type/category being generated
- * * key: The key being evaluated - this will typically match the `selectorType` except in aggregate types like `attributes`
- * * value: The value to consider. Returning `true` will allow its use in selector generation, `false` will prevent.
+ * @param {Filter} options.filter Provide a filter function to conditionally reject various traits when building selectors.
  * @param {Map<Element, String>} options.selectorCache Provide a cache to improve performance of repeated selector generation - it is the responsibility of the caller to handle cache invalidation. Caching is performed using the input Element as key. This cache handles Element -> Selector caching.
  * @param {Map<String, Boolean>} options.isUniqueCache Provide a cache to improve performance of repeated selector generation - it is the responsibility of the caller to handle cache invalidation. Caching is performed using the input Element as key. This cache handles Selector -> isUnique caching.
  * @return {String}
@@ -259,11 +263,18 @@ function unique(el) {
       selectorTypes = _options$selectorType === undefined ? ['id', 'name', 'class', 'tag', 'nth-child'] : _options$selectorType,
       _options$attributesTo = options.attributesToIgnore,
       attributesToIgnore = _options$attributesTo === undefined ? ['id', 'class', 'length'] : _options$attributesTo,
-      _options$filters = options.filters,
-      filters = _options$filters === undefined ? {} : _options$filters,
+      filter = options.filter,
       selectorCache = options.selectorCache,
       isUniqueCache = options.isUniqueCache;
+  // If filter was provided wrap it to ensure a default value of `true` is returned if the provided function fails to return a value
 
+  var normalizedFilter = filter && function (type, key, value) {
+    var result = filter(type, key, value);
+    if (result === null || result === undefined) {
+      return true;
+    }
+    return result;
+  };
   var allSelectors = [];
 
   var currentElement = el;
@@ -271,7 +282,7 @@ function unique(el) {
     var selector = selectorCache ? selectorCache.get(currentElement) : undefined;
 
     if (!selector) {
-      selector = getUniqueSelector(currentElement, selectorTypes, attributesToIgnore, filters);
+      selector = getUniqueSelector(currentElement, selectorTypes, attributesToIgnore, normalizedFilter);
       if (selectorCache) {
         selectorCache.set(currentElement, selector);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/unique-selector",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "Given a DOM node, return a unique CSS selector matching only that element",
   "main": "./lib/index.js",
   "jsnext:main": "./src/index.js",