tilt 2.0.0 → 2.4.0

data/lib/tilt.rb

@@ -1,73 +1,93 @@
-require 'tilt/mapping'
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'tilt/mapping'
+require_relative 'tilt/template'
 
 # Namespace for Tilt. This module is not intended to be included anywhere.
 module Tilt
   # Current version.
-  VERSION = '2.0.0'
+  VERSION = '2.4.0'
+
+  EMPTY_HASH = {}.freeze
+  private_constant :EMPTY_HASH
 
   @default_mapping = Mapping.new
 
-  # @return [Tilt::Mapping] the main mapping object
-  def self.default_mapping
-    @default_mapping
+  # Replace the default mapping with a finalized version of the default
+  # mapping. This can be done to improve performance after the template
+  # libraries you desire to use have already been loaded.  Once this is
+  # is called, all attempts to modify the default mapping will fail.
+  # This also freezes Tilt itself.
+  def self.finalize!
+    return self if @default_mapping.is_a?(FinalizedMapping)
+
+    class << self
+      prepend(Module.new do
+        def lazy_map(*)
+          raise "Tilt.#{__callee__} not supported after Tilt.finalize! has been called"
+        end
+        alias register lazy_map
+        alias register_lazy lazy_map
+        alias register_pipeline lazy_map
+        alias prefer lazy_map
+      end)
+    end
+
+    @default_mapping = @default_mapping.finalized
+
+    freeze
   end
 
   # @private
   def self.lazy_map
-    default_mapping.lazy_map
+    @default_mapping.lazy_map
   end
 
   # @see Tilt::Mapping#register
   def self.register(template_class, *extensions)
-    default_mapping.register(template_class, *extensions)
+    @default_mapping.register(template_class, *extensions)
   end
 
   # @see Tilt::Mapping#register_lazy
   def self.register_lazy(class_name, file, *extensions)
-    default_mapping.register_lazy(class_name, file, *extensions)
+    @default_mapping.register_lazy(class_name, file, *extensions)
   end
 
-  # @deprecated Use {register} instead.
-  def self.prefer(template_class, *extensions)
-    register(template_class, *extensions)
+  # @see Tilt::Mapping#register_pipeline
+  def self.register_pipeline(ext, options=EMPTY_HASH)
+    @default_mapping.register_pipeline(ext, options)
   end
 
   # @see Tilt::Mapping#registered?
   def self.registered?(ext)
-    default_mapping.registered?(ext)
+    @default_mapping.registered?(ext)
   end
 
   # @see Tilt::Mapping#new
-  def self.new(file, line=nil, options={}, &block)
-    default_mapping.new(file, line, options, &block)
+  def self.new(file, line=nil, options=nil, &block)
+    @default_mapping.new(file, line, options, &block)
   end
 
   # @see Tilt::Mapping#[]
   def self.[](file)
-    default_mapping[file]
+    @default_mapping[file]
   end
 
   # @see Tilt::Mapping#template_for
   def self.template_for(file)
-    default_mapping.template_for(file)
+    @default_mapping.template_for(file)
   end
 
   # @see Tilt::Mapping#templates_for
   def self.templates_for(file)
-    default_mapping.templates_for(file)
+    @default_mapping.templates_for(file)
   end
 
-  # @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]
+  class << self
+    # @return [Tilt::Mapping] the main mapping object
+    attr_reader :default_mapping
+
+    # Alias register as prefer for Tilt 1.x compatibility.
+    alias prefer register
   end
 
   # Extremely simple template cache implementation. Calling applications
@@ -78,14 +98,31 @@ module Tilt
   #     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
 
-    # @see Cache
+    # 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.
@@ -93,45 +130,58 @@ module Tilt
       @cache = {}
     end
   end
-
+  # :nocov:
+  # TILT3: Remove Tilt::Cache
+  deprecate_constant :Cache if respond_to?(:deprecate_constant, true)
+  # :nocov:
 
   # Template Implementations ================================================
 
   # 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 :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', 'livescript'
   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 :SlimTemplate,         'tilt/slim',      'slim'
   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'
