RubyGems - tilt - Versions diffs - 2.6.1 → 2.8.0 - Mend

tilt 2.6.1 → 2.8.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 (37) hide show

data/lib/tilt/mapping.rb CHANGED Viewed

@@ -119,8 +119,8 @@ module Tilt
   #     # => RDiscount::Template
   #
   # In the previous example we say that RDiscount has a *higher priority* than
-  # Kramdown. Tilt will first try to `require "rdiscount/template"`, falling
-  # back to `require "kramdown/template"`. If none of these are successful,
+  # Kramdown. Tilt will first try to <tt>require "rdiscount/template"</tt>, falling
+  # back to <tt>require "kramdown/template"</tt>. If none of these are successful,
   # the first error will be raised.
   class Mapping < BaseMapping
     LOCK = Mutex.new
@@ -237,7 +237,7 @@ module Tilt
     #                             :templates=>['erb', 'scss'])
     def register_pipeline(ext, options=EMPTY_HASH)
       templates = options[:templates] || ext.split('.').reverse
-      templates = templates.map{|t| [self[t], options[t] || EMPTY_HASH]}
+      templates = templates.map{|t| [self[t], t, options[t] || EMPTY_HASH]}
       klass = Class.new(Pipeline)
       klass.send(:const_set, :TEMPLATES, templates)
@@ -346,13 +346,13 @@ module Tilt
     end
     # The proper behavior (in MRI) for autoload? is to
-    # return `false` when the constant/file has been
+    # return <tt>false</tt> when the constant/file has been
     # explicitly required.
     #
-    # However, in JRuby it returns `true` even after it's
-    # been required. In that case it turns out that `defined?`
-    # returns `"constant"` if it exists and `nil` when it doesn't.
-    # This is actually a second bug: `defined?` should resolve
+    # However, in JRuby it returns <tt>true</tt> even after it's
+    # been required. In that case it turns out that <tt>defined?</tt>
+    # returns <tt>"constant"</tt> if it exists and <tt>nil</tt> when it doesn't.
+    # This is actually a second bug: <tt>defined?</tt> should resolve
     # autoload (aka. actually try to require the file).
     #
     # We use the second bug in order to resolve the first bug.

data/lib/tilt/markaby.rb CHANGED Viewed

@@ -1,10 +1,19 @@
 # frozen_string_literal: true
+# = Markaby
+#
+# === See also
+#
+# * http://github.com/markaby/markaby
+#
+# === Related module
+#
+# * Tilt::MarkabyTemplate
 require_relative 'template'
 require 'markaby'
 module Tilt
-  # Markaby
-  # http://github.com/markaby/markaby
   class MarkabyTemplate < Template
     def self.builder_class
       @builder_class ||= Class.new(Markaby::Builder) do

data/lib/tilt/nokogiri.rb CHANGED Viewed

@@ -1,10 +1,21 @@
 # frozen_string_literal: true
+# = Nokogiri
+#
+# Nokogiri template implementation.
+#
+# === See also
+#
+# * http://nokogiri.org/
+#
+# === Related module
+#
+# * Tilt::NokogiriTemplate
 require_relative 'template'
 require 'nokogiri'
 module Tilt
-  # Nokogiri template implementation. See:
-  # http://nokogiri.org/
   class NokogiriTemplate < Template
     DOCUMENT_HEADER = /\A<\?xml version=\"1\.0\"\?>\n?/
     self.default_mime_type = 'text/xml'

data/lib/tilt/pandoc.rb CHANGED Viewed

@@ -1,8 +1,50 @@
 # frozen_string_literal: true
+# = Markdown (<tt>markdown</tt>, <tt>md</tt>, <tt>mkd</tt>)
+#
+# {Markdown}[http://daringfireball.net/projects/markdown/syntax] 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]
+# * {Pandoc}[http://pandoc.org]
 require_relative 'template'
 require 'pandoc-ruby'
-# Pandoc markdown implementation. See: http://pandoc.org/
 Tilt::PandocTemplate = Tilt::StaticTemplate.subclass do
   # turn options hash into an array
   # Map tilt options to pandoc options

data/lib/tilt/pipeline.rb CHANGED Viewed

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 require_relative 'template'
 module Tilt
   # Superclass used for pipeline templates.  Should not be used directly.
   class Pipeline < Template
     def prepare
-      @pipeline = self.class::TEMPLATES.inject(proc{|*| data}) do |data, (klass, options)|
+      @pipeline = self.class::TEMPLATES.inject(proc{|*| data}) do |data, (klass, ext, options)|
         proc do |s,l,&sb|
