Issue 6891, 6741 - Rename FilterStorage to filterStorage

lib/filterStorage.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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
@@ skipping 16 matching lines @@
 const {Filter, ActiveFilter} = require("./filterClasses");
 const {Subscription, SpecialSubscription,
        ExternalSubscription} = require("./subscriptionClasses");
 const {filterNotifier} = require("./filterNotifier");
 const {INIParser} = require("./iniParser");
 
 /**
  * Version number of the filter storage file format.
  * @type {number}
  */
 const FORMAT_VERSION = 5;

[Manish Jethani, 2018/10/16 21:59:32]

Using `const` and accordingly using ALL_CAPS

 
 /**
  * {@link filterStorage} implementation.
  */
 class FilterStorage
 {
   /**
    * @hideconstructor

[Manish Jethani, 2018/10/16 21:59:31]

Singleton, so hide constructor.

    */
   constructor()
   {
     /**
      * Will be set to true after the initial {@link FilterStorage#loadFromDisk}
      * call completes.
      * @type {boolean}
      */
     this.initialized = false;
 
@@ skipping 14 matching lines @@
     /**
      * Map of subscriptions already on the list, by their URL/identifier.
      * @type {Map.<string,Subscription>}
      */
     this.knownSubscriptions = new Map();
 
     /**
      * Will be set to true if {@link FilterStorage#saveToDisk} is running
      * (reentrance protection).
      * @type {boolean}
      * @private

[Manish Jethani, 2018/10/16 21:59:32]

Marked @private

      */
     this._saving = false;
 
     /**
      * Will be set to true if a {@link FilterStorage#saveToDisk} call arrives
      * while {@link FilterStorage#saveToDisk} is already running (delayed
      * execution).
      * @type {boolean}
      * @private
      */
     this._needsSave = false;
   }
 
   /**
    * The version number of the <code>patterns.ini</code> format used.
    * @type {number}
    */
   get formatVersion()
   {
     return FORMAT_VERSION;
   }
 
   /**
    * The file containing the subscriptions.

[Manish Jethani, 2018/10/16 21:59:32]

Fixed some inconsistencies in the documentation.

s/filter list/subscription/

s/filter subscription/subscription/

s/in the list/in the storage/ (referring the the current FilterStorage instance)

    * @type {string}
    */
   get sourceFile()
   {
     return "patterns.ini";
   }
 
   /**
    * Yields all subscriptions in the storage.
    * @yields {Subscription}
    */
   *subscriptions()
   {
     yield* this.knownSubscriptions.values();
   }
 
   /**
    * The number of subscriptions in the storage.
    * @type {number}
    */
   get subscriptionCount()
   {
     return this.knownSubscriptions.size;
   }
 
   /**
    * Finds the filter group that a filter should be added to by default. Will
    * return <code>null</code> if this group doesn't exist yet.
    * @param {Filter} filter
    * @returns {?SpecialSubscription}

[Manish Jethani, 2018/10/16 21:59:32]

s/@return/@returns/

    */
   getGroupForFilter(filter)
   {
     let generalSubscription = null;
     for (let subscription of this.knownSubscriptions.values())
     {
       if (subscription instanceof SpecialSubscription && !subscription.disabled)
       {
         // Always prefer specialized subscriptions
         if (subscription.isDefaultFor(filter))
@@ skipping 13 matching lines @@
   /**
    * Adds a subscription to the storage.
    * @param {Subscription} subscription The subscription to be added.
    */
   addSubscription(subscription)
   {
     if (this.knownSubscriptions.has(subscription.url))
       return;
 
     this.knownSubscriptions.set(subscription.url, subscription);
-    addSubscriptionFilters(subscription);
+    connectSubscriptionFilters(subscription);
 
     filterNotifier.emit("subscription.added", subscription);
   }
 
   /**
    * Removes a subscription from the storage.
    * @param {Subscription} subscription The subscription to be removed.
    */
   removeSubscription(subscription)
   {
     if (!this.knownSubscriptions.has(subscription.url))
       return;
 
-    removeSubscriptionFilters(subscription);
+    disconnectSubscriptionFilters(subscription);
 
     this.knownSubscriptions.delete(subscription.url);
 
     // This should be the last remaining reference to the Subscription
     // object.
     Subscription.knownSubscriptions.delete(subscription.url);
 
     filterNotifier.emit("subscription.removed", subscription);
   }
 
   /**
    * Replaces the list of filters in a subscription with a new list.
    * @param {Subscription} subscription The subscription to be updated.
    * @param {Array.<Filter>} filters The new list of filters.

[Manish Jethani, 2018/10/16 21:59:32]

s/Filter[]/Array.<Filter>/

    */
   updateSubscriptionFilters(subscription, filters)
   {
-    removeSubscriptionFilters(subscription);
+    disconnectSubscriptionFilters(subscription);
     let oldFilters = subscription.filters;
     subscription.filters = filters;
-    addSubscriptionFilters(subscription);
+    connectSubscriptionFilters(subscription);
     filterNotifier.emit("subscription.updated", subscription, oldFilters);
   }
 
   /**
    * Adds a user-defined filter to the storage.
    * @param {Filter} filter
    * @param {?SpecialSubscription} [subscription] The subscription that the
    *   filter should be added to.
    * @param {number} [position] The position within the subscription at which
    *   the filter should be added. If not specified, the filter is added at the
@@ skipping 113 matching lines @@
   {
     if (!Prefs.savestats || !(filter instanceof ActiveFilter))
       return;
 
     filter.hitCount++;
     filter.lastHit = Date.now();
   }
 
   /**
    * Resets hit count for some filters.
-   * @param {?Array.<Filter>} filters The filters to be reset. If

[Manish Jethani, 2018/10/16 21:59:32]

Added ? before the type to indicate that the value can be null.

-   *   <code>null</code>, all filters will be reset.
+   * @param {?Array.<Filter>} [filters] The filters to be reset. If not
+   *   specified, all filters will be reset.
    */
   resetHitCounts(filters)
   {
     if (!filters)
       filters = Filter.knownFilters.values();
     for (let filter of filters)
     {
       filter.hitCount = 0;
       filter.lastHit = 0;
     }
@@ skipping 301 matching lines @@
 
 /**
  * Reads the user's filters from disk, manages them in memory, and writes them
  * back to disk.
  */
 let filterStorage = new FilterStorage();
 
 exports.filterStorage = filterStorage;
 
 /**
  * Connects a subscription to its filters without any notifications.

[Manish Jethani, 2018/10/16 21:59:31]

s/joins/connects/

  * @param {Subscription} subscription The subscription that should be
  *   connected to its filters.
  */
-function addSubscriptionFilters(subscription)
+function connectSubscriptionFilters(subscription)
 {
   if (!filterStorage.knownSubscriptions.has(subscription.url))
     return;
 
   for (let filter of subscription.filters)
     filter.addSubscription(subscription);
 }
 
 /**
  * Disconnects a subscription from its filters without any notifications.

[Manish Jethani, 2018/10/16 21:59:32]

s/removes/disconnects/

  * @param {Subscription} subscription The subscription that should be
  *   disconnected from its filters.
  */
-function removeSubscriptionFilters(subscription)
+function disconnectSubscriptionFilters(subscription)
 {
   if (!filterStorage.knownSubscriptions.has(subscription.url))
     return;
 
   for (let filter of subscription.filters)
     filter.removeSubscription(subscription);
 }