RubyGems - slim - Versions diffs - 0.6.1 → 0.7.0.beta.2 - Mend

slim 0.6.1 → 0.7.0.beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

data/.gitignore +8 -0
data/Gemfile +1 -6
data/Gemfile.lock +20 -16
data/README.md +137 -90
data/Rakefile +9 -37
data/benchmarks/run.rb +63 -0
data/benchmarks/src/complex.erb +23 -0
data/benchmarks/src/complex.haml +18 -0
data/benchmarks/src/complex.slim +18 -0
data/benchmarks/src/complex_view.rb +17 -0
data/lib/slim.rb +15 -11
data/lib/slim/compiler.rb +71 -137
data/lib/slim/embedded_engine.rb +108 -0
data/lib/slim/end_inserter.rb +57 -0
data/lib/slim/engine.rb +16 -14
data/lib/slim/filter.rb +44 -0
data/lib/slim/helpers.rb +37 -0
data/lib/slim/parser.rb +355 -0
data/lib/slim/rails.rb +2 -2
data/lib/slim/template.rb +18 -0
data/lib/slim/version.rb +3 -0
data/slim.gemspec +26 -66
data/test/helper.rb +32 -4
data/test/slim/test_code_blocks.rb +33 -0
data/test/slim/test_code_escaping.rb +69 -0
data/test/slim/test_code_evaluation.rb +199 -0
data/test/slim/test_code_helpers.rb +12 -0
data/test/slim/test_code_output.rb +116 -0
data/test/slim/test_code_structure.rb +84 -0
data/test/slim/test_embedded_engines.rb +55 -0
data/test/slim/test_html_escaping.rb +32 -0
data/test/slim/test_html_structure.rb +181 -0
data/test/slim/test_parser_errors.rb +98 -0
data/test/slim/test_slim_template.rb +128 -0
data/vim/slim.vim +33 -0
data/vim/test.slim +27 -0
metadata +127 -34
data/lib/slim/optimizer.rb +0 -70
data/readme.html +0 -159
data/test/slim/test_compiler.rb +0 -389
data/test/slim/test_engine.rb +0 -458
data/test/test_slim.rb +0 -4

data/.gitignore ADDED Viewed

