gremlin 3.8.0 → 4.0.0-beta.2

package/lib/process/traversal.js

@@ -1,541 +0,0 @@
-/*
- *  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.
- */
-
-/**
- * @author Jorge Bay Gondra
- */
-
-'use strict';
-
-const itemDone = Object.freeze({ value: null, done: true });
-const asyncIteratorSymbol = Symbol.asyncIterator || Symbol('@@asyncIterator');
-
-class Traversal {
-  constructor(graph, traversalStrategies, bytecode) {
-    this.graph = graph;
-    this.traversalStrategies = traversalStrategies;
-    this.bytecode = bytecode;
-    /** @type {Array<Traverser>} */
-    this.traversers = null;
-    this.sideEffects = null;
-    this._traversalStrategiesPromise = null;
-    this._traversersIteratorIndex = 0;
-  }
-
-  /**
-   * Async iterable method implementation.
-   */
-  [asyncIteratorSymbol]() {
-    return this;
-  }
-
-  /** @returns {Bytecode} */
-  getBytecode() {
-    return this.bytecode;
-  }
-
-  /**
-   * Returns an Array containing the traverser objects.
-   * @returns {Promise.<Array>}
-   */
-  toList() {
-    return this._applyStrategies().then(() => {
-      const result = [];
-      let it;
-      while ((it = this._getNext()) && !it.done) {
-        result.push(it.value);
-      }
-      return result;
-    });
-  }
-
-  /**
-   * Determines if there are any more items to iterate from the traversal.
-   * @returns {Promise.<boolean>}
-   */
-  hasNext() {
-    return this._applyStrategies().then(
-      () =>
-        this.traversers &&
-        this.traversers.length > 0 &&
-        this._traversersIteratorIndex < this.traversers.length &&
-        this.traversers[this._traversersIteratorIndex].bulk > 0,
-    );
-  }
-
-  /**
-   * Iterates all Traverser instances in the traversal.
-   * @returns {Promise}
-   */
-  iterate() {
-    this.bytecode.addStep('discard');
-    return this._applyStrategies().then(() => {
-      let it;
-      while ((it = this._getNext()) && !it.done) {
-        //
-      }
-    });
-  }
-
-  /**
-   * Async iterator method implementation.
-   * Returns a promise containing an iterator item.
-   * @returns {Promise.<{value, done}>}
-   */
-  next() {
-    return this._applyStrategies().then(() => this._getNext());
-  }
-
-  /**
-   * Synchronous iterator of traversers including
-   * @private
-   */
-  _getNext() {
-    while (this.traversers && this._traversersIteratorIndex < this.traversers.length) {
-      const traverser = this.traversers[this._traversersIteratorIndex];
-      if (traverser.bulk > 0) {
-        traverser.bulk--;
-        return { value: traverser.object, done: false };
-      }
-      this._traversersIteratorIndex++;
-    }
-    return itemDone;
-  }
-
-  _applyStrategies() {
-    if (this._traversalStrategiesPromise) {
-      // Apply strategies only once
-      return this._traversalStrategiesPromise;
-    }
-    return (this._traversalStrategiesPromise = this.traversalStrategies.applyStrategies(this));
-  }
-
-  /**
-   * Returns step instructions during JSON serialization
-   * @returns {Array}
-   */
-  toJSON() {
-    return this.bytecode.stepInstructions;
-  }
-
-  /**
-   * Returns the Bytecode JSON representation of the traversal
-   * @returns {String}
-   */
-  toString() {
-    return this.bytecode.toString();
-  }
-}
-
-class IO {
-  static get graphml() {
-    return 'graphml';
-  }
-
-  static get graphson() {
-    return 'graphson';
-  }
-
-  static get gryo() {
-    return 'gryo';
-  }
-
-  static get reader() {
-    return '~tinkerpop.io.reader';
-  }
-
-  static get registry() {
-    return '~tinkerpop.io.registry';
-  }
-
-  static get writer() {
-    return '~tinkerpop.io.writer';
-  }
-}
-
-// eslint-disable-next-line no-unused-vars
-class ConnectedComponent {
-  static get component() {
-    return 'gremlin.connectedComponentVertexProgram.component';
-  }
-
-  static get edges() {
-    return '~tinkerpop.connectedComponent.edges';
-  }
-
-  static get propertyName() {
-    return '~tinkerpop.connectedComponent.propertyName';
-  }
-}
-
-// eslint-disable-next-line no-unused-vars
-class ShortestPath {
-  static get distance() {
-    return '~tinkerpop.shortestPath.distance';
-  }
-
-  static get edges() {
-    return '~tinkerpop.shortestPath.edges';
-  }
-
-  static get includeEdges() {
-    return '~tinkerpop.shortestPath.includeEdges';
-  }
-
-  static get maxDistance() {
-    return '~tinkerpop.shortestPath.maxDistance';
-  }
-
-  static get target() {
-    return '~tinkerpop.shortestPath.target';
-  }
-}
-
-// eslint-disable-next-line no-unused-vars
-class PageRank {
-  static get edges() {
-    return '~tinkerpop.pageRank.edges';
-  }
-
-  static get propertyName() {
-    return '~tinkerpop.pageRank.propertyName';
-  }
-
-  static get times() {
-    return '~tinkerpop.pageRank.times';
-  }
-}
-
-// eslint-disable-next-line no-unused-vars
-class PeerPressure {
-  static get edges() {
-    return '~tinkerpop.peerPressure.edges';
-  }
-
-  static get propertyName() {
-    return '~tinkerpop.peerPressure.propertyName';
-  }
-
-  static get times() {
-    return '~tinkerpop.peerPressure.times';
-  }
-}
-
-class P {
-  /**
-   * Represents an operation.
-   * @constructor
-   */
-  constructor(operator, value, other) {
-    this.operator = operator;
-    this.value = value;
-    this.other = other;
-  }
-
-  /**
-   * Returns the string representation of the instance.
-   * @returns {string}
-   */
-  toString() {
-    function formatValue(value) {
-      if (Array.isArray(value)) {
-        const acc = [];
-        for (const item of value) {
-          acc.push(formatValue(item));
-        }
-        return acc;
-      }
-      if (value && typeof value === 'string') {
-        return `'${value}'`;
-      }
-      return value;
-    }
-
-    if (this.other === undefined || this.other === null) {
-      return this.operator + '(' + formatValue(this.value) + ')';
-    }
-    return this.operator + '(' + formatValue(this.value) + ', ' + formatValue(this.other) + ')';
-  }
-
-  and(arg) {
-    return new P('and', this, arg);
-  }
-
-  or(arg) {
-    return new P('or', this, arg);
-  }
-
-  static within(...args) {
-    if (args.length === 1 && Array.isArray(args[0])) {
-      return new P('within', args[0], null);
-    }
-    return new P('within', args, null);
-  }
-
-  static without(...args) {
-    if (args.length === 1 && Array.isArray(args[0])) {
-      return new P('without', args[0], null);
-    }
-    return new P('without', args, null);
-  }
-
-  /** @param {...Object} args */
-  static between(...args) {
-    return createP('between', args);
-  }
-
-  /** @param {...Object} args */
-  static eq(...args) {
-    return createP('eq', args);
-  }
-
-  /** @param {...Object} args */
-  static gt(...args) {
-    return createP('gt', args);
-  }
-
-  /** @param {...Object} args */
-  static gte(...args) {
-    return createP('gte', args);
-  }
-
-  /** @param {...Object} args */
-  static inside(...args) {
-    return createP('inside', args);
-  }
-
-  /** @param {...Object} args */
-  static lt(...args) {
-    return createP('lt', args);
-  }
-
-  /** @param {...Object} args */
-  static lte(...args) {
-    return createP('lte', args);
-  }
-
-  /** @param {...Object} args */
-  static neq(...args) {
-    return createP('neq', args);
-  }
-
-  /** @param {...Object} args */
-  static not(...args) {
-    return createP('not', args);
-  }
-
-  /** @param {...Object} args */
-  static outside(...args) {
-    return createP('outside', args);
-  }
-
-  /** @param {...Object} args */
-  static typeOf(...args) {
-    return createP('typeOf', args);
-  }
-
-  /** @param {...Object} args */
-  static test(...args) {
-    return createP('test', args);
-  }
-}
-
-function createP(operator, args) {
-  args.unshift(null, operator);
-  return new (Function.prototype.bind.apply(P, args))();
-}
-
-class TextP {
-  /**
-   * Represents an operation.
-   * @constructor
-   */
-  constructor(operator, value, other) {
-    this.operator = operator;
-    this.value = value;
-    this.other = other;
-  }
-
-  /**
-   * Returns the string representation of the instance.
-   * @returns {string}
-   */
-  toString() {
-    function formatValue(value) {
-      if (value && typeof value === 'string') {
-        return `'${value}'`;
-      }
-      return value;
-    }
-
-    if (this.other === undefined) {
-      return this.operator + '(' + formatValue(this.value) + ')';
-    }
-    return this.operator + '(' + formatValue(this.value) + ', ' + formatValue(this.other) + ')';
-  }
-
-  and(arg) {
-    return new P('and', this, arg);
-  }
-
-  or(arg) {
-    return new P('or', this, arg);
-  }
-
-  /** @param {...Object} args */
-  static containing(...args) {
-    return createTextP('containing', args);
-  }
-
-  /** @param {...Object} args */
-  static endingWith(...args) {
-    return createTextP('endingWith', args);
-  }
-
-  /** @param {...Object} args */
-  static notContaining(...args) {
-    return createTextP('notContaining', args);
-  }
-
-  /** @param {...Object} args */
-  static notEndingWith(...args) {
-    return createTextP('notEndingWith', args);
-  }
-
-  /** @param {...Object} args */
-  static notStartingWith(...args) {
-    return createTextP('notStartingWith', args);
-  }
-
-  /** @param {...Object} args */
-  static startingWith(...args) {
-    return createTextP('startingWith', args);
-  }
-
-  /** @param {...Object} args */
-  static regex(...args) {
-    return createTextP('regex', args);
-  }
-
-  /** @param {...Object} args */
-  static notRegex(...args) {
-    return createTextP('notRegex', args);
-  }
-}
-
-function createTextP(operator, args) {
-  args.unshift(null, operator);
-  return new (Function.prototype.bind.apply(TextP, args))();
-}
-
-class Traverser {
-  constructor(object, bulk) {
-    this.object = object;
-    this.bulk = bulk || 1;
-  }
-}
-
-class TraversalSideEffects {}
-
-const withOptions = {
-  tokens: '~tinkerpop.valueMap.tokens',
-  none: 0,
-  ids: 1,
-  labels: 2,
-  keys: 4,
-  values: 8,
-  all: 15,
-  indexer: '~tinkerpop.index.indexer',
-  list: 0,
-  map: 1,
-};
-
-function toEnum(typeName, keys) {
-  const result = {};
-  keys.split(' ').forEach((k) => {
-    let jsKey = k;
-    if (jsKey === jsKey.toUpperCase()) {
-      jsKey = jsKey.toLowerCase();
-    }
-    result[jsKey] = new EnumValue(typeName, k);
-  });
-  return result;
-}
-
-const directionAlias = {
-  from_: 'out',
-  to: 'in',
-};
-
-// for direction enums, maps the same EnumValue object to the enum aliases after creating them
-function toDirectionEnum(typeName, keys) {
-  const result = toEnum(typeName, keys);
-  Object.keys(directionAlias).forEach((k) => {
-    result[k] = result[directionAlias[k]];
-  });
-  return result;
-}
-
-function toGTypeEnum(typeName, keys) {
-  const result = {};
-  keys.split(' ').forEach((k) => {
-    result[k] = new EnumValue(typeName, k.toUpperCase());
-  });
-  return result;
-}
-
-class EnumValue {
-  constructor(typeName, elementName) {
-    this.typeName = typeName;
-    this.elementName = elementName;
-  }
-
-  toString() {
-    return this.elementName;
-  }
-}
-
-module.exports = {
-  EnumValue,
-  P,
-  TextP,
-  withOptions,
-  IO,
-  Traversal,
-  TraversalSideEffects,
-  Traverser,
-  barrier: toEnum('Barrier', 'normSack'),
-  cardinality: toEnum('Cardinality', 'list set single'),
-  column: toEnum('Column', 'keys values'),
-  direction: toDirectionEnum('Direction', 'BOTH IN OUT from_ to'),
-  dt: toEnum('DT', 'second minute hour day'),
-  gType: toGTypeEnum(
-    'GType',
-    'bigDecimal bigInt binary boolean byte char datetime double duration edge float graph int list long map null number path property set short string tree uuid vertex vproperty',
-  ),
-  graphSONVersion: toEnum('GraphSONVersion', 'V1_0 V2_0 V3_0'),
-  gryoVersion: toEnum('GryoVersion', 'V1_0 V3_0'),
-  merge: toEnum('Merge', 'onCreate onMatch outV inV'),
-  operator: toEnum('Operator', 'addAll and assign div max min minus mult or sum sumLong'),
-  order: toEnum('Order', 'asc desc shuffle'),
-  pick: toEnum('Pick', 'any none unproductive'),
-  pop: toEnum('Pop', 'all first last mixed'),
-  scope: toEnum('Scope', 'global local'),
-  t: toEnum('T', 'id key label value'),
-};

