@herb-tools/rewriter 0.9.2 → 0.9.4

package/dist/types/built-ins/action-view-tag-helper-to-html.d.ts

@@ -4,5 +4,5 @@ import type { Node } from "@herb-tools/core";
 export declare class ActionViewTagHelperToHTMLRewriter extends ASTRewriter {
     get name(): string;
     get description(): string;
-    rewrite<T extends Node>(node: T, _context: RewriteContext): T;
+    rewrite<T extends Node>(node: T, context: RewriteContext): T;
 }

package/dist/types/built-ins/erb-string-to-direct-output.d.ts

@@ -0,0 +1,21 @@
+import { ASTRewriter } from "../ast-rewriter.js";
+import type { RewriteContext } from "../context.js";
+import type { Node, PrismNode } from "@herb-tools/core";
+export interface TextPart {
+    type: "text";
+    content: string;
+}
+export interface ExpressionPart {
+    type: "expression";
+    expression: string;
+}
+export type ReplacementPart = TextPart | ExpressionPart;
+export declare class ERBStringToDirectOutputRewriter extends ASTRewriter {
+    get name(): string;
+    get description(): string;
+    rewrite<T extends Node>(node: T, _context: RewriteContext): T;
+    static isStringOutputNode(prismNode: PrismNode): boolean;
+    static extractStringContent(stringNode: PrismNode, source: string): string;
+    static extractExpressionSource(embeddedNode: PrismNode, source: string): string | null;
+    static extractReplacementParts(prismNode: PrismNode, source: string): ReplacementPart[] | null;
+}

package/dist/types/built-ins/index.d.ts

@@ -12,5 +12,7 @@ export declare function getBuiltinRewriter(name: string): RewriterClass | undefi
  */
 export declare function getBuiltinRewriterNames(): string[];
 export { ActionViewTagHelperToHTMLRewriter } from "./action-view-tag-helper-to-html.js";
+export { ERBStringToDirectOutputRewriter } from "./erb-string-to-direct-output.js";
 export { HTMLToActionViewTagHelperRewriter } from "./html-to-action-view-tag-helper.js";
 export { TailwindClassSorterRewriter } from "./tailwind-class-sorter.js";
+export type { TextPart, ExpressionPart, ReplacementPart } from "./erb-string-to-direct-output.js";

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 export { ASTRewriter } from "./ast-rewriter.js";
 export { ActionViewTagHelperToHTMLRewriter } from "./built-ins/action-view-tag-helper-to-html.js";
+export { ERBStringToDirectOutputRewriter } from "./built-ins/erb-string-to-direct-output.js";
 export { HTMLToActionViewTagHelperRewriter } from "./built-ins/html-to-action-view-tag-helper.js";
 export { StringRewriter } from "./string-rewriter.js";
 export { asMutable } from "./mutable.js";
@@ -10,3 +11,4 @@ export type { Mutable } from "./mutable.js";
 export type { RewriterClass } from "./type-guards.js";
 export type { Rewriter, RewriteOptions, RewriteResult } from "./rewrite.js";
 export type { TailwindClassSorterOptions } from "./rewriter-factories.js";
+export type { TextPart, ExpressionPart, ReplacementPart } from "./built-ins/erb-string-to-direct-output.js";

package/dist/types/rewriter-factories.d.ts

@@ -1,5 +1,6 @@
 import { TailwindClassSorterRewriter } from "./built-ins/tailwind-class-sorter.js";
 import { ActionViewTagHelperToHTMLRewriter } from "./built-ins/action-view-tag-helper-to-html.js";
