herb 0.8.10 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99c86daa1824a8c955a69c6015f8930c49b43b3e4333cb4c16b30d62b0e9ba58
-  data.tar.gz: 8e71055933851fa346707121e806e85b59a62d4ef00a9e6c4e7014c26859cca1
+  metadata.gz: 10b9ca3614ee3b23c37caf0f7d7363a434c15a39b27e3dc8c83023ec4f0587b1
+  data.tar.gz: 4be0d44ce17912901556481b7fb21ee18c5f7b71165c98f4e2cee6961614c626
 SHA512:
-  metadata.gz: 50134d7481f2d8bb436d9115d95e58af534a7be1ee4c24e5e193b738d32f605b4e767a49bec3b87b10956faaf1f7128c666e5db81dd4221ef163aa2e0857b505
-  data.tar.gz: 551022b3dd92e528d541696b829690bad55e749d2cff7993912cba3539b495266a8ee284cc2845c6d2c435eb029668bef9c8f699730270df0373ea5e0f8136b4
+  metadata.gz: '00879b8718267317125d050da50cc6423f33e1765c236c470c5ea5ff1da8e8ad57b1c0c35a8d7a3a4b75200f3f00beacfbc17d14b6d44886cdf8b5e67ac033f0'
+  data.tar.gz: b7f7583d3dd1cce9bf9021cc8a33d1936bab1e3e1cd681d77bf6e4f4d9e6be25b332b742ad9c1e5c079f13f363d3a21a3188affbac96f84a77f4160cbb9498a2

data/Makefile

@@ -1,8 +1,8 @@
 exec = herb
 test_exec = run_herb_tests
 
-sources = $(wildcard src/*.c) $(wildcard src/**/*.c)
-headers = $(wildcard src/*.h) $(wildcard src/**/*.h)
+sources = $(shell find src -name '*.c')
+headers = $(shell find src -name '*.h')
 objects = $(sources:.c=.o)
 
 extension_sources = $(wildcard ext/**/*.c)
@@ -20,6 +20,9 @@ test_sources = $(wildcard test/**/*.c)
 test_objects = $(test_sources:.c=.o)
 non_main_objects = $(filter-out src/main.o, $(objects))
 
+bench_allocs_exec = bench_allocs
+bench_allocs_source = bench/bench_allocs.c
+
 soext ?= $(shell ruby -e 'puts RbConfig::CONFIG["DLEXT"]')
 lib_name = $(build_dir)/lib$(exec).$(soext)
 static_lib_name = $(build_dir)/lib$(exec).a
@@ -102,9 +105,14 @@ test/%.o: test/%.c templates prism
 test: $(test_objects) $(non_main_objects)
 	$(cc) $(test_objects) $(non_main_objects) $(test_cflags) $(test_ldflags) -o $(test_exec)
 
+.PHONY: bench_allocs
+bench_allocs: $(non_main_objects)
+	$(cc) $(bench_allocs_source) $(non_main_objects) $(flags) $(prism_ldflags) -o $(bench_allocs_exec)
+	./$(bench_allocs_exec)
+
 .PHONY: clean
 clean:
