gremlin 3.8.1 → 4.0.0-beta.3

package/build/esm/language/translator/GroovyTranslateVisitor.js

@@ -0,0 +1,304 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+// Context parameters are typed as `any` because the generated grammar files
+// require accepting arbitrary context types at runtime.
+import TranslateVisitor from './TranslateVisitor.js';
+/**
+ * Converts a Gremlin traversal string into a Groovy source code representation.
+ * Mirrors the Java GroovyTranslateVisitor.
+ */
+export default class GroovyTranslateVisitor extends TranslateVisitor {
+    constructor(graphTraversalSourceName = 'g') {
+        super(graphTraversalSourceName);
+    }
+    visitIntegerLiteral(ctx) {
+        const integerLiteral = ctx.getText().toLowerCase();
+        const lastChar = integerLiteral[integerLiteral.length - 1];
+        if (!/[a-z]/.test(lastChar)) {
+            this.sb.push(integerLiteral);
+            return;
+        }
+        const num = integerLiteral.slice(0, -1);
+        switch (lastChar) {
+            case 'b':
+                this.sb.push('(byte)');
+                this.sb.push(num);
+                break;
+            case 's':
+                this.sb.push('(short)');
+                this.sb.push(num);
+                break;
+            case 'n':
+                // Groovy BigInteger uses the 'g' suffix
+                this.sb.push(num);
+                this.sb.push('g');
+                break;
+            default:
+                // i and l suffixes and anything else kept as-is
+                this.sb.push(integerLiteral);
+        }
+    }
+    visitFloatLiteral(ctx) {
+        if (ctx.infLiteral() != null) {
+            this.visit(ctx.infLiteral());
+            return;
+        }
+        if (ctx.nanLiteral() != null) {
+            this.visit(ctx.nanLiteral());
+            return;
+        }
+        const floatLiteral = ctx.getText().toLowerCase();
+        const lastChar = floatLiteral[floatLiteral.length - 1];
+        if (!/[a-z]/.test(lastChar)) {
+            this.sb.push(floatLiteral);
+            return;
+        }
+        const num = floatLiteral.slice(0, -1);
+        switch (lastChar) {
+            case 'f':
+            case 'd':
+                // keep f/d suffix as-is
+                this.sb.push(floatLiteral);
+                break;
+            case 'm':
+                // Groovy BigDecimal: if no decimal point use new BigDecimal(NL), else just the number
+                if (!floatLiteral.includes('.')) {
+                    this.sb.push('new BigDecimal(');
+                    this.sb.push(num);
+                    this.sb.push('L)');
+                }
+                else {
+                    this.sb.push(num);
+                }
+                break;
+            default:
+                this.sb.push(floatLiteral);
+        }
+    }
+    visitInfLiteral(ctx) {
+        if (ctx.SignedInfLiteral() != null && ctx.SignedInfLiteral().getText() === '-Infinity') {
+            this.sb.push('Double.NEGATIVE_INFINITY');
+        }
+        else {
+            this.sb.push('Double.POSITIVE_INFINITY');
+        }
+    }
+    visitUuidLiteral(ctx) {
+        if (ctx.stringLiteral() == null) {
+            this.sb.push('UUID.randomUUID()');
+            return;
+        }
+        this.sb.push('UUID.fromString(');
+        this.sb.push(ctx.stringLiteral().getText());
+        this.sb.push(')');
+    }
+    visitCharacterLiteral(ctx) {
+        const text = ctx.getText();
+        const withoutSuffix = text.substring(0, text.length - 1);
+        const inner = TranslateVisitor.removeFirstAndLastCharacters(withoutSuffix);
+        this.sb.push("'");
+        this.sb.push(inner);
+        this.sb.push("' as char");
+    }
+    visitDurationLiteral(ctx) {
+        const seconds = parseInt(ctx.integerLiteral(0).getText(), 10);
+        const nanos = parseInt(ctx.integerLiteral(1).getText(), 10);
+        const isPositive = ctx.booleanLiteral() === null ||
+            ctx.booleanLiteral().getText() === 'true';
+        this.sb.push(`Duration.ofSeconds(${seconds}, ${nanos})`);
+        if (!isPositive) {
+            this.sb.push('.negated()');
+        }
+    }
+    visitBinaryLiteral(ctx) {
+        this.sb.push('ByteBuffer.wrap(Base64.getDecoder().decode(');
+        this.sb.push(ctx.stringLiteral().getText());
+        this.sb.push('))');
+    }
+    visitNullLiteral(ctx) {
+        if (ctx.parent?.constructor?.name === 'GenericMapNullableArgumentContext') {
+            this.sb.push('null as Map');
+        }
+        else {
+            this.sb.push(ctx.getText());
+        }
+    }
+    visitGenericSetLiteral(ctx) {
+        this.sb.push('[');
+        const literals = ctx.genericLiteral();
+        for (let i = 0; i < literals.length; i++) {
+            this.visit(literals[i]);
+            if (i < literals.length - 1)
+                this.sb.push(', ');
+        }
+        this.sb.push('] as Set');
+    }
+    visitStringLiteral(ctx) {
+        // Preserve original quote style and escape Groovy GString interpolation
+        this.sb.push(ctx.getText().replace(/\$/g, () => '\\$'));
+    }
+    visitStringNullableLiteral(ctx) {
+        if (ctx.getText() === 'null') {
+            this.sb.push('null');
+        }
+        else {
+            // Preserve original quote style and escape Groovy GString interpolation
+            this.sb.push(ctx.getText().replace(/\$/g, () => '\\$'));
+        }
+    }
+    visitMapKey(ctx) {
+        if (ctx.LPAREN() != null && ctx.RPAREN() != null) {
+            // Groovy map syntax: expression keys must be parenthesized — preserve the parens
+            this.sb.push('(');
+            this.visit(ctx.getChild(1));
+            this.sb.push(')');
+        }
+        else {
+            this.visit(ctx.getChild(0));
+        }
+    }
+    visitNakedKey(ctx) {
+        // Groovy map/config syntax uses unquoted identifier keys
+        this.sb.push(ctx.getText());
+    }
+    visitKeyword(ctx) {
+        const keyword = ctx.getText();
+        const parentName = ctx.parent?.constructor?.name ?? '';
+        if (parentName === 'MapKeyContext' || parentName === 'ConfigurationContext') {
+            // Groovy uses unquoted keys
+            this.sb.push(keyword);
+        }
+        else {
+            this.sb.push(keyword);
+            this.sb.push(' ');
+        }
+    }
+    visitTraversalStrategy(ctx) {
+        if (ctx.getChildCount() === 1) {
+            // No-arg strategy: output name as-is (no .instance())
+            this.sb.push(ctx.getText());
+        }
+        else {
+            // Ensure 'new' keyword is present
+            if (ctx.getChild(0).getText() !== 'new') {
+                this.sb.push('new ');
+            }
+            this.visitChildren(ctx);
+        }
+    }
+    visitTraversalSourceSpawnMethod_inject(ctx) {
+        this.handleInject(ctx);
+    }
+    visitTraversalMethod_inject(ctx) {
+        this.handleInject(ctx);
+    }
+    visitTraversalMethod_hasLabel_String_String(ctx) {
+        if (ctx.getChildCount() > 4 && ctx.getChild(2).getText() === 'null') {
+            const varArgs = ctx.getChild(4);
+            this.sb.push(ctx.getChild(0).getText());
+            this.sb.push('((String) null, ');
+            for (let i = 0; i < varArgs.getChildCount(); i += 2) {
+                if (varArgs.getChild(i).getText() === 'null') {
+                    this.sb.push('(String) null');
+                }
+                else {
+                    this.visit(varArgs.getChild(i));
+                }
+                if (i < varArgs.getChildCount() - 1) {
+                    this.sb.push(', ');
+                }
+            }
+            this.sb.push(')');
+            return;
+        }
+        this.visitChildren(ctx);
+    }
+    visitTraversalMethod_option_Merge_Map(ctx) {
+        this.sb.push('option(');
+        this.visit(ctx.traversalMerge());
+        this.sb.push(', ');
+        this.tryCastMapNullableArgument(ctx.genericMapNullableArgument());
+        this.sb.push(')');
+    }
+    visitTraversalMethod_mergeV_Map(ctx) {
+        this.sb.push('mergeV(');
+        this.tryCastMapNullableArgument(ctx.genericMapNullableArgument());
+        this.sb.push(')');
+    }
+    visitTraversalSourceSpawnMethod_mergeV_Map(ctx) {
+        this.sb.push('mergeV(');
+        this.tryCastMapNullableArgument(ctx.genericMapNullableArgument());
+        this.sb.push(')');
+    }
+    visitTraversalMethod_mergeE_Map(ctx) {
+        this.sb.push('mergeE(');
+        this.tryCastMapNullableArgument(ctx.genericMapNullableArgument());
+        this.sb.push(')');
+    }
+    visitTraversalSourceSpawnMethod_mergeE_Map(ctx) {
+        this.sb.push('mergeE(');
+        this.tryCastMapNullableArgument(ctx.genericMapNullableArgument());
+        this.sb.push(')');
+    }
+    tryCastMapNullableArgument(ctx) {
+        const nullableLit = ctx?.genericMapNullableLiteral?.();
+        if (nullableLit != null && nullableLit?.nullLiteral?.() != null) {
+            this.sb.push('(Map) null');
+        }
+        else {
+            this.visit(ctx);
+        }
+    }
+    /**
+     * Special handling for inject with second `null` argument like g.inject(1, null).
+     * inject() is ambiguous in Groovy with jdk extension inject(Object, Closure).
+     */
+    handleInject(ctx) {
+        if (ctx.getChildCount() > 3) {
+            const child2 = ctx.getChild(2);
+            if (child2?.constructor?.name === 'GenericLiteralVarargsContext') {
+                const varArgs = child2;
+                if (varArgs.getChildCount() === 1) {
+                    const child0 = varArgs.getChild(0);
+                    if (child0?.constructor?.name === 'GenericLiteralExprContext') {
+                        const injectArgs = child0;
+                        if (injectArgs.getChildCount() > 2 && injectArgs.getChild(2).getText() === 'null') {
+                            this.sb.push(ctx.getChild(0).getText());
+                            this.sb.push('(');
+                            for (let i = 0; i < injectArgs.getChildCount(); i += 2) {
+                                if (i === 2) {
+                                    this.sb.push('(Object) null');
+                                }
+                                else {
+                                    this.visit(injectArgs.getChild(i));
+                                }
+                                if (i < injectArgs.getChildCount() - 1) {
+                                    this.sb.push(', ');
+                                }
+                            }
+                            this.sb.push(')');
+                            return;
+                        }
+                    }
+                }
+            }
+        }
+        this.visitChildren(ctx);
+    }
+}

