[BREAKING] refactor: Rename #to_html/#render_to to #to_s

README.md

@@ -36,7 +36,7 @@ class Alert
   end
 end
 
-Alert.new.to_html
+Alert.new.to_s
 ```
 
 Output:

benchmark/benchmark.cr

@@ -6,14 +6,14 @@ require "./ecr"
 
 require "../src/blueprint/version"
 
-blueprint_html = BlueprintHTML::Page.new.to_html
-blueprint_raw_html = BlueprintRawHTML::Page.new.to_html
+blueprint_html = BlueprintHTML::Page.new.to_s
+blueprint_raw_html = BlueprintRawHTML::Page.new.to_s
 ecr = ECR::Page.new.to_s # ECR is here just to have a base value to compare
 
 raise "Different results" if blueprint_html != blueprint_raw_html && blueprint_html != ecr
 
 Benchmark.ips do |x|
-  x.report("Blueprint::HTML #{Blueprint::VERSION}") { BlueprintHTML::Page.new.to_html }
-  x.report("Blueprint::RawHTML #{Blueprint::VERSION}") { BlueprintRawHTML::Page.new.to_html }
+  x.report("Blueprint::HTML #{Blueprint::VERSION}") { BlueprintHTML::Page.new.to_s }
+  x.report("Blueprint::RawHTML #{Blueprint::VERSION}") { BlueprintRawHTML::Page.new.to_s }
   x.report("ECR") { ECR::Page.new.to_s }
 end

spec/blueprint/html/attributes_handling_spec.cr

@@ -20,7 +20,7 @@ describe "attributes handling" do
       <div class="hello" id="first">Normal attributes</div>
     HTML
 
-    page.to_html.should contain(div)
+    page.to_s.should contain(div)
   end
 
   it "converts attribute values to string" do
@@ -29,7 +29,7 @@ describe "attributes handling" do
       <span id="421" float="2.4">Non-string attribute values</span>
     HTML
 
-    page.to_html.should contain(span)
+    page.to_s.should contain(span)
   end
 
   it "replaces `_` by `-` on attribute names" do
@@ -38,7 +38,7 @@ describe "attributes handling" do
       <section v-model="user.name" @click="doSomething">Transform attribute name</section>
     HTML
 
-    page.to_html.should contain(section)
+    page.to_s.should contain(section)
   end
 
   it "accepts boolean attributes" do
@@ -47,7 +47,7 @@ describe "attributes handling" do
       <input disabled outline="true" border="false">
     HTML
 
-    page.to_html.should contain(input)
+    page.to_s.should contain(input)
   end
 
   it "expands nested attributes" do
@@ -56,7 +56,7 @@ describe "attributes handling" do
       <nav aria-target="#home" aria-selected="false" aria-enabled>Nested attributes</nav>
     HTML
 
-    page.to_html.should contain(nav)
+    page.to_s.should contain(nav)
   end
 
   it "flattens, compacts and joins array attributes" do
@@ -65,6 +65,6 @@ describe "attributes handling" do
       <div class="a b c d">Array attributes</div>
     HTML
 
-    page.to_html.should contain(nav)
+    page.to_s.should contain(nav)
   end
 end

spec/blueprint/html/building_style_spec.cr

@@ -102,7 +102,7 @@ describe "style building" do
   end
 
   it "allows to build style inside components" do
-    actual_html = ButtonComponent.new.to_html { "Build Style!" }
+    actual_html = ButtonComponent.new.to_s { "Build Style!" }
     expected_html = normalize_html <<-HTML
       <a class="btn btn-xs btn-outline btn-blue">Build Style!</a>
     HTML

spec/blueprint/html/component_rendering_spec.cr

@@ -73,7 +73,7 @@ describe "component rendering" do
       <header>Basic component</header>
     HTML
 
-    page.to_html.should contain(basic_component)
+    page.to_s.should contain(basic_component)
   end
 
   it "can provide content to another blueprints" do
@@ -86,7 +86,7 @@ describe "component rendering" do
       </div>
     HTML
 
-    page.to_html.should contain(content_component)
+    page.to_s.should contain(content_component)
   end
 
   it "can use another blueprint methods" do
@@ -99,6 +99,6 @@ describe "component rendering" do
       </div>
     HTML
 
-    page.to_html.should contain(complex_component)
+    page.to_s.should contain(complex_component)
   end
 end

spec/blueprint/html/components_registration_spec.cr

@@ -60,7 +60,7 @@ describe "components registration" do
       <div id="required-block">Component with required block</div>
     HTML
 
-    page.to_html.should contain expected_html
+    page.to_s.should contain expected_html
   end
 
   it "allows component helper definition without required block" do
@@ -69,7 +69,7 @@ describe "components registration" do
       <h1>Component without block</h1>
     HTML
 
-    page.to_html.should contain expected_html
+    page.to_s.should contain expected_html
   end
 
   it "allows component helper definition with optional block" do
@@ -79,6 +79,6 @@ describe "components registration" do
       <div id="optional-block"></div>
     HTML
 
-    page.to_html.should contain expected_html
+    page.to_s.should contain expected_html
   end
 end

spec/blueprint/html/conditional_rendering_spec.cr

@@ -51,17 +51,17 @@ describe "conditional rendering" do
         <div></div>
       HTML
 
-      page.to_html.should eq expected_html
+      page.to_s.should eq expected_html
     end
   end
 
   context "when blueprint `#render?` returns false" do
     it "doesn't render the blueprint" do
       page = NoRenderPage.new
