erubi 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f90a1816343b873297c5d0f5cc2a4d5506c129b3f7613a63cdb34afa82cb28ee
-  data.tar.gz: ed8b6d7739ebae9db5818bebd6c42120a155da3d1eef8732f1d1e2b64bfdf417
+  metadata.gz: 30bbae115393cc4d2ff05acd506ebd7616aad0797454c91766b379bfbfecef8b
+  data.tar.gz: 4dd7876504af9f3a17674875daad4233b9731c7bd3f195ecdf2e2507a2fa33b1
 SHA512:
-  metadata.gz: 56b1f608a9f0f049ae3523afaf8ff1ab0970290f4adb703a1e3b949ee476ddb2347d550e20cef140ec7afa72d1d34bc35d9fd8404c5eb94f43b5fcf644d7d031
-  data.tar.gz: d8027fd9255e838d6c4df2064d37d5e2f2fa55c65bbd783b983438684a229706a8d35e3d2fbbaee79ffca0785a68804545acbb40c66ae9e1640322b501c17ff8
+  metadata.gz: 380753f81d65b28686ccc285bb77ed998fe95ef179fea87b28c74701c833182225ba22f544fbc2276cad1f5d1c8309a3c837e5e78ba120806b49b8b675d2ba30
+  data.tar.gz: 006365ddcb013ebb47789055993e176640ba8f285b4bb718c85d9a0793d7ba428587adab203976dc068dcb7fc0d466e76362f6fbcab7832d7463dfc05a7e3934

data/CHANGELOG