package/lib/structure/graph.js

@@ -1,182 +0,0 @@
-/*
- *  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.
- */
-
-/**
- * @author Jorge Bay Gondra
- */
-'use strict';
-
-const gt = require('../process/graph-traversal');
-const { TraversalStrategies } = require('../process/traversal-strategy');
-
-/**
- * An "empty" graph object to server only as a reference.
- */
-class Graph {
-  /**
-   * Returns the graph traversal source.
-   * @param {Function} [traversalSourceClass] The constructor to use for the {@code GraphTraversalSource} instance.
-   * @returns {GraphTraversalSource}
-   * @deprecated As of release 3.3.5, replaced by the traversal() anonymous function.
-   */
-  traversal(traversalSourceClass) {
-    const traversalSourceConstructor = traversalSourceClass || gt.GraphTraversalSource;
-    return new traversalSourceConstructor(this, new TraversalStrategies());
-  }
-
-  toString() {
-    return 'graph[]';
-  }
-}
-
-class Element {
-  // properties are stored as list of property objects
-  constructor(id, label, properties = []) {
-    this.id = id;
-    this.label = label;
-    this.properties = properties != null ? properties : [];
-  }
-
-  /**
-   * Compares this instance to another and determines if they can be considered as equal.
-   * @param {Element} other
-   * @returns {boolean}
-   */
-  equals(other) {
-    return other instanceof Element && this.id === other.id;
-  }
-}
-
-class Vertex extends Element {
-  constructor(id, label, properties = []) {
-    super(id, label, properties);
-  }
-
-  toString() {
-    return `v[${this.id}]`;
-  }
-}
-
-class Edge extends Element {
-  constructor(id, outV, label, inV, properties = []) {
-    super(id, label, properties);
-    this.outV = outV;
-    this.inV = inV;
-  }
-
-  toString() {
-    const outVId = this.outV ? this.outV.id : '?';
-    const inVId = this.inV ? this.inV.id : '?';
-
-    return `e[${this.id}][${outVId}-${this.label}->${inVId}]`;
-  }
-}
-
-class VertexProperty extends Element {
-  constructor(id, label, value, properties = []) {
-    super(id, label, properties);
-    this.value = value;
-    this.key = this.label;
-  }
-
-  toString() {
-    return `vp[${this.label}->${summarize(this.value)}]`;
-  }
-}
-
-class Property {
-  constructor(key, value) {
-    this.key = key;
-    this.value = value;
-  }
-
-  toString() {
-    return `p[${this.key}->${summarize(this.value)}]`;
-  }
-
-  equals(other) {
-    return other instanceof Property && this.key === other.key && this.value === other.value;
-  }
-}
-
-class Path {
-  /**
-   * Represents a walk through a graph as defined by a traversal.
-   * @param {Array} labels
-   * @param {Array} objects
-   * @constructor
-   */
-  constructor(labels, objects) {
-    this.labels = labels;
-    this.objects = objects;
-  }
-
-  toString() {
-    return `path[${(this.objects || []).join(', ')}]`;
-  }
-
-  equals(other) {
-    if (!(other instanceof Path)) {
-      return false;
-    }
-    if (other === this) {
-      return true;
-    }
-    return areEqual(this.objects, other.objects) && areEqual(this.labels, other.labels);
-  }
-}
-
-function areEqual(obj1, obj2) {
-  if (obj1 === obj2) {
-    return true;
-  }
-  if (typeof obj1.equals === 'function') {
-    return obj1.equals(obj2);
-  }
-  if (Array.isArray(obj1) && Array.isArray(obj2)) {
-    if (obj1.length !== obj2.length) {
-      return false;
-    }
-    for (let i = 0; i < obj1.length; i++) {
-      if (!areEqual(obj1[i], obj2[i])) {
-        return false;
-      }
-    }
-    return true;
-  }
-  return false;
-}
-
-function summarize(value) {
-  if (value === null || value === undefined) {
-    return value;
-  }
-
-  const strValue = value.toString();
-  return strValue.length > 20 ? strValue.substr(0, 20) : strValue;
-}
-
-module.exports = {
-  Edge,
-  Graph,
-  Path,
-  Property,
-  Vertex,
-  VertexProperty,
-};