RubyGems - tilt - Versions diffs - 2.0.11 → 2.7.0 - Mend

tilt 2.0.11 → 2.7.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 (50) hide show

data/lib/tilt/commonmarker.rb CHANGED Viewed

@@ -1,88 +1,136 @@
-require 'tilt/template'
-require 'commonmarker'
+# 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]
-module Tilt
-  class CommonMarkerTemplate < Template
-    self.default_mime_type = 'text/html'
+require_relative 'template'
+require 'commonmarker'
-    OPTION_ALIAS = {
-      :smartypants => :SMART
-    }
-    PARSE_OPTIONS = [
-      :FOOTNOTES,
-      :LIBERAL_HTML_TAG,
-      :SMART,
-      :smartypants,
-      :STRIKETHROUGH_DOUBLE_TILDE,
-      :UNSAFE,
-      :VALIDATE_UTF8,
-    ].freeze
-    RENDER_OPTIONS = [
-      :FOOTNOTES,
-      :FULL_INFO_STRING,
-      :GITHUB_PRE_LANG,
-      :HARDBREAKS,
-      :NOBREAKS,
-      :SAFE, # Removed in v0.18.0 (2018-10-17)
-      :SOURCEPOS,
-      :TABLE_PREFER_STYLE_ATTRIBUTES,
-      :UNSAFE,
-    ].freeze
-    EXTENSIONS = [
-      :autolink,
-      :strikethrough,
-      :table,
-      :tagfilter,
-      :tasklist,
-    ].freeze
+if defined?(::Commonmarker)
+  aliases = {
+    :smartypants => :smart
+  }.freeze
+  parse_opts = [
+    :smart,
+    :default_info_string,
+  ].freeze
+  render_opts = [
+    :hardbreaks,
+    :github_pre_lang,
+    :width,
+    :unsafe,
+    :escape,
+    :sourcepos,
+  ].freeze
+  exts = [
+    :strikethrough,
+    :tagfilter,
+    :table,
+    :autolink,
+    :tasklist,
+    :superscript,
+    :header_ids,
+    :footnotes,
+    :description_lists,
+    :front_matter_delimiter,
+    :shortcodes,
+  ].freeze
-    def extensions
-      EXTENSIONS.select do |extension|
-        options[extension]
-      end
-    end
+  Tilt::CommonMarkerTemplate = Tilt::StaticTemplate.subclass do
+    parse_options = @options.select { |key, _| parse_opts.include?(key.downcase) }.transform_keys(&:downcase)
+    parse_options.merge!(@options.select { |key, _| aliases.has_key?(key) }.transform_keys { |key| aliases[key] })
+    render_options = @options.select { |key, _| render_opts.include?(key.downcase) }.transform_keys(&:downcase)
+    extensions = @options.select { |key, _| exts.include?(key) }.transform_keys(&:downcase)
-    def parse_options
-      raw_options = PARSE_OPTIONS.select do |option|
-        options[option]
-      end
-      actual_options = raw_options.map do |option|
-        OPTION_ALIAS[option] || option
-      end
+    Commonmarker.to_html(@data, options: { parse: parse_options, render: render_options, extension: extensions })
+  end
+# :nocov:
+else
+  aliases = {
+    :smartypants => :SMART
+  }.freeze
+  parse_opts = [
+    :FOOTNOTES,
+    :LIBERAL_HTML_TAG,
+    :SMART,
+    :smartypants,
+    :STRIKETHROUGH_DOUBLE_TILDE,
+    :UNSAFE,
+    :VALIDATE_UTF8,
+  ].freeze
+  render_opts = [
+    :FOOTNOTES,
+    :FULL_INFO_STRING,
+    :GITHUB_PRE_LANG,
+    :HARDBREAKS,
+    :NOBREAKS,
+    :SAFE, # Removed in v0.18.0 (2018-10-17)
+    :SOURCEPOS,
+    :TABLE_PREFER_STYLE_ATTRIBUTES,
+    :UNSAFE,
+  ].freeze
+  exts = [
+    :autolink,
+    :strikethrough,
+    :table,
+    :tagfilter,
+    :tasklist,
+  ].freeze
-      if actual_options.any?
-        actual_options
-      else
-        :DEFAULT
-      end
+  Tilt::CommonMarkerTemplate = Tilt::StaticTemplate.subclass do
+    extensions = exts.select do |extension|
+      @options[extension]
     end
-    def render_options
-      raw_options = RENDER_OPTIONS.select do |option|
-        options[option]
-      end
-      actual_options = raw_options.map do |option|
-        OPTION_ALIAS[option] || option
+    parse_options, render_options = [parse_opts, render_opts].map do |opts|
+      opts = opts.select do |option|
+        @options[option]
+      end.map! do |option|
+        aliases[option] || option
       end
-      if actual_options.any?
-        actual_options
-      else
-        :DEFAULT
-      end
-    end
-    def prepare
-      @engine = nil
-      @output = nil
+      opts = :DEFAULT unless opts.any?
+      opts
     end
