slim 1.3.9 → 2.0.0

data/Rakefile

@@ -51,8 +51,14 @@ namespace 'test' do
     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) }
+
       # Run Slim integration test in Sinatra
-      t.test_files = FileList["#{spec.gem_dir}/test/slim_test.rb"]
+      t.test_files = FileList[file]
       t.verbose = true
     end
   rescue LoadError
@@ -62,19 +68,6 @@ namespace 'test' do
   end
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |t|
-    t.libs << 'lib' << 'test/slim'
-    t.test_files = FileList['test/slim/test_*.rb']
-    t.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort 'RCov is not available. In order to run rcov, you must: gem install rcov'
-  end
-end
-
 begin
   require 'yard'
   YARD::Rake::YardocTask.new do |t|

data/benchmarks/run-benchmarks.rb

@@ -22,7 +22,6 @@ class SlimBenchmarks
 
     init_compiled_benches
     init_tilt_benches
-    init_cached_benches
     init_parsing_benches if slow
   end
 
@@ -76,41 +75,18 @@ class SlimBenchmarks
     bench('(2) haml ugly')   { tilt_haml_ugly.render(context) }
   end
 
-  def init_cached_benches
-    context  = Context.new
-    context_binding = context.instance_eval { binding }
-
-    erb         = ERB.new(@erb_code)
-    erubis      = Erubis::Eruby.new(@erb_code)
-    fast_erubis = Erubis::FastEruby.new(@erb_code)
-    temple_erb  = Temple::ERB::Template.new { @erb_code }
-    haml_pretty = Haml::Engine.new(@haml_code, :format => :html5)
-    haml_ugly   = Haml::Engine.new(@haml_code, :format => :html5, :ugly => true)
-    slim_pretty = Slim::Template.new(:pretty => true) { @slim_code }
-    slim_ugly   = Slim::Template.new { @slim_code }
-
-    bench('(3) erb')         { erb.result(context_binding) }
-    bench('(3) erubis')      { erubis.result(context_binding) }
-    bench('(3) fast erubis') { fast_erubis.result(context_binding) }
-    bench('(3) temple erb')  { temple_erb.render(context) }
-    bench('(3) slim pretty') { slim_pretty.render(context) }
-    bench('(3) slim ugly')   { slim_ugly.render(context) }
-    bench('(3) haml pretty') { haml_pretty.render(context) }
-    bench('(3) haml ugly')   { haml_ugly.render(context) }
-  end
-
   def init_parsing_benches
     context  = Context.new
     context_binding = context.instance_eval { binding }
 
-    bench('(4) erb')         { ERB.new(@erb_code).result(context_binding) }
-    bench('(4) erubis')      { Erubis::Eruby.new(@erb_code).result(context_binding) }
-    bench('(4) fast erubis') { Erubis::FastEruby.new(@erb_code).result(context_binding) }
-    bench('(4) temple erb')  { Temple::ERB::Template.new { @erb_code }.render(context) }
-    bench('(4) slim pretty') { Slim::Template.new(:pretty => true) { @slim_code }.render(context) }
-    bench('(4) slim ugly')   { Slim::Template.new { @slim_code }.render(context) }
-    bench('(4) haml pretty') { Haml::Engine.new(@haml_code, :format => :html5).render(context) }
-    bench('(4) haml ugly')   { Haml::Engine.new(@haml_code, :format => :html5, :ugly => true).render(context) }
+    bench('(3) erb')         { ERB.new(@erb_code).result(context_binding) }
+    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 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) }
   end
 
   def run
@@ -133,11 +109,7 @@ class SlimBenchmarks
     Sinatra, Ramaze and Camping. (Rails still uses its own template
     compilation.)
 
-(3) Cached benchmark. Template is parsed before the benchmark.
-    The ruby code generated by the template engine might be evaluated every time.
-    This benchmark uses the standard API of the template engine.
-
-(4) Parsing benchmark. Template is parsed every time.
+(3) Parsing benchmark. Template is parsed every time.
     This is not the recommended way to use the template engine
     and Slim is not optimized for it. Activate this benchmark with 'rake bench slow=1'.
 

