Issue 3258 - Blockable items: restore item flashing functionality

lib/child/flasher.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 /**
- * @fileOverview Draws a blinking border for a list of matching nodes.
+ * @fileOverview Draws a blinking border for a list of matching elements.
  */
 
-function Flasher(nodes, scrollToItem)
+function Flasher(elements, scrollToItem)
 {
-  if (scrollToItem && nodes[0].ownerDocument)
+  if (scrollToItem && elements[0].ownerDocument)
   {
-    // Ensure that at least one node is visible when flashing
-    nodes[0].scrollIntoView();

[Thomas Greiner, 2015/11/24 12:15:42]

Detail: You're expecting a specific kind of `nsIDOMNode` here, namely element
nodes, so I'd suggest either renaming the variable (e.g. to "elements" or
"elementNodes") or adding documentation to the constructor to clarify it since
the check happens outside of this file in child/requestNotifier.js.

[Wladimir Palant, 2015/11/25 19:06:38]

I decided to rename the variables.

+    // Ensure that at least one element is visible when flashing
+    elements[0].scrollIntoView();
   }
 
-  this.nodes = nodes;
+  this.elements = elements;
   this.count = 0;
 
   this.doFlash();
 
 }
 Flasher.prototype =
 {
-  nodes: null,
+  elements: null,
   count: 0,
   timer: null,
 
   doFlash: function()
   {
     if (this.count >= 12)
     {
       this.stop();
       return;
     }
@@ skipping 10 matching lines @@
   },
 
   stop: function()
   {
     if (this.timer)
     {
       this.timer.cancel();
       this.timer = null;
     }
 
-    if (this.nodes)
+    if (this.elements)
     {
       this.switchOff();
-      this.nodes = null;
+      this.elements = null;
     }
   },
 
   setOutline: function(outline, offset)
   {
-    for (let node of this.nodes)
+    for (let element of this.elements)
     {
-      if (!Cu.isDeadWrapper(node) && "style" in node)
+      if (!Cu.isDeadWrapper(element) && "style" in element)
       {
-        node.style.outline = outline;
-        node.style.outlineOffset = offset;
+        element.style.outline = outline;
+        element.style.outlineOffset = offset;
       }
     }
   },
 
   switchOn: function()
   {
     this.setOutline("#CC0000 dotted 2px", "-2px");
   },
 
   switchOff: function()
   {
     this.setOutline("", "");
   }
 };
 
 exports.Flasher = Flasher;