erb 5.0.2 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd7e6b214a06aba5808f5137a14e9c79edc9d4b903e6a2c2bced832d1c30aaf7
-  data.tar.gz: 45213b43da5c2ee0dc330a6514d43b8a9192d5c404ef57ae72cdedba55ae94e5
+  metadata.gz: 5ab026054417af85a9a1ed3b4c13baf164c372ad658eca2e3268b9a2274ac7bc
+  data.tar.gz: fa4a74443e4fc60595fe1866156bd9f1cafe8af1af87855d4cd0ff26d505152a
 SHA512:
-  metadata.gz: 8617e29b0c2ddb43483ec2b1c31d0edd2f84da054507a0a4216c9a1ef389ac924e8416e214103f98d6e36e9cc7e1e840867e569c4dec07a26180e7d51290b5d2
-  data.tar.gz: ba3620ef2aeb6932f31b3f2dadc95d942c66a2ad3bd5d02307ad62ee80770d10479ce0485d19798f6f71a6ec9d40fee95e3bdb3a8bf24ae78d4e6a4c40256778
+  metadata.gz: 88e13e5d324d17e53d22aa6e2ca8aeb40499d91b43d5773e3717442dff92555d0af8feb17ea3010f299f11e738bacd1f110db3e5020a3fc90b3cdf593681722c
+  data.tar.gz: 3873dec50bbb24b9701a7f0728e7b82680dc3971252a8b35216d17a75d8c8887d4747acdf914a8707897824d2e6eb9efaaf2ecd970cd5162e846755d4dfb22fe

data/.github/dependabot.yml

@@ -3,4 +3,4 @@ updates:
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:
-      interval: 'weekly'
+      interval: 'monthly'

data/.github/workflows/dependabot_automerge.yml

@@ -0,0 +1,30 @@
+name: Dependabot auto-merge
+on:
+  pull_request:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]' && github.repository == 'ruby/erb'
+    steps:
+      - name: Dependabot metadata
+        uses: dependabot/fetch-metadata@v2
+        id: metadata
+
+      - name: Wait for status checks
+        uses: lewagon/wait-on-check-action@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          check-regexp: 'build \(.*\)'
+          wait-interval: 30
+
+      - name: Auto-merge for Dependabot PRs
+        run: gh pr merge --auto --rebase "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.MATZBOT_DEPENDABOT_MERGE_TOKEN }}

data/.github/workflows/push-gem.yml

@@ -0,0 +1,51 @@
+name: Publish gem to rubygems.org
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository_owner == 'ruby'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ruby, jruby]
+      fail-fast: false
+
+    environment:
+      name: rubygems.org
+      url: https://rubygems.org/gems/erb
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@d5126b9b3579e429dd52e51e68624dda2e05be25 # v1.267.0
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Publish to RubyGems
+        uses: rubygems/release-gem@1c162a739e8b4cb21a676e97b087e8268d8fc40b # v1.1.2
+
+      - name: Create GitHub release
+        run: |
+          tag_name="$(git describe --tags --abbrev=0)"
+          gh release create "${tag_name}" --verify-tag --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: ${{ matrix.ruby == 'ruby' }}

data/.github/workflows/sync-ruby.yml

@@ -0,0 +1,33 @@
+name: Sync ruby
+on:
+  push:
+    branches: [master]
+jobs:
+  sync:
+    name: Sync ruby
+    runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'ruby' }}
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Create GitHub App token
+        id: app-token
+        uses: actions/create-github-app-token@v2
+        with:
+          app-id: 2060836
+          private-key: ${{ secrets.RUBY_SYNC_DEFAULT_GEMS_PRIVATE_KEY }}
+          owner: ruby
+          repositories: ruby
+
+      - name: Sync to ruby/ruby
+        uses: convictional/trigger-workflow-and-wait@v1.6.5
+        with:
+          owner: ruby
+          repo: ruby
+          workflow_file_name: sync_default_gems.yml
+          github_token: ${{ steps.app-token.outputs.token }}
+          ref: master
+          client_payload: |
+            {"gem":"${{ github.event.repository.name }}","before":"${{ github.event.before }}","after":"${{ github.event.after }}"}
+          propagate_failure: true
+          wait_interval: 10

data/.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -31,3 +31,6 @@ jobs:
         bundler-cache: true
     - name: Run test
       run: bundle exec rake test
+    - name: RDoc coverage
+      run: |
+        rdoc -C --visibility=private .

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 group :development do
   gem 'rake'
   gem 'rake-compiler'
+  gem 'rdoc'
   gem 'test-unit'
   gem "test-unit-ruby-core"
 end

data/NEWS.md

@@ -1,4 +1,33 @@
-# Change Log
+# Changelog
+
+## 6.0.1
+
+* Freeze `ERB::Compiler::TrimScanner::ERB_STAG` for Ractor compatibility
+
+## 6.0.0
+
+* Remove `safe_level` and further positional arguments from `ERB.new`
+* Remove deprecated constant `ERB::Revision`
+
+## 5.1.3
+
+* Release v5.1.2 with trusted publishing for JRuby
+
+## 5.1.2
+
+* Add `changelog_uri` to spec metadata https://github.com/ruby/erb/pull/89
+
+## 5.1.1
+
+* Fix integer overflow that is introduced at v5.1.0
+
+## 5.1.0
+
+*  html_escape: Avoid buffer allocation for strings with no escapable character https://github.com/ruby/erb/pull/87
+
+## 5.0.3
+
+* Update help of erb(1) [#85](https://github.com/ruby/erb/pull/85)
 
 ## 5.0.2
 

data/README.md

@@ -1,255 +1,98 @@
-# ERB
+# ERB (Embedded Ruby)
 
-An easy to use but powerful templating system for Ruby.
+ERB is an easy-to-use, but also very powerful, [template processor][template processor].
 
-## Introduction
+ERB is commonly used to produce:
 
-ERB provides an easy to use but powerful templating system for Ruby.  Using
-ERB, actual Ruby code can be added to any plain text document for the
-purposes of generating document information details and/or flow control.
+- Customized or personalized email messages.
+- Customized or personalized web pages.
+- Software code (in code-generating applications).
 
-A very simple example is this:
+Like method [sprintf][sprintf], ERB can format run-time data into a string.
+ERB, however, is *much more powerful*
 
-```rb
-require 'erb'
+## How ERB Works
 
-x = 42
-template = ERB.new <<-EOF
-  The value of x is: <%= x %>
-EOF
-puts template.result(binding)
-```
+Using ERB, you can create a *template*: a plain-text string that has specially-formatted *tags*,
+then store it into an ERB object;
+when ERB produces _result_ string, it:
 
-Prints: `The value of x is: 42`
+- Inserts run-time-evaluated expressions into the result.
+- Executes snippets of Ruby code.
+- Omits comments from the results.
 
-More complex examples are given below.
+In the result:
 
-## Recognized Tags
+- All non-tag text is passed through, _unchanged_.
+- Each tag is either _replaced_ (expression tag),
+  or _omitted_ entirely (execution tag or comment tag).
 
-ERB recognizes certain tags in the provided template and converts them based
-on the rules below:
+There are three types of tags:
 
-```erb
-<% Ruby code -- inline with output %>
-<%= Ruby expression -- replace with result %>
-<%# comment -- ignored -- useful in testing %> (`<% #` doesn't work. Don't use Ruby comments.)
-% a line of Ruby code -- treated as <% line %> (optional -- see ERB.new)
-%% replaced with % if first thing on a line and % processing is used
-<%% or %%> -- replace with <% or %> respectively
-```
+| Tag            |                 Form                 |                Action                 |    Text in Result    |
+|----------------|:------------------------------------:|:-------------------------------------:|:--------------------:|
+| Expression tag | <tt>'<%= _ruby_expression_ %>'</tt>  | Evaluates <tt>_ruby_expression_</tt>. | Value of expression. |       
+| Execution tag  |     <tt>'<% _ruby_code_ %>'</tt>     |     Execute <tt>_ruby_code_</tt>.     |        None.         |                 
+| Comment tag    |   <tt>'<%# _comment_text_ %>'</tt>   |                 None.                 |        None.         |
 
-All other text is passed through ERB filtering unchanged.
+These examples use `erb`, the ERB command-line interface;
+each "echoes" a string template and pipes it to `erb` as input:
 
-## Options
 
-There are several settings you can change when you use ERB:
-* the nature of the tags that are recognized;
-* the binding used to resolve local variables in the template.
+- Expression tag:
 
-See the ERB.new and ERB#result methods for more detail.
+        $ echo "<%= $VERBOSE %>" | erb
+        "false"
+        $ echo "<%= 2 + 2 %>" | erb
+        "4"
 
-## Character encodings
+- Execution tag:
 
-ERB (or Ruby code generated by ERB) returns a string in the same
-character encoding as the input string.  When the input string has
-a magic comment, however, it returns a string in the encoding specified
-by the magic comment.
+        echo "<% if $VERBOSE %> Long message. <% else %> Short message. <% end %>" | erb
+        " Short message. "
 
-```rb
-# -*- coding: utf-8 -*-
-require 'erb'
+- Comment tag:
 
-template = ERB.new <<EOF
-<%#-*- coding: Big5 -*-%>
-  __ENCODING__ is <%= __ENCODING__ %>.
-EOF
-puts template.result
-```
+        echo "<%# TODO: Fix this nonsense. %> Nonsense." | erb
+        " Nonsense."
 
-Prints: `__ENCODING__ is Big5.`
+## How to Use ERB
 
-## Examples
+You can use ERB either:
 
-### Plain Text
+- In a program: see class ERB.
+- From the command line: see [ERB Executable][erb executable].
 
-ERB is useful for any generic templating situation.  Note that in this example, we use the
-convenient "% at start of line" tag, and we quote the template literally with
-`%q{...}` to avoid trouble with the backslash.
+## Installation
 
-```rb
-require "erb"
+ERB is installed with Ruby, and so there's no further installation needed.
 
-# Create template.
-template = %q{
-  From:  James Edward Gray II <james@grayproductions.net>
-  To:  <%= to %>
-  Subject:  Addressing Needs
+## Other Template Engines
 
-  <%= to[/\w+/] %>:
-
-  Just wanted to send a quick note assuring that your needs are being
-  addressed.
-
-  I want you to know that my team will keep working on the issues,
-  especially:
-
-  <%# ignore numerous minor requests -- focus on priorities %>
-  % priorities.each do |priority|
-    * <%= priority %>
-  % end
-
-  Thanks for your patience.
-
-  James Edward Gray II
-}.gsub(/^  /, '')
-
-message = ERB.new(template, trim_mode: "%<>")
-
-# Set up template data.
-to = "Community Spokesman <spokesman@ruby_community.org>"
-priorities = [ "Run Ruby Quiz",
-               "Document Modules",
-               "Answer Questions on Ruby Talk" ]
-
-# Produce result.
-email = message.result
-puts email
-```
-
-Generates:
-
-```
-From:  James Edward Gray II <james@grayproductions.net>
-To:  Community Spokesman <spokesman@ruby_community.org>
-Subject:  Addressing Needs
-
-Community:
-
-Just wanted to send a quick note assuring that your needs are being addressed.
-
-I want you to know that my team will keep working on the issues, especially:
-
-    * Run Ruby Quiz
-    * Document Modules
-    * Answer Questions on Ruby Talk
-
-Thanks for your patience.
-
-James Edward Gray II
-```
-
-### Ruby in HTML
-
-ERB is often used in .rhtml files (HTML with embedded Ruby).  Notice the need in
-this example to provide a special binding when the template is run, so that the instance
-variables in the Product object can be resolved.
-
-```rb
-require "erb"
-
-# Build template data class.
-class Product
-  def initialize( code, name, desc, cost )
-    @code = code
-    @name = name
-    @desc = desc
-    @cost = cost
-
-    @features = [ ]
-  end
-
-  def add_feature( feature )
-    @features << feature
-  end
-
-  # Support templating of member data.
-  def get_binding
-    binding
-  end
-
-  # ...
-end
-
-# Create template.
-template = %{
-  <html>
-    <head><title>Ruby Toys -- <%= @name %></title></head>
-    <body>
-
-      <h1><%= @name %> (<%= @code %>)</h1>
-      <p><%= @desc %></p>
-
-      <ul>
-        <% @features.each do |f| %>
-          <li><b><%= f %></b></li>
-        <% end %>
-      </ul>
-
-      <p>
-        <% if @cost < 10 %>
-          <b>Only <%= @cost %>!!!</b>
-        <% else %>
-           Call for a price, today!
-        <% end %>
-      </p>
-
-    </body>
-  </html>
-}.gsub(/^  /, '')
-
-rhtml = ERB.new(template)
+There are a variety of template engines available in various Ruby projects.
+For example, [RDoc][rdoc], distributed with Ruby, uses its own template engine, which
+can be reused elsewhere.
 
-# Set up template data.
-toy = Product.new( "TZ-1002",
-                   "Rubysapien",
-                   "Geek's Best Friend!  Responds to Ruby commands...",
-                   999.95 )
-toy.add_feature("Listens for verbal commands in the Ruby language!")
-toy.add_feature("Ignores Perl, Java, and all C variants.")
-toy.add_feature("Karate-Chop Action!!!")
-toy.add_feature("Matz signature on left leg.")
-toy.add_feature("Gem studded eyes... Rubies, of course!")
+Other popular template engines may be found in the [Ruby Toolbox][ruby toolbox].
 
-# Produce result.
-rhtml.run(toy.get_binding)
-```
+## Code
 
-Generates (some blank lines removed):
+The ERB source code is in GitHub project [ruby/erb][ruby/erb].
 
-```html
-<html>
-  <head><title>Ruby Toys -- Rubysapien</title></head>
-  <body>
-
-    <h1>Rubysapien (TZ-1002)</h1>
-    <p>Geek's Best Friend!  Responds to Ruby commands...</p>
-
-    <ul>
-        <li><b>Listens for verbal commands in the Ruby language!</b></li>
-        <li><b>Ignores Perl, Java, and all C variants.</b></li>
-        <li><b>Karate-Chop Action!!!</b></li>
-        <li><b>Matz signature on left leg.</b></li>
-        <li><b>Gem studded eyes... Rubies, of course!</b></li>
-    </ul>
-
-    <p>
-         Call for a price, today!
-    </p>
-
-  </body>
-</html>
-```
-
-## Notes
-
-There are a variety of templating solutions available in various Ruby projects.
-For example, RDoc, distributed with Ruby, uses its own template engine, which
-can be reused elsewhere.
+## Bugs
 
-Other popular engines could be found in the corresponding
-[Category](https://www.ruby-toolbox.com/categories/template_engines) of
-The Ruby Toolbox.
+Bugs may be reported at [ERB Issues][erb issues].
 
 ## License
 
-The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).
+This software is available as open source under the terms
+of the [2-Clause BSD License][2-clause bsd license].
+
+[2-clause bsd license]: https://opensource.org/licenses/BSD-2-Clause
+[erb executable]:       rdoc-ref:erb_executable.md
+[erb issues]:           https://github.com/ruby/erb/issues
+[rdoc]:                 https://ruby.github.io/rdoc/
+[ruby/erb]:             https://github.com/ruby/erb
+[ruby toolbox]:         https://www.ruby-toolbox.com/categories/template_engines
+[sprintf]:              https://docs.ruby-lang.org/en/master/Kernel.html#method-i-sprintf
+[template processor]:   https://en.wikipedia.org/wiki/Template_processor_