+  # TILT3: Remove
+  # Deprecated lazy loading of external template engines
+  register_lazy 'Tilt::HandlebarsTemplate',  'tilt/_handlebars', 'handlebars', 'hbs'
+  register_lazy 'Tilt::OrgTemplate',         'tilt/_org',        'org'
+  register_lazy 'Tilt::OrgTemplate',         'tilt/_emacs_org',  'org'
+  register_lazy 'Tilt::JbuilderTemplate',    'tilt/_jbuilder',   'jbuilder'
 end

metadata

@@ -1,162 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: tilt
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Ryan Tomayko
-autorequire: 
+- Magnus Holm
+- Jeremy Evans
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-11-30 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies: []
 description: Generic interface to multiple Ruby template engines
-email: r@tomayko.com
+email: code@jeremyevans.net
 executables:
 - tilt
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - COPYING
-- Gemfile
-- HACKING
-- README.md
-- Rakefile
 - bin/tilt
-- docs/TEMPLATES.md
-- docs/common.css
 - lib/tilt.rb
+- lib/tilt/_emacs_org.rb
+- lib/tilt/_handlebars.rb
+- lib/tilt/_jbuilder.rb
+- lib/tilt/_org.rb
 - lib/tilt/asciidoc.rb
-- lib/tilt/bluecloth.rb
+- lib/tilt/babel.rb
 - lib/tilt/builder.rb
+- lib/tilt/cli.rb
 - lib/tilt/coffee.rb
+- lib/tilt/commonmarker.rb
 - lib/tilt/creole.rb
 - lib/tilt/csv.rb
 - lib/tilt/erb.rb
+- lib/tilt/erubi.rb
 - lib/tilt/erubis.rb
 - lib/tilt/etanni.rb
 - lib/tilt/haml.rb
 - lib/tilt/kramdown.rb
-- lib/tilt/less.rb
 - lib/tilt/liquid.rb
+- lib/tilt/livescript.rb
 - lib/tilt/mapping.rb
 - lib/tilt/markaby.rb
 - lib/tilt/maruku.rb
 - lib/tilt/nokogiri.rb
+- lib/tilt/pandoc.rb
+- lib/tilt/pipeline.rb
 - lib/tilt/plain.rb
+- lib/tilt/prawn.rb
 - lib/tilt/radius.rb
 - lib/tilt/rdiscount.rb
 - lib/tilt/rdoc.rb
 - lib/tilt/redcarpet.rb
 - lib/tilt/redcloth.rb
+- lib/tilt/rst-pandoc.rb
 - lib/tilt/sass.rb
+- lib/tilt/slim.rb
 - lib/tilt/string.rb
 - lib/tilt/template.rb
+- lib/tilt/typescript.rb
 - lib/tilt/wikicloth.rb
 - lib/tilt/yajl.rb