-	rm -f $(exec) $(test_exec) $(lib_name) $(shared_lib_name) $(ruby_extension)
+	rm -f $(exec) $(test_exec) $(bench_allocs_exec) $(lib_name) $(shared_lib_name) $(ruby_extension)
 	rm -rf $(objects) $(test_objects) $(extension_objects) lib/herb/*.bundle tmp
 	rm -rf $(prism_path)
 	rake prism:clean

data/README.md

@@ -1,12 +1,12 @@
 <div align="center">
-  <img alt="Herb HTML+ERB parser" style="height: 256px" height="256px" src="https://github.com/user-attachments/assets/d0714ee1-ca33-4aa4-aaa9-d632ba79d54a">
+  <img alt="Herb HTML+ERB Toolchain" style="height: 256px" height="256px" src="https://github.com/user-attachments/assets/d0714ee1-ca33-4aa4-aaa9-d632ba79d54a">
 </div>
 
 <h2 align="center">Herb</h2>
 
-<h4 align="center">HTML+ERB (HTML + Embedded Ruby)</h4>
+<h4 align="center">The modern HTML+ERB Toolchain</h4>
 
-<div align="center">Powerful and seamless HTML-aware ERB parsing and tooling.</div><br/>
+<div align="center">An ecosystem of powerful and seamless developer tools for HTML+ERB (HTML + Embedded Ruby) templates.</div><br/>
 
 <p align="center">
   <a href="https://rubygems.org/gems/herb"><img alt="Gem Version" src="https://img.shields.io/gem/v/herb"></a>
@@ -25,36 +25,53 @@
 
 ## What is Herb?
 
-**Herb** is an ecosystem of developer tooling built specifically around **HTML+ERB** (`.html.erb`) files. It is designed to simplify and enhance the experience of working with HTML+ERB templates through precise, accurate tooling.
+**Herb** is a powerful and seamless HTML-aware ERB toolchain and an ecosystem of developer tools built specifically for **HTML+ERB** (`.html.erb`) files. It is designed to simplify and enhance the experience of working with HTML+ERB templates through precise, accurate tooling.
 
-At the core of Herb is the **Herb Parser**, a fast, portable, and HTML-aware ERB parser written in C. The parser generates a detailed, accurate syntax tree that serves as the foundation for reliable code analysis, transformations, and developer tooling.
+**Parser**
 
-The Herb ecosystem includes **developer tools** (CLI, language server, formatter, linter), **language bindings** (for Ruby, Node.js, and the Browser using WebAssembly), and **utility libraries** (language service, highlighter, minifier, printer). All these components leverage the Herb Parser's syntax tree to provide consistent, accurate, and helpful tooling experiences.
+At the core of the Herb ecosystem is the **Herb Parser**, a fast, portable, and HTML-aware ERB parser written in C. The parser generates a detailed, accurate syntax tree that serves as the foundation for reliable code analysis, transformations, and developer tooling.
 
-## What Herb Can Do for You
+**Toolchain**
 
-Herb provides a complete ecosystem of HTML+ERB tooling, designed to simplify and enhance your daily workflow. Built on the **Herb Parser**, it offers multiple tools that integrate seamlessly into editors, developer environments, and CI pipelines:
+The Herb toolchain includes **developer tools** (CLI, language server, formatter, linter, browser dev tools), **language bindings** (for Ruby, Node.js, Java, Rust, and the Browser using WebAssembly), and **utility libraries** (language service, highlighter, minifier, printer).
 
-- **Herb Language Server** ([available now](https://herb-tools.dev/projects/language-server)):
-  Rich integration for editors like VS Code, Zed, Neovim, and more. It provides diagnostics and real-time feedback to keep your templates error-free.
+All these components leverage the Herb Parser's syntax tree to provide consistent, accurate, and helpful tooling experiences.
 
-- **Herb Formatter** ([experimental preview](https://herb-tools.dev/projects/formatter)):
-  Automatic, consistent formatting for HTML+ERB files, reducing manual styling and enforcing a standard across projects. Currently in experimental preview - use with caution on version-controlled files.
+**Engine**
 
-- **Herb Linter** ([available now](https://herb-tools.dev/projects/linter)):  
-  Static analysis for your HTML+ERB templates to enforce best practices and quickly identify common mistakes with plenty of rules.
+`Herb::Engine` is a new, HTML-aware ERB rendering engine built on the Herb Parser. It is designed to be API-compatible with [`Erubi::Engine`](https://github.com/jeremyevans/erubi) while adding structural awareness of HTML+ERB content, enabling features like HTML validation, security checks, and precise error reporting.
 
-You can use Herb programmatically in **Ruby**, as well as in **JavaScript** via Node.js, WebAssembly, or directly in browsers.
+The Engine powers **ReActionView** and lays the foundation for a modern view layer for Rails and other Ruby web frameworks.
+
+| **[ReActionView](https://reactionview.dev)** <br> 🌱 A new ActionView-compatible ERB engine with modern DX, re-imagined with `Herb::Engine`. |
+| --- |
+| [GitHub](https://github.com/marcoroth/reactionview) · [Website](https://reactionview.dev) · [Documentation](https://reactionview.dev/overview) |
+
+## Ecosystem
+
+The Herb ecosystem offers multiple tools that integrate seamlessly into editors, developer environments, and CI pipelines:
+
+| Tool | Description |
+| --- | --- |
+| [Herb Parser](https://herb-tools.dev/projects/parser) | Fast, portable, HTML-aware ERB parser written in C. |
+| [Herb Linter](https://herb-tools.dev/projects/linter) | Static analysis to enforce best practices and identify common mistakes. |
+| [Herb Formatter](https://herb-tools.dev/projects/formatter) | Automatic, consistent formatting for HTML+ERB files. *(experimental)* |
+| [Herb Language Server](https://herb-tools.dev/projects/language-server) | Rich editor integration for VS Code, Zed, Neovim, and more. |
+| [Herb Engine](https://herb-tools.dev/projects/engine) | HTML-aware ERB rendering engine, API-compatible with Erubi. |
+| [Herb Dev Tools](https://herb-tools.dev/projects/dev-tools) | In-browser dev tools for inspecting and debugging templates, shipped with ReActionView. |
+| [ReActionView](https://reactionview.dev) | ActionView-compatible ERB engine with modern DX for Rails. |
+
+You can use the Herb Parser programmatically in **Ruby**, **Java**, **Rust**, as well as in **JavaScript** via Node.js, WebAssembly, or directly in browsers.
 
 For a complete overview of all available tools, libraries, and integrations, visit the [**Projects page**](https://herb-tools.dev/projects) on our documentation site.
 
 ## Motivation
 
-HTML+ERB templates never really had good, accurate, and reliable tooling. While developer tooling for Ruby code improved significantly in the last few years (especially with the introduction of the new Prism parser), HTML+ERB files remained underserved, lacking fundamental support like syntax checking, auto-formatting, linting, and structural understanding.
+HTML+ERB templates never really had good, accurate, and reliable tooling. While developer tooling for Ruby code improved significantly in the last few years (especially with the introduction of the new [Prism parser](https://github.com/ruby/prism)), HTML+ERB files remained underserved, lacking fundamental support like syntax checking, auto-formatting, linting, and structural understanding.
 
 At the same time, with the rise of tools like [Hotwire](https://hotwired.dev), [Stimulus](https://stimulus.hotwired.dev), [Turbo](https://turbo.hotwired.dev), [HTMX](https://htmx.org), [Unpoly](https://unpoly.com), and [Alpine.js](https://alpinejs.dev), advanced HTML templating became increasingly relevant (again). Developers expect modern, reliable, and precise tooling, especially given the robust ecosystem available to JavaScript frameworks and libraries.
 
-Herb was built to close this tooling gap, providing proper tooling for HTML+ERB that matches what modern developers expect in the age of language servers, LLMs, and AI-driven workflows.
+Herb was built to close this tooling gap with an HTML-aware approach, understanding both HTML structure and ERB as first-class citizens, to provide the kind of tooling modern developers expect in the age of language servers, LLMs, and AI-driven workflows.
 
 ## Command-Line Usage
 
@@ -64,6 +81,20 @@ Install the Herb gem via RubyGems:
 gem install herb
 ```
 
+### Installing from a Git branch
+
+To test a branch before it's released (e.g. from a fork), add both `prism` and `herb` to your Gemfile:
+
+```ruby
+gem "prism", github: "ruby/prism", tag: "v1.9.0"
+gem "herb", github: "fork/herb", branch: "my-branch"
+```
+
+The `prism` gem is required because Herb's native C extension compiles against
+Prism's C source, which is vendored automatically during installation.
+
+For detailed information, like how you can use Herb programmatically in Ruby and JavaScript, visit the [documentation site](https://herb-tools.dev/bindings/ruby/reference).
+
 Basic usage to analyze all HTML+ERB files in your project:
 
 ```sh
@@ -86,30 +117,29 @@ Files with parse errors:
 Results saved to 2025-06-29_12-16-23_erb_parsing_result_rubyevents.log
 ```
 
-Herb also comes with other useful commands:
+Lint your HTML+ERB templates:
 
+```sh
+npx @herb-tools/linter
 ```
-Herb 🌿 Powerful and seamless HTML-aware ERB parsing and tooling.
-
-Usage:
-  bundle exec herb [command] [options]
-
-Commands:
-  bundle exec herb lex [file]         Lex a file.
-  bundle exec herb parse [file]       Parse a file.
-  bundle exec herb analyze [path]     Analyze a project by passing a directory to the root of the project
-  bundle exec herb ruby [file]        Extract Ruby from a file.
-  bundle exec herb html [file]        Extract HTML from a file.
-  bundle exec herb playground [file]  Open the content of the source file in the playground
-  bundle exec herb version            Prints the versions of the Herb gem and the libherb library.
+
+Format your HTML+ERB templates:
+
+```sh
+npx @herb-tools/formatter
 ```
 
-For detailed information, like how you can use Herb programmatically in Ruby and JavaScript, visit the [documentation site](https://herb-tools.dev/bindings/ruby/reference).
 
 
-## Background and Talk
+## Background and Talks
+
+The **Herb Parser** was first introduced at [**RubyKaigi 2025**](https://rubykaigi.org/2025/presentations/marcoroth.html) in April 2025 with the talk [*Empowering Developers with HTML-Aware ERB Tooling*](https://www.rubyevents.org/talks/empowering-developers-with-html-aware-erb-tooling-rubykaigi-2025).
+
+At [**RailsConf 2025**](https://www.rubyevents.org/events/railsconf-2025) in July 2025, the Herb ecosystem was expanded with the talk [*The Modern View Layer Rails Deserves: A Vision for 2025 and Beyond*](https://www.rubyevents.org/talks/the-modern-view-layer-rails-deserves-a-vision-for-2025-and-beyond), introducing the linter, formatter, language server, and the vision for ReActionView.
+
+At [**Rails World 2025**](https://www.rubyevents.org/events/rails-world-2025) in September 2025, `Herb::Engine`, ReActionView, and the visual dev tools were launched with the talk [*Introducing ReActionView: An ActionView-Compatible ERB Engine*](https://www.rubyevents.org/talks/introducing-reactionview-an-actionview-compatible-erb-engine).
 
-**Herb** was first introduced at [**RubyKaigi 2025**](https://rubykaigi.org/2025/presentations/marcoroth.html) in April 2025 with the talk [*Empowering Developers with HTML-Aware ERB Tooling*](https://www.rubyevents.org/talks/empowering-developers-with-html-aware-erb-tooling-rubykaigi-2025).
+At [**San Francisco Ruby Conference 2025**](https://www.rubyevents.org/events/sfruby-2025) in November 2025, the keynote [*Herb to ReActionView: A New Foundation for the View Layer*](https://www.rubyevents.org/talks/keynote-herb-to-reactionview-a-new-foundation-for-the-view-layer) gave an overview of how Herb came to be, what Herb can do for you today, and how it could enable the next generation of the Rails view layer with ReActionView.
 
 ## Contributing
 

data/Rakefile

@@ -5,6 +5,34 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"].exclude("test/engine/**/*_test.rb", "test/integration/**/*_test.rb")
+end
+
+task :test_tip do
+  puts "TIP: This only runs core tests. Other test tasks available:"
+  puts "  rake test:all"
+  puts "  rake test:engine"
+  puts "  rake test:integration"
+  puts
+end
+
+Rake::Task[:test].enhance([:test_tip])
+
+Rake::TestTask.new("test:engine") do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/engine/**/*_test.rb"]
+end
+
+Rake::TestTask.new("test:integration") do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/integration/**/*_test.rb"]
+end
+
+Rake::TestTask.new("test:all") do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
@@ -22,17 +50,17 @@ end
 begin
   require "rake/extensiontask"
 
