From 4edc9982cc4dc9a5968150963622f4675975b19b Mon Sep 17 00:00:00 2001
From: David Majda <david@majda.cz>
Date: Wed, 2 May 2012 08:08:09 +0200
Subject: [PATCH] Jasmine: Convert |computeVarNames| compiler pass tests

---
 .../compiler/passes/compute-var-names.spec.js | 273 ++++++++++++++++++
 spec/index.html                               |   1 +
 .../compiler/passes/compute-var-names-test.js | 231 ---------------
 test/index.html                               |   1 -
 test/run                                      |   1 -
 5 files changed, 274 insertions(+), 233 deletions(-)
 create mode 100644 spec/compiler/passes/compute-var-names.spec.js
 delete mode 100644 test/compiler/passes/compute-var-names-test.js

diff --git a/spec/compiler/passes/compute-var-names.spec.js b/spec/compiler/passes/compute-var-names.spec.js
new file mode 100644
index 0000000..e16c8d4
--- /dev/null
+++ b/spec/compiler/passes/compute-var-names.spec.js
@@ -0,0 +1,273 @@
+describe("compiler pass |computeVarNames|", function() {
+  var pass = PEG.compiler.passes.computeVarNames;
+
+  var leafDetails     = { resultVar: "result0" },
+      choiceDetails   = {
+        resultVar:    "result0",
+        alternatives: [
+          { resultVar: "result0", posVar: "pos0" },
+          { resultVar: "result0", posVar: "pos0" },
+          { resultVar: "result0", posVar: "pos0" }
+        ]
+      },
+      sequenceDetails = {
+        resultVar: "result0",
+        posVar:    "pos0",
+        elements:  [
+          { resultVar: "result0", posVar: "pos1" },
+          { resultVar: "result1", posVar: "pos1" },
+          { resultVar: "result2", posVar: "pos1" }
+        ]
+      };
+
+  function ruleDetails(details) { return { rules: [details] }; }
+
+  beforeEach(function() {
+    this.addMatchers({
+      toChangeAST: function(grammar, details) {
+        function matchDetails(value, details) {
+          function isArray(value) {
+            return Object.prototype.toString.apply(value) === "[object Array]";
+          }
+
+          function isObject(value) {
+            return value !== null && typeof value === "object";
+          }
+
+          var i, key;
+
+          if (isArray(details)) {
+            if (!isArray(value)) { return false; }
+
+            if (value.length !== details.length) { return false; }
+            for (i = 0; i < details.length; i++) {
+              if (!matchDetails(value[i], details[i])) { return false; }
+            }
+
+            return true;
+          } else if (isObject(details)) {
+            if (!isObject(value)) { return false; }
+
+            for (key in details) {
+              if (!(key in value)) { return false; }
+
+              if (!matchDetails(value[key], details[key])) { return false; }
+            }
+
+            return true;
+          } else {
+            return value === details;
+          }
+        }
+
+        var ast = PEG.parser.parse(grammar);
+
+        this.actual(ast);
+
+        this.message = function() {
+          return "Expected the pass "
+               + (this.isNot ? "not " : "")
+               + "to change the AST " + jasmine.pp(ast) + " "
+               + "to match " + jasmine.pp(details) + ", "
+               + "but it " + (this.isNot ? "did" : "didn't") + ".";
+        };
+
+        return matchDetails(ast, details);
+      }
+    });
+  });
+
+  it("computes variable names for a choice", function() {
+    expect(pass).toChangeAST('start = &"a" / &"b" / &"c"', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    ["pos0"],
+      expression: choiceDetails
+    }));
+    expect(pass).toChangeAST('start = &"a" / &"b"* / &"c"', ruleDetails({
+      resultVars: ["result0", "result1"],
+      posVars:    ["pos0"],
+      expression: choiceDetails
+    }));
+    expect(pass).toChangeAST('start = &"a" / &(&"b") / &"c"', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    ["pos0", "pos1"],
+      expression: choiceDetails
+    }));
+  });
+
+  it("computes variable names for a sequence", function() {
+    expect(pass).toChangeAST('start = ', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    ["pos0"],
+      expression: { resultVar: "result0", posVar: "pos0" }
+    }));
+    expect(pass).toChangeAST('start = &"a" &"b" &"c"', ruleDetails({
+      resultVars: ["result0", "result1", "result2"],
+      posVars:    ["pos0", "pos1"],
+      expression: sequenceDetails
+    }));
+    expect(pass).toChangeAST('start = &"a" &"b" &"c"*', ruleDetails({
+      resultVars: ["result0", "result1", "result2", "result3"],
+      posVars:    ["pos0", "pos1"],
+      expression: sequenceDetails
+    }));
+    expect(pass).toChangeAST('start = &"a" &"b"* &"c"', ruleDetails({
+      resultVars: ["result0", "result1", "result2"],
+      posVars:    ["pos0", "pos1"],
+      expression: sequenceDetails
+    }));
+    expect(pass).toChangeAST('start = &"a" &("b"*)* &"c"', ruleDetails({
+      resultVars: ["result0", "result1", "result2", "result3"],
+      posVars:    ["pos0", "pos1"],
+      expression: sequenceDetails
+    }));
+    expect(pass).toChangeAST('start = &"a"* &"b" &"c"', ruleDetails({
+      resultVars: ["result0", "result1", "result2"],
+      posVars:    ["pos0", "pos1"],
+      expression: sequenceDetails
+    }));
+    expect(pass).toChangeAST('start = &("a"*)* &"b" &"c"', ruleDetails({
+      resultVars: ["result0", "result1", "result2"],
+      posVars:    ["pos0", "pos1"],
+      expression: sequenceDetails
+    }));
+    expect(pass).toChangeAST('start = &(("a"*)*)* &"b" &"c"', ruleDetails({
+      resultVars: ["result0", "result1", "result2", "result3"],
+      posVars:    ["pos0", "pos1"],
+      expression: sequenceDetails
+    }));
+    expect(pass).toChangeAST('start = &"a" &(&"b") &"c"', ruleDetails({
+      resultVars: ["result0", "result1", "result2"],
+      posVars:    ["pos0", "pos1", "pos2"],
+      expression: sequenceDetails
+    }));
+  });
+
+  it("computes variable names for a labeled", function() {
+    expect(pass).toChangeAST('start = label:&"a"', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    ["pos0"],
+      expression: {
+        resultVar:  "result0",
+        expression: { resultVar: "result0", posVar: "pos0" }
+      }
+    }));
+  });
+
+  it("computes variable names for a simple and", function() {
+    expect(pass).toChangeAST('start = &(&"a")', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    ["pos0", "pos1"],
+      expression: {
+        resultVar:  "result0",
+        posVar:     "pos0",
+        expression: { resultVar: "result0", posVar: "pos1" }
+      }
+    }));
+  });
+
+  it("computes variable names for a simple not", function() {
+    expect(pass).toChangeAST('start = !(&"a")', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    ["pos0", "pos1"],
+      expression: {
+        resultVar:  "result0",
+        posVar:     "pos0",
+        expression: { resultVar: "result0", posVar: "pos1" }
+      }
+    }));
+  });
+
+  it("computes variable names for a semantic and", function() {
+    expect(pass).toChangeAST('start = &{ code }', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    [],
+      expression: leafDetails
+    }));
+  });
+
+  it("computes variable names for a semantic not", function() {
+    expect(pass).toChangeAST('start = !{ code }', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    [],
+      expression: leafDetails
+    }));
+  });
+
+  it("computes variable names for an optional", function() {
+    expect(pass).toChangeAST('start = (&"a")?', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    ["pos0"],
+      expression: {
+        resultVar:  "result0",
+        expression: { resultVar: "result0", posVar: "pos0" }
+      }
+    }));
+  });
+
+  it("computes variable names for a zero or more", function() {
+    expect(pass).toChangeAST('start = (&"a")*', ruleDetails({
+      resultVars: ["result0", "result1"],
+      posVars:    ["pos0"],
+      expression: {
+        resultVar:  "result0",
+        expression: { resultVar: "result1", posVar: "pos0" }
+      }
+    }));
+  });
+
+  it("computes variable names for a one or more", function() {
+    expect(pass).toChangeAST('start = (&"a")+', ruleDetails({
+      resultVars: ["result0", "result1"],
+      posVars:    ["pos0"],
+      expression: {
+        resultVar:  "result0",
+        expression: { resultVar: "result1", posVar: "pos0" }
+      }
+    }));
+  });
+
+  it("computes variable names for an action", function() {
+    expect(pass).toChangeAST('start = &"a" { code }', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    ["pos0", "pos1"],
+      expression: {
+        resultVar:  "result0",
+        posVar:     "pos0",
+        expression: { resultVar: "result0", posVar: "pos1" }
+      }
+    }));
+  });
+
+  it("computes variable names for a rule reference", function() {
+    expect(pass).toChangeAST('start = a', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    [],
+      expression: leafDetails
+    }));
+  });
+
+  it("computes variable names for a literal", function() {
+    expect(pass).toChangeAST('start = "a"', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    [],
+      expression: leafDetails
+    }));
+  });
+
+  it("computes variable names for an any", function() {
+    expect(pass).toChangeAST('start = .', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    [],
+      expression: leafDetails
+    }));
+  });
+
+  it("computes variable names for a class", function() {
+    expect(pass).toChangeAST('start = [a-z]', ruleDetails({
+      resultVars: ["result0"],
+      posVars:    [],
+      expression: leafDetails
+    }));
+  });
+});
diff --git a/spec/index.html b/spec/index.html
index e5b200a..7622420 100644
--- a/spec/index.html
+++ b/spec/index.html
@@ -10,6 +10,7 @@
     <script src="generated-parser.spec.js"></script>
     <script src="compiler/passes/report-missing-rules.spec.js"></script>
     <script src="compiler/passes/report-left-recursion.spec.js"></script>
