tilt 2.1.0 → 2.3.0

data/lib/tilt/erb.rb

@@ -1,38 +1,30 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'erb'
 
 module Tilt
   # ERB template implementation. See:
   # http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html
   class ERBTemplate < Template
-    @@default_output_variable = '_erbout'
-
     SUPPORTS_KVARGS = ::ERB.instance_method(:initialize).parameters.assoc(:key) rescue false
 
-    def self.default_output_variable
-      @@default_output_variable
-    end
-
-    def self.default_output_variable=(name)
-      warn "#{self}.default_output_variable= has been replaced with the :outvar-option"
-      @@default_output_variable = name
-    end
-
     def prepare
       @freeze_string_literals = !!@options[:freeze]
-      @outvar = options[:outvar] || self.class.default_output_variable
-      trim = case options[:trim]
+      @outvar = @options[:outvar] || '_erbout'
+      trim = case @options[:trim]
       when false
         nil
       when nil, true
         '<>'
       else
-        options[:trim]
+        @options[:trim]
       end
       @engine = if SUPPORTS_KVARGS
-        ::ERB.new(data, trim_mode: trim, eoutvar: @outvar)
+        ::ERB.new(@data, trim_mode: trim, eoutvar: @outvar)
+      # :nocov:
       else
-        ::ERB.new(data, options[:safe], trim, @outvar)
+        ::ERB.new(@data, options[:safe], trim, @outvar)
+      # :nocov:
       end
     end
 

data/lib/tilt/erubi.rb

@@ -1,4 +1,5 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'erubi'
 
 module Tilt
@@ -12,7 +13,9 @@ module Tilt
   #                  instead of the default (which is ::Erubi::Engine).
   class ErubiTemplate < Template
     def prepare
-      @options.merge!(:preamble => false, :postamble => false, :ensure=>true)
+      @options[:preamble] = false
+      @options[:postamble] = false
+      @options[:ensure] = true
 
       engine_class = @options[:engine_class] || Erubi::Engine
 
@@ -34,11 +37,9 @@ module Tilt
         @options[:freeze_template_literals] = false
       end
 
-      @engine = engine_class.new(data, @options)
+      @engine = engine_class.new(@data, @options)
       @outvar = @engine.bufvar
-
-      # Remove dup after tilt supports frozen source.
-      @src = @engine.src.dup
+      @src = @engine.src
 
       @engine
     end

data/lib/tilt/erubis.rb

@@ -1,4 +1,5 @@
-require 'tilt/erb'
+# frozen_string_literal: true
+require_relative 'erb'
 require 'erubis'
 
 module Tilt
@@ -17,11 +18,13 @@ module Tilt
   class ErubisTemplate < ERBTemplate
     def prepare
       @freeze_string_literals = !!@options.delete(:freeze)
-      @outvar = options.delete(:outvar) || self.class.default_output_variable
-      @options.merge!(:preamble => false, :postamble => false, :bufvar => @outvar)
-      engine_class = options.delete(:engine_class)
-      engine_class = ::Erubis::EscapedEruby if options.delete(:escape_html)
-      @engine = (engine_class || ::Erubis::Eruby).new(data, options)
+      @outvar = @options.delete(:outvar) || '_erbout'
+      @options[:preamble] = false
+      @options[:postamble] = false
+      @options[:bufvar] = @outvar
+      engine_class = @options.delete(:engine_class)
+      engine_class = ::Erubis::EscapedEruby if @options.delete(:escape_html)
+      @engine = (engine_class || ::Erubis::Eruby).new(@data, @options)
     end
 
     def precompiled_preamble(locals)

data/lib/tilt/etanni.rb

@@ -1,4 +1,5 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 
 module Tilt
   class EtanniTemplate < Template
@@ -9,7 +10,7 @@ module Tilt
       stop = "\n#{separator}\n"
       replacement = "#{stop}\\1#{start}"
 
-      temp = data.strip
+      temp = @data.strip
       temp.gsub!(/<\?r\s+(.*?)\s+\?>/m, replacement)
 
       @code = "_out_ = [<<#{separator}.chomp!]\n#{temp}#{stop}_out_.join"

data/lib/tilt/haml.rb

@@ -1,4 +1,5 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'haml'
 
 module Tilt
@@ -14,13 +15,14 @@ module Tilt
       # `Gem::Version.correct?` may return false because of Haml::VERSION #=> "3.1.8 (Separated Sally)". After Haml 4, it's always correct.
       if Gem::Version.correct?(Haml::VERSION) && Gem::Version.new(Haml::VERSION) >= Gem::Version.new('5.0.0.beta.2')
         def prepare