package/build/esm/language/translator/JavaTranslateVisitor.d.ts

@@ -0,0 +1,26 @@
+import TranslateVisitor from './TranslateVisitor.js';
+/**
+ * Converts a Gremlin traversal string into a Java source code representation.
+ * Mirrors the Java JavaTranslateVisitor.
+ */
+export default class JavaTranslateVisitor extends TranslateVisitor {
+    constructor(graphTraversalSourceName?: string);
+    visitTraversalStrategy(ctx: any): void;
+    visitConfiguration(ctx: any): void;
+    visitClassType(ctx: any): void;
+    visitGenericMapLiteral(ctx: any): void;
+    visitMapEntry(ctx: any): void;
+    visitMapKey(ctx: any): void;
+    visitDateLiteral(ctx: any): void;
+    visitNanLiteral(_ctx: any): void;
+    visitInfLiteral(ctx: any): void;
+    visitIntegerLiteral(ctx: any): void;
+    visitFloatLiteral(ctx: any): void;
+    visitUuidLiteral(ctx: any): void;
+    visitCharacterLiteral(ctx: any): void;
+    visitDurationLiteral(ctx: any): void;
+    visitBinaryLiteral(ctx: any): void;
+    visitGenericRangeLiteral(_ctx: any): void;
+    visitGenericSetLiteral(ctx: any): void;
+    visitGenericCollectionLiteral(ctx: any): void;
+}