@@ -1,3 +1,7 @@
+=== 1.8.0 (2018-12-18)
+
+* Support :yield_returns_buffer option in capture_end for always returning the (potentially modified) buffer in <%|= tags (evanleck) (#15)
+
 === 1.7.1 (2018-03-05)
 
 * Make whitespace handling for <%# %> tags more compatible with Erubis (jeremyevans) (#14)

data/README.rdoc

@@ -63,6 +63,38 @@ To use the capture_end support with tilt:
   require 'erubi/capture_end'
   Tilt.new("filename.erb", :engine_class=>Erubi::CaptureEndEngine).render
 
+When using the capture_end support, any methods (such as +form+ in the example
+above) should return the (potentially modified) buffer.  Since the buffer
+variable is a local variable and not an instance variable by default, you'll
+probably want to set the +:bufvar+ variable when using the capture_end
+support to an instance variable, and have any methods used access that
+instance variable.  Example:
+
+  def form
+    @_buf << "<form>"
+    yield
+    @_buf << "</form>"
+    @_buf
+  end
+
+  puts eval(Erubi::CaptureEndEngine.new(<<-END, :bufvar=>:@_buf).src)
+  before
+  <%|= form do %>
+  inside
+  <%| end %>
+  after
+  END
+
+  # Output:
+  # before
+  # <form>
+  # inside
+  # </form>
+  # after
+
+Alternatively, passing the option +:yield_returns_buffer => true+ will return the
+buffer captured by the block instead of the last expression in the block.
+
 = Reporting Bugs
 
 The bug tracker is located at https://github.com/jeremyevans/erubi/issues

data/lib/erubi.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Erubi
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
   RANGE_ALL = 0..-1
 
   if RUBY_VERSION >= '1.9'

data/lib/erubi/capture_end.rb

@@ -10,10 +10,17 @@ module Erubi
     # additional options:
     # :escape_capture :: Whether to make <%|= escape by default, and <%|== not escape by default,
     #                    defaults to the same value as :escape.
+    # :yield_returns_buffer :: Whether to have <%| tags insert the buffer as an expression, so that
+    #                          <%| end %> tags will have the buffer be the last expression inside
+    #                          the block, and therefore have the buffer be returned by the yield
+    #                          expression.  Normally the buffer will be returned anyway, but there
+    #                          are cases where the last expression will not be the buffer,
+    #                          and therefore a different object will be returned.
     def initialize(input, properties={})
       properties = Hash[properties]
       escape = properties.fetch(:escape){properties.fetch(:escape_html, false)}
       @escape_capture = properties.fetch(:escape_capture, escape)
+      @yield_returns_buffer = properties.fetch(:yield_returns_buffer, false)
       @bufval = properties[:bufval] ||= 'String.new'
       @bufstack = '__erubi_stack'
       properties[:regexp] ||= /<%(\|?={1,2}|-|\#|%|\|)?(.*?)([-=])?%>([ \t]*\r?\n)?/m
@@ -34,7 +41,8 @@ module Erubi
       when '|'
         rspace = nil if tailch && !tailch.empty?
         add_text(lspace) if lspace
-        src << code << ")).to_s; ensure; #{@bufvar} = #{@bufstack}.pop; end;"
+        result = @yield_returns_buffer ? " #{@bufvar}; " : ""
+        src << result << code << ")).to_s; ensure; #{@bufvar} = #{@bufstack}.pop; end;"
         add_text(rspace) if rspace
       else
         super

data/test/test.rb

@@ -23,6 +23,8 @@ end
 
 require 'erubi'
 require 'erubi/capture_end'
+
+ENV['MT_NO_PLUGINS'] = '1' # Work around stupid autoloading of plugins
 require 'minitest/spec'
 require 'minitest/autorun'
 
@@ -663,4 +665,110 @@ END3
     proc{Erubi::Engine.new('<%] %>', :regexp =>/<%(={1,2}|\]|-|\#|%)?(.*?)([-=])?%>([ \t]*\r?\n)?/m)}.must_raise ArgumentError
     proc{Erubi::CaptureEndEngine.new('<%] %>', :regexp =>/<%(={1,2}|\]|-|\#|%)?(.*?)([-=])?%>([ \t]*\r?\n)?/m)}.must_raise ArgumentError
   end
+
+  it "should respect the :yield_returns_buffer option for making templates return the (potentially modified) buffer" do
+    @options[:engine] = ::Erubi::CaptureEndEngine
+    @options[:bufvar] = '@a'
+
+    def self.bar
+      a = String.new
+      a << "a"
+      yield 'burgers'
+      case b = (yield 'salads')
+      when String
+        a << b
+        a << 'b'
+        a.upcase
+      end
+    end
+
+    check_output(<<END1, <<END2, <<END3){}
+<%|= bar do |item| %>
+Let's eat <%= item %>!
+<% nil %><%| end %>
+END1
+@a = String.new;begin; (__erubi_stack ||= []) << @a; @a = String.new; __erubi_stack.last << (( bar do |item|  @a << '
+'; @a << 'Let\\'s eat '; @a << ( item ).to_s; @a << '!
+'; nil ; end )).to_s; ensure; @a = __erubi_stack.pop; end; @a << '
+';
+@a.to_s
+END2
+
+END3
+
+    @options[:yield_returns_buffer] = true
+
+    check_output(<<END1, <<END2, <<END3) {}
+<%|= bar do |item| %>
+Let's eat <%= item %>!
+<% nil %><%| end %>
+END1
+@a = String.new;begin; (__erubi_stack ||= []) << @a; @a = String.new; __erubi_stack.last << (( bar do |item|  @a << '
+'; @a << 'Let\\'s eat '; @a << ( item ).to_s; @a << '!
+'; nil ; @a;  end )).to_s; ensure; @a = __erubi_stack.pop; end; @a << '
+';
+@a.to_s
+END2
+A
+LET'S EAT BURGERS!
+
+LET'S EAT SALADS!
+B
+END3
+  end
+
+  it "should respect the :yield_returns_buffer option for making templates return the (potentially modified) buffer as the result of the block" do
+    @options[:engine] = ::Erubi::CaptureEndEngine
+    @options[:yield_returns_buffer] = true
+
+    def self.bar(foo = nil)
+      if foo.nil?
+        yield
+      else
+        foo
+      end
+    end
+
+    check_output(<<END1, <<END2, <<END3) {}
+<%|= bar do %>
+Let's eat the tacos!
+<%| end %>
+
+Delicious!
+END1
+_buf = String.new;begin; (__erubi_stack ||= []) << _buf; _buf = String.new; __erubi_stack.last << (( bar do  _buf << '
+'; _buf << 'Let\\'s eat the tacos!
+'; _buf;  end )).to_s; ensure; _buf = __erubi_stack.pop; end; _buf << '
+'; _buf << '
+Delicious!
+';
+_buf.to_s
+END2
+
+Let's eat the tacos!
+
+
+Delicious!
+END3
+
+    check_output(<<END1, <<END2, <<END3) {}
+<%|= bar("Don't eat the burgers!") do %>
+Let's eat burgers!
+<%| end %>
+
+Delicious!
+END1
+_buf = String.new;begin; (__erubi_stack ||= []) << _buf; _buf = String.new; __erubi_stack.last << (( bar(\"Don't eat the burgers!\") do  _buf << '
+'; _buf << 'Let\\'s eat burgers!
+'; _buf;  end )).to_s; ensure; _buf = __erubi_stack.pop; end; _buf << '
+'; _buf << '
+Delicious!
+';
+_buf.to_s
+END2
+Don't eat the burgers!
+
+Delicious!
+END3
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erubi
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Small ERB Implementation