slim 2.1.0 → 3.0.0.beta.2

data/Rakefile

@@ -60,15 +60,17 @@ namespace 'test' do
   end
 
   begin
-    require 'rubygems'
     require 'sinatra'
     spec = Gem::Specification.find_by_name('sinatra')
     Rake::TestTask.new('sinatra') do |t|
-      # FIXME: Rename deprecated attribute
       file = "#{spec.gem_dir}/test/slim_test.rb"
-      code = File.read(file)
-      code.gsub!('attr_wrapper', 'attr_quote')
-      File.open(file, 'w') {|out| out.write(code) }
+
+      if Sinatra::VERSION =~ /\A1\.3/
+        # FIXME: Rename deprecated attribute
+        code = File.read(file)
+        code.gsub!('attr_wrapper', 'attr_quote')
+        File.open(file, 'w') {|out| out.write(code) }
+      end
 
       # Run Slim integration test in Sinatra
       t.test_files = FileList[file]
@@ -93,6 +95,6 @@ rescue LoadError
 end
 
 desc "Generate Documentation"
-task :doc => :yard
+task doc: :yard
 
-task :default => 'test'
+task default: 'test'

data/benchmarks/context.rb

@@ -4,8 +4,8 @@ class Context
   end
 
   def item
-    [ { :name => 'red',   :current => true,  :url => '#red'   },
-      { :name => 'green', :current => false, :url => '#green' },
-      { :name => 'blue',  :current => false, :url => '#blue'  } ]
+    [ { name: 'red',   current: true,  url: '#red'   },
+      { name: 'green', current: false, url: '#green' },
+      { name: 'blue',  current: false, url: '#blue'  } ]
   end
 end

data/benchmarks/run-benchmarks.rb

@@ -29,8 +29,8 @@ class SlimBenchmarks
     erb         = ERB.new(@erb_code)
     erubis      = Erubis::Eruby.new(@erb_code)
     fast_erubis = Erubis::FastEruby.new(@erb_code)
-    haml_pretty = Haml::Engine.new(@haml_code, :format => :html5)
-    haml_ugly   = Haml::Engine.new(@haml_code, :format => :html5, :ugly => true)
+    haml_pretty = Haml::Engine.new(@haml_code, format: :html5)
+    haml_ugly   = Haml::Engine.new(@haml_code, format: :html5, ugly: true)
 
     context  = Context.new
 
@@ -41,7 +41,7 @@ class SlimBenchmarks
       def run_erubis; #{erubis.src}; end
       def run_temple_erb; #{Temple::ERB::Engine.new.call @erb_code}; end
       def run_fast_erubis; #{fast_erubis.src}; end
-      def run_slim_pretty; #{Slim::Engine.new(:pretty => true).call @slim_code}; end
+      def run_slim_pretty; #{Slim::Engine.new(pretty: true).call @slim_code}; end
       def run_slim_ugly; #{Slim::Engine.new.call @slim_code}; end
     }
 
@@ -59,9 +59,9 @@ class SlimBenchmarks
     tilt_erb        = Tilt::ERBTemplate.new { @erb_code }
     tilt_erubis     = Tilt::ErubisTemplate.new { @erb_code }
     tilt_temple_erb = Temple::ERB::Template.new { @erb_code }
-    tilt_haml_pretty= Tilt::HamlTemplate.new(:format => :html5){ @haml_code }
-    tilt_haml_ugly  = Tilt::HamlTemplate.new(:format => :html5, :ugly => true){ @haml_code }
-    tilt_slim_pretty= Slim::Template.new(:pretty => true) { @slim_code }
+    tilt_haml_pretty= Tilt::HamlTemplate.new(format: :html5){ @haml_code }
+    tilt_haml_ugly  = Tilt::HamlTemplate.new(format: :html5, ugly: true){ @haml_code }
+    tilt_slim_pretty= Slim::Template.new(pretty: true) { @slim_code }
     tilt_slim_ugly  = Slim::Template.new { @slim_code }
 
     context  = Context.new
@@ -83,10 +83,10 @@ class SlimBenchmarks
     bench('(3) erubis')      { Erubis::Eruby.new(@erb_code).result(context_binding) }
     bench('(3) fast erubis') { Erubis::FastEruby.new(@erb_code).result(context_binding) }
     bench('(3) temple erb')  { Temple::ERB::Template.new { @erb_code }.render(context) }
