Issue 4878 - Start using ESLint for adblockpluscore

lib/subscriptionClasses.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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/>.
  */
 
 "use strict";
 
 /**
  * @fileOverview Definition of Subscription class and its subclasses.
  */
 
-let {ActiveFilter, BlockingFilter,
-     WhitelistFilter, ElemHideBase} = require("filterClasses");
-let {FilterNotifier} = require("filterNotifier");
-let {desc, extend} = require("coreUtils");
+const {ActiveFilter, BlockingFilter,
+       WhitelistFilter, ElemHideBase} = require("filterClasses");
+const {FilterNotifier} = require("filterNotifier");
+const {desc, extend} = require("coreUtils");
 
 /**
  * Abstract base class for filter subscriptions
  *
  * @param {string} url    download location of the subscription
  * @param {string} [title]  title of the filter subscription
  * @constructor
  */
 function Subscription(url, title)
 {
@@ skipping 115 matching lines @@
 };
 
 /**
  * Cache for known filter subscriptions, maps URL to subscription objects.
  * @type {Object}
  */
 Subscription.knownSubscriptions = Object.create(null);
 
 /**
  * Returns a subscription from its URL, creates a new one if necessary.
- * @param {string} url  URL of the subscription
- * @return {Subscription} subscription or null if the subscription couldn't be
- *                        created
+ * @param {string} url
+ *   URL of the subscription
+ * @return {Subscription}
+ *   subscription or null if the subscription couldn't be created
  */
 Subscription.fromURL = function(url)
 {
   if (url in Subscription.knownSubscriptions)
     return Subscription.knownSubscriptions[url];
 
   if (url[0] != "~")
     return new DownloadableSubscription(url, null);
   return new SpecialSubscription(url);
 };
 
 /**
  * Deserializes a subscription
  *
- * @param {Object}  obj map of serialized properties and their values
- * @return {Subscription} subscription or null if the subscription couldn't be
- *                        created
+ * @param {Object}  obj
+ *   map of serialized properties and their values
+ * @return {Subscription}
+ *   subscription or null if the subscription couldn't be created
  */
 Subscription.fromObject = function(obj)
 {
   let result;
   if (obj.url[0] != "~")
   {
     // URL is valid - this is a downloadable subscription
     result = new DownloadableSubscription(obj.url, obj.title);
     if ("downloadStatus" in obj)
       result._downloadStatus = obj.downloadStatus;
@@ skipping 69 matching lines @@
         if (!(filter instanceof ActiveFilter) && type == "blacklist")
           return true;
       }
     }
 
     return false;
   },
 
   /**
    * See Subscription.serialize()
-   * @param {string[]} buffer  buffer to push the serialization results into
+   * @inheritdoc
    */
   serialize(buffer)
   {
     Subscription.prototype.serialize.call(this, buffer);
     if (this.defaults && this.defaults.length)
     {
-      buffer.push("defaults=" + this.defaults.
-        filter((type) => type in SpecialSubscription.defaultsMap).join(" "));

[Sebastian Noack, 2017/02/21 09:19:31]

If you break after the dot, it looks weird and is hard to recognize this as
method call. So prefer to wrap code like this, like that:

  buffer.push("defaults=" + this.defaults.filter(
    type => type in SpecialSubscription.defaultsMap).join(" ")
  );

[kzar, 2017/02/21 10:37:02]

Done.

+      buffer.push("defaults=" +
+        this.defaults.filter(
+          type => type in SpecialSubscription.defaultsMap
+        ).join(" ")
+      );
     }
     if (this._lastDownload)
       buffer.push("lastDownload=" + this._lastDownload);
   }
 });
 
 SpecialSubscription.defaultsMap = Object.create(null, desc({
   whitelist: WhitelistFilter,
   blocking: BlockingFilter,
   elemhide: ElemHideBase
 }));
 
 /**
  * Creates a new user-defined filter group.
  * @param {string} [title]  title of the new filter group
  * @return {SpecialSubscription}
  */
 SpecialSubscription.create = function(title)
 {
   let url;
   do
+  {
     url = "~user~" + Math.round(Math.random() * 1000000);
-  while (url in Subscription.knownSubscriptions);
+  } while (url in Subscription.knownSubscriptions);
   return new SpecialSubscription(url, title);
 };
 
 /**
  * Creates a new user-defined filter group and adds the given filter to it.
  * This group will act as the default group for this filter type.
  * @param {Filter} filter
  * @return {SpecialSubscription}
  */
 SpecialSubscription.createForFilter = function(filter)