+          options = options
+          if ext_opts = @options[ext]
+            options = options.merge(ext_opts)
+          end
           klass.new(file, line, options, &proc{|*| data.call(s, l, &sb)}).render(s, l, &sb)
         end
       end

data/lib/tilt/plain.rb CHANGED Viewed

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
-require_relative 'template'
+# = Plain
+#
 # Raw text (no template functionality).
+require_relative 'template'
 Tilt::PlainTemplate = Tilt::StaticTemplate.subclass{@data}

data/lib/tilt/prawn.rb CHANGED Viewed

@@ -1,26 +1,37 @@
 # frozen_string_literal: true
+# = Prawn
+#
+# Prawn template implementation.
+#
+# === See also
+#
+# * http://prawnpdf.org
+#
+# === Related module
+#
+# * Tilt::PrawnTemplate
 require_relative 'template'
 require 'prawn'
 module Tilt
-  # Prawn template implementation. See: http://prawnpdf.org
   class PrawnTemplate < Template
     self.default_mime_type = 'application/pdf'
     def prepare
       @options[:page_size] = 'A4' unless @options.has_key?(:page_size)
       @options[:page_layout] = :portrait unless @options.has_key?(:page_layout)
-      @engine = ::Prawn::Document.new(@options)
     end
     def evaluate(scope, locals, &block)
-      pdf = @engine
+      pdf = ::Prawn::Document.new(@options)
       locals = locals.dup
       locals[:pdf] = pdf
       super
       pdf.render
     end
     def precompiled_template(locals)
       @data.to_str
     end

data/lib/tilt/radius.rb CHANGED Viewed

@@ -1,4 +1,59 @@
 # frozen_string_literal: true
+# = Radius (<tt>radius</tt>)
+#
+# {Radius}[http://radius.rubyforge.org] is the template language used by {Radiant CMS}[http://radiantcms.org]. It is
+# a tag language designed to be valid XML/HTML.
+#
+# === Example
+#
+#     <html>
+#     <body>
+#       <h1><r:title /></h1>
+#       <ul class="<r:type />">
+#       <r:repeat times="3">
+#         <li><r:hello />!</li>
+#       </r:repeat>
+#       </ul>
+#       <r:yield />
+#     </body>
+#     </html>
+#
+# === Usage
+#
+# To render a template such as the one above.
+#
+#     scope = OpenStruct.new
+#     scope.title = "Radius Example"
+#     scope.hello = "Hello, World!"
+#
+#     require 'radius'
+#     template = Tilt::RadiusTemplate.new('example.radius', :tag_prefix=>'r')
+#     template.render(scope, :type=>'hlist'){ "Jackpot!" }
+#
+# The result will be:
+#
+#     <html>
+#     <body>
+#       <h1>Radius Example</h1>
+#       <ul class="hlist">
+#         <li>Hello, World!</li>
+#         <li>Hello, World!</li>
+#         <li>Hello, World!</li>
+#       </ul>
+#       Jackpot!
+#     </body>
+#     </html>
+#
+# === See also
+#
+# * {Radius}[http://radius.rubyforge.org]
+# * {Radiant CMS}[http://radiantcms.org]
+#
+# === Related module
+#
+# * Tilt::RadiusTemplate
 require_relative 'template'
 require 'radius'

data/lib/tilt/rdiscount.rb CHANGED Viewed

@@ -1,4 +1,69 @@
 # frozen_string_literal: true
+# = RDiscount (<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.
+#
+# RDiscount is a simple text filter. It does not support +scope+ or
+# +locals+. The +:smart+ and +:filter_html+ options may be set true
+# to enable those flags on the underlying RDiscount object.
+#
+# === 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]
+#  * [Discount][discount]
+#  * {RDiscount}[http://github.com/rtomayko/rdiscount]
+#
+# -----------------------------------
+#
+# [Discount][discount] is an implementation of the Markdown markup language in C.
+# [RDiscount][rdiscount] is a Ruby wrapper around Discount.
+#
+# All the documentation of {Markdown}[#markdown] applies in addition to the following:
+#
+# === Usage
+#
+# The <tt>Tilt::RDiscountTemplate</tt> class is registered for all files ending in
+# <tt>.markdown</tt>, <tt>.md</tt> or <tt>.mkd</tt> by default with the highest priority. If you
+# specifically want to use RDiscount, it's recommended to use <tt>#prefer</tt>:
+#
+#     Tilt.prefer Tilt::RDiscountTemplate
+#
+# __NOTE:__ It's suggested that your program <tt>require 'rdiscount'</tt> at load time when
+# using this template engine within a threaded environment.
 require_relative 'template'
 require 'rdiscount'
