temple 0.8.2 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 95a7b68d7ea63e7673e183765ce0a64838ee4bdb
-  data.tar.gz: 00e2072a5e6577a07a754bfe9c39bee365e87ebb
+SHA256:
+  metadata.gz: ec5bd4c914592e35029369b132ae55d5ae56771b73d5c8710d3b6cbaf8c1409d
+  data.tar.gz: 379717f7a2b6580cfe6e3732dcb8da6ff76f6adf2ec725cfc32eacd988f8471a
 SHA512:
-  metadata.gz: 8a685000159a7f3e0ba41c4d7a6f8e7b8167755d020f05725020ce64dd2526aa19cf5007f78e071b9dd9521787756fee24cf30edc224cce701b6596020858dfc
-  data.tar.gz: 71f2c6edfe191aa6ff7b90a245e2dbe8139fa03181a3d787236924b385c17a898dcad47a89e263cc2598769caf9b2767bdf32e6fcb4cac1d8d5421b1b8cf0562
+  metadata.gz: 938451e922d130af494c37d73612b35c53e05a94143d1cabff3e725b4512fbc4a04e1bf7acc27be0e8b37ebc7b00a2d9859e4f073c0941aeada7a1ed396889db
+  data.tar.gz: f2925b82e2fb217f63d0afa4890c71f7ff6e209ee7775e33b9fb4a3885dce9bd638e46b8280f58f3f5002b020fd3e07792c560c3e44ed4b182dbfcefa2c66978

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  schedule:
+    - cron: "00 15 * * *"
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - jruby
+          - truffleruby-head
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake spec

data/.gitignore

@@ -2,3 +2,4 @@ coverage
 .yardoc
 doc
 Gemfile.lock
+/pkg/

data/CHANGES

