erubi 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20b3fb23c6df5c201822001090290ca746da0c46
-  data.tar.gz: 1792657866eff6b28e95be1ab5a3463445be3a2b
+  metadata.gz: fd16f88fa55dfb16632b96ad51f1b9d8b4dfcb3a
+  data.tar.gz: 369980088c6de4f7309f53ccbc1f4d77c40569d7
 SHA512:
-  metadata.gz: e8e2c2e1e8bd7cbe522a1570f81fbd12a691c84a2332df3e1be760193b59b9ab73b6bf05f1d1944f64b902295d980229e63fe6098f1bebfa851f5816da81b1bb
-  data.tar.gz: 0b515eb522628f20f1843070c216ad1fc01a76a64235f87bc6ecec09116f20f6f97e77de85ba0518aeaa0fbe816c50e41096a197637f41b4edd24ba98791a614
+  metadata.gz: 5bea95cdd30ba995ffd760d40131dab30cfbbe0f4dd57c87957c8b8d55cd0a55b2e4c7fd92d692defc1e2d90ae7a0b564462d8c5b48babdd14947c7137be2708
+  data.tar.gz: a0850dc7e918bf33c5e32707f1747cdfa0cb2902f8308be7d4f19d120b006426e9efc5b384fde46c1a2b920d23fa7432a37fdaf08a636928355f0391b03df6b2

data/CHANGELOG

@@ -1,3 +1,9 @@
+=== 1.5.0 (2017-01-26)
+
+* Drop tilt/erubi file, as tilt now ships with Erubi support (jeremyevans)
+
+* Drop erubi/capture file, Erubi::CaptureEngine support (jeremyevans)
+
 === 1.4.0 (2017-01-20)
 
 * Allow postambles to depend on internal state of engine (jeremyevans)

data/README.rdoc

@@ -1,7 +1,7 @@
 = Erubi
 
-Erubi is a ERB template engine for ruby. It is a simplified fork of Erubis, with
-the following differences:
+Erubi is a ERB template engine for ruby. It is a simplified fork of Erubis, using
+the same basic algorithm, with 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
@@ -31,21 +31,16 @@ Source code is available on GitHub at https://github.com/jeremyevans/erubi
 
 = Usage
 
-The expected usage is via tilt, and erubi ships with tilt 2 integration:
-
-  require 'tilt/erubi'
-  Tilt.new("filename.erb").render
-
-Requiring +tilt/erubi+ sets erubi as the default erb/rhtml template processor
-for tilt.  In most cases, you can use Erubi as a replacement for Erubis if
-you are using tilt.
-
-You can use the library manually, but it's only useful to get the generated
-source:
+Erubi only has built in support for retrieving the generated source for a
+file:
 
   require 'erubi'
   eval(Erubi::Engine.new(File.read('filename.erb')).src)
 
+Most users are will probably use Erubi via Rails or Tilt.  Erubi is the default
+erb template handler in Tilt 2.0.6+ and will be the default template handler in
+Rails 5.1+.
+
 == Capturing
 
 Erubi does not support capturing block output into the template by default.
@@ -63,6 +58,12 @@ and <tt><%==</tt> tags, <tt><%|=</tt> captures by default and
 <tt><%|==</tt> captures and escapes by default, but this can be reversed
 via the +:escape_capture+ or +:escape+ options.
 
+To use the capture_end support with tilt:
+
+  require 'tilt'
+  require 'erubi/capture_end'
+  Tilt.new("filename.erb", :engine_class=>Erubi::CaptureEndEngine).render
+
 = Reporting Bugs
 
 The bug tracker is located at https://github.com/jeremyevans/erubi/issues

data/test/test.rb

@@ -22,9 +22,7 @@ if ENV['COVERAGE']
 end
 
 require 'erubi'
-require 'erubi/capture'
 require 'erubi/capture_end'
-require 'tilt/erubi'
 require 'minitest/spec'
 require 'minitest/autorun'
 
@@ -161,88 +159,6 @@ END3
     @a.must_equal 'bar'
   end
 
