tilt 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837e8836cd6aacedb861823faead2fd72549f1c750e2f0350471303c1ca5cab3
-  data.tar.gz: 578c1873d63eb0e2426e2c86199f414f516952562c85ee9e91e0907a936603b9
+  metadata.gz: 42821dda310628574e4e1c99c69751d463bee48887c8f90c82768b80bb17231b
+  data.tar.gz: eb67c15726743517bf14d6db8b0034f7cbb7bd6c3c96d72ce24623430df03202
 SHA512:
-  metadata.gz: a63e7b55aacbe374f70317cddd821c065ae512622be8f20bc25aeb2aabd5455d91cb7d97894de420f3bfb4f7c571c5f832047db182bb35107fd6d566879c04d7
-  data.tar.gz: 2c2785a08edb15f9e593a1b717682212f5a50f1f6694c02256179ee15c9a1e73429a5c6ae804e83611cc645209330c36ea117c6d38698f0021e2a7d748c59919
+  metadata.gz: 832ae277c35c2bb4fb36f93d2aaa411ec5ac948eb7d1eec956d70a1a54d27a2c4d326ae02bc5a75d06177aebb29d22cec4437ada71691ca25aba050fcad78236
+  data.tar.gz: ecc19aa399a14acc5c3d4f5adfc2d0bb70bf8d7552fd90ae7e4165cbad45b8f149e6cd808c49c0808762b6b9c68945dc6009a94c2910056a49f9e702637a8391

data/COPYING

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

data/bin/tilt

@@ -1,122 +1,4 @@
 #!/usr/bin/env ruby
-require 'ostruct'
-require 'optparse'
-require 'tilt'
+require_relative '../lib/tilt/cli'
 
-usage = <<USAGE
-Usage: tilt <options> <file>
-Process template <file> and write output to stdout. With no <file> or
-when <file> is '-', read template from stdin and use the --type option
-to determine the template's type.
-
-Options
-  -l, --list                List template engines + file patterns and exit
-  -t, --type=<pattern>      Use this template engine; required if no <file>
-  -y, --layout=<file>       Use <file> as a layout template
-
-  -D<name>=<value>          Define variable <name> as <value>
-  -d, --define-file=<file>  Load YAML from <file> and use for variables
-  --vars=<ruby>             Evaluate <ruby> to Hash and use for variables
-
-  -h, --help                Show this help message
-
-Convert markdown to HTML:
-  $ tilt foo.markdown > foo.html
-
-Process ERB template:
-  $ echo "Answer: <%= 2 + 2 %>" | tilt -t erb
-  Answer: 4
-
-Define variables:
-  $ echo "Answer: <%= 2 + n %>" | tilt -t erb --vars="{:n=>40}"
-  Answer: 42
-  $ echo "Answer: <%= 2 + n.to_i %>" | tilt -t erb -Dn=40
-  Answer: 42
-USAGE
-
-script_name = File.basename($0)
-pattern = nil
-layout = nil
-locals = {}
-
-ARGV.options do |o|
-  o.program_name = script_name
-
-  # list all available template engines
-  o.on("-l", "--list") do
-    groups = {}
-    Tilt.lazy_map.each do |pattern,engines|
-      engines.each do |engine|
-        key = engine[0].split('::').last.sub(/Template$/, '')
-        (groups[key] ||= []) << pattern
-      end
-    end
-    groups.sort { |(k1,v1),(k2,v2)| k1 <=> k2 }.each do |engine,files|
-      printf "%-15s %s\n", engine, files.sort.join(', ')
-    end
-    exit
-  end
-
-  # the template type / pattern
-  o.on("-t", "--type=PATTERN", String) do |val|
-    abort "unknown template type: #{val}" if Tilt[val].nil?
-    pattern = val
-  end
-
-  # pass template output into the specified layout template
-  o.on("-y", "--layout=FILE", String)  do |file|
-    paths = [file, "~/.tilt/#{file}", "/etc/tilt/#{file}"]
-    layout = paths.
-      map  { |p| File.expand_path(p) }.
-      find { |p| File.exist?(p) }
-    abort "no such layout: #{file}" if layout.nil?
-  end
-
-  # define a local variable
-  o.on("-D", "--define=PAIR", String) do |pair|
-    key, value = pair.split(/[=:]/, 2)
-    locals[key.to_sym] = value
-  end
-
-  # define local variables from YAML or JSON
-  o.on("-d", "--define-file=FILE", String) do |file|
-    require 'yaml'
-    abort "no such define file: #{file}" unless File.exist? file
-    hash = File.open(file, 'r:bom|utf-8') { |f| YAML.load f, file }
-    abort "vars must be a Hash, not #{hash.inspect}" if !hash.is_a?(Hash)
-    hash.each { |key, value| locals[key.to_sym] = value }
-  end
-
-  # define local variables using a Ruby hash
-  o.on("--vars=RUBY") do |ruby|
-    hash = eval(ruby)
-    abort "vars must be a Hash, not #{hash.inspect}" if !hash.is_a?(Hash)
-    hash.each { |key, value| locals[key.to_sym] = value }
-  end
-
-  o.on_tail("-h", "--help") { puts usage; exit }
-
-  o.parse!
-end
-
-file = ARGV.first || '-'
-pattern = file if pattern.nil?
-abort "template type not given. see: #{$0} --help" if ['-', ''].include?(pattern)
-
-engine = Tilt[pattern]
-abort "template engine not found for: #{pattern}" if engine.nil?
-
-template =
-  engine.new(file) {
-    if file == '-'
-      $stdin.read
-    else
-      File.read(file)
-    end
-  }
-output = template.render(self, locals)
-
-# process layout
-output = Tilt.new(layout).render(self, locals) { output } if layout
-
-$stdout.write(output)
+exit Tilt::CLI.run

