@stordata/grammars 1.0.20230421155415

package/src/grammars/parseCustomMetric.spec.js

@@ -0,0 +1,50 @@
+import { expect } from 'chai';
+
+import { CustomMetricListener, CustomMetricParser, walk } from '../index.js';
+
+import parseCustomMetric from './parseCustomMetric.js';
+
+class CountStringsAndStringDividersListener extends CustomMetricListener {
+
+  constructor() {
+    super();
+
+    this.strings = [];
+    this.dividers = [];
+  }
+
+  enterString(ctx) {
+    this.strings.push(ctx.getText());
+  }
+
+  enterDivision(ctx) {
+    if (ctx.right instanceof CustomMetricParser.StringContext) {
+      this.dividers.push(ctx.right.getText());
+    }
+  }
+
+}
+
+describe('The parseCustomMetric function', function() {
+
+  it('should not parseCustomMetric invalid syntax', function() {
+    expect(() => parseCustomMetric('a')).to.throw("mismatched input 'a'");
+  });
+
+  it('should parseCustomMetric valid syntax with only arithmetics', function() {
+    const tree = parseCustomMetric('1+2*(3- 2 )'),
+          listener = walk(tree, new CountStringsAndStringDividersListener());
+
+    expect(listener.strings).to.have.length(0);
+    expect(listener.dividers).to.have.length(0);
+  });
+
+  it('should parseCustomMetric valid syntax with strings, and divisions by strings', function() {
+    const tree = parseCustomMetric('0.5 * ("abcd" / "efgh")/42'),
+          listener = walk(tree, new CountStringsAndStringDividersListener());
+
+    expect(listener.strings).to.deep.equal(['"abcd"', '"efgh"']);
+    expect(listener.dividers).to.deep.equal(['"efgh"']);
+  });
+
+});

package/src/index.js

@@ -0,0 +1,20 @@
+import CustomMetricListener from '../generated/src/grammars/CustomMetricListener.js';
+import CustomMetricParser from '../generated/src/grammars/CustomMetricParser.js';
+import CustomMetricLexer from '../generated/src/grammars/CustomMetricLexer.js';
+
+import GrammarSyntaxError from './GrammarSyntaxError.js';
+import parse from './parse.js';
+import walk from './walk.js';
+import parseCustomMetric from './grammars/parseCustomMetric.js';
+
+export {
+  parse,
+  walk,
+  // The CustomMetric grammar
+  parseCustomMetric,
+  CustomMetricLexer,
+  CustomMetricParser,
+  CustomMetricListener,
+  // Helpers
+  GrammarSyntaxError
+};

package/src/parse.js

@@ -0,0 +1,18 @@
+import { CommonTokenStream, InputStream } from 'antlr4';
+
+import ThrowingErrorListener from './ThrowingErrorListener.js';
+
+export default function parse(input, Lexer, Parser) {
+  const parser = new Parser(
+    new CommonTokenStream(
+      new Lexer(
+        new InputStream(input)
+      )
+    )
+  );
+
+  parser.removeErrorListeners(); // There's a default one
+  parser.addErrorListener(new ThrowingErrorListener()); // Will throw on first error
+
+  return parser.all(); // The "all" rule gotta exist!
+}

package/src/walk.js

@@ -0,0 +1,7 @@
+import { ParseTreeWalker } from 'antlr4';
+
+export default function walk(tree, listener) {
+  ParseTreeWalker.DEFAULT.walk(listener, tree);
+
+  return listener;
+}

package/webpack.config.js

@@ -0,0 +1,8 @@
+export default {
+  mode: 'production',
+  entry: './src/index.js',
+  output: {
+    path: new URL('dist', import.meta.url).pathname,
+    filename: 'main.cjs'
+  }
+};