RubyGems - tilt - Versions diffs - 2.4.0 → 2.9.0 - Mend

tilt 2.4.0 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (41) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9bb9bafc29e9442fed0bf862fb442ea6efaa97c2881b7b958361f0ef7095aaa
-  data.tar.gz: f25db1d4c05ef3b20c5fabefa4eb664e702f51f8d9821b0c44f5f5404ade4c3b
+  metadata.gz: 07376d5da37cfc37ba1364a962859139ab42e2c6453aea4bd5610c2daccee019
+  data.tar.gz: dc64be5c7fbf26c8f6def8e40c143a61de7e46ed69157d0b0a0c1a558b9e4d93
 SHA512:
-  metadata.gz: dc69e05565c5b007fbaaddc7636d6298fc9930c42d1e029834b752236309d97024132118bb723817c5c192cad1f1cef01e278ce4fc46629dac706d0ec4fdd6a2
-  data.tar.gz: 702e18b78c3e9b21e1abe86671bbe6f2427db44b05be4941c1693f30070f1de028af5324294d693bdeda130da603ecfd5c98dcefbce7ca21f7e7f6df5a249b97
+  metadata.gz: 20bc55f1b6cdceb99068e2a40ac0df35006b6f61c27a66f31606ee79e32df7431bef7e2d37ca6ecef5cc30ef131f7f19f340258d12a1836ce4aee2a1ad0a4b23
+  data.tar.gz: 409ef4a5ba49ec95425d810987b892d694aa3794ce937256c7673caea67dc9ef93f64fb1b5b399de0a0ada44d13424d305d63f3e9b96a6f346739f8a7491c2b3

data/COPYING CHANGED Viewed

@@ -1,5 +1,5 @@
 Copyright (c) 2010-2016 Ryan Tomayko <http://tomayko.com/about>
-Copyright (c) 2015-2023 Jeremy Evans
+Copyright (c) 2015-2026 Jeremy Evans and contributors
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/lib/tilt/asciidoc.rb CHANGED Viewed

@@ -1,14 +1,21 @@
 # frozen_string_literal: true
-require_relative 'template'
-require 'asciidoctor'
-# AsciiDoc see: http://asciidoc.org/
-# Asciidoctor implementation for AsciiDoc see:
-# http://asciidoctor.github.com/
+# = AsciiDoc
+#
+# Asciidoctor implementation for AsciiDoc
 #
 # Asciidoctor is an open source, pure-Ruby processor for
 # converting AsciiDoc documents or strings into HTML 5,
 # DocBook 4.5 and other formats.
+#
+# === See also
+#
+# * http://asciidoc.org
+# * http://asciidoctor.github.com
+require_relative 'template'
+require 'asciidoctor'
 Tilt::AsciidoctorTemplate = Tilt::StaticTemplate.subclass do
   @options[:header_footer] = false if @options[:header_footer].nil?
   Asciidoctor.render(@data, @options)

data/lib/tilt/babel.rb CHANGED Viewed

@@ -1,4 +1,9 @@
 # frozen_string_literal: true
+# = Babel
+#
+#
 require_relative 'template'
 require 'babel/transpiler'

data/lib/tilt/builder.rb CHANGED Viewed

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
+# = Builder
+#
 require_relative 'template'
 require 'builder'

data/lib/tilt/coffee.rb CHANGED Viewed

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
+# CoffeeScript / Literate CoffeeScript template implementation.
+#
+# CoffeeScript templates do not support object scopes, locals, or yield.
+#
+# === See also
+#
+# * http://coffeescript.org
+#
+# === Related modules
+#
+# * Tilt::CoffeeScriptTemplate
+# * Tilt::CoffeeScriptLiterateTemplate
 require_relative 'template'
 require 'coffee_script'
 module Tilt
-  # CoffeeScript template implementation. See:
-  # http://coffeescript.org/
-  #
-  # CoffeeScript templates do not support object scopes, locals, or yield.
   class CoffeeScriptTemplate < StaticTemplate
     self.default_mime_type = 'application/javascript'

data/lib/tilt/commonmarker.rb CHANGED Viewed

@@ -1,4 +1,45 @@
 # frozen_string_literal: true
