Refactor goog.array.ArrayLike -> IArrayLike.

johnjbarton · jleyba · commit 09ec0b84cd8f · 2016-03-17T14:45:24.000-07:00
As suggested by the Closure library team, goog.array.ArrayLike is obsolete, IArrayLike should replace it to encourage better typechecking. See also https://docs.google.com/document/d/1eNpI_02NYb8K-x014Jo8iO6wjlpQQttDO3mVYZUXVtQ Fixes #1771 Signed-off-by: Jason Leyba <jmleyba@gmail.com>
diff --git a/javascript/atoms/inject.js b/javascript/atoms/inject.js
@@ -110,7 +110,7 @@ bot.inject.wrapValue = function(value) {
       return value.toString();
 
     case 'array':
-      return goog.array.map(/**@type {goog.array.ArrayLike}*/ (value),
+      return goog.array.map(/**@type {IArrayLike}*/ (value),
           bot.inject.wrapValue);
 
     case 'object':
@@ -141,7 +141,7 @@ bot.inject.wrapValue = function(value) {
       }
 
       if (goog.isArrayLike(value)) {
-        return goog.array.map(/**@type {goog.array.ArrayLike}*/ (value),
+        return goog.array.map(/**@type {IArrayLike}*/ (value),
             bot.inject.wrapValue);
       }
 
@@ -165,7 +165,7 @@ bot.inject.wrapValue = function(value) {
  */
 bot.inject.unwrapValue = function(value, opt_doc) {
   if (goog.isArray(value)) {
-    return goog.array.map(/**@type {goog.array.ArrayLike}*/ (value),
+    return goog.array.map(/**@type {IArrayLike}*/ (value),
         function(v) { return bot.inject.unwrapValue(v, opt_doc); });
   } else if (goog.isObject(value)) {
     if (typeof value == 'function') {
diff --git a/javascript/atoms/locators/classname.js b/javascript/atoms/locators/classname.js
@@ -80,7 +80,7 @@ bot.locators.className.single = function(target, root) {
  * @param {string} target The class name to search for.
  * @param {!(Document|Element)} root The document or element to perform the
  *     search under.
- * @return {!goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {!IArrayLike} All matching elements, or an empty list.
  */
 bot.locators.className.many = function(target, root) {
   if (!target) {
diff --git a/javascript/atoms/locators/css.js b/javascript/atoms/locators/css.js
@@ -70,7 +70,7 @@ bot.locators.css.single = function(target, root) {
  * @param {string} target The selector to search for.
  * @param {!(Document|Element)} root The document or element to perform the
  *     search under.
- * @return {!goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {!IArrayLike} All matching elements, or an empty list.
  */
 bot.locators.css.many = function(target, root) {
   if (!goog.isFunction(root['querySelectorAll']) &&
diff --git a/javascript/atoms/locators/id.js b/javascript/atoms/locators/id.js
@@ -71,7 +71,7 @@ bot.locators.id.single = function(target, root) {
  * @param {string} target The id to search for.
  * @param {!(Document|Element)} root The document or element to perform the
  *     search under.
- * @return {!goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {!IArrayLike} All matching elements, or an empty list.
  */
 bot.locators.id.many = function(target, root) {
   if (!target) {
diff --git a/javascript/atoms/locators/link_text.js b/javascript/atoms/locators/link_text.js
@@ -63,7 +63,7 @@ bot.locators.linkText.single_ = function(target, root, opt_isPartial) {
  *     search under.
  * @param {boolean} opt_isPartial Whether the link text needs to be matched
  *     only partially.
- * @return {goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {IArrayLike} All matching elements, or an empty list.
  * @private
  */
 bot.locators.linkText.many_ = function(target, root, opt_isPartial) {
@@ -102,7 +102,7 @@ bot.locators.linkText.single = function(target, root) {
  * @param {string} target The link text to search for.
  * @param {!(Document|Element)} root The document or element to perform the
  *     search under.
- * @return {goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {IArrayLike} All matching elements, or an empty list.
  */
 bot.locators.linkText.many = function(target, root) {
   return bot.locators.linkText.many_(target, root, false);
@@ -127,7 +127,7 @@ bot.locators.partialLinkText.single = function(target, root) {
  * @param {string} target The link text to search for.
  * @param {!(Document|Element)} root The document or element to perform the
  *     search under.
- * @return {goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {IArrayLike} All matching elements, or an empty list.
  */
 bot.locators.partialLinkText.many = function(target, root) {
   return bot.locators.linkText.many_(target, root, true);
diff --git a/javascript/atoms/locators/locators.js b/javascript/atoms/locators/locators.js
@@ -31,13 +31,13 @@ goog.require('bot.locators.name');
 goog.require('bot.locators.partialLinkText');
 goog.require('bot.locators.tagName');
 goog.require('bot.locators.xpath');
-goog.require('goog.array');  // for the goog.array.ArrayLike typedef
+goog.require('goog.array');  // for the IArrayLike typedef
 goog.require('goog.object');
 
 
 /**
  * @typedef {{single:function(string,!(Document|Element)):Element,
- *     many:function(string,!(Document|Element)):!goog.array.ArrayLike}}
+ *     many:function(string,!(Document|Element)):!IArrayLike}}
  */
 bot.locators.strategy;
 
@@ -142,7 +142,7 @@ bot.locators.findElement = function(target, opt_root) {
  * @param {!Object} target The selector to search for.
  * @param {(Document|Element)=} opt_root The node from which to start the
  *     search. If not specified, will use {@code document} as the root.
- * @return {!goog.array.ArrayLike.<Element>} All matching elements found in the
+ * @return {!IArrayLike.<Element>} All matching elements found in the
  *     DOM.
  */
 bot.locators.findElements = function(target, opt_root) {
diff --git a/javascript/atoms/locators/name.js b/javascript/atoms/locators/name.js
@@ -47,7 +47,7 @@ bot.locators.name.single = function(target, root) {
  * @param {string} target The name to search for.
  * @param {!(Document|Element)} root The document or element to perform the
  *     search under.
- * @return {!goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {!IArrayLike} All matching elements, or an empty list.
  */
 bot.locators.name.many = function(target, root) {
   var dom = goog.dom.getDomHelper(root);
diff --git a/javascript/atoms/locators/tag_name.js b/javascript/atoms/locators/tag_name.js
@@ -44,7 +44,7 @@ bot.locators.tagName.single = function(target, root) {
  * @param {string} target The tag name to search for.
  * @param {!(Document|Element)} root The document or element to perform the
  *     search under.
- * @return {goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {IArrayLike} All matching elements, or an empty list.
  */
 bot.locators.tagName.many = function(target, root) {
   if (target === "") {
diff --git a/javascript/atoms/locators/xpath.js b/javascript/atoms/locators/xpath.js
@@ -222,7 +222,7 @@ bot.locators.xpath.single = function(target, root) {
  * @param {string} target The xpath to search for.
  * @param {!(Document|Element)} root The document or element to perform the
  *     search under.
- * @return {!goog.array.ArrayLike} All matching elements, or an empty list.
+ * @return {!IArrayLike} All matching elements, or an empty list.
  */
 bot.locators.xpath.many = function(target, root) {
 
@@ -250,5 +250,5 @@ bot.locators.xpath.many = function(target, root) {
   goog.array.forEach(nodes, function(n) {
     bot.locators.xpath.checkElement_(n, target);
   });
-  return /** @type {!goog.array.ArrayLike} */ (nodes);
+  return /** @type {!IArrayLike} */ (nodes);
 };
diff --git a/javascript/safari-driver/inject/commands/commands.js b/javascript/safari-driver/inject/commands/commands.js
@@ -108,7 +108,7 @@ safaridriver.inject.commands.getPageSource = function() {
 /**
  * Defines an element locating command.
  * @param {function(!Object, (Document|Element)=):
- *     (Element|!goog.array.ArrayLike.<Element>)} locatorFn The locator function
+ *     (Element|!IArrayLike.<Element>)} locatorFn The locator function
  *     that should be used.
  * @return {function(!safaridriver.Command): !bot.response.ResponseObject} The
  *     locator command function.
diff --git a/javascript/safari-driver/inject/encoder.js b/javascript/safari-driver/inject/encoder.js
@@ -161,7 +161,7 @@ safaridriver.inject.Encoder.prototype.encode = function(value) {
 
       // Check for a NodeList.
       if (goog.isArrayLike(value)) {
-        return goog.array.map(/** @type {!goog.array.ArrayLike} */ (value),
+        return goog.array.map(/** @type {!IArrayLike} */ (value),
             this.encode, this);
       }
 
diff --git a/javascript/selenium-atoms/filters.js b/javascript/selenium-atoms/filters.js
@@ -26,7 +26,7 @@ goog.require('goog.array');
 
 /**
  * @param {string} name The expected name value to match against.
- * @param {!goog.array.ArrayLike.<!Element>} elements The list to filter.
+ * @param {!IArrayLike.<!Element>} elements The list to filter.
  * @return {!Array.<!Element>} The filtered list of elements.
  * @private
  */
@@ -39,7 +39,7 @@ core.filters.name_ = function(name, elements) {
 
 /**
  * @param {string} value The expected value to match against.
- * @param {!goog.array.ArrayLike.<!Element>} elements The list to filter.
+ * @param {!IArrayLike.<!Element>} elements The list to filter.
  * @return {!Array.<!Element>} The filtered list of elements.
  * @private
  */
@@ -52,7 +52,7 @@ core.filters.value_ = function(value, elements) {
 
 /**
  * @param {string} index The index to select.
- * @param {!goog.array.ArrayLike.<!Element>} elements The list to filter.
+ * @param {!IArrayLike.<!Element>} elements The list to filter.
  * @return {!Array.<!Element>} The filtered list of elements.
  * @private
  */
@@ -70,7 +70,7 @@ core.filters.index_ = function(index, elements) {
 
 /**
  * @typedef {function(string,
- *     !goog.array.ArrayLike.<!Element>):!Array.<Element>}
+ *     !IArrayLike.<!Element>):!Array.<Element>}
  */
 core.filters.Strategy;
 
@@ -93,7 +93,7 @@ core.filters.Filters_ = {
  *
  * @param {string} filterType The type of filter to use.
  * @param {string} filter The value to pass to the filter function.
- * @param {!goog.array.ArrayLike.<!Element>} elements The list of elements to
+ * @param {!IArrayLike.<!Element>} elements The list of elements to
  *     filter.
  * @return {!Array.<!Element>} The filtered list of elements.
  * @private
@@ -113,7 +113,7 @@ core.filters.selectElementsBy_ = function(filterType, filter, elements) {
  * Refine a list of elements using a filter.
  *
  * @param {string} filterExpr The type of filter to use.
- * @param {!goog.array.ArrayLike.<!Element>} elements The list of elements to
+ * @param {!IArrayLike.<!Element>} elements The list of elements to
  *     filter.
  * @param {string} defaultFilterType The default type of filter to use.
  * @return {!Array.<!Element>} The filtered list of elements.
diff --git a/javascript/selenium-atoms/inject.js b/javascript/selenium-atoms/inject.js
@@ -172,7 +172,7 @@ core.inject.ELEMENT_ID_PREFIX = 'stored=';
  */
 core.inject.removeElementIdPrefix_ = function(value) {
   if (goog.isArray(value)) {
-    return goog.array.map(/**@type {goog.array.ArrayLike}*/ (value),
+    return goog.array.map(/**@type {IArrayLike}*/ (value),
         core.inject.removeElementIdPrefix_ );
   } else if (value && goog.isObject(value) && !goog.isFunction(value)) {
     if (goog.object.containsKey(value, bot.inject.ELEMENT_KEY)) {
@@ -197,7 +197,7 @@ core.inject.removeElementIdPrefix_ = function(value) {
  */
 core.inject.addElementIdPrefix_ = function(value) {
   if (goog.isArray(value)) {
-    return goog.array.map(/**@type {goog.array.ArrayLike}*/ (value),
+    return goog.array.map(/**@type {IArrayLike}*/ (value),
         core.inject.addElementIdPrefix_ );
   } else if (value && goog.isObject(value) && !goog.isFunction(value)) {
     if (goog.object.containsKey(value, bot.inject.ELEMENT_KEY)) {
diff --git a/javascript/webdriver/atoms/inject/find_element.js b/javascript/webdriver/atoms/inject/find_element.js
@@ -69,7 +69,7 @@ webdriver.atoms.inject.locators.findElements = function(
  * @param {string} strategy The strategy to use to locate the element.
  * @param {string} target The locator to use.
  * @param {(function(!Object, (Document|Element)=): Element|
- *          function(!Object, (Document|Element)=): !goog.array.ArrayLike)}
+ *          function(!Object, (Document|Element)=): !IArrayLike)}
  *     searchFn The search function to invoke.
  * @param {?{ELEMENT: string}=} opt_root The WebElement reference for the
  *     element to perform the search under. If not specified, will use
diff --git a/javascript/webdriver/testing/asserts.js b/javascript/webdriver/testing/asserts.js
@@ -68,7 +68,7 @@ webdriver.testing.ContainsMatcher.prototype.matches = function(actualValue) {
         actualValue, /** @type {string} */(this.value_));
   } else {
     return goog.array.contains(
-        /** @type {goog.array.ArrayLike} */(actualValue), this.value_);
+        /** @type {IArrayLike} */(actualValue), this.value_);
   }
 };
 
diff --git a/javascript/webdriver/webdriver.js b/javascript/webdriver/webdriver.js
@@ -284,7 +284,7 @@ webdriver.WebDriver.toWireValue_ = function(obj) {
  */
 webdriver.WebDriver.fromWireValue_ = function(driver, value) {
   if (goog.isArray(value)) {
-    value = goog.array.map(/**@type {goog.array.ArrayLike}*/ (value),
+    value = goog.array.map(/**@type {IArrayLike}*/ (value),
         goog.partial(webdriver.WebDriver.fromWireValue_, driver));
   } else if (value && goog.isObject(value) && !goog.isFunction(value)) {
     if (webdriver.WebElement.ELEMENT_KEY in value) {