@@ -1,3 +1,20 @@
+0.9.1
+
+  * Fix Slim's error in AttributeMerger due to 0.9.0's :capture_generator (#137)
+  * Fix Temple::ERB::Engine's <%= to not escape and <%== to escape expressions
+
+0.9.0
+
+  * Require Ruby 2.5+ (#131)
+  * Change default :capture_generator to self (#113)
+  * Improve compatibility with Rails 7.1 (#135)
+  * Support Rails 6.1's annotate_rendered_view_with_filenames
+    with Temple::Filters::Ambles (#134)
+  * Fix a crash in StringSplitter filter (#138)
+  * Fix a warning by Object#=~ since Ruby 2.6 (#129)
+  * Fix deprecated Tilt template mime type (#108)
+  * Stop using deprecated EscapeUtils from Temple::Utils (#136)
+
 0.8.2
 
   * Support TruffleRuby in Temple::Filters::StaticAnalyzer (#127)
@@ -16,7 +33,7 @@
 
 0.7.8
 
-  * Fix an warning in StaticAnalyzer
+  * Fix a warning in StaticAnalyzer
 
 0.7.7
 

data/README.md

@@ -1,7 +1,7 @@
 Temple
 ======
 
-[![Build Status](https://secure.travis-ci.org/judofyr/temple.svg?branch=master)](http://travis-ci.org/judofyr/temple) [![Code Climate](https://codeclimate.com/github/judofyr/temple.svg)](https://codeclimate.com/github/judofyr/temple) [![Gem Version](https://badge.fury.io/rb/temple.svg)](https://rubygems.org/gems/temple)
+[![test](https://github.com/judofyr/temple/actions/workflows/test.yml/badge.svg)](https://github.com/judofyr/temple/actions/workflows/test.yml) [![Code Climate](https://codeclimate.com/github/judofyr/temple.svg)](https://codeclimate.com/github/judofyr/temple) [![Gem Version](https://badge.fury.io/rb/temple.svg)](https://rubygems.org/gems/temple) [![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/gems/temple/frames)
 
 Temple is an abstraction and a framework for compiling templates to pure Ruby.
 It's all about making it easier to experiment, implement and optimize template

data/Rakefile

@@ -1,15 +1,8 @@
-require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-task default: :test
-task :test do
-  sh "bacon -Ilib -Itest --automatic --quiet"
-end
-
-#Rake::TestTask.new(:test) do |t|
-#  t.libs << 'lib' << 'test'
-#  t.pattern = 'test/**/test_*.rb'
-#  t.verbose = false
-#end
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
 
 begin
   require 'rcov/rcovtask'

data/lib/temple/erb/parser.rb

@@ -27,7 +27,7 @@ module Temple
             when '#'
               result << [:code, "\n" * code.count("\n")]
             when /=/
-              result << [:escape, indicator.size <= 1, [:dynamic, code]]
+              result << [:escape, indicator.size == 2, [:dynamic, code]]
             else
               result << [:code, code]
             end

data/lib/temple/filters/ambles.rb

@@ -0,0 +1,21 @@
+module Temple
+  module Filters
+    class Ambles < Filter
+      define_options :preamble, :postamble
+
+      def initialize(*)
+        super
+        @preamble = options[:preamble]
+        @postamble = options[:postamble]
+      end
+
+      def call(ast)
+        ret = [:multi]
+        ret << [:static, @preamble] if @preamble
+        ret << ast
+        ret << [:static, @postamble] if @postamble
+        ret
+      end
+    end
+  end
+end

data/lib/temple/filters/string_splitter.rb

@@ -46,6 +46,7 @@ module Temple
 
               case type
               when :on_tstring_content
+                beg_str, end_str = escape_quotes(beg_str, end_str)
                 exps << [:static, eval("#{beg_str}#{str}#{end_str}").to_s]
               when :on_embexpr_beg
                 embedded = shift_balanced_embexpr(tokens)
@@ -54,6 +55,16 @@ module Temple
             end
           end
 
+          # Some quotes are split-unsafe. Replace such quotes with null characters.
+          def escape_quotes(beg_str, end_str)
+            case [beg_str[-1], end_str]
+            when ['(', ')'], ['[', ']'], ['{', '}']
+              [beg_str.sub(/.\z/) { "\0" }, "\0"]
+            else
+              [beg_str, end_str]
+            end
+          end
+
           def shift_balanced_embexpr(tokens)
             String.new.tap do |embedded|
               embexpr_open = 1

data/lib/temple/generator.rb

@@ -10,7 +10,7 @@ module Temple
     include Mixins::Options
 
     define_options :save_buffer,
-                   capture_generator: 'StringBuffer',
+                   capture_generator: :self,
                    buffer: '_buf',
                    freeze_static: RUBY_VERSION >= '2.1'
 
@@ -54,7 +54,7 @@ module Temple
     end
 
     def on_capture(name, exp)
-      capture_generator.new(buffer: name).call(exp)
+      capture_generator.new(**options, buffer: name).call(exp)
     end
 
     def on_static(text)
@@ -76,9 +76,15 @@ module Temple
     end
 
     def capture_generator
-      @capture_generator ||= Class === options[:capture_generator] ?
-      options[:capture_generator] :
-        Generators.const_get(options[:capture_generator])
+      @capture_generator ||=
+        case options[:capture_generator]
+        when :self
+          self.class
+        when Class
+          options[:capture_generator]
+        else
+          Generators.const_get(options[:capture_generator])
+        end
     end
 
     def concat(str)

data/lib/temple/generators/rails_output_buffer.rb

@@ -10,7 +10,7 @@ module Temple
     # @api public
     class RailsOutputBuffer < StringBuffer
       define_options :streaming,
-                     buffer_class: 'ActiveSupport::SafeBuffer',
+                     buffer_class: 'ActionView::OutputBuffer',
                      buffer: '@output_buffer',
                      # output_buffer is needed for Rails 3.1 Streaming support
                      capture_generator: RailsOutputBuffer
@@ -20,11 +20,7 @@ module Temple
       end
 
       def create_buffer
-        if options[:streaming] && options[:buffer] == '@output_buffer'
-          "#{buffer} = output_buffer || #{options[:buffer_class]}.new"
-        else
-          "#{buffer} = #{options[:buffer_class]}.new"
-        end
+        "#{buffer} = output_buffer || #{options[:buffer_class]}.new"
       end
 
       def concat(str)

data/lib/temple/mixins/grammar_dsl.rb

@@ -143,7 +143,8 @@ module Temple
           start = Or.new(self)
           curr = [start]
           rule.each do |elem|
-            if elem =~ /^(.*)(\*|\?|\+)$/
+            case elem
+            when /^(.*)(\*|\?|\+)$/
               elem = Element.new(self, const_get($1))
               curr.each {|c| c << elem }
               elem << elem if $2 != '?'

data/lib/temple/templates/rails.rb

@@ -5,6 +5,10 @@ module Temple
 
       def call(template, source = nil)
         opts = {}.update(self.class.options).update(file: template.identifier)
+        if ActionView::Base.try(:annotate_rendered_view_with_filenames) && template.format == :html
+          opts[:preamble] = "<!-- BEGIN #{template.short_identifier} -->\n"
+          opts[:postamble] = "<!-- END #{template.short_identifier} -->\n"
+        end
         self.class.compile((source || template.source), opts)
       end
 

data/lib/temple/templates/tilt.rb

@@ -7,14 +7,6 @@ module Temple
 
       define_options mime_type: 'text/html'
 
-      def self.default_mime_type
-        options[:mime_type]
-      end
-
-      def self.default_mime_type=(mime_type)
-        options[:mime_type] = mime_type
-      end
-
       # Prepare Temple template
       #
       # Called immediately after template data is loaded.
@@ -22,7 +14,7 @@ module Temple
       # @return [void]
       def prepare
         opts = {}.update(self.class.options).update(options).update(file: eval_file)
-        opts.delete(:mime_type)
+        metadata[:mime_type] = opts.delete(:mime_type)
         if opts.include?(:outvar)
           opts[:buffer] = opts.delete(:outvar)
           opts[:save_buffer] = true

data/lib/temple/utils.rb

@@ -1,10 +1,6 @@
 begin
-  require 'escape_utils'
+  require 'cgi/escape'
 rescue LoadError
-  begin
-    require 'cgi/escape'
-  rescue LoadError
-  end
 end
 
 module Temple
@@ -21,15 +17,7 @@ module Temple
       html.html_safe? ? html : escape_html(html)
     end
 
-    if defined?(EscapeUtils)
-      # Returns an escaped copy of `html`.
-      #
-      # @param html [String] The string to escape
-      # @return [String] The escaped string
-      def escape_html(html)
-        EscapeUtils.escape_html(html.to_s, false)
-      end
-    elsif defined?(CGI.escapeHTML)
+    if defined?(CGI.escapeHTML)
       # Returns an escaped copy of `html`.
       #
       # @param html [String] The string to escape

data/lib/temple/version.rb

@@ -1,3 +1,3 @@
 module Temple
-  VERSION = '0.8.2'
+  VERSION = '0.9.1'
 end

data/lib/temple.rb

@@ -41,6 +41,7 @@ module Temple
   end
 
   module Filters
+    autoload :Ambles,             'temple/filters/ambles'
     autoload :CodeMerger,         'temple/filters/code_merger'
     autoload :ControlFlow,        'temple/filters/control_flow'
     autoload :MultiFlattener,     'temple/filters/multi_flattener'

data/spec/engine_spec.rb

@@ -0,0 +1,189 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+class Callable1
+  def call(exp)
+    exp
+  end
+end
+
+class Callable2
+  def call(exp)
+    exp
+  end
+end
+
+class MySpecialFilter
+  def initialize(opts = {})
+  end
+
+  def call(exp)
+    exp
+  end
+end
+
+class TestEngine < Temple::Engine
+  use(:Parser) do |input|
+    [:static, input]
+  end
+  use :MyFilter1, proc {|exp| exp }
+  use :MyFilter2, proc {|exp| exp }
+  use Temple::HTML::Pretty, pretty: true
+  filter :MultiFlattener
+  generator :ArrayBuffer
+  use(:BeforeBeforeLast) { MySpecialFilter }
+  use :BeforeLast, Callable1.new
+  use(:Last) { Callable2.new }
+end
+
+describe Temple::Engine do
+  it 'should build chain' do
+    expect(TestEngine.chain.size).to eq(9)
+
+    expect(TestEngine.chain[0].first).to eq(:Parser)
+    expect(TestEngine.chain[0].size).to eq(2)
+    expect(TestEngine.chain[0].last).to be_a(Proc)
+
+    expect(TestEngine.chain[1].first).to eq(:MyFilter1)
+    expect(TestEngine.chain[1].size).to eq(2)
+    expect(TestEngine.chain[1].last).to be_a(Proc)
+
+    expect(TestEngine.chain[2].first).to eq(:MyFilter2)
+    expect(TestEngine.chain[2].size).to eq(2)
+    expect(TestEngine.chain[2].last).to be_a(Proc)
+
+    expect(TestEngine.chain[3].first).to eq(:'Temple::HTML::Pretty')
+    expect(TestEngine.chain[3].size).to eq(2)
+    expect(TestEngine.chain[3].last).to be_a(Proc)
+
+    expect(TestEngine.chain[4].first).to eq(:MultiFlattener)
+    expect(TestEngine.chain[4].size).to eq(2)
+    expect(TestEngine.chain[4].last).to be_a(Proc)
+
+    expect(TestEngine.chain[5].first).to eq(:ArrayBuffer)
+    expect(TestEngine.chain[5].size).to eq(2)
+    expect(TestEngine.chain[5].last).to be_a(Proc)
+
+    expect(TestEngine.chain[6].first).to eq(:BeforeBeforeLast)
+    expect(TestEngine.chain[6].size).to eq(2)
+    expect(TestEngine.chain[6].last).to be_a(Proc)
+
+    expect(TestEngine.chain[7].first).to eq(:BeforeLast)
+    expect(TestEngine.chain[7].size).to eq(2)
+    expect(TestEngine.chain[7].last).to be_a(Proc)
+
+    expect(TestEngine.chain[8].first).to eq(:Last)
+    expect(TestEngine.chain[8].size).to eq(2)
+    expect(TestEngine.chain[8].last).to be_a(Proc)
+  end
+
+  it 'should instantiate chain' do
+    call_chain = TestEngine.new.send(:call_chain)
+    expect(call_chain[0]).to be_a(Method)
+    expect(call_chain[1]).to be_a(Method)
+    expect(call_chain[2]).to be_a(Method)
+    expect(call_chain[3]).to be_a(Temple::HTML::Pretty)
+    expect(call_chain[4]).to be_a(Temple::Filters::MultiFlattener)
+    expect(call_chain[5]).to be_a(Temple::Generators::ArrayBuffer)
+    expect(call_chain[6]).to be_a(MySpecialFilter)
+    expect(call_chain[7]).to be_a(Callable1)
+    expect(call_chain[8]).to be_a(Callable2)
+  end
+
+  it 'should have #append' do
+    engine = TestEngine.new
+    call_chain = engine.send(:call_chain)
+    expect(call_chain.size).to eq(9)
+
+    engine.append :MyFilter3 do |exp|
+      exp
+    end
+
+    expect(TestEngine.chain.size).to eq(9)
+    expect(engine.chain.size).to eq(10)
+    expect(engine.chain[9].first).to eq(:MyFilter3)
+    expect(engine.chain[9].size).to eq(2)
+    expect(engine.chain[9].last).to be_a(Proc)
+
+    call_chain = engine.send(:call_chain)
+    expect(call_chain.size).to eq(10)
+    expect(call_chain[9]).to be_a(Method)
+  end
+
+  it 'should have #prepend' do
+    engine = TestEngine.new
+    call_chain = engine.send(:call_chain)
+    expect(call_chain.size).to eq(9)
+
+    engine.prepend :MyFilter0 do |exp|
+      exp
+    end
+
+    expect(TestEngine.chain.size).to eq(9)
+    expect(engine.chain.size).to eq(10)
+    expect(engine.chain[0].first).to eq(:MyFilter0)
+    expect(engine.chain[0].size).to eq(2)
+    expect(engine.chain[0].last).to be_a(Proc)
+    expect(engine.chain[1].first).to eq(:Parser)
+
+    call_chain = engine.send(:call_chain)
+    expect(call_chain.size).to eq(10)
+    expect(call_chain[0]).to be_a(Method)
+  end
+
+  it 'should have #after' do
+    engine = TestEngine.new
+    engine.after :Parser, :MyFilter0 do |exp|
+      exp
+    end
+    expect(TestEngine.chain.size).to eq(9)
+    expect(engine.chain.size).to eq(10)
+    expect(engine.chain[0].first).to eq(:Parser)
+    expect(engine.chain[1].first).to eq(:MyFilter0)
+    expect(engine.chain[2].first).to eq(:MyFilter1)
+  end
+
+  it 'should have #before' do
+    engine = TestEngine.new
+    engine.before :MyFilter1, :MyFilter0 do |exp|
+      exp
+    end
+    expect(TestEngine.chain.size).to eq(9)
+    expect(engine.chain.size).to eq(10)
+    expect(engine.chain[0].first).to eq(:Parser)
+    expect(engine.chain[1].first).to eq(:MyFilter0)
+    expect(engine.chain[2].first).to eq(:MyFilter1)
+  end
+
+  it 'should have #remove' do
+    engine = TestEngine.new
+    engine.remove :MyFilter1
+    expect(TestEngine.chain.size).to eq(9)
+    expect(engine.chain.size).to eq(8)
+    expect(engine.chain[0].first).to eq(:Parser)
+    expect(engine.chain[1].first).to eq(:MyFilter2)
+
+    engine = TestEngine.new
+    engine.remove /Last/
+    expect(engine.chain.size).to eq(6)
+  end
+
+  it 'should have #replace' do
+    engine = TestEngine.new
+    engine.replace :Parser, :MyParser do |exp|
+      exp
+    end
+    expect(engine.chain.size).to eq(9)
+    expect(engine.chain[0].first).to eq(:MyParser)
+  end
+
+  it 'should work with inheritance' do
+    inherited_engine = Class.new(TestEngine)
+    expect(inherited_engine.chain.size).to eq(9)
+    inherited_engine.append :MyFilter3 do |exp|
+      exp
+    end
+    expect(inherited_engine.chain.size).to eq(10)
+    expect(TestEngine.chain.size).to eq(9)
+  end
+end

data/{test/test_erb.rb → spec/erb_spec.rb}

@@ -1,5 +1,5 @@
-require 'helper'
-require 'tilt/erubis'
+require 'spec_helper'
+require 'tilt/erubi'
 
 describe Temple::ERB::Engine do
   it 'should compile erb' do
@@ -11,7 +11,7 @@ describe Temple::ERB::Engine do
 <% end %>
 }
 
-    erb(src).should.equal erubis(src)
+    expect(erb(src)).to eq(erubi(src))
   end
 
   it 'should recognize comments' do
@@ -20,7 +20,7 @@ hello
   <%# comment -- ignored -- useful in testing %>
 world}
 
-    erb(src).should.equal erubis(src)
+    expect(erb(src)).to eq(erubi(src))
   end
 
   it 'should recognize <%% and %%>' do
@@ -31,19 +31,19 @@ world}
 <% end %>
 }
 
-    erb(src).should.equal "\n<%\n  %>\n"
+    expect(erb(src)).to eq("\n<%\n  %>\n")
   end
 
   it 'should escape automatically' do
-    src = '<%= "<" %>'
+    src = '<%== "<" %>'
     ans = '&lt;'
-    erb(src).should.equal ans
+    expect(erb(src)).to eq(ans)
   end
 
-  it 'should support == to disable automatic escape' do
-    src = '<%== "<" %>'
+  it 'should support = to disable automatic escape' do
+    src = '<%= "<" %>'
     ans = '<'
-    erb(src).should.equal ans
+    expect(erb(src)).to eq(ans)
   end
 
   it 'should support trim mode' do
@@ -55,7 +55,7 @@ world}
 <% end %>
 }
 
-    erb(src, trim: true).should.equal erubis(src, trim: true)
-    erb(src, trim: false).should.equal erubis(src, trim: false)
+    expect(erb(src, trim: true)).to eq(erubi(src, trim: true))
+    expect(erb(src, trim: false)).to eq(erubi(src, trim: false))
   end
 end

data/spec/filter_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+class SimpleFilter < Temple::Filter
+  define_options :key
+
+  def on_test(arg)
+    [:on_test, arg]
+  end
+end
+
+describe Temple::Filter do
+  it 'should support options' do
+    expect(Temple::Filter).to respond_to(:default_options)
+    expect(Temple::Filter).to respond_to(:set_default_options)
+    expect(Temple::Filter).to respond_to(:define_options)
+    expect(Temple::Filter.new.options).to be_a(Temple::ImmutableMap)
+    expect(SimpleFilter.new(key: 3).options[:key]).to eq(3)
+  end
+
+  it 'should implement call' do
+    expect(Temple::Filter.new.call([:exp])).to eq([:exp])
+  end
+
+  it 'should process expressions' do
+    filter = SimpleFilter.new
+    expect(filter.call([:unhandled])).to eq([:unhandled])
+    expect(filter.call([:test, 42])).to eq([:on_test, 42])
+  end
+end

data/{test/filters/test_code_merger.rb → spec/filters/code_merger_spec.rb}

@@ -1,4 +1,4 @@
-require 'helper'
+require 'spec_helper'
 
 describe Temple::Filters::CodeMerger do
   before do
@@ -6,21 +6,21 @@ describe Temple::Filters::CodeMerger do
   end
 
   it 'should merge serveral codes' do
-    @filter.call([:multi,
+    expect(@filter.call([:multi,
       [:code, "a"],
       [:code, "b"],
       [:code, "c"]
-    ]).should.equal [:code, "a; b; c"]
+    ])).to eq [:code, "a; b; c"]
   end
 
   it 'should merge serveral codes around static' do
-    @filter.call([:multi,
+    expect(@filter.call([:multi,
       [:code, "a"],
       [:code, "b"],
       [:static, "123"],
       [:code, "a"],
       [:code, "b"]
-    ]).should.equal [:multi,
+    ])).to eq [:multi,
       [:code, "a; b"],
       [:static, "123"],
       [:code, "a; b"]
@@ -28,11 +28,11 @@ describe Temple::Filters::CodeMerger do
   end
 
   it 'should merge serveral codes with newlines' do
-    @filter.call([:multi,
+    expect(@filter.call([:multi,
       [:code, "a"],
       [:code, "b"],
       [:newline],
       [:code, "c"]
-    ]).should.equal [:code, "a; b\nc"]
+    ])).to eq [:code, "a; b\nc"]
   end
 end