+#
+# = Markdown (<tt>markdown</tt>, <tt>md</tt>, <tt>mkd</tt>)
+#
+# Markdown is a lightweight markup language, created by John Gruber
+# and Aaron Swartz. For any markup that is not covered by Markdown’s syntax, HTML
+# is used.  Marking up plain text with Markdown markup is easy and Markdown
+# formatted texts are readable.
+#
+# === Example
+#
+#     Hello Markdown Templates
+#     ========================
+#
+#     Hello World. This is a paragraph.
+#
+# === Usage
+#
+# To wrap a Markdown formatted document with a layout:
+#
+#     layout = Tilt['erb'].new do
+#       "<!doctype html><title></title><%= yield %>"
+#     end
+#     data = Tilt['md'].new { "# hello tilt" }
+#     layout.render { data.render }
+#     # => "<!doctype html><title></title><h1>hello tilt</h1>\n"
+#
+# === Options
+#
+# ==== <tt>:smartypants => true|false</tt>
+#
+# Set <tt>true</tt> to enable [Smarty Pants][smartypants] style punctuation replacement.
+#
+# ==== <tt>:escape_html => true|false</tt>
+#
+# Set <tt>true</tt> disallow raw HTML in Markdown contents. HTML is converted to
+# literal text by escaping <tt><</tt> characters.
+#
+# === See also
+#
+# * {Markdown Syntax Documentation}[http://daringfireball.net/projects/markdown/syntax]
 require_relative 'template'
 require 'commonmarker'
@@ -9,14 +50,24 @@ if defined?(::Commonmarker)
   parse_opts = [
     :smart,
     :default_info_string,
+    :relaxed_tasklist_matching,
+    :relaxed_autolinks,
+    :leave_footnote_definitions,
+    :ignore_setext,
   ].freeze
   render_opts = [
     :hardbreaks,
     :github_pre_lang,
+    :full_info_string,
     :width,
     :unsafe,
     :escape,
     :sourcepos,
+    :escaped_char_spans,
+    :ignore_empty_links,
+    :gfm_quirks,
+    :prefer_fenced,
+    :tasklist_classes,
   ].freeze
   exts = [
     :strikethrough,
@@ -27,9 +78,23 @@ if defined?(::Commonmarker)
     :superscript,
     :header_ids,
     :footnotes,
+    :inline_footnotes,
     :description_lists,
     :front_matter_delimiter,
+    :multiline_block_quotes,
+    :math_dollars,
+    :math_code,
     :shortcodes,
+    :wikilinks_title_before_pipe,
+    :wikilinks_title_after_pipe,
+    :underline,
+    :spoiler,
+    :greentext,
+    :subscript,
+    :subtext,
+    :alerts,
+    :cjk_friendly_emphasis,
+    :highlight,
   ].freeze
   Tilt::CommonMarkerTemplate = Tilt::StaticTemplate.subclass do

data/lib/tilt/csv.rb CHANGED Viewed

@@ -1,34 +1,44 @@
 # frozen_string_literal: true
+# = CSV
+#
+# CSV Template implementation.
+#
+# === Example
+#
+#    # Example of csv template
+#    tpl = <<-EOS
+#      # header
+#      csv << ['NAME', 'ID']
+#
+#      # data rows
+#      @people.each do |person|
+#        csv << [person[:name], person[:id]]
+#      end
+#    EOS
+#
+#    @people = [
+#      {:name => "Joshua Peek", :id => 1},
+#      {:name => "Ryan Tomayko", :id => 2},
+#      {:name => "Simone Carletti", :id => 3}
+#    ]
+#
+#    template = Tilt::CSVTemplate.new { tpl }
+#    template.render(self)
+#
+# === See also
+#
+# * http://ruby-doc.org/stdlib/libdoc/csv/rdoc/CSV.html
+#
+# === Related module
+#
+# * Tilt::CSVTemplate
 require_relative 'template'
 require 'csv'
 module Tilt
-  # CSV Template implementation. See:
-  # http://ruby-doc.org/stdlib/libdoc/csv/rdoc/CSV.html
-  #
-  # == Example
-  #
-  #    # Example of csv template
-  #    tpl = <<-EOS
-  #      # header
-  #      csv << ['NAME', 'ID']
-  #
-  #      # data rows
-  #      @people.each do |person|
-  #        csv << [person[:name], person[:id]]
-  #      end
-  #    EOS
-  #
-  #    @people = [
-  #      {:name => "Joshua Peek", :id => 1},
-  #      {:name => "Ryan Tomayko", :id => 2},
-  #      {:name => "Simone Carletti", :id => 3}
-  #    ]
-  #
-  #    template = Tilt::CSVTemplate.new { tpl }
-  #    template.render(self)
-  #
   class CSVTemplate < Template
     self.default_mime_type = 'text/csv'

data/lib/tilt/erb.rb CHANGED Viewed

@@ -1,10 +1,75 @@
 # frozen_string_literal: true
