feat: Require Analyzers to provide optimizationOptions hash.

amiller-gh · amiller-gh · commit 2e1080057fd1 · 2018-04-10T23:40:18.000-07:00
diff --git a/packages/css-blocks/src/Analyzer/Analysis.ts b/packages/css-blocks/src/Analyzer/Analysis.ts
@@ -9,7 +9,6 @@ import {
   SerializedTemplateInfo,
   TemplateAnalysis as OptimizationTemplateAnalysis,
   TemplateInfoFactory,
-  TemplateIntegrationOptions,
   TemplateTypes,
 } from "@opticss/template-api";
 import { ObjectDictionary, objectValues } from "@opticss/util";
@@ -137,25 +136,6 @@ export class Analysis<K extends keyof TemplateTypes> {
     return c;
   }
 
-  /**
-   * Get either the owner Analyzer's optimization options, or a default set of options.
-   */
-  optimizationOptions(): TemplateIntegrationOptions {
-    // TODO: Optimization options must be handled / propagated better.
-    return this.parent ? this.parent.optimizationOptions : {
-      rewriteIdents: {
-        id: false,
-        class: true,
-        omitIdents: {
-          id: [],
-          class: [],
-        },
-      },
-      analyzedAttributes: ["class"],
-      analyzedTagnames: false,
-    };
-  }
-
   /**
    * Get an Element by ID.
    */
@@ -391,10 +371,10 @@ export class Analysis<K extends keyof TemplateTypes> {
     return analysis;
   }
 
