tiny.smg.command.about.render

1const std = @import("std");23const smg = @import("../../root.zig");4const exports = smg.exports;5const graph_mod = smg.graph;6const model = smg.model;7const node_cli = smg.command.node;8const query = smg.query;9const view = smg.view;1011pub fn incoming(allocator: std.mem.Allocator, edges: []const model.Edge, coupling_only: bool) ![]const model.Edge {12    var out: std.ArrayList(model.Edge) = .empty;13    for (edges) |edge| {14        if (coupling_only and !exports.isCoupling(edge.rel)) continue;15        try out.append(allocator, edge);16    }17    std.mem.sort(model.Edge, out.items, {}, incomingLess);18    return try out.toOwnedSlice(allocator);19}2021pub fn outgoing(allocator: std.mem.Allocator, edges: []const model.Edge, coupling_only: bool) ![]const model.Edge {22    var out: std.ArrayList(model.Edge) = .empty;23    for (edges) |edge| {24        if (coupling_only and !exports.isCoupling(edge.rel)) continue;25        try out.append(allocator, edge);26    }27    std.mem.sort(model.Edge, out.items, {}, outgoingLess);28    return try out.toOwnedSlice(allocator);29}3031fn incomingLess(_: void, a: model.Edge, b: model.Edge) bool {32    const rel_order = std.mem.order(u8, a.rel, b.rel);33    if (rel_order != .eq) return rel_order == .lt;34    return std.mem.lessThan(u8, a.source, b.source);35}3637fn outgoingLess(_: void, a: model.Edge, b: model.Edge) bool {38    const rel_order = std.mem.order(u8, a.rel, b.rel);39    if (rel_order != .eq) return rel_order == .lt;40    return std.mem.lessThan(u8, a.target, b.target);41}4243pub fn neighbors(allocator: std.mem.Allocator, graph: graph_mod.Graph, name: []const u8, coupling_only: bool) ![]const []const u8 {44    const sub = try query.subgraph(allocator, graph, name, 2, coupling_only);45    var out: std.ArrayList([]const u8) = .empty;46    for (sub.nodes.items) |item| {47        if (!std.mem.eql(u8, item.name, name)) try out.append(allocator, item.name);48    }49    std.mem.sort([]const u8, out.items, {}, stringLess);50    return try out.toOwnedSlice(allocator);51}5253fn stringLess(_: void, a: []const u8, b: []const u8) bool {54    return std.mem.lessThan(u8, a, b);55}5657pub fn writeText(allocator: std.mem.Allocator, writer: *std.Io.Writer, graph: graph_mod.Graph, node: model.Node, depth: usize, full: bool, coupling_only: bool, incoming_all: usize, outgoing_all: usize, filtered_incoming: []const model.Edge, filtered_outgoing: []const model.Edge, path: []const []const u8, neighborhood: []const []const u8) !void {58    try writer.print("{s}  [{s}]\n", .{ node.name, node.type });59    const loc = try node_cli.location(allocator, node);60    if (loc.len != 0) try writer.print("file:  {s}\n", .{loc});61    if (node.docstring) |doc| try writer.print("doc:   {s}\n", .{firstLine(doc)});62    try node_cli.writeMetadata(allocator, writer, node.metadata);63    if (depth >= 1) {64        if (path.len > 1) {65            try writer.writeAll("\nPath: ");66            for (path, 0..) |item, index| {67                if (index != 0) try writer.writeAll(" > ");68                try writer.writeAll(item);69            }70            try writer.writeByte('\n');71        }72        const edge_cap = if (full) @as(usize, 0) else @as(usize, 10);73        if (filtered_incoming.len != 0) {74            try writer.print("\nIncoming ({d})\n", .{filtered_incoming.len});75            for (filtered_incoming, 0..) |edge, index| {76                if (edge_cap != 0 and index >= edge_cap) {77                    try writer.print("  ... and {d} more (use --full)\n", .{filtered_incoming.len - edge_cap});78                    break;79                }80                try writer.print("  {s} --{s}-->\n", .{ edge.source, edge.rel });81            }82        }83        if (filtered_outgoing.len != 0) {84            try writer.print("\nOutgoing ({d})\n", .{filtered_outgoing.len});85            for (filtered_outgoing, 0..) |edge, index| {86                if (edge_cap != 0 and index >= edge_cap) {87                    try writer.print("  ... and {d} more (use --full)\n", .{filtered_outgoing.len - edge_cap});88                    break;89                }90                try writer.print("  --{s}--> {s}\n", .{ edge.rel, edge.target });91            }92        }93        if (coupling_only) {94            const hidden_total = incoming_all - filtered_incoming.len + outgoing_all - filtered_outgoing.len;95            if (hidden_total != 0) try writer.print("\n{d} hidden non-coupling edge(s); rerun with --all-rels to include them\n", .{hidden_total});96        }97    }98    if (depth >= 2 and neighborhood.len != 0) {99        const neighbor_cap = if (full) @as(usize, 0) else @as(usize, 10);100        try writer.print("\nNeighborhood ({d} nodes within 2 hops)\n", .{neighborhood.len});101        for (neighborhood, 0..) |neighbor, index| {102            if (neighbor_cap != 0 and index >= neighbor_cap) {103                try writer.print("  ... and {d} more (use --full)\n", .{neighborhood.len - neighbor_cap});104                break;105            }106            const neighbor_node = graph_mod.getNode(&graph, neighbor);107            const neighbor_type = if (neighbor_node) |item| item.type else "?";108            try writer.print("  [{s}] {s}\n", .{ neighbor_type, neighbor });109        }110    }111}112113fn firstLine(value: []const u8) []const u8 {114    return value[0..(std.mem.indexOfScalar(u8, value, '\n') orelse value.len)];115}116117test "about text renders coupling context and hidden edge count" {118    var arena = std.heap.ArenaAllocator.init(std.testing.allocator);119    defer arena.deinit();120    const allocator = arena.allocator();121    var graph = graph_mod.init(allocator);122    try graph_mod.addNode(&graph, .{ .name = "app", .type = model.NodeType.module, .file = "src/app.py" });123    try graph_mod.addNode(&graph, .{ .name = "app.main", .type = model.NodeType.function, .file = "src/app.py", .line = 1, .docstring = "main doc\nmore" });124    try graph_mod.addNode(&graph, .{ .name = "app.helper", .type = model.NodeType.function, .file = "src/app.py", .line = 5 });125    try graph_mod.addEdge(&graph, .{ .source = "app", .rel = model.RelType.contains, .target = "app.main" });126    try graph_mod.addEdge(&graph, .{ .source = "app.main", .rel = model.RelType.calls, .target = "app.helper" });127    const node = graph_mod.getNode(&graph, "app.main").?;128    const incoming_all = try view.incoming(graph, allocator, "app.main", null);129    const outgoing_all = try view.outgoing(graph, allocator, "app.main", null);130    const filtered_incoming = try incoming(allocator, incoming_all, true);131    const filtered_outgoing = try outgoing(allocator, outgoing_all, true);132    const path = try query.containmentPath(allocator, graph, "app.main");133    var out: std.Io.Writer.Allocating = .init(allocator);134    try writeText(allocator, &out.writer, graph, node, 1, false, true, incoming_all.len, outgoing_all.len, filtered_incoming, filtered_outgoing, path, &.{});135    try std.testing.expectEqualStrings(136        \\app.main  [function]137        \\file:  src/app.py:1138        \\doc:   main doc139        \\140        \\Path: app > app.main141        \\142        \\Outgoing (1)143        \\  --calls--> app.helper144        \\145        \\1 hidden non-coupling edge(s); rerun with --all-rels to include them146        \\147    , out.written());148}

1pub const render = @import("render.zig");