feat(locators): add toString() wrapper for this.message

Author: elgalu

lib/locators.js

@@ -65,7 +65,10 @@ ProtractorBy.prototype.addLocator = function(name, script) {
         return driver.findElements(
             webdriver.By.js.apply(webdriver.By, findElementArguments));
       },
-      message: 'by.' + name + '("' + Array.prototype.join.call(locatorArguments, '", "') + '")'
+      toString: function toString() {
+        return 'by.' + name + '("' + Array.prototype.
+            join.call(locatorArguments, '", "') + '")';
+      }
     };
   };
 };
@@ -86,7 +89,7 @@ ProtractorBy.prototype.addLocator = function(name, script) {
  * expect(span2.getText()).toBe('[email protected]');
  *
  * @param {string} bindingDescriptor
- * @return {{findElementsOverride: findElementsOverride, message: string}}
+ * @return {{findElementsOverride: findElementsOverride, toString: Function|string}}
  */
 ProtractorBy.prototype.binding = function(bindingDescriptor) {
   return {
@@ -95,7 +98,9 @@ ProtractorBy.prototype.binding = function(bindingDescriptor) {
           webdriver.By.js(clientSideScripts.findBindings,
               bindingDescriptor, false, using));
     },
-    message: 'by.binding("' + bindingDescriptor + '")'
+    toString: function toString() {
+      return 'by.binding("' + bindingDescriptor + '")';
+    }
   };
 };
 
@@ -117,7 +122,7 @@ ProtractorBy.prototype.binding = function(bindingDescriptor) {
  * expect(element(by.exactBinding('phone')).isPresent()).toBe(false);
  * 
  * @param {string} bindingDescriptor
- * @return {{findElementsOverride: findElementsOverride, message: string}}
+ * @return {{findElementsOverride: findElementsOverride, toString: Function|string}}
  */
 ProtractorBy.prototype.exactBinding = function(bindingDescriptor) {
   return {
@@ -126,7 +131,9 @@ ProtractorBy.prototype.exactBinding = function(bindingDescriptor) {
           webdriver.By.js(clientSideScripts.findBindings,
               bindingDescriptor, true, using));
     },
-    message: 'by.exactBinding("' + bindingDescriptor + '")'
+    toString: function toString() {
+      return 'by.exactBinding("' + bindingDescriptor + '")';
+    }
   };
 };
 
@@ -150,7 +157,9 @@ ProtractorBy.prototype.model = function(model) {
       return driver.findElements(
           webdriver.By.js(clientSideScripts.findByModel, model, using));
     },
-    message: 'by.model("' + model + '")'
+    toString: function toString() {
+      return 'by.model("' + model + '")';
+    }
   };
 };
 
@@ -164,7 +173,7 @@ ProtractorBy.prototype.model = function(model) {
  * element(by.buttonText('Save'));
  *
  * @param {string} searchText
- * @return {{findElementsOverride: findElementsOverride, message: string}}
+ * @return {{findElementsOverride: findElementsOverride, toString: Function|string}}
  */
 ProtractorBy.prototype.buttonText = function(searchText) {
   return {
@@ -173,7 +182,9 @@ ProtractorBy.prototype.buttonText = function(searchText) {
           webdriver.By.js(clientSideScripts.findByButtonText,
           searchText, using));
     },
-    message: 'by.buttonText("' + searchText + '")'
+    toString: function toString() {
+      return 'by.buttonText("' + searchText + '")';
+    }
   };
 };
 
@@ -187,7 +198,7 @@ ProtractorBy.prototype.buttonText = function(searchText) {
  * element(by.partialButtonText('Save'));
  *
  * @param {string} searchText
- * @return {{findElementsOverride: findElementsOverride, message: string}}
+ * @return {{findElementsOverride: findElementsOverride, toString: Function|string}}
  */
 ProtractorBy.prototype.partialButtonText = function(searchText) {
   return {
@@ -196,7 +207,9 @@ ProtractorBy.prototype.partialButtonText = function(searchText) {
           webdriver.By.js(clientSideScripts.findByPartialButtonText,
           searchText, using));
     },
-    message: 'by.partialButtonText("' + searchText + '")'
+    toString: function toString() {
+      return 'by.partialButtonText("' + searchText + '")';
+    }
   };
 };
 
@@ -259,24 +272,30 @@ ProtractorBy.prototype.repeater = function(repeatDescriptor) {
         webdriver.By.js(clientSideScripts.findAllRepeaterRows,
             repeatDescriptor, using));
     },
-    message: 'by.repeater("' + repeatDescriptor + '")',
+    toString: function toString() {
+      return 'by.repeater("' + repeatDescriptor + '")';
+    },
     row: function(index) {
       return {
         findElementsOverride: function(driver, using) {
           return driver.findElements(
             webdriver.By.js(clientSideScripts.findRepeaterRows,
                 repeatDescriptor, index, using));
         },
-        message: 'by.repeater(' + repeatDescriptor + '").row("' + index + '")"',
+        toString: function toString() {
+          return 'by.repeater(' + repeatDescriptor + '").row("' + index + '")"';
+        },
         column: function(binding) {
           return {
             findElementsOverride: function(driver, using) {
               return driver.findElements(
                   webdriver.By.js(clientSideScripts.findRepeaterElement,
                       repeatDescriptor, index, binding, using));
             },
-            message: 'by.repeater("' + repeatDescriptor + '").row("' + index +
-                '").column("' + binding + '")'
+            toString: function toString() {
+              return 'by.repeater("' + repeatDescriptor + '").row("' + index +
+                '").column("' + binding + '")';
+            }
           };
         }
       };
@@ -288,17 +307,21 @@ ProtractorBy.prototype.repeater = function(repeatDescriptor) {
               webdriver.By.js(clientSideScripts.findRepeaterColumn,
                   repeatDescriptor, binding, using));
         },
-        message: 'by.repeater("' + repeatDescriptor + '").column("' + binding +
-            '")',
+        toString: function toString() {
+          return 'by.repeater("' + repeatDescriptor + '").column("' +
+            binding + '")';
+        },
         row: function(index) {
           return {
             findElementsOverride: function(driver, using) {
               return driver.findElements(
                   webdriver.By.js(clientSideScripts.findRepeaterElement,
                       repeatDescriptor, index, binding, using));
             },
-            message: 'by.repeater("' + repeatDescriptor + '").column("' +
-                binding + '").row("' + index + '")'
+            toString: function toString() {
+              return 'by.repeater("' + repeatDescriptor + '").column("' +
+                binding + '").row("' + index + '")';
+            }
           };
         }
       };
@@ -326,7 +349,9 @@ ProtractorBy.prototype.cssContainingText = function(cssSelector, searchText) {
         webdriver.By.js(clientSideScripts.findByCssContainingText,
         cssSelector, searchText, using));
     },
-    message: 'by.cssContainingText("' + cssSelector + '", "' + searchText + '")'
+    toString: function toString() {
+      return 'by.cssContainingText("' + cssSelector + '", "' + searchText + '")';
+    }
   };
 };
 

lib/protractor.js

@@ -568,7 +568,7 @@ var buildElementHelper = function(ptor) {
         this.locator_, this.parentElementFinder_).getWebElements();
 
     var id = webElementsPromise.then(function(arr) {
-      var locatorMessage = (self.locator_.message || self.locator_.toString());
+      var locatorMessage = self.locator_.toString();
       if (!arr.length) {
         throw new Error('No element found using locator: ' + locatorMessage);
       }