data/lib/tilt/_emacs_org.rb

@@ -0,0 +1,2 @@
+warn "Lazy loading of emacs org templates is deprecated and will be removed in Tilt 3.  Require tilt/emacs_org manually.", uplevel: 1
+require "tilt/emacs_org"

data/lib/tilt/_handlebars.rb

@@ -0,0 +1,2 @@
+warn "Lazy loading of handlebars templates is deprecated and will be removed in Tilt 3.  Require tilt/handlebars manually.", uplevel: 1
+require "tilt/handlebars"

data/lib/tilt/_jbuilder.rb

@@ -0,0 +1,2 @@
+warn "Lazy loading of jbuilder templates is deprecated and will be removed in Tilt 3.  Require tilt/jbuilder manually.", uplevel: 1
+require "tilt/jbuilder"

data/lib/tilt/_org.rb

@@ -0,0 +1,2 @@
+warn "Lazy loading of org templates is deprecated and will be removed in Tilt 3.  Require org-ruby manually.", uplevel: 1
+require "org-ruby"

data/lib/tilt/asciidoc.rb

@@ -1,27 +1,15 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'asciidoctor'
-
 # AsciiDoc see: http://asciidoc.org/
-module Tilt
-  # Asciidoctor implementation for AsciiDoc see:
-  # http://asciidoctor.github.com/
-  #
-  # Asciidoctor is an open source, pure-Ruby processor for
-  # converting AsciiDoc documents or strings into HTML 5,
-  # DocBook 4.5 and other formats.
-  class AsciidoctorTemplate < Template
-    self.default_mime_type = 'text/html'
-
-    def prepare
-      options[:header_footer] = false if options[:header_footer].nil?
-    end
-
-    def evaluate(scope, locals, &block)
-      @output ||= Asciidoctor.render(data, options, &block)
-    end
 