-          options = {}.update(@options).update(filename: eval_file, line: line)
-          if options.include?(:outvar)
-            options[:buffer] = options.delete(:outvar)
-            options[:save_buffer] = true
+          @options[:filename] = eval_file
+          @options[:line] = @line
+          if @options.include?(:outvar)
+            @options[:buffer] = @options.delete(:outvar)
+            @options[:save_buffer] = true
           end
-          @engine = ::Haml::TempleEngine.new(options)
-          @engine.compile(data)
+          @engine = ::Haml::TempleEngine.new(@options)
+          @engine.compile(@data)
         end
 
         def evaluate(scope, locals, &block)
@@ -39,8 +41,9 @@ module Tilt
         end
       else # Following definitions are for Haml <= 4 and deprecated.
         def prepare
-          options = @options.merge(:filename => eval_file, :line => line)
-          @engine = ::Haml::Engine.new(data, options)
+          @options[:filename] = eval_file
+          @options[:line] = @line
+          @engine = ::Haml::Engine.new(@data, @options)
         end
 
         def evaluate(scope, locals, &block)

data/lib/tilt/kramdown.rb

@@ -1,25 +1,13 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'kramdown'
 
-module Tilt
-  # Kramdown Markdown implementation. See:
-  # http://kramdown.rubyforge.org/
-  class KramdownTemplate < Template
-    DUMB_QUOTES = [39, 39, 34, 34]
+dumb_quotes = [39, 39, 34, 34].freeze
 
-    def prepare
-      options[:smart_quotes] = DUMB_QUOTES unless options[:smartypants]
-      @engine = Kramdown::Document.new(data, options)
-      @output = nil
-    end
+# Kramdown Markdown implementation. See: https://kramdown.gettalong.org/
+Tilt::KramdownTemplate = Tilt::StaticTemplate.subclass do
+  # dup as Krawmdown modifies the passed option with map!
+  @options[:smart_quotes] = dumb_quotes.dup unless @options[:smartypants]
 
-    def evaluate(scope, locals, &block)
-      @output ||= @engine.to_html
-    end
-
-    def allows_script?
-      false
-    end
-  end
+  Kramdown::Document.new(@data, @options).to_html
 end
-

data/lib/tilt/liquid.rb

@@ -1,11 +1,12 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'liquid'
 
 module Tilt
   # Liquid template implementation. See:
   # http://liquidmarkup.org/
   #
-  # Liquid is designed to be a *safe* template system and threfore
+  # Liquid is designed to be a *safe* template system and therefore
   # does not provide direct access to execuatable scopes. In order to
   # support a +scope+, the +scope+ must be able to represent itself
   # as a hash by responding to #to_h. If the +scope+ does not respond
@@ -17,16 +18,17 @@ module Tilt
   # time when using this template engine.
   class LiquidTemplate < Template
     def prepare
-      @engine = ::Liquid::Template.parse(data, liquid_options)
+      @options[:line_numbers] = true unless @options.has_key?(:line_numbers)
+      @engine = ::Liquid::Template.parse(@data, @options)
     end
 
-    def evaluate(scope, locals, &block)
-      locals = locals.inject({}){ |h,(k,v)| h[k.to_s] = v ; h }
+    def evaluate(scope, locs)
+      locals = {}
       if scope.respond_to?(:to_h)
-        scope  = scope.to_h.inject({}){ |h,(k,v)| h[k.to_s] = v ; h }
-        locals = scope.merge(locals)
+        scope.to_h.each{|k, v| locals[k.to_s] = v}
       end
-      locals['yield'] = block.nil? ? '' : yield
+      locs.each{|k, v| locals[k.to_s] = v}
+      locals['yield'] = block_given? ? yield : ''
       locals['content'] = locals['yield']
       @engine.render(locals)
     end
@@ -34,11 +36,5 @@ module Tilt
     def allows_script?
       false
     end
-
-    private
-
-    def liquid_options
-      { line_numbers: true }.merge options
-    end
   end
 end

data/lib/tilt/livescript.rb

@@ -1,23 +1,11 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'livescript'
 