-  [['', false], ['=', true]].each do |ind, escape|
-    it "should allow <%|=#{ind} for capturing with CaptureEngine with :escape_capture => #{escape} and :escape => #{escape}" do
-      @options[:bufvar] = '@a'
-      @options[:capture] = true
-      @options[:escape_capture] = escape
-      @options[:escape] = !escape
-      @options[:engine] = ::Erubi::CaptureEngine
-      setup_foo
-      check_output(<<END1, <<END2, <<END3){}
-<table>
- <tbody>
-  <%|=#{ind} @foo.bar do %>
-  <tr>
-   <td><%=#{ind} 1 %></td>
-   <td><%=#{ind} '&' %></td>
-  </tr>
- <% end %>
- </tbody>
-</table>
-END1
-#{'__erubi = ::Erubi;' unless escape}@a = ::Erubi::Buffer.new; @a << '<table>
- <tbody>
-'; @a << '  '; @a.before_append!; @a.append=  @foo.bar do  @a << '
-'; @a << '  <tr>
-   <td>'; @a << #{!escape ? '__erubi' : '::Erubi'}.h(( 1 )); @a << '</td>
-   <td>'; @a << #{!escape ? '__erubi' : '::Erubi'}.h(( '&' )); @a << '</td>
-  </tr>
-';  end 
- @a << ' </tbody>
-</table>
-';
-@a.to_s
-END2
-<table>
- <tbody>
-  A
-  <TR>
-   <TD>1</TD>
-   <TD>&AMP;</TD>
-  </TR>
-B </tbody>
-</table>
-END3
-    end
-  end
-
-  [['', true], ['=', false]].each do |ind, escape|
-    it "should allow <%|=#{ind} for capturing with CaptureEngine with :escape => #{escape}" do
-      @options[:bufvar] = '@a'
-      @options[:capture] = true
-      @options[:escape] = escape
-      @options[:engine] = ::Erubi::CaptureEngine
-      setup_foo
-      check_output(<<END1, <<END2, <<END3){}
-<table>
- <tbody>
-  <%|=#{ind} @foo.bar do %>
-   <b><%=#{ind} '&' %></b>
- <% end %>
- </tbody>
-</table>
-END1
-#{'__erubi = ::Erubi;' if escape}@a = ::Erubi::Buffer.new; @a << '<table>
- <tbody>
-'; @a << '  '; @a.before_append!; @a.escape=  @foo.bar do  @a << '
-'; @a << '   <b>'; @a << #{escape ? '__erubi' : '::Erubi'}.h(( '&' )); @a << '</b>
-';  end 
- @a << ' </tbody>
-</table>
-';
-@a.to_s
-END2
-<table>
- <tbody>
-  A
-   &lt;B&gt;&amp;AMP;&lt;/B&gt;
-B </tbody>
-</table>
-END3
-    end
-  end
-
   [['', false], ['=', true]].each do |ind, escape|
     it "should allow <%|=#{ind} and <%| for capturing with CaptureEndEngine with :escape_capture => #{escape} and :escape => #{!escape}" do
       @options[:bufvar] = '@a'
@@ -284,7 +200,6 @@ END3
   [['', true], ['=', false]].each do |ind, escape|
     it "should allow <%|=#{ind} and <%| for capturing with CaptureEndEngine when with :escape => #{escape}" do
       @options[:bufvar] = '@a'
-      @options[:capture] = true
       @options[:escape] = escape
       @options[:engine] = ::Erubi::CaptureEndEngine
       setup_bar
@@ -319,7 +234,6 @@ END3
 
     it "should allow <%|=#{ind} and <%| for nested capturing with CaptureEndEngine when with :escape => #{escape}" do
       @options[:bufvar] = '@a'
-      @options[:capture] = true
       @options[:escape] = escape
       @options[:engine] = ::Erubi::CaptureEndEngine
       setup_bar
@@ -622,71 +536,6 @@ END3
 
   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
