Issue 4394 - Create a filter class for element hiding emulation filters

test/filterClasses.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
@@ skipping 22 matching lines @@
 
 let t = null;
 let defaultTypes = null;
 
 exports.setUp = function(callback)
 {
   let sandboxedRequire = createSandbox();
   (
     {Filter, InvalidFilter, CommentFilter, ActiveFilter, RegExpFilter,
      BlockingFilter, WhitelistFilter, ElemHideBase, ElemHideFilter,
-     ElemHideException, ElemHideEmulationFilter} = sandboxedRequire("../lib/filterClasses")

[kzar, 2016/11/21 16:24:55]

Nit: This and some of the other lines you've modified in this file have become /
are too long. Mind fixing them? For example:

   (
     {Filter, InvalidFilter, CommentFilter, ActiveFilter, RegExpFilter,
      BlockingFilter, WhitelistFilter,
      ElemHideBase, ElemHideFilter, ElemHideException,
      ElemHideEmulationFilter} = sandboxedRequire("../lib/filterClasses")

...

if (type == "whitelist" || type == "filterlist" || type == "elemhide" ||
    type == "elemhideexception" || type == "elemhideemulation")

...

if (type == "elemhide" || type == "elemhideexception" ||
    type == "elemhideemulation")

...

test.equal(typeof ElemHideEmulationFilter, "function",
           "typeof ElemHideEmulationFilter");

The compareFilter lines probably aren't worth fixing, but you could try
something like this for those:

compareFilter(
  test,
  "foo.com##aaa [-abp-properties='abc'] bbb",
  ["type=elemhideemulation",
  "text=foo.com##aaa [-abp-properties='abc'] bbb",
  "selectorDomain=foo.com",
  "selector=aaa [-abp-properties='abc'] bbb",
  "domains=FOO.COM"]
);

[Felix Dahlke, 2016/11/21 17:26:12]

I'd actually prefer to leave those alone as part of this patch set, I don't want
the actual changes to go under. Could be done in a separate noissue.

[kzar, 2016/11/21 19:18:22]

On 2016/11/21 17:26:12, Felix Dahlke wrote: 
Fair enough, but IMO you should at least fix the lines which are now too long
but weren't before your changes.

[Felix Dahlke, 2016/11/21 20:11:48]

Fair enough, I fixed all lines I'm touching know, except for the compareFilter()
ones at the bottom. I actually found those a bit easier to deal with without
wrapping, so this seems like something we should touch in a separate commit.

+     ElemHideException,
+     ElemHideEmulationFilter} = sandboxedRequire("../lib/filterClasses")
   );
   t = RegExpFilter.typeMap;
   defaultTypes = 0x7FFFFFFF & ~(t.ELEMHIDE | t.DOCUMENT | t.POPUP |
                                 t.GENERICHIDE | t.GENERICBLOCK);
 
   callback();
 };
 
 function serializeFilter(filter)
 {
@@ skipping 71 matching lines @@
     else if (/^(\w+)/.test(entry))
       hasProperty[RegExp.$1] = true;
   }
 
   function addProperty(prop, value)
   {
     if (!(prop in hasProperty))
       expected.push(prop + "=" + value);
   }
 
-  if (type == "whitelist" || type == "filterlist" || type == "elemhide" || type == "elemhideexception" || type == "elemhideemulation")
+  if (type == "whitelist" || type == "filterlist" || type == "elemhide" ||
+      type == "elemhideexception" || type == "elemhideemulation")
   {
     addProperty("disabled", "false");
     addProperty("lastHit", "0");
     addProperty("hitCount", "0");
   }
   if (type == "whitelist" || type == "filterlist")
   {
     addProperty("contentType", 0x7FFFFFFF & ~(
       RegExpFilter.typeMap.DOCUMENT | RegExpFilter.typeMap.ELEMHIDE |
       RegExpFilter.typeMap.POPUP | RegExpFilter.typeMap.GENERICHIDE |
       RegExpFilter.typeMap.GENERICBLOCK
     ));
     addProperty("matchCase", "false");
     addProperty("thirdParty", "null");
     addProperty("domains", "");
     addProperty("sitekeys", "");
   }
   if (type == "filterlist")
   {
     addProperty("collapse", "null");
   }