-    def allows_script?
-      false
-    end
-  end
+# Asciidoctor implementation for AsciiDoc see:
+# http://asciidoctor.github.com/
+#
+# Asciidoctor is an open source, pure-Ruby processor for
+# converting AsciiDoc documents or strings into HTML 5,
+# DocBook 4.5 and other formats.
+Tilt::AsciidoctorTemplate = Tilt::StaticTemplate.subclass do
+  @options[:header_footer] = false if @options[:header_footer].nil?
+  Asciidoctor.render(@data, @options)
 end

data/lib/tilt/babel.rb

@@ -1,16 +1,8 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'babel/transpiler'
 
-module Tilt
-  class BabelTemplate < Template
-    self.default_mime_type = 'application/javascript'
-
-    def prepare
-      options[:filename] ||= file
-    end
-
-    def evaluate(scope, locals, &block)
-      @output ||= Babel::Transpiler.transform(data)["code"]
-    end
-  end
+Tilt::BabelTemplate = Tilt::StaticTemplate.subclass(mime_type: 'application/javascript') do
+  @options[:filename] ||= @file
+  Babel::Transpiler.transform(@data)["code"]
 end

data/lib/tilt/builder.rb

@@ -1,27 +1,27 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'builder'
 
 module Tilt
-  # Builder template implementation. See:
-  # http://builder.rubyforge.org/
+  # Builder template implementation.
   class BuilderTemplate < Template
     self.default_mime_type = 'text/xml'
 
     def prepare
-      options[:indent] ||= 2
+      @options[:indent] ||= 2
     end
 
     def evaluate(scope, locals, &block)
-      xml = (locals[:xml] || ::Builder::XmlMarkup.new(options))
-
-      if data.respond_to?(:to_str)
-        if !locals[:xml]
-          locals = locals.merge(:xml => xml)
+      if @data.respond_to?(:to_str)
+        unless locals[:xml]
+          locals = Hash[locals]
+          locals[:xml] = xml_builder
         end
-        return super(scope, locals, &block)
+        return super
       end
 
-      data.call(xml)
+      xml = locals[:xml] || xml_builder
+      @data.call(xml)
       xml.target!
     end
 
@@ -30,8 +30,13 @@ module Tilt
     end
 
     def precompiled_template(locals)
-      data.to_str
+      @data.to_str
+    end
+
+    private
+
+    def xml_builder
+      ::Builder::XmlMarkup.new(options)
     end
   end
 end
-