+    <script src="compiler/passes/compute-var-names.spec.js"></script>
     <script>
       (function() {
         var env      = jasmine.getEnv(),
diff --git a/test/compiler/passes/compute-var-names-test.js b/test/compiler/passes/compute-var-names-test.js
deleted file mode 100644
index 1f75016..0000000
--- a/test/compiler/passes/compute-var-names-test.js
+++ /dev/null
@@ -1,231 +0,0 @@
-(function() {
-
-module("PEG.compiler.passes.computeVarNames");
-
-test("computes variable names", function() {
-  var leafDetails     = { resultVar: "result0" },
-      choiceDetails   = {
-        resultVar:    "result0",
-        alternatives: [
-          { resultVar: "result0", posVar: "pos0" },
-          { resultVar: "result0", posVar: "pos0" },
-          { resultVar: "result0", posVar: "pos0" }
-        ]
-      },
-      sequenceDetails = {
-        resultVar: "result0",
-        posVar:    "pos0",
-        elements:  [
-          { resultVar: "result0", posVar: "pos1" },
-          { resultVar: "result1", posVar: "pos1" },
-          { resultVar: "result2", posVar: "pos1" }
-        ]
-      };
-
-  var cases = [
-    /* Choice */
-    {
-      grammar:    'start = &"a" / &"b" / &"c"',
-      resultVars: ["result0"],
-      posVars:    ["pos0"],
-      details:    choiceDetails
-    },
-    {
-      grammar:    'start = &"a" / &"b"* / &"c"',
-      resultVars: ["result0", "result1"],
-      posVars:    ["pos0"],
-      details:    choiceDetails
-    },
-    {
-      grammar:    'start = &"a" / &(&"b") / &"c"',
-      resultVars: ["result0"],
-      posVars:    ["pos0", "pos1"],
-      details:    choiceDetails
-    },
-
-    /* Sequence */
-    {
-      grammar:    'start = ',
-      resultVars: ["result0"],
-      posVars:    ["pos0"],
-      details:    { resultVar: "result0", posVar: "pos0" }
-    },
-    {
-      grammar:    'start = &"a" &"b" &"c"',
-      resultVars: ["result0", "result1", "result2"],
-      posVars:    ["pos0", "pos1"],
-      details:    sequenceDetails
-    },
-    {
-      grammar:    'start = &"a" &"b" &"c"*',
-      resultVars: ["result0", "result1", "result2", "result3"],
-      posVars:    ["pos0", "pos1"],
-      details:    sequenceDetails
-    },
-    {
-      grammar:    'start = &"a" &"b"* &"c"',
-      resultVars: ["result0", "result1", "result2"],
-      posVars:    ["pos0", "pos1"],
-      details:    sequenceDetails
-    },
-    {
-      grammar:    'start = &"a" &("b"*)* &"c"',
-      resultVars: ["result0", "result1", "result2", "result3"],
-      posVars:    ["pos0", "pos1"],
-      details:    sequenceDetails
-    },
-    {
-      grammar:    'start = &"a"* &"b" &"c"',
-      resultVars: ["result0", "result1", "result2"],
-      posVars:    ["pos0", "pos1"],
-      details:    sequenceDetails
-    },
-    {
-      grammar:    'start = &("a"*)* &"b" &"c"',
-      resultVars: ["result0", "result1", "result2"],
-      posVars:    ["pos0", "pos1"],
-      details:    sequenceDetails
-    },
-    {
-      grammar:    'start = &(("a"*)*)* &"b" &"c"',
-      resultVars: ["result0", "result1", "result2", "result3"],
-      posVars:    ["pos0", "pos1"],
-      details:    sequenceDetails
-    },
-    {
-      grammar:    'start = &"a" &(&"b") &"c"',
-      resultVars: ["result0", "result1", "result2"],
-      posVars:    ["pos0", "pos1", "pos2"],
-      details:    sequenceDetails
-    },
-
-    /* Others */
-    {
-      grammar:    'start = label:&"a"',
-      resultVars: ["result0"],
-      posVars:    ["pos0"],
-      details:    {
-        resultVar:  "result0",
-        expression: { resultVar: "result0", posVar: "pos0" }
-      }
-    },
-    {
-      grammar:    'start = &(&"a")',
-      resultVars: ["result0"],
-      posVars:    ["pos0", "pos1"],
-      details:    {
-        resultVar:  "result0",
-        posVar:     "pos0",
-        expression: { resultVar: "result0", posVar: "pos1" }
-      }
-    },
-    {
-      grammar:    'start = !(&"a")',
-      resultVars: ["result0"],
-      posVars:    ["pos0", "pos1"],
-      details:    {
-        resultVar:  "result0",
-        posVar:     "pos0",
-        expression: { resultVar: "result0", posVar: "pos1" }
-      }
-    },
-    {
-      grammar:    'start = &{ code }',
-      resultVars: ["result0"],
-      posVars:    [],
-      details:    leafDetails
-    },
-    {
-      grammar:    'start = !{ code }',
-      resultVars: ["result0"],
-      posVars:    [],
-      details:    leafDetails
-    },
-    {
-      grammar:    'start = (&"a")?',
-      resultVars: ["result0"],
-      posVars:    ["pos0"],
-      details:    {
-        resultVar:  "result0",
-        expression: { resultVar: "result0", posVar: "pos0" }
-      }
-    },
-    {
-      grammar:    'start = (&"a")*',
-      resultVars: ["result0", "result1"],
-      posVars:    ["pos0"],
-      details:    {
-        resultVar:  "result0",
-        expression: { resultVar: "result1", posVar: "pos0" }
-      }
-    },
-    {
-      grammar:    'start = (&"a")+',
-      resultVars: ["result0", "result1"],
-      posVars:    ["pos0"],
-      details:    {
-        resultVar:  "result0",
-        expression: { resultVar: "result1", posVar: "pos0" }
-      }
-    },
-    {
-      grammar:    'start = &"a" { code }',
-      resultVars: ["result0"],
-      posVars:    ["pos0", "pos1"],
-      details:    {
-        resultVar:  "result0",
-        posVar:     "pos0",
-        expression: { resultVar: "result0", posVar: "pos1" }
-      }
-    },
-    {
-      grammar:    'start = a',
-      resultVars: ["result0"],
-      posVars:    [],
-      details:    leafDetails
-    },
-    {
-      grammar:    'start = "a"',
-      resultVars: ["result0"],
-      posVars:    [],
-      details:    leafDetails
-    },
-    {
-      grammar:    'start = .',
-      resultVars: ["result0"],
-      posVars:    [],
-      details:    leafDetails
-    },
-    {
-      grammar:    'start = [a-z]',
-      resultVars: ["result0"],
-      posVars:    [],
-      details:    leafDetails
-    }
-  ];
-
-  function checkDetails(node, details) {
-    for (var key in details) {
-      if (Object.prototype.toString.call(details[key]) === "[object Array]") {
-        for (var i = 0; i < details[key].length; i++) {
-          checkDetails(node[key][i], details[key][i]);
-        }
-      } else if (typeof details[key] === "object") {
-        checkDetails(node[key], details[key]);
-      } else {
-        strictEqual(node[key], details[key]);
-      }
-    }
-  }
-
-  for (var i = 0; i < cases.length; i++) {
-    var ast = PEG.parser.parse(cases[i].grammar);
-    PEG.compiler.passes.computeVarNames(ast);
-
-    deepEqual(ast.rules[0].resultVars, cases[i].resultVars);
-    deepEqual(ast.rules[0].posVars,    cases[i].posVars);
-    checkDetails(ast.rules[0].expression, cases[i].details);
-  }
-});
-
-})();
diff --git a/test/index.html b/test/index.html
index 64814df..cad99a1 100644
--- a/test/index.html
+++ b/test/index.html
@@ -8,7 +8,6 @@
     <script src="vendor/qunit/qunit.js"></script>
     <script src="helpers.js"></script>
     <script src="compiler/passes/remove-proxy-rules-test.js"></script>
-    <script src="compiler/passes/compute-var-names-test.js"></script>
     <script src="compiler/passes/compute-params-test.js"></script>
   </head>
   <body>
diff --git a/test/run b/test/run
index 43e4789..33685a6 100755
--- a/test/run
+++ b/test/run
@@ -76,7 +76,6 @@ QUnit.done(function(details) {
 [
   "helpers.js",
   "compiler/passes/remove-proxy-rules-test.js",
-  "compiler/passes/compute-var-names-test.js",
   "compiler/passes/compute-params-test.js"
 ].forEach(function(file) {
   eval("with (QUnit) {" + fs.readFileSync(__dirname + "/" + file, "utf8") + "}");