-- test/markaby/locals.mab
-- test/markaby/markaby.mab
-- test/markaby/markaby_other_static.mab
-- test/markaby/render_twice.mab
-- test/markaby/scope.mab
-- test/markaby/yielding.mab
-- test/test_helper.rb
-- test/tilt_asciidoctor_test.rb
-- test/tilt_blueclothtemplate_test.rb
-- test/tilt_buildertemplate_test.rb
-- test/tilt_cache_test.rb
-- test/tilt_coffeescripttemplate_test.rb
-- test/tilt_compilesite_test.rb
-- test/tilt_creoletemplate_test.rb
-- test/tilt_csv_test.rb
-- test/tilt_erbtemplate_test.rb
-- test/tilt_erubistemplate_test.rb
-- test/tilt_etannitemplate_test.rb
-- test/tilt_hamltemplate_test.rb
-- test/tilt_kramdown_test.rb
-- test/tilt_lesstemplate_test.less
-- test/tilt_lesstemplate_test.rb
-- test/tilt_liquidtemplate_test.rb
-- test/tilt_mapping_test.rb
-- test/tilt_markaby_test.rb
-- test/tilt_markdown_test.rb
-- test/tilt_marukutemplate_test.rb
-- test/tilt_metadata_test.rb
-- test/tilt_nokogiritemplate_test.rb
-- test/tilt_radiustemplate_test.rb
-- test/tilt_rdiscounttemplate_test.rb
-- test/tilt_rdoctemplate_test.rb
-- test/tilt_redcarpettemplate_test.rb
-- test/tilt_redclothtemplate_test.rb
-- test/tilt_sasstemplate_test.rb
-- test/tilt_stringtemplate_test.rb
-- test/tilt_template_test.rb
-- test/tilt_test.rb
-- test/tilt_wikiclothtemplate_test.rb
-- test/tilt_yajltemplate_test.rb
-- tilt.gemspec
-homepage: http://github.com/rtomayko/tilt/
+homepage: https://github.com/jeremyevans/tilt
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/jeremyevans/tilt/issues
+  changelog_uri: https://github.com/jeremyevans/tilt/blob/master/CHANGELOG.md
+  mailing_list_uri: https://github.com/jeremyevans/tilt/discussions
+  source_code_uri: https://github.com/jeremyevans/tilt
+post_install_message:
 rdoc_options:
-- --line-numbers
-- --inline-source
-- --title
+- "--line-numbers"
+- "--inline-source"
+- "--title"
 - Tilt
-- --main
+- "--main"
 - Tilt
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
-specification_version: 2
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
 summary: Generic interface to multiple Ruby template engines
-test_files:
-- test/tilt_asciidoctor_test.rb
-- test/tilt_blueclothtemplate_test.rb
-- test/tilt_buildertemplate_test.rb
-- test/tilt_cache_test.rb
-- test/tilt_coffeescripttemplate_test.rb
-- test/tilt_compilesite_test.rb
-- test/tilt_creoletemplate_test.rb
-- test/tilt_csv_test.rb
-- test/tilt_erbtemplate_test.rb
-- test/tilt_erubistemplate_test.rb
-- test/tilt_etannitemplate_test.rb
-- test/tilt_hamltemplate_test.rb
-- test/tilt_kramdown_test.rb
-- test/tilt_lesstemplate_test.rb
-- test/tilt_liquidtemplate_test.rb
-- test/tilt_mapping_test.rb
-- test/tilt_markaby_test.rb
-- test/tilt_markdown_test.rb
-- test/tilt_marukutemplate_test.rb
-- test/tilt_metadata_test.rb
-- test/tilt_nokogiritemplate_test.rb
-- test/tilt_radiustemplate_test.rb
-- test/tilt_rdiscounttemplate_test.rb
-- test/tilt_rdoctemplate_test.rb
-- test/tilt_redcarpettemplate_test.rb
-- test/tilt_redclothtemplate_test.rb
-- test/tilt_sasstemplate_test.rb
-- test/tilt_stringtemplate_test.rb
-- test/tilt_template_test.rb
-- test/tilt_test.rb
-- test/tilt_wikiclothtemplate_test.rb
-- test/tilt_yajltemplate_test.rb
-has_rdoc: 
+test_files: []

data/CHANGELOG.md