data/doc/logic_less.md

@@ -0,0 +1,140 @@
+# Logic less mode
+
+Logic less mode is inspired by [Mustache](https://github.com/defunkt/mustache). Logic less mode uses a dictionary object
+e.g. a recursive hash tree which contains the dynamic content.
+
+## Conditional
+
+If the object is not false or empty?, the content will show
+
+    - article
+      h1 = title
+
+## Inverted conditional
+
+If the object is false or empty?, the content will show
+
+    -! article
+      p Sorry, article not found
+
+## Iteration
+
+If the object is an array, the section will iterate
+
+    - articles
+      tr: td = title
+
+## Lambdas
+
+Like mustache, Slim supports lambdas.
+
+    = person
+      = name
+
+The lambda method could be defined like this
+
+    def lambda_method
+      "<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.
+
+## Dictionary access
+
+Example code:
+
+    - article
+      h1 = title
+
+The dictionary object is accessed in the order given by the `:dictionary_access`. Default order:
+
+1. `:symbol` - If `article.respond_to?(:has_key?)` and `article.has_key?(:title)`, Slim will execute `article[:title]`
+2. `:string` - If `article.respond_to?(:has_key?)` and `article.has_key?('title')`, Slim will execute `article['title']`
+3. `:method` - If `article.respond_to?(:title)`, Slim will execute `article.send(:title)`
+4. `:instance_variable` - If `article.instance_variable_defined?(@title)`, Slim will execute `article.instance_variable_get @title`
+
+If all the above fails, Slim will try to resolve the title reference in the same order against the parent object. In this example, the parent would be the dictionary object you are rendering the template against.
+
+As you might have guessed, the article reference goes through the same steps against the dictionary. Instance variables are not allowed in the view code, but Slim will find and use them. Essentially, you're just using dropping the @ prefix in your template. Parameterized method calls are not allowed.
+
+
+## Strings
+
+The `self` keyword will return the `.to_s` value for the element under consideration.
+
+Given
+
+    {
+      :article => [
+        'Article 1',
+        'Article 2'
+      ]
+    }
+
+And
+
+    - article
+      tr: td = self
+
+This will yield
+
+    <tr>
+      <td>Article 1</td>
+    </>
+    <tr>
+      <td>Article 2</td>
+    </tr>
+
+
+## Logic less in Rails
+
+Install:
+
+    $ gem install slim
+
+Require:
+
+    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
+
+and activate logic less mode per render call in your action
+
+    class Controller
+      def action
+        Slim::Engine.with_options(:logic_less => true) do
+          render
+        end
+      end
+    end
+
+## Logic less in Sinatra
+
+Sinata has built-in support for Slim. All you have to do is require the logic less Slim plugin. This can be done in your config.ru:
+
+    require 'slim/logic_less'
+
+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
+
+and activate logic less mode per render call in your application
+
+    get '/page'
+      slim :page, :logic_less => true
+    end
+
+## Options
+
+<table>
+<thead style="font-weight:bold"><tr><td>Type</td><td>Name</td><td>Default</td><td>Purpose</td></tr></thead>
+<tbody>
+<tr><td>Boolean</td><td>:logic_less</td><td>true</td><td>Enable logic less mode (Enabled if 'slim/logic_less' is required)</td></tr>
+<tr><td>String</td><td>:dictionary</td><td>"self"</td><td>Dictionary where variables are looked up</td></tr>
+<tr><td>Symbol/Array&lt;Symbol&gt;</td><td>:dictionary_access</td><td>[:symbol, :string, :method, :instance_variable]</td><td>Dictionary access order (:symbol, :string, :method, :instance_variable)</td></tr>
+</tbody>
+</table>

data/doc/translator.md

@@ -0,0 +1,31 @@
+# Translator/I18n
+
+The translator plugin provides automatic translation of the templates using Gettext, Fast-Gettext or Rails I18n. Static text
+in the template is replaced by the translated version.
+
+Example:
+
+    h1 Welcome to #{url}!
+
+Gettext translates the string from english to german where interpolations are replaced by %1, %2, ...
+
+    "Welcome to %1!" -> "Willkommen auf %1!"
+
+and renders as
+
+    <h1>Willkommen auf slim-lang.com!</h1>
+
+Enable the translator plugin with
+
+    require 'slim/translator'
+
+# Options
+
+<table>
+<thead style="font-weight:bold"><tr><td>Type</td><td>Name</td><td>Default</td><td>Purpose</td></tr></thead>
+<tbody>
+<tr><td>Boolean</td><td>:tr</td><td>true</td><td>Enable translator (Enabled if 'slim/translator' is required)</td></tr>
+<tr><td>Symbol</td><td>:tr_mode</td><td>:dynamic</td><td>When to translate: :static = at compile time, :dynamic = at runtime</td></tr>
+<tr><td>String</td><td>:tr_fn</td><td>Depending on installed translation library</td><td>Translation function, could be '_' for gettext</td></tr>
+</tbody>
+</table>

data/lib/slim.rb

@@ -1,11 +1,13 @@
 require 'temple'
 require 'slim/parser'
 require 'slim/filter'
+require 'slim/do_inserter'
 require 'slim/end_inserter'
 require 'slim/embedded'
 require 'slim/interpolation'
 require 'slim/controls'
-require 'slim/splat_attributes'
+require 'slim/splat/filter'
+require 'slim/splat/builder'
 require 'slim/code_attributes'
 require 'slim/engine'
 require 'slim/template'

data/lib/slim/code_attributes.rb

@@ -11,34 +11,34 @@ module Slim
       [:multi, *attrs.map {|a| compile(a) }]
     end
 
-    # Handle attribute expression `[:slim, :attr, escape, code]`
+    # Handle attribute expression `[:html, :attr, escape, code]`
     #
     # @param [String] name Attribute name
     # @param [Array] value Value expression
     # @return [Array] Compiled temple expression
     def on_html_attr(name, value)
-      unless value[0] == :slim && value[1] == :attrvalue && !options[:merge_attrs][name]
-        # We perform merging on the attribute
+      if value[0] == :slim && value[1] == :attrvalue && !options[:merge_attrs][name]
+        # We handle the attribute as a boolean attribute
+        escape, code = value[2], value[3]
+        case code
+        when 'true'
+          [:html, :attr, name, [:static, name]]
+        when 'false', 'nil'
+          [:multi]
+        else
+          tmp = unique_name
+          [:multi,
+           [:code, "#{tmp} = #{code}"],
+           [:case, tmp,
+            ['true', [:html, :attr, name, [:static, name]]],
+            ['false, nil', [:multi]],
+            [:else, [:html, :attr, name, [:escape, escape, [:dynamic, tmp]]]]]]
+        end
+      else
+        # Attribute with merging
         @attr = name
         return super
       end
-
-      # We handle the attribute as a boolean attribute
-      escape, code = value[2], value[3]
-      case code
-      when 'true'
-        [:html, :attr, name, [:static, name]]
-      when 'false', 'nil'
-        [:multi]
-      else
-        tmp = unique_name
-        [:multi,
-         [:code, "#{tmp} = #{code}"],
-         [:case, tmp,
-          ['true', [:html, :attr, name, [:static, name]]],
-          ['false, nil', [:multi]],
-          [:else, [:html, :attr, name, [:escape, escape, [:dynamic, tmp]]]]]]
-      end
     end
 
     # Handle attribute expression `[:slim, :attrvalue, escape, code]`

data/lib/slim/command.rb

@@ -42,6 +42,10 @@ module Slim
         @options[:compile] = true
       end
 
+      opts.on('-e', '--erb', 'Convert to ERB') do
+        @options[:erb] = true
+      end
+
       opts.on('-r', '--rails', 'Generate rails compatible code (Implies --compile)') do
         Engine.set_default_options :disable_capture => true, :generator => Temple::Generators::RailsOutputBuffer
         @options[:compile] = true
@@ -70,7 +74,7 @@ module Slim
       end
 
       opts.on_tail('-v', '--version', 'Print version') do
-        puts "Slim #{Slim::VERSION}"
+        puts "Slim #{VERSION}"
         exit
       end
     end
@@ -94,11 +98,17 @@ module Slim
         @options[:output] = file ? File.open(file, 'w') : $stdout
       end
 
-      if @options[:compile]
-        @options[:output].puts(Slim::Engine.new(:file => @options[:file]).call(@options[:input].read))
-      else
-        @options[:output].puts(Slim::Template.new(@options[:file]) { @options[:input].read }.render)
-      end
+      result =
+        if @options[:erb]
+          require 'slim/erb_converter'
+          ERBConverter.new(:file => @options[:file]).call(@options[:input].read)
+        elsif @options[:compile]
+          Engine.new(:file => @options[:file]).call(@options[:input].read)
+        else
+          Template.new(@options[:file]) { @options[:input].read }.render
+        end
+
+      @options[:output].puts(result)
     end
   end
 end

data/lib/slim/do_inserter.rb

@@ -0,0 +1,33 @@
+module Slim
+  # In Slim you don't need the do keyword sometimes. This
+  # filter adds the missing keyword.
+  #
+  #   - 10.times
+  #     | Hello
+  #
+  # @api private
+  class DoInserter < Filter
+    BLOCK_REGEX = /(\A(if|unless|else|elsif|when|begin|rescue|ensure)\b)|do\s*(\|[^\|]*\|\s*)?\Z/
+
+    # Handle control expression `[:slim, :control, code, content]`
+    #
+    # @param [String] code Ruby code
+    # @param [Array] content Temple expression
+    # @return [Array] Compiled temple expression
+    def on_slim_control(code, content)
+      code = code + ' do' unless code =~ BLOCK_REGEX || empty_exp?(content)
+      [:slim, :control, code, compile(content)]
+    end
+
+    # Handle output expression `[:slim, :output, escape, code, content]`
+    #
+    # @param [Boolean] escape Escape html
+    # @param [String] code Ruby code
+    # @param [Array] content Temple expression
+    # @return [Array] Compiled temple expression
+    def on_slim_output(escape, code, content)
+      code = code + ' do' unless code =~ BLOCK_REGEX || empty_exp?(content)
+      [:slim, :output, escape, code, compile(content)]
+    end
+  end
+end

data/lib/slim/embedded.rb

@@ -268,10 +268,4 @@ module Slim
     # Embedded ruby code
     register :ruby,       RubyEngine
   end
-
-  def self.const_missing(name)
-    super unless name == :EmbeddedEngine
-    warn 'Slim::EmbeddedEngine is deprecated, it is called Slim::Embedded in Slim 2.0'
-    Embedded
-  end
 end

data/lib/slim/end_inserter.rb

@@ -10,7 +10,7 @@ module Slim
   #
   # @api private
   class EndInserter < Filter
-    ELSE_REGEX = /\A(else|elsif|when|rescue|ensure)\b/
+    BLOCK_REGEX = /\A(else|elsif|when|rescue|ensure)\b/
     END_REGEX = /\Aend\b/
 
     # Handle multi expression `[:multi, *exps]`
@@ -28,7 +28,7 @@ module Slim
 
           # Two control code in a row. If this one is *not*
           # an else block, we should close the previous one.
-          append_end(result) if prev_indent && exp[2] !~ ELSE_REGEX
+          append_end(result) if prev_indent && exp[2] !~ BLOCK_REGEX
 
           # Indent if the control code contains something.
           prev_indent = !empty_exp?(exp[3])