@cypress/unique-selector 0.4.3 → 1.0.0

package/lib/getData.js

@@ -1,27 +1,15 @@
-'use strict';
+"use strict";
 
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getData = undefined;
-
-require('css.escape');
-
 /**
  * Returns the data-{dataAttr} selector of the element
- * @param  { String } selectorType
- * @return { Function }
- * @param  { Object } element
- * @return { String }
+ * @param  { String } selectorType - The type of selector to return.
+ * @param  { String } attributes - The attributes of the element.
+ * @return { String | null } - The data-{dataAttr} selector of the element.
  */
 
-function needsQuote(v) {
-  // if the escaped value is different from
-  // the non escaped value then we know
-  // we need to quote the value
-  return v !== CSS.escape(v);
-}
-
 var getData = exports.getData = function getData(selectorType, attributes) {
   for (var i = 0; i < attributes.length; i++) {
     // extract node name + value
@@ -33,15 +21,11 @@ var getData = exports.getData = function getData(selectorType, attributes) {
 
     if (nodeName === selectorType) {
       if (value) {
-        if (needsQuote(value)) {
-          // if we have value that needs quotes
-          return '[' + nodeName + '="' + value + '"]';
-        }
-
-        return '[' + nodeName + '=' + value + ']';
+        // if we have value that needs quotes
+        return "[" + nodeName + "=\"" + value + "\"]";
       }
 
-      return '[' + nodeName + ']';
+      return "[" + nodeName + "]";
     }
   }
 

package/lib/getName.js

@@ -0,0 +1,19 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getName = getName;
+/**
+ * Returns the `name` attribute of the element (if one exists)
+ * @param  { Object } element
+ * @return { String }
+ */
+function getName(el) {
+  var name = el.getAttribute('name');
+
+  if (name !== null && name !== '') {
+    return '[name="' + name + '"]';
+  }
+  return null;
+}

package/lib/index.js

@@ -13,6 +13,8 @@ var _getCombinations = require('./getCombinations');
 
 var _getAttributes = require('./getAttributes');
 
+var _getName = require('./getName');
+
 var _getNthChild = require('./getNthChild');
 
 var _getTag = require('./getTag');
@@ -30,7 +32,7 @@ function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr
 var dataRegex = /^data-(.+)/;
 
 /**
- * Returns all the selectors of the elmenet
+ * Returns all the selectors of the element
  * @param  { Object } element
  * @return { Object }
  */
@@ -42,7 +44,8 @@ function getAllSelectors(el, selectors, attributesToIgnore) {
       return (0, _getAttributes.getAttributes)(elem, attributesToIgnore);
     },
     'class': _getClasses.getClassSelectors,
-    'id': _getID.getID
+    'id': _getID.getID,
+    'name': _getName.getName
   };
 
   return selectors.filter(function (selector) {
@@ -62,8 +65,12 @@ function getAllSelectors(el, selectors, attributesToIgnore) {
 function testUniqueness(element, selector) {
   var parentNode = element.parentNode;
 
-  var elements = parentNode.querySelectorAll(selector);
-  return elements.length === 1 && elements[0] === element;
+  try {
+    var elements = parentNode.querySelectorAll(selector);
+    return elements.length === 1 && elements[0] === element;
+  } catch (e) {
+    return false;
+  }
 }
 
 /**
@@ -144,6 +151,7 @@ function getUniqueSelector(element, selectorTypes, attributesToIgnore) {
       switch (selectorType) {
         case 'data':
         case 'id':
+        case 'name':
         case 'tag':
           if (testUniqueness(element, selector)) {
             return selector;
@@ -195,69 +203,39 @@ function getUniqueSelector(element, selectorTypes, attributesToIgnore) {
 function unique(el) {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var _options$selectorType = options.selectorTypes,
-      selectorTypes = _options$selectorType === undefined ? ['id', 'class', 'tag', 'nth-child'] : _options$selectorType,
+      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;
+      attributesToIgnore = _options$attributesTo === undefined ? ['id', 'class', 'length'] : _options$attributesTo,
+      selectorCache = options.selectorCache,
+      isUniqueCache = options.isUniqueCache;
 
   var allSelectors = [];
-  var parents = (0, _getParents.getParents)(el);
 
-  var _iteratorNormalCompletion2 = true;
-  var _didIteratorError2 = false;
-  var _iteratorError2 = undefined;
+  var currentElement = el;
+  while (currentElement) {
+    var selector = selectorCache ? selectorCache.get(currentElement) : undefined;
 
-  try {
-    for (var _iterator2 = parents[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
-      var elem = _step2.value;
-
-      var selector = getUniqueSelector(elem, selectorTypes, attributesToIgnore);
-      if (Boolean(selector)) {
-        allSelectors.push(selector);
-      }
-    }
-  } catch (err) {
-    _didIteratorError2 = true;
-    _iteratorError2 = err;
-  } finally {
-    try {
-      if (!_iteratorNormalCompletion2 && _iterator2.return) {
-        _iterator2.return();
-      }
-    } finally {
-      if (_didIteratorError2) {
-        throw _iteratorError2;
+    if (!selector) {
+      selector = getUniqueSelector(currentElement, selectorTypes, attributesToIgnore);
+      if (selectorCache) {
+        selectorCache.set(currentElement, selector);
       }
     }
-  }
-
-  var selectors = [];
-  var _iteratorNormalCompletion3 = true;
-  var _didIteratorError3 = false;
-  var _iteratorError3 = undefined;
-
-  try {
-    for (var _iterator3 = allSelectors[Symbol.iterator](), _step3; !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next()).done); _iteratorNormalCompletion3 = true) {
-      var it = _step3.value;
 
-      selectors.unshift(it);
-      var _selector = selectors.join(' > ');
-      if ((0, _isUnique.isUnique)(el, _selector)) {
-        return _selector;
+    allSelectors.unshift(selector);
+    var maybeUniqueSelector = allSelectors.join(' > ');
+    var isUniqueSelector = isUniqueCache ? isUniqueCache.get(maybeUniqueSelector) : undefined;
+    if (isUniqueSelector === undefined) {
+      isUniqueSelector = (0, _isUnique.isUnique)(el, maybeUniqueSelector);
+      if (isUniqueCache) {
+        isUniqueCache.set(maybeUniqueSelector, isUniqueSelector);
       }
     }
-  } catch (err) {
-    _didIteratorError3 = true;
-    _iteratorError3 = err;
-  } finally {
-    try {
-      if (!_iteratorNormalCompletion3 && _iterator3.return) {
-        _iterator3.return();
-      }
-    } finally {
-      if (_didIteratorError3) {
-        throw _iteratorError3;
-      }
+
+    if (isUniqueSelector) {
+      return maybeUniqueSelector;
     }
+    currentElement = currentElement.parentNode;
   }
 
   return null;

package/lib/isUnique.js

@@ -12,6 +12,10 @@ exports.isUnique = isUnique;
  */
 function isUnique(el, selector) {
   if (!Boolean(selector)) return false;
-  var elems = el.ownerDocument.querySelectorAll(selector);
-  return elems.length === 1 && elems[0] === el;
+  try {
+    var elems = el.ownerDocument.querySelectorAll(selector);
+    return elems.length === 1 && elems[0] === el;
+  } catch (e) {
+    return false;
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/unique-selector",
-  "version": "0.4.3",
+  "version": "1.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",
@@ -11,7 +11,7 @@
     "build": "npm run compile",
     "test": "npm run compile && mocha --ignore-leaks",
     "compile": "babel -d lib/ src/",
-    "prepublish": "npm run compile",
+    "prepublishOnly": "npm run compile",
     "watch": "npm-scripts-watcher"
   },
   "watch": {
@@ -21,7 +21,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/ericclemmons/unique-selector.git"
+    "url": "git://github.com/cypress-io/unique-selector.git"
   },
   "keywords": [
     "dom",
@@ -30,13 +30,7 @@
     "selector",
     "event"
   ],
-  "author": "Eric Clemmons <eric@smarterspam.com>",
-  "contributors": [
-    {
-      "name": "Avraam Mavridis",
-      "email": "avr.mav@gmail.com"
-    }
-  ],
+  "author": "Cypress",
   "license": "MIT",
   "devDependencies": {
     "babel-cli": "^6.26.0",
@@ -58,5 +52,8 @@
   },
   "dependencies": {
     "css.escape": "^1.5.1"
-  }
+  },
+  "files": [
+    "lib"
+  ]
 }

package/.babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["latest"]
-}

package/.eslintrc

@@ -1,42 +0,0 @@
-{
-    "rules": {
-        "quotes": [
-            2,
-            "single"
-        ],
-        "linebreak-style": [
-            2,
-            "unix"
-        ],
-        "semi": [
-            2,
-            "always"
-        ],
-        "no-console": 0,
-        "max-len": [1, 160],
-        "quote-props": [1, "consistent-as-needed"],
-        "no-cond-assign": [2, "except-parens"],
-        "radix": 0,
-        "keyword-spacing": 0,
-        "one-var": 0,
-        "func-names": 0,
-        "padded-blocks": 0,
-        "computed-property-spacing": [2, "always"],
-        "space-infix-ops": 0,
-        "no-unused-vars": [1, {"vars": "local", "args": "none"}],
-        "space-before-function-paren": 2,
-        "space-in-parens": [2, "always"],
-        "key-spacing": [2, { "align": "colon", "beforeColon": true, "afterColon": true }],
-        "brace-style": [2, "allman", { "allowSingleLine": true }]
-    },
-    "env": {
-        "es6": true,
-        "browser": true,
-        "node": true
-    },
-    "globals": {
-        "describe": true,
-        "it": true
-    },
-    "extends": "airbnb/base"
-}