erubi 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba16a36a1aa6da80b461f49724bf565bbd3245e5
-  data.tar.gz: 91c6545b66c34061ed72b00292a1a882cb4b6d45
+  metadata.gz: 92d3eacf43d264b3146fc705e27f23b9bdd70284
+  data.tar.gz: ecc36e3901223a29ef2c1db35a6f99e61318f04a
 SHA512:
-  metadata.gz: 75fb3e6d36720ceefec4de3358b7052de90e6de7bb1d28570878f3bfc38fda5a2696c0c66e0b4159a22fdb5c5c63d95aeed78bbd5b3caeb0fc417a044679bb4d
-  data.tar.gz: f7edc95fef95ffce7537ea88ac3a68216c56cb999977b2008da27c50e9577e644776b44d6eda8d18366ee3235d0ee819e6552deb3d354b3ca67308aebe35a6a7
+  metadata.gz: 393fac1c97bcec819d19cc77ff482a1a3ad3852ac0049b709d8e0d12320362337ad0b3b16304117272c381cb62d2f43ac32ea19af9605d6706cfe6bda69c34a7
+  data.tar.gz: 5461c001e9fe35fd7b0937941e4553b367986d3f588c58798184dc21aac6690a6510299c152a807b64ee4c9259819a5c86e293483149c5ee63edb05662e5a83d

data/CHANGELOG

@@ -1,3 +1,11 @@
+=== 1.2.0 (2016-11-21)
+
+* Engine#src now returns a frozen string (jeremyevans)
+
+* Automatically freeze template text strings on ruby 2.1+, reducing garbage generated (jeremyevans)
+
+* Allow overriding of behavior for <%= and <%== tags (ujifgc) (#1)
+
 === 1.1.0 (2016-11-14)
 
 * Add :ensure option to supporting restoring bufvar to original value (jeremyevans)

data/README.rdoc

@@ -6,6 +6,7 @@ the following differences:
 * Handles postfix conditionals when using escaping (e.g. <tt><%= foo if bar %></tt>)
 * Supports frozen_string_literal: true in templates via :freeze option
 * Works with ruby's --enable-frozen-string-literal option
+* Automatically freezes strings for template text when ruby optimizes it (on ruby 2.1+)
 * Escapes ' (apostrophe) when escaping for better XSS protection 
 * Has 90% smaller memory footprint for base engine
 * Has 75% smaller memory footprint for tilt support

data/lib/erubi.rb

@@ -7,6 +7,7 @@ module Erubi
   if RUBY_VERSION >= '1.9'
     RANGE_FIRST = 0
     RANGE_LAST = -1
+    TEXT_END = "'.freeze;"
 
     # Escape the following characters with their HTML/XML
     # equivalents.
@@ -17,6 +18,7 @@ module Erubi
     # :nocov:
     RANGE_FIRST = 0..0
     RANGE_LAST = -1..-1
+    TEXT_END = "';"
 
     def self.h(value)
       value.to_s.gsub(/[&<>"']/){|s| ESCAPE_TABLE[s]}
@@ -25,7 +27,7 @@ module Erubi
   end
 
   class Engine
-    # The ruby source code generated from the template, which can be evaled.
+    # The frozen ruby source code generated from the template, which can be evaled.
     attr_reader :src
 
     # The filename of the template, if one was given.
@@ -63,12 +65,12 @@ module Erubi
       src << "# frozen_string_literal: true\n" if properties[:freeze]
       src << "begin; __original_outvar = #{bufvar} if defined?(#{bufvar}); " if properties[:ensure]
 
-      unless escapefunc = properties[:escapefunc]
+      unless @escapefunc = properties[:escapefunc]
         if escape
-          escapefunc = '__erubi.h'
+          @escapefunc = '__erubi.h'
           src << "__erubi = ::Erubi;"
         else
-          escapefunc = '::Erubi.h'
+          @escapefunc = '::Erubi.h'
         end
       end
 
@@ -115,9 +117,9 @@ module Erubi
           rspace = nil if tailch && !tailch.empty?
           add_text(lspace) if lspace
           if ((indicator == '=') ^ escape)
-            src << " #{bufvar} << (" << code << ').to_s;'
+            add_expression_result(code)
           else
-            src << " #{bufvar} << #{escapefunc}((" << code << '));'
+            add_expression_result_escaped(code)
           end
           add_text(rspace) if rspace
         when '#'
@@ -149,6 +151,7 @@ module Erubi
       src << "\n" unless src[RANGE_LAST] == "\n"
       src << postamble
       src << "; ensure\n  #{bufvar} = __original_outvar\nend\n" if properties[:ensure]
+      src.freeze
       freeze
     end
 
@@ -156,7 +159,7 @@ module Erubi
 
     # Add raw text to the template
     def add_text(text)
-      @src << " #{@bufvar} << '" << text.gsub(/['\\]/, '\\\\\&') << "';" unless text.empty?
+      @src << " #{@bufvar} << '" << text.gsub(/['\\]/, '\\\\\&') << TEXT_END unless text.empty?
     end
 
     # Add ruby code to the template
@@ -165,6 +168,16 @@ module Erubi
       @src << ';' unless code[RANGE_LAST] == "\n"
     end
 
+    # Add the result of Ruby expression to the template
+    def add_expression_result(code)
+      @src << " #{@bufvar} << (" << code << ').to_s;'
+    end
+
+    # Add the escaped result of Ruby expression to the template
+    def add_expression_result_escaped(code)
+      @src << " #{@bufvar} << #{@escapefunc}((" << code << '));'
+    end
+
     # Raise an exception, as the base engine class does not support handling other indicators.
     def handle(indicator, code, tailch, rspace, lspace)
       raise ArgumentError, "Invalid indicator: #{indicator}"

data/lib/tilt/erubi.rb

@@ -18,11 +18,12 @@ module Tilt
 
       @engine = engine_class.new(data, @options)
       @outvar = @engine.bufvar
+      @src = @engine.src.dup
       @engine
     end
 
     def precompiled_template(locals)
-      @engine.src
+      @src
     end
 
     Tilt.register self, 'erb', 'rhtml', 'erubi'

data/test/test.rb

@@ -35,7 +35,7 @@ describe Erubi::Engine do
   def check_output(input, src, result, &block)
     t = (@options[:engine] || Erubi::Engine).new(input, @options)
     eval(t.src, block.binding).must_equal result
-    t.src.must_equal src
+    t.src.gsub("'.freeze;", "';").must_equal src
   end
 
   def setup_foo
@@ -485,6 +485,10 @@ END3
     Erubi::Engine.new('').frozen?.must_equal true
   end
 
+  it "should have frozen src" do
+    Erubi::Engine.new('').src.frozen?.must_equal true
+  end
+
   it "should raise an error if a tag is not handled when a custom regexp is used" do
     proc{Erubi::Engine.new('<%] %>', :regexp =>/<%(={1,2}|\]|-|\#|%)?(.*?)([-=])?%>([ \t]*\r?\n)?/m)}.must_raise ArgumentError
     proc{Erubi::CaptureEngine.new('<%] %>', :regexp =>/<%(={1,2}|\]|-|\#|%)?(.*?)([-=])?%>([ \t]*\r?\n)?/m)}.must_raise ArgumentError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erubi
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Small ERB Implementation