tilt 1.4.1 → 2.0.11

data/lib/tilt.rb

@@ -1,132 +1,111 @@
+require 'tilt/mapping'
+require 'tilt/template'
+
+# Namespace for Tilt. This module is not intended to be included anywhere.
 module Tilt
-  VERSION = '1.4.1'
+  # Current version.
+  VERSION = '2.0.11'
 
-  @preferred_mappings = Hash.new
-  @template_mappings = Hash.new { |h, k| h[k] = [] }
+  @default_mapping = Mapping.new
 
-  # Hash of template path pattern => template implementation class mappings.
-  def self.mappings
-    @template_mappings
+  # @return [Tilt::Mapping] the main mapping object
+  def self.default_mapping
+    @default_mapping
   end
 
-  def self.normalize(ext)
-    ext.to_s.downcase.sub(/^\./, '')
+  # @private
+  def self.lazy_map
+    default_mapping.lazy_map
   end
 
-  # Register a template implementation by file extension.
+  # @see Tilt::Mapping#register
   def self.register(template_class, *extensions)
-    if template_class.respond_to?(:to_str)
-      # Support register(ext, template_class) too
-      extensions, template_class = [template_class], extensions[0]
-    end
+    default_mapping.register(template_class, *extensions)
+  end
 
-    extensions.each do |ext|
-      ext = normalize(ext)
-      mappings[ext].unshift(template_class).uniq!
-    end
+  # @see Tilt::Mapping#register_lazy
+  def self.register_lazy(class_name, file, *extensions)
+    default_mapping.register_lazy(class_name, file, *extensions)
   end
 
-  # Makes a template class preferred for the given file extensions. If you
-  # don't provide any extensions, it will be preferred for all its already
-  # registered extensions:
-  #
-  #   # Prefer RDiscount for its registered file extensions:
-  #   Tilt.prefer(Tilt::RDiscountTemplate)
-  #
-  #   # Prefer RDiscount only for the .md extensions:
-  #   Tilt.prefer(Tilt::RDiscountTemplate, '.md')
+  # @deprecated Use {register} instead.
   def self.prefer(template_class, *extensions)
-    if extensions.empty?
-      mappings.each do |ext, klasses|
-        @preferred_mappings[ext] = template_class if klasses.include? template_class
-      end
-    else
-      extensions.each do |ext|
-        ext = normalize(ext)
-        register(template_class, ext)
-        @preferred_mappings[ext] = template_class
-      end
-    end
+    register(template_class, *extensions)
   end
 
-  # Returns true when a template exists on an exact match of the provided file extension
+  # @see Tilt::Mapping#registered?
   def self.registered?(ext)
-    mappings.key?(ext.downcase) && !mappings[ext.downcase].empty?
+    default_mapping.registered?(ext)
   end
 
-  # Create a new template for the given file using the file's extension
-  # to determine the the template mapping.
+  # @see Tilt::Mapping#new
   def self.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
+    default_mapping.new(file, line, options, &block)
   end
 
-  # Lookup a template class for the given filename or file
-  # extension. Return nil when no implementation is found.
+  # @see Tilt::Mapping#[]
   def self.[](file)
-    pattern = file.to_s.downcase
-    until pattern.empty? || registered?(pattern)
-      pattern = File.basename(pattern)
-      pattern.sub!(/^[^.]*\.?/, '')
-    end
-
-    # Try to find a preferred engine.
-    preferred_klass = @preferred_mappings[pattern]
-    return preferred_klass if preferred_klass
-
-    # Fall back to the general list of mappings.
-    klasses = @template_mappings[pattern]
-
-    # Try to find an engine which is already loaded.
-    template = klasses.detect do |klass|
-      if klass.respond_to?(:engine_initialized?)
-        klass.engine_initialized?
-      end
-    end
-
-    return template if template
-
-    # Try each of the classes until one succeeds. If all of them fails,
-    # we'll raise the error of the first class.
-    first_failure = nil
+    default_mapping[file]
+  end
 
-    klasses.each do |klass|
-      begin
-        klass.new { '' }
-      rescue Exception => ex
-        first_failure ||= ex
-        next
-      else
-        return klass
-      end
-    end
+  # @see Tilt::Mapping#template_for
+  def self.template_for(file)
+    default_mapping.template_for(file)
+  end
 
-    raise first_failure if first_failure
+  # @see Tilt::Mapping#templates_for
+  def self.templates_for(file)
+    default_mapping.templates_for(file)
   end
 
-  # Deprecated module.
-  module CompileSite
+  # @return the template object that is currently rendering.
+  #
+  # @example
+  #   tmpl = Tilt['index.erb'].new { '<%= Tilt.current_template %>' }
+  #   tmpl.render == tmpl.to_s
+  #
+  # @note This is currently an experimental feature and might return nil
+  #   in the future.
+  def self.current_template
+    Thread.current[:tilt_current_template]
   end
 
   # Extremely simple template cache implementation. Calling applications
   # create a Tilt::Cache instance and use #fetch with any set of hashable
   # arguments (such as those to Tilt.new):
-  #   cache = Tilt::Cache.new
-  #   cache.fetch(path, line, options) { Tilt.new(path, line, options) }
+  #
+  #     cache = Tilt::Cache.new
+  #     cache.fetch(path, line, options) { Tilt.new(path, line, options) }
   #
   # Subsequent invocations return the already loaded template object.
+  #
+  # @note
+  #   Tilt::Cache is a thin wrapper around Hash.  It has the following
+  #   limitations:
+  #   * Not thread-safe.
+  #   * Size is unbounded.
+  #   * Keys are not copied defensively, and should not be modified after
+  #     being passed to #fetch.  More specifically, the values returned by
+  #     key#hash and key#eql? should not change.
+  #   If this is too limiting for you, use a different cache implementation.
   class Cache
     def initialize
       @cache = {}
     end
 
+    # Caches a value for key, or returns the previously cached value.
+    # If a value has been previously cached for key then it is
+    # returned. Otherwise, block is yielded to and its return value
+    # which may be nil, is cached under key and returned.
+    # @yield
+    # @yieldreturn the value to cache for key
     def fetch(*key)
-      @cache[key] ||= yield
+      @cache.fetch(key) do
+        @cache[key] = yield
+      end
     end
 
+    # Clears the cache.
     def clear
       @cache = {}
     end
@@ -135,70 +114,54 @@ module Tilt
 
   # Template Implementations ================================================
 
-  require 'tilt/string'
-  register StringTemplate, 'str'
-
-  require 'tilt/erb'
-  register ERBTemplate,    'erb', 'rhtml'
-  register ErubisTemplate, 'erb', 'rhtml', 'erubis'
-
-  require 'tilt/etanni'
-  register EtanniTemplate, 'etn', 'etanni'
-
-  require 'tilt/haml'
-  register HamlTemplate,   'haml'
-
-  require 'tilt/css'
-  register SassTemplate, 'sass'
-  register ScssTemplate, 'scss'
-  register LessTemplate, 'less'
-
-  require 'tilt/csv'
-  register CSVTemplate, 'rcsv'
-
-  require 'tilt/coffee'
-  register CoffeeScriptTemplate, 'coffee'
-
-  require 'tilt/nokogiri'
-  register NokogiriTemplate, 'nokogiri'
-
-  require 'tilt/builder'
-  register BuilderTemplate,  'builder'
-
-  require 'tilt/markaby'
-  register MarkabyTemplate,  'mab'
-
-  require 'tilt/liquid'
-  register LiquidTemplate, 'liquid'
-
-  require 'tilt/radius'
-  register RadiusTemplate, 'radius'
-
-  require 'tilt/markdown'
-  register MarukuTemplate,    'markdown', 'mkd', 'md'
-  register KramdownTemplate,  'markdown', 'mkd', 'md'
-  register BlueClothTemplate, 'markdown', 'mkd', 'md'
-  register RDiscountTemplate, 'markdown', 'mkd', 'md'
-  register RedcarpetTemplate::Redcarpet1, 'markdown', 'mkd', 'md'
-  register RedcarpetTemplate::Redcarpet2, 'markdown', 'mkd', 'md'
-  register RedcarpetTemplate, 'markdown', 'mkd', 'md'
-
-  require 'tilt/textile'
-  register RedClothTemplate, 'textile'
-
-  require 'tilt/rdoc'
-  register RDocTemplate, 'rdoc'
-
-  require 'tilt/wiki'
-  register CreoleTemplate,    'wiki', 'creole'
-  register WikiClothTemplate, 'wiki', 'mediawiki', 'mw'
-
-  require 'tilt/yajl'
-  register YajlTemplate, 'yajl'
-
-  require 'tilt/asciidoc'
-  register AsciidoctorTemplate, 'ad', 'adoc', 'asciidoc'
-
-  require 'tilt/plain'
-  register PlainTemplate, 'html'
+  # ERB
+  register_lazy :ERBTemplate,    'tilt/erb',    'erb', 'rhtml'
+  register_lazy :ErubisTemplate, 'tilt/erubis', 'erb', 'rhtml', 'erubis'
+  register_lazy :ErubiTemplate,  'tilt/erubi',  'erb', 'rhtml', 'erubi'
+
+  # Markdown
+  register_lazy :BlueClothTemplate,    'tilt/bluecloth',    'markdown', 'mkd', 'md'
+  register_lazy :MarukuTemplate,       'tilt/maruku',       'markdown', 'mkd', 'md'
+  register_lazy :KramdownTemplate,     'tilt/kramdown',     'markdown', 'mkd', 'md'
+  register_lazy :RDiscountTemplate,    'tilt/rdiscount',    'markdown', 'mkd', 'md'
+  register_lazy :RedcarpetTemplate,    'tilt/redcarpet',    'markdown', 'mkd', 'md'
+  register_lazy :CommonMarkerTemplate, 'tilt/commonmarker', 'markdown', 'mkd', 'md'
+  register_lazy :PandocTemplate,       'tilt/pandoc',       'markdown', 'mkd', 'md'
+
+  # Rest (sorted by name)
+  register_lazy :AsciidoctorTemplate,  'tilt/asciidoc',  'ad', 'adoc', 'asciidoc'
+  register_lazy :BabelTemplate,        'tilt/babel',     'es6', 'babel', 'jsx'
+  register_lazy :BuilderTemplate,      'tilt/builder',   'builder'
+  register_lazy :CSVTemplate,          'tilt/csv',       'rcsv'
+  register_lazy :CoffeeScriptTemplate, 'tilt/coffee',    'coffee'
+  register_lazy :CoffeeScriptLiterateTemplate, 'tilt/coffee', 'litcoffee'
+  register_lazy :CreoleTemplate,       'tilt/creole',    'wiki', 'creole'
+  register_lazy :EtanniTemplate,       'tilt/etanni',    'etn', 'etanni'
+  register_lazy :HamlTemplate,         'tilt/haml',      'haml'
+  register_lazy :LessTemplate,         'tilt/less',      'less'
+  register_lazy :LiquidTemplate,       'tilt/liquid',    'liquid'
+  register_lazy :LiveScriptTemplate,   'tilt/livescript','ls'
+  register_lazy :MarkabyTemplate,      'tilt/markaby',   'mab'
+  register_lazy :NokogiriTemplate,     'tilt/nokogiri',  'nokogiri'
+  register_lazy :PlainTemplate,        'tilt/plain',     'html'
+  register_lazy :PrawnTemplate,        'tilt/prawn',     'prawn'
+  register_lazy :RDocTemplate,         'tilt/rdoc',      'rdoc'
+  register_lazy :RadiusTemplate,       'tilt/radius',    'radius'
+  register_lazy :RedClothTemplate,     'tilt/redcloth',  'textile'
+  register_lazy :RstPandocTemplate,    'tilt/rst-pandoc', 'rst'
+  register_lazy :SassTemplate,         'tilt/sass',      'sass'
+  register_lazy :ScssTemplate,         'tilt/sass',      'scss'
+  register_lazy :SigilTemplate,        'tilt/sigil',     'sigil'
+  register_lazy :StringTemplate,       'tilt/string',    'str'
+  register_lazy :TypeScriptTemplate,   'tilt/typescript', 'ts', 'tsx'
+  register_lazy :WikiClothTemplate,    'tilt/wikicloth', 'wiki', 'mediawiki', 'mw'
+  register_lazy :YajlTemplate,         'tilt/yajl',      'yajl'
+
+  # External template engines
+  register_lazy 'Slim::Template',            'slim',            'slim'
+  register_lazy 'Tilt::HandlebarsTemplate',  'tilt/handlebars', 'handlebars', 'hbs'
+  register_lazy 'Tilt::OrgTemplate',         'org-ruby',        'org'
+  register_lazy 'Tilt::EmacsOrgTemplate',    'tilt/emacs_org',  'org'
+  register_lazy 'Opal::Processor',           'opal',            'opal', 'rb'
+  register_lazy 'Tilt::JbuilderTemplate',    'tilt/jbuilder',   'jbuilder'
 end