erb 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f3996670474a52bba08a0a8cdeba934a01d09fb7a45047ad14de049823cea90
-  data.tar.gz: e23035811fc69fb375930eb155ecbf47b67e7991ba7c96fd3c95d6f823e58b6b
+  metadata.gz: 853983c0a4e1b81c59b0fee415b27383d0f12c372ea6b534e27f39d1f1ce4022
+  data.tar.gz: 568d2f27aa45623fd24e8d65325edf092b9c63154992800589da605e46256869
 SHA512:
-  metadata.gz: '09a2991c267e42f6b46f9c629db1596c3238a711e409099c1b50874ded8752d1dd64a9828b6eaec79796b06dab92d402d408c97b24a06eda3e4b12bb8c9e49ac'
-  data.tar.gz: 4341ca9b16e9e646121dd7e2da710156c6ce71a15983b6c12daaad6fc43fec918b4c57b15b933ff7e6a94a32894e8a458f580f3371300253cb36aaf955b2e07c
+  metadata.gz: f7e82ab6f0359e0185529481b05267c6837b9574af77a7fe5d01678fb10a61c8e51677c52a347d178c0c7c8a8f3b93f59e56846a9476020c4230a0a0081ddad7
+  data.tar.gz: 3914c61780fc17624f3e6d8848b9c0dcbf6a7ebfbadb1d6b8daecf3ebfc75d12e5ab54ba182fb5d8f1a3e51a00410fd1bf355b4f6c3a0c9a3dccf77c3b5ede51

data/.github/workflows/test.yml

@@ -3,20 +3,25 @@ name: test
 on: [push, pull_request]
 
 jobs:
-  build:
+  ruby-versions:
+    runs-on: ubuntu-latest
+    outputs:
+      versions: ${{ steps.versions.outputs.value }}
+    steps:
+      - id: versions
+        run: |
+          versions=$(curl -s 'https://cache.ruby-lang.org/pub/misc/ci_versions/cruby.json')
+          echo "::set-output name=value::${versions}"
+  test:
+    needs: ruby-versions
     name: build (${{ matrix.ruby }} / ${{ matrix.os }})
     strategy:
       matrix:
-        ruby:
-          - '2.5'
-          - '2.6'
-          - '2.7'
-          - '3.0'
-          - head
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/NEWS.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## 3.0.0
+
+- Bump `required_ruby_version` to Ruby 2.7+ [#23](https://github.com/ruby/erb/pull/23)
+- `ERB::Util.url_encode` uses a native implementation [#23](https://github.com/ruby/erb/pull/23)
+- Fix a bug that a magic comment with a wrong format could be detected [#6](https://github.com/ruby/erb/pull/6)
+
+## 2.2.3
+
+- Bump `required_ruby_version` from 2.3 to 2.5 as it has never been supported [#3](https://github.com/ruby/erb/pull/3)
+
+## 2.2.2
+
+- `ERB.version` returns just a version number
+- `ERB::Revision` is deprecated
+
 ## 2.2.1
 
 - `ERB#initialize` warns `safe_level` and later arguments even without -w

data/README.md

@@ -2,31 +2,253 @@
 
 An easy to use but powerful templating system for Ruby.
 
-## Installation
+## Introduction
 
-Add this line to your application's Gemfile:
+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.
 
-```ruby
-gem 'erb'
+A very simple example is this:
+
+```rb
+require 'erb'
+
+x = 42
+template = ERB.new <<-EOF
+  The value of x is: <%= x %>
+EOF
+puts template.result(binding)
+```
+
+Prints: `The value of x is: 42`
+
+More complex examples are given below.
+
+## Recognized Tags
+
+ERB recognizes certain tags in the provided template and converts them based
+on the rules below:
+
+```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
 ```
 
-And then execute:
+All other text is passed through ERB filtering unchanged.
+
+## 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.
+
+See the ERB.new and ERB#result methods for more detail.
+
+## Character encodings
+
+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.
+
+```rb
+# -*- coding: utf-8 -*-
+require 'erb'
+
+template = ERB.new <<EOF
+<%#-*- coding: Big5 -*-%>
+  __ENCODING__ is <%= __ENCODING__ %>.
+EOF
+puts template.result
+```
 
-    $ bundle install
+Prints: `__ENCODING__ is Big5.`
 
-Or install it yourself as:
+## Examples
 
-    $ gem install erb
+### Plain Text
 
-## Development
+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.
+
+```rb
+require "erb"
+
+# Create template.
+template = %q{
+  From:  James Edward Gray II <james@grayproductions.net>
+  To:  <%= to %>
+  Subject:  Addressing Needs
+
+  <%= 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
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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)
+
+# 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!")
+
+# Produce result.
+rhtml.run(toy.get_binding)
+```
+
+Generates (some blank lines removed):
+
+```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>
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Notes
 
-## Contributing
+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.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/erb.
+Other popular engines could be found in the corresponding
+[Category](https://www.ruby-toolbox.com/categories/template_engines) of
+The Ruby Toolbox.
 
 ## License
 

data/Rakefile

@@ -7,4 +7,11 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/test_*.rb']
 end
 
+task :sync_tool do
+  require 'fileutils'
+  FileUtils.cp '../ruby/tool/lib/core_assertions.rb', './test/lib'
+  FileUtils.cp '../ruby/tool/lib/envutil.rb', './test/lib'
+  FileUtils.cp '../ruby/tool/lib/find_executable.rb', './test/lib'
+end
+
 task default: :test

data/erb.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{An easy to use but powerful templating system for Ruby.}
   spec.description   = %q{An easy to use but powerful templating system for Ruby.}
   spec.homepage      = 'https://github.com/ruby/erb'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
   spec.licenses      = ['Ruby', 'BSD-2-Clause']
 
   spec.metadata['homepage_uri'] = spec.homepage
@@ -27,5 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = ['erb']
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'cgi'
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency 'cgi', '>= 0.3.3'
 end

data/lib/erb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 class ERB
-  VERSION = '2.2.2'
+  VERSION = '3.0.0'
   private_constant :VERSION
 end

data/lib/erb.rb

@@ -46,7 +46,7 @@ require 'erb/version'
 #
 #   <% Ruby code -- inline with output %>
 #   <%= Ruby expression -- replace with result %>
-#   <%# comment -- ignored -- useful in testing %>
+#   <%# 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
@@ -724,7 +724,7 @@ class ERB
       frozen = nil
       s.scan(re) do
         comment = $+
-        comment = $1 if comment[/-\*-\s*(.*?)\s*-*-$/]
+        comment = $1 if comment[/-\*-\s*([^\s].*?)\s*-\*-$/]
         case comment
         when %r"coding\s*[=:]\s*([[:alnum:]\-_]+)"
           enc = Encoding.find($1.sub(/-(?:mac|dos|unix)/i, ''))
@@ -1019,9 +1019,7 @@ class ERB
     #   Programming%20Ruby%3A%20%20The%20Pragmatic%20Programmer%27s%20Guide
     #
     def url_encode(s)
-      s.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m|
-        sprintf("%%%02X", m.unpack1("C"))
-      }
+      CGI.escapeURIComponent(s.to_s)
     end
     alias u url_encode
     module_function :u

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Masatoshi SEKI
 autorequire:
 bindir: libexec
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.3
 description: An easy to use but powerful templating system for Ruby.
 email:
 - seki@ruby-lang.org
@@ -60,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: An easy to use but powerful templating system for Ruby.