tilt 2.0.11 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a552c8551a7093b787234c00bac7ccaaef77e89b1d4835c31ddbaeb8388c74ae
-  data.tar.gz: 014cff88cd5ec4157d02127576eb788a6b0ae3795e69dc448781093f59153769
+  metadata.gz: e425f100107f57bdcf754dde8fcabc9a1d63ad9ee1ad5e2bffe2b5103affc712
+  data.tar.gz: 655f9f6617846da59ce0011c4ad15cb20ec01b55045662a4ef6d4537b6ff523c
 SHA512:
-  metadata.gz: 9d9da743f0359f10e8486b946132d39ba892482a99e7961c4a62258a680a214030824e92442db2421f35cac7c4378ff3e8e8e0af72bd8af35150aae2cc58555b
-  data.tar.gz: 2755a44a43e094eb95bffe6ab095f4d8a6cc1b58d1c96d6c20325d8d607ada32da7529758dfed8f8d8f09a3eafe2c7d96f381c314c7cc99f950a36c5eaff3454
+  metadata.gz: 18339cfc7b770f714aa272fa5bc8d9d0726b23b0cff8df69c45f2bafa3a341705c50c152bff1c20187b328e46c05b08a0e7a2ab0339352e42afd871559fecf8b
+  data.tar.gz: c0d5aee0ec0c2cab1f30aef4bc783432ce945dd446c929b3af370f2f57175718d76ae5f55e0ba1df29de2dc64720d4c911592c9ea0516b8e6abfd06daef656c7

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,22 @@
-require 'tilt/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'
+# frozen_string_literal: true
 
-    def prepare
-      options[:header_footer] = false if options[:header_footer].nil?
-    end
+# = 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
 
-    def evaluate(scope, locals, &block)
-      @output ||= Asciidoctor.render(data, options, &block)
-    end
+require_relative 'template'
+require 'asciidoctor'
 
-    def allows_script?
-      false
-    end
-  end
+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,13 @@
-require 'tilt/template'
-require 'babel/transpiler'
+# frozen_string_literal: true
 
-module Tilt
-  class BabelTemplate < Template
-    self.default_mime_type = 'application/javascript'
+# = Babel
+#
+#
 
-    def prepare
-      options[:filename] ||= file
-    end
+require_relative 'template'
+require 'babel/transpiler'
 
-    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,31 @@
-require 'tilt/template'
+# frozen_string_literal: true
+
+# = Builder
+#
+
+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 +34,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,32 +1,28 @@
-require 'tilt/template'
+# 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 < 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 +30,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