tilt 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4277574fbcafae6077fd4e64a6528e3117cae4aa653a471ab9179942a1440a3a
-  data.tar.gz: 0ebc6d611b50d8ef82eb91b6b09a5184788909716c4f6961dac770537b02aae6
+  metadata.gz: 07376d5da37cfc37ba1364a962859139ab42e2c6453aea4bd5610c2daccee019
+  data.tar.gz: dc64be5c7fbf26c8f6def8e40c143a61de7e46ed69157d0b0a0c1a558b9e4d93
 SHA512:
-  metadata.gz: 0c1b60402b38beff691e96630126af11e12a596df74923718e5ef99e66b2961218456d2dc0e7b87af1d2256603cee8cc0dba6823c8e39613fd790ebe39bd9b58
-  data.tar.gz: a55b63755285f279625ccc296fd637e22f3931c46549712ec8105c312e2bf537fac38882492691d6c1ad788f76e418ded62cbd6e6b2e54e3f3819cfc2f61b045
+  metadata.gz: 20bc55f1b6cdceb99068e2a40ac0df35006b6f61c27a66f31606ee79e32df7431bef7e2d37ca6ecef5cc30ef131f7f19f340258d12a1836ce4aee2a1ad0a4b23
+  data.tar.gz: 409ef4a5ba49ec95425d810987b892d694aa3794ce937256c7673caea67dc9ef93f64fb1b5b399de0a0ada44d13424d305d63f3e9b96a6f346739f8a7491c2b3

data/lib/tilt/herb.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# = Herb (<tt>herb</tt>, <tt>html.erb</tt>)
+#
+# {Herb}[https://herb-tools.dev] is an HTML-aware ERB implementation, which parses the
+# HTML in the template in addition to the embedded Ruby.
+#
+# Herb's engine is API compatible with the Erubi engine, so all the documentation of
+# {Erubi}[rdoc-ref:lib/tilt/erubi.rb] applies in addition to the following:
+#
+# === Differences from Erubi
+#
+# Herb parses the HTML in the template, and raises <tt>Herb::Engine::CompilationError</tt>
+# when creating the template if the HTML is invalid (such as unclosed or mismatched tags),
+# or if the embedded Ruby has invalid syntax. Erubi inspects neither the HTML nor the Ruby;
+# with Erubi, invalid Ruby syntax instead raises a SyntaxError when Tilt compiles the
+# template, which by default does not happen until the template is first rendered.
+#
+# Herb escapes interpolated values based on where they appear in the document, using a
+# separate escape function for attribute values, <tt><script></tt> content, and
+# <tt><style></tt> content. Erubi uses a single escape function everywhere.
+#
+# Herb accepts additional engine options. As with the Erubi engine options, these are
+# passed through to the engine class. See
+# {Herb::Engine}[https://herb-tools.dev/projects/engine] for the full list.
+#
+# === Usage
+#
+# The <tt>Tilt::HerbTemplate</tt> class is registered for all files ending in <tt>.herb</tt> or
+# <tt>.html.erb</tt> by default. Unlike {Erubi}[rdoc-ref:lib/tilt/erubi.rb], it is not
+# registered for <tt>.erb</tt> or <tt>.rhtml</tt>, since that would change which engine is
+# used for existing templates. To use Herb for those as well, use:
+#
+#     Tilt.register Tilt::HerbTemplate, 'erb', 'rhtml'
+#
+# __NOTE:__ It's suggested that your program <tt>require 'herb'</tt> at load time when
+# using this template engine within a threaded environment.
+#
+# === Options
+#
+# ==== <tt>:engine_class => Herb::Engine</tt>
+#
+# Allows you to specify a custom engine class to use instead of the
+# default which is <tt>Herb::Engine</tt>.
+#
+# ==== Other
+#
+# Other options are passed to the constructor of the engine class.
+#
+# === See also
+#
+# * {Herb Home}[https://herb-tools.dev]
+# * {Herb::Engine}[https://herb-tools.dev/projects/engine]
+# * {Herb Source}[https://github.com/marcoroth/herb]
+#
+# === Related module
+#
+# * Tilt::HerbTemplate
+
+require_relative 'template'
+require 'herb'
+require 'herb/engine'
+
+module Tilt
+  class HerbTemplate < Template
+    def prepare
+      @options[:preamble] = false
+      @options[:postamble] = false
+      @options[:ensure] = true
+
+      # Unlike Erubi, Herb uses the filename when reporting errors, so pass
+      # the file Tilt loaded the template from if the caller did not set one.
+      @options[:filename] ||= file
+
+      engine_class = @options[:engine_class] || Herb::Engine
+
+      # If :freeze option is given, the intent is to setup frozen string
+      # literals in the template.  So enable frozen string literals in the
+      # code Tilt generates if the :freeze option is given.
+      if @freeze_string_literals = !!@options[:freeze]
+        # Passing the :freeze option to Herb sets the
+        # frozen-string-literal magic comment, which doesn't have an effect
+        # with Tilt as Tilt wraps the resulting code.  Worse, the magic
+        # comment appearing not at the top of the file can cause a warning.
+        # So remove the :freeze option before passing to Herb.
+        @options.delete(:freeze)
+
+        # Herb by default appends .freeze to template literals, but that is
+        # not necessary and slows down code when Tilt is using frozen string
+        # literals, so pass the :freeze_template_literals option to not
+        # append .freeze.
+        @options[:freeze_template_literals] = false
+      end
+
+      @engine = engine_class.new(@data, @options)
+      @outvar = @engine.bufvar
+      @src = @engine.src
+
+      @engine
+    end
+
+    def precompiled_template(locals)
+      @src
+    end
+
+    def freeze_string_literals?
+      @freeze_string_literals
+    end
+  end
+end

data/lib/tilt.rb

@@ -5,7 +5,7 @@ require_relative 'tilt/template'
 # Namespace for Tilt. This module is not intended to be included anywhere.
 module Tilt
   # Current version.
-  VERSION = '2.8.0'
+  VERSION = '2.9.0'
 
   EMPTY_ARRAY = [].freeze
   private_constant :EMPTY_ARRAY
@@ -146,8 +146,9 @@ module Tilt
   # Template Implementations ================================================
 
   # ERB
-  register_lazy :ERBTemplate,    'tilt/erb',    'erb', 'rhtml'
-  register_lazy :ErubiTemplate,  'tilt/erubi',  'erb', 'rhtml', 'erubi'
+  register_lazy :ERBTemplate,    'tilt/erb',    'erb', 'rhtml', 'html.erb'
+  register_lazy :ErubiTemplate,  'tilt/erubi',  'erb', 'rhtml', 'erubi', 'html.erb'
+  register_lazy :HerbTemplate,   'tilt/herb',   'herb', 'html.erb'
 
   # Markdown
   register_lazy :KramdownTemplate,     'tilt/kramdown',     'markdown', 'mkd', 'md'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tilt
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Ryan Tomayko
@@ -36,6 +36,7 @@ files:
 - lib/tilt/erubi.rb
 - lib/tilt/etanni.rb
 - lib/tilt/haml.rb
+- lib/tilt/herb.rb
 - lib/tilt/kramdown.rb
 - lib/tilt/liquid.rb
 - lib/tilt/livescript.rb
@@ -87,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Generic interface to multiple Ruby template engines
 test_files: []