data/lib/tilt/cli.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+require_relative '../tilt'
+require 'optparse'
+
+module Tilt::CLI
+  USAGE = (<<USAGE).freeze
+Usage: tilt <options> <file>
+Process template <file> and write output to stdout. With no <file> or
+when <file> is '-', read template from stdin and use the --type option
+to determine the template's type.
+
+Options
+  -l, --list                List template engines + file patterns and exit
+  -t, --type=<pattern>      Use this template engine; required if no <file>
+  -y, --layout=<file>       Use <file> as a layout template
+
+  -D<name>=<value>          Define variable <name> as <value>
+  -d, --define-file=<file>  Load YAML from <file> and use for variables
+  --vars=<ruby>             Evaluate <ruby> to Hash and use for variables
+
+  -h, --help                Show this help message
+
+Convert markdown to HTML:
+  $ tilt foo.markdown > foo.html
+
+Process ERB template:
+  $ echo "Answer: <%= 2 + 2 %>" | tilt -t erb
+  Answer: 4
+
+Define variables:
+  $ echo "Answer: <%= 2 + n %>" | tilt -t erb --vars="{:n=>40}"
+  Answer: 42
+  $ echo "Answer: <%= 2 + n.to_i %>" | tilt -t erb -Dn=40
+  Answer: 42
+USAGE
+  private_constant :USAGE
+
+  # Backbone of the tilt command line utility. Allows mocking input/output
+  # for simple testing. Returns program exit code.
+  def self.run(argv: ARGV, stdout: $stdout, stdin: $stdin, stderr: $stderr, script_name: File.basename($0))
+    pattern = nil
+    layout = nil
+    locals = {}
+    abort = proc do |msg|
+      stderr.puts msg
+      return 1
+    end
+
+    OptionParser.new do |o|
+      o.program_name = script_name
+
+      # list all available template engines
+      o.on("-l", "--list") do
+        groups = {}
+        Tilt.lazy_map.each do |pattern,engines|
+          engines.each do |engine,|
+            engine = engine.split('::').last.sub(/Template\z/, '')
+            (groups[engine] ||= []) << pattern
+          end
+        end
+        groups.sort { |(k1,v1),(k2,v2)| k1 <=> k2 }.each do |engine,files|
+          stdout.printf "%-20s %s\n", engine, files.sort.join(', ')
+        end
+        return 0
+      end
+
+      # the template type / pattern
+      o.on("-t", "--type=PATTERN", String) do |val|
+        abort.("unknown template type: #{val}") unless Tilt[val]
+        pattern = val
+      end
+
+      # pass template output into the specified layout template
+      o.on("-y", "--layout=FILE", String)  do |file|
+        paths = [file, "~/.tilt/#{file}", "/etc/tilt/#{file}"]
+        layout = paths.
+          map  { |p| File.expand_path(p) }.
+          find { |p| File.exist?(p) }
+        abort.("no such layout: #{file}") if layout.nil?
+      end
+
+      # define a local variable
+      o.on("-D", "--define=PAIR", String) do |pair|
+        key, value = pair.split(/[=:]/, 2)
+        locals[key.to_sym] = value
+      end
+
+      # define local variables from YAML or JSON
+      o.on("-d", "--define-file=FILE", String) do |file|
+        require 'yaml'
+        abort.("no such define file: #{file}") unless File.exist? file
+        hash = File.open(file, 'r:bom|utf-8') { |f| YAML.load(f.read) }
+        abort.("vars must be a Hash, not instance of #{hash.class}") unless hash.is_a?(Hash)
+        hash.each { |key, value| locals[key.to_sym] = value }
+      end
+
+      # define local variables using a Ruby hash
+      o.on("--vars=RUBY") do |ruby|
+        hash = eval(ruby)
+        abort.("vars must be a Hash, not instance of #{hash.class}") unless hash.is_a?(Hash)
+        hash.each { |key, value| locals[key.to_sym] = value }
+      end
+
+      o.on_tail("-h", "--help") do
+        stdout.puts USAGE
+        return 0
+      end
+    end.parse!(argv)
+
+    file = argv.first || '-'
+    pattern = file if pattern.nil?
+    abort.("template type not given. see: #{script_name} --help") if ['-', ''].include?(pattern)
+
+    engine = Tilt[pattern]
+    abort.("template engine not found for: #{pattern}") unless engine
+
+    template =
+      engine.new(file) {
+        if file == '-'
+          stdin.read
+        else
+          File.read(file)
+        end
+      }
+    output = template.render(self, locals)
+
+    # process layout
+    output = Tilt.new(layout).render(self, locals) { output } if layout
+
+    stdout.write(output)
+
+    0
+  end
+end

data/lib/tilt/coffee.rb

@@ -1,4 +1,5 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'coffee_script'
 
 module Tilt
@@ -6,27 +7,12 @@ module Tilt
   # http://coffeescript.org/
   #
   # CoffeeScript templates do not support object scopes, locals, or yield.
-  class CoffeeScriptTemplate < Template
+  class CoffeeScriptTemplate < StaticTemplate
     self.default_mime_type = 'application/javascript'
 
-    @@default_bare = false
-
-    def self.default_bare
-      @@default_bare
-    end
-
-    def self.default_bare=(value)
-      @@default_bare = value
-    end
-
-    # DEPRECATED
-    def self.default_no_wrap
-      @@default_bare
-    end
-
-    # DEPRECATED
-    def self.default_no_wrap=(value)
-      @@default_bare = value
+    @default_bare = false
+    class << self
+      attr_accessor :default_bare
     end
 
     def self.literate?
