Issue 6891, 6741 - Rename FilterStorage to filterStorage

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

Patch Set 1

Because of https://hg.adblockplus.org/adblockpluscore/rev/3c14ad288359 there
will have to be changes to both adblockpluschrome and adblockplusui. If we're
going to make them change their code anyway, we might as well finish all the
changes to lib/filterStorage.js so this only needs to be done once at their end.

The only interesting changes are in lib/filterStorage.js, everywhere else is
just s/FilterStorage/fliterStorage/

In terms of the API, the exported FilterStorage object is now filterStorage
(small F), otherwise it's all the same. I have updated the JSDoc to make it
consistent throughout the file as well as with the changes we've made to other
files recently.

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.js
File lib/filterStorage.js (right):

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:37: const FORMAT_VERSION = 5;
Using `const` and accordingly using ALL_CAPS

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:45: * @hideconstructor
Singleton, so hide constructor.

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:80: * @private
Marked @private

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:104: * The file containing the subscriptions.
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)

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:134: * @returns {?SpecialSubscription}
s/@return/@returns/

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:196: * @param {Array.<Filter>} filters The new list of
filters.
s/Filter[]/Array.<Filter>/

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:337: * @param {?Array.<Filter>} filters The filters to be
reset. If
Added ? before the type to indicate that the value can be null.

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:660: * Connects a subscription to its filters without any
notifications.
s/joins/connects/

https://codereview.adblockplus.org/29912619/diff/29912620/lib/filterStorage.j...
lib/filterStorage.js:674: * Disconnects a subscription from its filters without
any notifications.
s/removes/disconnects/

[Manish Jethani, 2018-10-16 22:04:35]

Patch Set 2: Minor update

[hub, 2018-10-19 18:57:30]

I feel that some of the documentation changes could have been put in a separate
patch

[Manish Jethani, 2018-10-21 12:57:29]

On 2018/10/19 18:57:30, hub wrote:
> I feel that some of the documentation changes could have been put in a
separate
> patch

Any specific examples?

As part of #6741 we have been (1) converting things into ES2015 classes and (2)
fixing any inconsistencies in the JSDoc style. We may have also rewritten some
of the documentation where it made sense, though I don't remember now. Anyway I
can split this into two patches if you like, I just don't know what parts you
think should be separated out. To me it made sense to do all these changes in a
single patch.

[hub, 2018-10-22 13:39:32]

LGTM