+import { ERBStringToDirectOutputRewriter } from "./built-ins/erb-string-to-direct-output.js";
 import { HTMLToActionViewTagHelperRewriter } from "./built-ins/html-to-action-view-tag-helper.js";
 export interface TailwindClassSorterOptions {
     /**
@@ -29,4 +30,5 @@ export interface TailwindClassSorterOptions {
  */
 export declare function tailwindClassSorter(options?: TailwindClassSorterOptions): Promise<TailwindClassSorterRewriter>;
 export declare function actionViewTagHelperToHTML(): ActionViewTagHelperToHTMLRewriter;
+export declare function erbStringToDirectOutput(): ERBStringToDirectOutputRewriter;
 export declare function htmlToActionViewTagHelper(): HTMLToActionViewTagHelperRewriter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@herb-tools/rewriter",
-  "version": "0.9.2",
+  "version": "0.9.4",
   "description": "Rewriter system for transforming HTML+ERB AST nodes and formatted strings",
   "license": "MIT",
   "homepage": "https://herb-tools.dev",
@@ -38,12 +38,12 @@
     }
   },
   "dependencies": {
-    "@herb-tools/core": "0.9.2",
-    "@herb-tools/tailwind-class-sorter": "0.9.2",
+    "@herb-tools/core": "0.9.4",
+    "@herb-tools/tailwind-class-sorter": "0.9.4",
     "tinyglobby": "^0.2.15"
   },
   "devDependencies": {
-    "@herb-tools/printer": "0.9.2"
+    "@herb-tools/printer": "0.9.4"
   },
   "files": [
     "package.json",

package/src/built-ins/action-view-tag-helper-to-html.ts

@@ -1,5 +1,5 @@
 import { Visitor, Location, HTMLOpenTagNode, HTMLCloseTagNode, HTMLElementNode, HTMLAttributeValueNode, WhitespaceNode, ERBContentNode } from "@herb-tools/core"
-import { isHTMLAttributeNode, isERBOpenTagNode, isRubyLiteralNode, isRubyHTMLAttributesSplatNode, createSyntheticToken } from "@herb-tools/core"
+import { isHTMLAttributeNode, isERBOpenTagNode, isRubyLiteralNode, isRubyHTMLAttributesSplatNode, isWhitespaceNode, createSyntheticToken } from "@herb-tools/core"
 
 import { ASTRewriter } from "../ast-rewriter.js"
 import { asMutable } from "../mutable.js"
@@ -17,6 +17,45 @@ function createWhitespaceNode(): WhitespaceNode {
 }
 
 class ActionViewTagHelperToHTMLVisitor extends Visitor {
+  private shallow: boolean
+  private includeBody: boolean
+
+  constructor(options: { shallow?: boolean; includeBody?: boolean } = {}) {
+    super()
+    this.shallow = options.shallow ?? false
+    this.includeBody = options.includeBody ?? true
+  }
+
+  visitHTMLOpenTagNode(node: HTMLOpenTagNode): void {
+    const newChildren: Node[] = []
+
+    for (let index = 0; index < node.children.length; index++) {
+      const child = node.children[index]
+
+      if (isHTMLAttributeNode(child)) {
+        if (child.equals && child.equals.value !== "=") {
+          asMutable(child).equals = createSyntheticToken("=")
+        }
+
+        if (child.value) {
+          this.transformAttributeValue(child.value)
+        }
+
+        const previous = index > 0 ? node.children[index - 1] : null
+
+        if (!previous || !isWhitespaceNode(previous)) {
+          newChildren.push(createWhitespaceNode())
+        }
+      }
+
+      newChildren.push(child)
+    }
+
+    asMutable(node).children = newChildren
+
+    this.visitChildNodes(node)
+  }
+
   visitHTMLElementNode(node: HTMLElementNode): void {
     if (!node.element_source) {
       this.visitChildNodes(node)
@@ -104,7 +143,9 @@ class ActionViewTagHelperToHTMLVisitor extends Visitor {
 
     asMutable(node).element_source = "HTML"
 
-    if (node.body) {
+    if (!this.includeBody) {
+      asMutable(node).body = []
+    } else if (node.body) {
       asMutable(node).body = node.body.map(child => {
         if (isRubyLiteralNode(child)) {
           return new ERBContentNode({
@@ -120,7 +161,10 @@ class ActionViewTagHelperToHTMLVisitor extends Visitor {
           })
         }
 
-        this.visit(child)
+        if (!this.shallow) {
+          this.visit(child)
+        }
+
         return child
       })
     }
@@ -150,12 +194,12 @@ class ActionViewTagHelperToHTMLVisitor extends Visitor {
       })
 
       mutableValue.children = newChildren
+    }
 
-      if (!value.quoted) {
-        mutableValue.quoted = true
-        mutableValue.open_quote = createSyntheticToken('"')
-        mutableValue.close_quote = createSyntheticToken('"')
-      }
+    if (!value.quoted) {
+      mutableValue.quoted = true
+      mutableValue.open_quote = createSyntheticToken('"')
+      mutableValue.close_quote = createSyntheticToken('"')
     }
   }
 }
@@ -169,8 +213,8 @@ export class ActionViewTagHelperToHTMLRewriter extends ASTRewriter {
     return "Converts ActionView tag helpers to raw HTML elements"
   }
 
-  rewrite<T extends Node>(node: T, _context: RewriteContext): T {
-    const visitor = new ActionViewTagHelperToHTMLVisitor()
+  rewrite<T extends Node>(node: T, context: RewriteContext): T {
+    const visitor = new ActionViewTagHelperToHTMLVisitor({ shallow: context.shallow, includeBody: context.includeBody })
 
     visitor.visit(node)
 

package/src/built-ins/erb-string-to-direct-output.ts

@@ -0,0 +1,176 @@
+import { Visitor, isERBOutputNode, createLiteral, createERBOutputNode, findParentArray } from "@herb-tools/core"
+
+import { ASTRewriter } from "../ast-rewriter.js"
+
+import type { RewriteContext } from "../context.js"
+import type { Node, ERBContentNode, PrismNode } from "@herb-tools/core"
+
+const STRING_NODE_TYPE = "StringNode"
+const INTERPOLATED_STRING_NODE_TYPE = "InterpolatedStringNode"
+const EMBEDDED_STATEMENTS_NODE_TYPE = "EmbeddedStatementsNode"
+
+export interface TextPart {
+  type: "text"
+  content: string
+}
+
+export interface ExpressionPart {
+  type: "expression"
+  expression: string
+}
+
+export type ReplacementPart = TextPart | ExpressionPart
+
+class ERBStringToDirectOutputVisitor extends Visitor {
+  private root: Node
+
+  constructor(root: Node) {
+    super()
+    this.root = root
+  }
+
+  visitERBContentNode(node: ERBContentNode): void {
+    if (!isERBOutputNode(node)) {
+      this.visitChildNodes(node)
+      return
+    }
+
+    const prismNode = node.prismNode
+    if (!prismNode) {
+      this.visitChildNodes(node)
+      return
+    }
+
+    const source = node.source
+    if (!source) {
+      this.visitChildNodes(node)
+      return
+    }
+
+    if (!ERBStringToDirectOutputRewriter.isStringOutputNode(prismNode)) {
+      this.visitChildNodes(node)
+      return
+    }
+
+    const replacementParts = ERBStringToDirectOutputRewriter.extractReplacementParts(prismNode, source)
+
+    if (!replacementParts) {
+      this.visitChildNodes(node)
+      return
+    }
+
+    const tagOpening = node.tag_opening?.value ?? "<%="
+    const tagClosing = node.tag_closing?.value ?? "%>"
+
+    const parentInfo = findParentArray(this.root, node)
+
+    if (!parentInfo) {
+      this.visitChildNodes(node)
+      return
+    }
+
+    const { array: parentArray, index: nodeIndex } = parentInfo
+    const replacementNodes: Node[] = []
+
+    for (const part of replacementParts) {
+      if (part.type === "text") {
+        replacementNodes.push(createLiteral(part.content))
+      } else {
+        replacementNodes.push(createERBOutputNode(` ${part.expression.trim()} `, tagOpening, tagClosing))
+      }
+    }
+
+    parentArray.splice(nodeIndex, 1, ...replacementNodes)
+  }
+}
+
+export class ERBStringToDirectOutputRewriter extends ASTRewriter {
+  get name(): string {
+    return "erb-string-to-direct-output"
+  }
+
+  get description(): string {
+    return "Replaces ERB string output with direct text and expression tags"
+  }
+
+  rewrite<T extends Node>(node: T, _context: RewriteContext): T {
+    const visitor = new ERBStringToDirectOutputVisitor(node)
+
+    visitor.visit(node)
+
+    return node
+  }
+
+  static isStringOutputNode(prismNode: PrismNode): boolean {
+    const nodeType = prismNode.constructor.name
+
+    return nodeType === STRING_NODE_TYPE || nodeType === INTERPOLATED_STRING_NODE_TYPE
+  }
+
+  static extractStringContent(stringNode: PrismNode, source: string): string {
+    const unescapedValue = stringNode.unescaped?.value
+
+    if (typeof unescapedValue === "string") {
+      return unescapedValue
+    }
+
+    const location = stringNode.contentLoc
+
+    if (location) {
+      return source.substring(location.startOffset, location.startOffset + location.length)
+    }
+
+    return ""
+  }
+
+  static extractExpressionSource(embeddedNode: PrismNode, source: string): string | null {
+    const openingLocation = embeddedNode.openingLoc
+    const closingLocation = embeddedNode.closingLoc
+
+    if (!openingLocation || !closingLocation) return null
+
+    const expressionStart = openingLocation.startOffset + openingLocation.length
+    const expressionEnd = closingLocation.startOffset
+
+    return source.substring(expressionStart, expressionEnd)
+  }
+
+  static extractReplacementParts(prismNode: PrismNode, source: string): ReplacementPart[] | null {
+    const nodeType = prismNode.constructor.name
+
+    if (nodeType === STRING_NODE_TYPE) {
+      const textContent = this.extractStringContent(prismNode, source)
+      return [{ type: "text", content: textContent }]
+    }
+
+    if (nodeType === INTERPOLATED_STRING_NODE_TYPE) {
+      const parts = prismNode.parts
+
+      if (!parts || parts.length === 0) return null
+
+      const replacementParts: ReplacementPart[] = []
+
+      for (const part of parts) {
+        const partType = part.constructor.name
+
+        if (partType === STRING_NODE_TYPE) {
+          const textContent = this.extractStringContent(part, source)
+
+          if (textContent) {
+            replacementParts.push({ type: "text", content: textContent })
+          }
+        } else if (partType === EMBEDDED_STATEMENTS_NODE_TYPE) {
+          const expression = this.extractExpressionSource(part, source)
+
+          if (expression) {
+            replacementParts.push({ type: "expression", expression })
+          }
+        }
+      }
+
+      return replacementParts.length > 0 ? replacementParts : null
+    }
+
+    return null
+  }
+}

package/src/built-ins/html-to-action-view-tag-helper.ts

@@ -124,9 +124,10 @@ class HTMLToActionViewTagHelperVisitor extends Visitor {
     const isAnchor = tagName.value === "a"
     const isTurboFrame = tagName.value === "turbo-frame"
     const isScript = tagName.value === "script"
+    const isImg = tagName.value === "img"
     const attributes = openTag.children.filter(child => !isWhitespaceNode(child))
-    const hasSrcAttribute = isScript && attributes.some(child => isHTMLAttributeNode(child) && getStaticAttributeName(child.name!) === "src")
-    const { attributes: attributesString, href, id, src } = serializeAttributes(attributes, { extractHref: isAnchor, extractId: isTurboFrame, extractSrc: isScript })
+    const hasSrcAttribute = (isScript || isImg) && attributes.some(child => isHTMLAttributeNode(child) && getStaticAttributeName(child.name!) === "src")
+    const { attributes: attributesString, href, id, src } = serializeAttributes(attributes, { extractHref: isAnchor, extractId: isTurboFrame, extractSrc: isScript || isImg })
     const hasBody = node.body && node.body.length > 0 && !node.is_void
     const isInlineContent = hasBody && isTextOnlyBody(node.body)
 
@@ -145,6 +146,9 @@ class HTMLToActionViewTagHelperVisitor extends Visitor {
     } else if (isScript) {
       content = this.buildJavascriptTagContent(node, attributesString, isInlineContent)
       elementSource = "ActionView::Helpers::JavaScriptHelper#javascript_tag"
+    } else if (isImg) {
+      content = this.buildImageTagContent(attributesString, src)
+      elementSource = "ActionView::Helpers::AssetTagHelper#image_tag"
     } else {
       content = this.buildTagContent(tagName.value, node, attributesString, isInlineContent)
       elementSource = "ActionView::Helpers::TagHelper#tag"
@@ -165,7 +169,7 @@ class HTMLToActionViewTagHelperVisitor extends Visitor {
     asMutable(node).element_source = elementSource
 
     const isInlineLiteralContent = isScript && hasBody && node.body.length === 1 && isLiteralNode(node.body[0]) && !node.body[0].content.includes("\n")
-    const isInlineForm = isInlineContent || isInlineLiteralContent || (isTurboFrame && !hasBody) || (isScript && hasSrcAttribute)
+    const isInlineForm = isInlineContent || isInlineLiteralContent || (isTurboFrame && !hasBody) || (isScript && hasSrcAttribute) || isImg
 
     if (node.is_void) {
       asMutable(node).close_tag = null
@@ -270,6 +274,17 @@ class HTMLToActionViewTagHelperVisitor extends Visitor {
     return argString ? ` javascript_include_tag ${argString} ` : ` javascript_include_tag `
   }
 
+  private buildImageTagContent(attributes: string, source: string | null): string {
+    const args: string[] = []
+
+    if (source) args.push(source)
+    if (attributes) args.push(attributes)
+
+    const argString = args.join(", ")
+
+    return argString ? ` image_tag ${argString} ` : ` image_tag `
+  }
+
   private buildLinkToContent(node: HTMLElementNode, attribute: string, href: string | null, isInlineContent: boolean): string {
     const args: string[] = []
 
@@ -301,7 +316,7 @@ export class HTMLToActionViewTagHelperRewriter extends ASTRewriter {
   }
 
   get description(): string {
-    return "Converts raw HTML elements to ActionView tag helpers (tag.*, turbo_frame_tag, javascript_tag, javascript_include_tag)"
+    return "Converts raw HTML elements to ActionView tag helpers (tag.*, turbo_frame_tag, javascript_tag, javascript_include_tag, image_tag)"
   }
 
   rewrite<T extends Node>(node: T, _context: RewriteContext): T {

package/src/built-ins/index.ts

@@ -1,4 +1,5 @@
 import { ActionViewTagHelperToHTMLRewriter } from "./action-view-tag-helper-to-html.js"
+import { ERBStringToDirectOutputRewriter } from "./erb-string-to-direct-output.js"
 import { HTMLToActionViewTagHelperRewriter } from "./html-to-action-view-tag-helper.js"
 import { TailwindClassSorterRewriter } from "./tailwind-class-sorter.js"
 
@@ -9,6 +10,7 @@ import type { RewriterClass } from "../type-guards.js"
  */
 export const builtinRewriters: RewriterClass[] = [
   ActionViewTagHelperToHTMLRewriter,
+  ERBStringToDirectOutputRewriter,
   HTMLToActionViewTagHelperRewriter,
   TailwindClassSorterRewriter
 ]
@@ -36,5 +38,8 @@ export function getBuiltinRewriterNames(): string[] {
 }
 
 export { ActionViewTagHelperToHTMLRewriter } from "./action-view-tag-helper-to-html.js"
+export { ERBStringToDirectOutputRewriter } from "./erb-string-to-direct-output.js"
 export { HTMLToActionViewTagHelperRewriter } from "./html-to-action-view-tag-helper.js"
 export { TailwindClassSorterRewriter } from "./tailwind-class-sorter.js"
+
+export type { TextPart, ExpressionPart, ReplacementPart } from "./erb-string-to-direct-output.js"

package/src/index.ts

@@ -1,5 +1,6 @@
 export { ASTRewriter } from "./ast-rewriter.js"
 export { ActionViewTagHelperToHTMLRewriter } from "./built-ins/action-view-tag-helper-to-html.js"
+export { ERBStringToDirectOutputRewriter } from "./built-ins/erb-string-to-direct-output.js"
 export { HTMLToActionViewTagHelperRewriter } from "./built-ins/html-to-action-view-tag-helper.js"
 export { StringRewriter } from "./string-rewriter.js"
 
@@ -13,3 +14,4 @@ export type { Mutable } from "./mutable.js"
 export type { RewriterClass } from "./type-guards.js"
 export type { Rewriter, RewriteOptions, RewriteResult } from "./rewrite.js"
 export type { TailwindClassSorterOptions } from "./rewriter-factories.js"
+export type { TextPart, ExpressionPart, ReplacementPart } from "./built-ins/erb-string-to-direct-output.js"

package/src/rewriter-factories.ts

@@ -1,5 +1,6 @@
 import { TailwindClassSorterRewriter } from "./built-ins/tailwind-class-sorter.js"
 import { ActionViewTagHelperToHTMLRewriter } from "./built-ins/action-view-tag-helper-to-html.js"
+import { ERBStringToDirectOutputRewriter } from "./built-ins/erb-string-to-direct-output.js"
 import { HTMLToActionViewTagHelperRewriter } from "./built-ins/html-to-action-view-tag-helper.js"
 
 export interface TailwindClassSorterOptions {
@@ -42,6 +43,10 @@ export function actionViewTagHelperToHTML(): ActionViewTagHelperToHTMLRewriter {
   return new ActionViewTagHelperToHTMLRewriter()
 }
 
+export function erbStringToDirectOutput(): ERBStringToDirectOutputRewriter {
+  return new ERBStringToDirectOutputRewriter()
+}
+
 export function htmlToActionViewTagHelper(): HTMLToActionViewTagHelperRewriter {
   return new HTMLToActionViewTagHelperRewriter()
 }