+# = ERB (<tt>erb</tt>, <tt>rhtml</tt>)
+#
+# ERB is a simple but powerful template languge for Ruby. In Tilt it's
+# backed by {Erubi}[rdoc-ref:lib/tilt/erubi.rb] (if installed on your system] or by
+# {erb.rb}[rdoc-ref:lib/tilt/erb.rb] (which is included in Ruby's standard library]. This
+# documentation applies to both implementations.
+#
+# === Example
+#
+#     Hello <%= world %>!
+#
+# === Usage
+#
+# ERB templates support custom evaluation scopes and locals:
+#
+#     >> require 'erb'
+#     >> template = Tilt.new('hello.html.erb')
+#     >> template.render(self, :world => 'World!')
+#     => "Hello World!"
+#
+# Or, use <tt>Tilt['erb']</tt> directly to process strings:
+#
+#     template = Tilt['erb'].new { "Hello <%= world %>!" }
+#     template.render(self, :world => 'World!')
+#
+# The <tt>Tilt::ERBTemplate</tt> class is registered for all files ending in <tt>.erb</tt> or
+# <tt>.rhtml</tt> by default, but with a *lower* priority than ErubiTemplate.
+# If you specifically want to use ERB, it's recommended to use
+# <tt>#prefer</tt>:
+#
+#     Tilt.prefer Tilt::ERBTemplate
+#
+# __NOTE:__ It's suggested that your program <tt>require 'erb'</tt> at load time when
+# using this template engine within a threaded environment.
+#
+# === Options
+#
+# ==== <tt>:trim => trim</tt>
+#
+# The ERB trim mode flags. This is a string consisting of any combination of the
+# following characters:
+#
+# * <tt>'>'</tt>  omits newlines for lines ending in <tt>></tt>
+# * <tt>'<>'</tt> omits newlines for lines starting with <tt><%</tt> and ending in <tt>%></tt>
+# * <tt>'%'</tt>  enables processing of lines beginning with <tt>%</tt>
+# * <tt>true</tt> is an alias of <tt><></tt>
+#
+# ==== <tt>:outvar => '_erbout'</tt>
+#
+# The name of the variable used to accumulate template output. This can be
+# any valid Ruby expression but must be assignable. By default a local
+# variable named <tt>_erbout</tt> is used.
+#
+# ==== <tt>:freeze => false</tt>
+#
+# If set to true, will set the <tt>frozen_string_literal</tt> flag in the compiled
+# template code, so that string literals inside the templates will be frozen.
+#
+# === See also
+#
+# * http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html
+#
+# === Related module
+#
+# * Tilt::ERBTemplate
 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
     SUPPORTS_KVARGS = ::ERB.instance_method(:initialize).parameters.assoc(:key) rescue false

data/lib/tilt/erubi.rb CHANGED Viewed

@@ -1,16 +1,49 @@
 # frozen_string_literal: true
+# = Erubi (<tt>erb</tt>, <tt>rhtml</tt>, <tt>erubi</tt>)
+#
+# {Erubi}[https://github.com/jeremyevans/erubi] is an ERB implementation that uses the same algorithm as
+# the erubis gem, but is maintained and offers numerous improvements.
+#
+# All the documentation of {ERB}[rdoc-ref:lib/tilt/erb.rb] applies in addition to the following:
+#
+# === Usage
+#
+# The <tt>Tilt::ErubiTemplate</tt> class is registered for all files ending in <tt>.erb</tt> or
+# <tt>.rhtml</tt> by default, with the *highest* priority.
+#
+# __NOTE:__ It's suggested that your program <tt>require 'erubi'</tt> at load time when
+# using this template engine within a threaded environment.
+#
+# === Options
+#
+# ==== <tt>:engine_class => Erubi::Engine</tt>
+#
+# Allows you to specify a custom engine class to use instead of the
+# default which is <tt>Erubi::Engine</tt>.
+#
+# ==== Other
+#
+# Other options are passed to the constructor of the engine class.
+#
+# ErubiTemplate supports the following additional options, in addition
+# to the options supported by the Erubi engine:
+#
+# :engine_class :: allows you to specify a custom engine class to use
+#                  instead of the default (which is ::Erubi::Engine).
+#
+# === See also
+#
+# * {Erubi Home}[https://github.com/jeremyevans/erubi]
+#
+# === Related module
+#
+# * Tilt::ErubiTemplate
 require_relative 'template'
 require 'erubi'
 module Tilt
-  # Erubi (a simplified version of Erubis) template implementation.
-  # See https://github.com/jeremyevans/erubi
-  #
-  # ErubiTemplate supports the following additional options, in addition
-  # to the options supported by the Erubi engine:
-  #
-  # :engine_class :: allows you to specify a custom engine class to use
-  #                  instead of the default (which is ::Erubi::Engine).
   class ErubiTemplate < Template
     def prepare
       @options[:preamble] = false

data/lib/tilt/etanni.rb CHANGED Viewed

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
+# = Etanni
+#
+# === Related module
+#
+# * Tilt::EtanniTemplate
 require_relative 'template'
 module Tilt

data/lib/tilt/haml.rb CHANGED Viewed

@@ -1,4 +1,70 @@
 # frozen_string_literal: true
