temple 0.6.10 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae954824af20378733a4583f79f7e25fe6493bf5
-  data.tar.gz: 71463f0834e907f81591ad89e262ac56a0b7ecc6
+  metadata.gz: 02ca8f3e947dac83c75a1a000ee6704e648b5b2b
+  data.tar.gz: 61b7cc39adfe732535a96b6c3e7f9f8876233869
 SHA512:
-  metadata.gz: bd44ebc6d99334bea744709cc2297e6eb3f9fb9824439676cb04c093a2fe5e3ce5c5820951c86d7f5a7f4cf96c3951cfc1669106d127cd06d40b38dc357c53e3
-  data.tar.gz: a0f479de080332970d17b05fca137d60aa61e68ae3112fdfc8e0996c3a1dea9e0b8cc80ba5f61c9d786ca7950d805a88e1deaffb9afd94b41c770df00c658b34
+  metadata.gz: c2bdfd18f5484eb9af801a382d518d02a04bb7944171203ecafa358b81095c1ddbc17288ba1d2de0417159a56d90207584b5da8499e74dcce08924e1d53e885d
+  data.tar.gz: 29159d5eab3f95322e5a8b6058ae095df229667c0e9fcdb769070eb6874713e32ad0cacf326be483503b864c3e7e27d12aa0601c4ea48a4d9be7cb04ffe9512a

data/.travis.yml

@@ -1,11 +1,9 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
   - 2.1.0
   - ruby-head
-  - jruby-18mode
   - jruby-19mode
   - rbx-2
 matrix:

data/CHANGES

@@ -1,3 +1,18 @@
+0.7.1
+
+  * Rename *Hash to *Map
+  * Add Filters::StaticFreezer
+
+0.7.0
+
+  * Drop Ruby 1.8.7 support
+  * EngineDSL: Remove option filter
+  * HTML: Deprecate :html4, :html5 formats
+  * HTML: Add format :xml
+  * Rename DefaultOptions to ClassOptions
+  * Deprecate default_options in favor of options
+  * Add Utils.indent_dynamic
+
 0.6.10
 
   * Tilt template: Support :outvar and save/restore buffer to make the behaviour compatible with ERB

data/README.md

@@ -195,8 +195,8 @@ When you have a chain of a parsers, some filters and a generator you can finally
 
 ```ruby
  class MyEngine < Temple::Engine
-   # First run MyParser, passing the :strict option
-   use MyParser, :strict
+   # First run MyParser
+   use MyParser
 
    # Then a custom filter
    use MyFilter
@@ -207,10 +207,10 @@ When you have a chain of a parsers, some filters and a generator you can finally
    filter :DynamicInliner
 
    # Finally the generator
-   generator :ArrayBuffer, :buffer
+   generator :ArrayBuffer
  end
 
- engine = MyEngine.new(:strict => "For MyParser")
+ engine = MyEngine.new(strict: "For MyParser")
  engine.call(something)
 ```
 
@@ -227,7 +227,7 @@ Rails.
  require 'tilt'
 
  # Create template class MyTemplate and register your file extension
- MyTemplate = Temple::Templates::Tilt(MyEngine, :register_as => 'ext')
+ MyTemplate = Temple::Templates::Tilt(MyEngine, register_as: 'ext')
 
  Tilt.new('example.ext').render     # => Render a file
  MyTemplate.new { "String" }.render # => Render a string
@@ -236,7 +236,7 @@ Rails.
 Installation
 ------------
 