-    def evaluate(scope, locals, &block)
-      doc = CommonMarker.render_doc(data, parse_options, extensions)
-      doc.to_html(render_options, extensions)
-    end
-    def allows_script?
-      false
-    end
+    CommonMarker.render_doc(@data, parse_options, extensions).to_html(render_options, extensions)
   end
 end
+# :nocov:

data/lib/tilt/csv.rb CHANGED Viewed

@@ -1,57 +1,55 @@
-require 'tilt/template'
-if RUBY_VERSION >= '1.9.0'
-  require 'csv'
-else
-  require 'fastercsv'
-end
+# 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'
-    def self.engine
-      if RUBY_VERSION >= '1.9.0' && defined? ::CSV
-        ::CSV
-      elsif defined? ::FasterCSV
-        ::FasterCSV
-      end
-    end
     def prepare
-      @outvar = options.delete(:outvar) || '_csvout'
+      @outvar = @options.delete(:outvar) || '_csvout'
     end
     def precompiled_template(locals)
       <<-RUBY
-        #{@outvar} = #{self.class.engine}.generate(**#{options}) do |csv|
-          #{data}
+        #{@outvar} = CSV.generate(**#{@options}) do |csv|
+          #{@data}
         end
       RUBY
     end

data/lib/tilt/erb.rb CHANGED Viewed

@@ -1,30 +1,95 @@
-require 'tilt/template'
+# 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
-    @@default_output_variable = '_erbout'
     SUPPORTS_KVARGS = ::ERB.instance_method(:initialize).parameters.assoc(:key) rescue false
-    def self.default_output_variable
-      @@default_output_variable
-    end
-    def self.default_output_variable=(name)
-      warn "#{self}.default_output_variable= has been replaced with the :outvar-option"
-      @@default_output_variable = name
-    end
     def prepare
-      @outvar = options[:outvar] || self.class.default_output_variable
-      options[:trim] = '<>' if !(options[:trim] == false) && (options[:trim].nil? || options[:trim] == true)
+      @freeze_string_literals = !!@options[:freeze]
+      @outvar = @options[:outvar] || '_erbout'
+      trim = case @options[:trim]
+      when false
+        nil
+      when nil, true
+        '<>'
+      else
+        @options[:trim]
+      end
       @engine = if SUPPORTS_KVARGS
-        ::ERB.new(data, trim_mode: options[:trim], eoutvar: @outvar)
+        ::ERB.new(@data, trim_mode: trim, eoutvar: @outvar)
+      # :nocov:
       else
-        ::ERB.new(data, options[:safe], options[:trim], @outvar)
+        ::ERB.new(@data, options[:safe], trim, @outvar)
+      # :nocov:
       end
     end
@@ -52,11 +117,13 @@ module Tilt
     # ERB generates a line to specify the character coding of the generated
     # source in 1.9. Account for this in the line offset.
-    if RUBY_VERSION >= '1.9.0'
-      def precompiled(locals)
-        source, offset = super
-        [source, offset + 1]
-      end
+    def precompiled(locals)
+      source, offset = super
+      [source, offset + 1]
+    end
+    def freeze_string_literals?
+      @freeze_string_literals
     end
   end
 end

data/lib/tilt/erubi.rb CHANGED Viewed

@@ -1,26 +1,78 @@
-require 'tilt/template'
+# 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.merge!(:preamble => false, :postamble => false, :ensure=>true)
+      @options[:preamble] = false
+      @options[:postamble] = false
+      @options[:ensure] = true
       engine_class = @options[:engine_class] || Erubi::Engine
-      @engine = engine_class.new(data, @options)
-      @outvar = @engine.bufvar
+      # 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 Erubi 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 Erubi.
+        @options.delete(:freeze)
-      # Remove dup after tilt supports frozen source.
-      @src = @engine.src.dup
+        # Erubi by default appends .freeze to template literals on Ruby 2.1+,
+        # 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
@@ -28,5 +80,9 @@ module Tilt
     def precompiled_template(locals)
       @src
     end
+    def freeze_string_literals?
+      @freeze_string_literals
+    end
   end
 end

data/lib/tilt/etanni.rb CHANGED Viewed

@@ -1,18 +1,26 @@
-require 'tilt/template'
+# frozen_string_literal: true
+# = Etanni
+#
+# === Related module
+#
+# * Tilt::EtanniTemplate
+require_relative 'template'
 module Tilt
   class EtanniTemplate < Template
     def prepare
       separator = data.hash.abs
-      chomp = "<<#{separator}.chomp!"
+      chomp = "<<#{separator}.chomp"
       start = "\n_out_ << #{chomp}\n"
       stop = "\n#{separator}\n"
       replacement = "#{stop}\\1#{start}"
-      temp = data.strip
+      temp = @data.strip
       temp.gsub!(/<\?r\s+(.*?)\s+\?>/m, replacement)
-      @code = "_out_ = [<<#{separator}.chomp!]\n#{temp}#{stop}_out_.join"
+      @code = "_out_ = [<<#{separator}.chomp]\n#{temp}#{stop}_out_.join"
     end
     def precompiled_template(locals)