rename gatherer base class to gatherer

brendankenny · paulirish · commit 0c7bef779a3a · 2016-07-28T15:41:52.000-04:00
diff --git a/lighthouse-core/gather/gatherers/accessibility.js b/lighthouse-core/gather/gatherers/accessibility.js
@@ -18,7 +18,7 @@
 
 /* global document, __returnResults */
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 const fs = require('fs');
 const axe = fs.readFileSync(
   require.resolve('axe-core/axe.min.js')
@@ -33,7 +33,7 @@ function runA11yChecks() {
   });
 }
 
-class Accessibility extends Gather {
+class Accessibility extends Gatherer {
   static _errorAccessibility(errorString) {
     return {
       raw: undefined,
diff --git a/lighthouse-core/gather/gatherers/cache-contents.js b/lighthouse-core/gather/gatherers/cache-contents.js
@@ -18,7 +18,7 @@
 
 /* global __returnResults, caches */
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
 // This is run in the page, not Lighthouse itself.
 /* istanbul ignore next */
@@ -47,7 +47,7 @@ function getCacheContents() {
       });
 }
 
-class CacheContents extends Gather {
+class CacheContents extends Gatherer {
   static _error(errorString) {
     return {
       raw: undefined,
diff --git a/lighthouse-core/gather/gatherers/content-width.js b/lighthouse-core/gather/gatherers/content-width.js
@@ -16,7 +16,7 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
 /* global window, __returnResults */
 
@@ -30,7 +30,7 @@ function getContentWidth() {
   });
 }
 
-class ContentWidth extends Gather {
+class ContentWidth extends Gatherer {
 
   afterPass(options) {
     const driver = options.driver;
diff --git a/lighthouse-core/gather/gatherers/critical-request-chains.js b/lighthouse-core/gather/gatherers/critical-request-chains.js
@@ -17,12 +17,12 @@
 
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 const WebInspector = require('../../lib/web-inspector');
 
 const includes = (arr, elm) => arr.indexOf(elm) > -1;
 
-class CriticalRequestChains extends Gather {
+class CriticalRequestChains extends Gatherer {
 
   /**
    * For now, we use network priorities as a proxy for "render-blocking"/critical-ness.
diff --git a/lighthouse-core/gather/gatherers/gatherer.js b/lighthouse-core/gather/gatherers/gatherer.js
@@ -16,7 +16,10 @@
  */
 'use strict';
 
-class Gather {
+/**
+ * Base class for all gatherers; defines pass lifecycle methods.
+ */
+class Gatherer {
 
   constructor() {
     this.artifact = {};
@@ -45,4 +48,4 @@ class Gather {
 
 }
 
-module.exports = Gather;
+module.exports = Gatherer;
diff --git a/lighthouse-core/gather/gatherers/geolocation-on-start.js b/lighthouse-core/gather/gatherers/geolocation-on-start.js
@@ -16,7 +16,7 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
 /**
  * @fileoverview Tests whether the page attempts to request geolocation on page load. This often
@@ -42,7 +42,7 @@ function collectGeoState() {
   __returnResults(window.__didNotCallGeo);
 }
 
-class GeolocationOnStart extends Gather {
+class GeolocationOnStart extends Gatherer {
 
   beforePass(options) {
     return options.driver.evaluateScriptOnLoad(`(${overrideGeo.toString()}())`);
diff --git a/lighthouse-core/gather/gatherers/html-without-javascript.js b/lighthouse-core/gather/gatherers/html-without-javascript.js
@@ -18,7 +18,7 @@
 
 /* Note that this returns the innerText of the <body> element, not the HTML. */
 
-const HTML = require('./html');
+const Gatherer = require('./gatherer');
 
 /* global document, __returnResults */
 
@@ -30,7 +30,7 @@ function getBodyText() {
   __returnResults(body ? body.innerText : '');
 }
 
-class HTMLWithoutJavaScript extends HTML {
+class HTMLWithoutJavaScript extends Gatherer {
 
   beforePass(options) {
     options.disableJavaScript = true;
diff --git a/lighthouse-core/gather/gatherers/html.js b/lighthouse-core/gather/gatherers/html.js
@@ -16,9 +16,9 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
-class HTML extends Gather {
+class HTML extends Gatherer {
 
   afterPass(options) {
     const driver = options.driver;
diff --git a/lighthouse-core/gather/gatherers/http-redirect.js b/lighthouse-core/gather/gatherers/http-redirect.js
@@ -16,9 +16,9 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
-class HTTPRedirect extends Gather {
+class HTTPRedirect extends Gatherer {
 
   constructor() {
     super();
diff --git a/lighthouse-core/gather/gatherers/https.js b/lighthouse-core/gather/gatherers/https.js
@@ -16,9 +16,9 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
-class HTTPS extends Gather {
+class HTTPS extends Gatherer {
 
   constructor() {
     super();
diff --git a/lighthouse-core/gather/gatherers/manifest.js b/lighthouse-core/gather/gatherers/manifest.js
@@ -16,7 +16,7 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 const manifestParser = require('../../lib/manifest-parser');
 
 /* global document, XMLHttpRequest, __returnResults */
@@ -53,7 +53,7 @@ function getManifestContent() {
   req.send();
 }
 
-class Manifest extends Gather {
+class Manifest extends Gatherer {
 
   static _errorManifest(errorString) {
     return {
diff --git a/lighthouse-core/gather/gatherers/offline.js b/lighthouse-core/gather/gatherers/offline.js
@@ -19,7 +19,7 @@
 
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
 // *WARNING* do not use fetch.. due to it requiring window focus to fire.
 // Request the current page by issuing a XMLHttpRequest request to ''
@@ -36,7 +36,7 @@ const requestPage = function() {
   oReq.send();
 };
 
-class Offline extends Gather {
+class Offline extends Gatherer {
 
   static config(opts) {
     return {
diff --git a/lighthouse-core/gather/gatherers/screenshots.js b/lighthouse-core/gather/gatherers/screenshots.js
@@ -17,10 +17,10 @@
 
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 const DevtoolsTimelineModel = require('../../lib/traces/devtools-timeline-model');
 
-class ScreenshotFilmstrip extends Gather {
+class ScreenshotFilmstrip extends Gatherer {
 
   fetchScreenshot(frame) {
     return frame
diff --git a/lighthouse-core/gather/gatherers/service-worker.js b/lighthouse-core/gather/gatherers/service-worker.js
@@ -16,9 +16,9 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
-class ServiceWorker extends Gather {
+class ServiceWorker extends Gatherer {
 
   /**
    * @param {string} url
diff --git a/lighthouse-core/gather/gatherers/speedline.js b/lighthouse-core/gather/gatherers/speedline.js
@@ -16,10 +16,10 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 const speedline = require('speedline');
 
-class Speedline extends Gather {
+class Speedline extends Gatherer {
 
   afterPass(options, tracingData) {
     return speedline(tracingData.traceContents).then(results => {
diff --git a/lighthouse-core/gather/gatherers/theme-color.js b/lighthouse-core/gather/gatherers/theme-color.js
@@ -16,9 +16,9 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
-class ThemeColor extends Gather {
+class ThemeColor extends Gatherer {
 
   afterPass(options) {
     const driver = options.driver;
diff --git a/lighthouse-core/gather/gatherers/url.js b/lighthouse-core/gather/gatherers/url.js
@@ -16,9 +16,9 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
-class URL extends Gather {
+class URL extends Gatherer {
 
   beforePass(options) {
     this.artifact = options.url || options.driver.url;
diff --git a/lighthouse-core/gather/gatherers/viewport.js b/lighthouse-core/gather/gatherers/viewport.js
@@ -16,9 +16,9 @@
  */
 'use strict';
 
-const Gather = require('./gather');
+const Gatherer = require('./gatherer');
 
-class Viewport extends Gather {
+class Viewport extends Gatherer {
 
   /**
    * @param {!{driver: !Object}} options Run options
diff --git a/lighthouse-core/test/gather/gather-runner.js b/lighthouse-core/test/gather/gather-runner.js
@@ -18,12 +18,12 @@
 
 /* eslint-env mocha */
 
-const Gather = require('../../gather/gatherers/gather');
+const Gatherer = require('../../gather/gatherers/gatherer');
 const GatherRunner = require('../../gather/gather-runner');
 const Audit = require('../../audits/audit');
 const assert = require('assert');
 
-class TestGatherer extends Gather {
+class TestGatherer extends Gatherer {
   constructor() {
     super();
     this.called = false;
diff --git a/lighthouse-core/test/gather/gatherers/gatherer.js b/lighthouse-core/test/gather/gatherers/gatherer.js
@@ -17,12 +17,12 @@
 
 /* eslint-env mocha */
 
-const Gather = require('../../../gather/gatherers/gather');
+const Gatherer = require('../../../gather/gatherers/gatherer');
 const assert = require('assert');
 
-describe('Gather', () => {
+describe('Gatherer', () => {
   it('returns its name', () => {
-    const g = new Gather();
-    return assert.equal(g.name, 'Gather');
+    const g = new Gatherer();
+    return assert.equal(g.name, 'Gatherer');
   });
 });
