erb 4.0.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5013347602fe04849ab4f30713e5f33c3119e4a8de6f3de31dc2a39108d70a46
+  data.tar.gz: cc71c6d4bdb04f39d35873317b340289e372b27cd343fbb596d2d0d9c18dbbd0
+SHA512:
+  metadata.gz: ae29c46417424d5487c271975695ee21d5e437b3d8adbed5303dbb6aeef8d35401255d8527cf6c17bff84001d57112bad69c4272075e9c1251ea26b075662091
+  data.tar.gz: b33d009e86b08846aaeef2652add1251288bcbc245900cde13dd0762bf7c7f74228da036b00732bc7efb50f291c68969c41af70d2ab6debfb1b75f8aa2adeb4b

data/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  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' | jq -c '. + ["jruby", "truffleruby-head"]')
+          echo "::set-output name=value::${versions}"
+  test:
+    needs: ruby-versions
+    name: build (${{ matrix.ruby }} / ${{ matrix.os }})
+    strategy:
+      matrix:
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
+        os: [ubuntu-latest]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run test
+      run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.so
+*.bundle
+*.gem

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rake-compiler'
+  gem 'test-unit'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/NEWS.md

@@ -0,0 +1,39 @@
+# Change Log
+
+## 4.0.1
+
+* Stop building the C extension for TruffleRuby [#39](https://github.com/ruby/erb/pull/39)
+
+## 4.0.0
+
+* Optimize `ERB::Util.html_escape` [#27](https://github.com/ruby/erb/pull/27)
+  * No longer duplicate an argument string when nothing is escaped.
+     * This makes `ERB::Util.html_escape` faster than `CGI.escapeHTML` in no-escape cases.
+  * It skips calling `#to_s` when an argument is already a String.
+* Define `ERB::Escape.html_escape` as an alias to `ERB::Util.html_escape` [#38](https://github.com/ruby/erb/pull/38)
+  * `ERB::Util.html_escape` is known to be monkey-patched by Rails.
+    `ERB::Escape.html_escape` is useful when you want a non-monkey-patched version.
+* Drop deprecated `-S` option from `erb` command
+
+## 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
+
+## 2.2.0
+
+* Ruby 3.0 promoted ERB to a default gem

data/README.md

@@ -0,0 +1,255 @@
+# ERB
+
+An easy to use but powerful templating system for Ruby.
+
+## Introduction
+
+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.
+
+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
+```
+
+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
+```
+
+Prints: `__ENCODING__ is Big5.`
+
+## Examples
+
+### Plain Text
+
+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
+
+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>
+```
+
+## 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.
+
+Other popular engines could be found in the corresponding
+[Category](https://www.ruby-toolbox.com/categories/template_engines) of
+The Ruby Toolbox.
+
+## License
+
+The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test/lib'
+  t.ruby_opts << '-rhelper'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+case RUBY_ENGINE
+when 'jruby', 'truffleruby'
+  # not using C extension
+else
+  require 'rake/extensiontask'
+  Rake::ExtensionTask.new('erb/escape')
+  task test: :compile
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "erb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/erb.gemspec

@@ -0,0 +1,38 @@
+begin
+  require_relative 'lib/erb/version'
+rescue LoadError
+  # for Ruby core repository
+  require_relative 'erb/version'
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = 'erb'
+  spec.version       = ERB.const_get(:VERSION, false)
+  spec.authors       = ['Masatoshi SEKI', 'Takashi Kokubun']
+  spec.email         = ['seki@ruby-lang.org', 'takashikkbn@gmail.com']
+
+  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.5.0')
+  spec.licenses      = ['Ruby', 'BSD-2-Clause']
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'libexec'
+  spec.executables   = ['erb']
+  spec.require_paths = ['lib']
+
+  if RUBY_ENGINE == 'jruby'
+    spec.platform = 'java'
+  else
+    spec.required_ruby_version = '>= 2.7.0'
+    spec.extensions = ['ext/erb/escape/extconf.rb']
+  end
+
+  spec.add_dependency 'cgi', '>= 0.3.3'
+end

data/ext/erb/escape/escape.c

@@ -0,0 +1,95 @@
+#include "ruby.h"
+#include "ruby/encoding.h"
+
+static VALUE rb_cERB, rb_mEscape, rb_cCGI;
+static ID id_escapeHTML;
+
+#define HTML_ESCAPE_MAX_LEN 6
+
+static const struct {
+    uint8_t len;
+    char str[HTML_ESCAPE_MAX_LEN+1];
+} html_escape_table[UCHAR_MAX+1] = {
+#define HTML_ESCAPE(c, str) [c] = {rb_strlen_lit(str), str}
+    HTML_ESCAPE('\'', "'"),
+    HTML_ESCAPE('&', "&"),
+    HTML_ESCAPE('"', """),
+    HTML_ESCAPE('<', "&lt;"),
+    HTML_ESCAPE('>', "&gt;"),
+#undef HTML_ESCAPE
+};
+
+static inline void
+preserve_original_state(VALUE orig, VALUE dest)
+{
+    rb_enc_associate(dest, rb_enc_get(orig));
+}
+
+static inline long
+escaped_length(VALUE str)
+{
+    const long len = RSTRING_LEN(str);
+    if (len >= LONG_MAX / HTML_ESCAPE_MAX_LEN) {
+        ruby_malloc_size_overflow(len, HTML_ESCAPE_MAX_LEN);
+    }
+    return len * HTML_ESCAPE_MAX_LEN;
+}
+
+static VALUE
+optimized_escape_html(VALUE str)
+{
+    VALUE vbuf;
+    char *buf = ALLOCV_N(char, vbuf, escaped_length(str));
+    const char *cstr = RSTRING_PTR(str);
+    const char *end = cstr + RSTRING_LEN(str);
+
+    char *dest = buf;
+    while (cstr < end) {
+        const unsigned char c = *cstr++;
+        uint8_t len = html_escape_table[c].len;
+        if (len) {
+            memcpy(dest, html_escape_table[c].str, len);
+            dest += len;
+        }
+        else {
+            *dest++ = c;
+        }
+    }
+
+    VALUE escaped = str;
+    if (RSTRING_LEN(str) < (dest - buf)) {
+        escaped = rb_str_new(buf, dest - buf);
+        preserve_original_state(str, escaped);
+    }
+    ALLOCV_END(vbuf);
+    return escaped;
+}
+
+// ERB::Util.html_escape is different from CGI.escapeHTML in the following two parts:
+//   * ERB::Util.html_escape converts an argument with #to_s first (only if it's not T_STRING)
+//   * ERB::Util.html_escape does not allocate a new string when nothing needs to be escaped
+static VALUE
+erb_escape_html(VALUE self, VALUE str)
+{
+    if (!RB_TYPE_P(str, T_STRING)) {
+        str = rb_convert_type(str, T_STRING, "String", "to_s");
+    }
+
+    if (rb_enc_str_asciicompat_p(str)) {
+        return optimized_escape_html(str);
+    }
+    else {
+        return rb_funcall(rb_cCGI, id_escapeHTML, 1, str);
+    }
+}
+
+void
+Init_escape(void)
+{
+    rb_cERB = rb_define_class("ERB", rb_cObject);
+    rb_mEscape = rb_define_module_under(rb_cERB, "Escape");
+    rb_define_module_function(rb_mEscape, "html_escape", erb_escape_html, 1);
+
+    rb_cCGI = rb_define_class("CGI", rb_cObject);
+    id_escapeHTML = rb_intern("escapeHTML");
+}

data/ext/erb/escape/extconf.rb

@@ -0,0 +1,7 @@
+require 'mkmf'
+
+if RUBY_ENGINE == 'truffleruby'
+  File.write('Makefile', dummy_makefile($srcdir).join)
+else
+  create_makefile 'erb/escape'
+end