1337
', str end end def test_custom_attr_delims_option source = %q{ p { foo="bar" } } assert_html '', source assert_html '', source, attr_list_delims: {'{' => '}'} assert_html '{ foo="bar" }
', source, attr_list_delims: {'(' => ')', '[' => ']'} end def test_closed_tag source = %q{ closed/ } assert_html '< x=(1+1) > Hello
', source assert_html '< x=(1+1) > Hello
', source, attr_list_delims: {'{' => '}'} assert_html '{ foo="bar" x=(1+1) }
Hello
', source, attr_list_delims: {'<' => '>'}, code_attr_delims: { '(' => ')' } end def test_closed_tag source = %q{ closed/ } assert_html 'Hello
World
", source end def test_render_with_html_conditional_and_tag source = %q{ /[ if IE ] p Get a better browser. } assert_html "", source end def test_render_with_html_conditional_and_method_output source = %q{ /[ if IE ] = message 'hello' } assert_html "", source end def test_multiline_attributes_with_method source = %q{ p1337
', str end end def test_multiline_attributes_with_text_on_same_line source = %q{ pTHE space modulator
', str end end def test_multiline_attributes_with_nested_text source = %q{ pTHE space modulator
', str end end def test_multiline_attributes_with_dynamic_attr source = %q{ pTHE space modulator
', str end end def test_multiline_attributes_with_nested_tag source = %q{ pTHE space modulator
', str end end def test_multiline_attributes_with_nested_text_and_extra_indentation source = %q{ li< id="myid" class="myclass" data-info="myinfo"> a href="link" My Link } Slim::Parser.options[:attr_list_delims].each do |k,v| str = source.sub('<',k).sub('>',v) assert_html 'd
Text
}, source
end
def test_eval_attributes_once
source = %q{
input[value=succ_x]
input[value=succ_x]
}
assert_html %{}, source
end
def test_html_line_indicator
source = %q{
head
meta name="keywords" content=hello_world
- if true
#{hello_world}
span = hello_world } assert_html 'Hello World from @env
Hello World from @env', source end end slim-3.0.7/test/core/test_code_blocks.rb 0000644 0000041 0000041 00000007237 12727176366 020311 0 ustar www-data www-data require 'helper' class TestSlimCodeBlocks < TestSlim def test_render_with_output_code_block source = %q{ p = hello_world "Hello Ruby!" do | Hello from within a block! } assert_html 'Hello Ruby! Hello from within a block! Hello Ruby!
', source end def test_render_with_output_code_block_without_do source = %q{ p = hello_world "Hello Ruby!" | Hello from within a block! } assert_html 'Hello Ruby! Hello from within a block! Hello Ruby!
', source end def test_render_variable_ending_with_do source = %q{ - appelido=10 p= appelido - appelido } assert_html '10
', source end def test_render_with_output_code_within_block source = %q{ p = hello_world "Hello Ruby!" do = hello_world "Hello from within a block!" } assert_html 'Hello Ruby! Hello from within a block! Hello Ruby!
', source end def test_render_with_output_code_within_block_without_do source = %q{ p = hello_world "Hello Ruby!" = hello_world "Hello from within a block!" } assert_html 'Hello Ruby! Hello from within a block! Hello Ruby!
', source end def test_render_with_output_code_within_block_2 source = %q{ p = hello_world "Hello Ruby!" do = hello_world "Hello from within a block!" do = hello_world "And another one!" } assert_html 'Hello Ruby! Hello from within a block! And another one! Hello from within a block! Hello Ruby!
', source end def test_render_with_output_code_within_block_2_without_do source = %q{ p = hello_world "Hello Ruby!" = hello_world "Hello from within a block!" = hello_world "And another one!" } assert_html 'Hello Ruby! Hello from within a block! And another one! Hello from within a block! Hello Ruby!
', source end def test_output_block_with_arguments source = %q{ p = define_macro :person do |first_name, last_name| .first_name = first_name .last_name = last_name == call_macro :person, 'John', 'Doe' == call_macro :person, 'Max', 'Mustermann' } assert_html 'John
Doe
Max
Mustermann
', source
end
def test_render_with_control_code_loop
source = %q{
p
- 3.times do
| Hey!
}
assert_html 'Hey!Hey!Hey!
', source end def test_render_with_control_code_loop_without_do source = %q{ p - 3.times | Hey! } assert_html 'Hey!Hey!Hey!
', source end def test_captured_code_block_with_conditional source = %q{ = hello_world "Hello Ruby!" do - if true | Hello from within a block! } assert_html 'Hello Ruby! Hello from within a block! Hello Ruby!', source end def test_captured_code_block_with_conditional_without_do source = %q{ = hello_world "Hello Ruby!" - if true | Hello from within a block! } 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 slim-3.0.7/test/core/test_commands.rb 0000644 0000041 0000041 00000014436 12727176366 017642 0 ustar www-data www-data # coding: utf-8 require 'helper' require 'open3' require 'tempfile' class TestSlimCommands < Minitest::Test # nothing complex STATIC_TEMPLATE = "p Hello World!\n" # requires a `name` variable to exist at render time DYNAMIC_TEMPLATE = "p Hello \#{name}!\n" # a more complex example LONG_TEMPLATE = "h1 Hello\np\n | World!\n small Tiny text" # exception raising example EXCEPTION_TEMPLATE = '- raise NotImplementedError' # Temple has this feature... STRING_FREEZER = RUBY_VERSION >= '2.1' ? '.freeze' : '' def test_option_help out, err = exec_slimrb '--help' assert err.empty? assert_match /Show this message/, out end def test_option_version out, err = exec_slimrb '--version' assert err.empty? assert_match /\ASlim #{Regexp.escape Slim::VERSION}$/, out end def test_render prepare_common_test STATIC_TEMPLATE do |out, err| assert err.empty? assert_equal "Hello World!
\n", out end end # superficial test, we don't want to test Tilt/Temple def test_compile prepare_common_test STATIC_TEMPLATE, '--compile' do |out, err| assert err.empty? assert_match %r{\"Hello World!<\/p>\"#{STRING_FREEZER}}, out end end def test_erb prepare_common_test DYNAMIC_TEMPLATE, '--erb' do |out, err| assert err.empty? assert_equal "
Hello <%= ::Temple::Utils.escape_html((name)) %>!
\n", out end end def test_rails prepare_common_test DYNAMIC_TEMPLATE, '--rails' do |out, err| assert err.empty? assert out.include? %Q{@output_buffer = ActiveSupport::SafeBuffer.new;} assert out.include? %Q{@output_buffer.safe_concat(("Hello "#{STRING_FREEZER}));} assert out.include? %Q{@output_buffer.safe_concat(((::Temple::Utils.escape_html((name))).to_s));} assert out.include? %Q{@output_buffer.safe_concat(("!
"#{STRING_FREEZER}));} end end def test_pretty prepare_common_test LONG_TEMPLATE, '--pretty' do |out, err| assert err.empty? assert_equal "\n Hello\n
\n\n World!Tiny text\n
\n", out end end # We cannot run these two on Travis, because we can't install libyaml. # See https://github.com/slim-template/slim/issues/576 if ENV['TRAVIS'] && RUBY_ENGINE != 'rbx' def test_locals_json data = '{"name":"from slim"}' prepare_common_test DYNAMIC_TEMPLATE, '--locals', data do |out, err| assert err.empty? assert_equal "Hello from slim!
\n", out end end def test_locals_yaml data = "name: from slim" prepare_common_test DYNAMIC_TEMPLATE, '--locals', data do |out, err| assert err.empty? assert_equal "Hello from slim!
\n", out end end end def test_locals_hash data = '{name:"from slim"}' prepare_common_test DYNAMIC_TEMPLATE, '--locals', data do |out, err| assert err.empty? assert_equal "Hello from slim!
\n", out end end def test_require with_tempfile 'puts "Not in slim"', 'rb' do |lib| prepare_common_test STATIC_TEMPLATE, '--require', lib, stdin_file: false, file_file: false do |out, err| assert err.empty? assert_equal "Not in slim\nHello World!
\n", out end end end def test_error prepare_common_test EXCEPTION_TEMPLATE, stdin_file: false do |out, err| assert out.empty? assert_match /NotImplementedError: NotImplementedError/, err assert_match /Use --trace for backtrace/, err end end def test_trace_error prepare_common_test EXCEPTION_TEMPLATE, '--trace', stdin_file: false do |out, err| assert out.empty? assert_match /bin\/slimrb/, err end end private # Whether you call slimrb with a file argument or pass the slim content # via $stdin; whether you want the output written to $stdout or into # another file given as argument, the output is the same. # # This method prepares a test with this exact behaviour: # # It yields the tupel (out, err) once after the `content` was passed # in via $stdin and once it was passed as a (temporary) file argument. # # In effect, this method executes a test (given as block) 4 times: # # 1. read from $stdin, write to $stdout # 2. read from file, write to $stdout # 3. read from $stdin, write to file # 4. read from file, write to file def prepare_common_test(content, *args) options = Hash === args.last ? args.pop : {} # case 1. $stdin → $stdout unless options[:stdin_stdout] == false out, err = exec_slimrb *args, '--stdin' do |i| i.write content end yield out, err end # case 2. file → $stdout unless options[:file_stdout] == false with_tempfile content do |in_file| out, err = exec_slimrb *args, in_file yield out, err end end # case 3. $stdin → file unless options[:stdin_file] == false with_tempfile content do |out_file| _, err = exec_slimrb *args, '--stdin', out_file do |i| i.write content end yield File.read(out_file), err end end # case 3. file → file unless options[:file_file] == false with_tempfile '' do |out_file| with_tempfile content do |in_file| _, err = exec_slimrb *args, in_file, out_file do |i| i.write content end yield File.read(out_file), err end end end end # Calls bin/slimrb as a subprocess. # # Yields $stdin to the caller and returns a tupel (out,err) with the # contents of $stdout and $stderr. # # (I'd like to use Minitest::Assertions#capture_subprecess_io here, # but then there's no way to insert data via $stdin.) def exec_slimrb(*args) out, err = nil, nil Open3.popen3 'ruby', 'bin/slimrb', *args do |i,o,e,t| yield i if block_given? i.close out, err = o.read, e.read end return out, err end # Creates a temporary file with the given content and yield the path # to this file. The file itself is only available inside the block and # will be deleted afterwards. def with_tempfile(content=nil, extname='slim') f = Tempfile.new ['slim', ".#{extname}"] if content f.write content f.flush # ensure content is actually saved to disk f.rewind end yield f.path ensure f.close f.unlink end end slim-3.0.7/test/core/test_ruby_errors.rb 0000644 0000041 0000041 00000007214 12727176366 020412 0 ustar www-data www-data require 'helper' class TestSlimRubyErrors < TestSlim def test_multline_attribute source = %q{ p(data-1=1 data2-=1) p = unknown_ruby_method } assert_ruby_error NameError, "test.slim:5", source, file: 'test.slim' end def test_broken_output_line source = %q{ p = hello_world + \ hello_world + \ unknown_ruby_method } # FIXME: Remove this hack! # This is actually a jruby issue. Jruby reports a wrong # line number 1 in this case: # # test = 1+\ # unknown_variable if RUBY_PLATFORM == "java" assert_ruby_error NameError, "test.slim:2", source, file: 'test.slim' else assert_ruby_error NameError, "test.slim:4", source, file: 'test.slim' end end def test_broken_output_line2 source = %q{ p = hello_world + \ hello_world p Hello = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):5", source end def test_output_block source = %q{ p = hello_world "Hello Ruby" do = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):3", source end def test_output_block2 source = %q{ p = hello_world "Hello Ruby" do = "Hello from block" p Hello = unknown_ruby_method } assert_ruby_error NameError, "(__TEMPLATE__):5", source end def test_text_block source = %q{ p Text line 1 Text line 2 = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):4", source end def test_text_block2 source = %q{ | Text line 1 Text line 2 = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):5", source end def test_comment source = %q{ / Comment line 1 Comment line 2 = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):4", source end def test_embedded_erb source = %q{ erb: <%= 123 %> Hello from ERB! <%# comment block %> <% if true %> Text <% end %> = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):11", source end def test_embedded_ruby1 source = %q{ ruby: a = 1 b = 2 = a + b = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):6", source end def test_embedded_ruby2 source = %q{ ruby: a = 1 unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):4", source end def test_embedded_markdown source = %q{ markdown: #Header Hello from #{"Markdown!"} "Second Line!" = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):6", source end def test_embedded_javascript source = %q{ javascript: alert(); alert(); = unknown_ruby_method } assert_ruby_error NameError,"(__TEMPLATE__):5", source end def test_invalid_nested_code source = %q{ p - test = 123 = "Hello from within a block! " } assert_ruby_syntax_error "(__TEMPLATE__):3", source end def test_invalid_nested_output source = %q{ p = "Hello Ruby!" = "Hello from within a block! " } assert_ruby_syntax_error "(__TEMPLATE__):3", source end def test_explicit_end source = %q{ div - if show_first? p The first paragraph - end } assert_runtime_error 'Explicit end statements are forbidden', source end def test_multiple_id_attribute source = %{ #alpha id="beta" Test it } assert_runtime_error 'Multiple id attributes specified', source end def test_splat_multiple_id_attribute source = %{ #alpha *{id:"beta"} Test it } assert_runtime_error 'Multiple id attributes specified', source end # def test_invalid_option # render('', foobar: 42) # raise Exception, 'ArgumentError expected' # rescue ArgumentError => ex # assert_equal 'Option :foobar is not supported by Slim::Engine', ex.message # end end slim-3.0.7/test/core/test_erb_converter.rb 0000644 0000041 0000041 00000003074 12727176366 020674 0 ustar www-data www-data require 'helper' require 'slim/erb_converter' class TestSlimERBConverter < TestSlim def test_converter source = %q{ doctype 5 html head title Hello World! /! Meta tags with long explanatory multiline comment meta name="description" content="template language" /! Stylesheets link href="style.css" media="screen" rel="stylesheet" type="text/css" link href="colors.css" media="screen" rel="stylesheet" type="text/css" /! Javascripts script src="jquery.js" script src="jquery.ui.js" /[if lt IE 9] script src="old-ie1.js" script src="old-ie2.js" sass: body background-color: red body #container p Hello World! p= "dynamic text with\nnewline" } result = %q{Hello World!
<%= ::Temple::Utils.escape_html(("dynamic text with\nnewline")) %>
Hello World!
dynamic text with newline
content
}
assert_html result, source, scope: self, locals: {body: body, content: content }
end
def test_correct_line_number
source = %q{
html
head
body
p Slim
= ''
= ''
= ''
= unknown_ruby_method
}
assert_ruby_error NameError,"(__TEMPLATE__):9", source
end
def test_unindenting
source = %q{
span before
span = " middle "
span after
}
result = %q{before middle after}
assert_html result, source
source = %q{
html
body == " \n link\n
"
}
result = %q{
}
assert_html result, source
end
def test_helper_unindent
source = %q{
= define_macro :content
div
a link
html
body
== call_macro :content
}
result = %q{
}
assert_html result, source
end
end
slim-3.0.7/test/core/test_thread_options.rb 0000644 0000041 0000041 00000001003 12727176366 021045 0 ustar www-data www-data require 'helper'
class TestSlimThreadOptions < TestSlim
def test_thread_options
source = %q{p.test}
assert_html '', source
assert_html "", source, attr_quote: "'"
Slim::Engine.with_options(attr_quote: "'") do
assert_html "", source
assert_html '', source, attr_quote: '"'
end
assert_html '', source
assert_html "", source, attr_quote: "'"
end
end
slim-3.0.7/test/core/test_html_escaping.rb 0000644 0000041 0000041 00000002456 12727176366 020655 0 ustar www-data www-data require 'helper'
class TestSlimHtmlEscaping < TestSlim
def test_html_will_not_be_escaped
source = %q{
p test <x>
', source end def test_html_nested_escaping source = %q{ = hello_world do | escaped & } assert_html 'Hello World from @env escaped & Hello World from @env', source end def test_html_quoted_attr_escape source = %q{ p id="&" class=="&" } assert_html '', source end def test_html_quoted_attr_escape_with_interpolation source = %q{ p id="&#{'"'}" class=="&#{'"'}" p id="&#{{'"'}}" class=="&#{{'"'}}" } assert_html '', source end def test_html_ruby_attr_escape source = %q{ p id=('&'.to_s) class==('&'.to_s) } assert_html '', source end end slim-3.0.7/test/core/test_encoding.rb 0000644 0000041 0000041 00000001247 12727176366 017623 0 ustar www-data www-data require 'helper' class TestSlimEncoding < TestSlim def test_windows_crlf source = "a href='#' something\r\nbr\r\na href='#' others\r\n" result = "somethingothers" assert_html result, source end def test_binary source = "| \xFF\xFF" source.force_encoding(Encoding::BINARY) result = "\xFF\xFF" result.force_encoding(Encoding::BINARY) out = render(source, default_encoding: 'binary') out.force_encoding(Encoding::BINARY) assert_equal result, out end def test_bom source = "\xEF\xBB\xBFh1 Hello World!" result = '
Hello World!
' assert_html result, source end end slim-3.0.7/test/core/test_code_output.rb 0000644 0000041 0000041 00000005675 12727176366 020400 0 ustar www-data www-data require 'helper' class TestSlimCodeOutput < TestSlim def test_render_with_call source = %q{ p = hello_world } assert_html 'Hello World from @env
', source end def test_render_with_trailing_whitespace source = %q{ p =' hello_world } assert_html 'Hello World from @env
', source end def test_render_with_trailing_whitespace_after_tag source = %q{ p=' hello_world } assert_html 'Hello World from @env
', source end def test_no_escape_render_with_trailing_whitespace source = %q{ p ==' hello_world } assert_html 'Hello World from @env
', source end def test_no_escape_render_with_trailing_whitespace_after_tag source = %q{ p==' hello_world } assert_html 'Hello World from @env
', source end def test_render_with_conditional_call source = %q{ p = hello_world if true } assert_html 'Hello World from @env
', source end def test_render_with_parameterized_call source = %q{ p = hello_world("Hello Ruby!") } assert_html 'Hello Ruby!
', source end def test_render_with_spaced_parameterized_call source = %q{ p = hello_world "Hello Ruby!" } assert_html 'Hello Ruby!
', source end def test_render_with_spaced_parameterized_call_2 source = %q{ p = hello_world "Hello Ruby!", dummy: "value" } assert_html 'Hello Ruby!dummy value
', source end def test_render_with_call_and_inline_text source = %q{ h1 This is my title p = hello_world } assert_html 'This is my title
Hello World from @env
', source end def test_render_with_attribute_starts_with_keyword source = %q{ p = hello_world in_keyword } assert_html 'starts with keyword
', source end def test_hash_call source = %q{ p = hash[:a] } assert_html 'The letter a
', source end def test_tag_output_without_space source = %q{ p= hello_world p=hello_world } assert_html 'Hello World from @env
Hello World from @env
', source end def test_class_output_without_space source = %q{ .test=hello_world #test==hello_world } assert_html 'Hello World from @env
Hello World from @env
', source
end
def test_attribute_output_without_space
source = %q{
p id="test"=hello_world
p(id="test")==hello_world
}
assert_html 'Hello World from @env
Hello World from @env
', source end def test_render_with_backslash_end # Keep trailing spaces! source = %q{ p = \ "Hello" + \ " Ruby!" - variable = 1 + \ 2 + \ 3 = variable + \ 1 } assert_html 'Hello Ruby!
7', source end def test_render_with_comma_end source = %q{ p = message("Hello", "Ruby!") } assert_html 'Hello Ruby!
', source end def test_render_with_no_trailing_character source = %q{ p = hello_world} assert_html 'Hello World from @env
', source end end slim-3.0.7/test/core/test_parser_errors.rb 0000644 0000041 0000041 00000006762 12727176366 020734 0 ustar www-data www-data require 'helper' class TestParserErrors < TestSlim def test_correct_filename source = %q{ doctype 5 div Invalid } assert_syntax_error "Unexpected indentation\n test.slim, Line 3, Column 2\n div Invalid\n ^\n", source, file: 'test.slim' end def test_unexpected_indentation source = %q{ doctype 5 div Invalid } assert_syntax_error "Unexpected indentation\n (__TEMPLATE__), Line 3, Column 2\n div Invalid\n ^\n", source end def test_malformed_indentation source = %q{ p div Valid div Invalid } assert_syntax_error "Malformed indentation\n (__TEMPLATE__), Line 4, Column 1\n div Invalid\n ^\n", source end def test_malformed_indentation2 source = %q{ div Valid div Invalid } assert_syntax_error "Malformed indentation\n (__TEMPLATE__), Line 3, Column 1\n div Invalid\n ^\n", source end def test_unknown_line_indicator source = %q{ p div Valid .valid #valid ?invalid } assert_syntax_error "Unknown line indicator\n (__TEMPLATE__), Line 6, Column 2\n ?invalid\n ^\n", source end def test_expected_closing_delimiter source = %q{ p img(src="img.jpg" title={title} } assert_syntax_error "Expected closing delimiter )\n (__TEMPLATE__), Line 3, Column 33\n img(src=\"img.jpg\" title={title}\n ^\n", source end def test_missing_quote_unexpected_end source = %q{ p img(src="img.jpg } assert_syntax_error "Unexpected end of file\n (__TEMPLATE__), Line 3, Column 0\n \n ^\n", source end def test_expected_closing_attribute_delimiter source = %q{ p img src=[hash[1] + hash[2] } assert_syntax_error "Expected closing delimiter ]\n (__TEMPLATE__), Line 3, Column 28\n img src=[hash[1] + hash[2]\n ^\n", source end def test_invalid_empty_attribute source = %q{ p img{src= } } assert_syntax_error "Invalid empty attribute\n (__TEMPLATE__), Line 3, Column 11\n img{src= }\n ^\n", source end def test_invalid_empty_attribute2 source = %q{ p img{src=} } assert_syntax_error "Invalid empty attribute\n (__TEMPLATE__), Line 3, Column 10\n img{src=}\n ^\n", source end def test_invalid_empty_attribute3 source = %q{ p img src= } assert_syntax_error "Invalid empty attribute\n (__TEMPLATE__), Line 3, Column 10\n img src=\n ^\n", source end def test_missing_tag_in_block_expansion source = %{ html: body: } assert_syntax_error "Expected tag\n (__TEMPLATE__), Line 2, Column 11\n html: body:\n ^\n", source end def test_invalid_tag_in_block_expansion source = %{ html: body: /comment } assert_syntax_error "Expected tag\n (__TEMPLATE__), Line 2, Column 12\n html: body: /comment\n ^\n", source source = %{ html: body:/comment } assert_syntax_error "Expected tag\n (__TEMPLATE__), Line 2, Column 11\n html: body:/comment\n ^\n", source end def test_unexpected_text_after_closed source = %{ img / text } assert_syntax_error "Unexpected text after closed tag\n (__TEMPLATE__), Line 2, Column 6\n img / text\n ^\n", source end def test_illegal_shortcuts source = %{ .#test } assert_syntax_error "Illegal shortcut\n (__TEMPLATE__), Line 2, Column 0\n .#test\n ^\n", source source = %{ div.#test } assert_syntax_error "Illegal shortcut\n (__TEMPLATE__), Line 2, Column 3\n div.#test\n ^\n", source end end slim-3.0.7/test/core/test_code_evaluation.rb 0000644 0000041 0000041 00000011050 12727176366 021167 0 ustar www-data www-data require 'helper' class TestSlimCodeEvaluation < TestSlim def test_render_with_call_to_set_attributes source = %q{ p id="#{id_helper}" class="hello world" = hello_world } assert_html 'Hello World from @env
', source end def test_render_with_call_to_set_custom_attributes source = %q{ p data-id="#{id_helper}" data-class="hello world" = hello_world } assert_html 'Hello World from @env
', source end def test_render_with_call_to_set_attributes_and_call_to_set_content source = %q{ p id="#{id_helper}" class="hello world" = hello_world } assert_html 'Hello World from @env
', source end def test_render_with_parameterized_call_to_set_attributes_and_call_to_set_content source = %q{ p id="#{id_helper}" class="hello world" = hello_world("Hello Ruby!") } assert_html 'Hello Ruby!
', source end def test_render_with_spaced_parameterized_call_to_set_attributes_and_call_to_set_content source = %q{ p id="#{id_helper}" class="hello world" = hello_world "Hello Ruby!" } assert_html 'Hello Ruby!
', source end def test_render_with_spaced_parameterized_call_to_set_attributes_and_call_to_set_content_2 source = %q{ p id="#{id_helper}" class="hello world" = hello_world "Hello Ruby!", dummy: "value" } assert_html 'Hello Ruby!dummy value
', source end def test_hash_call_in_attribute source = %q{ p id="#{hash[:a]}" Test it } assert_html 'Test it
', source end def test_instance_variable_in_attribute_without_quotes source = %q{ p id=@var } assert_html '', source end def test_method_call_in_attribute_without_quotes source = %q{ form action=action_path(:page, :save) method='post' } assert_html '', source end def test_ruby_attribute_with_unbalanced_delimiters source = %q{ div crazy=action_path('[') id="crazy_delimiters" } assert_html '', source end def test_method_call_in_delimited_attribute_without_quotes source = %q{ form(action=action_path(:page, :save) method='post') } assert_html '', source end def test_method_call_in_delimited_attribute_without_quotes2 source = %q{ form(method='post' action=action_path(:page, :save)) } assert_html '', source end def test_hash_call_in_attribute_without_quotes source = %q{ p id=hash[:a] Test it } assert_html 'Test it
', source end def test_hash_call_in_delimited_attribute source = %q{ p(id=hash[:a]) Test it } assert_html 'Test it
', source end def test_hash_call_in_attribute_with_ruby_evaluation source = %q{ p id=(hash[:a] + hash[:a]) Test it } assert_html 'Test it
', source end def test_hash_call_in_delimited_attribute_with_ruby_evaluation source = %q{ p(id=(hash[:a] + hash[:a])) Test it } assert_html 'Test it
', source end def test_hash_call_in_delimited_attribute_with_ruby_evaluation_2 source = %q{ p[id=(hash[:a] + hash[:a])] Test it } assert_html 'Test it
', source end def test_hash_call_in_delimited_attribute_with_ruby_evaluation_3 source = %q{ p(id=(hash[:a] + hash[:a]) class=hash[:a]) Test it } assert_html 'Test it
', source end def test_hash_call_in_delimited_attribute_with_ruby_evaluation_4_ source = %q{ p(id=hash[:a] class=hash[:a]) Test it } assert_html 'Test it
', source end def test_computation_in_attribute source = %q{ p id=(1 + 1)*5 Test it } assert_html 'Test it
', source end def test_code_attribute_does_not_modify_argument template = 'span class=attribute' model = OpenStruct.new(attribute: [:a, :b, [:c, :d]]) output = Slim::Template.new { template }.render(model) assert_equal('', output) assert_equal([:a, :b, [:c, :d]], model.attribute) end def test_number_type_interpolation source = %q{ p = output_number } assert_html '1337
', source end end slim-3.0.7/test/core/test_html_attributes.rb 0000644 0000041 0000041 00000014451 12727176366 021250 0 ustar www-data www-data require 'helper' class TestSlimHTMLAttributes < TestSlim def test_ternary_operation_in_attribute source = %q{ p id="#{(false ? 'notshown' : 'shown')}" = output_number } assert_html '1337
', source end def test_ternary_operation_in_attribute_2 source = %q{ p id=(false ? 'notshown' : 'shown') = output_number } assert_html '1337
', source end def test_class_attribute_merging source = %{ .alpha class="beta" Test it } assert_html 'Test it
', source
end
def test_class_attribute_merging_with_nil
source = %{
.alpha class="beta" class=nil class="gamma" Test it
}
assert_html 'Test it
', source
end
def test_class_attribute_merging_with_empty_static
source = %{
.alpha class="beta" class="" class="gamma" Test it
}
assert_html 'Test it
', source
end
def test_id_attribute_merging
source = %{
#alpha id="beta" Test it
}
assert_html 'Test it
', source, merge_attrs: {'class' => ' ', 'id' => '_' }
end
def test_id_attribute_merging2
source = %{
#alpha id="beta" Test it
}
assert_html 'Test it
', source, merge_attrs: {'class' => ' ', 'id' => '-' }
end
def test_boolean_attribute_false
source = %{
- cond=false
option selected=false Text
option selected=cond Text2
}
assert_html '', source
end
def test_boolean_attribute_true
source = %{
- cond=true
option selected=true Text
option selected=cond Text2
}
assert_html '', source
end
def test_boolean_attribute_nil
source = %{
- cond=nil
option selected=nil Text
option selected=cond Text2
}
assert_html '', source
end
def test_boolean_attribute_string2
source = %{
option selected="selected" Text
}
assert_html '', source
end
def test_boolean_attribute_shortcut
source = %{
option(class="clazz" selected) Text
option(selected class="clazz") Text
}
assert_html '', source
end
def test_array_attribute_merging
source = %{
.alpha class="beta" class=[[""], :gamma, nil, :delta, [true, false]]
.alpha class=:beta,:gamma
}
assert_html '', source
end
def test_hyphenated_attribute
source = %{
.alpha data={a: 'alpha', b: 'beta', c_d: 'gamma', c: {e: 'epsilon'}}
}
assert_html '', source
end
def test_splat_without_content
source = %q{
*hash
p*hash
}
assert_html '', source
end
def test_shortcut_splat
source = %q{
*hash This is my title
}
assert_html 'This is my title
', source
end
def test_splat
source = %q{
h1 *hash class=[] This is my title
}
assert_html 'This is my title
', source end def test_closed_splat source = %q{ *hash / } assert_html '', source end def test_splat_tag_name source = %q{ *{tag: 'h1', id: 'title'} This is my title } assert_html 'This is my title
', source end def test_splat_empty_tag_name source = %q{ *{tag: '', id: 'test'} This is my title } assert_html 'This is my title
', source
end
def test_closed_splat_tag
source = %q{
*hash /
}
assert_html '', source
end
def test_splat_with_id_shortcut
source = %q{
#myid*hash This is my title
}
assert_html 'This is my title
', source
end
def test_splat_with_class_shortcut
source = %q{
.myclass*hash This is my title
}
assert_html 'This is my title
', source
end
def test_splat_with_id_and_class_shortcuts
source = %q{
#myid.myclass*hash This is my title
}
assert_html 'This is my title
', source
end
def test_splat_with_class_merging
source = %q{
#myid.myclass *{class: [:secondclass, %w(x y z)]} *hash This is my title
}
assert_html 'This is my title
', source
end
def test_splat_with_boolean_attribute
source = %q{
*{disabled: true, empty1: false, nonempty: '', empty2: nil} This is my title
}
assert_html 'This is my title
', source
end
def test_splat_merging_with_arrays
source = %q{
*{a: 1, b: 2} *[[:c, 3], [:d, 4]] *[[:e, 5], [:f, 6]] This is my title
}
assert_html 'This is my title
', source
end
def test_splat_with_other_attributes
source = %q{
h1 data-id="123" *hash This is my title
}
assert_html 'This is my title
', source end def test_attribute_merging source = %q{ a class=true class=false a class=false *{class:true} a class=true a class=false } assert_html '', source end def test_static_empty_attribute source = %q{ p(id="marvin" name="" class="" data-info="Illudium Q-36")= output_number } assert_html '1337
', source end def test_dynamic_empty_attribute source = %q{ p(id="marvin" class=nil nonempty=("".to_s) data-info="Illudium Q-36")= output_number } assert_html '1337
', source end def test_weird_attribute source = %q{ p img(src='img.png' whatsthis?!) img src='img.png' whatsthis?!="wtf" } assert_html '
<script>do_something_evil();</script>
', source end def test_render_without_html_safe source = %q{ p = "Hello World\\n, meet \\"Slim\\"." } assert_html "<strong>Hello World\n, meet \"Slim\"</strong>.
", source end def test_render_without_html_safe2 source = %q{ p = "Hello World\\n, meet 'Slim'." } assert_html "<strong>Hello World\n, meet 'Slim'</strong>.
", source end def test_render_with_html_safe_false source = %q{ p = "Hello World\\n, meet \\"Slim\\"." } with_html_safe do assert_html "<strong>Hello World\n, meet \"Slim\"</strong>.
", source, use_html_safe: true end end def test_render_with_html_safe_true source = %q{ p = "Hello World\\n, meet \\"Slim\\".".html_safe } with_html_safe do assert_html "Hello World\n, meet \"Slim\".
", source, use_html_safe: true end end def test_render_splat_with_html_safe_true source = %q{ p *{ title: '&'.html_safe } } with_html_safe do assert_html "", source, use_html_safe: true end end def test_render_splat_with_html_safe_false source = %q{ p *{ title: '&' } } with_html_safe do assert_html "", source, use_html_safe: true end end def test_render_attribute_with_html_safe_true source = %q{ p title=('&'.html_safe) } with_html_safe do assert_html "", source, use_html_safe: true end end def test_render_with_disable_escape_false source = %q{ = "Hello
" == "World
" } assert_html "<p>Hello</p>World
", source end def test_render_with_disable_escape_true source = %q{ = "Hello
" == "World
" } assert_html "Hello
World
", source, disable_escape: true end def test_escaping_evil_method_with_pretty source = %q{ p = evil_method } assert_html "\n <script>do_something_evil();</script>\n
", source, pretty: true end def test_render_without_html_safe_with_pretty source = %q{ p = "Hello World\\n, meet \\"Slim\\"." } assert_html "\n <strong>Hello World\n , meet \"Slim\"</strong>.\n
", source, pretty: true end def test_render_with_html_safe_false_with_pretty source = %q{ p = "Hello World\\n, meet \\"Slim\\"." } with_html_safe do assert_html "\n <strong>Hello World\n , meet \"Slim\"</strong>.\n
", source, use_html_safe: true, pretty: true end end def test_render_with_html_safe_true_with_pretty source = %q{ p = "Hello World\\n, meet \\"Slim\\".".html_safe } with_html_safe do assert_html "\n Hello World\n , meet \"Slim\".\n
", source, use_html_safe: true, pretty: true end end def test_render_with_disable_escape_false_with_pretty source = %q{ = "Hello
" == "World
" } assert_html "<p>Hello</p>World
", source, pretty: true end def test_render_with_disable_escape_true_with_pretty source = %q{ = "Hello
" == "World
" } assert_html "Hello
World
", source, disable_escape: true, pretty: true end end slim-3.0.7/test/core/test_slim_template.rb 0000644 0000041 0000041 00000004114 12727176366 020670 0 ustar www-data www-data require 'helper' class ::MockError < NameError end class TestSlimTemplate < TestSlim def test_default_mime_type assert_equal 'text/html', Slim::Template.default_mime_type end def test_registered_extension assert_equal Slim::Template, Tilt['test.slim'] end def test_preparing_and_evaluating template = Slim::Template.new { |t| "p Hello World!\n" } assert_equal "Hello World!
", template.render end def test_evaluating_in_an_object_scope template = Slim::Template.new { "p = 'Hey ' + @name + '!'\n" } scope = Object.new scope.instance_variable_set :@name, 'Joe' assert_equal "Hey Joe!
", template.render(scope) end def test_passing_a_block_for_yield template = Slim::Template.new { "p = 'Hey ' + yield + '!'\n" } assert_equal "Hey Joe!
", template.render { 'Joe' } end def test_backtrace_file_and_line_reporting_without_locals data = File.read(__FILE__).split("\n__END__\n").last fail unless data[0] == ?h template = Slim::Template.new('test.slim', 10) { data } begin template.render fail 'should have raised an exception' rescue => ex assert_kind_of NameError, ex assert_backtrace(ex, 'test.slim:12') end end def test_backtrace_file_and_line_reporting_with_locals data = File.read(__FILE__).split("\n__END__\n").last fail unless data[0] == ?h template = Slim::Template.new('test.slim') { data } begin res = template.render(Object.new, name: 'Joe', foo: 'bar') rescue => ex assert_kind_of MockError, ex assert_backtrace(ex, 'test.slim:5') end end def test_compiling_template_source_to_a_method template = Slim::Template.new { |t| "Hello World!" } template.render method = template.send(:compiled_method, []) assert_kind_of UnboundMethod, method end def test_passing_locals template = Slim::Template.new { "p = 'Hey ' + name + '!'\n" } assert_equal "Hey Joe!
", template.render(Object.new, name: 'Joe') end end __END__ html body h1 = "Hey #{name}" = raise MockError p we never get here slim-3.0.7/test/core/test_code_structure.rb 0000644 0000041 0000041 00000005636 12727176366 021075 0 ustar www-data www-data require 'helper' class TestSlimCodeStructure < TestSlim def test_render_with_conditional source = %q{ div - if show_first? p The first paragraph - else p The second paragraph } assert_html 'The second paragraph
A
B
C
', source end def test_render_with_consecutive_conditionals source = %q{ div - if show_first? true p The first paragraph - if show_first? true p The second paragraph } assert_html 'The first paragraph
The second paragraph
The second paragraph
The first paragraph
42Hello World from @env
', source end def test_render_with_case source = %q{ p - case 42 - when 41 | 41 - when 42 | 42 | is the answer p - case 41 - when 41 | 41 - when 42 | 42 | is the answer p - case 42 when 41 | 41 - when 42 | 42 | is the answer p - case 41 when 41 | 41 - when 42 | 42 | is the answer } assert_html '42 is the answer
41 is the answer
42 is the answer
41 is the answer
', source end def test_render_with_slim_comments source = %q{ p Hello / This is a comment Another comment p World } assert_html 'Hello
World
', source end def test_render_with_yield source = %q{ div == yield :menu } assert_html 'This is the menu
', source do
'This is the menu'
end
end
def test_render_with_begin_rescue
source = %q{
- begin
p Begin
- rescue
p Rescue
p After
}
assert_html 'Begin
After
', source end def test_render_with_begin_rescue_exception source = %q{ - begin p Begin - raise 'Boom' p After Boom - rescue => ex p = ex.message p After } assert_html 'Begin
Boom
After
', source end def test_render_with_begin_rescue_ensure source = %q{ - begin p Begin - raise 'Boom' p After Boom - rescue => ex p = ex.message - ensure p Ensure p After } assert_html 'Begin
Boom
Ensure
After
', source end end slim-3.0.7/test/core/test_unicode.rb 0000644 0000041 0000041 00000000633 12727176366 017461 0 ustar www-data www-data # -*- coding: utf-8 -*- require 'helper' class TestSlimUnicode < TestSlim def test_unicode_tags source = "Статья года" result = "<Статья>года" assert_html result, source end def test_unicode_attrs source = "Статья года=123 content" result = "<Статья года=\"123\">content" assert_html result, source end end slim-3.0.7/test/literate/ 0000755 0000041 0000041 00000000000 12727176366 015326 5 ustar www-data www-data slim-3.0.7/test/literate/helper.rb 0000644 0000041 0000041 00000000704 12727176366 017133 0 ustar www-data www-data require 'slim' require 'slim/logic_less' require 'slim/translator' require 'slim/grammar' require 'minitest/autorun' Slim::Engine.after Slim::Parser, Temple::Filters::Validator, grammar: Slim::Grammar Slim::Engine.before :Pretty, Temple::Filters::Validator Slim::Engine.set_options tr: false, logic_less: false class MiniTest::Spec def render(source, options = {}, &block) Slim::Template.new(options) { source }.render(self, &block) end end slim-3.0.7/test/literate/run.rb 0000644 0000041 0000041 00000004624 12727176366 016465 0 ustar www-data www-data require 'temple' class LiterateTest < Temple::Engine class Parser < Temple::Parser def call(lines) stack = [[:multi]] until lines.empty? case lines.shift when /\A(#+)\s*(.*)\Z/ stack.pop(stack.size - $1.size) block = [:multi] stack.last << [:section, $2, block] stack << block when /\A~{3,}\s*(\w+)\s*\Z/ lang = $1 code = [] until lines.empty? case lines.shift when /\A~{3,}\s*\Z/ break when /\A.*\Z/ code << $& end end stack.last << [lang.to_sym, code.join("\n")] when /\A\s*\Z/ when /\A\s*(.*?)\s*Z/ stack.last << [:comment, $1] end end stack.first end end class Compiler < Temple::Filter def call(exp) @opts, @in_testcase = {}, false "require 'helper'\n\n#{compile(exp)}" end def on_section(title, body) old_opts = @opts.dup raise Temple::FilterError, 'New section between slim and html block' if @in_testcase "describe #{title.inspect} do\n #{compile(body).gsub("\n", "\n ")}\nend\n" ensure @opts = old_opts end def on_multi(*exps) exps.map {|exp| compile(exp) }.join("\n") end def on_comment(text) "#{@in_testcase ? ' ' : ''}# #{text}" end def on_slim(code) raise Temple::FilterError, 'Slim block must be followed by html block' if @in_testcase @in_testcase = true "it 'should render' do\n slim = #{code.inspect}" end def on_html(code) raise Temple::FilterError, 'Html block must be preceded by slim block' unless @in_testcase @in_testcase = false result = " html = #{code.inspect}\n" if @opts.empty? result << " render(slim).must_equal html\nend\n" else result << " options = #{@opts.inspect}\n render(slim, options).must_equal html\nend\n" end end def on_options(code) raise Temple::FilterError, 'Options set inside test case' if @in_testcase @opts.update(eval("{#{code}}")) "# #{code.gsub("\n", "\n# ")}" end def on(*exp) raise Temple::InvalidExpression, exp end end use Parser use Compiler use(:Evaluator) {|code| eval(code) } end Dir.glob(File.join(File.dirname(__FILE__), '*.md')) do |file| LiterateTest.new.call(File.readlines(file)) end slim-3.0.7/test/literate/TESTS.md 0000644 0000041 0000041 00000046445 12727176366 016567 0 ustar www-data www-data # Slim test suite You can run this testsuite with `rake test:literate`. We use pretty mode in the test suite to make the output more readable. Pretty mode is enabled by setting the option ~~~ options :pretty => true ~~~ ## Line indicators In this section we test all line indicators. ### Text `|` A text blocks starts with the `|` as line indicator. ~~~ slim | Text block ~~~ renders as ~~~ html Text block ~~~ Multiple lines can be indented beneath the first text line. ~~~ slim | Text block with multiple lines ~~~ renders as ~~~ html Text block with multiple lines ~~~ The first line of a text block determines the indentation. ~~~ slim | Text block with multiple lines ~~~ renders as ~~~ html Text block with multiple lines ~~~ You can nest text blocks beneath tags. ~~~ slim body | Text ~~~ renders as ~~~ html Text ~~~ You can embed html code in the text which is not escaped. ~~~ slim | slim-lang.com ~~~ renders as ~~~ html slim-lang.com ~~~ ### Text with trailing white space `'` A text blocks with trailing white space starts with the `'` as line indicator. ~~~ slim ' Text block ~~~ renders as ~~~ html Text block ~~~ This is especially useful if you use tags behind a text block. ~~~ slim ' Link to a href="http://slim-lang.com" slim-lang.com ~~~ renders as ~~~ html Link to slim-lang.com ~~~ Multiple lines can be indented beneath the first text line. ~~~ slim ' Text block with multiple lines ~~~ renders as ~~~ html Text block with multiple lines ~~~ The first line of a text block determines the indentation. ~~~ slim ' Text block with multiple lines ~~~ renders as ~~~ html Text block with multiple lines ~~~ ### Inline HTML `<` HTML can be written directly. ~~~ slim slim-lang.com ~~~ renders as ~~~ html slim-lang.com ~~~ HTML tags allow nested blocks inside. ~~~ slim title Example body - if true | yes - else | no ~~~ renders as ~~~ html| table | 10 |
| chair | 5 |
| table | 10 |
| chair | 5 |
Hello!
~~~ ### HTML comment `/!` Code comments begin with `/!`. ~~~ slim /! Comment body /! Another comment with multiple lines p Hello! /! First line determines indentation of the comment ~~~ renders as ~~~ htmlHello!
~~~ ### IE conditional comment `/[...]` ~~~ slim /[if IE] p Get a better browser. ~~~ renders as ~~~ html ~~~ ## HTML tags ### Doctype tags The doctype tag is a special tag which can be used to generate the complex doctypes in a very simple way. You can output the XML version using the doctype tag. ~~~ slim doctype xml doctype xml ISO-8859-1 ~~~ renders as ~~~ html ~~~ In XHTML mode the following doctypes are supported: ~~~ slim doctype html doctype 5 doctype 1.1 doctype strict doctype frameset doctype mobile doctype basic doctype transitional ~~~ renders as ~~~ html ~~~ If we activate HTML mode with the option ~~~ options :format => :html ~~~ the following doctypes are supported: ~~~ slim doctype html doctype 5 doctype strict doctype frameset doctype transitional ~~~ renders as ~~~ html ~~~ ### Closed tags You can close tags explicitly by appending a trailing `/`. ~~~ slim div id="not-closed" .closed/ #closed/ div id="closed"/ ~~~ renders as ~~~ html ~~~ Note, that this is usually not necessary since the standard html tags (img, br, ...) are closed automatically. ~~~ slim img src="image.png" ~~~ renders as ~~~ html
~~~
### Trailing and leading whitespace
You can force a trailing whitespace behind a tag by adding `>`. The legacy syntax with `'` is also supported.
~~~ slim
a#closed> class="test" /
a#closed> class="test"/
a> href='url1' Link1
a< href='url1' Link1
a' href='url2' Link2
~~~
renders as
~~~ html
Link1 Link1Link2
~~~
If you combine > and =' only one trailing whitespace is added.
~~~ slim
a> =' 'Text1'
a =' 'Text2'
a> = 'Text3'
a>= 'Text4'
a=> 'Text5'
a<= 'Text6'
a=< 'Text7'
~~~
renders as
~~~ html
Text1 Text2 Text3 Text4 Text5 Text6 Text7
~~~
You can force a leading whitespace before a tag by adding `<`.
~~~ slim
a#closed< class="test" /
a#closed< class="test"/
a< href='url1' Link1
a< href='url2' Link2
~~~
~~~ html
Link1 Link2
~~~
You can also combine both.
~~~ slim
a#closed<> class="test" /
a#closed>< class="test"/
a<> href='url1' Link1
a<> href='url2' Link2
~~~
~~~ html
Link1 Link2
~~~
### Inline tags
Sometimes you may want to be a little more compact and inline the tags.
~~~ slim
ul
li.first: a href="/first" First
li: a href="/second" Second
~~~
renders as
~~~ html
~~~
For readability, don't forget you can wrap the attributes.
~~~ slim
ul
li.first: a(href="/first") First
li: a(href="/second") Second
~~~
renders as
~~~ html
~~~
### Text content
### Dynamic content `=`
### Attributes
#### Attribute wrapper
If a delimiter makes the syntax more readable for you, you can use the characters `{...}`, `(...)`, `[...]` to wrap the attributes.
~~~ slim
li
a(href="http://slim-lang.com" class="important") Link
li
a[href="http://slim-lang.com" class="important"] Link
li
a{href="http://slim-lang.com" class="important"} Link
~~~
renders as
~~~ html
Logo
Tagline
~~~ #### Quoted attributes You can use single or double quotes for simple text attributes. ~~~ slim a href="http://slim-lang.com" title='Slim Homepage' Goto the Slim homepage ~~~ renders as ~~~ html Goto the Slim homepage ~~~ You can use text interpolation in the quoted attributes: ~~~ slim - url='slim-lang.com' a href="http://#{url}" Goto the #{url} a href="{"test"}" Test of quoted text in braces ~~~ renders as ~~~ html Goto the slim-lang.comTest of quoted text in braces ~~~ The attribute value will be escaped by default. Use == if you want to disable escaping in the attribute. ~~~ slim li a href='&' Link li a href=="&" Link ~~~ renders as ~~~ html
text
text
text
text
~~~
## Text interpolation
Use standard Ruby interpolation. The text will be html escaped by default.
~~~ slim
- user="John Doe Welcome John Doe <john@doe.net>!
~~~ ## Pretty printing of XML We can enable XML mode with ~~~ options :format => :xml ~~~ ~~~ slim doctype xml document closed-element/ element(boolean-attribute) child attribute="value" | content ~~~ ~~~ htmlA
B
C
D
E
FG H
I} assert_html result, source end def test_multi_line_smart_text source = %q{ p First line. Second line. Third line with a continuation and one more. Fourth line. } result = %q{First line. Second line. Third line with a continuation and one more. Fourth line.
} assert_html result, source end def test_smart_text_escaping source = %q{ | Not escaped <&>. p Escaped <&>. p Escaped <&>. > Escaped <&>. Protected & < > © Á. Protected ÿ. Escaped &#xx; f; &9; &_; &;. } result = %q{Not escaped <&>.Escaped <&>.
Escaped <&>. Escaped <&>. Protected & < > © Á. Protected ÿ. Escaped &#xx; f; &9; &_; &;.
} assert_html result, source end def test_smart_text_disabled_escaping Slim::Engine.with_options( smart_text_escaping: false ) do source = %q{ p Not escaped <&>. | Not escaped <&>. p Not escaped <&>. > Not escaped <&>. Not escaped & < > © Á. Not escaped ÿ. Not escaped &#xx; f; &9; &_; &;. } result = %q{Not escaped <&>.
Not escaped <&>.Not escaped <&>. Not escaped <&>. Not escaped & < > © Á. Not escaped ÿ. Not escaped &#xx; f; &9; &_; &;.
} assert_html result, source end end def test_smart_text_in_tag_escaping source = %q{ p Escaped <&>. Protected & < > © Á. Protected ÿ. Escaped &#xx; f; &9; &_; &;. } result = %q{Escaped <&>. Protected & < > © Á. Protected ÿ. Escaped &#xx; f; &9; &_; &;.
} assert_html result, source end def test_smart_text_mixed_with_tags source = %q{ p Text br >is strong really > recognized. More b text . And i more ... span Really ?!? .bold Really !!! #id #{'Good'} ! } result = %q{Text
is
really
recognized.
More
text.
And
more...
Really?!?
Really
!!!
Good
!}
assert_html result, source
end
def test_smart_text_mixed_with_links
source = %q{
p
Text with
a href="#1" link
.
Text with
a href="#2" another
link
> to somewhere else.
a href="#3"
This link
> goes
elsewhere.
See (
a href="#4" link
)?
}
result = %q{Text with link. Text with another link to somewhere else. This link goes elsewhere. See (link)?
} assert_html result, source end def test_smart_text_mixed_with_code source = %q{ p Try a list ul - 2.times do |i| li Item: #{i} > which stops b here . Right? } result = %q{Try a list
- Item: 0
- Item: 1
是 čip Čip Žůžo šíp
} assert_html result, source end def test_unicode_smart_text source = %q{ p 是 čip Čip Žůžo šíp .řek . } result = %q{是 čip Čip Žůžo šíp
.
}
assert_html result, source
end
end
slim-3.0.7/test/translator/ 0000755 0000041 0000041 00000000000 12727176366 015706 5 ustar www-data www-data slim-3.0.7/test/translator/test_translator.rb 0000644 0000041 0000041 00000005034 12727176366 021465 0 ustar www-data www-data require 'helper'
require 'slim/translator'
class TestSlimTranslator < TestSlim
def setup
super
Slim::Engine.set_options tr: true, tr_fn: 'TestSlimTranslator.tr'
end
def self.tr(s)
s.upcase
end
def self.tr_reverse(s)
s.reverse.gsub(/(\d+)%/, '%\1')
end
def test_no_translation_of_embedded
source = %q{
markdown:
#Header
Hello from #{"Markdown!"}
#{1+2}
* one
* two
}
case Tilt['md'].name.downcase
when /redcarpet/
assert_html "Header
\n\nHello from Markdown!
\n\n3
\n\n- \n
- one \n
- two \n
Header
\n\nHello from Markdown!
\n\n3
\n\n- \n
- one \n
- two \n
Header
\n\nHello from Markdown!
\n\n3
\n\n- \n
- one \n
- two \n
Header
\n\nHello from Markdown!
\n\n3
\n\n- \n
- one \n
- two \n
Header
\nHello from Markdown!
\n\n3
\n\n- \n
- one \n
- two \n
Header
\nHello from Markdown!
\n\n3
\n\n- \n
- one \n
- two \n
translate Hello World from @env this\nsecond line\nthird 3 line
", source, tr: false assert_html "TRANSLATE Hello World from @env THIS\nSECOND LINE\nTHIRD 3 LINE
", source, tr_mode: :dynamic assert_html "TRANSLATE Hello World from @env THIS\nSECOND LINE\nTHIRD 3 LINE
", source, tr_mode: :static end def test_translation_reverse source = %q{ ' alpha #{1} beta #{2} gamma #{3} } assert_html "3 ammag 2 ateb 1 ahpla ", source, tr_mode: :dynamic, tr_fn: 'TestSlimTranslator.tr_reverse' assert_html "3 ammag 2 ateb 1 ahpla ", source, tr_mode: :static, tr_fn: 'TestSlimTranslator.tr_reverse' end end slim-3.0.7/test/rails/ 0000755 0000041 0000041 00000000000 12727176366 014627 5 ustar www-data www-data slim-3.0.7/test/rails/Rakefile 0000644 0000041 0000041 00000000411 12727176366 016270 0 ustar www-data www-data # Add your own tasks in files placed in lib/tasks ending in .rake, # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. require File.expand_path('../config/application', __FILE__) require 'rake' Dummy::Application.load_tasks slim-3.0.7/test/rails/script/ 0000755 0000041 0000041 00000000000 12727176366 016133 5 ustar www-data www-data slim-3.0.7/test/rails/script/rails 0000755 0000041 0000041 00000000447 12727176366 017200 0 ustar www-data www-data #!/usr/bin/env ruby # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application. APP_PATH = File.expand_path('../../config/application', __FILE__) require File.expand_path('../../config/boot', __FILE__) require 'rails/commands' slim-3.0.7/test/rails/test/ 0000755 0000041 0000041 00000000000 12727176366 015606 5 ustar www-data www-data slim-3.0.7/test/rails/test/test_slim.rb 0000644 0000041 0000041 00000005316 12727176366 020143 0 ustar www-data www-data require File.expand_path('../helper', __FILE__) class TestSlim < ActionDispatch::IntegrationTest test "normal view" do get "/slim/normal" assert_response :success assert_template "slim/normal" assert_template "layouts/application" assert_html "Hello Slim!
" end test "xml view" do get "/slim/xml" assert_response :success assert_template "slim/xml" assert_template "layouts/application" assert_html "Hello Slim!
" end test "helper" do get "/slim/helper" assert_response :success assert_template "slim/helper" assert_template "layouts/application" assert_html "Hello User
" end test "normal erb view" do get "/slim/erb" assert_html "Hello Erb!
" end test "view without a layout" do get "/slim/no_layout" assert_template "slim/no_layout" assert_html "Hello Slim without a layout!
", skip_layout: true end test "view with variables" do get "/slim/variables" assert_html "Hello Slim with variables!
" end test "partial view" do get "/slim/partial" assert_html "Hello Slim!
With a partial!
" end if RUBY_ENGINE == 'jruby' && RUBY_ENGINE < '2.2.0' puts 'Streaming test disabled for JRuby < 9000.', 'See https://github.com/jruby/jruby/issues/1243', 'and https://github.com/jruby/jruby/issues/1789' else puts 'Streaming test enabled.' test "streaming" do get "/slim/streaming" output = "2f\r\n\r\n53\r\n
\r\n0\r\n\r\n"
assert_equal output, @response.body
end
end
test "render integers" do
get "/slim/integers"
assert_html "Page content
Hello Streaming!
Hello Streaming!
\r\n14\r\n1337
" end test "render thread_options" do get "/slim/thread_options", attr: 'role' assert_html 'Test
' get "/slim/thread_options", attr: 'id' # Overwriting doesn't work because of caching assert_html 'Test
' end test "content_for" do get "/slim/content_for" assert_html "Page content
Hello Slim!
Hello Slim!
", heading: 'Heading set from a view' end test "form_for" do get "/entries/edit/1" assert_match %r{action="/entries"}, @response.body assert_match %r{}, @response.body assert_xpath '//input[@id="entry_name" and @name="entry[name]" and @type="text"]' end test "splat" do get "/slim/splat" assert_html "#{expected}
" unless options[:skip_layout]
assert_equal expected, @response.body
end
end
slim-3.0.7/test/rails/config/ 0000755 0000041 0000041 00000000000 12727176366 016074 5 ustar www-data www-data slim-3.0.7/test/rails/config/application.rb 0000644 0000041 0000041 00000003543 12727176366 020731 0 ustar www-data www-data require File.expand_path('../boot', __FILE__)
require 'active_model/railtie'
require 'action_controller/railtie'
require 'action_view/railtie'
#require 'active_record/railtie'
#require 'action_mailer/railtie'
require 'slim'
module Dummy
class Application < Rails::Application
# Settings in config/environments/* take precedence over those specified here.
# Application configuration should go into files in config/initializers
# -- all .rb files in that directory are automatically loaded.
# Custom directories with classes and modules you want to be autoloadable.
# config.autoload_paths += %W(#{config.root}/extras)
# Only load the plugins named here, in the order given (default is alphabetical).
# :all can be used as a placeholder for all plugins not explicitly named.
# config.plugins = [ :exception_notification, :ssl_requirement, :all ]
# Activate observers that should always be running.
# config.active_record.observers = :cacher, :garbage_collector, :forum_observer
# Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
# Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
# config.time_zone = 'Central Time (US & Canada)'
# The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
# config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
# config.i18n.default_locale = :de
# JavaScript files you want as :defaults (application.js is always included).
# config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
# Configure the default encoding used in templates for Ruby 1.9.
config.encoding = "utf-8"
# Configure sensitive parameters which will be filtered from the log file.
config.filter_parameters += [:password]
end
end
slim-3.0.7/test/rails/config/initializers/ 0000755 0000041 0000041 00000000000 12727176366 020602 5 ustar www-data www-data slim-3.0.7/test/rails/config/initializers/secret_token.rb 0000644 0000041 0000041 00000001034 12727176366 023612 0 ustar www-data www-data # Be sure to restart your server when you modify this file.
# Your secret key for verifying the integrity of signed cookies.
# If you change this key, all old signed cookies will become invalid!
# Make sure the secret is at least 30 characters and all random,
# no regular words or you'll be exposed to dictionary attacks.
Dummy::Application.config.secret_token = Dummy::Application.config.secret_key_base = '123a9119fb14a410f485f9390286b33f2743b9d348246cf3e4434522078f77c202d7a1fb7e42666dd0844bcb10d0ff3d8b4ee087796269d4c574837948512dbf'
slim-3.0.7/test/rails/config/initializers/session_store.rb 0000644 0000041 0000041 00000000627 12727176366 024033 0 ustar www-data www-data # Be sure to restart your server when you modify this file.
Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
# Use the database for sessions instead of the cookie-based default,
# which shouldn't be used to store highly confidential information
# (create the session table with "rails generate session_migration")
# Dummy::Application.config.session_store :active_record_store
slim-3.0.7/test/rails/config/initializers/mime_types.rb 0000644 0000041 0000041 00000000315 12727176366 023301 0 ustar www-data www-data # Be sure to restart your server when you modify this file.
# Add new mime types for use in respond_to blocks:
# Mime::Type.register "text/richtext", :rtf
# Mime::Type.register_alias "text/html", :iphone
slim-3.0.7/test/rails/config/initializers/backtrace_silencers.rb 0000644 0000041 0000041 00000000624 12727176366 025117 0 ustar www-data www-data # Be sure to restart your server when you modify this file.
# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
# Rails.backtrace_cleaner.remove_silencers!
slim-3.0.7/test/rails/config/initializers/inflections.rb 0000644 0000041 0000041 00000000570 12727176366 023446 0 ustar www-data www-data # Be sure to restart your server when you modify this file.
# Add new inflection rules using the following format
# (all these examples are active by default):
# ActiveSupport::Inflector.inflections do |inflect|
# inflect.plural /^(ox)$/i, '\1en'
# inflect.singular /^(ox)en/i, '\1'
# inflect.irregular 'person', 'people'
# inflect.uncountable %w( fish sheep )
# end
slim-3.0.7/test/rails/config/boot.rb 0000644 0000041 0000041 00000000417 12727176366 017366 0 ustar www-data www-data require 'rubygems'
gemfile = File.expand_path('../../../../../../Gemfile', __FILE__)
if File.exist?(gemfile)
ENV['BUNDLE_GEMFILE'] = gemfile
require 'bundler'
Bundler.setup(:default, :integration)
end
$:.unshift File.expand_path('../../../../../../lib', __FILE__) slim-3.0.7/test/rails/config/environments/ 0000755 0000041 0000041 00000000000 12727176366 020623 5 ustar www-data www-data slim-3.0.7/test/rails/config/environments/test.rb 0000644 0000041 0000041 00000002645 12727176366 022136 0 ustar www-data www-data Dummy::Application.configure do
# Settings specified here will take precedence over those in config/application.rb
# The test environment is used exclusively to run your application's
# test suite. You never need to work with it otherwise. Remember that
# your test database is "scratch space" for the test suite and is wiped
# and recreated between test runs. Don't rely on the data there!
config.cache_classes = true
# Show full error reports and disable caching
config.consider_all_requests_local = true
config.action_controller.perform_caching = false
# Raise exceptions instead of rendering exception templates
config.action_dispatch.show_exceptions = false
# Disable request forgery protection in test environment
config.action_controller.allow_forgery_protection = false
# Tell Action Mailer not to deliver emails to the real world.
# The :test delivery method accumulates sent emails in the
# ActionMailer::Base.deliveries array.
#config.action_mailer.delivery_method = :test
# Use SQL instead of Active Record's schema dumper when creating the test database.
# This is necessary if your schema can't be completely dumped by the schema dumper,
# like if you have constraints or database-specific column types
# config.active_record.schema_format = :sql
# Print deprecation notices to the stderr
config.active_support.deprecation = :stderr
config.eager_load = false
end
slim-3.0.7/test/rails/config/routes.rb 0000644 0000041 0000041 00000003402 12727176366 017741 0 ustar www-data www-data Dummy::Application.routes.draw do
# The priority is based upon order of creation:
# first created -> highest priority.
resources :entries
# Sample of regular route:
# match 'products/:id' => 'catalog#view'
# Keep in mind you can assign values other than :controller and :action
# Sample of named route:
# match 'products/:id/purchase' => 'catalog#purchase', as: :purchase
# This route can be invoked with purchase_url(id: product.id)
# Sample resource route (maps HTTP verbs to controller actions automatically):
# resources :products
# Sample resource route with options:
# resources :products do
# member do
# get 'short'
# post 'toggle'
# end
#
# collection do
# get 'sold'
# end
# end
# Sample resource route with sub-resources:
# resources :products do
# resources :comments, :sales
# resource :seller
# end
# Sample resource route with more complex sub-resources
# resources :products do
# resources :comments
# resources :sales do
# get 'recent', on: :collection
# end
# end
# Sample resource route within a namespace:
# namespace :admin do
# # Directs /admin/products/* to Admin::ProductsController
# # (app/controllers/admin/products_controller.rb)
# resources :products
# end
# You can have the root of your site routed with "root"
# just remember to delete public/index.html.
# root to: "welcome#index"
# See how all your routes lay out with "rake routes"
# This is a legacy wild controller route that's not recommended for RESTful applications.
# Note: This route will make all actions in every controller accessible via GET requests.
get ':controller(/:action(/:id(.:format)))'
end
slim-3.0.7/test/rails/config/environment.rb 0000644 0000041 0000041 00000000225 12727176366 020764 0 ustar www-data www-data # Load the rails application
require File.expand_path('../application', __FILE__)
# Initialize the rails application
Dummy::Application.initialize!
slim-3.0.7/test/rails/config/locales/ 0000755 0000041 0000041 00000000000 12727176366 017516 5 ustar www-data www-data slim-3.0.7/test/rails/config/locales/en.yml 0000644 0000041 0000041 00000000325 12727176366 020643 0 ustar www-data www-data # Sample localization file for English. Add more files in this directory for other locales.
# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
en:
hello: "Hello world"
slim-3.0.7/test/rails/app/ 0000755 0000041 0000041 00000000000 12727176366 015407 5 ustar www-data www-data slim-3.0.7/test/rails/app/views/ 0000755 0000041 0000041 00000000000 12727176366 016544 5 ustar www-data www-data slim-3.0.7/test/rails/app/views/entries/ 0000755 0000041 0000041 00000000000 12727176366 020215 5 ustar www-data www-data slim-3.0.7/test/rails/app/views/entries/edit.html.slim 0000644 0000041 0000041 00000000100 12727176366 022762 0 ustar www-data www-data = form_for @entry do |f|
label: b Name
= f.text_field :name
slim-3.0.7/test/rails/app/views/slim/ 0000755 0000041 0000041 00000000000 12727176366 017510 5 ustar www-data www-data slim-3.0.7/test/rails/app/views/slim/variables.html.slim 0000644 0000041 0000041 00000000012 12727176366 023302 0 ustar www-data www-data h1= @hello slim-3.0.7/test/rails/app/views/slim/form_for.html.slim 0000644 0000041 0000041 00000000060 12727176366 023146 0 ustar www-data www-data = form_for @entry do |f|
= f.text_field :name
slim-3.0.7/test/rails/app/views/slim/_partial.html.slim 0000644 0000041 0000041 00000000021 12727176366 023125 0 ustar www-data www-data p With a partial! slim-3.0.7/test/rails/app/views/slim/xml.slim 0000644 0000041 0000041 00000000016 12727176366 021173 0 ustar www-data www-data h1 Hello Slim! slim-3.0.7/test/rails/app/views/slim/erb.html.erb 0000644 0000041 0000041 00000000023 12727176366 021710 0 ustar www-data www-data Hello Erb!
slim-3.0.7/test/rails/app/views/slim/content_for.html.slim 0000644 0000041 0000041 00000000233 12727176366 023657 0 ustar www-data www-data p Page content - content_for :page_heading, "Heading set from a view" - content_for :hello_slim do p= @hello h1= yield :hello_slim h2= yield :hello_slim slim-3.0.7/test/rails/app/views/slim/integers.html.slim 0000644 0000041 0000041 00000000013 12727176366 023153 0 ustar www-data www-data p= @integer slim-3.0.7/test/rails/app/views/slim/partial.html.slim 0000644 0000041 0000041 00000000041 12727176366 022770 0 ustar www-data www-data h1 Hello Slim! = render "partial" slim-3.0.7/test/rails/app/views/slim/normal.html.slim 0000644 0000041 0000041 00000000016 12727176366 022626 0 ustar www-data www-data h1 Hello Slim! slim-3.0.7/test/rails/app/views/slim/helper.html.slim 0000644 0000041 0000041 00000000053 12727176366 022616 0 ustar www-data www-data p = headline do ' Hello = 'User' slim-3.0.7/test/rails/app/views/slim/splat.html.slim 0000644 0000041 0000041 00000000037 12727176366 022464 0 ustar www-data www-data #splat *{tag: 'splat'} Hello slim-3.0.7/test/rails/app/views/slim/no_layout.html.slim 0000644 0000041 0000041 00000000037 12727176366 023352 0 ustar www-data www-data h1 Hello Slim without a layout! slim-3.0.7/test/rails/app/views/slim/thread_options.html.slim 0000644 0000041 0000041 00000000015 12727176366 024357 0 ustar www-data www-data p@empty Test slim-3.0.7/test/rails/app/views/layouts/ 0000755 0000041 0000041 00000000000 12727176366 020244 5 ustar www-data www-data slim-3.0.7/test/rails/app/views/layouts/application.html.slim 0000644 0000041 0000041 00000000164 12727176366 024401 0 ustar www-data www-data doctype html html head title Dummy = csrf_meta_tag body = yield :page_heading .content= yield slim-3.0.7/test/rails/app/controllers/ 0000755 0000041 0000041 00000000000 12727176366 017755 5 ustar www-data www-data slim-3.0.7/test/rails/app/controllers/entries_controller.rb 0000644 0000041 0000041 00000000134 12727176366 024214 0 ustar www-data www-data class EntriesController < ApplicationController def edit @entry = Entry.new end end slim-3.0.7/test/rails/app/controllers/slim_controller.rb 0000644 0000041 0000041 00000001050 12727176366 023505 0 ustar www-data www-data class SlimController < ApplicationController def normal end def xml end def no_layout render layout: false end def variables @hello = "Hello Slim with variables!" end def partial end def streaming @hello = "Hello Streaming!" render :content_for, stream: true end def integers @integer = 1337 end def thread_options Slim::Engine.with_options(shortcut: {'@' => { attr: params[:attr] }}) do render end end def content_for @hello = "Hello Slim!" end def helper end end slim-3.0.7/test/rails/app/controllers/application_controller.rb 0000644 0000041 0000041 00000000071 12727176366 025046 0 ustar www-data www-data class ApplicationController < ActionController::Base end slim-3.0.7/test/rails/app/models/ 0000755 0000041 0000041 00000000000 12727176366 016672 5 ustar www-data www-data slim-3.0.7/test/rails/app/models/entry.rb 0000644 0000041 0000041 00000000374 12727176366 020364 0 ustar www-data www-data class Entry include ActiveModel::Conversion extend ActiveModel::Naming attr_accessor :name def initialize(attributes = {}) attributes.each do |name, value| send("#{name}=", value) end end def persisted? false end end slim-3.0.7/test/rails/app/helpers/ 0000755 0000041 0000041 00000000000 12727176366 017051 5 ustar www-data www-data slim-3.0.7/test/rails/app/helpers/application_helper.rb 0000644 0000041 0000041 00000000146 12727176366 023241 0 ustar www-data www-data module ApplicationHelper def headline(&block) "#{capture(&block)}
".html_safe end end slim-3.0.7/test/rails/config.ru 0000644 0000041 0000041 00000000233 12727176366 016442 0 ustar www-data www-data # This file is used by Rack-based servers to start the application. require ::File.expand_path('../config/environment', __FILE__) run Dummy::Application slim-3.0.7/test/logic_less/ 0000755 0000041 0000041 00000000000 12727176366 015640 5 ustar www-data www-data slim-3.0.7/test/logic_less/test_logic_less.rb 0000644 0000041 0000041 00000013723 12727176366 021355 0 ustar www-data www-data require 'helper' require 'slim/logic_less' class TestSlimLogicLess < TestSlim class Scope def initialize @hash = { person: [ { name: 'Joe', age: 1, selected: true }, { name: 'Jack', age: 2 } ] } end end def test_lambda source = %q{ p == person .name = name == simple .hello= hello == list li = key } hash = { hello: 'Hello!', person: lambda do |&block| %w(Joe Jack).map do |name| "#{block.call(name: name)}" end.join end, simple: lambda do |&block| "#{block.call}
"
end,
list: lambda do |&block|
list = [{key: 'First'}, {key: 'Second'}]
"- #{block.call(*list)}
JoeJack
Hello!
- First
- Second
Joe
Jack
', source, scope: hash
end
def test_string_access
source = %q{
p
- person
.name = name
}
hash = {
'person' => [
{ 'name' => 'Joe', },
{ 'name' => 'Jack', }
]
}
assert_html 'Joe
Jack
', source, scope: hash, dictionary_access: :string
end
def test_symbol_access
source = %q{
p
- person
.name = name
}
hash = {
person: [
{ name: 'Joe', },
{ name: 'Jack', }
]
}
assert_html 'Joe
Jack
', source, scope: hash, dictionary_access: :symbol
end
def test_method_access
source = %q{
p
- person
.name = name
}
object = Object.new
def object.person
%w(Joe Jack).map do |name|
person = Object.new
person.instance_variable_set(:@name, name)
def person.name
@name
end
person
end
end
assert_html 'Joe
Jack
', source, scope: object, dictionary_access: :method
end
def test_instance_variable_access
source = %q{
p
- person
.name = name
}
object = Object.new
object.instance_variable_set(:@person, %w(Joe Jack).map do |name|
person = Object.new
person.instance_variable_set(:@name, name)
person
end)
assert_html 'Joe
Jack
', source, scope: object, dictionary_access: :instance_variable
end
def test_to_s_access
source = %q{
p
- people
.name = self
}
hash = {
people: [
'Joe',
'Jack'
]
}
assert_html 'Joe
Jack
', source, scope: hash, dictionary_access: :symbol
end
def test_string_hash
source = %q{
p
- person
.name = name
}
hash = {
'person' => [
{ 'name' => 'Joe', },
{ 'name' => 'Jack', }
]
}
assert_html 'Joe
Jack
', source, scope: hash
end
def test_dictionary_option
source = %q{
p
- person
.name = name
}
assert_html 'Joe
Jack
', source, scope: Scope.new, dictionary: '@hash'
end
def test_flag_section
source = %q{
p
- show_person
- person
.name = name
- show_person
| shown
}
hash = {
show_person: true,
person: [
{ name: 'Joe', },
{ name: 'Jack', }
]
}
assert_html 'Joe
Jack
shown', source, scope: hash
end
def test_inverted_section
source = %q{
p
- person
.name = name
-! person
| No person
- !person
| No person 2
}
hash = {}
assert_html 'No person No person 2
', source, scope: hash end def test_escaped_interpolation source = %q{ p text with \#{123} test } assert_html 'text with #{123} test
', source end def test_ruby_attributes source = %q{ p - person b name=name Person a id=name = age span class=name Person } assert_html '', source, scope: Scope.new, dictionary: '@hash' end def test_boolean_attributes source = %q{ p - person input checked=selected = name } assert_html 'JoeJack
', source, scope: Scope.new, dictionary: '@hash' end def test_sections source = %q{ p - person .name = name } assert_html 'Joe
Jack
', source, dictionary: 'ViewEnv.new'
end
def test_with_array
source = %q{
ul
- people_with_locations
li = name
li = city
}
assert_html '- Andy
- Atlanta
- Fred
- Melbourne
- Daniel
- Karlsruhe
This is the menu
', source do
'This is the menu'
end
end
end
slim-3.0.7/slim.gemspec 0000644 0000041 0000041 00000001735 12727176366 015055 0 ustar www-data www-data # -*- encoding: utf-8 -*-
require File.dirname(__FILE__) + '/lib/slim/version'
require 'date'
Gem::Specification.new do |s|
s.name = 'slim'
s.version = Slim::VERSION
s.date = Date.today.to_s
s.authors = ['Daniel Mendler', 'Andrew Stone', 'Fred Wu']
s.email = ['mail@daniel-mendler.de', 'andy@stonean.com', 'ifredwu@gmail.com']
s.summary = 'Slim is a template language.'
s.description = 'Slim is a template language whose goal is reduce the syntax to the essential parts without becoming cryptic.'
s.homepage = 'http://slim-lang.com/'
s.license = 'MIT'
s.files = `git ls-files`.split("\n")
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = %w(lib)
s.required_ruby_version = '>=1.9.2'
s.add_runtime_dependency('temple', ['~> 0.7.6'])
s.add_runtime_dependency('tilt', ['>= 1.3.3', '< 2.1'])
end
slim-3.0.7/.gitignore 0000644 0000041 0000041 00000000200 12727176366 014516 0 ustar www-data www-data *.swp
*.gem
Gemfile.lock
.bundle
.redcar
.rvmrc
.yardoc
coverage
pkg
test/rails/log
test/rails/tmp
/.ruby-gemset
/.ruby-version
slim-3.0.7/.yardopts 0000644 0000041 0000041 00000000224 12727176366 014402 0 ustar www-data www-data --markup-provider redcarpet
--markup markdown
- README.md CHANGES LICENSE test/literate/TESTS.md doc/logic_less.md doc/translator.md doc/smart.md
slim-3.0.7/LICENSE 0000644 0000041 0000041 00000002065 12727176366 013546 0 ustar www-data www-data The MIT License
Copyright (c) 2010 - 2015 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.
slim-3.0.7/benchmarks/ 0000755 0000041 0000041 00000000000 12727176366 014653 5 ustar www-data www-data slim-3.0.7/benchmarks/run-benchmarks.rb 0000755 0000041 0000041 00000011621 12727176366 020123 0 ustar www-data www-data #!/usr/bin/env ruby
$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.dirname(__FILE__))
require 'slim'
require 'context'
require 'benchmark/ips'
require 'tilt'
require 'erubis'
require 'erb'
require 'haml'
class SlimBenchmarks
def initialize(slow)
@benches = Hash.new { |h, k| h[k] = [] }
@erb_code = File.read(File.dirname(__FILE__) + '/view.erb')
@haml_code = File.read(File.dirname(__FILE__) + '/view.haml')
@slim_code = File.read(File.dirname(__FILE__) + '/view.slim')
init_compiled_benches
init_tilt_benches
init_parsing_benches if slow
end
def init_compiled_benches
haml_pretty = Haml::Engine.new(@haml_code, format: :html5, escape_attrs: false)
haml_ugly = Haml::Engine.new(@haml_code, format: :html5, ugly: true, escape_attrs: false)
context = Context.new
haml_pretty.def_method(context, :run_haml_pretty)
haml_ugly.def_method(context, :run_haml_ugly)
context.instance_eval %{
def run_erb; #{ERB.new(@erb_code).src}; end
def run_erubis; #{Erubis::Eruby.new(@erb_code).src}; end
def run_temple_erb; #{Temple::ERB::Engine.new.call @erb_code}; end
def run_fast_erubis; #{Erubis::FastEruby.new(@erb_code).src}; end
def run_slim_pretty; #{Slim::Engine.new(pretty: true).call @slim_code}; end
def run_slim_ugly; #{Slim::Engine.new.call @slim_code}; end
}
bench(:compiled, 'erb') { context.run_erb }
bench(:compiled, 'erubis') { context.run_erubis }
bench(:compiled, 'fast erubis') { context.run_fast_erubis }
bench(:compiled, 'temple erb') { context.run_temple_erb }
bench(:compiled, 'slim pretty') { context.run_slim_pretty }
bench(:compiled, 'slim ugly') { context.run_slim_ugly }
bench(:compiled, 'haml pretty') { context.run_haml_pretty }
bench(:compiled, 'haml ugly') { context.run_haml_ugly }
end
def init_tilt_benches
tilt_erb = Tilt::ERBTemplate.new { @erb_code }
tilt_erubis = Tilt::ErubisTemplate.new { @erb_code }
tilt_temple_erb = Temple::ERB::Template.new { @erb_code }
tilt_haml_pretty = Tilt::HamlTemplate.new(format: :html5) { @haml_code }
tilt_haml_ugly = Tilt::HamlTemplate.new(format: :html5, ugly: true) { @haml_code }
tilt_slim_pretty = Slim::Template.new(pretty: true) { @slim_code }
tilt_slim_ugly = Slim::Template.new { @slim_code }
context = Context.new
bench(:tilt, 'erb') { tilt_erb.render(context) }
bench(:tilt, 'erubis') { tilt_erubis.render(context) }
bench(:tilt, 'temple erb') { tilt_temple_erb.render(context) }
bench(:tilt, 'slim pretty') { tilt_slim_pretty.render(context) }
bench(:tilt, 'slim ugly') { tilt_slim_ugly.render(context) }
bench(:tilt, 'haml pretty') { tilt_haml_pretty.render(context) }
bench(:tilt, 'haml ugly') { tilt_haml_ugly.render(context) }
end
def init_parsing_benches
context = Context.new
context_binding = context.instance_eval { binding }
bench(:parsing, 'erb') { ERB.new(@erb_code).result(context_binding) }
bench(:parsing, 'erubis') { Erubis::Eruby.new(@erb_code).result(context_binding) }
bench(:parsing, 'fast erubis') { Erubis::FastEruby.new(@erb_code).result(context_binding) }
bench(:parsing, 'temple erb') { Temple::ERB::Template.new { @erb_code }.render(context) }
bench(:parsing, 'slim pretty') { Slim::Template.new(pretty: true) { @slim_code }.render(context) }
bench(:parsing, 'slim ugly') { Slim::Template.new { @slim_code }.render(context) }
bench(:parsing, 'haml pretty') { Haml::Engine.new(@haml_code, format: :html5).render(context) }
bench(:parsing, 'haml ugly') { Haml::Engine.new(@haml_code, format: :html5, ugly: true).render(context) }
end
def run
@benches.each do |group_name, group_benches|
puts "Running #{group_name} benchmarks:"
Benchmark.ips do |x|
group_benches.each do |name, block|
x.report("#{group_name} #{name}", &block)
end
x.compare!
end
end
puts "
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.
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.)
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'.
Temple ERB is the ERB implementation using the Temple framework. It shows the
overhead added by the Temple framework compared to ERB.
"
end
def bench(group, name, &block)
@benches[group].push([name, block])
end
end
SlimBenchmarks.new(ENV['slow']).run
slim-3.0.7/benchmarks/view.haml 0000644 0000041 0000041 00000000507 12727176366 016472 0 ustar www-data www-data !!! html
%html
%head
%title Simple Benchmark
%body
%h1= header
- unless item.empty?
%ul
- for i in item
- if i[:current]
%li
%strong= i[:name]
- else
%li
%a{:href => i[:url]}= i[:name]
- else
%p The list is empty.
slim-3.0.7/benchmarks/run-diffbench.rb 0000755 0000041 0000041 00000000726 12727176366 017722 0 ustar www-data www-data #!/usr/bin/env ruby
$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.dirname(__FILE__))
require 'slim'
require 'context'
require 'diffbench'
content = File.read(File.dirname(__FILE__) + '/view.slim')
engine = Slim::Engine.new
template = Slim::Template.new { content }
context = Context.new
DiffBench.bm do
report("Parse") do
2000.times { engine.call(content) }
end
report("Render") do
100000.times { template.render(context) }
end
end
slim-3.0.7/benchmarks/context.rb 0000644 0000041 0000041 00000000355 12727176366 016667 0 ustar www-data www-data class Context
def header
'Colors'
end
def item
[ { name: 'red', current: true, url: '#red' },
{ name: 'green', current: false, url: '#green' },
{ name: 'blue', current: false, url: '#blue' } ]
end
end
slim-3.0.7/benchmarks/profile-render.rb 0000644 0000041 0000041 00000000450 12727176366 020114 0 ustar www-data www-data #!/usr/bin/env ruby
$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.dirname(__FILE__))
require 'slim'
require 'context'
content = File.read(File.dirname(__FILE__) + '/view.slim')
slim = Slim::Template.new { content }
context = Context.new
10000.times { slim.render(context) }
slim-3.0.7/benchmarks/view.slim 0000644 0000041 0000041 00000000501 12727176366 016507 0 ustar www-data www-data doctype html
html
head
title Simple Benchmark
body
h1 == header
- unless item.empty?
ul
- for i in item
- if i[:current]
li
strong == i[:name]
- else
li
a href==i[:url] == i[:name]
- else
p The list is empty.
slim-3.0.7/benchmarks/profile-parser.rb 0000644 0000041 0000041 00000000363 12727176366 020134 0 ustar www-data www-data #!/usr/bin/env ruby
$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.dirname(__FILE__))
require 'slim'
content = File.read(File.dirname(__FILE__) + '/view.slim')
engine = Slim::Engine.new
1000.times { engine.call(content) }
slim-3.0.7/benchmarks/view.erb 0000644 0000041 0000041 00000000725 12727176366 016323 0 ustar www-data www-data
<%= header %>
<% unless item.empty? %>-
<% for i in item %>
<% if i[:current] %>
- <%= i[:name] %> <% else %>
- <%= i[:name] %> <% end %> <% end %>
The list is empty.
<% end %> slim-3.0.7/README.jp.md 0000644 0000041 0000041 00000133712 12727176366 014434 0 ustar www-data www-data # Slim [](http://rubygems.org/gems/slim) [](http://travis-ci.org/slim-template/slim) [](https://gemnasium.com/slim-template/slim) [](https://codeclimate.com/github/slim-template/slim) [](https://codeclimate.com/github/slim-template/slim/coverage) [](https://www.gittip.com/min4d/ "Donate weekly to this project using Gittip") [](https://flattr.com/submit/auto?user_id=min4d&url=http%3A%2F%2Fslim-lang.org%2F "Donate monthly to this project using Flattr") Slim は 不可解にならないように view の構文を本質的な部品まで減らすことを目指したテンプレート言語です。標準的な HTML テンプレートからどれだけのものが削除できるか確かめるところから始まりました。(<, >, 閉じタグなど) 多くの人が Slim に興味を持ったことで, 機能性は発展し, 柔軟な構文をもたらしました。 機能の短いリスト * すっきりした構文 * 閉じタグの無い短い構文 (代わりにインデントを用いる) * 閉じタグを用いた HTML 形式の構文 * 設定可能なショートカットタグ (デフォルトでは `#` は `` に, `.` は `
` に)
* 安全性
* デフォルトで自動 HTML エスケープ
* Rails の `html_safe?` に対応
* 柔軟な設定
* プラグインを用いた拡張性:
* Mustache と同様のロジックレスモード
* インクルード
* 多言語化/I18n
* 高性能
* ERB/Erubis に匹敵するスピード
* Rails のストリーミングに対応
* 全てのメジャーフレームワークが対応 (Rails, Sinatra, ...)
* タグや属性の Unicode に完全対応
* Markdown や Textile のような埋め込みエンジン
## リンク
* ホームページ:
* ソース:
* バグ:
* リスト:
* API ドキュメント:
* 最新の Gem:
* GitHub master:
## イントロダクション
### Slim とは?
Slim は __Rails3 および 4__ に対応した高速, 軽量なテンプレートエンジンです。すべての主要な Ruby の実装でしっかりテストされています。
私たちは継続的インテグレーションを採用しています。(travis-ci)
Slim の核となる構文は1つの考えによって導かれます: "この動作を行うために最低限必要なものは何か"。
多くの人々の Slim への貢献によって, 彼らが使う [Haml](https://github.com/haml/haml) や [Jade](https://github.com/visionmedia/jade) の影響を受け構文の追加が行われています。 Slim の開発チームは美は見る人の目の中にあることを分っているのでこういった追加にオープンです。
Slim は 構文解析/コンパイルに [Temple](https://github.com/judofyr/temple) を使い [Tilt](https://github.com/rtomayko/tilt) に組み込まれます。これにより [Sinatra](https://github.com/sinatra/sinatra) やプレーンな [Rack](https://github.com/rack/rack) とも一緒に使えます。
Temple のアーキテクチャはとても柔軟でモンキーパッチなしで構文解析とコンパイルのプロセスの拡張を可能にします。これはロジックレスのプラグインや I18n が提供する翻訳プラグインに
使用されます。ロジックレスモードでは HTML をビルドするために Slim の構文を使いたいが, テンプレートの中で Ruby を書きたくない場合にも Slim を使うことができます。
### なぜ Slim を使うのか?
* Slim によって メンテナンスが容易な限りなく最小限のテンプレートを作成でき, 正しい文法の HTML や XML が書けることを保証します。
* Slim の構文は美的であり, テンプレートを書くのを楽しくしてくれると思います。Slim は主要なフレームワークで互換性があるので簡単に始めることができます。
* Slim のアーキテクチャは非常に柔軟なので構文の拡張やプラグインを書くことができます。
___そう, Slim は速い!___ Slim は開発当初からパフォーマンスに注意して開発されました。
ベンチマークはコミット毎に で取られています。
この数字が信じられませんか? それは仕方ないことです。是非 rake タスクを使って自分でベンチマークを取ってみてください!
私たちの考えでは, あなたは Slim の機能と構文を使うべきです。Slim はあなたのアプリケーションのパフォーマンスに悪影響を与えないことを保証します。
### どう始めるの?
Slim を gem としてインストール:
~~~
gem install slim
~~~
あなたの Gemfile に `gem 'slim'` と書いてインクルードするか, ファイルに `require 'slim'` と書く必要があります。これだけです! 後は拡張子に .slim を使うだけで準備はできています。
### 構文例
Slim テンプレートがどのようなものか簡単な例を示します:
~~~ slim
doctype html
html
head
title Slim のファイル例
meta name="keywords" content="template language"
meta name="author" content=author
link rel="icon" type="image/png" href=file_path("favicon.png")
javascript:
alert('Slim は javascript の埋め込みに対応します!')
body
h1 マークアップ例
#content
p このマークアップ例は Slim の典型的なファイルがどのようなものか示します。
== yield
- if items.any?
table#items
- for item in items
tr
td.name = item.name
td.price = item.price
- else
p アイテムが見つかりませんでした。いくつか目録を追加してください。
ありがとう!
div id="footer"
== render 'footer'
| Copyright © #{@year} #{@author}
~~~
インデントについて, インデントの深さはあなたの好みで選択できます。もし最初のインデントをスペース2つ, その次に5スペースを使いたい場合, それはあなたの選択次第です。マークアップを入れ子にするにはスペース1つのインデントが必要なだけです。
## ラインインジケータ
### テキスト `|`
パイプは Slim に行をコピーしろと命じます。基本的にどのような処理でもエスケープします。
パイプよりも深くインデントされた各行がコピーされます。
~~~ slim
body
p
|
これはテキストブロックのテストです。
~~~
構文解析結果は以下:
~~~ html
#{a.name} #{a.description} #{a.name} #{a.description} テキスト
~~~
#### 属性のショートカット
カスタムショートカットを定義することができます (`#` が id で `.` が class であるように)。
例として `&` で作った type 属性付きの input 要素のショートカットを作成し追加します。
~~~ ruby
Slim::Engine.set_options shortcut: {'&' => {tag: 'input', attr: 'type'}, '#' => {attr: 'id'}, '.' => {attr: 'class'}}
~~~
Slim コードの中でこの様に使用できます。
~~~ slim
&text name="user"
&password name="pw"
&submit
~~~
レンダリング結果
~~~ html
~~~
別の例として `@` で作った role 属性のショートカットを作成し追加します。
~~~ ruby
Slim::Engine.set_options shortcut: {'@' => 'role', '#' => 'id', '.' => 'class'}
~~~
Slim コードの中でこの様に使用できます。
~~~ slim
.person@admin = person.name
~~~
レンダリング結果
~~~ html
### テストスイートと継続的インテグレーション
Slim は minitest ベースの拡張性のあるテストスイートを提供します。テストは 'rake test' または
rails のインテグレーションテストの場合 'rake test:rails' で実行できます。
私たちは現在 markdown ファイルで書かれた人間が読めるテストを試しています: [TESTS.md](test/literate/TESTS.md)
Travis-CI は継続的インテグレーションテストに利用されています:
Slim はすべての主要な Ruby 実装で動作します:
* Ruby 1.9.3, 2.0.0, 2.1.0 および 2.2.0
* Ruby EE
* JRuby 1.9 mode
* Rubinius 2.0
## 貢献
Slim の改良を支援したい場合, Git で管理されているプロジェクトを clone してください。
~~~
$ git clone git://github.com/slim-template/slim
~~~
魔法をかけた後 pull request を送ってください。私たちは pull request が大好きです！
Ruby の 2.2.0, 2.1.0, 2.0.0 と 1.9.3 でテストをすることを覚えておいてください。
もしドキュメントの不足を見つけたら, README.md をアップデートして私たちを助けて下さい。Slim に割く時間がないが, 私たちが知るべきものを何か見つけた場合には issue を送ってください。
## License
Slim は [MIT license](http://www.opensource.org/licenses/MIT) に基づいてリリースされています。
## 作者
* [Daniel Mendler](https://github.com/minad) (Lead developer)
* [Andrew Stone](https://github.com/stonean)
* [Fred Wu](https://github.com/fredwu)
## 寄付とサポート
このプロジェクトをサポートしたい場合, Gittip や Flattr のページを見てください。
[](https://www.gittip.com/min4d/ "Donate weekly to this project using Gittip")
[](https://flattr.com/submit/auto?user_id=min4d&url=http%3A%2F%2Fslim-lang.org%2F "Donate monthly to this project using Flattr")
今のところ, 寄付はホスティング費用 (ドメインなど) に当てられる予定です。
## 議論
* [Google Group](http://groups.google.com/group/slim-template)
## 関連プロジェクト
テンプレートのコンパイルフレームワーク:
* [Temple](https://github.com/judofyr/temple)
フレームワークサポート:
* [Rails generators (slim-rails)](https://github.com/slim-template/slim-rails)
* [slimkeyfy - Translation string extraction](https://github.com/phrase/slimkeyfy)
構文ハイライト:
* [Vim](https://github.com/slim-template/vim-slim)
* [Emacs](https://github.com/slim-template/emacs-slim)
* [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)
静的コード解析:
* [Slim-Lint](https://github.com/sds/slim-lint)
* [SublimeLinter-slim-lint](https://github.com/elstgav/SublimeLinter-slim-lint)
テンプレート変換 (HAML, ERB, ...):
* [Haml2Slim converter](https://github.com/slim-template/haml2slim)
* [ERB2Slim, HTML2Slim converter](https://github.com/slim-template/html2slim)
移植言語/同様の言語:
* [Sliq (Slim/Liquid integration)](https://github.com/slim-template/sliq)
* [Slm (Slim port to Javascript)](https://github.com/slm-lang/slm)
* [Coffee script plugin for Slim](https://github.com/yury/coffee-views)
* [Clojure port of Slim](https://github.com/chaslemley/slim.clj)
* [Hamlet.rb (Similar template language)](https://github.com/gregwebs/hamlet.rb)
* [Plim (Python port of Slim)](https://github.com/2nd/plim)
* [Skim (Slim for Javascript)](https://github.com/jfirebaugh/skim)
* [Emblem.js (Javascript, similar to Slim)](https://github.com/machty/emblem.js)
* [Hamlit (High performance Haml implementation, based on Temple like Slim)](https://github.com/k0kubun/hamlit)
* [Faml (Faster Haml implementation, also using Temple like Slim)](https://github.com/eagletmt/faml)
* [Haml (Older engine which inspired Slim)](https://github.com/haml/haml)
* [Jade (Similar engine for javascript)](https://github.com/visionmedia/jade)
* [Sweet (Similar engine which also allows to write classes and functions)](https://github.com/joaomdmoura/sweet)
* [Amber (Similar engine for Go)](https://github.com/eknkc/amber)
slim-3.0.7/README.md 0000644 0000041 0000041 00000114315 12727176366 014022 0 ustar www-data www-data # Slim
[](http://rubygems.org/gems/slim) [](http://travis-ci.org/slim-template/slim) [](https://gemnasium.com/slim-template/slim) [](https://codeclimate.com/github/slim-template/slim) [](https://codeclimate.com/github/slim-template/slim/coverage) [](https://www.gittip.com/min4d/ "Donate weekly to this project using Gittip")
[](https://flattr.com/submit/auto?user_id=min4d&url=http%3A%2F%2Fslim-lang.org%2F "Donate monthly to this project using Flattr")
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...
* Elegant syntax
* Short syntax without closing tags (Using indentation instead)
* HTML style mode with closing tags
* Configurable shortcut tags (`#` for `
これはテキストブロックのテストです。
~~~ ブロックの左端はパイプ +1 スペースのインデントに設定されています。 追加のスペースはコピーされます。 ~~~ slim body p | この行は左端になります。 この行はスペース 1 つを持つことになります。 この行はスペース 2 つを持つことになります。 以下同様に... ~~~ テキスト行に HTML を埋め込むこともできます。 ~~~ slim - articles.each do |a| |Slim の家
~~~
次のようにハッシュを返すメソッドやインスタンス変数を使うこともできます"
~~~ slim
.card *method_which_returns_hash = place.name
.card *@hash_instance_variable = place.name
~~~
属性の結合 (Slim オプション `:merge_attrs` 参照) に対応するハッシュ属性には `Array` を与えることもできます。
~~~ slim
.first *{class: [:second, :third]} テキスト
~~~
レンダリング結果
~~~ slim
div class="first second third"
~~~
#### 動的タグ `*`
アスタリスク属性を使用することで完全に動的なタグを作ることができます。:tag をキーにもつハッシュを返すメソッドを
作るだけです。
~~~ slim
ruby:
def a_unless_current
@page_current ? {tag: 'span'} : {tag: 'a', href: 'http://slim-lang.com/'}
end
- @page_current = true
*a_unless_current リンク
- @page_current = false
*a_unless_current リンク
~~~
レンダリング結果:
~~~ html
リンクリンク
~~~
### ショートカット
#### タグショートカット
`:shortcut` オプションを設定することで独自のタグショートカットを定義できます。Rails アプリケーションでは, `config/initializers/slim.rb` のようにイニシャライザに定義します。Sinatra アプリでは, `require 'slim'` が書かれた下であればどこにでも設定を定義することができます。
~~~ ruby
Slim::Engine.set_options shortcut: {'c' => {tag: 'container'}, '#' => {attr: 'id'}, '.' => {attr: 'class'} }
~~~
Slim コードの中でこの様に使用できます。
~~~ slim
c.content テキスト
~~~
レンダリング結果
~~~ html
Daniel
~~~
1つのショートカットを使って複数の属性を設定することもできます。
~~~ ruby
Slim::Engine.set_options shortcut: {'@' => {attr: %w(data-role role)}}
~~~
Slim の中で次のように使用し
~~~ slim
.person@admin = person.name
~~~
このようのレンダリングされます。
~~~ html
Daniel
~~~
次のように追加の属性固定値を設定することもできます。
~~~ ruby
Slim::Engine.set_options shortcut: {'^' => {tag: 'script', attr: 'data-binding',
additional_attrs: { type: "text/javascript" }}}
~~~
このように使用します。
~~~ slim
^products
== @products.to_json
~~~
レンダリング結果です。
~~~ html
~~~
#### ID ショートカット `#` と class ショートカット `.`
`id` と `class` の属性を次のショートカットで指定できます。
~~~ slim
body
h1#headline
= page_headline
h2#tagline.small.tagline
= page_tagline
.content
= show_content
~~~
これは次に同じです
~~~ slim
body
h1 id="headline"
= page_headline
h2 id="tagline" class="small tagline"
= page_tagline
div class="content"
= show_content
~~~
## ヘルパ, キャプチャとインクルード
いくつかのヘルパを使用してテンプレートを拡張することもできます。次のヘルパが定義されていることを前提として,
~~~ruby
module Helpers
def headline(&block)
if defined?(::Rails)
# Rails の場合には capture メソッドを使う
"#{capture(&block)}
" else # フレームワークなしで Slim を使う場合(Tilt の場合), # ただ出力する "#{yield}
" end end end ~~~ このインクルードされたコードのスコープは実行される Slim のテンプレートコードです。Slim テンプレートの中では次のように使用することができます。 ~~~ slim p = headline do ' Hello = user.name ~~~ `do` ブロック内のコンテンツが自動的にキャプチャされ `yield` を通してヘルパに渡されます。糖衣構文として `do` キーワードを省略して書くこともできます。 ~~~ slim p = headline ' Hello = user.name ~~~ ### ローカル変数のキャプチャ 次のように `Binding` を使ってローカル変数をキャプチャすることができます: ~~~ruby module Helpers def capture_to_local(var, &block) set_var = block.binding.eval("lambda {|x| #{var} = x }") # Rails では capture! を使います # Slim をフレームワークなしで使う場合 (Tilt のみを使う場合), # キャプチャブロックを取得するには yield が利用できます set_var.call(defined?(::Rails) ? capture(&block) : yield) end end ~~~ このヘルパは次のように使用できます ~~~ slim / captured_content 変数は Binding 前に定義されていなければいけません。 = capture_to_local captured_content=:captured_content p この段落は captured_content 変数にキャプチャされます = captured_content ~~~ 別の興味深いユースケースは, enumerableを使いそれぞれの要素をキャプチャすることです。ヘルパは, このようになります。 ~~~ ruby module Capture def capture(var, enumerable = nil, &block) value = enumerable ? enumerable.map(&block) : yield block.binding.eval("lambda {|x| #{var} = x }").call(value) nil end end ~~~ そして, 次のように使用出来ます。 ~~~ slim - links = { 'http://slim-lang.com' => 'The Slim Template Language' } = capture link_list=:link_list, links do |url, text| a href=url = text ~~~ その後は, `link_list`はキャプチャしたコンテンツを含みます。 ### インクルードヘルパ コンパイル時にインクルード機能を使いたい場合には, [パーシャルのインクルード](doc/jp/include.md) を見てください。 実行時にサブテンプレートを実行すること ( Rails の `#render` のように) もできます。インクルードヘルパを自分で用意する必要があります: ~~~ ruby module Helpers def include_slim(name, options = {}, &block) Slim::Template.new("#{name}.slim", options).render(self, &block) end end ~~~ このヘルパは次のように使用できます ~~~ slim nav = include_slim 'menu' section = include_slim 'content' ~~~ しかし, このヘルパはキャッシュを行いません。その為, 目的にあったよりインテリジェントなバージョンを 実装する必要があります。また, ほとんどのフレームワークにはすでに同様のヘルパが含まれるので注意してください。(例: Rails の `render` メソッド) ## テキストの展開 Ruby の標準的な展開方法を使用します。テキストはデフォルトで html エスケープされます。 ~~~ slim body h1 ようこそ #{current_user.name} ショーへ。 | エスケープしない #{{content}} こともできます。 ~~~ 展開したテキストのエスケープ方法 (言い換えればそのままのレンダリング) ~~~ slim body h1 ようこそ \#{current_user.name} ショーへ。 ~~~ ## 埋め込みエンジン (Markdown, ...) ありがとう [Tilt](https://github.com/rtomayko/tilt), Slim は他のテンプレートエンジンの埋め込みに見事に対応します。 例: ~~~ slim coffee: square = (x) -> x * x markdown: #Header #{"Markdown"} からこんにちわ! 2行目! p: markdown: Tag with **inline** markdown! ~~~ 対応エンジン: | フィルタ | 必要な gems | 種類 | 説明 | | -------- | ----------- | ---- | ----------- | | ruby: | なし | ショートカット | Ruby コードを埋め込むショートカット | | javascript: | なし | ショートカット | javascript コードを埋め込むショートカットで script タグで囲む | | css: | なし | ショートカット | css コードを埋め込むショートカットで style タグで囲む | | sass: | sass | コンパイル時 | sass コードを埋め込むショートカットで style タグで囲む | | scss: | sass | コンパイル時 | scss コードを埋め込むショートカットで style タグで囲む | | less: | less | コンパイル時 | less コードを埋め込むショートカットで style タグで囲む | | styl: | styl | コンパイル時 | stylus コードを埋め込むショートカットで style タグで囲む | | coffee: | coffee-script | コンパイル時 | コンパイルした CoffeeScript で script タグで囲む | | asciidoc: | asciidoctor | コンパイル時 + 展開 | AsciiDoc コードのコンパイルとテキスト中の # \{variables} の展開 | | markdown: | redcarpet/rdiscount/kramdown | コンパイル時 + 展開 | Markdownのコンパイルとテキスト中の # \{variables} の展開 | | textile: | redcloth | コンパイル時 + 展開 | textile のコンパイルとテキスト中の # \{variables} の展開 | | creole: | creole | コンパイル時 + 展開 | cleole のコンパイルとテキスト中の # \{variables} の展開 | | wiki:, mediawiki: | wikicloth | コンパイル時 + 展開 | wiki のコンパイルとテキスト中の # \{variables} の展開 | | rdoc: | rdoc | コンパイル時 + 展開 | RDoc のコンパイルとテキスト中の # \{variables} の展開 | | builder: | builder | プレコンパイル | builder コードの埋め込み | | nokogiri: | nokogiri | プレコンパイル | nokogiri コードの埋め込み | | erb: | なし | プレコンパイル | erb コードの埋め込み | 埋め込みエンジンは Slim の `Slim::Embedded` フィルタのオプションで直接設定されます。例: ~~~ ruby Slim::Embedded.options[:markdown] = {auto_ids: false} ~~~ ## Slim の設定 Slim とその基礎となる [Temple](https://github.com/judofyr/temple) は非常に柔軟に設定可能です。 Slim を設定する方法はコンパイル機構に少し依存します。(Rails や [Tilt](https://github.com/rtomayko/tilt))。デフォルトオプションの設定は `Slim::Engine` クラスでいつでも可能です。Rails の 環境設定ファイルで設定可能です。例えば, config/environments/developers.rb で設定したいとします: ### デフォルトオプション ~~~ ruby # デバック用に html をきれいにインデントし属性をソートしない Slim::Engine.set_options pretty: true, sort_attrs: false ~~~ ハッシュで直接オプションにアクセスすることもできます: ~~~ ruby Slim::Engine.options[:pretty] = true ~~~ ### 実行時のオプション設定 実行時のオプション設定の方法は2つあります。Tilt テンプレート (`Slim::Template`) の場合, テンプレートを インスタンス化する時にオプションを設定できます。 ~~~ ruby Slim::Template.new('template.slim', optional_option_hash).render(scope) ~~~ 他の方法は Rails に主に関係がありますがスレッド毎にオプション設定を行う方法です: ~~~ slim Slim::Engine.with_options(option_hash) do # ここで作成される Slim エンジンは option_hash を使用します # Rails での使用例: render :page, layout: true end ~~~ Rails ではコンパイルされたテンプレートエンジンのコードとオプションはテンプレート毎にキャッシュされ, 後でオプションを変更できないことに注意する必要があります。 ~~~ slim # 最初のレンダリング呼び出し Slim::Engine.with_options(pretty: true) do render :page, layout: true end # 2回目のレンダリング呼び出し Slim::Engine.with_options(pretty: false) do render :page, layout: true # :pretty is still true because it is cached end ~~~ ### 可能なオプション 次のオプションが `Slim::Engine` によって用意され `Slim::Engine.set_options` で設定することができます。 沢山ありますが良いことに, Slim はもし誤った設定キーを使用しようとした場合キーをチェックしエラーを報告します。 | 種類 | 名前 | デフォルト | 用途 | | ---- | ---- | ---------- | ---- | | 文字列 | :file | nil | 解析対象のファイル名ですが, Slim::Template によって自動的に設定されます | | 数値 | :tabsize | 4 | 1 タブあたりのスペース数 (構文解析で利用されます) | | 文字列 | :encoding | "utf-8" | テンプレートのエンコーディングを設定 | | 文字列 | :default_tag | "div" | タグ名が省略されている場合デフォルトのタグとして使用される | | ハッシュ | :shortcut | \{'.' => {attr: 'class'}, '#' => {attr: 'id'}} | 属性のショートカット | | ハッシュ | :code_attr_delims | \{'(' => ')', '[' => ']', '{' => '}'} | Ruby コードの属性区切り文字 | | ハッシュ | :attr_list_delims | \{'(' => ')', '[' => ']', '{' => '}'} | 属性リスト区切り文字 | | 配列<シンボル,文字列> | :enable_engines | nil (すべて可) | 有効な埋め込みエンジンリスト (ホワイトリスト) | | 配列<シンボル,文字列> | :disable_engines | nil (無効なし) | 無効な埋め込みエンジンリスト (ブラックリスト) | | 真偽値 | :disable_capture | false (Rails では true) | ブロック内キャプチャ無効 (ブロックはデフォルトのバッファに書き込む) | | 真偽値 | :disable_escape | false | 文字列の自動エスケープ無効 | | 真偽値 | :use_html_safe | false (Rails では true) | ActiveSupport の String# html_safe? を使う (:disable_escape と一緒に機能する) | | シンボル | :format | :xhtml | html の出力フォーマット (対応フォーマット :html, :xhtml, :xml) | | 文字列 | :attr_quote | '"' | html の属性を囲む文字 (' または " が可能) | | ハッシュ | :merge_attrs | \{'class' => ' '} | 複数の html 属性が与えられた場合結合に使われる文字列 (例: class="class1 class2") | | 配列<文字列> | :hyphen_attrs | %w(data) | 属性にハッシュが与えられた場合ハイフンつなぎされます。(例: data={a:1, b:2} は data-a="1" data-b="2" のように) | | 真偽値 | :sort_attrs | true | 名前によって属性をソート | | シンボル | :js_wrapper | nil | :comment, :cdata や :both で JavaScript をラップします。:guess を指定することで :format オプションに基いて設定することもできます | | 真偽値 | :pretty | false | 綺麗な html インデント (遅くなります!) | | 文字列 | :indent | ' ' | インデントに使用される文字列 | | 真偽値 | :streaming | false (Rails では true, 無効化するにはストリーミングを参照) | ストリーミング出力の有効化, 体感的なパフォーマンスの向上 | | Class | :generator | Temple::Generators::ArrayBuffer/ RailsOutputBuffer | Temple コードジェネレータ (デフォルトのジェネレータは配列バッファを生成します) | | 文字列 | :buffer | '_buf' (Rails では '@output_buffer') | バッファに使用される変数 | Temple フィルタによってもっと多くのオプションがサポートされていますが一覧には載せず公式にはサポートしません。 Slim と Temple のコードを確認しなければなりません。 ### オプションの優先順位と継承 Slim や Temple のアーキテクチャについてよく知っている開発者は異なる場所で設定を 上書きすることができます。 Temple はサブクラスがスーパークラスのオプションを上書きできるように 継承メカニズムを採用しています。オプションの優先順位は次のとおりです: 1. `Slim::Template` オプションはエンジン初期化時に適用されます 2. `Slim::Template.options` 3. `Slim::Engine.thread_options`, `Slim::Engine.options` 5. パーサ/フィルタ/ジェネレータ `thread_options`, `options` (例: `Slim::Parser`, `Slim::Compiler`) `Temple::Engine` のようにスーパークラスのオプションを設定することも可能です。しかしこれはすべての Temple テンプレートエンジンに影響します。 ~~~ ruby Slim::Engine < Temple::Engine Slim::Compiler < Temple::Filter ~~~ ## プラグイン Slim はロジックレスモードと I18n, インクルードプラグインを提供しています。プラグインのドキュメントを確認してください。 * [ロジックレスモード](doc/jp/logic_less.md) * [パーシャルのインクルード](doc/jp/include.md) * [多言語化/I18n](doc/jp/translator.md) * [スマートテキストモード](doc/jp/smart.md) ## フレームワークサポート ### Tilt Slim は生成されたコードをコンパイルするために [Tilt](https://github.com/rtomayko/tilt) を使用します。Slim テンプレートを直接使いたい場合, Tilt インターフェイスが使用できます。 ~~~ ruby Tilt.new['template.slim'].render(scope) Slim::Template.new('template.slim', optional_option_hash).render(scope) Slim::Template.new(optional_option_hash) { source }.render(scope) ~~~ optional_option_hash は前述のオプションを持つことができます。このオブジェクトのスコープは実行されるテンプレートの コードです。 ### Sinatra ~~~ ruby require 'sinatra' require 'slim' get('/') { slim :index } __END__ @@ index doctype html html head title Slim で Sinatra body h1 Slim は楽しい! ~~~ ### Rails Rails のジェネレータは [slim-rails](https://github.com/slim-template/slim-rails) によって提供されます。 slim-rails は Rails で Slim を使用する場合に必須ではありません。Slim をインストールし Gemfile に `gem 'slim-rails'` を追加するだけです。 後は .slim 拡張子を使えば Rails で使用できます。 #### ストリーミング HTTP ストリーミングは Rails がそれをサポートしているバージョンであればデフォルトで有効化されています。しかし, ストリーミングが体感的なパフォーマンスを改善していることを知る必要があります。 レンダリング時間は増加するでしょう。ストリーミングを無効化したい場合の設定です: ~~~ ruby Slim::RailsTemplate.set_options streaming: false ~~~ ## ツール ### Slim コマンド 'slimrb' gem の 'slim' にはコマンドラインから Slim をテストするための小さなツール 'slimrb' が付属します。
$ slimrb --help
Usage: slimrb [options]
-s, --stdin Read input from standard input instead of an input file
--trace Show a full traceback on error
-c, --compile Compile only but do not run
-e, --erb Convert to ERB
--rails Generate rails compatible code (Implies --compile)
-r, --require library Load library or plugin with -r slim/plugin
-p, --pretty Produce pretty html
-o, --option name=code Set slim option
-l, --locals Hash|YAML|JSON Set local variables
-h, --help Show this message
-v, --version Print version
'slimrb' で起動し, コードをタイプし Ctrl-d で EOF を送ります。Windows のコマンドプロンプトでは Ctrl-z で EOF を送ります。使い方例:
$ slimrb markdown: 最初の段落。 2つ目の段落。 * 1つ * 2つ * 3つ //Enter Ctrl-d <p>最初の段落。 </p> <p>2つめの段落。 </p> <ul> <li>1つ</li> <li>2つ</li> <li>3つ</li> </ul>### 構文ハイライト 様々なテキストエディタのためのプラグインがあります。(最も重要なものも含めて - Vim, Emacs や Textmate): * [Vim](https://github.com/slim-template/vim-slim) * [Emacs](https://github.com/slim-template/emacs-slim) * [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) ### テンプレート変換 (HAML, ERB, ...) * Slim は gem に含まれる `slimrb` や `Slim::ERBConverter` を用いて ERB に変換できます。 * [Haml2Slim converter](https://github.com/slim-template/haml2slim) * [ERB2Slim, HTML2Slim converter](https://github.com/slim-template/html2slim) ## テスト ### ベンチマーク *そうです, Slim は最速の Ruby のテンプレートエンジンです! production モードの Slim は Erubis (最速のテンプレートエンジン) と同じくらい高速です。 ありがたいことに何らかの理由であなたが Slim を選択した場合, 私たちは パフォーマンスが障害にならないだろうことを保証します。* ベンチマークは `rake bench` で実行します。時間が余計にかかりますが遅い解析ベンチマークを 実行したい場合 `slow` オプションを追加できます。 ~~~ rake bench slow=1 iterations=1000 ~~~ 私たちはコミット毎に Travis-CI でベンチマークをとっています。最新のベンチマーク結果はリンク先を確認:
` and `.` for `
` in the default configuration)
* Safety
* Automatic HTML escaping by default
* Support for Rails' `html_safe?`
* Highly configurable
* Extensible via the following plugins:
* Logic less mode similar to Mustache
* Includes
* Translator/I18n
* High performance
* Comparable speed to ERB/Erubis
* Streaming support in Rails
* Supported by all major frameworks (Rails, Sinatra, ...)
* Full Unicode support for tags and attributes
* Embedded engines like Markdown and Textile
## Links
* Homepage:
* Source:
* Bugs:
* List:
* API documentation:
* Latest Gem:
* GitHub master:
## Introduction
### What is Slim?
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
continuous integration (travis-ci).
Slim's core syntax is guided by one thought: "What's the minimum required to make this work".
As more people have contributed to Slim, there have been syntax additions influenced from their use of [Haml](https://github.com/haml/haml) and [Jade](https://github.com/visionmedia/jade). The Slim team is open to these additions because we know beauty is in the eye of the beholder.
Slim uses [Temple](https://github.com/judofyr/temple) for parsing/compilation and is also integrated into [Tilt](https://github.com/rtomayko/tilt), so it can be used together with [Sinatra](https://github.com/sinatra/sinatra) or plain [Rack](https://github.com/rack/rack).
The architecture of Temple is very flexible and allows the extension of the parsing and compilation process without monkey-patching. This is used
by the logic less plugin and the translator plugin which provides I18n. In logic-less mode you can use Slim if you like the Slim syntax to build your HTML but don't want to write Ruby in your templates.
### Why use Slim?
* Slim allows you to write very minimal templates which are easy to maintain and pretty much guarantees that you write well-formed HTML and XML
* We also think that the Slim syntax is also aesthetic and makes it much more fun to write templates. Since you can use Slim as a drop-in replacement in all the major framework you can start easily.
* The Slim architecture is very flexible and allows you to write syntax extensions and plugins.
___Yes, Slim is speedy!___ Slim was developed right from the start with performance in mind.
Benchmarks are done for every commit at .
Don't trust the numbers? That's as it should be. Please try the benchmark rake task yourself!
However in our opinion you should use Slim because of its features and syntax. We just ensure that Slim doesn't have a negative impact on the performance of your application.
### How to start?
Install Slim as a gem:
~~~
gem install slim
~~~
Include Slim in your Gemfile with `gem 'slim'` or require it with `require 'slim'`. That's it! Now, just use the .slim extension and you're good to go.
### Syntax example
Here's a quick example to demonstrate what a Slim template looks like:
~~~ slim
doctype html
html
head
title Slim Examples
meta name="keywords" content="template language"
meta name="author" content=author
link rel="icon" type="image/png" href=file_path("favicon.png")
javascript:
alert('Slim supports embedded javascript!')
body
h1 Markup examples
#content
p This example shows you how a basic Slim file looks.
== yield
- if items.any?
table#items
- for item in items
tr
td.name = item.name
td.price = item.price
- else
p No items found. Please add some inventory.
Thank you!
div id="footer"
== render 'footer'
| Copyright © #{@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.
## Line indicators
### Verbatim text `|`
The pipe tells Slim to just copy the line. It essentially escapes any processing.
Each following line that is indented greater than the pipe is copied over.
~~~ slim
body
p
|
This is a test of the text block.
~~~
The parsed result of the above:
~~~ html
#{a.name} #{a.description} #{a.name} #{a.description} Text
~~~
#### Attribute shortcuts
You can define custom shortcuts (Similar to `#` for id and `.` for class).
In this example we add `&` to create a shortcut for the input elements with type attribute.
~~~ ruby
Slim::Engine.set_options shortcut: {'&' => {tag: 'input', attr: 'type'}, '#' => {attr: 'id'}, '.' => {attr: 'class'}}
~~~
We can use it in Slim code like this
~~~ slim
&text name="user"
&password name="pw"
&submit
~~~
which renders to
~~~ html
~~~
In another example we add `@` to create a shortcut for the role attribute.
~~~ ruby
Slim::Engine.set_options shortcut: {'@' => {attr: 'role'}, '#' => {attr: 'id'}, '.' => {attr: 'class'}}
~~~
We can use it in Slim code like this
~~~ slim
.person@admin = person.name
~~~
which renders to
~~~ html
### Test suite and continuous integration
Slim provides an extensive test-suite based on minitest. You can run the tests
with 'rake test' and the rails integration tests with 'rake test:rails'.
We are currently experimenting with human-readable literate tests which are written as markdown files: [TESTS.md](test/literate/TESTS.md)
Travis-CI is used for continuous integration testing:
Slim is working well on all major Ruby implementations:
* Ruby 1.9.3, 2.0.0, 2.1.0 and 2.2.0
* Ruby EE
* JRuby 1.9 mode
* Rubinius 2.0
## Contributing
If you'd like to help improve Slim, clone the project with Git by running:
~~~
$ git clone git://github.com/slim-template/slim
~~~
Work your magic and then submit a pull request. We love pull requests!
Please remember to keep the compatibility with Ruby versions 1.9.3, 2.0.0, 2.1.0 and 2.2.0.
If you find the documentation lacking, 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
Slim is released under the [MIT license](http://www.opensource.org/licenses/MIT).
## Authors
* [Daniel Mendler](https://github.com/minad) (Lead developer)
* [Andrew Stone](https://github.com/stonean)
* [Fred Wu](https://github.com/fredwu)
## Donations and sponsoring
If you want to support this project please visit the Gittip and Flattr pages.
[](https://www.gittip.com/min4d/ "Donate weekly to this project using Gittip")
[](https://flattr.com/submit/auto?user_id=min4d&url=http%3A%2F%2Fslim-lang.org%2F "Donate monthly to this project using Flattr")
Currently the donations will be used to cover the hosting costs (domain name etc).
## Discuss
* [Google Group](http://groups.google.com/group/slim-template)
## Related projects
Template compilation framework:
* [Temple](https://github.com/judofyr/temple)
Framework support:
* [Rails generators (slim-rails)](https://github.com/slim-template/slim-rails)
* [slimkeyfy - Translation string extraction](https://github.com/phrase/slimkeyfy)
Syntax highlighting:
* [Vim](https://github.com/slim-template/vim-slim)
* [Emacs](https://github.com/slim-template/emacs-slim)
* [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)
Static code analysis:
* [Slim-Lint](https://github.com/sds/slim-lint)
* [SublimeLinter-slim-lint](https://github.com/elstgav/SublimeLinter-slim-lint)
Template Converters (HAML, ERB, ...):
* [Haml2Slim converter](https://github.com/slim-template/haml2slim)
* [ERB2Slim, HTML2Slim converter](https://github.com/slim-template/html2slim)
Language ports/Similar languages:
* [Sliq (Slim/Liquid integration)](https://github.com/slim-template/sliq)
* [Slm (Slim port to Javascript)](https://github.com/slm-lang/slm)
* [Coffee script plugin for Slim](https://github.com/yury/coffee-views)
* [Clojure port of Slim](https://github.com/chaslemley/slim.clj)
* [Hamlet.rb (Similar template language)](https://github.com/gregwebs/hamlet.rb)
* [Plim (Python port of Slim)](https://github.com/2nd/plim)
* [Skim (Slim for Javascript)](https://github.com/jfirebaugh/skim)
* [Emblem.js (Javascript, similar to Slim)](https://github.com/machty/emblem.js)
* [Hamlit (High performance Haml implementation, based on Temple like Slim)](https://github.com/k0kubun/hamlit)
* [Faml (Faster Haml implementation, also using Temple like Slim)](https://github.com/eagletmt/faml)
* [Haml (Older engine which inspired Slim)](https://github.com/haml/haml)
* [Jade (Similar engine for javascript)](https://github.com/visionmedia/jade)
* [Sweet (Similar engine which also allows to write classes and functions)](https://github.com/joaomdmoura/sweet)
* [Amber (Similar engine for Go)](https://github.com/eknkc/amber)
slim-3.0.7/CHANGES 0000644 0000041 0000041 00000036371 12727176366 013543 0 ustar www-data www-data 3.0.7 (2016-05-22)
* Add additional attributes feature to shortcuts
* Freeze string literals
3.0.6 (2015-06-05)
* Fix warnings #625
3.0.4 (2015-06-02)
* javascript: doesn't add type='text/javascript' anymore
* slimrb: --require added
* Fix #624
3.0.3 (2015-03-06)
* Fix #392, capturing for splat attributes didn't work correctly under Rails
3.0.2 (2015-02-02)
* slimrb: Add option --locals
* Fix issues in the test suite (#576), thanks @dmke!
3.0.1 (2014-12-22)
* Allow more special characters in html attribute names (See https://html.spec.whatwg.org/multipage/syntax.html#attributes-2), #567
* Fix: Code attributes mutate their argument (#571)
3.0.0 (2014-12-07)
* Drop 1.8.7 support
* Deprecate default_options in favor of options
* Support xml pretty printing with format: :xml
* Deprecate `='`, `=='` and `tag'` syntax for trailing whitespace. Use `=<` etc. instead.
* slimrb: Remove deprecated plugin options -l and -t
2.1.0 (2014-10-15)
* Parser: Require pairwise braces in quoted attributes
* Parser: add :attr_list_delims and :code_attr_delims
* Parser: deprecate :attr_delims
* Parser: relax text indentation requirements:
| line
next line
tag some text
more text
* Parser: allow first line to be indented
* Parser: allow inline embedded languages:
.content: markdown: This is **important**
* Parser: allow line breaks in quoted attributes
* Added Opal as embedded engine
* slimrb: Change meaning of -r, deprecate -t and -l
* Fix issue with inserted end (#485)
* Add experimental 'slim/include' plugin (Might change in the future)
* Add experimental 'slim/smart' plugin (Might change in the future)
* Drop jruby18 support
* Fix rails error reporting #587 (Manipulate stacktrace)
* Splat: handle html_safe
2.0.3 (2014-07-04)
* slimrb: Don't update HTML output on exceptions
* Allow dashes at the beginning of class names (#474)
* Render empty attributes as standalone in html mode (#480)
* Fix #482: problem with whitespace modifier `tag=<`
* Fix #485: missing end for empty `if` control blocks
* Fix #510: double dash in class name
2.0.2 (2013-10-27)
* Add option :attr_delims
2.0.1 (2013-07-31)
* Support multiple attributes per shortcut (See issue #415)
* Add support for org-ruby embedded engine
* Render true boolean attributes with empty value
* Support case-when statements
* Fix issue #431
* Also escape ' to '
2.0.0 (2013-05-27)
* IMPORTANT: Backward incompatible syntax change: '{...}' and '[...]' are not
allowed as ruby attribute wrappers anymore. Use parentheses '(...)'
if you want to wrap code with spaces. This allows to write arrays and hashes directly.
Old:
div id={'obj' + name} data=({:a => 1, :b => 2}) class=['alpha', 'beta']
New:
div id=('obj' + name) data={:a => 1, :b => 2} class=['alpha', 'beta']
* Quoted attributes are escaped by default
Old:
a href='http://slim-lang.com/?a=1&b=2'
New:
a href='http://slim-lang.com/?a=1&b=2'
a href=='http://slim-lang.com/?a=1&b=2'
You can always disable escaping completly by using :disable_escape if you don't want to write '=='.
* Added hyphenation support for data attributes (Option :hyphen_attrs)
Example: div data={key1_key2: 2, key1: {key3: 3}} will render as ''
* Removed deprecated options:
- :escape_quoted_attrs
- :remove_empty_attrs
- :chain
- :attr_wrapper (renamed to :attr_quote)
- :attr_delimiter (renamed to :merge_attrs)
- Slim::LogicLess :wrapped dictionary
- Slim::Parser :shortcut string option
* Allow spaces around attributes, e.g 'a [ href = url ] text' and 'a href = url text'
* Add unicode support for tags and attributes (Issue #212)
* Generate missing `do` keywords for code blocks (see #342)
* Logic-less: Add keyword `self` for string access
* Added Slim::ERBConverter, require 'slim/erb_converter'
* Added option '-e' for ERB conversion to slimrb
* Add syntax for trailing or leading whitespace after tag, e.g. input>, input<
* Add syntax for trailing or leading whitespace after output, e.g. =>, =<
1.3.8 (2013-04-11)
* Disable some superflous deprecation warnings
1.3.7 (2013-04-10)
* 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 (2013-01-06)
* Allow attribute values to be broken with `\` (Issue #331)
* Tag shortcuts implemented (Issue #306)
* Hash format of Slim::Parser option :shortcut changed, old configuration deprecated but still supported
1.3.5 (2012-12-19)
* Logic-less:
- Rewrote logic-less mode (Issue #326, #327)
- Logic-less mode supports lambdas
- Option :dictionary_access made more powerful, value :wrapped deprecated
1.3.4 (2012-11-15)
* Fixed #314
* Logic-less test cases added
1.3.3 (2012-10-16)
* Attribute handling made consistent:
- Splat attributes, static and dynamic attributes are now all handled the same
- Merged attributes are removed if empty (in the default configuration this is only "class")
- Dynamic attributes which are not merged are checked for false or nil and removed if this is the case
- Dynamic attributes which are not merged are checked for true and generated as attribute-name="attribute-name"
* Rename class BooleanAttributes to CodeAttributes
* Add literate test suite (still incomplete), run with `rake test:literate`
* Remove UTF BOM when parsing Slim code
* Fixed issue #303
1.3.2 (2012-09-26)
* Fix boolean attributes #299
1.3.1 (2012-09-23)
* Support inline html at the beginning of a line (New line indicator <). No pipe symbol is | necessary.
It is even possible to wrap other Slim syntax in such a html block.
* Code restructured - Handling of boolean and splat attributes improved and PERFORMANCE improved.
* BACKWARD INCOMPATIBLE CHANGE - Dynamic attributes which return empty value "" are not removed anymore
(this means "" is now interpreted as true), whereas false and nil are still removed.
This corresponds to the definition of boolean attributes in XHTML and HTML5.
* Deprecated option :remove_empty_attrs (TODO: Remove in 1.4.0)
* Add option :escape_quoted_attrs to escape quoted attributes, use == if you don't want that.
The default is false to stay backward compatible.
* Use Temple::FilterError exception
* Use Temple::Parser
* / is not escaped anymore to /
* Parser: check for missing closing quote in quoted attributes
* Use new temple option validation to make Slim configuration more user friendly.
* Support thread options Slim::Engine.with_options which especially useful for Rails
* Add explicit column number to SyntaxError.to_s
1.3.0 (2012-09-04)
* Parser wraps text blocks in [:slim, :text, ...] (Used by Translator/I18n plugin)
* Added Translator/I18n plugin which uses GetText or FastGettext (require 'slim/translator')
* Moved logic less mode out of the core to plugin (require 'slim/logic_less')
1.2.2 (2012-06-21)
* Fix issue #264
1.2.1 (2012-05-22)
* Support stylus as embedded engine
* Fix issue #257
1.2.0 (2012-03-30)
* Add option :shortcut which configures attribute shortcuts
Default setting:
Slim::Parser.default_options[:shortcut] = {'#' => 'id', '.' => 'class', '*' => '*'}
Define custom shortcut attribute (e.g. a@ajax-link renders )
Slim::Parser.default_options[:shortcut] = {'@' => 'role'}
Define custom shortcut attribute with tag (e.g. @ajax-link renders )
Slim::Parser.default_options[:shortcut] = {'@' => 'a role'}
* Add syntax for splat attributes (#109)
* Support for dynamic tags, e.g. *{:tag => 'img', :src => 'image.jpg'}
1.1.1 (2012-02-29)
* Evaluating a html attribute now happens only once (#219)
* Code with trailing comma is treated as broken line (#226)
* Support option :remove_empty_attrs (default true)
* Require temple 0.4.0
1.1.0 (2012-01-06)
* Support for special characters in class/id shortcut removed
* Do not allow : in class/id shortcut
* Add support for block expansion syntax
* Support options :indent, :sort_attrs
* Require temple 0.3.5
1.0.4 (2011-11-03)
* Pass options to embedded Tilt engine
Slim::EmbeddedEngine.set_default_options :markdown => {...}
* Add test case for precompiled embedded engine 'builder'
* Bug #204 fixed, tabs were not parsed correctly
1.0.3 (2011-10-08)
* Fix rubinius test cases
* Fix line numbers for embedded engines
* Require temple 0.3.4
* Remove dynamic embedded engines Haml, Liquid, Radius, Markaby
* More thorough integration testing using travis-ci
See http://travis-ci.org/#!/stonean/slim
* Empty static attributes are not removed anymore
* Line indicator =' is supported in tags
1.0.2 (2011-08-26)
* Support for Rails 3.1 streaming (Temple > 0.3.2 required)
* Switch to default format xhtml (supports all doctypes, including html5)
* Improve parsing of #{interpolation} in quoted attributes (issue #159)
* Use travis-ci for continous integration testing
1.0.1 (2011-08-07)
* Only delimiting brackets must be balanced in ruby attributes
e.g this is possible now `a href=(ruby_code "{")
* Skip empty lines in text block (#156)
1.0.0 (2011-07-24)
* Fixed html attribute issue in sections mode (#127)
* Obsolete directive syntax removed
* Syntax for trailing whitespace added (==' and =')
* Deprecated file 'slim/rails.rb' removed
* Parsing of #{interpolation} in markdown fixed
* Support for attributes which span multiple lines
* Dynamic attributes with value true/false are interpreted as boolean
* Support boolean attributes without value e.g. option(selected id="abc")
0.9.3 (2011-05-15)
* 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 (2011-03-30)
* 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 (2011-03-10)
* add new doctype syntax without !
* slim directive expression has type and args
0.9.0 (2011-01-30)
* slim should not be registered as the default template handler.
* add support for unescaped text interpolation
0.8.4 (2011-01-26)
* 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 (2010-12-23)
* 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 (2010-12-22)
* fix issue #96
* Added the Temple Debugger filter.
* Rails problems fixed
0.8.1 (2010-12-17)
* remove backtick slim syntax -- no longer supported
* slim executable conflict. issue #91
* vim syntax support improved
0.8.0 (2010-11-29)
* rails logic less support
0.7.4 (2010-11-22)
* use ' for text block with trailing whitespace
* allow to disable/enable embedded engines
0.7.3 (2010-11-16)
* fix #82
* basic rails test added
0.7.2 (2010-11-09)
* get rid of rails deprecation warning
* use_html_safe is activated automatically by temple
0.7.1 (2010-11-03)
* logic less mode
* add syntax for explicitly closed tags
0.7.0 (2010-10-25)
* 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 (2010-10-17)
* can wrap parens around attributes if you so desire
* added erubis to the benchmarks
0.6.0 (2010-10-17)
* 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 (2010-10-08)
* Consecutive condition statements now working as expected.
0.5.0 (2010-10-07)
* 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 (2010-10-03)
* 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 (2010-09-21)
* 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 (2010-09-17)
* fix bug with adding end to nesting ruby code
0.3.0 (2010-09-17)
* Optimize compiled string to reduce number of concatentations to the buffer
0.2.0 (2010-09-17)
* can now make code call on same line as tag
0.1.0 (2010-09-15)
* Initial release
This is a test of the text block.
~~~ If the text starts on the same line, the left margin is set at the indent of the pipe + one space. Any additional spaces will be copied over. ~~~ slim 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... ~~~ You can also embed html in the text line ~~~ slim - articles.each do |a| |Slim's house
~~~
You can also use methods or instance variables which return a hash as shown here:
~~~ slim
.card *method_which_returns_hash = place.name
.card *@hash_instance_variable = place.name
~~~
The hash attributes which support attribute merging (see Slim option `:merge_attrs`) can be given as an `Array`
~~~ slim
.first *{class: [:second, :third]} Text
~~~
This renders as:
~~~ html
div class="first second third"
~~~
#### Dynamic tags `*`
You can create completely dynamic tags using the splat attributes. Just create a method which returns a hash
with the :tag key.
~~~ slim
ruby:
def a_unless_current
@page_current ? {tag: 'span'} : {tag: 'a', href: 'http://slim-lang.com/'}
end
- @page_current = true
*a_unless_current Link
- @page_current = false
*a_unless_current Link
~~~
This renders as:
~~~ html
LinkLink
~~~
### Shortcuts
#### Tag shortcuts
You can define custom tag shortcuts by setting the option `:shortcut`. In Rails apps, you need to put this code for your shortcuts into an initializer like `config/initializers/slim.rb`. In Sinatra, you simply add the same configuration anywhere below the line where you `require 'slim'`.
~~~ ruby
Slim::Engine.set_options shortcut: {'c' => {tag: 'container'}, '#' => {attr: 'id'}, '.' => {attr: 'class'} }
~~~
We can use it in Slim code like this
~~~ slim
c.content Text
~~~
which renders to
~~~ html
Daniel
~~~
You can also set multiple attributes with same value at once using one shortcut.
~~~ ruby
Slim::Engine.set_options shortcut: {'@' => {attr: %w(data-role role)}}
~~~
We can use it in Slim code like this
~~~ slim
.person@admin = person.name
~~~
which renders to
~~~ html
Daniel
~~~
You can also set additional fixed value attributes to a shortcut.
~~~ ruby
Slim::Engine.set_options shortcut: {'^' => {tag: 'script', attr: 'data-binding',
additional_attrs: { type: "text/javascript" }}}
~~~
Then
~~~ slim
^products
== @products.to_json
~~~
which renders to
~~~ html
~~~
#### ID shortcut `#` and class shortcut `.`
You can specify the `id` and `class` attributes in the following shortcut form
~~~ slim
body
h1#headline
= page_headline
h2#tagline.small.tagline
= page_tagline
.content
= show_content
~~~
This is the same as
~~~ slim
body
h1 id="headline"
= page_headline
h2 id="tagline" class="small tagline"
= page_tagline
div class="content"
= show_content
~~~
## 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
~~~ruby
module Helpers
def headline(&block)
if defined?(::Rails)
# In Rails we have to use capture!
"#{capture(&block)}
" else # If we are using Slim without a framework (Plain Tilt), # this works directly. "#{yield}
" end end end ~~~ which is included in the scope that executes the Slim template code. The helper can then be used in the Slim template as follows ~~~ slim p = headline do ' Hello = user.name ~~~ The content in the `do` block is then captured automatically and passed to the helper via `yield`. As a syntactic sugar you can omit the `do` keyword and write only ~~~ slim p = headline ' Hello = user.name ~~~ ### Capturing to local variables Using the `Binding` you can capture to local variables as follows: ~~~ruby module Helpers def capture_to_local(var, &block) set_var = block.binding.eval("lambda {|x| #{var} = x }") # In Rails we have to use capture! # If we are using Slim without a framework (Plain Tilt), # you can just yield to get the captured block. set_var.call(defined?(::Rails) ? capture(&block) : yield) end end ~~~ The helper can then be used in the Slim template as follows ~~~ slim / The captured_content variable must be known by the Binding beforehand. = capture_to_local captured_content=:captured_content p This will be captured in the variable captured_content = captured_content ~~~ Another interesting use case is to use an enumerable and capture for each element. The helper could look like this ~~~ ruby module Capture def capture(var, enumerable = nil, &block) value = enumerable ? enumerable.map(&block) : yield block.binding.eval("lambda {|x| #{var} = x }").call(value) nil end end ~~~ and it would be used as follows ~~~ slim - links = { 'http://slim-lang.com' => 'The Slim Template Language' } = capture link_list=:link_list, links do |url, text| a href=url = text ~~~ Afterwards, `link_list` contains the captured content. ### Include helper If you want includes which are processed at compile time, you can take a look at [Include partials](doc/include.md). However you can also execute subtemplates at runtime (similar to Rails' `#render`). You have to write your own include helper: ~~~ 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 ~~~ slim 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. ~~~ slim body h1 Welcome #{current_user.name} to the show. | Unescaped #{{content}} is also possible. ~~~ To escape the interpolation (i.e. render as is) ~~~ slim body h1 Welcome \#{current_user.name} to the show. ~~~ ## Embedded engines (Markdown, ...) Thanks to [Tilt](https://github.com/rtomayko/tilt), Slim has extensive support for embedding other template engines. Examples: ~~~ slim coffee: square = (x) -> x * x markdown: #Header Hello from #{"Markdown!"} Second Line! p: markdown: Tag with **inline** markdown! ~~~ Supported engines: | Filter | Required gems | Type | Description | | ------ | ------------- | ---- | ----------- | | ruby: | none | Shortcut | Shortcut to embed ruby code | | javascript: | none | Shortcut | Shortcut to embed javascript code and wrap in script tag | | css: | none | Shortcut | Shortcut to embed css code and wrap in style tag | | sass: | sass | Compile time | Embed sass code and wrap in style tag | | scss: | sass | Compile time | Embed scss code and wrap in style tag | | less: | less | Compile time | Embed less css code and wrap in style tag | | styl: | styl | Compile time | Embed stylus css code and wrap in style tag | | coffee: | coffee-script | Compile time | Compile coffee script code and wrap in script tag | | asciidoc: | asciidoctor | Compile time + Interpolation | Compile AsciiDoc code and interpolate #\{variables} in text | | markdown: | redcarpet/rdiscount/kramdown | Compile time + Interpolation | Compile markdown code and interpolate #\{variables} in text | | textile: | redcloth | Compile time + Interpolation | Compile textile code and interpolate #\{variables} in text | | creole: | creole | Compile time + Interpolation | Compile creole code and interpolate #\{variables} in text | | wiki:, mediawiki: | wikicloth | Compile time + Interpolation | Compile wiki code and interpolate #\{variables} in text | | rdoc: | rdoc | Compile time + Interpolation | Compile rdoc code and interpolate #\{variables} in text | | builder: | builder | Precompiled | Embed builder code | | nokogiri: | nokogiri | Precompiled | Embed nokogiri builder code | | erb: | none | Precompiled | Embed erb code | The embedded engines can be configured in Slim by setting the options directly on the `Slim::Embedded` filter. Example: ~~~ ruby Slim::Embedded.options[:markdown] = {auto_ids: false} ~~~ ## Configuring Slim Slim and the underlying [Temple](https://github.com/judofyr/temple) framework are highly configurable. The way how you configure Slim depends a bit on the compilation mechanism (Rails or [Tilt](https://github.com/rtomayko/tilt)). It is always possible to set default options per `Slim::Engine` class. This can be done in Rails' environment files. For instance, in config/environments/development.rb you probably want: ### Default options ~~~ ruby # Indent html for pretty debugging and do not sort attributes Slim::Engine.set_options pretty: true, sort_attrs: false ~~~ You can also access the option hash directly: ~~~ ruby Slim::Engine.options[:pretty] = true ~~~ ### Setting options at runtime There are two ways to set options at runtime. For Tilt templates (`Slim::Template`) you can set the options when you instantiate the template: ~~~ ruby Slim::Template.new('template.slim', optional_option_hash).render(scope) ~~~ The other possibility is to set the options per thread which is interesting mostly for Rails: ~~~ ruby Slim::Engine.with_options(option_hash) do # Any Slim engines which are created here use the option_hash # For example in Rails: render :page, layout: true end ~~~ You have to be aware that the compiled engine code and the options are cached per template in Rails and you cannot change the option afterwards. ~~~ ruby # First render call Slim::Engine.with_options(pretty: true) do render :page, layout: true end # Second render call Slim::Engine.with_options(pretty: false) do render :page, layout: true # :pretty is still true because it is cached end ~~~ ### Available options The following options are exposed by the `Slim::Engine` and can be set with `Slim::Engine.set_options`. There are a lot of them but the good thing is, that Slim checks the configuration keys and reports an error if you try to use an invalid configuration key. | Type | Name | Default | Purpose | | ---- | ---- | ------- | ------- | | String | :file | nil | Name of parsed file, set automatically by Slim::Template | | Integer | :tabsize | 4 | Number of white spaces per tab (used by the parser) | | String | :encoding | "utf-8" | Set encoding of template | | String | :default_tag | "div" | Default tag to be used if tag name is omitted | | Hash | :shortcut | \{'.' => {attr: 'class'}, '#' => {attr: 'id'}} | Attribute shortcuts | | Hash | :code_attr_delims | \{'(' => ')', '[' => ']', '{' => '}'} | Attribute delimiters for Ruby code attributes | | Hash | :attr_list_delims | \{'(' => ')', '[' => ']', '{' => '}'} | Attribute list delimiter | | Array<Symbol,String> | :enable_engines | nil (All enabled) | List of enabled embedded engines (whitelist) | | Array<Symbol,String> | :disable_engines | nil (None disabled) | List of disabled embedded engines (blacklist) | | Boolean | :disable_capture | false (true in Rails) | Disable capturing in blocks (blocks write to the default buffer | | Boolean | :disable_escape | false | Disable automatic escaping of strings | | Boolean | :use_html_safe | false (true in Rails) | Use String#html_safe? from ActiveSupport (Works together with :disable_escape) | | Symbol | :format | :xhtml | HTML output format (Possible formats :html, :xhtml, :xml) | | String | :attr_quote | '"' | Character to wrap attributes in html (can be ' or ") | | Hash | :merge_attrs | \{'class' => ' '} | Joining character used if multiple html attributes are supplied (e.g. class="class1 class2") | | Array<String> | :hyphen_attrs | %w(data) | Attributes which will be hyphenated if a Hash is given (e.g. data={a:1,b:2} will render as data-a="1" data-b="2") | | Boolean | :sort_attrs | true | Sort attributes by name | | Symbol | :js_wrapper | nil | Wrap javascript by :comment, :cdata or :both. You can also :guess the wrapper based on :format. | | Boolean | :pretty | false | Pretty HTML indenting, only block level tags are indented (This is slower!) | | String | :indent | ' ' | Indentation string | | Boolean | :streaming | false (true in Rails, see below how to disable it!) | Enable output streaming, improves the perceived performance | | Class | :generator | Temple::Generators::ArrayBuffer/ RailsOutputBuffer | Temple code generator (default generator generates array buffer) | | String | :buffer | '_buf' ('@output_buffer' in Rails) | Variable used for buffer | There are more options which are supported by the Temple filters but which are not exposed and are not officially supported. You have to take a look at the Slim and Temple code for that. ### Option priority and inheritance For developers who know more about Slim and Temple architecture it is possible to override default options at different positions. Temple uses an inheritance mechanism to allow subclasses to override options of the superclass. The option priorities are as follows: 1. `Slim::Template` options passed at engine instantiation 2. `Slim::Template.options` 3. `Slim::Engine.thread_options`, `Slim::Engine.options` 5. Parser/Filter/Generator `thread_options`, `options` (e.g `Slim::Parser`, `Slim::Compiler`) It is also possible to set options for superclasses like `Temple::Engine`. But this will affect all temple template engines then. ~~~ ruby Slim::Engine < Temple::Engine Slim::Compiler < Temple::Filter ~~~ ## Plugins Slim currently provides plugins for logic less mode, includes and I18n. See the plugin documentation. * [Logic less mode](doc/logic_less.md) * [Include partials](doc/include.md) * [Translator/I18n](doc/translator.md) * [Smart text mode](doc/smart.md) ## Framework support ### Tilt Slim uses [Tilt](https://github.com/rtomayko/tilt) to compile the generated code. If you want to use the Slim template directly, you can use the Tilt interface. ~~~ ruby Tilt.new['template.slim'].render(scope) 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 scope is the object in which the template code is executed. ### Sinatra ~~~ ruby require 'sinatra' require 'slim' get('/') { slim :index } __END__ @@ index doctype html html head title Sinatra With Slim body h1 Slim Is Fun! ~~~ ### Rails Rails generators are provided by [slim-rails](https://github.com/slim-template/slim-rails). slim-rails is not necessary to use Slim in Rails though. Just install Slim and add it to your Gemfile with `gem 'slim-rails'`. Then just use the .slim extension and you're good to go. #### Streaming HTTP streaming is enabled by default if you use a Rails version which supports it. However you have to be aware that streaming only improves the perceived performance. The rendering time in total will increase. If you want to disable it use: ~~~ ruby Slim::RailsTemplate.set_options streaming: false ~~~ ## Tools ### Slim Command 'slimrb' The gem 'slim' comes with the small tool 'slimrb' to test Slim from the command line.
$ slimrb --help
Usage: slimrb [options]
-s, --stdin Read input from standard input instead of an input file
--trace Show a full traceback on error
-c, --compile Compile only but do not run
-e, --erb Convert to ERB
--rails Generate rails compatible code (Implies --compile)
-r, --require library Load library or plugin with -r slim/plugin
-p, --pretty Produce pretty html
-o, --option name=code Set slim option
-l, --locals Hash|YAML|JSON Set local variables
-h, --help Show this message
-v, --version Print version
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:
$ slimrb markdown: First paragraph. Second paragraph. * one * two * three //Enter Ctrl-d <p>First paragraph </p> <p>Second paragraph </p> <ul> <li>one</li> <li>two</li> <li>three</li> </ul>### Syntax Highlighters There are plugins for various text editors (including the most important ones - Vim, Emacs and Textmate): * [Vim](https://github.com/slim-template/vim-slim) * [Emacs](https://github.com/slim-template/emacs-slim) * [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, ...) * Slim can be converted to ERB using `slimrb` or `Slim::ERBConverter' which are both included in the Slim gem * [Haml2Slim converter](https://github.com/slim-template/haml2slim) * [ERB2Slim, HTML2Slim converter](https://github.com/slim-template/html2slim) ## Testing ### Benchmarks *Yes, Slim is one of the fastest Ruby template engines out there! In production mode Slim is nearly as fast as Erubis (which is the fastest template engine). But we would be happy if you chose Slim also for any other reason, we assure you performance will not be an obstacle.* Run the benchmarks with `rake bench`. You can add the option `slow` to run the slow parsing benchmark which needs more time. You can also increase the number of iterations. ~~~ $ rake bench slow=1 iterations=1000 ~~~ We run the benchmarks for every commit on Travis-CI. Take a look at the newest benchmarking results: