slim 1.3.6 → 1.3.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46f376c5e0b3f395ccf918b89355717d62d28c0e
+  data.tar.gz: 5b1f71d32c229146001bdffa4f3b693b6333e512
+SHA512:
+  metadata.gz: 1a4816cbd0490de7df3248cb095c09f3306b509fe9295b7f8d5a702a2fe8ef37b3b727770c94b4dd5e4318c9b55e8300511fafba5a92202c2fb7f7be5961f521
+  data.tar.gz: 60f673c3b31c65d19c6098145889f100e597d51ccd05b500d0e656e14583b601f05bb3d115c1a23053a268c9f3013e01c8131b0d38d05d4fe5baf647c0f97371

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.8.7
   - 1.9.3
+  - 2.0.0
   - ruby-head
   - jruby-18mode
   - jruby-19mode
@@ -10,11 +11,13 @@ rvm:
 env:
   - "TASK=test:core_and_plugins"
   - "TASK=test:rails RAILS=master"
-  - "TASK=test:rails RAILS=3.0.18"
-  - "TASK=test:rails RAILS=3.1.9"
-  - "TASK=test:rails RAILS=3.2.10"
+  - "TASK=test:rails RAILS=3.0.20"
+  - "TASK=test:rails RAILS=3.1.12"
+  - "TASK=test:rails RAILS=3.2.13"
+  - "TASK=test:rails RAILS=4.0.0.beta1"
   - "TASK=test:sinatra SINATRA=master"
-  - "TASK=test:sinatra SINATRA=1.3.3"
+  - "TASK=test:sinatra SINATRA=1.3.6"
+  - "TASK=test:sinatra SINATRA=1.4.2"
   - "TASK=bench iterations=10000"
   - "TASK=bench slow=1 iterations=1000"
 matrix:
@@ -26,12 +29,21 @@ matrix:
       env: "TASK=test:rails RAILS=master"
     - rvm: rbx-18mode
       env: "TASK=test:rails RAILS=master"
+    - rvm: 1.8.7
+      env: "TASK=test:rails RAILS=4.0.0.beta1"
+    - rvm: jruby-18mode
+      env: "TASK=test:rails RAILS=4.0.0.beta1"
+    - rvm: rbx-18mode
+      env: "TASK=test:rails RAILS=4.0.0.beta1"
   allow_failures:
     - env: "TASK=test:rails RAILS=master"
+    - env: "TASK=test:rails RAILS=4.0.0.beta1"
     - env: "TASK=test:sinatra SINATRA=master"
+    - env: "TASK=test:rails RAILS=3.0.20"
+      rvm: 2.0.0
     - rvm: ruby-head
 # Rails master needs newest bundler
 before_install:
   - ./kill-travis.sh
-  - gem install bundler --pre
+  - gem update bundler
 script: "bundle exec rake $TASK"

data/CHANGES

@@ -1,3 +1,35 @@
+1.3.8
+
+  * Disable some superflous deprecation warnings
+
+1.3.7
+
+  * Fixed issue #374, rescue and ensure blocks
+  * Fixed issue #333 (Throw syntax error if you write text after closed tag)
+  * Deprecated :attr_delimiter (renamed to :merge_attrs)
+  * Deprecated :attr_wrapper (renamed to :attr_quote)
+  * Warn if you use curly braces or brackets for ruby attributes since
+    curly braces and brackets will be interpreted as Hash/Array in Slim 2.0.0
+    Old syntax:
+      div id={person && person.id}
+      div id=[person && person.id]
+    New syntax in 2.0.0:
+      div id=(person && person.id)
+  * Deprecated :escape_quoted_attrs (done by default in 2.0)
+  * Warn if quoted attributes might be double escaped in Slim 2.0.0
+    Old syntax:
+       a href='http://slim-lang.com/?a=1&b=2'
+       a href=='http://slim-lang.com/?a=1&b=2'
+    New syntax in 2.0.0:
+       a href='http://slim-lang.com/?a=1&b=2'
+       a href=='http://slim-lang.com/?a=1&b=2'
+  * Improved pretty printing (Issue #202)
+  * Renamed Slim::EmbeddedEngine to Slim::Embedded (Old constant still available until 2.0)
+  * Renamed Slim::ControlStructures to Slim::Controls
+  * Tab expansion improved (tab + space is interpreted as equivalent to tab)
+  * Support for wrapping javascript in HTML comments or CDATA (Issue #340)
+  * Asciidoc embedded engine added
+
 1.3.6
 
   * Allow attribute values to be broken with `\` (Issue #331)

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org/'
 
 gemspec
 
@@ -33,6 +33,14 @@ if ENV['SINATRA']
   end
 end
 
+gem 'rake', '>= 0.8.7'
+gem 'sass', '>= 3.1.0'
+gem 'minitest'
+gem 'kramdown'
+gem 'creole'
+gem 'builder'
+gem 'asciidoctor'
+
 if ENV['TASK'] == 'bench'
   gem 'erubis'
   gem 'haml'

data/README.md

@@ -1,28 +1,47 @@
 # Slim
 
-[![Build Status](https://secure.travis-ci.org/slim-template/slim.png?branch=master)](http://travis-ci.org/slim-template/slim) [![Dependency Status](https://gemnasium.com/slim-template/slim.png?travis)](https://gemnasium.com/slim-template/slim) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/slim-template/slim)
+[![Gem Version](https://badge.fury.io/rb/slim.png)](http://rubygems.org/gems/slim) [![Build Status](https://secure.travis-ci.org/slim-template/slim.png?branch=master)](http://travis-ci.org/slim-template/slim) [![Dependency Status](https://gemnasium.com/slim-template/slim.png?travis)](https://gemnasium.com/slim-template/slim) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/slim-template/slim)
 
 Slim is a template language whose goal is to reduce the view syntax to the essential parts without becoming cryptic. It started as an exercise to see how much could be removed from a standard html template (<, >, closing tags, etc...). As more people took an interest in Slim, the functionality grew and so did the flexibility of the syntax.
 
 A short list of the features...
 
-* Short syntax without closing tags (Using indentation instead)
-* Embedded engines like Markdown and Textile
-* Configurable shortcut tags (`#` for `div id` and `.` for `div class` in the default configuration)
-* Automatic HTML escaping and support for Rails' `html_safe?`
-* HTML style mode with closing tags
-* Logic less mode similar to Mustache, realized as plugin
-* Translator/I18n, realized as plugin
-* Highly configurable and extendable
-* High performance (Comparable to ERB)
+* Elegant syntax
+    * Short syntax without closing tags (Using indentation instead)
+    * HTML style mode with closing tags
+    * Configurable shortcut tags (`#` for `<div id="...">` and `.` for `<div class="...">` in the default configuration)
+* Safety
+    * Automatic HTML escaping by default
+    * Support for Rails' `html_safe?`
+* Highly configurable and extendable via plugins
+    * Logic less mode similar to Mustache, realized as plugin
+    * Translator/I18n, realized as plugin
+* High performance
+    * Comparable speed to ERB/Erubis
+    * Streaming support in Rails
 * Supported by all major frameworks (Rails, Sinatra, ...)
-* Streaming support in Rails
+* Embedded engines like Markdown and Textile
+
+## Upgrade to version 2.0
+
+__NOTE:__ Slim 2.0 is not yet released, but you can try the preview versions.
+
+If you are already using Slim 1.3 or 1.2 and want to upgrade to the newest version 2.0, you should at first
+upgrade to Slim 1.3.7 which will emit warnings for deprecated features. This way you can easily
+see if your application is already Slim 2.0 compliant!
+
+Slim 2.0 removes deprecated features from the 1.3 series and cleans up some minor
+inconsistencies in the syntax (Attribute wrapper and quoted attribute escaping).
+Of course it also includes new features and bugfixes. See the CHANGES for details.
+
+In general don't be afraid of upgrading! We try to be backward compatible and follow [semantic versions](http://semver.org/)
+as good as possible.
 
 ## Introduction
 
 ### What is Slim?
 
-Slim is a fast, lightweight templating engine with support for __Rails 3__. It has been heavily tested on all major ruby implementations. We use
+Slim is a fast, lightweight templating engine with support for __Rails 3 and 4__. It has been heavily tested on all major ruby implementations. We use
 continous integration (travis-ci).
 
 Slim's core syntax is guided by one thought: "What's the minimum required to make this work".
@@ -38,9 +57,12 @@ by the logic less plugin and the translator plugin which provides I18n.
 
 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 syntax can be quite cryptic to the uninitiated.
 
+There is also some development in logic-less engines (e.g. [Mustache](https://github.com/defunkt/mustache) which requires you to write standard HTML). You can also use Slim in logic-less mode if you like the Slim syntax to build your HTML but don't want to write Ruby in your templates.
+
 Slim was born to bring a minimalist syntax approach with speed. If people chose not to use Slim, it would not be because of speed.
 
-___Yes, Slim is speedy!___ Benchmarks are provided at the end of this README file. Don't trust the numbers? That's as it should be. Therefore we provide a benchmark rake task so you could test it yourself (`rake bench`).
+___Yes, Slim is speedy!___ Benchmarks are done for every commit at {http://travis-ci.org/#!/slim-template/slim}.
+Don't trust the numbers? That's as it should be. Please try the benchmark rake task yourself!
 
 ### How to start?
 
@@ -84,7 +106,7 @@ Here's a quick example to demonstrate what a Slim template looks like:
 
         div id="footer"
           = render 'footer'
-          | Copyright &copy; #{year} #{author}
+          | Copyright &copy; #{@year} #{@author}
 
 Indentation matters, but the indentation depth can be chosen as you like. 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.
 
@@ -380,7 +402,7 @@ as booleans. If you use the attribut wrapper you can omit the attribute assigmen
 
 #### Attribute merging
 
-You can configure attributes to be merged if multiple are given (See option `:attr_delimiter`). In the default configuration
+You can configure attributes to be merged if multiple are given (See option `:merge_attrs`). In the default configuration
 this is done for class attributes with the white space as delimiter.
 
     a.menu class="highlight" href="http://slim-lang.com/" Slim-lang.com
@@ -409,7 +431,7 @@ You can also use methods or instance variables which return a hash as shown here
     .card *method_which_returns_hash = place.name
     .card *@hash_instance_variable = place.name
 
-The hash attributes which support attribute merging (see Slim option `:attr_delimiter`) can be given as an `Array`
+The hash attributes which support attribute merging (see Slim option `:merge_attrs`) can be given as an `Array`
 
     .first *{:class => [:second, :third]} Text
 
@@ -545,6 +567,7 @@ Supported engines:
 <tr><td>less:</td><td>less</td><td>Compile time</td><td>Embed less css code and wrap in style tag</td></tr>
 <tr><td>styl:</td><td>styl</td><td>Compile time</td><td>Embed stylus css code and wrap in style tag</td></tr>
 <tr><td>coffee:</td><td>coffee-script</td><td>Compile time</td><td>Compile coffee script code and wrap in script tag</td></tr>
+<tr><td>asciidoc:</td><td>asciidoctor</td><td>Compile time + Interpolation</td><td>Compile AsciiDoc code and interpolate #\{variables} in text</td></tr>
 <tr><td>markdown:</td><td>redcarpet/rdiscount/kramdown</td><td>Compile time + Interpolation</td><td>Compile markdown code and interpolate #\{variables} in text</td></tr>
 <tr><td>textile:</td><td>redcloth</td><td>Compile time + Interpolation</td><td>Compile textile code and interpolate #\{variables} in text</td></tr>
 <tr><td>creole:</td><td>creole</td><td>Compile time + Interpolation</td><td>Compile creole code and interpolate #\{variables} in text</td></tr>
@@ -556,9 +579,9 @@ Supported engines:
 </tbody>
 </table>
 
-The embedded engines can be configured in Slim by setting the options directly on the `Slim::EmbeddedEngine` filter. Example:
+The embedded engines can be configured in Slim by setting the options directly on the `Slim::Embedded` filter. Example:
 
-    Slim::EmbeddedEngine.default_options[:markdown] = {:auto_ids => false}
+    Slim::Embedded.default_options[:markdown] = {:auto_ids => false}
 
 ## Configuring Slim
 
@@ -617,16 +640,17 @@ There are a lot of them but the good thing is, that Slim checks the configuratio
 <tr><td>String</td><td>:encoding</td><td>"utf-8"</td><td>Set encoding of template</td></tr>
 <tr><td>String</td><td>:default_tag</td><td>"div"</td><td>Default tag to be used if tag name is omitted</td></tr>
 <tr><td>Hash</td><td>:shortcut</td><td>\{'.' => {:attr => 'class'}, '#' => {:attr => 'id'}}</td><td>Attribute shortcuts</td></tr>
-<tr><td>Symbol/String list</td><td>:enable_engines</td><td>nil <i>(All enabled)</i></td><td>List of enabled embedded engines (whitelist)</td></tr>
-<tr><td>Symbol/String list</td><td>:disable_engines</td><td>nil <i>(None disabled)</i></td><td>List of disabled embedded engines (blacklist)</td></tr>
+<tr><td>Array&lt;Symbol,String&gt;</td><td>:enable_engines</td><td>nil <i>(All enabled)</i></td><td>List of enabled embedded engines (whitelist)</td></tr>
+<tr><td>Array&lt;Symbol,String&gt;</td><td>:disable_engines</td><td>nil <i>(None disabled)</i></td><td>List of disabled embedded engines (blacklist)</td></tr>
 <tr><td>Boolean</td><td>:disable_capture</td><td>false (true in Rails)</td><td>Disable capturing in blocks (blocks write to the default buffer </td></tr>
 <tr><td>Boolean</td><td>:disable_escape</td><td>false</td><td>Disable automatic escaping of strings</td></tr>
-<tr><td>Boolean</td><td>:escape_quoted_attrs</td><td>false</td><td>Escape quoted attributes</td></tr>
+<tr><td>Boolean</td><td>:escape_quoted_attrs</td><td>false</td><td>Escape quoted attributes. <b>Option is removed and activated per default in Slim 2.0!</b></td></tr>
 <tr><td>Boolean</td><td>:use_html_safe</td><td>false (true in Rails)</td><td>Use String#html_safe? from ActiveSupport (Works together with :disable_escape)</td></tr>
 <tr><td>Symbol</td><td>:format</td><td>:xhtml</td><td>HTML output format (Possible formats :xhtml, :html4, :html5, :html)</td></tr>
-<tr><td>String</td><td>:attr_wrapper</td><td>'"'</td><td>Character to wrap attributes in html (can be ' or ")</td></tr>
-<tr><td>Hash</td><td>:attr_delimiter</td><td>\{'class' => ' '}</td><td>Joining character used if multiple html attributes are supplied (e.g. class="class1 class2")</td></tr>
+<tr><td>String</td><td>:attr_quote</td><td>'"'</td><td>Character to wrap attributes in html (can be ' or ")</td></tr>
+<tr><td>Hash</td><td>:merge_attrs</td><td>\{'class' => ' '}</td><td>Joining character used if multiple html attributes are supplied (e.g. class="class1 class2")</td></tr>
 <tr><td>Boolean</td><td>:sort_attrs</td><td>true</td><td>Sort attributes by name</td></tr>
+<tr><td>Symbol</td><td>:js_wrapper</td><td>nil</td><td>Wrap javascript by :comment, :cdata or :both. You can also :guess the wrapper based on :format.</td></tr>
 <tr><td>Boolean</td><td>:pretty</td><td>false</td><td>Pretty html indenting <b>(This is slower!)</b></td></tr>
 <tr><td>String</td><td>:indent</td><td>'  '</td><td>Indentation string</td></tr>
 <tr><td>Boolean</td><td>:streaming</td><td>false (true in Rails > 3.1)</td><td>Enable output streaming</td></tr>
@@ -764,7 +788,7 @@ and activate logic less mode per render call in your application
 <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 of Symbols</td><td>:dictionary_access</td><td>[:symbol, :string, :method, :instance_variable]</td><td>Dictionary access order (:symbol, :string, :method, :instance_variable)</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>
 
@@ -837,7 +861,7 @@ Then just use the .slim extension and you're good to go.
 
 #### Streaming
 
-HTTP streaming is enabled enabled by default if you use a Rails version which supports it.
+HTTP streaming is enabled by default if you use a Rails version which supports it.
 
 ## Tools
 
@@ -944,12 +968,7 @@ Work your magic and then submit a pull request. We love pull requests!
 
 Please remember to test against Ruby versions 1.9.2 and 1.8.7.
 
-If you find the documentation lacking (and you probably will), help us out
-The docs are located in the gh-pages branch:
-
-    $ git checkout gh-pages
-
-If you don't have the time to work on Slim, but found something we should know about, please submit an issue.
+If you find the documentation lacking (and you probably will), help us out and update this README.md. If you don't have the time to work on Slim, but found something we should know about, please submit an issue.
 
 ## License
 
@@ -973,7 +992,7 @@ Template compilation framework:
 
 Framework support:
 
-* [Rails 3 generators (slim-rails)](https://github.com/slim-template/slim-rails)
+* [Rails generators (slim-rails)](https://github.com/slim-template/slim-rails)
 
 Syntax highlighting:
 

data/lib/slim.rb

@@ -2,9 +2,9 @@ require 'temple'
 require 'slim/parser'
 require 'slim/filter'
 require 'slim/end_inserter'
-require 'slim/embedded_engine'
+require 'slim/embedded'
 require 'slim/interpolation'
-require 'slim/control_structures'
+require 'slim/controls'
 require 'slim/splat_attributes'
 require 'slim/code_attributes'
 require 'slim/engine'

data/lib/slim/code_attributes.rb

@@ -1,7 +1,7 @@
 module Slim
   # @api private
   class CodeAttributes < Filter
-    define_options :attr_delimiter
+    define_options :merge_attrs
 
     # Handle attributes expression `[:html, :attrs, *attrs]`
     #
@@ -17,7 +17,7 @@ module Slim
     # @param [Array] value Value expression
     # @return [Array] Compiled temple expression
     def on_html_attr(name, value)
-      unless value[0] == :slim && value[1] == :attrvalue && !options[:attr_delimiter][name]
+      unless value[0] == :slim && value[1] == :attrvalue && !options[:merge_attrs][name]
         # We perform merging on the attribute
         @attr = name
         return super
@@ -48,7 +48,7 @@ module Slim
     # @return [Array] Compiled temple expression
     def on_slim_attrvalue(escape, code)
       # We perform attribute merging on Array values
-      if delimiter = options[:attr_delimiter][@attr]
+      if delimiter = options[:merge_attrs][@attr]
         tmp = unique_name
         [:multi,
          [:code, "#{tmp} = #{code}"],

data/lib/slim/command.rb

@@ -1,11 +1,8 @@
-require 'slim/logic_less'
-require 'slim/translator'
+require 'slim'
 require 'optparse'
 
 module Slim
-  Engine.set_default_options :logic_less => false,
-                             :pretty => false,
-                             :tr => false
+  Engine.set_default_options :pretty => false
 
   # Slim commandline interface
   # @api private
@@ -51,11 +48,11 @@ module Slim
       end
 
       opts.on('-t', '--translator', 'Enable translator plugin') do
-        Engine.set_default_options :tr => true
+        require 'slim/translator'
       end
 
       opts.on('-l', '--logic-less', 'Enable logic less plugin') do
-        Engine.set_default_options :logic_less => true
+        require 'slim/logic_less'
       end
 
       opts.on('-p', '--pretty', 'Produce pretty html') do

data/lib/slim/{control_structures.rb → controls.rb}

@@ -1,6 +1,6 @@
 module Slim
   # @api private
-  class ControlStructures < Filter
+  class Controls < Filter
     define_options :disable_capture
 
     # Handle control expression `[:slim, :control, code, content]`

data/lib/slim/{embedded_engine.rb → embedded.rb}

@@ -60,7 +60,7 @@ module Slim
 
   # Temple filter which processes embedded engines
   # @api private
-  class EmbeddedEngine < Filter
+  class Embedded < Filter
     @engines = {}
 
     # Register embedded engine
@@ -155,7 +155,7 @@ module Slim
           :style => options[:pretty] ? :expanded : :compressed,
           :cache => false)) { text }.render
         text.chomp!
-        [:static, options[:pretty] ? "\n#{text}\n" : text]
+        [:static, text]
       end
     end
 
@@ -221,6 +221,18 @@ module Slim
       end
     end
 
+    # Javascript wrapper engine.
+    # Like TagEngine, but can wrap content in html comment or cdata.
+    class JavaScriptEngine < TagEngine
+      disable_option_validator!
+
+      set_default_options :tag => :script, :attributes => { :type => 'text/javascript' }
+
+      def on_slim_embedded(engine, body)
+        super(engine, [:html, :js, body])
+      end
+    end
+
     # Embeds ruby code
     class RubyEngine < Engine
       def on_slim_embedded(engine, body)
@@ -229,6 +241,7 @@ module Slim
     end
 
     # These engines are executed at compile time, embedded ruby is interpolated
+    register :asciidoc,   InterpolateTiltEngine
     register :markdown,   InterpolateTiltEngine
     register :textile,    InterpolateTiltEngine
     register :rdoc,       InterpolateTiltEngine
@@ -237,7 +250,7 @@ module Slim
     register :mediawiki,  InterpolateTiltEngine
 
     # These engines are executed at compile time
-    register :coffee,     TagEngine, :tag => :script, :attributes => { :type => 'text/javascript' },  :engine => StaticTiltEngine
+    register :coffee,     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
@@ -249,10 +262,16 @@ module Slim
     register :builder,    PrecompiledTiltEngine
 
     # Embedded javascript/css
-    register :javascript, TagEngine, :tag => :script, :attributes => { :type => 'text/javascript' }
+    register :javascript, JavaScriptEngine
     register :css,        TagEngine, :tag => :style,  :attributes => { :type => 'text/css' }
 
     # 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)\b/
+    ELSE_REGEX = /\A(else|elsif|when|rescue|ensure)\b/
     END_REGEX = /\Aend\b/
 
     # Handle multi expression `[:multi, *exps]`