ruby2html 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57887705c24091d9cf76d5f1b7e41da4167077c9c61b5a408756af3804e0df1b
-  data.tar.gz: e27fa7060204b4da1c95998451a186cf84492e4a896440baa9ce78eceaaf6f9c
+  metadata.gz: acd9834eee45bda437a281566e66300e5e5645dddb45850d571d506c27a94501
+  data.tar.gz: ebe9a74c98f952e049335357fda1e9268f7126fbb090cbf7bf4e8b4e1fbedc1f
 SHA512:
-  metadata.gz: 3267b43294cac4d37620a16076fbb97eaaf7d6e8c639b1b83e7b7657e597739617f5ee051c83a2d2394758a9ab19f0d9dd66243ad36eb2c4057308fec64d9ec2
-  data.tar.gz: 583b0c34f859915a57de3b7c1518ed7df16225eef381203c53b73fdf8664401567f564a5dd5c42b870b9b75d3c4f37f119dc7fae51b7707907ded372d97b52c7
+  metadata.gz: 4dc38bb961568de810742b8e8c2a8c9231abcbc0244bf0334350b3949eef3e1d81d2f907ab2565bc1acc6b0b6751ccabdc2c04b9855996e72e0ef0c117eaf8fa
+  data.tar.gz: 5e200ab5fd3f5a0941c7d7a32e5729e5a9f249d01158b1906a2797d0b0e8309bf403e0aaf5bd5a8416ef9cf42a8d56c0150bc2a9d5f0ca63bfe987ba8c777dca

data/README.md

@@ -1,6 +1,6 @@
 # Ruby2html 🔮✨
 
-Transform your Ruby code into beautiful, structured HTML with ease! 🚀
+Transform your view logic into elegant, semantic HTML with the power of pure Ruby! 🚀✨
 
 ## 🌟 What is Ruby2html?
 
@@ -39,6 +39,30 @@ end
 
 ### In your views
 
+File: `app/views/your_view.html.rb`
+
+```ruby
+div class: 'container' do
+  h1 'Welcome to Ruby2html! 🎉', class: 'main-title', 'data-controller': 'welcome'
+  link_to 'Home Sweet Home 🏠', root_path, class: 'btn btn-primary', 'data-turbo': false
+
+  @items.each do |item|
+    h2 class: 'item-title', id: "item-#{item[:id]}" do
+      item[:title]
+    end
+    p class: 'item-description' do
+      item[:description]
+    end
+  end
+end
+
+plain '<div>Inline html</div>'.html_safe
+
+render partial: 'shared/navbar'
+```
+
+#### Or use your current .erb views
+
 File: `app/views/your_view.html.erb`
 
 Replace your ERB with beautiful Ruby code:
@@ -46,27 +70,47 @@ Replace your ERB with beautiful Ruby code:
 ```erb
 <%=
   html(self) do
-    h1 class: 'main-title', 'data-controller': 'welcome' do
-      "Welcome to Ruby2html! 🎉"
-    end
+    h1 "Welcome to Ruby2html! 🎉", class: 'main-title', 'data-controller': 'welcome'
     div id: 'content', class: 'container' do
       link_to 'Home Sweet Home 🏠', root_path, class: 'btn btn-primary', 'data-turbo': false
     end
 
     @items.each do |item|
       h2 class: 'item-title', id: "item-#{item[:id]}" do
-        plain item[:title]
+        item[:title]
       end
       p class: 'item-description' do
-        plain item[:description]
+        item[:description]
       end
     end
 
+    plain "<div>Inline html</div>".html_safe
+
     render partial: 'shared/navbar'
   end
 %>
 ```
 
+### Benchmark
+
+```bash
+ruby 3.3.3 (2024-06-12 revision f1c7b6f435) +YJIT [x86_64-linux]
+Warming up --------------------------------------
+GET /benchmark/html (ERB)
+                         1.000 i/100ms
+GET /benchmark/ruby (Ruby2html)
+                         1.000 i/100ms
+Calculating -------------------------------------
+GET /benchmark/html (ERB)
+                         20.163 (±19.8%) i/s -     95.000 in   5.062853s
+GET /benchmark/ruby (Ruby2html)
+                         19.362 (±15.5%) i/s -     92.000 in   5.006433s
+
+Comparison:
+GET /benchmark/html (ERB):       20.2 i/s
+GET /benchmark/ruby (Ruby2html):       19.4 i/s - same-ish: difference falls within error
+```
+
 ### With ViewComponents
 
 Ruby2html seamlessly integrates with ViewComponents, offering flexibility in how you define your component's HTML structure. You can use the `call` method with Ruby2html syntax, or stick with traditional `.erb` template files.