-  end
-
-  it "should have working tilt support" do
-    @list = ['&\'<>"2']
-    Tilt::ErubiTemplate.new{<<END1}.render(self).must_equal(<<END2)
-<table>
- <tbody>
-  <% i = 0
-     @list.each_with_index do |item, i| %>
-  <tr>
-   <td><%= i+1 %></td>
-   <td><%== item %></td>
-  </tr>
- <% end %>
- </tbody>
-</table>
-<%== i+1 %>
-END1
-<table>
- <tbody>
-  <tr>
-   <td>1</td>
-   <td>&amp;&#039;&lt;&gt;&quot;2</td>
-  </tr>
- </tbody>
-</table>
-1
-END2
-  end
-
-  it "should have working tilt support for capturing" do
-    setup_foo
-    Tilt::ErubiTemplate.new(:capture=>true, :outvar=>'@a'){<<END1}.render(self).must_equal(<<END2)
-1<%|= @foo.bar do %>bar<% end %>2
-END1
-1ABARB2
-END2
-  end
-
-  it "should have working tilt support for explicit capturing" do
-    setup_bar
-    Tilt::ErubiTemplate.new(:capture=>:explicit, :outvar=>'@a'){<<END1}.render(self).must_equal(<<END2)
-1<%|= bar do %>b<%|= baz do %>e<%| end %>ar<%| end %>2
-END1
-1ABCEDCEDARB2
-END2
-  end
-
-  it "should have working tilt support for specifying engine class" do
-    setup_foo
-    @a = 1
-    Tilt::ErubiTemplate.new(:engine_class=>Erubi::CaptureEngine, :outvar=>'@a'){<<END1}.render(self).must_equal(<<END2)
-1<%|= @foo.bar do %>bar<% end %>2
-END1
-1ABARB2
-END2
-    @a.must_equal 1
-  end
-
-  it "should have working tilt support for locals" do
-    Tilt::ErubiTemplate.new{<<END1}.render(self, :b=>3).must_equal(<<END2)
-<%= b %>
-END1
-3
-END2
+    proc{Erubi::CaptureEndEngine.new('<%] %>', :regexp =>/<%(={1,2}|\]|-|\#|%)?(.*?)([-=])?%>([ \t]*\r?\n)?/m)}.must_raise ArgumentError
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erubi
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: tilt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,9 +39,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/erubi.rb
-- lib/erubi/capture.rb
 - lib/erubi/capture_end.rb
-- lib/tilt/erubi.rb
 - test/test.rb
 homepage: https://github.com/jeremyevans/erubi
 licenses:

data/lib/erubi/capture.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require 'erubi'
-
-module Erubi
-  # A buffer class used for templates that support captures
-  class Buffer
-    def initialize
-      @bufs = [new_buffer]
-    end
-
-    # Return the current buffer
-    def buffer
-      @bufs.last
-    end
-
-    # Append to the current buffer
-    def <<(str)
-      buffer << str
-    end
-
-    # Add a new buffer, that future appends will go to.
-    def before_append!
-      @bufs << new_buffer
-    end
-
-    # Take the current buffer and append it to the previous buffer.
-    def append=(_)
-      buf = @bufs.pop
-      buffer << buf.to_s
-    end
-
-    # Escape the current buffer and append it to the previous buffer,
-    def escape=(_)
-      buf = @bufs.pop
-      buffer << escape(buf.to_s)
-    end
-
-    # Return the current buffer, as a string.
-    def to_s
-      buffer.to_s
-    end
-
-    private
-
-    # An object to use for the underlying buffers.
-    def new_buffer
-      String.new
-    end
-
-    # HTML/XML escape the given string.
-    def escape(str)
-      ::Erubi.h(str)
-    end
-  end
-
-  # An engine class that supports capturing blocks via the <%|= and <%|== tags.
-  class CaptureEngine < Engine
-    # Initializes the engine.  Accepts the same arguments as ::Erubi::Engine, and these
-    # additional options:
-    # :escape_capture :: Whether to make <%|= escape by default, and <%|== not escape by default,
-    #                    defaults to the same value as :escape.
-    def initialize(input, properties={})
-      properties = Hash[properties]
-      escape = properties.fetch(:escape){properties.fetch(:escape_html, false)}
-      @escape_capture = properties.fetch(:escape_capture, escape)
-      properties[:regexp] ||= /<%(\|?={1,2}|-|\#|%)?(.*?)([-=])?%>([ \t]*\r?\n)?/m
-      properties[:bufval] ||= "::Erubi::Buffer.new"
-      super
-    end
-
-    private
-
-    # Handle the <%|= and <%|== tags
-    def handle(indicator, code, tailch, rspace, lspace)
-      case indicator
-      when '|=', '|=='
-        rspace = nil if tailch && !tailch.empty?
-        add_text(lspace) if lspace
-        meth = ((indicator == '|=') ^ @escape_capture) ? 'append' : 'escape'
-        src << " #{@bufvar}.before_append!; #{@bufvar}.#{meth}= " << code
-        add_text(rspace) if rspace
-      else
-        super
-      end
-    end
-  end
-end

data/lib/tilt/erubi.rb

@@ -1,35 +0,0 @@
-require 'tilt'
-require 'tilt/template'
-require 'erubi'
-
-module Tilt
-  # Erubi (a simplified version of Erubis) template implementation
-  class ErubiTemplate < Template
-    def prepare
-      @options.merge!(:preamble => false, :postamble => false, :ensure=>true)
-
-      engine_class = if @options[:engine_class]
-        @options[:engine_class]
-      elsif capture = @options[:capture]
-        if capture == :explicit
-          Erubi::CaptureEndEngine
-        else
-          Erubi::CaptureEngine
-        end
-      else
-        Erubi::Engine
-      end
-
-      @engine = engine_class.new(data, @options)
-      @outvar = @engine.bufvar
-      @src = @engine.src.dup
-      @engine
-    end
-
-    def precompiled_template(locals)
-      @src
-    end
-
-    Tilt.register self, 'erb', 'rhtml', 'erubi'
-  end
-end