-    bench('(3) slim pretty') { Slim::Template.new(:pretty => true) { @slim_code }.render(context) }
+    bench('(3) slim pretty') { Slim::Template.new(pretty: true) { @slim_code }.render(context) }
     bench('(3) slim ugly')   { Slim::Template.new { @slim_code }.render(context) }
-    bench('(3) haml pretty') { Haml::Engine.new(@haml_code, :format => :html5).render(context) }
-    bench('(3) haml ugly')   { Haml::Engine.new(@haml_code, :format => :html5, :ugly => true).render(context) }
+    bench('(3) haml pretty') { Haml::Engine.new(@haml_code, format: :html5).render(context) }
+    bench('(3) haml ugly')   { Haml::Engine.new(@haml_code, format: :html5, ugly: true).render(context) }
   end
 
   def run

data/benchmarks/view.slim

@@ -12,6 +12,6 @@ html
               strong == i[:name]
           - else
             li
-              a href=i[:url] == i[:name]
+              a href==i[:url] == i[:name]
     - else
       p The list is empty.

data/doc/jp/logic_less.md

@@ -34,7 +34,7 @@ Mustache のように, Slim はラムダ式をサポートします。
 ラムダ式は次のように定義できます:
 
     def lambda_method
-      "<div class='person'>#{yield(:name => 'Andrew')}</div>"
+      "<div class='person'>#{yield(name: 'Andrew')}</div>"
     end
 
 任意に 1 つ以上のハッシュを `yield` に渡すことができます。複数のハッシュを渡した場合, 先述したようにブロックが繰り返されます。
