slim 2.0.2 → 2.0.3

data/README.md

@@ -555,7 +555,7 @@ This is the same as
       div class="content"
         = show_content
 
-## Helpers and capturing
+## Helpers, capturing and includes
 
 If you use Slim you might want to extend your template with some helpers. Assume that you have the following helper
 
@@ -574,7 +574,7 @@ module Helpers
 end
 ~~~
 
-which can be used in Slim as follows
+which is included in the scope that executes the Slim template code. The helper can then be used in the Slim template as follows
 
     p
       = headline do
@@ -589,6 +589,25 @@ sugar you can omit the `do` keyword and write only
         ' Hello
         = user.name
 
+It has been requested many times to support includes of subtemplates in Slim. Up to now this has not been implemented as a core feature
+but you can easily get it by writing your own helper. The includes will be executed at runtime.
+
+~~~ruby
+module Helpers
+  def include_slim(name, options = {}, &block)
+    Slim::Template.new("#{name}.slim", options).render(self, &block)
+  end
+end
+~~~
+
+This helper can then be used as follows
+
+    nav= include_slim 'menu'
+    section= include_slim 'content'
+
+However this helper doesn't do any caching. You should therefore implement a more intelligent version of the helper which
+fits your purposes. You should also be aware that most frameworks already bring their own include helper, e.g. Rails has `render`.
+
 ## Text interpolation
 
 Use standard Ruby interpolation. The text will be html escaped by default.