-  forOptimizer(opts: ResolvedConfiguration): OptimizationTemplateAnalysis<K> {
+  forOptimizer(config: ResolvedConfiguration): OptimizationTemplateAnalysis<K> {
     let optAnalysis = new OptimizationTemplateAnalysis<K>(this.template);
     for (let element of this.elements.values()) {
-      let result = element.forOptimizer(opts);
+      let result = element.forOptimizer(config);
       optAnalysis.elements.push(result[0]);
     }
     return optAnalysis;
diff --git a/packages/css-blocks/src/Analyzer/Analyzer.ts b/packages/css-blocks/src/Analyzer/Analyzer.ts
@@ -20,19 +20,6 @@ import { TemplateValidatorOptions } from "./validations";
 
 const debug = debugGenerator("css-blocks:analyzer");
 
-const DEFAULT_FEATURES = {
-  rewriteIdents: {
-    id: false,
-    class: true,
-    omitIdents: {
-      id: [],
-      class: [],
-    },
-  },
-  analyzedAttributes: ["class"],
-  analyzedTagnames: false,
-};
-
 export interface AnalysisOptions {
   validations?: TemplateValidatorOptions;
   features?: TemplateIntegrationOptions;
@@ -46,7 +33,6 @@ export abstract class Analyzer<K extends keyof TemplateTypes> {
   public readonly blockFactory: BlockFactory;
 
   public readonly validatorOptions: TemplateValidatorOptions;
-  public readonly optimizationOptions: TemplateIntegrationOptions;
   public readonly cssBlocksOptions: ResolvedConfiguration;
 
   protected analysisMap: Map<string, Analysis<K>>;
@@ -59,14 +45,14 @@ export abstract class Analyzer<K extends keyof TemplateTypes> {
   ) {
     this.cssBlocksOptions = resolveConfiguration(options);
     this.validatorOptions = analysisOpts && analysisOpts.validations || {};
-    this.optimizationOptions = analysisOpts && analysisOpts.features || DEFAULT_FEATURES;
     this.blockFactory = new BlockFactory(this.cssBlocksOptions);
     this.analysisMap = new Map();
     this.staticStyles = new MultiMap();
     this.dynamicStyles = new MultiMap();
   }
 
   abstract analyze(...entryPoints: string[]): Promise<Analyzer<K>>;
+  abstract get optimizationOptions(): TemplateIntegrationOptions;
 
   // TODO: We don't really want to burn the world here.
   // We need more targeted Analysis / BlockFactory invalidation.
@@ -134,10 +120,10 @@ export abstract class Analyzer<K extends keyof TemplateTypes> {
     return { analyses };
   }
 
-  forOptimizer(opts: ResolvedConfiguration): OptimizationAnalysis<K>[] {
+  forOptimizer(config: ResolvedConfiguration): OptimizationAnalysis<K>[] {
     let analyses = new Array<OptimizationAnalysis<K>>();
     this.eachAnalysis(a => {
-      analyses.push(a.forOptimizer(opts));
+      analyses.push(a.forOptimizer(config));
     });
     return analyses;
   }
diff --git a/packages/css-blocks/test/opticss-test.ts b/packages/css-blocks/test/opticss-test.ts
@@ -79,6 +79,20 @@ export class TemplateAnalysisTests {
           return this;
         });
       }
+      get optimizationOptions() {
+        return {
+          rewriteIdents: {
+            id: false,
+            class: true,
+            omitIdents: {
+              id: [],
+              class: [],
+            },
+          },
+          analyzedAttributes: ["class"],
+          analyzedTagnames: false,
+        };
+      }
     }
     let analyzer = new TestAnalyzer();
     return analyzer.analyze().then(async (analyzer: TestAnalyzer) => {
diff --git a/packages/css-blocks/test/template-analysis-test.ts b/packages/css-blocks/test/template-analysis-test.ts
@@ -4,22 +4,19 @@ import { assert } from "chai";
 import { skip, suite, test } from "mocha-typescript";
 import * as postcss from "postcss";
 
-import { Analyzer, ElementAnalysis, SerializedAnalysis } from "../src/Analyzer";
+import { ElementAnalysis, SerializedAnalysis } from "../src/Analyzer";
 import { BlockFactory } from "../src/BlockParser";
 import { Attribute, AttrValue, Block, BlockClass } from "../src/BlockTree";
 import { Options, resolveConfiguration } from "../src/configuration";
 import * as cssBlocks from "../src/errors";
 
+import { TestAnalyzer } from "./util/TestAnalyzer";
 import { assertParseError } from "./util/assertError";
 import { setupImporting } from "./util/setupImporting";
 
 type TestElement = ElementAnalysis<null, null, null>;
 type TemplateType = "Opticss.Template";
 
-class TestAnalyzer extends Analyzer<"Opticss.Template"> {
-  analyze() { return Promise.resolve(this); }
-}
-
 type BlockAndRoot = [Block, postcss.Container];
 
 @suite("Template Analysis")
diff --git a/packages/css-blocks/test/util/TestAnalyzer.ts b/packages/css-blocks/test/util/TestAnalyzer.ts
@@ -0,0 +1,19 @@
+import { Analyzer } from "../../src/Analyzer";
+
+export class TestAnalyzer extends Analyzer<"Opticss.Template"> {
+  analyze() { return Promise.resolve(this); }
+  get optimizationOptions() {
+    return {
+      rewriteIdents: {
+        id: false,
+        class: true,
+        omitIdents: {
+          id: [],
+          class: [],
+        },
+      },
+      analyzedAttributes: ["class"],
+      analyzedTagnames: false,
+    };
+  }
+}
diff --git a/packages/css-blocks/test/validations/attribute-group-validator-test.ts b/packages/css-blocks/test/validations/attribute-group-validator-test.ts
@@ -3,19 +3,15 @@ import { assert } from "chai";
 import { suite, test } from "mocha-typescript";
 import * as postcss from "postcss";
 
-import { Analyzer } from "../../src/Analyzer";
 import { BlockFactory } from "../../src/BlockParser";
 import { Block } from "../../src/BlockTree";
 import { Options, resolveConfiguration } from "../../src/configuration";
 import * as cssBlocks from "../../src/errors";
+import { TestAnalyzer } from "../util/TestAnalyzer";
+import { assertParseError } from "../util/assertError";
 import { setupImporting } from "../util/setupImporting";
 
-import { assertParseError } from "./../util/assertError";
-
 type BlockAndRoot = [Block, postcss.Container];
-class TestAnalyzer extends Analyzer<"Opticss.Template"> {
-  analyze() { return Promise.resolve(this); }
-}
 
 @suite("Attribute Group Validator")
 export class TemplateAnalysisTests {
diff --git a/packages/css-blocks/test/validations/attribute-parent-validator-test.ts b/packages/css-blocks/test/validations/attribute-parent-validator-test.ts
@@ -3,19 +3,16 @@ import { assert } from "chai";
 import { suite, test } from "mocha-typescript";
 import * as postcss from "postcss";
 
-import { Analyzer } from "../../src/Analyzer";
 import { BlockFactory } from "../../src/BlockParser";
 import { Block, BlockClass } from "../../src/BlockTree";
 import { Options, resolveConfiguration } from "../../src/configuration";
 import * as cssBlocks from "../../src/errors";
 
+import { TestAnalyzer } from "../util/TestAnalyzer";
 import { assertParseError } from "../util/assertError";
 import { setupImporting } from "../util/setupImporting";
 
 type BlockAndRoot = [Block, postcss.Container];
-class TestAnalyzer extends Analyzer<"Opticss.Template"> {
-  analyze() { return Promise.resolve(this); }
-}
 
 @suite("State Parent Validator")
 export class TemplateAnalysisTests {
diff --git a/packages/css-blocks/test/validations/class-pairs-validator-test.ts b/packages/css-blocks/test/validations/class-pairs-validator-test.ts
@@ -2,17 +2,15 @@ import { Template } from "@opticss/template-api";
 import { suite, test } from "mocha-typescript";
 import * as postcss from "postcss";
 
-import { Analyzer } from "../../src/Analyzer";
 import { BlockFactory } from "../../src/BlockParser";
 import { Block } from "../../src/BlockTree";
 import { Options, resolveConfiguration } from "../../src/configuration";
 import * as cssBlocks from "../../src/errors";
+
+import { TestAnalyzer } from "../util/TestAnalyzer";
 import { assertParseError } from "../util/assertError";
 
 type BlockAndRoot = [Block, postcss.Container];
-class TestAnalyzer extends Analyzer<"Opticss.Template"> {
-  analyze() { return Promise.resolve(this); }
-}
 
 @suite("Class Pairs Validator")
 export class TemplateAnalysisTests {
diff --git a/packages/css-blocks/test/validations/property-conflict-validator-test.ts b/packages/css-blocks/test/validations/property-conflict-validator-test.ts
@@ -3,20 +3,17 @@ import { assert } from "chai";
 import { suite, test } from "mocha-typescript";
 import * as postcss from "postcss";
 
-import { Analyzer } from "../../src/Analyzer";
 import { BlockFactory } from "../../src/BlockParser";
 import { AttrValue, Block, BlockClass, isAttrValue, isBlockClass } from "../../src/BlockTree";
 import { Options, resolveConfiguration } from "../../src/configuration";
 import { CssBlockError, TemplateAnalysisError } from "../../src/errors";
 
 import { MockImportRegistry } from "../util/MockImportRegistry";
+import { TestAnalyzer } from "../util/TestAnalyzer";
 import { assertParseError } from "../util/assertError";
 import { indented } from "../util/indented";
 
 type BlockAndRoot = [Block, postcss.Container];
-class TestAnalyzer extends Analyzer<"Opticss.Template"> {
-  analyze() { return Promise.resolve(this); }
-}
 
 @suite("Property Conflict Validator")
 export class TemplateAnalysisTests {
diff --git a/packages/css-blocks/test/validations/root-class-validator-test.ts b/packages/css-blocks/test/validations/root-class-validator-test.ts
@@ -3,19 +3,17 @@ import { assert } from "chai";
 import { suite, test } from "mocha-typescript";
 import * as postcss from "postcss";
 
-import { Analyzer, SerializedAnalysis } from "../../src/Analyzer";
+import { SerializedAnalysis } from "../../src/Analyzer";
 import { BlockFactory } from "../../src/BlockParser";
 import { Block } from "../../src/BlockTree";
 import { Options, resolveConfiguration } from "../../src/configuration";
 import * as cssBlocks from "../../src/errors";
 
-import { MockImportRegistry } from "./../util/MockImportRegistry";
-import { assertParseError } from "./../util/assertError";
+import { MockImportRegistry } from "../util/MockImportRegistry";
+import { TestAnalyzer } from "../util/TestAnalyzer";
+import { assertParseError } from "../util/assertError";
 
 type BlockAndRoot = [Block, postcss.Container];
-class TestAnalyzer extends Analyzer<"Opticss.Template"> {
-  analyze() { return Promise.resolve(this); }
-}
 
 @suite("Root Class Validator")
 export class AnalysisTests {
diff --git a/packages/css-blocks/test/validations/validator-test.ts b/packages/css-blocks/test/validations/validator-test.ts
@@ -3,17 +3,15 @@ import { Template } from "@opticss/template-api";
 import { suite, test } from "mocha-typescript";
 import * as postcss from "postcss";
 
-import { Analyzer } from "../../src/Analyzer";
 import { BlockFactory } from "../../src/BlockParser";
 import { Block } from "../../src/BlockTree";
 import { Options, resolveConfiguration } from "../../src/configuration";
 import { TemplateAnalysisError } from "../../src/errors";
+
+import { TestAnalyzer } from "../util/TestAnalyzer";
 import { assertParseError } from "../util/assertError";
 
 type BlockAndRoot = [Block, postcss.Container];
-class TestAnalyzer extends Analyzer<"Opticss.Template"> {
-  analyze() { return Promise.resolve(this); }
-}
 
 @suite("Validators")
 export class TemplateAnalysisTests {
diff --git a/packages/glimmer-templates/src/Analyzer.ts b/packages/glimmer-templates/src/Analyzer.ts
@@ -1,4 +1,5 @@
 import { preprocess, traverse } from "@glimmer/syntax";
+import { TemplateIntegrationOptions } from "@opticss/template-api";
 import {
   Analysis,
   AnalysisOptions,
@@ -40,9 +41,25 @@ export class GlimmerAnalyzer extends Analyzer<TEMPLATE_TYPE> {
   }
 
   reset() {
+    super.reset();
     this.project.reset();
   }
 
+  get optimizationOptions(): TemplateIntegrationOptions {
+    return {
+      rewriteIdents: {
+        id: false,
+        class: true,
+        omitIdents: {
+          id: [],
+          class: [],
+        },
+      },
+      analyzedAttributes: ["class"],
+      analyzedTagnames: false,
+    };
+  }
+
   async analyze(...templateNames: string[]): Promise<GlimmerAnalyzer> {
 
     // TODO pass module config https://github.com/tomdale/glimmer-analyzer/pull/1
diff --git a/packages/jsx/src/analyzer/index.ts b/packages/jsx/src/analyzer/index.ts
@@ -1,3 +1,4 @@
+import { TemplateIntegrationOptions } from "@opticss/template-api";
 import { some, unwrap } from "@opticss/util";
 import traverse from "babel-traverse";
 import * as babylon from "babylon";
@@ -43,6 +44,21 @@ export class CSSBlocksJSXAnalyzer extends Analyzer<TEMPLATE_TYPE> {
     this.blockPromises = new Map();
   }
 
+  get optimizationOptions(): TemplateIntegrationOptions {
+    return {
+      rewriteIdents: {
+        id: false,
+        class: true,
+        omitIdents: {
+          id: [],
+          class: [],
+        },
+      },
+      analyzedAttributes: ["class"],
+      analyzedTagnames: false,
+    };
+  }
+
   async analyze(...entryPoints: string[]): Promise<CSSBlocksJSXAnalyzer> {
     if (!entryPoints.length) {
       throw new JSXParseError("CSS Blocks JSX Analyzer must be passed at least one entry point.");
diff --git a/packages/webpack-plugin/test/configs/basicConfig.ts b/packages/webpack-plugin/test/configs/basicConfig.ts
@@ -1,18 +1,14 @@
-import { Analyzer } from "css-blocks";
 import { Configuration as WebpackConfiguration } from "webpack";
 import * as merge from "webpack-merge";
 
 import { LoaderOptions } from "../../src/LoaderOptions";
 import { CssBlocksPlugin } from "../../src/Plugin";
 
+import { TestAnalyzer } from "../util/TestAnalyzer";
 import { BLOCK_LOADER_PATH } from "../util/testPaths";
 
 import { config as defaultOutputConfig } from "./defaultOutputConfig";
 
-export class TestAnalyzer extends Analyzer<"Opticss.Template"> {
-    analyze(): Promise<Analyzer<"Opticss.Template">> { return Promise.resolve(this); }
-}
-
 export function config(entry: string, options?: LoaderOptions): WebpackConfiguration {
   const baseConfig: WebpackConfiguration = {
     entry: entry,
diff --git a/packages/webpack-plugin/test/configs/templateConfig.ts b/packages/webpack-plugin/test/configs/templateConfig.ts
diff --git a/packages/webpack-plugin/test/util/TestAnalyzer.ts b/packages/webpack-plugin/test/util/TestAnalyzer.ts
