ts-graphviz 1.1.0 → 1.2.0

package/test/class-base.test.ts

@@ -1,4 +1,4 @@
-import { Digraph, Edge, Node, Subgraph, attribute as _ } from 'ts-graphviz';
+import { Digraph, Edge, Node, Subgraph, attribute as _, EdgeTargetTuple, withContext } from 'ts-graphviz';
 import { toDot } from '#test/utils';
 
 test('class base', () => {
@@ -21,3 +21,111 @@ test('class base', () => {
   const dot = toDot(G);
   expect(dot).toMatchSnapshot();
 });
+
+describe('Custom Class', () => {
+  class MyCustomDigraph extends Digraph {
+    constructor() {
+      super('G', {
+        [_.label]: 'This is Custom Digraph',
+      });
+    }
+  }
+  class MyCustomNode extends Node {
+    constructor(id: string) {
+      super(`node_${id}`, {
+        [_.label]: `This is Custom Node ${id}`,
+      });
+    }
+  }
+
+  class MyCustomEdge extends Edge {
+    constructor(targets: EdgeTargetTuple) {
+      super(targets, {
+        [_.label]: 'This is Custom Edge',
+      });
+    }
+  }
+
+  test('OOP', () => {
+    const digraph = new MyCustomDigraph();
+    const node1 = new MyCustomNode('A');
+    const node2 = new MyCustomNode('B');
+    const edge = new MyCustomEdge([node1, node2]);
+    digraph.addNode(node1);
+    digraph.addNode(node2);
+    digraph.addEdge(edge);
+    const dot = toDot(digraph);
+    expect(dot).toMatchInlineSnapshot(`
+      digraph "G" {
+        label = "This is Custom Digraph";
+        "node_A" [
+          label = "This is Custom Node A";
+        ];
+        "node_B" [
+          label = "This is Custom Node B";
+        ];
+        "node_A" -> "node_B" [
+          label = "This is Custom Edge";
+        ];
+      }
+    `);
+  });
+
+  describe('Models Context API', () => {
+    test('with method', () => {
+      const g = new Digraph();
+      g.with({
+        Node: MyCustomNode,
+        Edge: MyCustomEdge,
+      });
+      const a = g.createNode('A');
+      const b = g.createNode('B');
+      expect(a).toBeInstanceOf(MyCustomNode);
+      expect(g.createEdge([a, b])).toBeInstanceOf(MyCustomEdge);
+      const dot = toDot(g);
+      expect(dot).toMatchInlineSnapshot(`
+        digraph {
+          "node_A" [
+            label = "This is Custom Node A";
+          ];
+          "node_B" [
+            label = "This is Custom Node B";
+          ];
+          "node_A" -> "node_B" [
+            label = "This is Custom Edge";
+          ];
+        }
+      `);
+    });
+
+    test('createContext', () => {
+      const { digraph } = withContext({
+        Digraph: MyCustomDigraph,
+        Node: MyCustomNode,
+        Edge: MyCustomEdge,
+      });
+
+      const G = digraph((g) => {
+        const a = g.node('A'); // MyCustomNode
+        const b = g.node('B'); // MyCustomNode
+        g.edge([a, b]); // MyCustomEdge
+      });
+
+      const dot = toDot(G);
+      expect(dot).toMatchInlineSnapshot(`
+        digraph "G" {
+          label = "This is Custom Digraph";
+          "node_A" [
+            label = "This is Custom Node A";
+          ];
+          "node_B" [
+            label = "This is Custom Node B";
+          ];
+          "node_A" -> "node_B" [
+            label = "This is Custom Edge";
+          ];
+        }
+      `);
+    });
+  });
+});

package/test/from-dot.test.ts

@@ -0,0 +1,58 @@
+import { Digraph, Edge, Node, RootGraph, Subgraph, fromDot } from 'ts-graphviz';
+import { toDot } from '#test/utils';
+
+describe('fromDot function', () => {
+  test('RootGraph', () => {
+    const G = fromDot('digraph {}');
+    expect(G).toBeInstanceOf(RootGraph);
+    expect(G).toBeInstanceOf(Digraph);
+    expect(G.strict).toStrictEqual(false);
+  });
+
+  test('Node', () => {
+    const node = fromDot('a[ label = hoge]', { parse: { startRule: 'Node' } });
+    expect(node).toBeInstanceOf(Node);
+    expect(node.id).toStrictEqual('a');
+    expect(node.attributes.get('label')).toStrictEqual('hoge');
+  });
+
+  test('Edge', () => {
+    const edge = fromDot('a -> b [ label = hoge]', { parse: { startRule: 'Edge' } });
+    expect(edge).toBeInstanceOf(Edge);
+    expect(edge.targets).toMatchObject([{ id: 'a' }, { id: 'b' }]);
+    expect(edge.attributes.get('label')).toStrictEqual('hoge');
+  });
+
+  test('Subgraph', () => {
+    const subgraph = fromDot(
+      `subgraph sub {
+        label = hoge;
+      }`,
+      { parse: { startRule: 'Subgraph' } },
+    );
+    expect(subgraph).toBeInstanceOf(Subgraph);
+    expect(subgraph.id).toStrictEqual('sub');
+    expect(subgraph.get('label')).toStrictEqual('hoge');
+  });
+});
+
+test('partially described by DOT', () => {
+  const G = fromDot(
+    `digraph {
+      node_A [
+        label = "This is a Label of Node A";
+      ];
+    }`,
+  );
+
+  G.edge(['node_A', 'node_B']);
+
+  expect(toDot(G)).toMatchInlineSnapshot(`
+    digraph {
+      "node_A" [
+        label = "This is a Label of Node A";
+      ];
+      "node_A" -> "node_B";
+    }
+  `);
+});