ruby2html 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57887705c24091d9cf76d5f1b7e41da4167077c9c61b5a408756af3804e0df1b
+  data.tar.gz: e27fa7060204b4da1c95998451a186cf84492e4a896440baa9ce78eceaaf6f9c
+SHA512:
+  metadata.gz: 3267b43294cac4d37620a16076fbb97eaaf7d6e8c639b1b83e7b7657e597739617f5ee051c83a2d2394758a9ab19f0d9dd66243ad36eb2c4057308fec64d9ec2
+  data.tar.gz: 583b0c34f859915a57de3b7c1518ed7df16225eef381203c53b73fdf8664401567f564a5dd5c42b870b9b75d3c4f37f119dc7fae51b7707907ded372d97b52c7

data/.dockerignore

@@ -0,0 +1,48 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+
+# Ignore git directory.
+/.git/
+/.gitignore
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files (except templates).
+/.env*
+!/.env*.erb
+
+# Ignore all default key files.
+/config/master.key
+/config/credentials/*.key
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/.keep
+
+# Ignore assets.
+/node_modules/
+/app/assets/builds/*
+!/app/assets/builds/.keep
+/public/assets
+
+# Ignore CI service files.
+/.github
+
+# Ignore development files
+/.devcontainer
+
+# Ignore Docker-related files
+/.dockerignore
+/Dockerfile*

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format progress

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Lint/Debugger:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.3.3

data/Dockerfile

@@ -0,0 +1,71 @@
+# syntax = docker/dockerfile:1
+
+# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand:
+# docker build -t my-app .
+# docker run -d -p 80:80 -p 443:443 --name my-app -e RAILS_MASTER_KEY=<value from config/master.key> my-app
+
+# For a containerized dev environment, see Dev Containers: https://guides.rubyonrails.org/getting_started_with_devcontainer.html
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
+ARG RUBY_VERSION=3.3.3
+FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Install base packages
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl libjemalloc2 libsqlite3-0 libvips && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+# Throw-away build stage to reduce size of final image
+FROM base AS build
+
+# Install packages needed to build gems
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git pkg-config && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
+    bundle exec bootsnap precompile --gemfile
+
+# Copy application code
+COPY . .
+
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+
+
+
+# Final stage for app image
+FROM base
+
+# Copy built artifacts: gems, application
+COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN groupadd --system --gid 1000 rails && \
+    useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
+    chown -R rails:rails db log storage tmp
+USER 1000:1000
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

data/README.md

@@ -0,0 +1,264 @@
+# Ruby2html 🔮✨
+
+Transform your Ruby code into beautiful, structured HTML with ease! 🚀
+
+## 🌟 What is Ruby2html?
+
+Ruby2html is a magical gem that allows you to write your views in pure Ruby and automatically converts them into clean, well-formatted HTML. Say goodbye to messy ERB templates and hello to the full power of Ruby in your views! 🎉
+
+## 🚀 Installation
+
+Add this line to your application's Gemfile:
+
+
+```ruby
+gem 'ruby2html'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby2html
+
+## 🎨 Usage
+
+### In your ApplicationController
+
+File: `app/controllers/application_controller.rb`
+
+```ruby
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+  include Ruby2html::RailsHelper
+end
+```
+
+### In your views
+
+File: `app/views/your_view.html.erb`
+
+Replace your ERB with beautiful Ruby code:
+
+```erb
+<%=
+  html(self) do
+    h1 class: 'main-title', 'data-controller': 'welcome' do
+      "Welcome to Ruby2html! 🎉"
+    end
+    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]
+      end
+      p class: 'item-description' do
+        plain item[:description]
+      end
+    end
+
+    render partial: 'shared/navbar'
+  end
+%>
+```
+
+### 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.
+
+File: `app/components/application_component.rb`
+
+```ruby
+# frozen_string_literal: true
+
+class ApplicationComponent < ViewComponent::Base
+  include Ruby2html::ComponentHelper
+end
+```
+
+#### Option 1: Using `call` method with Ruby2html
+
+File: `app/components/greeting_component.rb`
+
+```ruby
+# frozen_string_literal: true
+
+class GreetingComponent < ApplicationComponent
+  def initialize(name)
+    @name = name
+  end
+
+  def call
+    html(self) do
+      h1 class: 'greeting', 'data-user': @name do
+        plain "Hello, #{@name}! 👋"
+      end
+      p class: 'welcome-message' do
+        plain 'Welcome to the wonderful world of Ruby2html!'
+      end
+    end
+  end
+end
+```
+
+#### Option 2: Using traditional ERB template
+
+File: `app/components/farewell_component.rb`
+
+```ruby
+# frozen_string_literal: true
+
+class FarewellComponent < ApplicationComponent
+  def initialize(name)
+    @name = name
+  end
+end
+```
+
+File: `app/components/farewell_component.html.erb`
+
+```erb
+<div class="farewell">
+  <h2>Goodbye, <%= @name %>! 👋</h2>
+  <p>We hope you enjoyed using Ruby2html!</p>
+
+  <%=
+    html do
+      link_to 'Home', root_path, class: 'btn btn-primary', 'data-turbo': false
+    end
+  %>
+</div>
+```
+
+This flexibility allows you to:
+- Use Ruby2html syntax for new components or when refactoring existing ones
+- Keep using familiar ERB templates where preferred
+- Mix and match approaches within your application as needed
+
+### More Component Examples
+
+File: `app/components/first_component.rb`
+
+```ruby
+# frozen_string_literal: true
+
+class FirstComponent < ApplicationComponent
+  def initialize
+    @item = 'Hello, World!'
+  end
+
+  def call
+    html(self) do
+      h1 id: 'first-component-title' do
+        plain 'first component'
+      end
+      div class: 'content-wrapper' do
+        h2 'A subheading'
+      end
+      p class: 'greeting-text', 'data-testid': 'greeting' do
+        plain @item
+      end
+    end
+  end
+end
+```
+
+File: `app/components/second_component.rb`
+
+```ruby
+# frozen_string_literal: true
+
+class SecondComponent < ApplicationComponent
+  def call
+    html(self) do
+      h1 class: 'my-class', id: 'second-component-title', 'data-controller': 'second' do
+        plain 'second component'
+      end
+      link_to 'Home', root_path, class: 'nav-link', 'data-turbo-frame': false
+    end
+  end
+end
+```
+
+## Without Rails
+```ruby
+html = Ruby2html::Render.new(nil) do # nil is the context, you can use self or any other object
+  html do
+    h1 'Hello, World!'
+  end
+end
+
+puts html.render
+```
+
+## 🐢 Gradual Adoption
+
+One of the best features of Ruby2html is that you don't need to rewrite all your views at once! You can adopt it gradually, mixing Ruby2html with your existing ERB templates. This allows for a smooth transition at your own pace.
+
+### Mixed usage example
+
+File: `app/views/your_mixed_view.html.erb`
+
+```erb
+<h1>Welcome to our gradually evolving page!</h1>
+
+<%= render partial: 'legacy_erb_partial' %>
+
+<%=
+  html(self) do
+    div class: 'ruby2html-section' do
+      h2 "This section is powered by Ruby2html!"
+      p "Isn't it beautiful? 😍"
+    end
+  end
+%>
+
+<%= render ModernComponent.new %>
+
+<footer>
+  <!-- More legacy ERB code -->
+</footer>
+```
+
+In this example, you can see how Ruby2html seamlessly integrates with existing ERB code. This approach allows you to:
+
+- Keep your existing ERB templates and partials
+- Gradually introduce Ruby2html in specific sections
+- Use Ruby2html in new components while maintaining older ones
+- Refactor your views at your own pace
+
+Remember, there's no rush! You can keep your `.erb` files and Ruby2html code side by side until you're ready to fully transition. This flexibility ensures that adopting Ruby2html won't disrupt your existing workflow or require a massive rewrite of your application. 🌈
+
+## 🛠 Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sebyx07/ruby2html. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sebyx07/ruby2html/blob/master/CODE_OF_CONDUCT.md).
+
+## 📜 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 🌈 Code of Conduct
+
+Everyone interacting in the Ruby2html project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sebyx07/ruby2html/blob/master/CODE_OF_CONDUCT.md).
+
+## 🌟 Features
+
+- Write views in pure Ruby 💎
+- Seamless Rails integration 🛤️
+- ViewComponent support with flexible template options 🧩
+- Automatic HTML beautification 💅
+- Easy addition of custom attributes and data attributes 🏷️
+- Gradual adoption - mix with existing ERB templates 🐢
+- Improved readability and maintainability 📚
+- Full access to Ruby's power in your views 💪
+
+Start writing your views in Ruby today and experience the magic of Ruby2html! ✨🔮

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/app/channels/application_cable/connection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/app/components/application_component.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationComponent < ViewComponent::Base
+  include Ruby2html::ComponentHelper
+end

data/app/components/first_component.html.erb

@@ -0,0 +1,9 @@
+<%= html(self) do
+  h1 "first component"
+
+  div do
+    h2 "A subheading"
+  end
+
+  p @item
+end %>

data/app/components/first_component.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FirstComponent < ApplicationComponent
+  def initialize
+    @item = 'Hello, World!'
+  end
+end

data/app/components/second_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class SecondComponent < ApplicationComponent
+  def call
+    html(self) do
+      h1 class: 'my-class' do
+        plain 'Second Component'
+      end
+      link_to 'Home', root_path
+    end
+  end
+end

data/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+  # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has.
+  allow_browser versions: :modern
+  include Ruby2html::RailsHelper
+end

data/app/controllers/home_controller.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class HomeController < ApplicationController
+  def index
+    @items = [
+      {
+        title: 'Item 1',
+        description: 'Description 1'
+      }
+    ]
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module ApplicationHelper
+end

data/app/jobs/application_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/app/mailers/application_mailer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/app/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

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

@@ -0,0 +1,36 @@
+<h1>Home</h1>
+
+<%= render FirstComponent.new %>
+<%= render SecondComponent.new %>
+
+<%=
+  html(self) do
+    h1(id: 4) { plain "ok" }
+    h1 "ok"
+    h1 "ok"
+    h1 "ok"
+    h1 "ok"
+    h1 "ok"
+    div do
+      link_to 'home', root_path
+    end
+    link_to 'home', root_path
+    link_to 'home', root_path
+
+    render partial: 'shared/navbar'
+
+    @items.each do |item|
+      h1 item[:title]
+    end
+  end
+%>
+
+<%= render partial: 'shared/navbar' %>
+
+<%=
+  html(self) do
+    @items.each do |item|
+      h1 item[:title]
+    end
+  end
+%>

data/app/views/layouts/application.html.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= content_for(:title) || "Ruby2html" %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= yield :head %>
+
+    <link rel="manifest" href="/manifest.json">
+    <link rel="icon" href="/icon.png" type="image/png">
+    <link rel="icon" href="/icon.svg" type="image/svg+xml">
+    <link rel="apple-touch-icon" href="/icon.png">
+    <%= stylesheet_link_tag "application" %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/app/views/pwa/manifest.json.erb

@@ -0,0 +1,22 @@
+{
+  "name": "Ruby2html",
+  "icons": [
+    {
+      "src": "/icon.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    },
+    {
+      "src": "/icon.png",
+      "type": "image/png",
+      "sizes": "512x512",
+      "purpose": "maskable"
+    }
+  ],
+  "start_url": "/",
+  "display": "standalone",
+  "scope": "/",
+  "description": "Ruby2html.",
+  "theme_color": "red",
+  "background_color": "red"
+}