@herb-tools/printer 0.6.0 → 0.7.0

package/src/erb-to-ruby-string-printer.ts

@@ -0,0 +1,309 @@
+import { IdentityPrinter } from "./identity-printer.js"
+import { PrintOptions, DEFAULT_PRINT_OPTIONS } from "./printer.js"
+import { isERBOutputNode, filterNodes, ERBContentNode, } from "@herb-tools/core"
+
+import { HTMLTextNode, ERBIfNode, ERBElseNode, ERBUnlessNode, Node, HTMLAttributeValueNode } from "@herb-tools/core"
+
+export interface ERBToRubyStringOptions extends PrintOptions {
+  /**
+   * Whether to force wrapping the output in double quotes even for single ERB nodes
+   * @default false
+   */
+  forceQuotes?: boolean
+}
+
+export const DEFAULT_ERB_TO_RUBY_STRING_OPTIONS: ERBToRubyStringOptions = {
+  ...DEFAULT_PRINT_OPTIONS,
+  forceQuotes: false
+}
+
+/**
+ * ERBToRubyStringPrinter - Converts ERB snippets to Ruby strings with interpolation
+ *
+ * This printer transforms ERB templates into Ruby strings by:
+ * - Converting literal text to string content
+ * - Converting <%= %> tags to #{} interpolation
+ * - Converting simple if/else blocks to ternary operators
+ * - Ignoring <% %> tags (they don't produce output)
+ *
+ * Examples:
+ * - `hello world <%= hello %>` => `"hello world #{hello}"`
+ * - `hello world <% hello %>` => `"hello world "`
+ * - `Welcome <%= user.name %>!` => `"Welcome #{user.name}!"`
+ * - `<% if logged_in? %>Welcome<% else %>Login<% end %>` => `"logged_in? ? "Welcome" : "Login"`
+ * - `<% if logged_in? %>Welcome<% else %>Login<% end %>!` => `"#{logged_in? ? "Welcome" : "Login"}!"`
+ */
+export class ERBToRubyStringPrinter extends IdentityPrinter {
+
+  // TODO: cleanup `.type === "AST_*" checks`
+  static print(node: Node, options: Partial<ERBToRubyStringOptions> = DEFAULT_ERB_TO_RUBY_STRING_OPTIONS): string {
+    const erbNodes = filterNodes([node], ERBContentNode)
+
+    if (erbNodes.length === 1 && isERBOutputNode(erbNodes[0]) && !options.forceQuotes) {
+      return (erbNodes[0].content?.value || "").trim()
+    }
+
+    if ('children' in node && Array.isArray(node.children)) {
+      const childErbNodes = filterNodes(node.children, ERBContentNode)
+      const hasOnlyERBContent = node.children.length > 0 && node.children.length === childErbNodes.length
+
+      if (hasOnlyERBContent && childErbNodes.length === 1 && isERBOutputNode(childErbNodes[0]) && !options.forceQuotes) {
+        return (childErbNodes[0].content?.value || "").trim()
+      }
+
+      if (node.children.length === 1 && node.children[0].type === "AST_ERB_IF_NODE" && !options.forceQuotes) {
+        const ifNode = node.children[0] as ERBIfNode
+        const printer = new ERBToRubyStringPrinter()
+
+        if (printer.canConvertToTernary(ifNode)) {
+          printer.convertToTernaryWithoutWrapper(ifNode)
+          return printer.context.getOutput()
+        }
+      }
+
+      if (node.children.length === 1 && node.children[0].type === "AST_ERB_UNLESS_NODE" && !options.forceQuotes) {
+        const unlessNode = node.children[0] as ERBUnlessNode
+        const printer = new ERBToRubyStringPrinter()
+
+        if (printer.canConvertUnlessToTernary(unlessNode)) {
+          printer.convertUnlessToTernaryWithoutWrapper(unlessNode)
+          return printer.context.getOutput()
+        }
+      }
+    }
+
+    const printer = new ERBToRubyStringPrinter()
+
+    printer.context.write('"')
+
+    printer.visit(node)
+
+    printer.context.write('"')
+
+    return printer.context.getOutput()
+  }
+
+  visitHTMLTextNode(node: HTMLTextNode) {
+    if (node.content) {
+      const escapedContent = node.content.replace(/\\/g, '\\\\').replace(/"/g, '\\"')
+      this.context.write(escapedContent)
+    }
+  }
+
+  visitERBContentNode(node: ERBContentNode) {
+    if (isERBOutputNode(node)) {
+      this.context.write("#{")
+
+      if (node.content?.value) {
+        this.context.write(node.content.value.trim())
+      }
+
+      this.context.write("}")
+    }
+  }
+
+  visitERBIfNode(node: ERBIfNode) {
+    if (this.canConvertToTernary(node)) {
+      this.convertToTernary(node)
+    }
+  }
+
+  visitERBUnlessNode(node: ERBUnlessNode) {
+    if (this.canConvertUnlessToTernary(node)) {
+      this.convertUnlessToTernary(node)
+    }
+  }
+
+  visitHTMLAttributeValueNode(node: HTMLAttributeValueNode) {
+    this.visitChildNodes(node)
+  }
+
+  private canConvertToTernary(node: ERBIfNode): boolean {
+    if (node.subsequent && node.subsequent.type !== "AST_ERB_ELSE_NODE") {
+      return false
+    }
+
+    const ifOnlyText = node.statements ? node.statements.every(statement => statement.type === "AST_HTML_TEXT_NODE") : true
+    if (!ifOnlyText) return false
+
+    if (node.subsequent && node.subsequent.type === "AST_ERB_ELSE_NODE") {
+      return (node.subsequent as ERBElseNode).statements
+        ? (node.subsequent as ERBElseNode).statements.every(statement => statement.type === "AST_HTML_TEXT_NODE")
+        : true
+    }
+
+    return true
+  }
+
+  private convertToTernary(node: ERBIfNode) {
+    this.context.write("#{")
+
+    if (node.content?.value) {
+      const condition = node.content.value.trim()
+      const cleanCondition = condition.replace(/^if\s+/, '')
+      const needsParentheses = cleanCondition.includes(' ')
+
+      if (needsParentheses) {
+        this.context.write("(")
+      }
+
+      this.context.write(cleanCondition)
+
+      if (needsParentheses) {
+        this.context.write(")")
+      }
+    }
+
+    this.context.write(" ? ")
+    this.context.write('"')
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    this.context.write('"')
+    this.context.write(" : ")
+    this.context.write('"')
+
+    if (node.subsequent && node.subsequent.type === "AST_ERB_ELSE_NODE" && (node.subsequent as ERBElseNode).statements) {
+      (node.subsequent as ERBElseNode).statements.forEach(statement => this.visit(statement))
+    }
+
+    this.context.write('"')
+    this.context.write("}")
+  }
+
+  private convertToTernaryWithoutWrapper(node: ERBIfNode) {
+    if (node.subsequent && node.subsequent.type !== "AST_ERB_ELSE_NODE") {
+      return false
+    }
+
+    if (node.content?.value) {
+      const condition = node.content.value.trim()
+      const cleanCondition = condition.replace(/^if\s+/, '')
+      const needsParentheses = cleanCondition.includes(' ')
+
+      if (needsParentheses) {
+        this.context.write("(")
+      }
+
+      this.context.write(cleanCondition)
+
+      if (needsParentheses) {
+        this.context.write(")")
+      }
+    }
+
+    this.context.write(" ? ")
+    this.context.write('"')
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    this.context.write('"')
+    this.context.write(" : ")
+    this.context.write('"')
+
+    if (node.subsequent && node.subsequent.type === "AST_ERB_ELSE_NODE" && (node.subsequent as ERBElseNode).statements) {
+      (node.subsequent as ERBElseNode).statements.forEach(statement => this.visit(statement))
+    }
+
+    this.context.write('"')
+  }
+
+  private canConvertUnlessToTernary(node: ERBUnlessNode): boolean {
+    const unlessOnlyText = node.statements ? node.statements.every(statement => statement.type === "AST_HTML_TEXT_NODE") : true
+
+    if (!unlessOnlyText) return false
+
+    if (node.else_clause && node.else_clause.type === "AST_ERB_ELSE_NODE") {
+      return node.else_clause.statements
+        ? node.else_clause.statements.every(statement => statement.type === "AST_HTML_TEXT_NODE")
+        : true
+    }
+
+    return true
+  }
+
+  private convertUnlessToTernary(node: ERBUnlessNode) {
+    this.context.write("#{")
+
+    if (node.content?.value) {
+      const condition = node.content.value.trim()
+      const cleanCondition = condition.replace(/^unless\s+/, '')
+      const needsParentheses = cleanCondition.includes(' ')
+
+      this.context.write("!(")
+
+      if (needsParentheses) {
+        this.context.write("(")
+      }
+
+      this.context.write(cleanCondition)
+
+      if (needsParentheses) {
+        this.context.write(")")
+      }
+
+      this.context.write(")")
+    }
+
+    this.context.write(" ? ")
+    this.context.write('"')
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    this.context.write('"')
+    this.context.write(" : ")
+    this.context.write('"')
+
+    if (node.else_clause && node.else_clause.type === "AST_ERB_ELSE_NODE") {
+      node.else_clause.statements.forEach(statement => this.visit(statement))
+    }
+
+    this.context.write('"')
+    this.context.write("}")
+  }
+
+  private convertUnlessToTernaryWithoutWrapper(node: ERBUnlessNode) {
+    if (node.content?.value) {
+      const condition = node.content.value.trim()
+      const cleanCondition = condition.replace(/^unless\s+/, '')
+      const needsParentheses = cleanCondition.includes(' ')
+
+      this.context.write("!(")
+
+      if (needsParentheses) {
+        this.context.write("(")
+      }
+
+      this.context.write(cleanCondition)
+
+      if (needsParentheses) {
+        this.context.write(")")
+      }
+
+      this.context.write(")")
+    }
+
+    this.context.write(" ? ")
+    this.context.write('"')
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    this.context.write('"')
+    this.context.write(" : ")
+    this.context.write('"')
+
+    if (node.else_clause && node.else_clause.type === "AST_ERB_ELSE_NODE") {
+      node.else_clause.statements.forEach(statement => this.visit(statement))
+    }
+
+    this.context.write('"')
+  }
+}

package/src/identity-printer.ts

@@ -1,4 +1,7 @@
 import { Printer } from "./printer.js"
+import { getNodesBeforePosition, getNodesAfterPosition } from "@herb-tools/core"
+
+import type * as Nodes from "@herb-tools/core"
 
 /**
  * IdentityPrinter - Provides lossless reconstruction of the original source
@@ -10,5 +13,373 @@ import { Printer } from "./printer.js"
  * - Verifying AST round-trip fidelity
  */
 export class IdentityPrinter extends Printer {
+  visitLiteralNode(node: Nodes.LiteralNode): void {
+    this.write(node.content)
+  }
+
+  visitHTMLTextNode(node: Nodes.HTMLTextNode): void {
+    this.write(node.content)
+  }
+
+  visitWhitespaceNode(node: Nodes.WhitespaceNode): void {
+    if (node.value) {
+      this.write(node.value.value)
+    }
+  }
+
+  visitHTMLOpenTagNode(node: Nodes.HTMLOpenTagNode): void {
+    if (node.tag_opening) {
+      this.write(node.tag_opening.value)
+    }
+
+    if (node.tag_name) {
+      this.write(node.tag_name.value)
+    }
+
+    this.visitChildNodes(node)
+
+    if (node.tag_closing) {
+      this.write(node.tag_closing.value)
+    }
+  }
+
+  visitHTMLCloseTagNode(node: Nodes.HTMLCloseTagNode): void {
+    if (node.tag_opening) {
+      this.write(node.tag_opening.value)
+    }
+
+    if (node.tag_name) {
+      const before = getNodesBeforePosition(node.children, node.tag_name.location.start, true)
+      const after = getNodesAfterPosition(node.children, node.tag_name.location.end)
+
+      this.visitAll(before)
+      this.write(node.tag_name.value)
+      this.visitAll(after)
+    } else {
+      this.visitAll(node.children)
+    }
+
+    if (node.tag_closing) {
+      this.write(node.tag_closing.value)
+    }
+  }
+
+  visitHTMLElementNode(node: Nodes.HTMLElementNode): void {
+    const tagName = node.tag_name?.value
+
+    if (tagName) {
+      this.context.enterTag(tagName)
+    }
+
+    if (node.open_tag) {
+      this.visit(node.open_tag)
+    }
+
+    if (node.body) {
+      node.body.forEach(child => this.visit(child))
+    }
+
+    if (node.close_tag) {
+      this.visit(node.close_tag)
+    }
+
+    if (tagName) {
+      this.context.exitTag()
+    }
+  }
+
+  visitHTMLAttributeNode(node: Nodes.HTMLAttributeNode): void {
+    if (node.name) {
+      this.visit(node.name)
+    }
+
+    if (node.equals) {
+      this.write(node.equals.value)
+    }
+
+    if (node.equals && node.value) {
+      this.visit(node.value)
+    }
+  }
+
+  visitHTMLAttributeNameNode(node: Nodes.HTMLAttributeNameNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLAttributeValueNode(node: Nodes.HTMLAttributeValueNode): void {
+    if (node.quoted && node.open_quote) {
+      this.write(node.open_quote.value)
+    }
+
+    this.visitChildNodes(node)
+
+    if (node.quoted && node.close_quote) {
+      this.write(node.close_quote.value)
+    }
+  }
+
+  visitHTMLCommentNode(node: Nodes.HTMLCommentNode): void {
+    if (node.comment_start) {
+      this.write(node.comment_start.value)
+    }
+
+    this.visitChildNodes(node)
+
+    if (node.comment_end) {
+      this.write(node.comment_end.value)
+    }
+  }
+
+  visitHTMLDoctypeNode(node: Nodes.HTMLDoctypeNode): void {
+    if (node.tag_opening) {
+      this.write(node.tag_opening.value)
+    }
+
+    this.visitChildNodes(node)
+
+    if (node.tag_closing) {
+      this.write(node.tag_closing.value)
+    }
+  }
+
+  visitXMLDeclarationNode(node: Nodes.XMLDeclarationNode): void {
+    if (node.tag_opening) {
+      this.write(node.tag_opening.value)
+    }
+
+    this.visitChildNodes(node)
+
+    if (node.tag_closing) {
+      this.write(node.tag_closing.value)
+    }
+  }
+
+  visitCDATANode(node: Nodes.CDATANode): void {
+    if (node.tag_opening) {
+      this.write(node.tag_opening.value)
+    }
+
+    this.visitChildNodes(node)
+
+    if (node.tag_closing) {
+      this.write(node.tag_closing.value)
+    }
+  }
+
+  visitERBContentNode(node: Nodes.ERBContentNode): void {
+    this.printERBNode(node)
+  }
+
+  visitERBIfNode(node: Nodes.ERBIfNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    if (node.subsequent) {
+      this.visit(node.subsequent)
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBElseNode(node: Nodes.ERBElseNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+  }
+
+  visitERBEndNode(node: Nodes.ERBEndNode): void {
+    this.printERBNode(node)
+  }
+
+  visitERBBlockNode(node: Nodes.ERBBlockNode): void {
+    this.printERBNode(node)
+
+    if (node.body) {
+      node.body.forEach(child => this.visit(child))
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBCaseNode(node: Nodes.ERBCaseNode): void {
+    this.printERBNode(node)
+
+    if (node.children) {
+      node.children.forEach(child => this.visit(child))
+    }
+
+    if (node.conditions) {
+      node.conditions.forEach(condition => this.visit(condition))
+    }
+
+    if (node.else_clause) {
+      this.visit(node.else_clause)
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBWhenNode(node: Nodes.ERBWhenNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+  }
+
+  visitERBWhileNode(node: Nodes.ERBWhileNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBUntilNode(node: Nodes.ERBUntilNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBForNode(node: Nodes.ERBForNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBBeginNode(node: Nodes.ERBBeginNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    if (node.rescue_clause) {
+      this.visit(node.rescue_clause)
+    }
+
+    if (node.else_clause) {
+      this.visit(node.else_clause)
+    }
+
+    if (node.ensure_clause) {
+      this.visit(node.ensure_clause)
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBRescueNode(node: Nodes.ERBRescueNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    if (node.subsequent) {
+      this.visit(node.subsequent)
+    }
+  }
+
+  visitERBEnsureNode(node: Nodes.ERBEnsureNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+  }
+
+  visitERBUnlessNode(node: Nodes.ERBUnlessNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+
+    if (node.else_clause) {
+      this.visit(node.else_clause)
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBYieldNode(node: Nodes.ERBYieldNode): void {
+    this.printERBNode(node)
+  }
+
+  visitERBInNode(node: Nodes.ERBInNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      node.statements.forEach(statement => this.visit(statement))
+    }
+  }
+
+  visitERBCaseMatchNode(node: Nodes.ERBCaseMatchNode): void {
+    this.printERBNode(node)
+
+    if (node.children) {
+      node.children.forEach(child => this.visit(child))
+    }
+
+    if (node.conditions) {
+      node.conditions.forEach(condition => this.visit(condition))
+    }
+
+    if (node.else_clause) {
+      this.visit(node.else_clause)
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  /**
+   * Print ERB node tags and content
+   */
+  protected printERBNode(node: Nodes.ERBNode): void {
+    if (node.tag_opening) {
+      this.write(node.tag_opening.value)
+    }
+
+    if (node.content) {
+      this.write(node.content.value)
+    }
 
+    if (node.tag_closing) {
+      this.write(node.tag_closing.value)
+    }
+   }
 }

package/src/index.ts

@@ -1,4 +1,5 @@
 export { IdentityPrinter } from "./identity-printer.js"
+export { ERBToRubyStringPrinter } from "./erb-to-ruby-string-printer.js"
 export { PrintContext } from "./print-context.js"
 export { Printer, DEFAULT_PRINT_OPTIONS } from "./printer.js"
 export type { PrintOptions } from "./printer.js"