diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/MopsCommand.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/MopsCommand.kt index 9f7f66c7..9f9a01e0 100644 --- a/cli/src/main/kotlin/com/specificlanguages/mops/cli/MopsCommand.kt +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/MopsCommand.kt @@ -114,7 +114,7 @@ class MopsCommand( } } - override var nodeReferenceFormat: NodeReferenceFormat = NodeReferenceFormat.SERIALIZED + override var nodeReferenceFormat: NodeReferenceFormat = NodeReferenceFormat.default() @Option( names = ["--refs-as-urls"], @@ -122,7 +122,7 @@ class MopsCommand( description = ["Render node references as MPS URLs in text output; JSON output is unchanged."], ) fun setRefsAsUrls(enabled: Boolean) { - nodeReferenceFormat = if (enabled) NodeReferenceFormat.URL else NodeReferenceFormat.SERIALIZED + nodeReferenceFormat = if (enabled) NodeReferenceFormat.URL else NodeReferenceFormat.default() } @Spec diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/check/checkResultRendering.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/check/checkResultRendering.kt index d3faf86f..a2e56a04 100644 --- a/cli/src/main/kotlin/com/specificlanguages/mops/cli/check/checkResultRendering.kt +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/check/checkResultRendering.kt @@ -4,7 +4,8 @@ import com.specificlanguages.mops.cli.output.LIMIT_LIFTING_HINT import com.specificlanguages.mops.cli.output.metadataLine import com.specificlanguages.mops.cli.output.truncationLine import com.specificlanguages.mops.cli.output.renderJson -import com.specificlanguages.mops.cli.output.renderNodeReference +import com.specificlanguages.mops.cli.output.TextColumn +import com.specificlanguages.mops.cli.output.nodeReferenceColumn import com.specificlanguages.mops.cli.output.textRow import com.specificlanguages.mops.cli.output.NodeReferenceFormat import com.specificlanguages.mops.protocol.ModelCheckFindingJson @@ -47,9 +48,13 @@ private fun summaryRecord(response: ModelCheckResponse): ModelCheckSummaryJson = ) private fun renderHuman(finding: ModelCheckFindingJson, nodeReferenceFormat: NodeReferenceFormat) { - val columns = mutableListOf(finding.severity.name.lowercase(), finding.message) + val columns = mutableListOf(TextColumn(finding.severity.name.lowercase()), TextColumn(finding.message)) finding.node?.let { - columns += listOf(it.name ?: "", it.concept, renderNodeReference(it.reference, nodeReferenceFormat)) + columns += listOf( + TextColumn(it.name ?: ""), + TextColumn(it.concept), + nodeReferenceColumn(it.reference, nodeReferenceFormat), + ) } println(textRow(columns)) } diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/find/SearchCommand.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/find/SearchCommand.kt index 9c9886d7..bb08c168 100644 --- a/cli/src/main/kotlin/com/specificlanguages/mops/cli/find/SearchCommand.kt +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/find/SearchCommand.kt @@ -73,7 +73,7 @@ abstract class SearchCommand(protected val environment: CommandEnvironment) : Cl json -> println(renderJson(results.response)) refsOnly -> { matches.forEach { - println(renderNodeReference(it.reference, environment.nodeReferenceFormat, hyperlinks = false)) + println(renderNodeReference(it.reference, environment.nodeReferenceFormat.withoutLink())) } if (results.truncated) reportTruncationOnStderr(matches.size) } diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/find/resultRendering.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/find/resultRendering.kt index b1d23f45..791160d9 100644 --- a/cli/src/main/kotlin/com/specificlanguages/mops/cli/find/resultRendering.kt +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/find/resultRendering.kt @@ -2,7 +2,8 @@ package com.specificlanguages.mops.cli.find import com.specificlanguages.mops.cli.output.displayConcept import com.specificlanguages.mops.cli.output.NodeReferenceFormat -import com.specificlanguages.mops.cli.output.renderNodeReference +import com.specificlanguages.mops.cli.output.TextColumn +import com.specificlanguages.mops.cli.output.nodeReferenceColumn import com.specificlanguages.mops.cli.output.textRow import com.specificlanguages.mops.protocol.MpsNodeParentJson import com.specificlanguages.mops.protocol.MpsNodeSummaryJson @@ -15,10 +16,10 @@ internal fun renderText( ): String = textRow( listOf( - node.type, - node.name ?: "", - displayConcept(node.concept, fullConcept), - renderNodeReference(node.reference, nodeReferenceFormat), + TextColumn(node.type), + TextColumn(node.name ?: ""), + TextColumn(displayConcept(node.concept, fullConcept)), + nodeReferenceColumn(node.reference, nodeReferenceFormat), ) + parentColumns(node.parent, fullConcept, nodeReferenceFormat), ) @@ -30,11 +31,11 @@ internal fun renderText( val owner = usage.owner return textRow( listOf( - "usage", - usage.role, - owner.name ?: "", - displayConcept(owner.concept, fullConcept), - renderNodeReference(owner.reference, nodeReferenceFormat), + TextColumn("usage"), + TextColumn(usage.role), + TextColumn(owner.name ?: ""), + TextColumn(displayConcept(owner.concept, fullConcept)), + nodeReferenceColumn(owner.reference, nodeReferenceFormat), ) + parentColumns(owner.parent, fullConcept, nodeReferenceFormat), ) } @@ -44,18 +45,18 @@ internal fun renderText( * reference. The concept is shown as a short name unless [fullConcept] is set. Empty when the node is a Root Node, so * root results keep their existing shorter rows. */ -internal fun parentColumns( +private fun parentColumns( parent: MpsNodeParentJson?, fullConcept: Boolean, - nodeReferenceFormat: NodeReferenceFormat = NodeReferenceFormat.SERIALIZED, -): List = + nodeReferenceFormat: NodeReferenceFormat, +): List = if (parent == null) { emptyList() } else { listOf( - "parent", - parent.name ?: "", - displayConcept(parent.concept, fullConcept), - renderNodeReference(parent.reference, nodeReferenceFormat), + TextColumn("parent"), + TextColumn(parent.name ?: ""), + TextColumn(displayConcept(parent.concept, fullConcept)), + nodeReferenceColumn(parent.reference, nodeReferenceFormat), ) } diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/list/ListRenderer.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/list/ListRenderer.kt index 22972587..2e605f89 100644 --- a/cli/src/main/kotlin/com/specificlanguages/mops/cli/list/ListRenderer.kt +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/list/ListRenderer.kt @@ -2,7 +2,8 @@ package com.specificlanguages.mops.cli.list import com.specificlanguages.mops.cli.output.displayConcept import com.specificlanguages.mops.cli.output.NodeReferenceFormat -import com.specificlanguages.mops.cli.output.renderNodeReference +import com.specificlanguages.mops.cli.output.TextColumn +import com.specificlanguages.mops.cli.output.nodeReferenceColumn import com.specificlanguages.mops.cli.output.truncationLine import com.specificlanguages.mops.cli.output.textRow import com.specificlanguages.mops.protocol.MpsListEntryJson @@ -43,25 +44,21 @@ internal class ListRenderer( return listOf(summary.by, key, group.count.toString()) + concepts } - private fun MpsListEntryJson.columns(): List = + private fun MpsListEntryJson.columns(): List = when (type) { - "project" -> listOf("project", name.orEmpty()) - "repository" -> listOf("repository", name.orEmpty()) - "module" -> listOf(moduleKind ?: "other", name.orEmpty(), reference.orEmpty()) - "model" -> listOf("model", name.orEmpty(), reference.orEmpty()) - "root" -> nodeColumns("root") - "node" -> listOf("node", role.orEmpty()) + nodeColumnsWithoutType() - else -> listOf(type, name.orEmpty(), reference.orEmpty()) + "project" -> plainColumns("project", name.orEmpty()) + "repository" -> plainColumns("repository", name.orEmpty()) + "module" -> plainColumns(moduleKind ?: "other", name.orEmpty(), reference.orEmpty()) + "model" -> plainColumns("model", name.orEmpty(), reference.orEmpty()) + "root" -> plainColumns("root") + nodeColumnsWithoutType() + "node" -> plainColumns("node", role.orEmpty()) + nodeColumnsWithoutType() + else -> plainColumns(type, name.orEmpty(), reference.orEmpty()) } - private fun MpsListEntryJson.nodeColumns(typeColumn: String): List = - listOf(typeColumn) + nodeColumnsWithoutType() + private fun MpsListEntryJson.nodeColumnsWithoutType(): List = + plainColumns(name ?: "", concept?.let { displayConcept(it, fullConcept) }.orEmpty()) + + (reference?.let { nodeReferenceColumn(it, nodeReferenceFormat) } ?: TextColumn("")) + + listOfNotNull(error).map { TextColumn(it) } - private fun MpsListEntryJson.nodeColumnsWithoutType(): List = - listOf( - name ?: "", - concept?.let { displayConcept(it, fullConcept) }.orEmpty(), - reference?.let { renderNodeReference(it, nodeReferenceFormat) }.orEmpty(), - ) + - listOfNotNull(error) + private fun plainColumns(vararg texts: String): List = texts.map { TextColumn(it) } } diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/NodeReferenceFormat.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/NodeReferenceFormat.kt index 2e336b23..0ccd76b5 100644 --- a/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/NodeReferenceFormat.kt +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/NodeReferenceFormat.kt @@ -1,6 +1,22 @@ package com.specificlanguages.mops.cli.output +/** How text output shows a node reference. */ enum class NodeReferenceFormat { + /** The serialized reference. */ SERIALIZED, + + /** The serialized reference, as a terminal hyperlink to the MPS node URL. */ + LINKED, + + /** The MPS node URL. */ URL, + ; + + /** This format without a terminal hyperlink: [LINKED] becomes [SERIALIZED]. */ + fun withoutLink(): NodeReferenceFormat = if (this == LINKED) SERIALIZED else this + + companion object { + /** [LINKED] when mops writes to a terminal, [SERIALIZED] otherwise. */ + fun default(): NodeReferenceFormat = if (System.console() != null) LINKED else SERIALIZED + } } diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/TextColumn.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/TextColumn.kt new file mode 100644 index 00000000..b877cf28 --- /dev/null +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/TextColumn.kt @@ -0,0 +1,17 @@ +package com.specificlanguages.mops.cli.output + +private const val ESC = '\u001B' + +/** + * One column of text output: [text], shown in a terminal as an OSC 8 hyperlink to [link] when [link] is set. + */ +internal data class TextColumn(val text: String, val link: String? = null) { + /** + * Renders [text] passed through [escape], wrapped in the hyperlink markup when [link] is set. The markup and [link] + * never go through [escape], so escaping the text cannot break the link. + */ + fun render(escape: (String) -> String = { it }): String { + val shown = escape(text) + return if (link == null) shown else "$ESC]8;;$link$ESC\\$shown$ESC]8;;$ESC\\" + } +} diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/nodeReferenceRendering.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/nodeReferenceRendering.kt index 00fc1ebb..7775c154 100644 --- a/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/nodeReferenceRendering.kt +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/nodeReferenceRendering.kt @@ -4,19 +4,18 @@ import java.net.URLEncoder import java.nio.charset.StandardCharsets private const val MPS_NODE_URL = "http://127.0.0.1:63320/node?ref=" -private const val ESC = '\u001B' -internal fun renderNodeReference( - reference: String, - format: NodeReferenceFormat = NodeReferenceFormat.SERIALIZED, - hyperlinks: Boolean = System.console() != null, -): String { - if (format == NodeReferenceFormat.SERIALIZED && !hyperlinks) return reference +/** A node [reference] as a text column in [format]. */ +internal fun nodeReferenceColumn(reference: String, format: NodeReferenceFormat): TextColumn = + when (format) { + NodeReferenceFormat.SERIALIZED -> TextColumn(reference) + NodeReferenceFormat.LINKED -> TextColumn(reference, link = nodeReferenceUrl(reference)) + NodeReferenceFormat.URL -> TextColumn(nodeReferenceUrl(reference)) + } - val url = nodeReferenceUrl(reference) - if (format == NodeReferenceFormat.URL) return url - return "$ESC]8;;$url$ESC\\$reference$ESC]8;;$ESC\\" -} +/** A node [reference] as text outside a [textRow]: [nodeReferenceColumn] rendered without escaping. */ +internal fun renderNodeReference(reference: String, format: NodeReferenceFormat): String = + nodeReferenceColumn(reference, format).render() private fun nodeReferenceUrl(reference: String): String { val encodedReference = URLEncoder.encode(reference, StandardCharsets.UTF_8).replace("+", "%20") diff --git a/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/textRows.kt b/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/textRows.kt index ff572ef6..6b12f098 100644 --- a/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/textRows.kt +++ b/cli/src/main/kotlin/com/specificlanguages/mops/cli/output/textRows.kt @@ -2,10 +2,14 @@ package com.specificlanguages.mops.cli.output /** * Renders one row of row-shaped text output: [columns] joined with tabs. A backslash, newline, carriage return or tab - * inside a column is written as the two-character escape `\\`, `\n`, `\r` or `\t`, so a column cannot end the row or - * add a column, and the original text can be recovered. + * inside a column's text is written as the two-character escape `\\`, `\n`, `\r` or `\t`, so a column cannot end the row + * or add a column, and the original text can be recovered. A column's hyperlink markup is written as is. */ -internal fun textRow(columns: List): String = columns.joinToString("\t") { escapeColumn(it) } +internal fun textRow(columns: List): String = columns.joinToString("\t") { it.render(::escapeColumn) } + +/** Renders one row of plain [columns], as [textRow] does for columns without hyperlinks. */ +@JvmName("textRowOfStrings") +internal fun textRow(columns: List): String = textRow(columns.map { TextColumn(it) }) private fun escapeColumn(value: String): String = value.replace("\\", "\\\\").replace("\n", "\\n").replace("\r", "\\r").replace("\t", "\\t") diff --git a/cli/src/test/kotlin/com/specificlanguages/mops/cli/HyperlinkedTextRowsTest.kt b/cli/src/test/kotlin/com/specificlanguages/mops/cli/HyperlinkedTextRowsTest.kt new file mode 100644 index 00000000..42569ee6 --- /dev/null +++ b/cli/src/test/kotlin/com/specificlanguages/mops/cli/HyperlinkedTextRowsTest.kt @@ -0,0 +1,102 @@ +package com.specificlanguages.mops.cli + +import com.specificlanguages.mops.cli.check.CheckOutputFormat +import com.specificlanguages.mops.cli.check.renderCheckResponse +import com.specificlanguages.mops.cli.find.renderText +import com.specificlanguages.mops.cli.list.ListRenderer +import com.specificlanguages.mops.cli.output.NodeReferenceFormat +import com.specificlanguages.mops.protocol.FindingSeverity +import com.specificlanguages.mops.protocol.MpsListEntryJson +import com.specificlanguages.mops.protocol.ModelCheckFindingJson +import com.specificlanguages.mops.protocol.ModelCheckResponse +import com.specificlanguages.mops.protocol.ModelCheckSummary +import com.specificlanguages.mops.protocol.MpsNodeParentJson +import com.specificlanguages.mops.protocol.MpsNodeSummaryJson +import java.io.ByteArrayOutputStream +import java.io.PrintStream +import kotlin.test.Test +import kotlin.test.assertEquals + +class HyperlinkedTextRowsTest { + @Test + fun `list rows keep the hyperlink markup unescaped`() { + val output = captureStdout { + ListRenderer(fullConcept = false, NodeReferenceFormat.LINKED).renderText( + MpsListEntryJson(type = "root", name = "TestClass", concept = "a.ClassConcept", reference = REFERENCE), + indent = 1, + ) + } + + assertEquals(" root\tTestClass\tClassConcept\t$LINKED_REFERENCE\n", output) + } + + @Test + fun `find rows keep the hyperlink markup unescaped for the node and its parent`() { + val node = MpsNodeSummaryJson( + type = "node", + name = "field", + concept = "a.FieldDeclaration", + reference = REFERENCE, + parent = MpsNodeParentJson(type = "root", name = "TestClass", concept = "a.ClassConcept", reference = REFERENCE), + ) + + assertEquals( + "node\tfield\tFieldDeclaration\t$LINKED_REFERENCE\tparent\tTestClass\tClassConcept\t$LINKED_REFERENCE", + renderText(node, fullConcept = false, NodeReferenceFormat.LINKED), + ) + } + + @Test + fun `check rows keep the hyperlink markup unescaped`() { + val response = ModelCheckResponse( + summary = ModelCheckSummary(rootsChecked = 1, errors = 1, warnings = 0, infos = 0, limit = 10, truncated = false), + findings = listOf( + ModelCheckFindingJson( + severity = FindingSeverity.ERROR, + message = "broken", + node = MpsNodeSummaryJson(type = "root", name = "TestClass", concept = "ClassConcept", reference = REFERENCE), + ), + ), + ) + + val output = captureStdout { + renderCheckResponse(response, CheckOutputFormat.HUMAN, NodeReferenceFormat.LINKED) + } + + assertEquals("error\tbroken\tTestClass\tClassConcept\t$LINKED_REFERENCE", output.lines().first()) + } + + @Test + fun `linked text is escaped like any column while the link target keeps the original reference`() { + val reference = "r:1(a\tb)/2" + + assertEquals( + "root\tX\tC\t\u001B]8;;http://127.0.0.1:63320/node?ref=r%3A1%28a%09b%29%2F2\u001B\\" + + "r:1(a\\tb)/2\u001B]8;;\u001B\\\n", + captureStdout { + ListRenderer(fullConcept = false, NodeReferenceFormat.LINKED).renderText( + MpsListEntryJson(type = "root", name = "X", concept = "C", reference = reference), + indent = 0, + ) + }, + ) + } + + private fun captureStdout(block: () -> Unit): String { + val buffer = ByteArrayOutputStream() + val original = System.out + System.setOut(PrintStream(buffer, true, Charsets.UTF_8)) + try { + block() + } finally { + System.setOut(original) + } + return buffer.toString(Charsets.UTF_8).replace(System.lineSeparator(), "\n") + } + + private companion object { + const val REFERENCE = "r:123(example.model)/456" + const val LINKED_REFERENCE = "\u001B]8;;http://127.0.0.1:63320/node?ref=r%3A123%28example.model%29%2F456\u001B\\" + + "$REFERENCE\u001B]8;;\u001B\\" + } +} diff --git a/cli/src/test/kotlin/com/specificlanguages/mops/cli/NodeReferenceRenderingTest.kt b/cli/src/test/kotlin/com/specificlanguages/mops/cli/NodeReferenceRenderingTest.kt index 6d6f98da..bfa27828 100644 --- a/cli/src/test/kotlin/com/specificlanguages/mops/cli/NodeReferenceRenderingTest.kt +++ b/cli/src/test/kotlin/com/specificlanguages/mops/cli/NodeReferenceRenderingTest.kt @@ -8,7 +8,7 @@ import kotlin.test.assertEquals class NodeReferenceRenderingTest { @Test fun `plain presentation preserves the serialized reference`() { - assertEquals(NODE_REFERENCE, renderNodeReference(NODE_REFERENCE, hyperlinks = false)) + assertEquals(NODE_REFERENCE, renderNodeReference(NODE_REFERENCE, NodeReferenceFormat.SERIALIZED)) } @Test @@ -17,7 +17,7 @@ class NodeReferenceRenderingTest { "\u001B]8;;http://127.0.0.1:63320/node?ref=" + "r%3A123%28example.model%29%2F456\u001B\\" + "$NODE_REFERENCE\u001B]8;;\u001B\\", - renderNodeReference(NODE_REFERENCE, hyperlinks = true), + renderNodeReference(NODE_REFERENCE, NodeReferenceFormat.LINKED), ) } @@ -25,7 +25,7 @@ class NodeReferenceRenderingTest { fun `URL presentation prints the MPS node URL`() { assertEquals( "http://127.0.0.1:63320/node?ref=r%3A123%28example.model%29%2F456", - renderNodeReference(NODE_REFERENCE, NodeReferenceFormat.URL, hyperlinks = false), + renderNodeReference(NODE_REFERENCE, NodeReferenceFormat.URL), ) } diff --git a/cli/src/test/kotlin/com/specificlanguages/mops/cli/SearchCommandTest.kt b/cli/src/test/kotlin/com/specificlanguages/mops/cli/SearchCommandTest.kt index fedf6b14..eb843c1b 100644 --- a/cli/src/test/kotlin/com/specificlanguages/mops/cli/SearchCommandTest.kt +++ b/cli/src/test/kotlin/com/specificlanguages/mops/cli/SearchCommandTest.kt @@ -179,6 +179,35 @@ class SearchCommandTest { assertEquals(testNode.reference + NL + testChildNode.reference + NL, run.stdout) } + @ParameterizedTest + @MethodSource("subcommands") + fun `prints plain node references with --refs-only when references are linked`(subcommand: SearchSubcommand) { + val client = subcommand.returning(subcommand.response(listOf(testNode))) + + val run = subcommand.run(client, "--refs-only", format = NodeReferenceFormat.LINKED) + + assertEquals(0, run.exitCode, run.stderr) + assertEquals(testNode.reference + NL, run.stdout) + } + + @ParameterizedTest + @MethodSource("subcommands") + fun `links node references in text rows when references are linked`(subcommand: SearchSubcommand) { + val client = subcommand.returning(subcommand.response(listOf(testNode))) + + val run = subcommand.run(client, format = NodeReferenceFormat.LINKED) + + assertEquals( + subcommand.row( + testNode, + "JsonObject\tConceptDeclaration\t\u001B]8;;http://127.0.0.1:63320/node?ref=" + + "r%3Afd752404-89d3-4ffe-bc3a-7fb7a27c63b6%28com.specificlanguages.json.structure%29%2F" + + "2110045694544566905\u001B\\${testNode.reference}\u001B]8;;\u001B\\", + ) + NL, + run.stdout, + ) + } + @ParameterizedTest @MethodSource("subcommands") fun `rejects --refs-only combined with --json`(subcommand: SearchSubcommand) {