-  PLATFORMS = %w[
-    aarch64-linux-gnu
-    aarch64-linux-musl
-    arm-linux-gnu
-    arm-linux-musl
-    arm64-darwin
-    x86_64-darwin
-    x86_64-linux-gnu
-    x86_64-linux-musl
-    x86-linux-gnu
-    x86-linux-musl
+  PLATFORMS = [
+    "aarch64-linux-gnu",
+    "aarch64-linux-musl",
+    "arm-linux-gnu",
+    "arm-linux-musl",
+    "arm64-darwin",
+    "x86_64-darwin",
+    "x86_64-linux-gnu",
+    "x86_64-linux-musl",
+    "x86-linux-gnu",
+    "x86-linux-musl"
   ].freeze
 
   exttask = Rake::ExtensionTask.new do |ext|
@@ -121,55 +149,35 @@ end
 
 desc "Render out template files"
 task :templates do
-  require_relative "templates/template"
+  require_relative "lib/herb/bootstrap"
 
-  Dir.glob("#{__dir__}/templates/**/*.erb").each do |template|
-    Herb::Template.render(template)
-  end
+  Herb::Bootstrap.generate_templates
 end
 
-prism_vendor_path = "vendor/prism"
-
 namespace :prism do
   desc "Setup and vendor Prism"
   task :vendor do
+    require_relative "lib/herb/bootstrap"
+
     Rake::Task["prism:clean"].execute
 
     prism_bundle_path = `bundle show prism`.chomp
 
-    puts prism_bundle_path
-
     if prism_bundle_path.empty?
       puts "Make sure to run `bundle install` in the herb project directory first"
       exit 1
     end
 
-    FileUtils.mkdir_p(prism_vendor_path)
-
-    files = [
-      "config.yml",
-      "Rakefile",
-      "src/",
-      "include/",
-      "templates/"
-    ]
-
-    files.each do |file|
-      vendored_file_path = prism_vendor_path + "/#{file}"
-      puts "Vendoring '#{file}' Prism file to #{vendored_file_path}"
-      FileUtils.cp_r(prism_bundle_path + "/#{file}", prism_vendor_path)
-    end
-
-    prism_ast_header = "#{prism_vendor_path}/include/prism/ast.h"
+    puts prism_bundle_path
 
-    unless File.exist?(prism_ast_header)
-      puts "Generating Prism template files..."
-      system("ruby #{prism_vendor_path}/templates/template.rb", exception: true)
-    end
+    Herb::Bootstrap.vendor_prism(prism_gem_path: prism_bundle_path)
   end
 
   desc "Clean vendored Prism in vendor/prism/"
   task :clean do
+    require_relative "lib/herb/bootstrap"
+
+    prism_vendor_path = Herb::Bootstrap::PRISM_VENDOR_DIR
     puts "Cleaning up vendored Prism at #{prism_vendor_path}..."
     begin
       FileUtils.rm_r(prism_vendor_path)