@@ -0,0 +1,8 @@
+*.swp
+pkg/*
+*.gem
+.bundle
+readme.html
+.yardoc/
+doc/
+coverage/

data/Gemfile CHANGED Viewed

@@ -1,8 +1,3 @@
 source :rubygems
-gemspec
-group :development do
-  gem 'slim', :path => File.dirname(__FILE__)
-  gem 'minitest' if RUBY_VERSION < '1.9'
-end
+gemspec

data/Gemfile.lock CHANGED Viewed

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    slim (0.6.0)
-      escape_utils
+    slim (0.7.0.beta.1)
+      escape_utils (>= 0.1.9)
+      temple (~> 0.1.2)
+      tilt (~> 1.1)
 GEM
   remote: http://rubygems.org/
@@ -10,26 +12,28 @@ GEM
     abstract (1.0.0)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    escape_utils (0.1.8)
-    gemcutter (0.6.1)
-    git (1.2.5)
-    haml (3.0.21)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
-      git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json_pure (1.4.6)
+    escape_utils (0.1.9)
+    haml (3.0.22)
+    liquid (2.2.2)
+    minitest (1.7.2)
     rake (0.8.7)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
+    rcov (0.9.9)
+    rdiscount (1.6.5)
+    temple (0.1.2)
+    tilt (1.1)
 PLATFORMS
   ruby
 DEPENDENCIES
   erubis
-  escape_utils
+  escape_utils (>= 0.1.9)
   haml
-  jeweler
-  rake
+  liquid
+  minitest
+  rake (>= 0.8.7)
+  rcov
+  rdiscount
   slim!
+  temple (~> 0.1.2)
+  tilt (~> 1.1)

data/README.md CHANGED Viewed

@@ -12,7 +12,7 @@ Slim is a fast, lightweight templating engine for __Rails 3__. It has been teste
 Within the Rails community, _Erb_ and _Haml_ are without doubt the two most popular templating engines. However, _Erb_'s syntax is cumbersome and Haml's performance isn't exactly the best. Slim was born to bring the minimalist syntax approach of _Haml_ and the higher performance of Erb into once solution.
-___Yes, Slim is speedy!___ Benchmarks are provided at the end of this README file. Alternatively, a benchmark script is provided so you could test it yourself (`./benchmarks/run.rb`).
+___Yes, Slim is speedy!___ Benchmarks are provided at the end of this README file. Alternatively, a benchmark rake task is provided so you could test it yourself (`rake bench`).
 ## How?
@@ -77,38 +77,67 @@ Here's a quick example to demonstrate what a Slim template looks like:
 __Please note that all line indicators must be followed by a space__
-* |
-  * The pipe tells Slim to just copy the line. It essentially escapes any processing.
-* `
-  * _Same as the pipe ('|')._
-* -
-  * The dash denotes control code (similar to Haml).  Examples of control code are loops and conditionals.
-* =
-  * The equal sign tells Slim it's a Ruby call that produces output to add to the buffer (similar to Erb and Haml).
-* ==
-  * Same as the single equal sign, but does not go through the escape_html method.
-* !
-  * This is a directive.  Most common example: `! doctype html # renders <!doctype html>`
-* /
-  * Use the forward slash for ruby code comments - anything after it won't get displayed in the final render.
+#### `|`
+> The pipe tells Slim to just copy the line. It essentially escapes any processing.
+#### `` ` `` or `'`
+> _Same as the pipe (`|`)._
+#### `-`
+> The dash denotes control code (similar to Haml).  Examples of control code are loops and conditionals.
+#### `=`
+> The equal sign tells Slim it's a Ruby call that produces output to add to the buffer (similar to Erb and Haml).
+#### `==`
+> Same as the single equal sign, but does not go through the escape_html method.
+#### `!`
+> This is a directive.  Most common example: `! doctype html # renders <!doctype html>`
+#### `/`
+> Use the forward slash for ruby code comments - anything after it won't get displayed in the final render.
 ### Things to know
-* Standard Ruby syntax after '-' and '='
-  * __end__ is not required
-* Can put content on same line or nest it.
-  * If you nest content (e.g. put it on the next line), start the line with a pipe ('|') or a backtick ('`').
-* Indentation matters, but it's not as strict as Haml.
-  * If you want to first indent 2 spaces, then 5 spaces, it's your choice. To nest markup you only need to indent by one space, the rest is gravy.
+#### Standard Ruby syntax after `-` and `=`
+  `end` is not required but can be used if you don't want to omit it
+#### Can put content on same line or nest it.
+  If you nest content (e.g. put it on the next line), start the line with a pipe (`|`) or a backtick (`` ` ``).
+#### Indentation matters, but it's not as strict as Haml.
+  If you want to first indent 2 spaces, then 5 spaces, it's your choice. To nest markup you only need to indent by one space, the rest is gravy.
+#### If your ruby code needs to use multiple lines, append a `\` at the end of the lines, for example:
+    `javascript_include_tag \
+      "jquery", \
+      "application"`
+### Wrap attributes with delimiters
+  If a delimiter makes the syntax more readable for you,
+  you can use the characters {...}, (...), [...] to wrap the attributes.
+    body
+      h1(id="logo") = page_logo
+      h2[id="tagline" class="small tagline"] = page_tagline
 ### Add content to a tag
-    # Either start on the same line as the tag
+  Either start on the same line as the tag
     body
       h1 id="headline" Welcome to my site.
-    # Or nest it.  __Note:__ Must use a pipe or a backtick (followed by a space) to escape processing
+  Or nest it.  __Note:__ Must use a pipe or a backtick (followed by a space) to escape processing
     body
       h1 id="headline"
@@ -116,12 +145,12 @@ __Please note that all line indicators must be followed by a space__
 ### Add content to a tag with code
-    # Can make the call on the same line
+  Can make the call on the same line
     body
       h1 id="headline" = page_headline
-    # Or nest it.
+  Or nest it.
     body
       h1 id="headline"
@@ -129,9 +158,9 @@ __Please note that all line indicators must be followed by a space__
 ### Shortcut form for `id` and `class` attributes
-    # Similarly to Haml, you can specify the `id` and `class`
-    # attributes in the following shortcut form
-    # Note: the shortcut form does not evaluate ruby code
+  Similarly to Haml, you can specify the `id` and `class`
+  attributes in the following shortcut form
+  Note: the shortcut form does not evaluate ruby code
     body
       h1#headline
@@ -141,7 +170,7 @@ __Please note that all line indicators must be followed by a space__
       .content
         = show_content
-    # this is the same as
+  this is the same as
     body
       h1 id="headline"
@@ -151,37 +180,36 @@ __Please note that all line indicators must be followed by a space__
       div class="content"
         = show_content
-### Wrap attributes with parens
-    # If parens make the syntax more readable for you
-    body
-      h1(id="tagline" class="small tagline") = page_tagline
 ### Set an attribute's value with a method
-    # Use standard Ruby interpolation.
+  * Alternative 1: Use parentheses (), {}, []. The code in the parentheses will be evaluated.
+  * Alternative 2: If the code doesn't contain any spaces you can omit the parentheses.
+  * Alternative 3: Use standard ruby interpolation #{}
+  Attributes will always be html escaped.
     body
       table
         - for user in users do
-          tr id="user_#{user.id}"
+          td id="user_#{user.id}" class=user.role
+            a href=user_action(user, :edit) Edit #{user.name}
+            a href={path_to_user user} = user.name
-### Call a method in content
+### Evaluate ruby code in text
-    # Use standard Ruby interpolation.
+  Use standard Ruby interpolation. The text will always be html escaped.
     body
       h1 Welcome #{current_user.name} to the show.
-    # To escape the interpolation (i.e. render as is)
+  To escape the interpolation (i.e. render as is)
     body
       h1 Welcome \#{current_user.name} to the show.
-### Skip the escaping
+### Skip the html escaping
-    # Use a double equal sign
+  Use a double equal sign
     body
       h1 id="headline"
@@ -189,79 +217,98 @@ __Please note that all line indicators must be followed by a space__
 ### Treat multiple lines of code as text that should bypass parsing
-    # Use a pipe ('|') or backtick ('`') to start the escape.
-    # Each following line that is indented greater than
-    # the backtick is copied over.
+  Use a pipe (`|`) or backtick (`` ` ``) to start the escape.
+  Each following line that is indented greater than
+  the backtick is copied over.
     body
       p
         |
           This is a test of the text block.
-    # The parsed result of the above:
+  The parsed result of the above:
     <body><p>This is a test of the text block.</p></body>
-    # The left margin is set at the indent of the backtick + one space.
-    # Any additional spaces will be copied over.
+  The left margin is set at the indent of the backtick + one space.
+  Any additional spaces will be copied over.
     body
       p
-        |
-          This line is on the left margin.
-           This line will have one space in front of it.
-             This line will have two spaces in front of it.
-               And so on...
+        |  This line is on the left margin.
+            This line will have one space in front of it.
+              This line will have two spaces in front of it.
+                And so on...
 ### Add code comments
-    # Use a forward slash for ruby code comments
+  Use a forward slash for ruby code comments
     body
       p
         / This line won't get displayed.
         / Neither does this line.
-    # The parsed result of the above:
+  The parsed result of the above:
     <body><p></p></body>
 ## Benchmarks
-    # Ubuntu 10.4 + Ruby 1.9.2
-    Rehearsal --------------------------------------------------------
-    erb                    0.580000   0.010000   0.590000 (  0.611149)
-    erubis                 0.480000   0.000000   0.480000 (  0.506241)
-    fast erubis            0.480000   0.010000   0.490000 (  0.499427)
-    slim                   0.640000   0.000000   0.640000 (  0.667160)
-    haml                   4.140000   0.000000   4.140000 (  4.221195)
-    haml ugly              3.960000   0.000000   3.960000 (  4.018103)
-    erb (cached)           0.200000   0.000000   0.200000 (  0.208529)
-    erubis (cached)        0.160000   0.000000   0.160000 (  0.167134)
-    fast erubis (cached)   0.140000   0.000000   0.140000 (  0.152149)
-    slim (cached)          0.150000   0.000000   0.150000 (  0.159058)
-    haml (cached)          0.450000   0.010000   0.460000 (  0.462814)
-    haml ugly (cached)     0.370000   0.000000   0.370000 (  0.387312)
-    ---------------------------------------------- total: 11.780000sec
-    user     system      total        real
-    erb                    0.560000   0.010000   0.570000 (  0.574373)
-    erubis                 0.480000   0.000000   0.480000 (  0.501512)
-    fast erubis            0.470000   0.000000   0.470000 (  0.481918)
-    slim                   0.610000   0.000000   0.610000 (  0.612794)
-    haml                   3.930000   0.010000   3.940000 (  3.939419)
-    haml ugly              3.790000   0.010000   3.800000 (  3.798528)
-    erb (cached)           0.190000   0.000000   0.190000 (  0.188593)
-    erubis (cached)        0.160000   0.000000   0.160000 (  0.159869)
-    fast erubis (cached)   0.140000   0.000000   0.140000 (  0.135476)
-    slim (cached)          0.150000   0.000000   0.150000 (  0.153698)
-    haml (cached)          0.430000   0.000000   0.430000 (  0.436980)
-    haml ugly (cached)     0.370000   0.000000   0.370000 (  0.372770)
+    # OS X 10.6 + Ruby 1.9.2
+                               user     system      total        real
+    erb                    0.410000   0.010000   0.420000 (  0.421608)
+    erubis                 0.350000   0.000000   0.350000 (  0.357187)
+    fast erubis            0.340000   0.000000   0.340000 (  0.351943)
+    slim                   2.360000   0.020000   2.380000 (  2.495331)
+    haml                   2.970000   0.010000   2.980000 (  3.023121)
+    haml ugly              2.870000   0.010000   2.880000 (  2.968662)
+    erb (cached)           0.150000   0.000000   0.150000 (  0.149980)
+    erubis (cached)        0.120000   0.000000   0.120000 (  0.122935)
+    fast erubis (cached)   0.100000   0.000000   0.100000 (  0.105832)
+    slim (cached)          0.020000   0.000000   0.020000 (  0.020290)
+    haml (cached)          0.330000   0.000000   0.330000 (  0.335519)
+    haml ugly (cached)     0.280000   0.000000   0.280000 (  0.286695)
+    # OS X 10.6 + REE 1.8.7
+                               user     system      total        real
+    erb                    0.440000   0.010000   0.450000 (  0.463941)
+    erubis                 0.310000   0.000000   0.310000 (  0.322083)
+    fast erubis            0.310000   0.000000   0.310000 (  0.309852)
+    slim                   2.420000   0.020000   2.440000 (  2.470208)
+    haml                   2.990000   0.020000   3.010000 (  3.040942)
+    haml ugly              2.900000   0.020000   2.920000 (  3.101786)
+    erb (cached)           0.080000   0.000000   0.080000 (  0.079252)
+    erubis (cached)        0.070000   0.000000   0.070000 (  0.066370)
+    fast erubis (cached)   0.060000   0.000000   0.060000 (  0.062001)
+    slim (cached)          0.030000   0.000000   0.030000 (  0.023835)
+    haml (cached)          0.270000   0.010000   0.280000 (  0.279409)
+    haml ugly (cached)     0.210000   0.000000   0.210000 (  0.221059)
+    # OSX 10.6 + JRuby 1.5.3
+                               user     system      total        real
+    erb                    0.970000   0.000000   0.970000 (  0.970000)
+    erubis                 0.672000   0.000000   0.672000 (  0.672000)
+    fast erubis            0.624000   0.000000   0.624000 (  0.624000)
+    slim                   2.694000   0.000000   2.694000 (  2.694000)
+    haml                   3.368000   0.000000   3.368000 (  3.368000)
+    haml ugly              3.462000   0.000000   3.462000 (  3.462000)
+    erb (cached)           0.736000   0.000000   0.736000 (  0.736000)
+    erubis (cached)        0.413000   0.000000   0.413000 (  0.413000)
+    fast erubis (cached)   0.340000   0.000000   0.340000 (  0.340000)
+    slim (cached)          0.069000   0.000000   0.069000 (  0.069000)
+    haml (cached)          1.001000   0.000000   1.001000 (  1.001000)
+    haml ugly (cached)     0.763000   0.000000   0.763000 (  0.763000)
 ## Authors
 * [Andrew Stone](http://github.com/stonean)
 * [Fred Wu](http://github.com/fredwu)
+## Discuss
+[Google Group](http://groups.google.com/group/slim-template)

data/Rakefile CHANGED Viewed

@@ -1,44 +1,16 @@
-require 'rubygems'
-require 'rake'
-require File.join(File.dirname(__FILE__), "lib", "slim")
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "slim"
-    gem.version = Slim.version
-    gem.rubyforge_project = gem.name
-    gem.summary = "Slim is a template language."
-    gem.description = "Slim is a template language whose goal is reduce the syntax to the essential parts without becoming cryptic."
-    gem.homepage = "http://github.com/stonean/slim"
-    gem.authors = ["Andrew Stone", "Fred Wu"]
-    gem.email = ["andy@stonean.com", "ifredwu@gmail.com"]
-    gem.files = ['*', 'lib/**/*', 'test/**/*']
-    gem.add_dependency 'escape_utils'
-    gem.add_development_dependency 'rake'
-    gem.add_development_dependency 'jeweler'
-    gem.add_development_dependency 'haml'
-    gem.add_development_dependency 'erubis'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue Exception => e
 end
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new do |t|
-    t.files   = FileList['lib/**/*.rb']
-    t.options = ['-r'] # optional
-  end
-rescue LoadError
-  task :yard do
-    abort "YARD is not available. In order to run yard, you must: gem install yard"
-  end
+require 'rake/testtask'
+desc 'Run Slim benchmarks! (Default :iterations is 1000)'
+task :bench, :iterations do |t, args|
+  ruby("benchmarks/run.rb #{args[:iterations]}")
 end
-require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/test_*.rb'
@@ -48,7 +20,7 @@ end
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
-    test.libs << 'test'
+    test.libs << 'lib' << 'test'
     test.pattern = 'test/**/test_*.rb'
     test.verbose = true
   end