@@ -754,7 +773,8 @@ Slim uses [Tilt](https://github.com/rtomayko/tilt) to compile the generated code
     Slim::Template.new('template.slim', optional_option_hash).render(scope)
     Slim::Template.new(optional_option_hash) { source }.render(scope)
 
-The optional option hash can have to options which were documented in the section above.
+The optional option hash can have to options which were documented in the section above. The scope is the object in which the template
+code is executed.
 
 ### Sinatra
 
@@ -805,7 +825,7 @@ Usage: slimrb [options]
     -v, --version                    Print version
 </pre>
 
-Start 'slimrb', type your code and press Ctrl-d to send EOF. Example usage:
+Start 'slimrb', type your code and press Ctrl-d to send EOF. In Windows Command Prompt press Ctrl-z, Enter to send EOF.  Example usage:
 
 <pre>
 $ slimrb
@@ -930,6 +950,7 @@ Syntax highlighting:
 * [Textmate / Sublime Text](https://github.com/slim-template/ruby-slim.tmbundle)
 * [Espresso text editor](https://github.com/slim-template/Slim-Sugar)
 * [Coda](https://github.com/slim-template/Coda-2-Slim.mode)
+* [Atom](https://github.com/slim-template/language-slim)
 
 Template Converters (HAML, ERB, ...):
 

data/lib/slim/code_attributes.rb

@@ -37,7 +37,7 @@ module Slim
       else
         # Attribute with merging
         @attr = name
-        return super
+        super
       end
     end
 

data/lib/slim/command.rb

@@ -17,13 +17,6 @@ module Slim
       @opts = OptionParser.new(&method(:set_opts))
       @opts.parse!(@args)
       process
-      exit 0
-    rescue Exception => ex
-      raise ex if @options[:trace] || SystemExit === ex
-      $stderr.print "#{ex.class}: " if ex.class != RuntimeError
-      $stderr.puts ex.message
-      $stderr.puts '  Use --trace for backtrace.'
-      exit 1
     end
 
     private
@@ -93,11 +86,6 @@ module Slim
         end
       end
 
-      unless @options[:output]
-        file = args.shift
-        @options[:output] = file ? File.open(file, 'w') : $stdout
-      end
-
       result =
         if @options[:erb]
           require 'slim/erb_converter'
@@ -108,7 +96,19 @@ module Slim
           Template.new(@options[:file]) { @options[:input].read }.render
         end
 
-      @options[:output].puts(result)
+      rescue Exception => ex
+        raise ex if @options[:trace] || SystemExit === ex
+        $stderr.print "#{ex.class}: " if ex.class != RuntimeError
+        $stderr.puts ex.message
+        $stderr.puts '  Use --trace for backtrace.'
+        exit 1
+      else
+        unless @options[:output]
+          file = args.shift
+          @options[:output] = file ? File.open(file, 'w') : $stdout
+        end
+        @options[:output].puts(result)
+        exit 0
     end
   end
 end

data/lib/slim/controls.rb

@@ -3,6 +3,8 @@ module Slim
   class Controls < Filter
     define_options :disable_capture
 
+    IF_RE = /\A(if|unless)\b|do\s*(\|[^\|]*\|)?\s*$/
+
     # Handle control expression `[:slim, :control, code, content]`
     #
     # @param [String] code Ruby code
@@ -21,9 +23,7 @@ module Slim
     # @param [Array] content Temple expression
     # @return [Array] Compiled temple expression
     def on_slim_output(escape, code, content)
-      if empty_exp?(content)
-        [:multi, [:escape, escape, [:dynamic, code]], content]
-      else
+      if code =~ IF_RE
         tmp = unique_name
 
         [:multi,
@@ -43,6 +43,8 @@ module Slim
 
          # Output the content.
          [:escape, escape, [:dynamic, tmp]]]
+      else
+        [:multi, [:escape, escape, [:dynamic, code]], content]
       end
     end
 

data/lib/slim/end_inserter.rb

@@ -10,8 +10,9 @@ module Slim
   #
   # @api private
   class EndInserter < Filter
-    BLOCK_REGEX = /\A(else|elsif|when|rescue|ensure)\b/
-    END_REGEX = /\Aend\b/
+    IF_RE = /\A(if|unless|else|elsif|when|rescue|ensure)\b|do\s*(\|[^\|]*\|)?\s*$/
+    ELSE_RE = /\A(else|elsif|when|rescue|ensure)\b/
+    END_RE = /\Aend\b/
 
     # Handle multi expression `[:multi, *exps]`
     #
@@ -24,14 +25,14 @@ module Slim
 
       exps.each do |exp|
         if control?(exp)
-          raise(Temple::FilterError, 'Explicit end statements are forbidden') if exp[2] =~ END_REGEX
+          raise(Temple::FilterError, 'Explicit end statements are forbidden') if exp[2] =~ END_RE
 
           # 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] !~ BLOCK_REGEX
+          append_end(result) if prev_indent && exp[2] !~ ELSE_RE
 
-          # Indent if the control code contains something.
-          prev_indent = !empty_exp?(exp[3])
+          # Indent if the control code starts a block.
+          prev_indent = exp[2] =~ IF_RE
         elsif exp[0] != :newline && prev_indent
           # This is *not* a control code, so we should close the previous one.
           # Ignores newlines because they will be inserted after each line.

data/lib/slim/engine.rb

@@ -7,6 +7,7 @@ module Slim
     # `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,
@@ -17,7 +18,7 @@ module Slim
     use Slim::Parser, :file, :tabsize, :shortcut, :default_tag, :attr_delims
     use Slim::Embedded, :enable_engines, :disable_engines, :pretty
     use Slim::Interpolation
-    use Slim::Splat::Filter, :merge_attrs, :attr_quote, :sort_attrs, :default_tag, :hyphen_attrs
+    use Slim::Splat::Filter, :merge_attrs, :attr_quote, :sort_attrs, :default_tag, :hyphen_attrs, :format
     use Slim::DoInserter
     use Slim::EndInserter
     use Slim::Controls, :disable_capture

data/lib/slim/parser.rb

@@ -58,7 +58,7 @@ module Slim
         end
       end
       keys = Regexp.union @attr_shortcut.keys.sort_by {|k| -k.size }
-      @attr_shortcut_re = /\A(#{keys}+)(#{WORD_RE}(?:#{WORD_RE}|-)*#{WORD_RE}|#{WORD_RE}+)/
+      @attr_shortcut_re = /\A(#{keys}+)((?:#{WORD_RE}|-)*)/
       keys = Regexp.union @tag_shortcut.keys.sort_by {|k| -k.size }
       @tag_re = /\A(?:#{keys}|\*(?=[^\s]+)|(#{WORD_RE}(?:#{WORD_RE}|:|-)*#{WORD_RE}|#{WORD_RE}+))/
       keys = Regexp.escape options[:attr_delims].keys.join
@@ -338,8 +338,9 @@ module Slim
         # Handle output code
         @line = $'
         trailing_ws2 = $2.include?('\'') || $2.include?('>')
+        leading_ws2 = $2.include?('<')
         block = [:multi]
-        @stacks.last << [:static, ' '] if !leading_ws && $2.include?('<')
+        @stacks.last.insert(-2, [:static, ' ']) if !leading_ws && $2.include?('<')
         tag << [:slim, :output, $1 != '=', parse_broken_line, block]
         @stacks.last << [:static, ' '] if !trailing_ws && trailing_ws2
         @stacks << block
@@ -397,7 +398,7 @@ module Slim
           when boolean_attr_re
             # Boolean attribute
             @line = $'
-            attributes << [:html, :attr, $1, [:slim, :attrvalue, false, 'true']]
+            attributes << [:html, :attr, $1, [:multi]]
           when end_re
             # Find ending delimiter
             @line = $'

data/lib/slim/splat/builder.rb

@@ -13,18 +13,8 @@ module Slim
           attr(name, escape ? Temple::Utils.escape_html(value) : value) unless value.empty?
         elsif @options[:hyphen_attrs].include?(name) && Hash === value
           hyphen_attr(name, escape, value)
-        else
-          case value
-          when false, nil
-            # Boolean false attribute
-            return
-          when true
-            # Boolean true attribute
-            value = ''
-          else
-            value = value.to_s
-          end
-          attr(name, escape ? Temple::Utils.escape_html(value) : value)
+        elsif value != false && value != nil
+          attr(name, value != true && escape ? Temple::Utils.escape_html(value) : value)
         end
       end
 
@@ -37,7 +27,7 @@ module Slim
       def attr(name, value)
         if @attrs[name]
           if delim = @options[:merge_attrs][name]
-            @attrs[name] << delim << value
+            @attrs[name] << delim << value.to_s
           else
             raise("Multiple #{name} attributes specified")
           end
@@ -59,7 +49,15 @@ module Slim
       def build_attrs
         attrs = @options[:sort_attrs] ? @attrs.sort_by(&:first) : @attrs
         attrs.map do |k, v|
-          " #{k}=#{@options[:attr_quote]}#{v}#{@options[:attr_quote]}"
+          if v == true
+            if @options[:format] == :xhtml
+              " #{k}=#{@options[:attr_quote]}#{@options[:attr_quote]}"
+            else
+              " #{k}"
+            end
+          else
+            " #{k}=#{@options[:attr_quote]}#{v}#{@options[:attr_quote]}"
+          end
         end.join
       end
 
@@ -71,7 +69,7 @@ module Slim
             hyphen_attr("#{name}-#{n.to_s.gsub('_', '-')}", escape, v)
           end
         else
-          attr(name, escape ? Temple::Utils.escape_html(value) : value.to_s)
+          attr(name, value != true && escape ? Temple::Utils.escape_html(value) : value)
         end
       end
     end

data/lib/slim/splat/filter.rb

@@ -2,7 +2,7 @@ module Slim
   module Splat
     # @api private
     class Filter < ::Slim::Filter
-      OPTIONS = [:merge_attrs, :attr_quote, :sort_attrs, :default_tag, :hyphen_attrs]
+      OPTIONS = [:merge_attrs, :attr_quote, :sort_attrs, :default_tag, :hyphen_attrs, :format]
       define_options OPTIONS
       default_options[:hyphen_attrs] = %w(data aria)
 

data/lib/slim/version.rb

@@ -1,5 +1,5 @@
 module Slim
   # Slim version string
   # @api public
-  VERSION = '2.0.2'
+  VERSION = '2.0.3'
 end

data/test/core/test_code_blocks.rb

@@ -116,4 +116,57 @@ p
 
     assert_html 'Hello Ruby! Hello from within a block! Hello Ruby!', source
   end
+
+  def test_if_without_content
+    source = %q{
+- if true
+}
+    assert_html '', source
+  end
+
+  def test_unless_without_content
+    source = %q{
+- unless true
+}
+    assert_html '', source
+  end
+
+  def test_if_with_comment
+    source = %q{
+- if true
+  / comment
+}
+    assert_html '', source
+  end
+
+  def test_control_do_with_comment
+    source = %q{
+- hello_world "Hello"
+  / comment
+}
+    assert_html '', source
+  end
+
+  def test_output_do_with_comment
+    source = %q{
+= hello_world "Hello"
+  / comment
+}
+    assert_html 'Hello', source
+  end
+
+  def test_output_if_without_content
+    source = %q{
+= if true
+}
+    assert_html '', source
+  end
+
+  def test_output_if_with_comment
+    source = %q{
+= if true
+  / comment
+}
+    assert_html '', source
+  end
 end

data/test/core/test_embedded_engines.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'erb' #asciidoctor fail to load it randomly
 
 class TestSlimEmbeddedEngines < TestSlim
   def test_render_with_erb

data/test/literate/TESTS.md

@@ -410,6 +410,16 @@ renders as
 49 
 ~~~
 
+~~~ slim
+=< 7*7
+~~~
+
+renders as
+
+~~~ html
+ 49
+~~~
+
 The legacy syntax `='` is also supported.
 
 ~~~ slim
@@ -705,13 +715,14 @@ You can force a trailing whitespace behind a tag by adding `>`. The legacy synta
 a#closed> class="test" /
 a#closed> class="test"/
 a> href='url1' Link1
+a< href='url1' Link1
 a' href='url2' Link2
 ~~~
 
 renders as
 
 ~~~ html
-<a class="test" id="closed" /> <a class="test" id="closed" /> <a href="url1">Link1</a> <a href="url2">Link2</a> 
+<a class="test" id="closed" /> <a class="test" id="closed" /> <a href="url1">Link1</a>  <a href="url1">Link1</a><a href="url2">Link2</a> 
 ~~~
 
 If you combine > and =' only one trailing whitespace is added.
@@ -721,12 +732,15 @@ a> =' 'Text1'
 a =' 'Text2'
 a> = 'Text3'
 a>= 'Text4'
+a=> 'Text5'
+a<= 'Text6'
+a=< 'Text7'
 ~~~
 
 renders as
 
 ~~~ html
-<a>Text1</a> <a>Text2</a> <a>Text3</a> <a>Text4</a> 
+<a>Text1</a> <a>Text2</a> <a>Text3</a> <a>Text4</a> <a>Text5</a>  <a>Text6</a> <a>Text7</a>
 ~~~
 
 You can force a leading whitespace before a tag by adding `<`.
@@ -1008,6 +1022,28 @@ renders as
 <input type="text" /><input type="text" /><input type="text" /><input type="text" /><input type="text" />
 ~~~
 
+If html5 is activated the attributes are written as standalone.
+
+~~~ options
+:format => :html
+~~~
+
+~~~ slim
+- true_value1 = ""
+- true_value2 = true
+input type="text" disabled=true_value1
+input type="text" disabled=true_value2
+input type="text" disabled="disabled"
+input type="text" disabled=true
+input(type="text" disabled)
+~~~
+
+renders as
+
+~~~ html
+<input disabled="" type="text"><input disabled type="text"><input disabled="disabled" type="text"><input disabled type="text"><input disabled type="text">
+~~~
+
 #### Attribute merging
 
 You can configure attributes to be merged if multiple are given (See option `:merge_attrs`). In the default configuration
@@ -1160,6 +1196,32 @@ renders to
 
 #### ID shortcut and class shortcut `.`
 
+ID and class shortcuts can contain dashes.
+
+~~~ slim
+.-test text
+#test- text
+.--a#b- text
+.a--test-123#--b text
+~~~
+
+renders as
+
+~~~ html
+<div class="-test">
+  text
+</div>
+<div id="test-">
+  text
+</div>
+<div class="--a" id="b-">
+  text
+</div>
+<div class="a--test-123" id="--b">
+  text
+</div>
+~~~
+
 ## Text interpolation
 
 Use standard Ruby interpolation. The text will be html escaped by default.