-  if (type == "elemhide" || type == "elemhideexception" || type == "elemhideemulation")
+  if (type == "elemhide" || type == "elemhideexception" ||
+      type == "elemhideemulation")
   {
     addProperty("selectorDomain", "");
     addProperty("domains", "");
   }
 }
 
 function compareFilter(test, text, expected, postInit)
 {
   addDefaults(expected);
 
@@ skipping 30 matching lines @@
   test.equal(typeof Filter, "function", "typeof Filter");
   test.equal(typeof InvalidFilter, "function", "typeof InvalidFilter");
   test.equal(typeof CommentFilter, "function", "typeof CommentFilter");
   test.equal(typeof ActiveFilter, "function", "typeof ActiveFilter");
   test.equal(typeof RegExpFilter, "function", "typeof RegExpFilter");
   test.equal(typeof BlockingFilter, "function", "typeof BlockingFilter");
   test.equal(typeof WhitelistFilter, "function", "typeof WhitelistFilter");
   test.equal(typeof ElemHideBase, "function", "typeof ElemHideBase");
   test.equal(typeof ElemHideFilter, "function", "typeof ElemHideFilter");
   test.equal(typeof ElemHideException, "function", "typeof ElemHideException");
-  test.equal(typeof ElemHideEmulationFilter, "function", "typeof ElemHideEmulationFilter");
+  test.equal(typeof ElemHideEmulationFilter, "function",
+             "typeof ElemHideEmulationFilter");
 
   test.done();
 };
 
 exports.testComments = function(test)
 {
   compareFilter(test, "!asdf", ["type=comment", "text=!asdf"]);
   compareFilter(test, "!foo#bar", ["type=comment", "text=!foo#bar"]);
   compareFilter(test, "!foo##bar", ["type=comment", "text=!foo##bar"]);
 
   test.done();
 };
 
 exports.testInvalidFilters = function(test)
 {
   compareFilter(test, "/??/", ["type=invalid", "text=/??/", "reason=filter_invalid_regexp"]);
   compareFilter(test, "asd$foobar", ["type=invalid", "text=asd$foobar", "reason=filter_unknown_option"]);
   compareFilter(test, "#dd(asd)(ddd)", ["type=invalid", "text=#dd(asd)(ddd)", "reason=filter_elemhide_duplicate_id"]);
   compareFilter(test, "#*", ["type=invalid", "text=#*", "reason=filter_elemhide_nocriteria"]);
 
   function checkElemHideEmulationFilterInvalid(domains)
   {
     let filterText = domains + "##[-abp-properties='abc']";
-    compareFilter(test, filterText, ["type=invalid", "text=" + filterText, "reason=filter_elemhideemulation_nodomain"]);
+    compareFilter(test, filterText,
+                  ["type=invalid", "text=" + filterText,
+                   "reason=filter_elemhideemulation_nodomain"]);
   }
   checkElemHideEmulationFilterInvalid("");
   checkElemHideEmulationFilterInvalid("~foo.com");
   checkElemHideEmulationFilterInvalid("~foo.com,~bar.com");
   checkElemHideEmulationFilterInvalid("foo");
   checkElemHideEmulationFilterInvalid("~foo.com,bar");
 
   test.done();
 };
 
@@ skipping 123 matching lines @@
 
   for (let filterText of emptyDomainFilters)
   {
     let filter = Filter.fromText(filterText);
     test.ok(filter instanceof InvalidFilter);
     test.equal(filter.reason, "filter_invalid_domain");
   }
 
   test.done();
 };