@@ -96,10 +140,10 @@ class GreetingComponent < ApplicationComponent
   def call
     html(self) do
       h1 class: 'greeting', 'data-user': @name do
-        plain "Hello, #{@name}! 👋"
+        "Hello, #{@name}! 👋"
       end
       p class: 'welcome-message' do
-        plain 'Welcome to the wonderful world of Ruby2html!'
+        'Welcome to the wonderful world of Ruby2html!'
       end
     end
   end
@@ -155,13 +199,13 @@ class FirstComponent < ApplicationComponent
   def call
     html(self) do
       h1 id: 'first-component-title' do
-        plain 'first component'
+        'first component'
       end
       div class: 'content-wrapper' do
         h2 'A subheading'
       end
       p class: 'greeting-text', 'data-testid': 'greeting' do
-        plain @item
+        @item
       end
     end
   end
@@ -177,7 +221,7 @@ class SecondComponent < ApplicationComponent
   def call
     html(self) do
       h1 class: 'my-class', id: 'second-component-title', 'data-controller': 'second' do
-        plain 'second component'
+        'second component'
       end
       link_to 'Home', root_path, class: 'nav-link', 'data-turbo-frame': false
     end
@@ -187,13 +231,18 @@ end
 
 ## Without Rails
 ```ruby
-html = Ruby2html::Render.new(nil) do # nil is the context, you can use self or any other object
+renderer = Ruby2html::Render.new(nil) do # nil is the context, you can use self or any other object
   html do
-    h1 'Hello, World!'
+    head do
+      title 'Ruby2html Example'
+    end
+    body do
+      h1 'Hello, World!'
+    end
   end
 end
 
-puts html.render
+puts renderer.render # => "<html><head><title>Ruby2html Example</title></head><body><h1>Hello, World!</h1></body></html>"
 ```
 
 ## 🐢 Gradual Adoption

data/app/controllers/benchmark_controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class BenchmarkController < ApplicationController
+  def normal_html
+    @complex_data = generate_complex_data
+  end
+
+  def ruby_2html
+    @complex_data = generate_complex_data
+  end
+
+  private
+    def generate_complex_data
+      {
+        users: 50.times.map do |i|
+          {
+            id: i + 1,
+            name: Faker::Name.name,
+            email: Faker::Internet.email,
+            address: {
+              street: Faker::Address.street_address,
+              city: Faker::Address.city,
+              country: Faker::Address.country
+            },
+            orders: rand(1..5).times.map do
+              {
+                id: Faker::Alphanumeric.alphanumeric(number: 10),
+                total: Faker::Commerce.price(range: 10..1000.0),
+                items: rand(1..10).times.map do
+                  {
+                    name: Faker::Commerce.product_name,
+                    price: Faker::Commerce.price(range: 5..500.0),
+                    quantity: rand(1..5)
+                  }
+                end
+              }
+            end
+          }
+        end,
+        stats: {
+          total_users: 50,
+          average_orders_per_user: rand(1.0..5.0).round(2),
+          most_expensive_item: Faker::Commerce.product_name,
+          most_popular_country: Faker::Address.country
+        }
+      }
+    end
+end

data/app/controllers/home_controller.rb

@@ -9,4 +9,8 @@ class HomeController < ApplicationController
       }
     ]
   end
+
+  def rb_files
+    @value = 'value'
+  end
 end

data/app/views/benchmark/normal_html.html.erb

@@ -0,0 +1,31 @@
+<h1>Benchmark: Normal HTML (ERB)</h1>
+
+<h2>User Statistics</h2>
+<ul>
+  <li>Total Users: <%= @complex_data[:stats][:total_users] %></li>
+  <li>Average Orders per User: <%= @complex_data[:stats][:average_orders_per_user] %></li>
+  <li>Most Expensive Item: <%= @complex_data[:stats][:most_expensive_item] %></li>
+  <li>Most Popular Country: <%= @complex_data[:stats][:most_popular_country] %></li>
+</ul>
+
+<h2>User List</h2>
+<% @complex_data[:users].each do |user| %>
+  <div class="user-card">
+    <h3><%= user[:name] %></h3>
+    <p>Email: <%= user[:email] %></p>
+    <p>Address: <%= "#{user[:address][:street]}, #{user[:address][:city]}, #{user[:address][:country]}" %></p>
+
+    <h4>Orders</h4>
+    <% user[:orders].each do |order| %>
+      <div class="order">
+        <p>Order ID: <%= order[:id] %></p>
+        <p>Total: $<%= order[:total] %></p>
+        <ul>
+          <% order[:items].each do |item| %>
+            <li><%= item[:name] %> - $<%= item[:price] %> (Quantity: <%= item[:quantity] %>)</li>
+          <% end %>
+        </ul>
+      </div>
+    <% end %>
+  </div>
+<% end %>