package/build/esm/language/translator/JavaTranslateVisitor.js

@@ -0,0 +1,264 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+// Context parameters are typed as `any` because the generated grammar files
+// require accepting arbitrary context types at runtime.
+import TranslateVisitor from './TranslateVisitor.js';
+import { TranslatorException } from './TranslatorException.js';
+/**
+ * Converts a Gremlin traversal string into a Java source code representation.
+ * Mirrors the Java JavaTranslateVisitor.
+ */
+export default class JavaTranslateVisitor extends TranslateVisitor {
+    constructor(graphTraversalSourceName = 'g') {
+        super(graphTraversalSourceName);
+    }
+    visitTraversalStrategy(ctx) {
+        if (ctx.getChildCount() === 1) {
+            this.sb.push(ctx.getText());
+            this.sb.push('.instance()');
+            return;
+        }
+        this.visit(ctx.classType());
+        this.sb.push('.build()');
+        const configs = ctx.configuration();
+        // mirrors Java: ctx.getChild(1) is "OptionsStrategy" only when form is `new OptionsStrategy(...)`
+        const isNewOptionsStrategy = configs.length > 0 &&
+            ctx.getChild(1)?.getText() === 'OptionsStrategy';
+        if (isNewOptionsStrategy) {
+            for (const cfg of configs) {
+                this.sb.push('.with("');
+                this.sb.push(cfg.getChild(0).getText());
+                this.sb.push('", ');
+                this.visit(cfg.getChild(2));
+                this.sb.push(')');
+            }
+        }
+        else {
+            for (const cfg of configs) {
+                this.sb.push('.');
+                this.visit(cfg);
+            }
+        }
+        this.sb.push('.create()');
+    }
+    visitConfiguration(ctx) {
+        this.sb.push(ctx.getChild(0).getText());
+        this.sb.push('(');
+        this.visit(ctx.getChild(2));
+        this.sb.push(')');
+    }
+    visitClassType(ctx) {
+        const parentName = ctx.parent?.constructor?.name ?? '';
+        this.sb.push(ctx.getText());
+        if (parentName === 'TraversalSourceSelfMethod_withoutStrategiesContext' ||
+            parentName === 'ClassTypeExprContext') {
+            this.sb.push('.class');
+        }
+    }
+    visitGenericMapLiteral(ctx) {
+        this.sb.push('new LinkedHashMap<Object, Object>() {{ ');
+        const entries = ctx.mapEntry();
+        for (let i = 0; i < entries.length; i++) {
+            this.visit(entries[i]);
+            if (i < entries.length - 1)
+                this.sb.push(' ');
+        }
+        this.sb.push(' }}');
+    }
+    visitMapEntry(ctx) {
+        this.sb.push('put(');
+        this.visit(ctx.mapKey());
+        this.sb.push(', ');
+        this.visit(ctx.genericLiteral());
+        this.sb.push(');');
+    }
+    visitMapKey(ctx) {
+        const keyIndex = (ctx.LPAREN() != null && ctx.RPAREN() != null) ? 1 : 0;
+        this.visit(ctx.getChild(keyIndex));
+    }
+    visitDateLiteral(ctx) {
+        const dtString = ctx.getChild(2).getText();
+        const inner = TranslateVisitor.removeFirstAndLastCharacters(dtString);
+        this.sb.push('OffsetDateTime.parse("');
+        this.sb.push(formatDatetimeJavaStyle(inner));
+        this.sb.push('")');
+    }
+    visitNanLiteral(_ctx) {
+        this.sb.push('Double.NaN');
+    }
+    visitInfLiteral(ctx) {
+        if (ctx.SignedInfLiteral() != null && ctx.SignedInfLiteral().getText() === '-Infinity') {
+            this.sb.push('Double.NEGATIVE_INFINITY');
+        }
+        else {
+            this.sb.push('Double.POSITIVE_INFINITY');
+        }
+    }
+    visitIntegerLiteral(ctx) {
+        const integerLiteral = ctx.getText().toLowerCase();
+        const lastChar = integerLiteral[integerLiteral.length - 1];
+        if (!/[a-z]/.test(lastChar)) {
+            this.sb.push(integerLiteral);
+            return;
+        }
+        const num = integerLiteral.slice(0, -1);
+        switch (lastChar) {
+            case 'b':
+                this.sb.push('new Byte(');
+                this.sb.push(num);
+                this.sb.push(')');
+                break;
+            case 's':
+                this.sb.push('new Short(');
+                this.sb.push(num);
+                this.sb.push(')');
+                break;
+            case 'i':
+                this.sb.push(num);
+                break;
+            case 'l':
+                this.sb.push(integerLiteral); // keep the 'l' suffix
+                break;
+            case 'n':
+                this.sb.push('new BigInteger("');
+                this.sb.push(num);
+                this.sb.push('")');
+                break;
+            default:
+                this.sb.push(integerLiteral);
+        }
+    }
+    visitFloatLiteral(ctx) {
+        if (ctx.infLiteral() != null) {
+            this.visit(ctx.infLiteral());
+            return;
+        }
+        if (ctx.nanLiteral() != null) {
+            this.visit(ctx.nanLiteral());
+            return;
+        }
+        const floatLiteral = ctx.getText().toLowerCase();
+        const lastChar = floatLiteral[floatLiteral.length - 1];
+        if (!/[a-z]/.test(lastChar)) {
+            this.sb.push(floatLiteral);
+            return;
+        }
+        const num = floatLiteral.slice(0, -1);
+        switch (lastChar) {
+            case 'f':
+            case 'd':
+                this.sb.push(floatLiteral); // keep f/d suffix
+                break;
+            case 'm':
+                this.sb.push('new BigDecimal("');
+                this.sb.push(num);
+                this.sb.push('")');
+                break;
+            default:
+                this.sb.push(floatLiteral);
+        }
+    }
+    visitUuidLiteral(ctx) {
+        if (ctx.stringLiteral() == null) {
+            this.sb.push('UUID.randomUUID()');
+            return;
+        }
+        this.sb.push('UUID.fromString(');
+        this.sb.push(ctx.stringLiteral().getText());
+        this.sb.push(')');
+    }
+    visitCharacterLiteral(ctx) {
+        const text = ctx.getText();
+        const withoutSuffix = text.substring(0, text.length - 1);
+        const inner = TranslateVisitor.removeFirstAndLastCharacters(withoutSuffix);
+        this.sb.push("'");
+        this.sb.push(inner);
+        this.sb.push("'");
+    }
+    visitDurationLiteral(ctx) {
+        const seconds = parseInt(ctx.integerLiteral(0).getText(), 10);
+        const nanos = parseInt(ctx.integerLiteral(1).getText(), 10);
+        const isPositive = ctx.booleanLiteral() === null ||
+            ctx.booleanLiteral().getText() === 'true';
+        this.sb.push(`Duration.ofSeconds(${seconds}, ${nanos})`);
+        if (!isPositive) {
+            this.sb.push('.negated()');
+        }
+    }
+    visitBinaryLiteral(ctx) {
+        this.sb.push('ByteBuffer.wrap(Base64.getDecoder().decode(');
+        this.sb.push(ctx.stringLiteral().getText());
+        this.sb.push('))');
+    }
+    visitGenericRangeLiteral(_ctx) {
+        throw new TranslatorException('Java does not support range literals');
+    }
+    visitGenericSetLiteral(ctx) {
+        this.sb.push('new HashSet<Object>() {{ ');
+        const literals = ctx.genericLiteral();
+        for (let i = 0; i < literals.length; i++) {
+            this.sb.push('add(');
+            this.visit(literals[i]);
+            this.sb.push(');');
+            if (i < literals.length - 1)
+                this.sb.push(' ');
+        }
+        this.sb.push(' }}');
+    }
+    visitGenericCollectionLiteral(ctx) {
+        this.sb.push('new ArrayList<Object>() {{ ');
+        const literals = ctx.genericLiteral();
+        for (let i = 0; i < literals.length; i++) {
+            this.sb.push('add(');
+            this.visit(literals[i]);
+            this.sb.push(');');
+            if (i < literals.length - 1)
+                this.sb.push(' ');
+        }
+        this.sb.push(' }}');
+    }
+}
+// ─── Helpers ─────────────────────────────────────────────────────────────────
+/**
+ * Formats a datetime string the same way Java's OffsetDateTime.toString() does:
+ * - Truncates seconds if both seconds and milliseconds are 0
+ * - Uses 'Z' for UTC offset
+ */
+function formatDatetimeJavaStyle(s) {
+    const d = new Date(s);
+    if (isNaN(d.getTime())) {
+        throw new TranslatorException(`Invalid datetime: ${s}`);
+    }
+    const year = d.getUTCFullYear().toString().padStart(4, '0');
+    const month = (d.getUTCMonth() + 1).toString().padStart(2, '0');
+    const day = d.getUTCDate().toString().padStart(2, '0');
+    const hours = d.getUTCHours().toString().padStart(2, '0');
+    const minutes = d.getUTCMinutes().toString().padStart(2, '0');
+    const seconds = d.getUTCSeconds();
+    const millis = d.getUTCMilliseconds();
+    let result = `${year}-${month}-${day}T${hours}:${minutes}`;
+    if (seconds !== 0 || millis !== 0) {
+        result += ':' + seconds.toString().padStart(2, '0');
+        if (millis !== 0) {
+            result += '.' + millis.toString().padStart(3, '0').replace(/0+$/, '');
+        }
+    }
+    result += 'Z';
+    return result;
+}