+# = Haml (<tt>haml</tt>)
+#
+# {Haml}[https://haml.info] is a markup language that’s used to cleanly and simply describe
+# the HTML of any web document without the use of inline code. Haml functions as
+# a replacement for inline page templating systems such as PHP, ASP, and ERB, the
+# templating language used in most Ruby on Rails applications. However, Haml
+# avoids the need for explicitly coding HTML into the template, because it itself
+# is a description of the HTML, with some code to generate dynamic content.
+# ({more}[http://haml.info/about.html)]
+#
+# === Example
+#
+#     %html
+#       %head
+#         %title= @title
+#       %body
+#         %h1
+#           Hello
+#           = world + '!'
+#
+# === Usage
+#
+# The <tt>Tilt::HamlTemplate</tt> class is registered for all files ending in <tt>.haml</tt>
+# by default. Haml templates support custom evaluation scopes and locals:
+#
+#     >> require 'haml'
+#     >> template = Tilt.new('hello.haml')
+#     => #<Tilt::HamlTemplate @file='hello.haml'>
+#     >> @title = "Hello Haml!"
+#     >> template.render(self, :world => 'Haml!')
+#     => "
+#     <html>
+#       <head>
+#         <title>Hello Haml!</title>
+#       </head>
+#       <body>
+#         <h1>Hello Haml!</h1>
+#       </body>
+#     </html>"
+#
+# Or, use the <tt>Tilt::HamlTemplate</tt> class directly to process strings:
+#
+#     >> require 'haml'
+#     >> template = Tilt::HamlTemplate.new { "%h1= 'Hello Haml!'" }
+#     => #<Tilt::HamlTemplate @file=nil ...>
+#     >> template.render
+#     => "<h1>Hello Haml!</h1>"
+#
+# __NOTE:__ It's suggested that your program <tt>require 'haml'</tt> at load time when
+# using this template engine within a threaded environment.
+#
+# === Options
+#
+# Please see the {Haml Reference}[http://haml.info/docs/yardoc/file.HAML_REFERENCE.html#options] for all available options.
+#
+# === See also
+#
+# * {#haml.docs}[http://haml.info/docs.html]
+# * {Haml Tutorial}[http://haml.info/tutorial.html]
+# * {Haml Reference}[http://haml.info/docs/yardoc/file.HAML_REFERENCE.html]
+#
+# === Related module
+#
+# * Tilt::HamlTemplate
 require_relative 'template'
 require 'haml'
@@ -12,7 +78,7 @@ module Tilt
     class HamlTemplate < Template
       self.default_mime_type = 'text/html'
-      # `Gem::Version.correct?` may return false because of Haml::VERSION #=> "3.1.8 (Separated Sally)". After Haml 4, it's always correct.
+      # <tt>Gem::Version.correct?</tt> 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[:filename] = eval_file

data/lib/tilt/herb.rb ADDED Viewed

@@ -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/kramdown.rb CHANGED Viewed

@@ -1,10 +1,56 @@
 # frozen_string_literal: true
+# = Markdown (<tt>markdown</tt>, <tt>md</tt>, <tt>mkd</tt>)
+#
+# Markdown is a lightweight markup language, created by John Gruber
+# and Aaron Swartz. For any markup that is not covered by Markdown’s syntax, HTML
+# is used.  Marking up plain text with Markdown markup is easy and Markdown
+# formatted texts are readable.
+#
+# === Example
+#
+#     Hello Markdown Templates
+#     ========================
+#
+#     Hello World. This is a paragraph.
+#
+# === Usage
+#
+# To wrap a Markdown formatted document with a layout:
+#
+#     layout = Tilt['erb'].new do
+#       "<!doctype html><title></title><%= yield %>"
+#     end
+#     data = Tilt['md'].new { "# hello tilt" }
+#     layout.render { data.render }
+#     # => "<!doctype html><title></title><h1>hello tilt</h1>\n"
+#
+# === Options
+#
+# Every implementation of Markdown *should* support these options, but there are
+# some known problems with the Kramdown engine.
+#
+# ==== <tt>:smartypants => true|false</tt>
+#
+# Set <tt>true</tt> to enable [Smarty Pants][smartypants] style punctuation replacement.
+#
+# In Kramdown this option only applies to smart quotes. It will apply a
+# subset of Smarty Pants (e.g. <tt>...</tt> to <tt>…</tt>) regardless of any option.
+#
+# ==== <tt>:escape_html => true|false</tt>
+#
+# Kramdown doesn't support this option.
+#
+# === See also
+#
+# * {Markdown Syntax Documentation}[http://daringfireball.net/projects/markdown/syntax]
+# * {Kramdown Markdown implementation}[https://kramdown.gettalong.org]
 require_relative 'template'
 require 'kramdown'
 dumb_quotes = [39, 39, 34, 34].freeze
-# 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]