data/app/views/benchmark/ruby_2html.html.erb

@@ -0,0 +1,35 @@
+<%=
+  html(self) do
+    h1 'Benchmark: Ruby2html'
+
+    h2 'User Statistics'
+    ul do
+      li { plain "Total Users: #{@complex_data[:stats][:total_users]}" }
+      li { plain "Average Orders per User: #{@complex_data[:stats][:average_orders_per_user]}" }
+      li { plain "Most Expensive Item: #{@complex_data[:stats][:most_expensive_item]}" }
+      li { plain "Most Popular Country: #{@complex_data[:stats][:most_popular_country]}" }
+    end
+
+    h2 'User List'
+    @complex_data[:users].each do |user|
+      div class: 'user-card' do
+        h3 user[:name]
+        p { plain "Email: #{user[:email]}" }
+        p { plain "Address: #{user[:address][:street]}, #{user[:address][:city]}, #{user[:address][:country]}" }
+
+        h4 'Orders'
+        user[:orders].each do |order|
+          div class: 'order' do
+            p { plain "Order ID: #{order[:id]}" }
+            p { plain "Total: $#{order[:total]}" }
+            ul do
+              order[:items].each do |item|
+                li { plain "#{item[:name]} - $#{item[:price]} (Quantity: #{item[:quantity]})" }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+%>

data/app/views/home/index.html.erb

@@ -5,7 +5,8 @@
 
 <%=
   html(self) do
-    h1(id: 4) { plain "ok" }
+    h1(id: 4) { "Inside" }
+    h2 "Inside 2", id: '44'
     h1 "ok"
     h1 "ok"
     h1 "ok"

data/config/routes.rb

@@ -2,6 +2,11 @@
 
 Rails.application.routes.draw do
   root to: 'home#index'
+  get '/benchmark/html', to: 'benchmark#normal_html'
+  get '/benchmark/ruby', to: 'benchmark#ruby_2html'
+
+  get '/rb_files', to: 'home#rb_files'
+
   # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
 
   # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.

data/lib/gem/ruby2html/render.rb

@@ -39,14 +39,15 @@ module Ruby2html
     end
 
     HTML5_TAGS.each do |tag|
-      define_method(tag) do |*args, &block|
-        html!(tag, *args, &block)
+      define_method(tag) do |*args, **options, &block|
+        html!(tag, *args, **options, &block)
       end
     end
 
-    def html!(name, *args, &block)
-      attributes = args.first.is_a?(Hash) ? args.shift : {}
-      content = args.first.to_s
+    def html!(name, *args, **options, &block)
+      content = args.first.is_a?(String) ? args.shift : nil
+      attributes = options
+
       tag_content = StringIO.new
       tag_content << '<'
       tag_content << name
@@ -61,10 +62,10 @@ module Ruby2html
           prev_output = @current_output
           nested_content = StringIO.new
           @current_output = nested_content
-          instance_exec(&block)
+          block_result = yield
           @current_output = prev_output
-          tag_content << nested_content.string
-        else
+          tag_content << (block_result.is_a?(String) ? escape_html(block_result) : nested_content.string)
+        elsif content
           tag_content << escape_html(content)
         end
 
@@ -105,7 +106,7 @@ module Ruby2html
         define_method(method) do |*args, &block|
           plain @context.send(method, *args, &block)
         end
-      end
+      end if defined?(ActionView)
 
       def attributes_to_s(attributes)
         return '' if attributes.empty?

data/lib/gem/ruby2html/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ruby2html
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby2html
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - sebi
@@ -37,6 +37,7 @@ files:
 - app/components/first_component.rb
 - app/components/second_component.rb
 - app/controllers/application_controller.rb
+- app/controllers/benchmark_controller.rb
 - app/controllers/concerns/.keep
 - app/controllers/home_controller.rb
 - app/helpers/application_helper.rb
@@ -44,6 +45,8 @@ files:
 - app/mailers/application_mailer.rb
 - app/models/application_record.rb
 - app/models/concerns/.keep
+- app/views/benchmark/normal_html.html.erb
+- app/views/benchmark/ruby_2html.html.erb
 - app/views/home/index.html.erb
 - app/views/layouts/application.html.erb
 - app/views/layouts/mailer.html.erb