package/build/esm/language/translator/JavascriptTranslateVisitor.d.ts

@@ -0,0 +1,28 @@
+import TranslateVisitor from './TranslateVisitor.js';
+/**
+ * Converts a Gremlin traversal string into a JavaScript source code representation.
+ * Assumes use of https://www.npmjs.com/package/uuid library for UUID handling.
+ */
+export default class JavascriptTranslateVisitor extends TranslateVisitor {
+    constructor(graphTraversalSourceName?: string);
+    protected processGremlinSymbol(step: string): string;
+    protected getCardinalityFunctionClass(): string;
+    visitTraversalStrategy(ctx: any): void;
+    visitConfiguration(ctx: any): void;
+    visitTraversalGType(ctx: any): void;
+    visitGenericMapLiteral(ctx: any): void;
+    visitMapEntry(ctx: any): void;
+    visitMapKey(ctx: any): void;
+    visitDateLiteral(ctx: any): void;
+    visitNanLiteral(_ctx: any): void;
+    visitInfLiteral(ctx: any): void;
+    visitIntegerLiteral(ctx: any): void;
+    visitFloatLiteral(ctx: any): void;
+    visitGenericRangeLiteral(_ctx: any): void;
+    visitGenericSetLiteral(ctx: any): void;
+    visitGenericCollectionLiteral(ctx: any): void;
+    visitUuidLiteral(ctx: any): void;
+    visitCharacterLiteral(_ctx: any): void;
+    visitDurationLiteral(_ctx: any): void;
+    visitBinaryLiteral(ctx: any): void;
+}