erb 3.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 853983c0a4e1b81c59b0fee415b27383d0f12c372ea6b534e27f39d1f1ce4022
-  data.tar.gz: 568d2f27aa45623fd24e8d65325edf092b9c63154992800589da605e46256869
+  metadata.gz: e00dd4c30b3c6affa697b52c33f6888583030f2cd90ae088e92dc36e1e2d513b
+  data.tar.gz: 5c778ef315846ec45a3c2f0413ca1c1f1bf38727037bcb2c23be2a2782f4f5b9
 SHA512:
-  metadata.gz: f7e82ab6f0359e0185529481b05267c6837b9574af77a7fe5d01678fb10a61c8e51677c52a347d178c0c7c8a8f3b93f59e56846a9476020c4230a0a0081ddad7
-  data.tar.gz: 3914c61780fc17624f3e6d8848b9c0dcbf6a7ebfbadb1d6b8daecf3ebfc75d12e5ab54ba182fb5d8f1a3e51a00410fd1bf355b4f6c3a0c9a3dccf77c3b5ede51
+  metadata.gz: f3ec96b260c70b9a3c673d21500a5b2e4834870caecb0153b0f7bf5337581e5183a90ed81b59e5a26843b76012540d5c695c26cfe206b636e7a33a2639c4d6fa
+  data.tar.gz: f918bf3065949b0ab784212357a160bce6432b284509660d0949d8479866cc5577bbe3892a9f1dee721d501f5a09d522efcd22473aee84c14a4557ae94ca6dc8

data/.github/workflows/test.yml

@@ -1,6 +1,10 @@
 name: test
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   ruby-versions:
@@ -10,7 +14,7 @@ jobs:
     steps:
       - id: versions
         run: |
-          versions=$(curl -s 'https://cache.ruby-lang.org/pub/misc/ci_versions/cruby.json')
+          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
@@ -19,6 +23,7 @@ jobs:
       matrix:
         ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
         os: [ubuntu-latest]
+      fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
@@ -26,9 +31,6 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: |
-        gem install bundler --no-document
-        bundle install
+        bundler-cache: true
     - name: Run test
-      run: rake test
+      run: bundle exec rake test

data/.gitignore

@@ -7,3 +7,6 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+*.so
+*.bundle
+*.gem

data/Gemfile

@@ -2,5 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake'
-gem 'test-unit'
+group :development do
+  gem 'rake'
+  gem 'rake-compiler'
+  gem 'test-unit'
+end

data/NEWS.md

@@ -1,24 +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)
+* 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)
+* 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
+* `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
+* `ERB#initialize` warns `safe_level` and later arguments even without -w
 
 ## 2.2.0
 
-- Ruby 3.0 promoted ERB to a default gem
+* Ruby 3.0 promoted ERB to a default gem

data/Rakefile

@@ -7,6 +7,15 @@ Rake::TestTask.new(:test) do |t|
   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'

data/erb.gemspec

@@ -8,8 +8,8 @@ end
 Gem::Specification.new do |spec|
   spec.name          = 'erb'
   spec.version       = ERB.const_get(:VERSION, false)
-  spec.authors       = ['Masatoshi SEKI']
-  spec.email         = ['seki@ruby-lang.org']
+  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.}
@@ -27,7 +27,12 @@ Gem::Specification.new do |spec|
   spec.executables   = ['erb']
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = ">= 2.7.0"
+  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