@@ skipping 44 matching lines @@
       this._homepage = value;
       FilterNotifier.triggerListeners("subscription.homepage",
                                       this, value, oldValue);
     }
     return this._homepage;
   },
 
   /**
    * Time of the last subscription download (in seconds since the
    * beginning of the epoch)
-   * @type {Number}
+   * @type {number}
    */
   get lastDownload()
   {
     return this._lastDownload;
   },
   set lastDownload(value)
   {
     if (value != this._lastDownload)
     {
       let oldValue = this._lastDownload;
       this._lastDownload = value;
       FilterNotifier.triggerListeners("subscription.lastDownload",
                                       this, value, oldValue);
     }
     return this._lastDownload;
   },
 
   /**
    * See Subscription.serialize()
-   * @param {string[]} buffer
+   * @inheritdoc
    */
   serialize(buffer)
   {
     Subscription.prototype.serialize.call(this, buffer);
     if (this._homepage)
       buffer.push("homepage=" + this._homepage);
     if (this._lastDownload)
       buffer.push("lastDownload=" + this._lastDownload);
   }
 });
 
 /**
  * Class for filter subscriptions updated externally (by other extension)
  * @param {string} url    see Subscription()
  * @param {string} [title]  see Subscription()
  * @constructor
  * @augments RegularSubscription
  */
 function ExternalSubscription(url, title)
 {
   RegularSubscription.call(this, url, title);
 }
 exports.ExternalSubscription = ExternalSubscription;
 
 ExternalSubscription.prototype = extend(RegularSubscription, {
   /**
    * See Subscription.serialize()
-   * @param {string[]} buffer
+   * @inheritdoc
    */
   serialize(buffer)
   {
     throw new Error(
       "Unexpected call, external subscriptions should not be serialized"
     );
   }
 });
 
 /**
@@ skipping 35 matching lines @@
    * Time of the last successful download (in seconds since the beginning of the
    * epoch).
    */
   lastSuccess: 0,
 
   /**
    * Time when the subscription was considered for an update last time
    * (in seconds since the beginning of the epoch). This will be used
    * to increase softExpiration if the user doesn't use Adblock Plus
    * for some time.
-   * @type {Number}
+   * @type {number}
    */
   get lastCheck()
   {
     return this._lastCheck;
   },
   set lastCheck(value)
   {
     if (value != this._lastCheck)
     {
       let oldValue = this._lastCheck;
       this._lastCheck = value;
       FilterNotifier.triggerListeners("subscription.lastCheck",
                                       this, value, oldValue);
     }
     return this._lastCheck;
   },
 
   /**
    * Hard expiration time of the filter subscription (in seconds since
    * the beginning of the epoch)
-   * @type {Number}
+   * @type {number}
    */
   expires: 0,
 
   /**
    * Soft expiration time of the filter subscription (in seconds since
    * the beginning of the epoch)
-   * @type {Number}
+   * @type {number}
    */
   softExpiration: 0,
 
   /**
    * Number of download failures since last success
-   * @type {Number}
+   * @type {number}
    */
   get errors()
   {
     return this._errors;
   },
   set errors(value)
   {
     if (value != this._errors)
     {
       let oldValue = this._errors;
       this._errors = value;
       FilterNotifier.triggerListeners("subscription.errors", this,
                                       value, oldValue);
     }
     return this._errors;
   },
 
   /**
    * Version of the subscription data retrieved on last successful download
-   * @type {Number}
+   * @type {number}
    */
   version: 0,
 
   /**
    * Minimal Adblock Plus version required for this subscription
    * @type {string}
    */
   requiredVersion: null,
 
   /**
    * Number indicating how often the object was downloaded.
-   * @type {Number}
+   * @type {number}
    */
   downloadCount: 0,
 
   /**
    * See Subscription.serialize()
-   * @param {string[]} buffer
+   * @inheritdoc
    */
   serialize(buffer)
   {
     RegularSubscription.prototype.serialize.call(this, buffer);
     if (this.downloadStatus)
       buffer.push("downloadStatus=" + this.downloadStatus);
     if (this.lastSuccess)
       buffer.push("lastSuccess=" + this.lastSuccess);
     if (this.lastCheck)
       buffer.push("lastCheck=" + this.lastCheck);
     if (this.expires)
       buffer.push("expires=" + this.expires);
     if (this.softExpiration)
       buffer.push("softExpiration=" + this.softExpiration);
     if (this.errors)
       buffer.push("errors=" + this.errors);
     if (this.version)
       buffer.push("version=" + this.version);
     if (this.requiredVersion)
       buffer.push("requiredVersion=" + this.requiredVersion);
     if (this.downloadCount)
       buffer.push("downloadCount=" + this.downloadCount);
   }
 });