-module Tilt
-  # LiveScript template implementation. See:
-  # http://livescript.net/
-  #
-  # LiveScript templates do not support object scopes, locals, or yield.
-  class LiveScriptTemplate < Template
-    self.default_mime_type = 'application/javascript'
-
-    def prepare
-    end
-
-    def evaluate(scope, locals, &block)
-      @output ||= LiveScript.compile(data, options)
-    end
-
-    def allows_script?
-      false
-    end
-  end
+# LiveScript template implementation. See:
+# http://livescript.net/
+#
+# LiveScript templates do not support object scopes, locals, or yield.
+Tilt::LiveScriptTemplate = Tilt::StaticTemplate.subclass(mime_type: 'application/javascript') do
+  LiveScript.compile(@data, @options)
 end

data/lib/tilt/mapping.rb

@@ -1,7 +1,81 @@
-require 'monitor'
+# frozen_string_literal: true
 require_relative 'pipeline'
 
 module Tilt
+  # Private internal base class for both Mapping and FinalizedMapping, for the shared methods.
+  class BaseMapping
+    # Instantiates a new template class based on the file.
+    #
+    # @raise [RuntimeError] if there is no template class registered for the
+    #   file name.
+    #
+    # @example
+    #   mapping.new('index.mt') # => instance of MyEngine::Template
+    #
+    # @see Tilt::Template.new
+    def new(file, line=nil, options={}, &block)
+      if template_class = self[file]
+        template_class.new(file, line, options, &block)
+      else
+        fail "No template engine registered for #{File.basename(file)}"
+      end
+    end
+
+    # Looks up a template class based on file name and/or extension.
+    #
+    # @example
+    #   mapping['views/hello.erb'] # => Tilt::ERBTemplate
+    #   mapping['hello.erb']       # => Tilt::ERBTemplate
+    #   mapping['erb']             # => Tilt::ERBTemplate
+    #
+    # @return [template class]
+    def [](file)
+      _, ext = split(file)
+      ext && lookup(ext)
+    end
+
+    alias template_for []
+
+    # Looks up a list of template classes based on file name. If the file name
+    # has multiple extensions, it will return all template classes matching the
+    # extensions from the end.
+    #
+    # @example
+    #   mapping.templates_for('views/index.haml.erb')
+    #   # => [Tilt::ERBTemplate, Tilt::HamlTemplate]
+    #
+    # @return [Array<template class>]
+    def templates_for(file)
+      templates = []
+
+      while true
+        prefix, ext = split(file)
+        break unless ext
+        templates << lookup(ext)
+        file = prefix
+      end
+
+      templates
+    end
+
+    private
+
+    def split(file)
+      pattern = file.to_s.downcase
+      full_pattern = pattern.dup
+
+      until registered?(pattern)
+        return if pattern.empty?
+        pattern = File.basename(pattern)
+        pattern.sub!(/\A[^.]*\.?/, '')
+      end
+
+      prefix_size = full_pattern.size - pattern.size
+      [full_pattern[0,prefix_size-1], pattern]
+    end
+  end
+  private_constant :BaseMapping
+
   # Tilt::Mapping associates file extensions with template implementations.
   #
   #     mapping = Tilt::Mapping.new
@@ -39,16 +113,18 @@ module Tilt
   # the exception of the first, since that was the most preferred one.
   #
   #     mapping = Tilt::Mapping.new
-  #     mapping.register_lazy('Bluecloth::Template', 'bluecloth/template', 'md')
+  #     mapping.register_lazy('Maruku::Template', 'maruku/template', 'md')
   #     mapping.register_lazy('RDiscount::Template', 'rdiscount/template', 'md')
   #     mapping['index.md']
   #     # => RDiscount::Template
   #
   # In the previous example we say that RDiscount has a *higher priority* than
-  # BlueCloth. Tilt will first try to `require "rdiscount/template"`, falling
-  # back to `require "bluecloth/template"`. If none of these are successful,
+  # Maruku. Tilt will first try to `require "rdiscount/template"`, falling
+  # back to `require "maruku/template"`. If none of these are successful,
   # the first error will be raised.
-  class Mapping
+  class Mapping < BaseMapping
+    LOCK = Mutex.new
+
     # @private
     attr_reader :lazy_map, :template_map
 
@@ -59,8 +135,26 @@ module Tilt
 
     # @private
     def initialize_copy(other)