@@ -65,7 +65,7 @@ Mustache のように, Slim はラムダ式をサポートします。
 辞書オブジェクトを与え,
 
     {
-      :article => [
+      article: [
         'Article 1',
         'Article 2'
       ]
@@ -94,17 +94,17 @@ Mustache のように, Slim はラムダ式をサポートします。
 
 require で指定:
 
-    gem 'slim', :require => 'slim/logic_less'
+    gem 'slim', require: 'slim/logic_less'
 
 特定のアクションでのみロジックレスモードを有効化したい場合, まず設定でロジックレスモードを global に無効化します。
 
-    Slim::Engine.set_default_options :logic_less => false
+    Slim::Engine.set_options logic_less: false
 
 さらに, アクションの中でレンダリングする度にロジックレスモードを有効化します。
 
     class Controller
       def action
-        Slim::Engine.with_options(:logic_less => true) do
+        Slim::Engine.with_options(logic_less: true) do
           render
         end
       end
@@ -120,12 +120,12 @@ Sinatra には Slim のビルトインサポートがあります。しなけれ
 
 特定のアクションでのみロジックレスモードを有効化したい場合, まず設定でロジックレスモードを global に無効化します。
 
-    Slim::Engine.set_default_options :logic_less => false
+    Slim::Engine.set_options logic_less: false
 
 さらに, アクションの中でレンダリングする度にロジックレスモードを有効化します。
 
     get '/page'
-      slim :page, :logic_less => true
+      slim :page, logic_less: true
     end
 
 ## オプション

data/doc/logic_less.md

@@ -34,7 +34,7 @@ Like mustache, Slim supports lambdas.
 The lambda method could be defined like this
 
     def lambda_method
-      "<div class='person'>#{yield(:name => 'Andrew')}</div>"
+      "<div class='person'>#{yield(name: 'Andrew')}</div>"
     end
 
 You can optionally pass one or more hashes to `yield`. If you pass multiple hashes, the block will be iterated as described above.
@@ -65,7 +65,7 @@ The `self` keyword will return the `.to_s` value for the element under considera
 Given
 
     {
-      :article => [
+      article: [
         'Article 1',
         'Article 2'
       ]
@@ -94,17 +94,17 @@ Install:
 
 Require:
 
-    gem 'slim', :require => 'slim/logic_less'
+    gem 'slim', require: 'slim/logic_less'
 
 You might want to activate logic less mode only for a few actions, you should disable logic-less mode globally at first in the configuration
 
-    Slim::Engine.set_default_options :logic_less => false
+    Slim::Engine.set_options logic_less: false
 
 and activate logic less mode per render call in your action
 
     class Controller
       def action
-        Slim::Engine.with_options(:logic_less => true) do
+        Slim::Engine.with_options(logic_less: true) do
           render
         end
       end
@@ -120,12 +120,12 @@ You are then ready to rock!
 
 You might want to activate logic less mode only for a few actions, you should disable logic-less mode globally at first in the configuration
 
-    Slim::Engine.set_default_options :logic_less => false
+    Slim::Engine.set_options logic_less: false
 
 and activate logic less mode per render call in your application
 
     get '/page'
-      slim :page, :logic_less => true
+      slim :page, logic_less: true
     end
 
 ## Options

data/lib/slim/command.rb

@@ -2,7 +2,7 @@ require 'slim'
 require 'optparse'
 
 module Slim
-  Engine.set_default_options :pretty => false
+  Engine.set_options pretty: false
 
   # Slim commandline interface
   # @api private
@@ -40,7 +40,7 @@ module Slim
       end
 
       opts.on('--rails', 'Generate rails compatible code (Implies --compile)') do
-        Engine.set_default_options :disable_capture => true, :generator => Temple::Generators::RailsOutputBuffer
+        Engine.set_options disable_capture: true, generator: Temple::Generators::RailsOutputBuffer
         @options[:compile] = true
       end
 
@@ -48,23 +48,13 @@ module Slim
         require lib
       end
 
-      opts.on('-t', '--translator', 'Enable translator plugin') do
-        puts "Deprecated option: Use -r slim/translator"
-        require 'slim/translator'
-      end
-
-      opts.on('-l', '--logic-less', 'Enable logic less plugin') do
-        puts "Deprecated option: Use -r slim/logic_less"
-        require 'slim/logic_less'
-      end
-
       opts.on('-p', '--pretty', 'Produce pretty html') do
-        Engine.set_default_options :pretty => true
+        Engine.set_options pretty: true
       end
 
       opts.on('-o', '--option name=code', String, 'Set slim option') do |str|
         parts = str.split('=', 2)
-        Engine.default_options[parts.first.gsub(/\A:/, '').to_sym] = eval(parts.last)
+        Engine.options[parts.first.gsub(/\A:/, '').to_sym] = eval(parts.last)
       end
 
       opts.on_tail('-h', '--help', 'Show this message') do
@@ -95,9 +85,9 @@ module Slim
       result =
         if @options[:erb]
           require 'slim/erb_converter'
-          ERBConverter.new(:file => @options[:file]).call(@options[:input].read)
+          ERBConverter.new(file: @options[:file]).call(@options[:input].read)
         elsif @options[:compile]
-          Engine.new(:file => @options[:file]).call(@options[:input].read)
+          Engine.new(file: @options[:file]).call(@options[:input].read)
         else
           Template.new(@options[:file]) { @options[:input].read }.render
         end

data/lib/slim/embedded.rb

@@ -136,10 +136,7 @@ module Slim
         tilt_options = options[engine.to_sym] || {}
         [:multi, tilt_render(tilt_engine, tilt_options, collect_text(body)), collect_newlines(body)]
       end
-    end
 
-    # Tilt-based static template (evaluated at compile-time)
-    class StaticTiltEngine < TiltEngine
       protected
 
       def tilt_render(tilt_engine, tilt_options, text)
@@ -155,8 +152,8 @@ module Slim
 
       def tilt_render(tilt_engine, tilt_options, text)
         text = tilt_engine.new(tilt_options.merge(
-          :style => options[:pretty] ? :expanded : :compressed,
-          :cache => false)) { text }.render
+          style: options[:pretty] ? :expanded : :compressed,
+          cache: false)) { text }.render
         text.chomp!
         [:static, text]
       end
@@ -229,7 +226,7 @@ module Slim
     class JavaScriptEngine < TagEngine
       disable_option_validator!
 
-      set_default_options :tag => :script, :attributes => { :type => 'text/javascript' }
+      set_options tag: :script, attributes: { type: 'text/javascript' }
 
       def on_slim_embedded(engine, body)
         super(engine, [:html, :js, body])
@@ -254,12 +251,12 @@ module Slim
     register :org,        InterpolateTiltEngine
 
     # These engines are executed at compile time
-    register :coffee,     JavaScriptEngine, :engine => StaticTiltEngine
-    register :opal,       JavaScriptEngine, :engine => StaticTiltEngine
-    register :less,       TagEngine, :tag => :style,  :attributes => { :type => 'text/css' },         :engine => StaticTiltEngine
-    register :styl,       TagEngine, :tag => :style,  :attributes => { :type => 'text/css' },         :engine => StaticTiltEngine
-    register :sass,       TagEngine, :pretty, :tag => :style, :attributes => { :type => 'text/css' }, :engine => SassEngine
-    register :scss,       TagEngine, :pretty, :tag => :style, :attributes => { :type => 'text/css' }, :engine => SassEngine
+    register :coffee,     JavaScriptEngine, engine: TiltEngine
+    register :opal,       JavaScriptEngine, engine: TiltEngine
+    register :less,       TagEngine, tag: :style,  attributes: { type: 'text/css' },         engine: TiltEngine
+    register :styl,       TagEngine, tag: :style,  attributes: { type: 'text/css' },         engine: TiltEngine
+    register :sass,       TagEngine, :pretty, tag: :style, attributes: { type: 'text/css' }, engine: SassEngine
+    register :scss,       TagEngine, :pretty, tag: :style, attributes: { type: 'text/css' }, engine: SassEngine
 
     # These engines are precompiled, code is embedded
     register :erb,        ERBEngine
@@ -268,7 +265,7 @@ module Slim
 
     # Embedded javascript/css
     register :javascript, JavaScriptEngine
-    register :css,        TagEngine, :tag => :style,  :attributes => { :type => 'text/css' }
+    register :css,        TagEngine, tag: :style,  attributes: { type: 'text/css' }
 
     # Embedded ruby code
     register :ruby,       RubyEngine

data/lib/slim/engine.rb

@@ -5,37 +5,35 @@ module Slim
     # This overwrites some Temple default options or sets default options for Slim specific filters.
     # It is recommended to set the default settings only once in the code and avoid duplication. Only use
     # `define_options` when you have to override some default settings.
-    define_options :pretty => false,
-                   :sort_attrs => true,
-                   :format => :xhtml,
-                   :attr_quote => '"',
-                   :merge_attrs => {'class' => ' '},
-                   :generator => Temple::Generators::ArrayBuffer,
-                   :default_tag => 'div'
-    define_deprecated_options :attr_delims
+    define_options pretty: false,
+                   sort_attrs: true,
+                   format: :xhtml,
+                   attr_quote: '"',
+                   merge_attrs: {'class' => ' '},
+                   generator: Temple::Generators::ArrayBuffer,
+                   default_tag: 'div'
 
-    filter :Encoding, :encoding
+    filter :Encoding
     filter :RemoveBOM
-    use Slim::Parser, :file, :tabsize, :shortcut, :default_tag, :attr_delims, :attr_list_delims, :code_attr_delims
-    use Slim::Embedded, :enable_engines, :disable_engines, :pretty
+    use Slim::Parser
+    use Slim::Embedded
     use Slim::Interpolation
-    use Slim::Splat::Filter, :merge_attrs, :attr_quote, :sort_attrs, :default_tag, :hyphen_attrs, :format, :use_html_safe
+    use Slim::Splat::Filter
     use Slim::DoInserter
     use Slim::EndInserter
-    use Slim::Controls, :disable_capture
-    html :AttributeSorter, :sort_attrs
-    html :AttributeMerger, :merge_attrs
-    use Slim::CodeAttributes, :merge_attrs
-    use(:AttributeRemover) { Temple::HTML::AttributeRemover.new(:remove_empty_attrs => options[:merge_attrs].keys) }
-    html :Pretty, :format, :attr_quote, :pretty, :indent, :js_wrapper
-    filter :Escapable, :use_html_safe, :disable_escape
+    use Slim::Controls
+    html :AttributeSorter
+    html :AttributeMerger
+    use Slim::CodeAttributes
+    use(:AttributeRemover) { Temple::HTML::AttributeRemover.new(remove_empty_attrs: options[:merge_attrs].keys) }
+    html :Pretty
+    filter :Escapable
     filter :ControlFlow
     filter :MultiFlattener
-    use :Optimizer do
-      (options[:streaming] ? Temple::Filters::StaticMerger : Temple::Filters::DynamicInliner).new
-    end
+    filter :StaticMerger
+    filter :StaticFreezer
     use :Generator do
-      options[:generator].new(options.to_hash.reject {|k,v| !options[:generator].default_options.valid_keys.include?(k) })
+      options[:generator].new(options.to_hash.reject {|k,v| !options[:generator].options.valid_key?(k) })
     end
   end
 end

data/lib/slim/erb_converter.rb

@@ -8,7 +8,8 @@ module Slim
   #
   # @api public
   class ERBConverter < Engine
-    replace :Optimizer, Temple::Filters::CodeMerger
+    remove :StaticMerger
+    replace :StaticFreezer, Temple::Filters::CodeMerger
     replace :Generator, Temple::Generators::ERB
   end
 end

data/lib/slim/include.rb

@@ -7,7 +7,7 @@ module Slim
   #
   # @api private
   class Include < Slim::Filter
-    define_options :file, :include_dirs => [Dir.pwd, '.']
+    define_options :file, include_dirs: [Dir.pwd, '.']
 
     def on_html_tag(tag, attributes, content)
       return super if tag != 'include'
@@ -35,7 +35,7 @@ module Slim
   end
 
   class Engine
-    after Slim::Parser, Slim::Include, :file, :include_dirs
+    after Slim::Parser, Slim::Include
     after Slim::Include, :stop do |exp|
       throw :stop, exp if Thread.current[:slim_include_level] > 1
       exp

data/lib/slim/logic_less.rb

@@ -2,5 +2,4 @@ require 'slim'
 require 'slim/logic_less/filter'
 require 'slim/logic_less/context'
 
-# Insert plugin filter into Slim engine chain
-Slim::Engine.after(Slim::Interpolation, Slim::LogicLess, :logic_less, :dictionary, :dictionary_access)
+Slim::Engine.after Slim::Interpolation, Slim::LogicLess

data/lib/slim/logic_less/filter.rb

@@ -6,9 +6,9 @@ module Slim
     # Default dictionary access order, change it with the option :dictionary_access
     DEFAULT_ACCESS_ORDER = [:symbol, :string, :method, :instance_variable].freeze
 
-    define_options :logic_less => true,
-                   :dictionary => 'self',
-                   :dictionary_access => DEFAULT_ACCESS_ORDER
+    define_options logic_less: true,
+                   dictionary: 'self',
+                   dictionary_access: DEFAULT_ACCESS_ORDER
 
     def initialize(opts = {})
       super

data/lib/slim/parser.rb

@@ -5,18 +5,21 @@ module Slim
   class Parser < Temple::Parser
     define_options :file,
                    :default_tag,
-                   :code_attr_delims,
-                   :attr_list_delims,
-                   :tabsize => 4,
-                   :shortcut => {
-                     '#' => { :attr => 'id' },
-                     '.' => { :attr => 'class' }
+                   tabsize: 4,
+                   code_attr_delims: {
+                     '(' => ')',
+                     '[' => ']',
+                     '{' => '}',
                    },
-                   :attr_delims => {
+                   attr_list_delims: {
                      '(' => ')',
                      '[' => ']',
                      '{' => '}',
-                    }
+                   },
+                   shortcut: {
+                     '#' => { attr: 'id' },
+                     '.' => { attr: 'class' }
+                   }
 
     class SyntaxError < StandardError
       attr_reader :error, :file, :line, :lineno, :column
@@ -42,8 +45,8 @@ module Slim
 
     def initialize(opts = {})
       super
-      @attr_list_delims = options[:attr_list_delims] || options[:attr_delims]
-      @code_attr_delims = options[:code_attr_delims] || options[:attr_delims]
+      @attr_list_delims = options[:attr_list_delims]
+      @code_attr_delims = options[:code_attr_delims]
       tabsize = options[:tabsize]
       if tabsize > 1
         @tab_re = /\G((?: {#{tabsize}})*) {0,#{tabsize-1}}\t/
@@ -58,13 +61,13 @@ module Slim
         @tag_shortcut[k] = v[:tag] || options[:default_tag]
         if v.include?(:attr)
           @attr_shortcut[k] = [v[:attr]].flatten
-          raise ArgumentError, 'You can only use special characters for attribute shortcuts' if k =~ /(#{WORD_RE}|-)/
+          raise ArgumentError, 'You can only use special characters for attribute shortcuts' if k =~ /(\p{Word}|-)/
         end
       end
       keys = Regexp.union @attr_shortcut.keys.sort_by {|k| -k.size }
-      @attr_shortcut_re = /\A(#{keys}+)((?:#{WORD_RE}|-)*)/
+      @attr_shortcut_re = /\A(#{keys}+)((?:\p{Word}|-)*)/
       keys = Regexp.union @tag_shortcut.keys.sort_by {|k| -k.size }
-      @tag_re = /\A(?:#{keys}|\*(?=[^\s]+)|(#{WORD_RE}(?:#{WORD_RE}|:|-)*#{WORD_RE}|#{WORD_RE}+))/
+      @tag_re = /\A(?:#{keys}|\*(?=[^\s]+)|(\p{Word}(?:\p{Word}|:|-)*\p{Word}|\p{Word}+))/
       keys = Regexp.escape @code_attr_delims.keys.join
       @code_attr_delims_re = /\A[#{keys}]/
       keys = Regexp.escape @attr_list_delims.keys.join
@@ -89,9 +92,7 @@ module Slim
 
     protected
 
-    WORD_RE = ''.respond_to?(:encoding) ? '\p{Word}' : '\w'
-    LC_WORD_RE = '[_a-z0-9]'
-    ATTR_NAME = "\\A\\s*(#{WORD_RE}(?:#{WORD_RE}|:|-)*)"
+    ATTR_NAME = '\\A\\s*(\p{Word}(?:\p{Word}|:|-)*)'
     QUOTED_ATTR_RE = /#{ATTR_NAME}\s*=(=?)\s*("|')/
     CODE_ATTR_RE = /#{ATTR_NAME}\s*=(=?)\s*/
 
@@ -221,7 +222,11 @@ module Slim
         # Found an output block.
         # We expect the line to be broken or the next line to be indented.
         @line = $'
-        trailing_ws = $2.include?('\'') || $2.include?('>')
+        trailing_ws = $2.include?('>')
+        if $2.include?('\'')
+          deprecated_syntax '=\' for trailing whitespace is deprecated in favor of =>'
+          trailing_ws = true
+        end
         block = [:multi]
         @stacks.last << [:static, ' '] if $2.include?('<')
         @stacks.last << [:slim, :output, $1.empty?, parse_broken_line, block]
@@ -324,7 +329,12 @@ module Slim
 
       @line =~ /\A[<>']*/
       @line = $'
-      trailing_ws = $&.include?('\'') || $&.include?('>')
+      trailing_ws = $&.include?('>')
+      if $&.include?('\'')
+        deprecated_syntax 'tag\' for trailing whitespace is deprecated in favor of tag>'
+        trailing_ws = true
+      end
+
       leading_ws = $&.include?('<')
 
       parse_attributes(attributes)
@@ -354,7 +364,11 @@ module Slim
       when /\A\s*=(=?)(['<>]*)/
         # Handle output code
         @line = $'
-        trailing_ws2 = $2.include?('\'') || $2.include?('>')
+        trailing_ws2 = $2.include?('>')
+        if $2.include?('\'')
+          deprecated_syntax '=\' for trailing whitespace is deprecated in favor of =>'
+          trailing_ws2 = true
+        end
         block = [:multi]
         @stacks.last.insert(-2, [:static, ' ']) if !leading_ws && $2.include?('<')
         tag << [:slim, :output, $1 != '=', parse_broken_line, block]
@@ -495,6 +509,16 @@ module Slim
       raise
     end
 
+    def deprecated_syntax(message)
+      line = @orig_line.lstrip
+      column = (@orig_line && @line ? @orig_line.size - @line.size : 0) + line.size - @orig_line.size
+      warn %{Deprecated syntax: #{message}
+  #{options[:file]}, Line #{@lineno}, Column #{@column}
+    #{line}
+    #{' ' * column}^
+}
+    end
+
     def expect_next_line
       next_line || syntax_error!('Unexpected end of file')
       @line.strip!