tilt 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69824d0f8d59718a45a289673dbbc34b6e083c83
-  data.tar.gz: a655207744e9fa92153589e77587d8593cbbd005
+  metadata.gz: 736fe3309d9aab2be73d9ec2fd4d9b110d6736ac
+  data.tar.gz: 236969d204a43624049b69dee61983bf410b57d8
 SHA512:
-  metadata.gz: 7c5c9bfae55c46fb9cb82e0ba9612a649d6a3283fcf8b9a1bcc20b115299f0c34619b751420b8b77c94d65e76ab53a6d88b8f83cb77c5a1abcc87088e3a5bcda
-  data.tar.gz: ef8c85a45a30d284d8fb61b7480cc223bca9254fba2d5a026106aeb52024133f629dcab8bcf6f90606a1c211dcc41a2fa0ff6908b164f70f6325fd34dda2b5f3
+  metadata.gz: c30008417646c5d8273b32cb357c57635d6c34c879957f8712c2a52dac00b1915a44cb6937093eb2459c216d999a5b22aa1844381de8a94eb28610b6e24e13af
+  data.tar.gz: 2d4d093a48e787e69431b8e34d89ce983dd648b90820bdc393e83ba2f71015e63203031c81908ae6445dd7cc6138213bc78f9d999ad3968c6c307d9ab081b559

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.0.5 (2016-06-02)
+
+* Add support for reST using Pandoc (#284, mfenner)
+* Make lazy loading thread-safe; remove warning (judofyr)
+
 ## 2.0.4 (2016-05-16)
 
 * Fix regression in BuilderTemplate (#283, judofyr)

data/COPYING

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

data/README.md

@@ -41,6 +41,7 @@ Support for these template engines is included with the package:
 | BlueCloth               | .markdown, .mkd, .md   | bluecloth                                  | Community   |
 | Kramdown                | .markdown, .mkd, .md   | kramdown                                   | Community   |
 | Pandoc                  | .markdown, .mkd, .md   | pandoc                                     | Community   |
+| reStructuredText        | .rst                   | pandoc                                     | Community   |
 | Maruku                  | .markdown, .mkd, .md   | maruku                                     | Community   |
 | CommonMarker            | .markdown, .mkd, .md   | commonmarker                               | Community   |
 | RedCloth                | .textile               | redcloth                                   | Community   |

data/docs/TEMPLATES.md

@@ -33,10 +33,11 @@ Tilt also includes support for CSS processors like [LessCSS][lesscss] and
  * CoffeeScript - `Tilt::CoffeeScriptTemplate`
  * Literate CoffeeScript - `Tilt::CoffeeScriptLiterateTemplate`
  * [Textile](#redcloth) - `Tilt::RedClothTemplate`
+ * reStructuredText - `Tilt::RstPandocTemplate`
  * Creole - `Tilt::CreoleTemplate`
  * [RDoc](#rdoc) - `Tilt::RDocTemplate`
 
-Tilt has extensive support for Markdown, backed by one of four different
+Tilt has extensive support for Markdown, backed by one of seven different
 implementations (depending on which are available on your system):
 
  * [Markdown](#markdown) - Generic Markdown implementation
@@ -45,6 +46,7 @@ implementations (depending on which are available on your system):
  * BlueCloth - `Tilt::BlueClothTemplate`
  * Kramdown - `Tilt::KramdownTemplate`
  * Pandoc - `Tilt::PandocTemplate`
+ * CommonMarker - `Tilt::CommonMarkerTemplate`
  * Maruku - `Tilt::MarukuTemplate`
 
 <a name='erb'></a>
@@ -393,6 +395,31 @@ when using this template engine in a threaded environment.
 
   * [RedCloth][redcloth]
 
+<a name='rst'></a>
+reStructuredText (`rst`)
+-------------------
+
+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][pandoc], which
+is an application written in Haskell, with a Ruby wrapper provided by the
+[pandoc-ruby][pandoc-ruby] gem.
+
+### Example
+
+    Hello Rst Templates
+    ===================
+
+    Hello World. This is a paragraph.
+
+### See Also
+
+  * [Pandoc][pandoc]
+  * [pandoc-ruby][pandoc-ruby]
+
 
 <a name='rdoc'></a>
 RDoc (`rdoc`)
@@ -523,3 +550,5 @@ using this template engine within a threaded environment.
 [rdiscount]: http://github.com/rtomayko/rdiscount/ "RDiscount"
 [smartypants]: http://daringfireball.net/projects/smartypants/ "Smarty Pants"
 [markdown]: http://en.wikipedia.org/wiki/Markdown "Markdown"
+[pandoc]: http://pandoc.org/ "Pandoc"
+[pandoc-ruby]: https://github.com/alphabetum/pandoc-ruby "pandoc-ruby"

data/lib/tilt.rb

@@ -4,7 +4,7 @@ require 'tilt/template'
 # Namespace for Tilt. This module is not intended to be included anywhere.
 module Tilt
   # Current version.
-  VERSION = '2.0.4'
+  VERSION = '2.0.5'
 
   @default_mapping = Mapping.new
 
@@ -146,6 +146,7 @@ module Tilt
   register_lazy :RDocTemplate,         'tilt/rdoc',      'rdoc'
   register_lazy :RadiusTemplate,       'tilt/radius',    'radius'
   register_lazy :RedClothTemplate,     'tilt/redcloth',  'textile'
+  register_lazy :RstPandocTemplate,    'tilt/rst-pandoc', 'rst'
   register_lazy :SassTemplate,         'tilt/sass',      'sass'
   register_lazy :ScssTemplate,         'tilt/sass',      'scss'
   register_lazy :StringTemplate,       'tilt/string',    'str'

data/lib/tilt/mapping.rb

@@ -1,3 +1,5 @@
+require 'monitor'
+
 module Tilt
   # Tilt::Mapping associates file extensions with template implementations.
   #
@@ -214,9 +216,14 @@ module Tilt
       @template_map[ext] || lazy_load(ext)
     end
 
+    LOCK = Monitor.new
+
     def lazy_load(pattern)
       return unless @lazy_map.has_key?(pattern)
 
+      LOCK.enter
+      entered = true
+
       choices = @lazy_map[pattern]
 
       # Check if a template class is already present
@@ -234,12 +241,6 @@ module Tilt
       choices.each do |class_name, file|
         begin
           require file
-
-          if Thread.list.size > 1
-            warn "WARN: tilt autoloading '#{file}' in a non thread-safe way; " +
-              "explicit require '#{file}' suggested."
-          end
-
           # It's safe to eval() here because constant_defined? will
           # raise NameError on invalid constant names
           template_class = eval(class_name)
@@ -252,6 +253,8 @@ module Tilt
       end
 
       raise first_failure if first_failure
+    ensure
+      LOCK.exit if entered
     end
 
     # This is due to a bug in JRuby (see GH issue jruby/jruby#3585)

data/lib/tilt/pandoc.rb

@@ -5,45 +5,41 @@ module Tilt
   # Pandoc markdown implementation. See:
   # http://pandoc.org/
   class PandocTemplate < Template
-    def prepare
-      @output = PandocRuby.convert(data, options_hash, *options_array).strip
-    end
+    self.default_mime_type = 'text/html'
 
     def tilt_to_pandoc_mapping
-      { :smartypants => [:smart, true],
-        :escape_html => [:f, 'markdown-raw_html']
+      { :smartypants => :smart,
+        :escape_html => { :f => 'markdown-raw_html' },
+        :commonmark => { :f => 'commonmark' },
+        :markdown_strict => { :f => 'markdown_strict' }
       }
     end
 
-    def pandoc_optimised_options
-      options.inject({}) do |hash, option|
-        if tilt_to_pandoc_mapping.has_key?(option[0]) && option[1] === true
-          hash[tilt_to_pandoc_mapping[option[0]][0]] = tilt_to_pandoc_mapping[option[0]][1]
+    # turn options hash into an array
+    # Map tilt options to pandoc options
+    # Replace hash keys with value true with symbol for key
+    # Remove hash keys with value false
+    # Leave other hash keys untouched
+    def pandoc_options
+      options.reduce([]) do |sum, (k,v)|
+        case v
+        when true
+          sum << (tilt_to_pandoc_mapping[k] || k)
+        when false
+          sum
         else
-          hash[option[0]] = option[1]
+          sum << { k => v }
         end
-
-        hash
-      end.merge({:to => :html})
-    end
-
-    def options_array
-      pandoc_optimised_options.map do |option|
-        option[0] if option[1] === true
-      end.compact
+      end
     end
 
-    def options_hash
-      pandoc_optimised_options.inject({}) do |hash, option|
-        # next if option[1] === true
-        # next if option[1] === false
-        hash[option[0]] = option[1] unless option[1] === true or option[1] === false
-        hash
-      end
+    def prepare
+      @engine = PandocRuby.new(data, *pandoc_options)
+      @output = nil
     end
 
     def evaluate(scope, locals, &block)
-      @output
+      @output ||= @engine.to_html.strip
     end
 
     def allows_script?

data/lib/tilt/rst-pandoc.rb

@@ -0,0 +1,18 @@
+require 'tilt/template'
+require 'tilt/pandoc'
+
+module Tilt
+  # Pandoc reStructuredText implementation. See:
+  # http://pandoc.org/
+  # Use PandocTemplate and specify input format
+  class RstPandocTemplate < PandocTemplate
+    def tilt_to_pandoc_mapping
+      { :smartypants => :smart }
+    end
+
+    def pandoc_options
+      options.merge!(f: 'rst')
+      super
+    end
+  end
+end

data/test/tilt_mapping_test.rb

@@ -125,20 +125,6 @@ module Tilt
           end
         end
       end
-
-      test "warns when there's multiple threads" do
-        Thread.new do
-          req = proc do |file|
-            class ::MyTemplate; end
-          end
-
-          @mapping.stub :require, req do
-            assert_output '', /autoloading 'my_template'/ do
-              @mapping['hello.mt']
-            end
-          end
-        end.join
-      end
     end
 
     context "lazy with two template classes" do

data/test/tilt_markdown_test.rb

@@ -180,9 +180,6 @@ begin
   class MarkdownPandocTest < Minitest::Test
     include MarkdownTests
     template Tilt::PandocTemplate
-
-    # Doesn't support escaping
-    undef test_escape_html_true
   end
 rescue LoadError => boom
   # It should already be warned in the main tests

data/test/tilt_pandoctemplate_test.rb

@@ -9,12 +9,12 @@ begin
   class PandocTemplateTest < Minitest::Test
     test "preparing and evaluating templates on #render" do
       template = Tilt::PandocTemplate.new { |t| "# Hello World!" }
-      assert_equal "<h1 id=\"hello-world\">Hello World!</h1>", template.render.strip
+      assert_equal "<h1 id=\"hello-world\">Hello World!</h1>", template.render
     end
 
     test "can be rendered more than once" do
       template = Tilt::PandocTemplate.new { |t| "# Hello World!" }
-      3.times { assert_equal "<h1 id=\"hello-world\">Hello World!</h1>", template.render.strip }
+      3.times { assert_equal "<h1 id=\"hello-world\">Hello World!</h1>", template.render }
     end
 
     test "smartypants when :smartypants is set" do
@@ -29,12 +29,23 @@ begin
 
     # Pandoc has tons of additional markdown features (see http://pandoc.org/README.html#pandocs-markdown).
     # The test for footnotes should be seen as a general representation for all of them.
-    test "generates footnotes" do
-      template = Tilt::PandocTemplate.new { |t| "Here is an inline note.^[Inlines notes are cool!]" }
-      assert_equal "<p>Here is an inline note.<a href=\"#fn1\" class=\"footnoteRef\" id=\"fnref1\"><sup>1</sup></a></p>\n<div class=\"footnotes\">\n<hr />\n<ol>\n<li id=\"fn1\"><p>Inlines notes are cool!<a href=\"#fnref1\">↩</a></p></li>\n</ol>\n</div>", template.render.strip
-    end
-
+    # use markdown_strict => true to disable additional markdown features
     describe "passing in Pandoc options" do
+      test "generates footnotes" do
+        template = Tilt::PandocTemplate.new { |t| "Here is an inline note.^[Inlines notes are cool!]" }
+        assert_equal "<p>Here is an inline note.<a href=\"#fn1\" class=\"footnoteRef\" id=\"fnref1\"><sup>1</sup></a></p>\n<div class=\"footnotes\">\n<hr />\n<ol>\n<li id=\"fn1\"><p>Inlines notes are cool!<a href=\"#fnref1\">↩</a></p></li>\n</ol>\n</div>", template.render
+      end
+
+      test "doesn't generate footnotes with markdown_strict option" do
+        template = Tilt::PandocTemplate.new(:markdown_strict => true) { |t| "Here is an inline note.^[Inlines notes are cool!]" }
+        assert_equal "<p>Here is an inline note.^[Inlines notes are cool!]</p>", template.render
+      end
+
+      test "doesn't generate footnotes with commonmark option" do
+        template = Tilt::PandocTemplate.new(:commonmark => true) { |t| "Here is an inline note.^[Inlines notes are cool!]" }
+        assert_equal "<p>Here is an inline note.^[Inlines notes are cool!]</p>", template.render
+      end
+
       test "accepts arguments with values (e.g. :id_prefix => 'xyz')" do
         # Table of contents isn't on by default
         template = Tilt::PandocTemplate.new { |t| "# This is a heading" }

data/test/tilt_rstpandoctemplate_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+require 'tilt'
+
+begin
+  require 'tilt/rst-pandoc'
+
+  class RstPandocTemplateTest < Minitest::Test
+    test "is registered for '.rst' files" do
+      assert_equal Tilt::RstPandocTemplate, Tilt['test.rst']
+    end
+
+    test "compiles and evaluates the template on #render" do
+      template = Tilt::RstPandocTemplate.new { |t| "Hello World!\n============" }
+      assert_equal "<h1 id=\"hello-world\">Hello World!</h1>", template.render
+    end
+
+    test "can be rendered more than once" do
+      template = Tilt::RstPandocTemplate.new { |t| "Hello World!\n============" }
+      3.times do
+        assert_equal "<h1 id=\"hello-world\">Hello World!</h1>", template.render
+      end
+    end
+
+    test "doens't use markdown options" do
+      template = Tilt::RstPandocTemplate.new(:escape_html => true) { |t| "HELLO <blink>WORLD</blink>" }
+      err = assert_raises(RuntimeError) { template.render }
+      assert_match /pandoc: unrecognized option `--escape-html/, err.message
+    end
+  end
+rescue LoadError => boom
+  warn "Tilt::RstPandocTemplate (disabled) [#{boom}]"
+end

data/tilt.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'tilt'
-  s.version = '2.0.4'
-  s.date = '2016-05-16'
+  s.version = '2.0.5'
+  s.date = '2016-06-02'
 
   s.description = "Generic interface to multiple Ruby template engines"
   s.summary     = s.description
@@ -53,6 +53,7 @@ Gem::Specification.new do |s|
     lib/tilt/rdoc.rb
     lib/tilt/redcarpet.rb
     lib/tilt/redcloth.rb
+    lib/tilt/rst-pandoc.rb
     lib/tilt/sass.rb
     lib/tilt/string.rb
     lib/tilt/template.rb
@@ -101,6 +102,7 @@ Gem::Specification.new do |s|
     test/tilt_rdoctemplate_test.rb
     test/tilt_redcarpettemplate_test.rb
     test/tilt_redclothtemplate_test.rb
+    test/tilt_rstpandoctemplate_test.rb
     test/tilt_sasstemplate_test.rb
     test/tilt_stringtemplate_test.rb
     test/tilt_template_test.rb

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tilt
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Ryan Tomayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies: []
 description: Generic interface to multiple Ruby template engines
 email: r@tomayko.com
@@ -55,6 +55,7 @@ files:
 - lib/tilt/rdoc.rb
 - lib/tilt/redcarpet.rb
 - lib/tilt/redcloth.rb
+- lib/tilt/rst-pandoc.rb
 - lib/tilt/sass.rb
 - lib/tilt/string.rb
 - lib/tilt/template.rb
@@ -103,6 +104,7 @@ files:
 - test/tilt_rdoctemplate_test.rb
 - test/tilt_redcarpettemplate_test.rb
 - test/tilt_redclothtemplate_test.rb
+- test/tilt_rstpandoctemplate_test.rb
 - test/tilt_sasstemplate_test.rb
 - test/tilt_stringtemplate_test.rb
 - test/tilt_template_test.rb
@@ -137,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 2
 summary: Generic interface to multiple Ruby template engines
@@ -171,6 +173,7 @@ test_files:
 - test/tilt_rdoctemplate_test.rb
 - test/tilt_redcarpettemplate_test.rb
 - test/tilt_redclothtemplate_test.rb
+- test/tilt_rstpandoctemplate_test.rb
 - test/tilt_sasstemplate_test.rb
 - test/tilt_stringtemplate_test.rb
 - test/tilt_template_test.rb