-      @template_map = other.template_map.dup
-      @lazy_map = other.lazy_map.dup
+      LOCK.synchronize do
+        @template_map = other.template_map.dup
+        @lazy_map = other.lazy_map.dup
+      end
+    end
+
+    # Return a finalized mapping. A finalized mapping will only include
+    # support for template libraries already loaded, and will not
+    # allow registering new template libraries or lazy loading template
+    # libraries not yet loaded. Finalized mappings improve performance
+    # by not requiring synchronization and ensure that the mapping will
+    # not attempt to load additional files (useful when restricting
+    # file system access after template libraries in use are loaded).
+    def finalized
+      LOCK.synchronize{@lazy_map.dup}.each do |pattern, classes|
+        register_defined_classes(LOCK.synchronize{classes.map(&:first)}, pattern)
+      end
+
+      # Check if a template class is already present
+      FinalizedMapping.new(LOCK.synchronize{@template_map.dup}.freeze)
     end
 
     # Registers a lazy template implementation by file extension. You
@@ -86,8 +180,9 @@ module Tilt
         class_name = "Tilt::#{class_name}"
       end
 
+      v = [class_name, file].freeze
       extensions.each do |ext|
-        @lazy_map[ext].unshift([class_name, file])
+        LOCK.synchronize{@lazy_map[ext].unshift(v)}
       end
     end
 
@@ -109,7 +204,10 @@ module Tilt
       end
 
       extensions.each do |ext|
-        @template_map[ext.to_s] = template_class
+        ext = ext.to_s
+        LOCK.synchronize do
+          @template_map[ext] = template_class
+        end
       end
     end
 
@@ -137,9 +235,9 @@ module Tilt
     #   mapping.register_pipeline('scss.erb', 'erb'=>{:outvar=>'@foo'})
     #   mapping.register_pipeline('scsserb', :extra_exts => 'scss.erb',
     #                             :templates=>['erb', 'scss'])
-    def register_pipeline(ext, options={})
+    def register_pipeline(ext, options=EMPTY_HASH)
       templates = options[:templates] || ext.split('.').reverse
-      templates = templates.map{|t| [self[t], options[t] || {}]}
+      templates = templates.map{|t| [self[t], options[t] || EMPTY_HASH]}
 
       klass = Class.new(Pipeline)
       klass.send(:const_set, :TEMPLATES, templates)
@@ -162,8 +260,10 @@ module Tilt
     def unregister(*extensions)
       extensions.each do |ext|
         ext = ext.to_s
-        @template_map.delete(ext)
-        @lazy_map.delete(ext)
+        LOCK.synchronize do
+          @template_map.delete(ext)
+          @lazy_map.delete(ext)
+        end
       end
 
       nil
@@ -178,119 +278,52 @@ module Tilt
     #   mapping.registered?('erb')  # => true
     #   mapping.registered?('nope') # => false
     def registered?(ext)
-      @template_map.has_key?(ext.downcase) or lazy?(ext)
-    end
-
-    # Instantiates a new template class based on the file.
-    #
-    # @raise [RuntimeError] if there is no template class registered for the
-    #   file name.
-    #
-    # @example
-    #   mapping.new('index.mt') # => instance of MyEngine::Template
-    #
-    # @see Tilt::Template.new
-    def new(file, line=nil, options={}, &block)
-      if template_class = self[file]
-        template_class.new(file, line, options, &block)
-      else
-        fail "No template engine registered for #{File.basename(file)}"
-      end
-    end
-
-    # Looks up a template class based on file name and/or extension.
-    #
-    # @example
-    #   mapping['views/hello.erb'] # => Tilt::ERBTemplate
-    #   mapping['hello.erb']       # => Tilt::ERBTemplate
-    #   mapping['erb']             # => Tilt::ERBTemplate
-    #
-    # @return [template class]
-    def [](file)
-      _, ext = split(file)
-      ext && lookup(ext)
-    end
-
-    alias template_for []
-
-    # Looks up a list of template classes based on file name. If the file name
-    # has multiple extensions, it will return all template classes matching the
-    # extensions from the end.
-    #
-    # @example
-    #   mapping.templates_for('views/index.haml.erb')
-    #   # => [Tilt::ERBTemplate, Tilt::HamlTemplate]
-    #
-    # @return [Array<template class>]
-    def templates_for(file)
-      templates = []
-
-      while true
-        prefix, ext = split(file)
-        break unless ext
-        templates << lookup(ext)
-        file = prefix
-      end
-
-      templates
+      ext_downcase = ext.downcase
+      LOCK.synchronize{@template_map.has_key?(ext_downcase)} or lazy?(ext)
     end
 
     # Finds the extensions the template class has been registered under.
     # @param [template class] template_class
     def extensions_for(template_class)
       res = []
