slim 0.9.2 → 0.9.3

data/.gitignore

@@ -0,0 +1,18 @@
+*.swp
+*.gem
+
+readme.html
+Gemfile.lock
+
+.bundle
+.redcar
+.rvmrc
+.yardoc
+
+doc
+coverage
+pkg
+
+test/integration/rails/dummy/log/
+test/integration/rails/dummy/tmp/
+test/integration/rails/dummy/db/*.sqlite3

data/.yardopts

@@ -0,0 +1,2 @@
+--title Slim
+--files CHANGES,LICENSE

data/CHANGES

@@ -0,0 +1,147 @@
+master
+
+0.9.3
+
+  * Allow for bypassing escaping in attributes
+  * check if string encoding is valid
+  * support for html conditional comments
+  * Use new Temple html attribute expression [:html, :attrs, [:html, :attr, ...], ...]
+  * Use new slim html attribute expression (similiar to Temple)
+  * Option :id_delimiter replaced with :attr_delimiter
+  * Attribute value merging improved (nil/empty values are ignored now)
+  * Arrays attribute values are joined
+  * Boolean attributes (e.g. selected=true is converted to selected="selected")
+  * Option :debug removed
+  * Slim expression grammar provided, Temple validator used in tests
+  * Option :auto_escape replaced with inverse option :disable_escape
+  * Require temple 0.3.0
+
+0.9.2
+
+  * add SassEngine which respects :pretty
+  * embedded engine code refactored
+  * temple supports denser template registration
+  * deprecate slim/rails (just require 'slim')
+  * use temple rails and tilt templates
+  * add encoding option to Slim::Parser/Slim::Engine to enforce template encoding
+  * vim support is now an external project
+
+0.9.1
+
+  * add new doctype syntax without !
+  * slim directive expression has type and args
+
+0.9.0
+
+  * slim should not be registered as the default template handler.
+  * add support for unescaped text interpolation
+
+0.8.4
+
+  * Added the option to turn off automatic HTML escaping.
+  * update to tilt 1.2.2
+  * allow call to yield in logic less mode
+  * allow doctype declaration to be capitalized
+
+0.8.3
+
+  * Added support for html comments. The parser uses the :static filter instead of the :comment filter due to the way the parser is constructed.
+
+0.8.2
+
+  * fix issue #96
+  * Added the Temple Debugger filter.
+  * Rails problems fixed
+
+0.8.1
+
+  * remove backtick slim syntax -- no longer supported
+  * slim executable conflict. issue #91
+  * vim syntax support improved
+
+0.8.0
+
+  * rails logic less support
+
+0.7.4
+
+  * use ' for text block with trailing whitespace
+  * allow to disable/enable embedded engines
+
+0.7.3
+
+  * fix #82
+  * basic rails test added
+
+0.7.2
+
+  * get rid of rails deprecation warning
+  * use_html_safe is activated automatically by temple
+
+0.7.1
+
+  * logic less mode
+  * add syntax for explicitly closed tags
+
+0.7.0
+
+  * slim-mode.el for emacs added (modified haml-mode.el, needs some work to be fully functional for slim)
+  * embedded engines
+  * escape interpolated strings/attributes
+  * Slim#Filter now uses optional configuration hash
+  * Initial implementation for Rail's `html_safe`. Closes #25
+  * fallback to escape_html stolen from cgi.rb if escape_utils is unavailable, use normal requires because slim is on the load path
+  * Limit the allowed characters used for attributes delimiters (now only allows parentheses, square brackets and curly braces). See #16 for more info.
+  * Default to HTML5-mode
+  * Slim now uses Temple and Tilt.
+  * Choose your own attribute delimiter!
+
+0.6.1
+
+  * can wrap parens around attributes if you so desire
+  * added erubis to the benchmarks
+
+0.6.0
+
+  * Added slim itself, haml and mustache to the development env for easier benchmarking.
+  * added escape_html functionality.  need to tweak for speed
+
+0.5.1
+
+  * Consecutive condition statements now working as expected.
+
+0.5.0
+
+  * Added 'unless' to the list of control words.
+  * Fixes for inline conditions. There must be a better way of doing this??
+  * '-' is a valid character in HTML attributes, so let's allow that.
+  * Improved the regex so that control code now supports code blocks.
+  * Output code (start with '=') can now accept code blocks.
+  * Method calls no longer need parenthesis. We need more tests to ensure the implementation's robustness.
+
+0.4.1
+
+  * Added '|' as an alias of '`' for parsing plain text. This simulates the syntax of the Jade template engine.
+  * Added instructions of how to use the gem.
+
+0.4.0
+
+  * support for nesting lines under backtick
+  * make it so that one space is the left margin. any additional spaces will be copied over
+  * support for using indentation after backtick to denote paragraphs. useful for script tags and paragraphs
+
+0.3.1
+
+  * fix bug with adding end to nesting ruby code
+
+0.3.0
+
+  * Optimize compiled string to reduce number of concatentations to the buffer
+
+0.2.0
+
+  * can now make code call on same line as tag
+
+0.1.0
+
+  * Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+
+gemspec
+
+if path = ENV['SLIM_USE_TEMPLE']
+  if path == 'edge'
+    gem 'temple', :git => 'git://github.com/judofyr/temple.git'
+  else
+    gem 'temple', :path => path
+  end
+end
+
+group :integration do
+  gem 'rails', '~> 3.0.3'
+  gem 'sqlite3-ruby'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Slim Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -29,7 +29,7 @@ Install Slim as a gem:
 
 Include Slim in your Gemfile:
 
-    gem 'slim', :require => 'slim/rails'
+    gem 'slim'
 
 That's it! Now, just use the .slim extension and you're good to go.
 
@@ -215,10 +215,11 @@ Here's a quick example to demonstrate what a Slim template looks like:
 
 ### Evaluate ruby code in text
 
-  Use standard Ruby interpolation. The text will always be html escaped.
+  Use standard Ruby interpolation. The text will be html escaped by default.
 
     body
       h1 Welcome #{current_user.name} to the show.
+      | Unescaped #{{content}} is also possible.
 
   To escape the interpolation (i.e. render as is)
 
@@ -233,9 +234,9 @@ Here's a quick example to demonstrate what a Slim template looks like:
       h1 id="headline"
         == page_headline
 
-  Alternatively, if you prefer to use single equal sign, you may do so by setting the `auto_escape` option to false.
+  Alternatively, if you prefer to use single equal sign, you may do so by setting the `disable_escape` option to true.
 
-    Slim::Engine.default_options[:auto_escape] = false
+    Slim::Engine.default_options[:disable_escape] = true
 
 ### Treat multiple lines of code as text that should bypass parsing
 
@@ -276,41 +277,34 @@ Here's a quick example to demonstrate what a Slim template looks like:
 
     <body><p><!--This will get displayed as html comments.--></p></body>
 
-### Validate Slim syntax
-
-There are two helpers you could use to validate your Slim syntax:
-
-    Slim::Validator.valid?(source) # -> true or false
-    Slim::Validator.validate!(source) # -> true or exception
-
 ## Benchmarks
 
-    # OS X 10.6 + Ruby 1.9.2, 1000 iterations
+    # Linux + Ruby 1.9.2, 1000 iterations
 
                           user     system      total        real
-    (1) erb           0.310000   0.000000   0.310000 (  0.311769)
-    (1) erubis        0.250000   0.000000   0.250000 (  0.252026)
-    (1) fast erubis   0.250000   0.000000   0.250000 (  0.257639)
-    (1) slim          3.250000   0.040000   3.290000 (  3.282734)
-    (1) haml          2.230000   0.000000   2.230000 (  2.237396)
-    (1) haml ugly     2.160000   0.000000   2.160000 (  2.154061)
-    (2) erb           0.100000   0.000000   0.100000 (  0.107232)
-    (2) erubis        0.090000   0.000000   0.090000 (  0.087301)
-    (2) fast erubis   0.080000   0.000000   0.080000 (  0.073382)
-    (2) slim          0.020000   0.000000   0.020000 (  0.017364)
-    (2) haml          0.240000   0.010000   0.250000 (  0.234680)
-    (2) haml ugly     0.200000   0.000000   0.200000 (  0.209600)
-    (3) erb           0.010000   0.000000   0.010000 (  0.010558)
-    (3) erubis        0.010000   0.000000   0.010000 (  0.008676)
-    (3) fast erubis   0.010000   0.000000   0.010000 (  0.009134)
-    (3) slim          0.010000   0.000000   0.010000 (  0.012114)
-    (3) haml          0.090000   0.000000   0.090000 (  0.086450)
-    (3) haml ugly     0.070000   0.000000   0.070000 (  0.078825)
-    (4) erb           0.020000   0.000000   0.020000 (  0.015715)
-    (4) erubis        0.010000   0.000000   0.010000 (  0.014027)
-    (4) slim          0.020000   0.000000   0.020000 (  0.017591)
-    (4) haml          0.100000   0.000000   0.100000 (  0.098249)
-    (4) haml ugly     0.090000   0.000000   0.090000 (  0.089413)
+    (1) erb           0.680000   0.000000   0.680000 (  0.810375)
+    (1) erubis        0.510000   0.000000   0.510000 (  0.547548)
+    (1) fast erubis   0.530000   0.000000   0.530000 (  0.583134)
+    (1) slim          4.330000   0.020000   4.350000 (  4.495633)
+    (1) haml          4.680000   0.020000   4.700000 (  4.747019)
+    (1) haml ugly     4.530000   0.020000   4.550000 (  4.592425)
+    (2) erb           0.240000   0.000000   0.240000 (  0.235896)
+    (2) erubis        0.180000   0.000000   0.180000 (  0.185349)
+    (2) fast erubis   0.150000   0.000000   0.150000 (  0.154970)
+    (2) slim          0.050000   0.000000   0.050000 (  0.046685)
+    (2) haml          0.490000   0.000000   0.490000 (  0.497864)
+    (2) haml ugly     0.420000   0.000000   0.420000 (  0.428596)
+    (3) erb           0.030000   0.000000   0.030000 (  0.033979)
+    (3) erubis        0.030000   0.000000   0.030000 (  0.030705)
+    (3) fast erubis   0.040000   0.000000   0.040000 (  0.035229)
+    (3) slim          0.040000   0.000000   0.040000 (  0.036249)
+    (3) haml          0.160000   0.000000   0.160000 (  0.165024)
+    (3) haml ugly     0.150000   0.000000   0.150000 (  0.146130)
+    (4) erb           0.060000   0.000000   0.060000 (  0.059847)
+    (4) erubis        0.040000   0.000000   0.040000 (  0.040770)
+    (4) slim          0.040000   0.000000   0.040000 (  0.047389)
+    (4) haml          0.190000   0.000000   0.190000 (  0.188837)
+    (4) haml ugly     0.170000   0.000000   0.170000 (  0.175378)
 
     1. Uncached benchmark. Template is parsed every time.
        Activate this benchmark with slow=1.
@@ -341,7 +335,8 @@ This project is released under the MIT license.
 
 ## Discuss
 
-[Google Group](http://groups.google.com/group/slim-template)
+* [Google Group](http://groups.google.com/group/slim-template)
+* IRC Channel #slim-lang on freenode.net
 
 ## Slim related projects
 

data/benchmarks/run.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.join(File.dirname(__FILE__), 'src'))
+
+require 'slim'
+require 'complex_view'
+
+require 'benchmark'
+require 'ostruct'
+require 'erubis'
+require 'erb'
+require 'haml'
+require 'tilt'
+
+class SlimBenchmarks
+  def initialize(slow, iterations)
+    @iterations = (iterations || 1000).to_i
+    @benches    = []
+
+    tpl_erb  = File.read(File.dirname(__FILE__) + '/src/complex.erb')
+    tpl_haml = File.read(File.dirname(__FILE__) + '/src/complex.haml')
+    tpl_slim = File.read(File.dirname(__FILE__) + '/src/complex.slim')
+
+    view  = ComplexView.new
+    eview = OpenStruct.new(:header => view.header, :item => view.item).instance_eval{ binding }
+
+    erb         = ERB.new(tpl_erb)
+    erubis      = Erubis::Eruby.new(tpl_erb)
+    fast_erubis = Erubis::FastEruby.new(tpl_erb)
+    haml        = Haml::Engine.new(tpl_haml, :format => :html5)
+    haml_ugly   = Haml::Engine.new(tpl_haml, :format => :html5, :ugly => true)
+    slim        = Slim::Template.new { tpl_slim }
+
+    tilt_erb       = Tilt::ERBTemplate.new { tpl_erb }
+    tilt_erubis    = Tilt::ErubisTemplate.new { tpl_erb }
+    tilt_haml      = Tilt::HamlTemplate.new(:format => :html5){ tpl_haml }
+    tilt_haml_ugly = Tilt::HamlTemplate.new(:format => :html5, :ugly => true){ tpl_haml }
+    tilt_slim      = Slim::Template.new { tpl_slim }
+
+    haml.def_method(view, :run_haml)
+    haml_ugly.def_method(view, :run_haml_ugly)
+    view.instance_eval %{
+      def run_erb; #{erb.src}; end
+      def run_erubis; #{erubis.src}; end
+      def run_fast_erubis; #{fast_erubis.src}; end
+      def run_slim; #{slim.precompiled_template}; end
+    }
+
+    if slow
+      bench('(1) erb')         { ERB.new(tpl_erb).result(eview) }
+      bench('(1) erubis')      { Erubis::Eruby.new(tpl_erb).result(eview) }
+      bench('(1) fast erubis') { Erubis::Eruby.new(tpl_erb).result(eview) }
+      bench('(1) slim')        { Slim::Template.new { tpl_slim }.render(view) }
+      bench('(1) haml')        { Haml::Engine.new(tpl_haml, :format => :html5).render(view) }
+      bench('(1) haml ugly')   { Haml::Engine.new(tpl_haml, :format => :html5, :ugly => true).render(view) }
+    end
+
+    bench('(2) erb')         { erb.result(eview) }
+    bench('(2) erubis')      { erubis.result(eview) }
+    bench('(2) fast erubis') { fast_erubis.result(eview) }
+    bench('(2) slim')        { slim.render(view) }
+    bench('(2) haml')        { haml.render(view) }
+    bench('(2) haml ugly')   { haml_ugly.render(view) }
+
+    bench('(3) erb')         { view.run_erb }
+    bench('(3) erubis')      { view.run_erubis }
+    bench('(3) fast erubis') { view.run_fast_erubis }
+    bench('(3) slim')        { view.run_slim }
+    bench('(3) haml')        { view.run_haml }
+    bench('(3) haml ugly')   { view.run_haml_ugly }
+
+    bench('(4) erb')       { tilt_erb.render(view) }
+    bench('(4) erubis')    { tilt_erubis.render(view) }
+    bench('(4) slim')      { tilt_slim.render(view) }
+    bench('(4) haml')      { tilt_haml.render(view) }
+    bench('(4) haml ugly') { tilt_haml_ugly.render(view) }
+  end
+
+  def run
+    puts "#{@iterations} Iterations"
+    Benchmark.bmbm do |x|
+      @benches.each do |name, block|
+        x.report name.to_s do
+          @iterations.to_i.times { block.call }
+        end
+      end
+    end
+    puts "
+1. Uncached benchmark. Template is parsed every time.
+   Activate this benchmark with slow=1.
+
+2. 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.
+
+3. Compiled benchmark. Template is parsed before the benchmark and
+   generated ruby code is compiled into a method.
+   This is the fastest evaluation strategy because it benchmarks
+   pure execution speed of the generated ruby code.
+
+4. Compiled Tilt benchmark. Template is compiled with Tilt, which gives a more
+   accurate result of the performance in production mode in frameworks like
+   Sinatra, Ramaze and Camping. (Rails still uses its own template
+   compilation.)
+
+"
+  end
+
+  def bench(name, &block)
+    @benches.push([name, block])
+  end
+end
+
+SlimBenchmarks.new(ARGV[0], ARGV[1]).run

data/benchmarks/src/complex.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE HTML>
+
+<html>
+  <head>
+    <title>Simple Benchmark</title>
+  </head>
+  <body>
+    <h1><%= header %></h1>
+    <% unless item.empty? %>
+      <ul>
+      <% for i in item %>
+        <% if i[:current] %>
+          <li><strong><%= i[:name] %></strong></li>
+        <% else %>
+          <li><a href="<%= i[:url] %>"><%= i[:name] %></a></li>
+        <% end %>
+      <% end %>
+      </ul>
+    <% else %>
+      <p>The list is empty.</p>
+    <% end %>
+  </body>
+</html>