@@ -34,22 +20,17 @@ module Tilt
     end
 
     def prepare
-      if !options.key?(:bare) and !options.key?(:no_wrap)
-        options[:bare] = self.class.default_bare
+      if !@options.key?(:bare) and !@options.key?(:no_wrap)
+        @options[:bare] = self.class.default_bare
       end
-      options[:literate] ||= self.class.literate?
-    end
-
-    def evaluate(scope, locals, &block)
-      @output ||= CoffeeScript.compile(data, options)
-    end
-
-    def allows_script?
-      false
+      @options[:literate] ||= self.class.literate?
+      @output = CoffeeScript.compile(@data, @options)
     end
   end
 
   class CoffeeScriptLiterateTemplate < CoffeeScriptTemplate
+    @default_bare = false
+
     def self.literate?
       true
     end

data/lib/tilt/commonmarker.rb

@@ -1,88 +1,54 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'commonmarker'
 
-module Tilt
-  class CommonMarkerTemplate < Template
-    self.default_mime_type = 'text/html'
-
-    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
-
-    def extensions
-      EXTENSIONS.select do |extension|
-        options[extension]
-      end
-    end
-
-    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
-
-      if actual_options.any?
-        actual_options
-      else
-        :DEFAULT
-      end
-    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
-      end
-      if actual_options.any?
-        actual_options
-      else
-        :DEFAULT
-      end
-    end
-
-    def prepare
-      @engine = nil
-      @output = nil
-    end
+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
+
+
+Tilt::CommonMarkerTemplate = Tilt::StaticTemplate.subclass do
+  extensions = exts.select do |extension|
+    @options[extension]
+  end
 
-    def evaluate(scope, locals, &block)
-      doc = CommonMarker.render_doc(data, parse_options, extensions)
-      doc.to_html(render_options, extensions)
+  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
 
-    def allows_script?
-      false
-    end
+    opts = :DEFAULT unless opts.any?
+    opts
   end
+
+  CommonMarker.render_doc(@data, parse_options, extensions).to_html(render_options, extensions)
 end

data/lib/tilt/creole.rb

@@ -1,25 +1,14 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'creole'
 
-module Tilt
-  # Creole implementation. See:
-  # http://www.wikicreole.org/
-  class CreoleTemplate < Template
-    def prepare
-      opts = {}
-      [:allowed_schemes, :extensions, :no_escape].each do |k|
-        opts[k] = options[k] if options[k]
-      end
-      @engine = Creole::Parser.new(data, opts)
-      @output = nil
-    end
+allowed_opts = [:allowed_schemes, :extensions, :no_escape].freeze
 
-    def evaluate(scope, locals, &block)
-      @output ||= @engine.to_html
-    end
-
-    def allows_script?
-      false
-    end
+# Creole implementation. See: http://www.wikicreole.org/
+Tilt::CreoleTemplate = Tilt::StaticTemplate.subclass do
+  opts = {}
+  allowed_opts.each do |k|
+    opts[k] = @options[k] if @options[k]
   end
+  Creole::Parser.new(@data, opts).to_html
 end

data/lib/tilt/csv.rb

@@ -1,4 +1,5 @@
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'template'
 require 'csv'
 
 module Tilt
@@ -32,13 +33,13 @@ module Tilt
     self.default_mime_type = 'text/csv'
 
     def prepare
-      @outvar = options.delete(:outvar) || '_csvout'
+      @outvar = @options.delete(:outvar) || '_csvout'
     end
 
     def precompiled_template(locals)
       <<-RUBY
-        #{@outvar} = CSV.generate(**#{options}) do |csv|
-          #{data}
+        #{@outvar} = CSV.generate(**#{@options}) do |csv|
+          #{@data}
         end
       RUBY
     end