-      template_map.each do |ext, klass|
+      LOCK.synchronize{@template_map.to_a}.each do |ext, klass|
         res << ext if template_class == klass
       end
-      lazy_map.each do |ext, choices|
-        res << ext if choices.any? { |klass, file| template_class.to_s == klass }
+      LOCK.synchronize{@lazy_map.to_a}.each do |ext, choices|
+        res << ext if LOCK.synchronize{choices.dup}.any? { |klass, file| template_class.to_s == klass }
       end
-      res.uniq
+      res.uniq!
+      res
     end
 
     private
 
     def lazy?(ext)
       ext = ext.downcase
-      @lazy_map.has_key?(ext) && !@lazy_map[ext].empty?
-    end
-
-    def split(file)
-      pattern = file.to_s.downcase
-      full_pattern = pattern.dup
-
-      until registered?(pattern)
-        return if pattern.empty?
-        pattern = File.basename(pattern)
-        pattern.sub!(/^[^.]*\.?/, '')
-      end
-
-      prefix_size = full_pattern.size - pattern.size
-      [full_pattern[0,prefix_size-1], pattern]
+      LOCK.synchronize{@lazy_map.has_key?(ext) && !@lazy_map[ext].empty?}
     end
 
     def lookup(ext)
-      @template_map[ext] || lazy_load(ext)
+      LOCK.synchronize{@template_map[ext]} || lazy_load(ext)
     end
 
-    LOCK = Monitor.new
-
-    def lazy_load(pattern)
-      return unless @lazy_map.has_key?(pattern)
-
-      LOCK.enter
-      entered = true
-
-      choices = @lazy_map[pattern]
-
-      # Check if a template class is already present
-      choices.each do |class_name, file|
+    def register_defined_classes(class_names, pattern)
+      class_names.each do |class_name|
         template_class = constant_defined?(class_name)
         if template_class
           register(template_class, pattern)
-          return template_class
+          yield template_class if block_given?
         end
       end
+    end
+
+    def lazy_load(pattern)
+      choices = LOCK.synchronize{@lazy_map[pattern].dup}
+
+      # Check if a template class is already present
+      register_defined_classes(choices.map(&:first), pattern) do |template_class|
+        return template_class
+      end
 
       first_failure = nil
 
@@ -309,9 +342,7 @@ module Tilt
         end
       end
 
-      raise first_failure if first_failure
-    ensure
-      LOCK.exit if entered
+      raise first_failure
     end
 
     # The proper behavior (in MRI) for autoload? is to
@@ -333,4 +364,49 @@ module Tilt
       end
     end
   end
+
+  # Private internal class for finalized mappings, which are frozen and
+  # cannot be modified.
+  class FinalizedMapping < BaseMapping
+    # Set the template map to use.  The template map should already
+    # be frozen, but this is an internal class, so it does not
+    # explicitly check for that.
+    def initialize(template_map)
+      @template_map = template_map
+      freeze
+    end
+
+    # Returns receiver, since instances are always frozen.
+    def dup
+      self
+    end
+
+    # Returns receiver, since instances are always frozen.
+    def clone(freeze: false)
+      self
+    end
+
+    # Return whether the given file extension has been registered.
+    def registered?(ext)
+      @template_map.has_key?(ext.downcase)
+    end
+
+    # Returns an aarry of all extensions the template class will
+    # be used for.
+    def extensions_for(template_class)
+      res = []
+      @template_map.each do |ext, klass|
+        res << ext if template_class == klass
+      end
+      res.uniq!
+      res
+    end
+
+    private
+
+    def lookup(ext)
+      @template_map[ext]
+    end
+  end
+  private_constant :FinalizedMapping
 end

data/lib/tilt/markaby.rb

@@ -1,4 +1,5 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'markaby'
 
 module Tilt
@@ -15,19 +16,16 @@ module Tilt
       end
     end
 
-    def prepare
-    end
-
     def evaluate(scope, locals, &block)
       builder = self.class.builder_class.new({}, scope)
       builder.locals = locals
 
-      if data.kind_of? Proc
-        (class << builder; self end).send(:define_method, :__run_markaby_tilt__, &data)
+      if @data.kind_of? Proc
+        (class << builder; self end).send(:define_method, :__run_markaby_tilt__, &@data)
       else
         builder.instance_eval <<-CODE, __FILE__, __LINE__
           def __run_markaby_tilt__
-            #{data}
+            #{@data}
           end
         CODE
       end