erb 2.2.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e39ac89a663f9ec9c2dd46af732f74e814b95167967f5efcf1aa35dbe640ea63
-  data.tar.gz: cfceb3434204b17b65d00a0eab2f73e7abca7c1c67bfa7baefeea151346dae5b
+  metadata.gz: 7b2863be9c08d529339d060f45fe14a92ddc56e5107c4e96d96f62c5bb3891ef
+  data.tar.gz: 5bedf59f948afda25ce5a9b34ffeba0ec9c8d69cce09ee20a00f63ab0f468363
 SHA512:
-  metadata.gz: d71d4bdcf0f0a027f1897a2c74aa56c728658d96f2f88c5e1e4e3e33d5d5707c514a3ed39946335cf9f94ccd4734ee33ad21a1a8f57b547339ef1b49a81681b4
-  data.tar.gz: b85fd09d707a9e92adfd1e8d827cf4c172106cce3f3207495944f8e4fa5b966fb9af2b52053af02e39bd2b1f1db06d9bb00ebe31bc4409b9ff5339a976cee938
+  metadata.gz: f3c5db15f023dd2cca0c76a9fad16746f98d44adc41284308c6baad9eebb75ac3aa54a7a89f3457f9e82ddc62cf7c42ddf1050cd5aef7811b74ab7513822a92f
+  data.tar.gz: dfb6828690e0e3ea9572692534f676d07a952d2db47726f7c3de7da38ca8a970ed4d26525698b56de04bc4956bbd032bf7b2f15515a9f649cc3c0c4dbb02a067

data/.github/workflows/test.yml

@@ -1,29 +1,36 @@
 name: test
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
 
 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' | jq -c '. + ["jruby", "truffleruby-head"]')
+          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]
+      fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v2
     - name: Set up Ruby
       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,14 +1,35 @@
 # Change Log
 
+## 4.0.0
+
+* Optimize `ERB::Util.html_escape`
+  * 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`
+  * `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
+* `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/README.md

@@ -32,7 +32,7 @@ on the rules below:
 ```erb
 <% 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

data/Rakefile

@@ -7,4 +7,17 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/test_*.rb']
 end
 
+if RUBY_ENGINE != 'jruby'
+  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/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,5 +27,12 @@ Gem::Specification.new do |spec|
   spec.executables   = ['erb']
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'cgi'
+  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,2 @@
+require 'mkmf'
+create_makefile 'erb/escape'