@@ -9,12 +74,6 @@ aliases = {
 _flags = [:smart, :filter_html, :smartypants, :escape_html].freeze
-# Discount Markdown implementation. See:
-# http://github.com/rtomayko/rdiscount
-#
-# RDiscount is a simple text filter. It does not support +scope+ or
-# +locals+. The +:smart+ and +:filter_html+ options may be set true
-# to enable those flags on the underlying RDiscount object.
 Tilt::RDiscountTemplate = Tilt::StaticTemplate.subclass do
   flags = _flags.select { |flag| @options[flag] }.
     map! { |flag| aliases[flag] || flag }

data/lib/tilt/rdoc.rb CHANGED Viewed

@@ -1,11 +1,41 @@
 # frozen_string_literal: true
+# = RDoc (<tt>rdoc</tt>)
+#
+# {RDoc}[http://rdoc.rubyforge.org] is the simple text markup system that comes with Ruby's standard
+# library.
+#
+# === Example
+#
+#     = Hello RDoc Templates
+#
+#     Hello World. This is a paragraph.
+#
+# === Usage
+#
+# __NOTE:__ It's suggested that your program <tt>require 'rdoc'</tt>,
+# <tt>require 'rdoc/markup'</tt>, and <tt>require 'rdoc/markup/to_html'</tt> at load time
+# when using this template engine in a threaded environment.
+#
+# === See also
+#
+# * {RDoc}[http://rdoc.rubyforge.org]
+# * {RDoc Github}[https://github.com/ruby/rdoc]
 require_relative 'template'
 require 'rdoc'
 require 'rdoc/markup'
 require 'rdoc/markup/to_html'
 require 'rdoc/options'
-# RDoc template. See: https://github.com/ruby/rdoc
-Tilt::RDocTemplate = Tilt::StaticTemplate.subclass do
-  RDoc::Markup::ToHtml.new(RDoc::Options.new, nil).convert(@data).to_s
+Tilt::RDocTemplate = if defined?(RDoc::VERSION) && RDoc::VERSION >= "8"
+  Tilt::StaticTemplate.subclass do
+    RDoc::Markup::ToHtml.new.convert(@data).to_s
+  end
+# :nocov:
+else
+  Tilt::StaticTemplate.subclass do
+    RDoc::Markup::ToHtml.new(RDoc::Options.new, nil).convert(@data).to_s
+  end
 end
+# :nocov:

data/lib/tilt/redcarpet.rb CHANGED Viewed

@@ -1,4 +1,46 @@
 # frozen_string_literal: true
+# = Markdown (<tt>markdown</tt>, <tt>md</tt>, <tt>mkd</tt>)
+#
+# {Markdown}[http://daringfireball.net/projects/markdown/syntax] 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 'redcarpet'

data/lib/tilt/redcloth.rb CHANGED Viewed

@@ -1,8 +1,35 @@
 # frozen_string_literal: true
+# = Textile (<tt>textile</tt>)
+#
+# Textile is a lightweight markup language originally developed by Dean Allen and
+# billed as a "humane Web text generator". Textile converts its marked-up text
+# input to valid, well-formed XHTML and also inserts character entity references
+# for apostrophes, opening and closing single and double quotation marks,
+# ellipses and em dashes.
+#
+# Textile formatted texts are converted to HTML with the {RedCloth}[http://redcloth.org]
+# engine, which is a Ruby extension written in C.
+#
+# === Example
+#
+#     h1. Hello Textile Templates
+#
+#     Hello World. This is a paragraph.
+#
+# === Usage
+#
+# __NOTE:__ It's suggested that your program <tt>require 'redcloth'</tt> at load time
+# when using this template engine in a threaded environment.
+#
+# === See Also
+#
+# * {RedCloth}[http://redcloth.org]
+# * https://github.com/jgarber/redcloth
 require_relative 'template'
 require 'redcloth'
-# RedCloth implementation. See: https://github.com/jgarber/redcloth
 Tilt::RedClothTemplate = Tilt::StaticTemplate.subclass do
   engine = RedCloth.new(@data)
   @options.each  do |k, v|

data/lib/tilt/rst-pandoc.rb CHANGED Viewed

@@ -1,10 +1,33 @@
 # frozen_string_literal: true
+# = reStructuredText (<tt>rst</tt>)
+#
+# reStructuredText is a lightweight markup language originally developed by David Goodger,
+# based on StructuredText and Setext. reStructuredText is primarily used for technical
+# documentation in the Python programming language community, e.g. by the
+# {Sphinx}[http://www.sphinx-doc.org/en/stable/rest.html] Python documentation generator.
+#
+# reStructuredText formatted texts are converted to HTML with {Pandoc}[http://pandoc.org/], which
+# is an application written in Haskell, with a Ruby wrapper provided by the
+# {pandoc-ruby}[https://github.com/alphabetum/pandoc-ruby] gem.
+#
+# === Example
+#
+#     Hello Rst Templates
+#     ===================
+#
+#     Hello World. This is a paragraph.
+#
+# === See Also
+#
+# * {Pandoc}[http://pandoc.org/]
+# * {pandoc-ruby}[https://github.com/alphabetum/pandoc-ruby]
 require_relative 'template'
 require_relative 'pandoc'
 rst = {:f => "rst"}.freeze
-# Pandoc reStructuredText implementation. See: # http://pandoc.org/
 Tilt::RstPandocTemplate = Tilt::StaticTemplate.subclass do
   PandocRuby.new(@data, rst).to_html.strip
 end

data/lib/tilt/sass.rb CHANGED Viewed

@@ -1,10 +1,23 @@
 # frozen_string_literal: true
+# = Sass / Scss
+#
+# Sass/Scss template implementation for generating CSS.
+#
+# Sass templates do not support object scopes, locals, or yield.
+#
+# === See also
+#
+# * https://sass-lang.com/
+#
+# === Related modules
+#
+# * Tilt::SassTemplate
+# * Tilt::ScssTemplate
 require_relative 'template'
 module Tilt
-  # Sass template implementation for generating CSS. See: https://sass-lang.com/
-  #
-  # Sass templates do not support object scopes, locals, or yield.
   class SassTemplate < StaticTemplate
     self.default_mime_type = 'text/css'

data/lib/tilt/slim.rb CHANGED Viewed

@@ -1,4 +1,17 @@
 # frozen_string_literal: true
+# = Slim (<tt>slim</tt>)
+#
+# === Embedded locals
+#
+# In slim templates, the comment format looks like this:
+#
+#   //# locals: ()
+#
+# === See also
+#
+# * https://slim-template.github.io
 require_relative 'template'
 require 'slim'

data/lib/tilt/string.rb CHANGED Viewed

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
+# = String
+#
+# The template source is evaluated as a Ruby string. The #{} interpolation
+# syntax can be used to generated dynamic output.
+#
+# === Related module
+#
+# * Tilt::StringTemplate
 require_relative 'template'
 module Tilt
-  # The template source is evaluated as a Ruby string. The #{} interpolation
-  # syntax can be used to generated dynamic output.
   class StringTemplate < Template
     def prepare
       hash = "TILT#{@data.hash.abs}"

data/lib/tilt/template.rb CHANGED Viewed

@@ -41,12 +41,12 @@ module Tilt
         @metadata ||= {}
       end
-      # Use `.metadata[:mime_type]` instead.
+      # Use <tt>.metadata[:mime_type]</tt> instead.
       def default_mime_type
         metadata[:mime_type]
       end
-      # Use `.metadata[:mime_type] = val` instead.
+      # Use <tt>.metadata[:mime_type] = val</tt> instead.
       def default_mime_type=(value)
         metadata[:mime_type] = value
       end
@@ -376,10 +376,10 @@ module Tilt
       s = "locals = locals[:locals]"
       if assignments.delete(s)
-        # If there is a locals key itself named `locals`, delete it from the ordered keys so we can
+        # If there is a locals key itself named <tt>locals</tt>, delete it from the ordered keys so we can
         # assign it last. This is important because the assignment of all other locals depends on the
-        # `locals` local variable still matching the `locals` method argument given to the method
-        # created in `#compile_template_method`.
+        # <tt>locals</tt> local variable still matching the <tt>locals</tt> method argument given to the method
+        # created in <tt>#compile_template_method</tt>.
         assignments << s
       end

data/lib/tilt/typescript.rb CHANGED Viewed

@@ -1,4 +1,9 @@
 # frozen_string_literal: true
+# = Typescript
+#
+# TypeScript implementation.
 require_relative 'template'
 require 'typescript-node'