-You need Ruby 1.8.7 or Ruby 1.9.2 to work with Temple. Temple is published as a Ruby Gem which can be installed
+You need at least Ruby 1.9.3 to work with Temple. Temple is published as a Ruby Gem which can be installed
 as following:
 
 ```bash

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake/testtask'
 
-task :default => :test
+task default: :test
 task :test do
   sh "bacon -Ilib -Itest --automatic --quiet"
 end

data/lib/temple.rb

@@ -10,9 +10,9 @@ module Temple
   autoload :Filter,               'temple/filter'
   autoload :Templates,            'temple/templates'
   autoload :Grammar,              'temple/grammar'
-  autoload :ImmutableHash,        'temple/hash'
-  autoload :MutableHash,          'temple/hash'
-  autoload :OptionHash,           'temple/hash'
+  autoload :ImmutableMap,         'temple/map'
+  autoload :MutableMap,           'temple/map'
+  autoload :OptionMap,            'temple/map'
 
   module Mixins
     autoload :Dispatcher,         'temple/mixins/dispatcher'
@@ -20,7 +20,7 @@ module Temple
     autoload :EngineDSL,          'temple/mixins/engine_dsl'
     autoload :GrammarDSL,         'temple/mixins/grammar_dsl'
     autoload :Options,            'temple/mixins/options'
-    autoload :DefaultOptions,     'temple/mixins/options'
+    autoload :ClassOptions,       'temple/mixins/options'
     autoload :Template,           'temple/mixins/template'
   end
 
@@ -44,6 +44,7 @@ module Temple
     autoload :ControlFlow,        'temple/filters/control_flow'
     autoload :MultiFlattener,     'temple/filters/multi_flattener'
     autoload :StaticMerger,       'temple/filters/static_merger'
+    autoload :StaticFreezer,      'temple/filters/static_freezer'
     autoload :DynamicInliner,     'temple/filters/dynamic_inliner'
     autoload :Escapable,          'temple/filters/escapable'
     autoload :Eraser,             'temple/filters/eraser'

data/lib/temple/engine.rb

@@ -24,7 +24,7 @@ module Temple
   #     replace :ArrayBuffer, Temple::Generators::RailsOutputBuffer
   #   end
   #
-  #   engine = MyEngine.new(:strict => "For MyParser")
+  #   engine = MyEngine.new(strict: "For MyParser")
   #   engine.call(something)
   #
   # @api public

data/lib/temple/erb/engine.rb

@@ -5,8 +5,8 @@ module Temple
     # @api public
     class Engine < Temple::Engine
       use Temple::ERB::Parser
-      use Temple::ERB::Trimming, :trim_mode
-      filter :Escapable, :use_html_safe, :disable_escape
+      use Temple::ERB::Trimming
+      filter :Escapable
       filter :MultiFlattener
       filter :DynamicInliner
       generator :ArrayBuffer

data/lib/temple/filters/encoding.rb

@@ -4,7 +4,7 @@ module Temple
     #
     # @api public
     class Encoding < Parser
-      define_options :encoding => 'utf-8'
+      define_options encoding: 'utf-8'
 
       def call(s)
         if options[:encoding] && s.respond_to?(:encoding)

data/lib/temple/filters/eraser.rb

@@ -5,7 +5,7 @@ module Temple
     # @api public
     class Eraser < Filter
       # [] is the empty type => keep all
-      define_options :keep => [[]], :erase => nil
+      define_options :erase, keep: [[]]
 
       def compile(exp)
         exp.first == :multi || (do?(:keep, exp) && !do?(:erase, exp)) ?

data/lib/temple/filters/escapable.rb

@@ -9,8 +9,8 @@ module Temple
     class Escapable < Filter
       # Activate the usage of html_safe? if it is available (for Rails 3 for example)
       define_options :escape_code,
-                     :use_html_safe => ''.respond_to?(:html_safe?),
-                     :disable_escape => false
+                     :disable_escape,
+                     use_html_safe: ''.respond_to?(:html_safe?)
 
       def initialize(opts = {})
         super

data/lib/temple/filters/remove_bom.rb

@@ -5,15 +5,8 @@ module Temple
     # @api public
     class RemoveBOM < Parser
       def call(s)
-        if s.respond_to?(:encoding)
-          if s.encoding.name =~ /^UTF-(8|16|32)(BE|LE)?/
-            s.gsub(Regexp.new("\\A\uFEFF".encode(s.encoding.name)), '')
-          else
-            s
-          end
-        else
-          s.gsub(/\A\xEF\xBB\xBF/, '')
-        end
+        return s if s.encoding.name !~ /^UTF-(8|16|32)(BE|LE)?/
+        s.gsub(Regexp.new("\\A\uFEFF".encode(s.encoding.name)), '')
       end
     end
   end

data/lib/temple/filters/static_freezer.rb

@@ -0,0 +1,11 @@
+module Temple
+  module Filters
+    class StaticFreezer < Filter
+      define_options freeze_static: RUBY_VERSION >= '2.1'
+
+      def on_static(s)
+        options[:freeze_static] ? [:dynamic, "#{s.inspect}.freeze"] : [:static, s]
+      end
+    end
+  end
+end

data/lib/temple/filters/validator.rb

@@ -4,7 +4,7 @@ module Temple
     #
     # @api public
     class Validator < Filter
-      define_options :grammar => Temple::Grammar
+      define_options grammar: Temple::Grammar
 
       def compile(exp)
         options[:grammar].validate!(exp)

data/lib/temple/generator.rb

@@ -9,9 +9,9 @@ module Temple
     include Mixins::CompiledDispatcher
     include Mixins::Options
 
-    define_options :capture_generator => 'StringBuffer',
-                   :buffer => '_buf',
-                   :save_buffer => false
+    define_options :save_buffer,
+                   capture_generator: 'StringBuffer',
+                   buffer: '_buf'
 
     def call(exp)
       [preamble, compile(exp), postamble].flatten.compact.join('; ')
@@ -53,7 +53,7 @@ module Temple
     end
 
     def on_capture(name, exp)
-      capture_generator.new(:buffer => name).call(exp)
+      capture_generator.new(buffer: name).call(exp)
     end
 
     def on_static(text)

data/lib/temple/generators/rails_output_buffer.rb

@@ -10,10 +10,10 @@ module Temple
     # @api public
     class RailsOutputBuffer < StringBuffer
       define_options :streaming,
-                     :buffer_class => 'ActiveSupport::SafeBuffer',
-                     :buffer => '@output_buffer',
+                     buffer_class: 'ActiveSupport::SafeBuffer',
+                     buffer: '@output_buffer',
                      # output_buffer is needed for Rails 3.1 Streaming support
-                     :capture_generator => RailsOutputBuffer
+                     capture_generator: RailsOutputBuffer
 
       def call(exp)
         [preamble, compile(exp), postamble].flatten.compact.join('; ')

data/lib/temple/html/attribute_merger.rb

@@ -3,7 +3,7 @@ module Temple
     # This filter merges html attributes (e.g. used for id and class)
     # @api public
     class AttributeMerger < Filter
-      define_options :merge_attrs => {'id' => '_', 'class' => ' '}
+      define_options merge_attrs: {'id' => '_', 'class' => ' '}
 
       def on_html_attrs(*attrs)
         names = []

data/lib/temple/html/attribute_remover.rb

@@ -3,7 +3,7 @@ module Temple
     # This filter removes empty attributes
     # @api public
     class AttributeRemover < Filter
-      define_options :remove_empty_attrs => %w(id class)
+      define_options remove_empty_attrs: %w(id class)
 
       def initialize(opts = {})
         super

data/lib/temple/html/attribute_sorter.rb

@@ -3,7 +3,7 @@ module Temple
     # This filter sorts html attributes.
     # @api public
     class AttributeSorter < Filter
-      define_options :sort_attrs => true
+      define_options sort_attrs: true
 
       def call(exp)
         options[:sort_attrs] ? super : exp

data/lib/temple/html/fast.rb

@@ -2,40 +2,50 @@ module Temple
   module HTML
     # @api public
     class Fast < Filter
-      XHTML_DOCTYPES = {
-        '1.1'          => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">',
-        '5'            => '<!DOCTYPE html>',
-        'html'         => '<!DOCTYPE html>',
-        'strict'       => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">',
-        'frameset'     => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">',
-        'mobile'       => '<!DOCTYPE html PUBLIC "-//WAPFORUM//DTD XHTML Mobile 1.2//EN" "http://www.openmobilealliance.org/tech/DTD/xhtml-mobile12.dtd">',
-        'basic'        => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">',
-        'transitional' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
-        'svg'          => '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">'
-      }.freeze
+      DOCTYPES = {
+        xml: {
+          '1.1'          => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">',
+          '5'            => '<!DOCTYPE html>',
+          'html'         => '<!DOCTYPE html>',
+          'strict'       => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">',
+          'frameset'     => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">',
+          'mobile'       => '<!DOCTYPE html PUBLIC "-//WAPFORUM//DTD XHTML Mobile 1.2//EN" "http://www.openmobilealliance.org/tech/DTD/xhtml-mobile12.dtd">',
+          'basic'        => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">',
+          'transitional' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
+          'svg'          => '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">'
+        },
+        html: {
+          '5'            => '<!DOCTYPE html>',
+          'html'         => '<!DOCTYPE html>',
+          'strict'       => '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">',
+          'frameset'     => '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">',
+          'transitional' => '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">'
+        }
+      }
+      DOCTYPES[:xhtml] = DOCTYPES[:xml]
+      DOCTYPES.freeze
 
-      HTML_DOCTYPES = {
-        '5'            => '<!DOCTYPE html>',
-        'html'         => '<!DOCTYPE html>',
-        'strict'       => '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">',
-        'frameset'     => '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">',
-        'transitional' => '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">',
-      }.freeze
+      # See http://www.w3.org/html/wg/drafts/html/master/single-page.html#void-elements
+      HTML_VOID_ELEMENTS = %w[area base br col embed hr img input keygen link menuitem meta param source track wbr]
 
-      define_options :format => :xhtml,
-                     :attr_quote => '"',
-                     :autoclose => %w[base basefont bgsound link meta area br embed img keygen wbr input menuitem param source track hr col frame],
-                     :js_wrapper => nil
-
-      HTML = [:html, :html4, :html5]
+      define_options format: :xhtml,
+                     attr_quote: '"',
+                     autoclose: HTML_VOID_ELEMENTS,
+                     js_wrapper: nil
 
       def initialize(opts = {})
         super
-        unless [:xhtml, *HTML].include?(options[:format])
-          raise ArgumentError, "Invalid format #{options[:format].inspect}"
+        @format = options[:format]
+        unless [:xhtml, :html, :xml].include?(@format)
+          if @format == :html4 || @format == :html5
+            @format = :html
+            warn "Format #{@format.inspect} is deprecated, use :html"
+          else
+            raise ArgumentError, "Invalid format #{@format.inspect}"
+          end
         end
         wrapper = options[:js_wrapper]
-        wrapper = xhtml? ? :cdata : :comment if wrapper == :guess
+        wrapper = @format == :xml || @format == :xhtml ? :cdata : :comment if wrapper == :guess
         @js_wrapper =
           case wrapper
           when :comment
@@ -52,25 +62,15 @@ module Temple
           end
       end
 
-      def xhtml?
-        options[:format] == :xhtml
-      end
-
-      def html?
-        !xhtml?
-      end
-
       def on_html_doctype(type)
         type = type.to_s.downcase
 
         if type =~ /^xml(\s+(.+))?$/
-          raise(FilterError, 'Invalid xml directive in html mode') if html?
+          raise(FilterError, 'Invalid xml directive in html mode') if @format == :html
           w = options[:attr_quote]
           str = "<?xml version=#{w}1.0#{w} encoding=#{w}#{$2 || 'utf-8'}#{w} ?>"
-        elsif html?
-          str = HTML_DOCTYPES[type] || raise(FilterError, "Invalid html doctype #{type}")
         else
-          str = XHTML_DOCTYPES[type] || raise(FilterError, "Invalid xhtml doctype #{type}")
+          str = DOCTYPES[@format][type] || raise(FilterError, "Invalid doctype #{type}")
         end
 
         [:static, str]
@@ -92,9 +92,9 @@ module Temple
 
       def on_html_tag(name, attrs, content = nil)
         name = name.to_s
-        closed = !content || (empty_exp?(content) && options[:autoclose].include?(name))
+        closed = !content || (empty_exp?(content) && (@format == :xml || options[:autoclose].include?(name)))
         result = [:multi, [:static, "<#{name}"], compile(attrs)]
-        result << [:static, (closed && xhtml? ? ' /' : '') + '>']
+        result << [:static, (closed && @format != :html ? ' /' : '') + '>']
         result << compile(content) if content
         result << [:static, "</#{name}>"] if !closed
         result
@@ -105,7 +105,7 @@ module Temple
       end
 
       def on_html_attr(name, value)
-        if html? && empty_exp?(value)
+        if @format == :html && empty_exp?(value)
           [:static, " #{name}"]
         else
           [:multi,

data/lib/temple/html/pretty.rb

@@ -2,21 +2,21 @@ module Temple
   module HTML
     # @api public
     class Pretty < Fast
-      define_options :indent => '  ',
-                     :pretty => true,
-                     :indent_tags => %w(article aside audio base body datalist dd div dl dt
+      define_options indent: '  ',
+                     pretty: true,
+                     indent_tags: %w(article aside audio base body datalist dd div dl dt
                                         fieldset figure footer form head h1 h2 h3 h4 h5 h6
                                         header hgroup hr html li link meta nav ol option p
                                         rp rt ruby section script style table tbody td tfoot
                                         th thead tr ul video doctype).freeze,
-                     :pre_tags => %w(code pre textarea).freeze
+                     pre_tags: %w(code pre textarea).freeze
 
       def initialize(opts = {})
         super
-        @last = nil
+        @indent_next = nil
         @indent = 0
         @pretty = options[:pretty]
-        @pre_tags = Regexp.new(options[:pre_tags].map {|t| "<#{t}" }.join('|'))
+        @pre_tags = @format != :xml && Regexp.union(options[:pre_tags].map {|t| "<#{t}" })
       end
 
       def call(exp)
@@ -24,36 +24,19 @@ module Temple
       end
 
       def on_static(content)
-        if @pretty
-          if @pre_tags !~ content
-            content = content.sub(/\A\s*\n?/, "\n") if options[:indent_tags].include?(@last)
-            content = content.gsub("\n", indent)
-          end
-          @last = :static
+        return [:static, content] unless @pretty
+        unless @pre_tags && @pre_tags =~ content
+          content = content.sub(/\A\s*\n?/, "\n") if @indent_next
+          content = content.gsub("\n", indent)
         end
+        @indent_next = false
         [:static, content]
       end
 
       def on_dynamic(code)
-        if @pretty
-          tmp = unique_name
-          indent_code = ''
-          indent_code << "#{tmp} = #{tmp}.sub(/\\A\\s*\\n?/, \"\\n\"); " if options[:indent_tags].include?(@last)
-          indent_code << "#{tmp} = #{tmp}.gsub(\"\\n\", #{indent.inspect}); "
-          if ''.respond_to?(:html_safe)
-            safe = unique_name
-            # we have to first save if the string was html_safe
-            # otherwise the gsub operation will lose that knowledge
-            indent_code = "#{safe} = #{tmp}.html_safe?; #{indent_code}#{tmp} = #{tmp}.html_safe if #{safe}; "
-          end
-          @last = :dynamic
-          [:multi,
-           [:code, "#{tmp} = (#{code}).to_s"],
-           [:code, "if #{@pre_tags_name} !~ #{tmp}; #{indent_code}end"],
-           [:dynamic, tmp]]
-        else
-          [:dynamic, code]
-        end
+        return [:dynamic, code] unless @pretty
+        indent_next, @indent_next = @indent_next, false
+        [:dynamic, "::Temple::Utils.indent_dynamic((#{code}), #{indent_next.inspect}, #{indent.inspect}#{@pre_tags ? ', ' + @pre_tags_name : ''})"]
       end
 
       def on_html_doctype(type)
@@ -64,7 +47,7 @@ module Temple
       def on_html_comment(content)
         return super unless @pretty
         result = [:multi, [:static, tag_indent('comment')], super]
-        @last = :comment
+        @indent_next = false
         result
       end
 
@@ -76,16 +59,18 @@ module Temple
 
         @pretty = false
         result = [:multi, [:static, "#{tag_indent(name)}<#{name}"], compile(attrs)]
-        result << [:static, (closed && xhtml? ? ' /' : '') + '>']
+        result << [:static, (closed && @format != :html ? ' /' : '') + '>']
 
-        @pretty = !options[:pre_tags].include?(name)
+        @pretty = !@pre_tags || !options[:pre_tags].include?(name)
         if content
           @indent += 1
           result << compile(content)
           @indent -= 1
         end
-        result << [:static, "#{content && !empty_exp?(content) ? tag_indent(name) : ''}</#{name}>"] unless closed
-
+        unless closed
+          indent = tag_indent(name)
+          result << [:static, "#{content && !empty_exp?(content) ? indent : ''}</#{name}>"]
+        end
         @pretty = true
         result
       end
@@ -93,6 +78,7 @@ module Temple
       protected
 
       def preamble
+        return [:multi] unless @pre_tags
         @pre_tags_name = unique_name
         [:code, "#{@pre_tags_name} = /#{@pre_tags.source}/"]
       end
@@ -103,9 +89,14 @@ module Temple
 
       # Return indentation before tag
       def tag_indent(name)
-        result = @last && (options[:indent_tags].include?(@last) || options[:indent_tags].include?(name)) ? indent : ''
-        @last = name
-        result
+        if @format == :xml
+          flag = @indent_next != nil
+          @indent_next = true
+        else
+          flag = @indent_next != nil && (@indent_next || options[:indent_tags].include?(name))
+          @indent_next = options[:indent_tags].include?(name)
+        end
+        flag ? indent : ''
       end
     end
   end