-      page.to_html.should eq ""
+      page.to_s.should eq ""
 
       page = NoRenderPage.new
-      html = page.to_html { "This page will not be rendered" }
+      html = page.to_s { "This page will not be rendered" }
       html.should eq ""
     end
   end

spec/blueprint/html/custom_elements_registration_spec.cr

@@ -23,7 +23,7 @@ describe "custom elements registration" do
       <v-btn href="#home" data-id="12" data-visible>Home</v-btn>
     HTML
 
-    page.to_html.should contain expected_html
+    page.to_s.should contain expected_html
   end
 
   it "allows passing content as first argument" do
@@ -32,7 +32,7 @@ describe "custom elements registration" do
       <v-btn href="#contact">Contact</v-btn>
     HTML
 
-    page.to_html.should contain expected_html
+    page.to_s.should contain expected_html
   end
 
   it "allows empty custom elements" do
@@ -41,7 +41,7 @@ describe "custom elements registration" do
       <v-btn></v-btn>
     HTML
 
-    page.to_html.should contain expected_html
+    page.to_s.should contain expected_html
   end
 
   it "allows defining custom tags" do
@@ -50,6 +50,6 @@ describe "custom elements registration" do
       <MyCard></MyCard>
     HTML
 
-    page.to_html.should contain expected_html
+    page.to_s.should contain expected_html
   end
 end

spec/blueprint/html/enveloping_spec.cr

@@ -56,6 +56,6 @@ describe "enveloping" do
       </html>
     HTML
 
-    page.to_html.should eq expected_html
+    page.to_s.should eq expected_html
   end
 end

spec/blueprint/html/helpers_spec.cr

@@ -28,7 +28,7 @@ describe "helpers" do
         <div class="a b c e">Tokens</div>
       HTML
 
-      page.to_html.should contain expected_html
+      page.to_s.should contain expected_html
     end
   end
 end

spec/blueprint/html/safety_spec.cr