@@ -1,61 +0,0 @@
-## master
-
-* Add Handlebars as external template engine (#204, judofyr, jimothyGator)
-* Add org-ruby as external template engine (#207, judofyr, minad)
-* Documentation typo (#208, elgalu)
-
-## 2.0.0.beta1 (2013-07-16)
-
-* Documentation typo (#202, chip)
-* Use YARD for documentation (#189, judofyr)
-* Add Slim as an external template engine (judofyr)
-* Add Tilt.templates_for (#121, judofyr)
-* Add Tilt.current_template (#151, judofyr)
-* Avoid loading all files in tilt.rb (#160, #187, judofyr)
-* Implement lazily required templates classes (#178, #187, judofyr)
-* Move #allows_script and default_mime_type to metadata (#187, judofyr)
-* Introduce Tilt::Mapping (#187, judofyr)
-* Make template compilation thread-safe (#191, judofyr)
-
-## 1.4.1 (2013-05-08)
-
-* Support Arrays in pre/postambles (#193, jbwiv)
-
-## 1.4.0 (2013-05-01)
-
-* Better encoding support
-
-## 1.3.7 (2013-04-09)
-
-* Erubis: Check for the correct constant (#183, mattwildig)
-* Don't fail when BasicObject is defined in 1.8 (#182, technobrat, judofyr)
-
-## 1.3.6 (2013-03-17)
-
-* Accept Hash that implements #path as options (#180, lawso017)
-* Changed extension for CsvTemplate from '.csv' to '.rcsv' (#177, alexgb)
-
-## 1.3.5 (2013-03-06)
-
-* Fixed extension for PlainTemplate (judofyr)
-* Improved local variables regexp (#174, razorinc)
-* Added CHANGELOG.md
-
-## 1.3.4 (2013-02-28)
-
-* Support RDoc 4.0 (#168, judofyr)
-* Add mention of Org-Mode support (#165, aslakknutsen)
-* Add AsciiDoctorTemplate (#163, #164, aslakknutsen)
-* Add PlainTextTemplate (nathanaeljones)
-* Restrict locals to valid variable names (#158, thinkerbot)
-* ERB: Improve trim mode support (#156, ssimeonov)
-* Add CSVTemplate (#153, alexgb)
-* Remove special case for 1.9.1 (#147, guilleiguaran)
-* Add allows\_script? method to Template (#143, bhollis)
-* Default to using Redcarpet2 (#139, DAddYE)
-* Allow File/Tempfile as filenames (#134, jamesotron)
-* Add EtanniTemplate (#131, manveru)
-* Support RDoc 3.10 (#112, timfel)
-* Always compile templates; remove old source evaluator (rtomayko)
-* Less: Options are now being passed to the parser (#106, cowboyd)
-

data/Gemfile

@@ -1,39 +0,0 @@
-source "http://rubygems.org"
-
-gem 'yard', '~> 0.8.6'
-gem 'minitest', '~> 5.0'
-
-gem 'rake'
-
-group :engines do
-  gem 'asciidoctor', '>= 0.1.0'
-  gem 'builder'
-  gem 'coffee-script'
-  gem 'contest'
-  gem 'creole'
-  gem 'erubis'
-  gem 'haml', '>= 2.2.11', '< 4'
-  gem 'kramdown'
-  gem 'less'
-  gem 'liquid'
-  gem 'markaby'
-  gem 'maruku'
-  gem 'nokogiri' if RUBY_VERSION > '1.9.2'
-  gem 'radius'
-  gem 'sass'
-  gem 'wikicloth'
-  gem 'rdoc', (ENV['RDOC_VERSION'] || '> 0')
-
-  platform :ruby do
-    gem 'yajl-ruby'
-    gem 'redcarpet' if RUBY_VERSION > '1.8.7'
-    gem 'rdiscount', '>= 2.1.6' if RUBY_VERSION != '1.9.2'
-    gem 'RedCloth'
-  end
-
-  platform :mri do
-    gem 'therubyracer'
-    gem 'bluecloth' if ENV['BLUECLOTH']
-  end
-end
-

data/HACKING

@@ -1,16 +0,0 @@
-Clone:
-
-    git clone git://github.com/rtomayko/tilt.git
-    cd tilt
-
-Install needed packages under ./vendor and run tests (requires bundler):
-
-    rake
-
-Run tests under your current gem environment. Do not install anything:
-
-    rake test
-
-Only install needed packages under ./vendor:
-
-    rake setup