Skip to content

Allow passing IO to HTML.build #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
willhbr wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Allow passing IO to HTML.build #24

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0319278
Allow passing IO to HTML.build
willhbr Feb 2, 2026
1d18ff9
Handle passing IO correctly
willhbr Feb 3, 2026
1c4a2d7
Address code review comments
willhbr Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions spec/html_builder_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ require "../src/html/builder"

describe HTML::Builder do
it "builds html" do
str = HTML::Builder.build do
str = HTML.build do
doctype
html do
head do
Expand All @@ -20,8 +20,18 @@ describe HTML::Builder do
str.should eq %(<!DOCTYPE html><html><head><title>Crystal Programming Language</title></head><body><a href="http://crystal-lang.org">Crystal rocks!</a><form method="POST"><input name="name"></form></body></html>)
end

it "builds html to IO" do
io = IO::Memory.new
HTML.build(io) do
doctype
html do
end
end
io.to_s.should eq %(<!DOCTYPE html><html></html>)
end

it "builds html with some tag attributes" do
str = HTML::Builder.new.build do
str = HTML.build do
a(href: "http://crystal-lang.org", class: "crystal", id: "main") do
text "Crystal rocks!"
end
Expand All @@ -30,7 +40,7 @@ describe HTML::Builder do
end

it "builds html with some tag attributes, using a hash" do
str = HTML::Builder.new.build do
str = HTML.build do
a(href: "http://crystal-lang.org", class: "crystal", id: "main") do
text "Crystal rocks!"
end
Expand All @@ -39,7 +49,7 @@ describe HTML::Builder do
end

it "builds html with some tag attributes, using a named tuple" do
str = HTML::Builder.new.build do |builder|
str = HTML.build do |builder|
builder.a({href: "http://crystal-lang.org", class: "crystal", id: "main"}) do
text "Crystal rocks!"
end
Expand All @@ -48,28 +58,28 @@ describe HTML::Builder do
end

it "builds html with an provided html string" do
str = HTML::Builder.new.build do
str = HTML.build do
html "<section>Crystal rocks!</section>"
end
str.should eq %(<section>Crystal rocks!</section>)
end

it "builds html with a custom tag with attributes" do
str = HTML::Builder.new.build do
str = HTML.build do
tag("section", class: "crystal") { text "Crystal rocks!" }
end
str.should eq %(<section class="crystal">Crystal rocks!</section>)
end

it "escapes attribute values" do
str = HTML::Builder.new.build do
str = HTML.build do
a(href: "<>") { }
end
str.should eq %(<a href="&lt;&gt;"></a>)
end

it "escapes text" do
str = HTML::Builder.new.build do
str = HTML.build do
a { text "<>" }
end
str.should eq %(<a>&lt;&gt;</a>)
Expand Down
39 changes: 33 additions & 6 deletions src/html/builder/builder.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,38 @@ require "html"
struct HTML::Builder
# Creates a new HTML::Builder, yields with with `with ... yield`
# and then returns the resulting string.
def self.build
new.build do |builder|
def self.build : String
String.build do |io|
new(io).build_impl do |builder|
with builder yield builder
end
end
end

def self.build(io : IO)
new(io).build_impl do |builder|
with builder yield builder
end
end

def initialize
@buffer = String::Builder.new
@buffer : IO

def initialize(@buffer : IO)
end

@[Deprecated("Use HTML.build directly")]
def initialize(@buffer = String::Builder.new)
end

def build
protected def build_impl
with self yield self
end

@[Deprecated("Use HTML.build directly")]
def build(&block)
build_impl do
with self yield self
end
@buffer.to_s
end

Expand Down Expand Up @@ -179,9 +199,16 @@ end

module HTML
# Convenience method which invokes `HTML::Builder#build`.
def self.build
def self.build : String
HTML::Builder.build do |builder|
with builder yield builder
end
end

# Convenience method which invokes `HTML::Builder#build`.
def self.build(io : IO)
HTML::Builder.build(io) do |builder|
with builder yield builder
end
end
end