@@ -33,7 +33,7 @@ describe "safety" do
       <span>&lt;script&gt;alert(&#39;hello&#39;)&lt;/script&gt;</span>
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 
   it "escapes content passed to tags via argument" do
@@ -42,7 +42,7 @@ describe "safety" do
       <span>&lt;script&gt;alert(&#39;content&#39;)&lt;/script&gt;</span>
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 
   it "escapes plain text" do
@@ -51,7 +51,7 @@ describe "safety" do
       &lt;script&gt;alert(&#39;Plain Text&#39;)&lt;/script&gt;
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 
   it "escapes content passed to blueprints" do
@@ -60,7 +60,7 @@ describe "safety" do
       &lt;script&gt;alert(&#39;ExampleComponent&#39;)&lt;/script&gt;
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 
   it "escapes attribute values" do
@@ -69,7 +69,7 @@ describe "safety" do
       <div class="some-class&quot; onblur=&quot;alert(&#39;Attribute&#39;)"></div>
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 
   it "escapes comment content passed via block" do
@@ -78,7 +78,7 @@ describe "safety" do
       <!----&gt;&lt;script&gt;alert(&#39;Plain Text&#39;)&lt;/script&gt;&lt;!---->
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 
   it "escapes comment content passed via argument" do
@@ -87,7 +87,7 @@ describe "safety" do
       <!----&gt;&lt;script&gt;alert(&#39;Another plain text&#39;)&lt;/script&gt;&lt;!---->
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 
   it "escapes custom tag content passed via argument" do
@@ -96,7 +96,7 @@ describe "safety" do
       <v-btn>&lt;script&gt;alert(&#39;content&#39;)&lt;/script&gt;</v-btn>
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 
   it "escapes custom tag content passed via block" do
@@ -105,6 +105,6 @@ describe "safety" do
       <v-btn class="some-class&quot; onclick=&quot;alert(&#39;Attribute&#39;)">&lt;script&gt;alert(&#39;hello&#39;)&lt;/script&gt;</v-btn>
     HTML
 
-    page.to_html.should contain(expected_html)
+    page.to_s.should contain(expected_html)
   end
 end

spec/blueprint/html/standard_elements_spec.cr

@@ -73,6 +73,6 @@ describe "standard HTML elements" do
       io << "<select attribute=\"test\">content</select>"
     end
 
-    page.to_html.should eq expected_html
+    page.to_s.should eq expected_html
   end
 end

spec/blueprint/html/svg_rendering_spec.cr

@@ -48,7 +48,7 @@ describe "SVG rendering" do
       </svg>
     HTML
 
-    example.to_html.should eq expected_html
+    example.to_s.should eq expected_html
   end
 
   it "defines all SVG element helper methods" do
@@ -64,6 +64,6 @@ describe "SVG rendering" do
       io << "</svg>"
     end
 
-    page.to_html.should eq expected_html
+    page.to_s.should eq expected_html
   end
 end

spec/blueprint/html/utils_spec.cr

@@ -29,57 +29,57 @@ describe "utils" do
     it "renders plain text passed via argument" do
       page = ExamplePage.new
 
-      page.to_html.should contain("<div>Hello<b>World</b></div>")
+      page.to_s.should contain("<div>Hello<b>World</b></div>")
     end
 
     it "renders plain text passed via block" do
       page = ExamplePage.new
 
-      page.to_html.should contain("<span>Plain!</span>")
+      page.to_s.should contain("<span>Plain!</span>")
     end
   end
 
   describe "#doctype" do
     it "renders HTML 5 doctype declaration" do
       page = ExamplePage.new
 
-      page.to_html.should contain("<!DOCTYPE html>")
+      page.to_s.should contain("<!DOCTYPE html>")
     end
   end
 
   describe "#comment" do
     it "renders an html comment passed via block" do
       page = ExamplePage.new
 
-      page.to_html.should contain("<!--This is an html comment-->")
+      page.to_s.should contain("<!--This is an html comment-->")
     end
 
     it "renders an html comment passed via argument" do
       page = ExamplePage.new
 
-      page.to_html.should contain("<!--This is another html comment-->")
+      page.to_s.should contain("<!--This is another html comment-->")
     end
   end
 
   describe "#whitespace" do
     it "renders an whitespace" do
       page = ExamplePage.new
 
-      page.to_html.should contain("<i>Hi</i> User")
+      page.to_s.should contain("<i>Hi</i> User")
     end
   end
 
   describe "#unsafe_raw" do
     it "renders content passed via argument without escaping" do
       page = ExamplePage.new
 
-      page.to_html.should contain("<script>Dangerous script</script>")
+      page.to_s.should contain("<script>Dangerous script</script>")
     end
 
     it "renders content passed via block without escaping" do
       page = ExamplePage.new
 
-      page.to_html.should contain("<div><script>Another dangerous script</script></div>")
+      page.to_s.should contain("<div><script>Another dangerous script</script></div>")
     end
   end
 end