"
end,
list: lambda do |&block|
list = [{key: 'First'}, {key: 'Second'}]
"
#{block.call(*list)}
"
end
}
assert_html '
Joe
Jack
Hello!
First
Second
', source, scope: hash
end
def test_symbol_hash
source = %q{
p
- person
.name = name
}
hash = {
person: [
{ name: 'Joe', },
{ name: 'Jack', }
]
}
assert_html '
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_method_access_without_private
source = %q{
p
- person
.age = age
}
object = Object.new
def object.person
person = Object.new
def person.age
42
end
person.singleton_class.class_eval { private :age }
person
end
assert_html '', 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 '
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: {prev_page: 'prev', next_page: 'next'}
end
def test_render_with_yield
source = %q{
div
== yield
}
assert_html '
This is the menu
', source do
'This is the menu'
end
end
end
slim-4.0.1/test/sinatra/ 0000755 0000041 0000041 00000000000 13411312757 015134 5 ustar www-data www-data slim-4.0.1/test/sinatra/test_core.rb 0000644 0000041 0000041 00000005115 13411312757 017452 0 ustar www-data www-data require_relative 'helper.rb'
begin
class SlimTest < Minitest::Test
it 'renders inline slim strings' do
slim_app { slim "h1 Hiya\n" }
assert ok?
assert_equal "
Hiya
", body
end
it 'renders .slim files in views path' do
slim_app { slim :hello }
assert ok?
assert_equal "
Hello From Slim
", body
end
it "renders with inline layouts" do
mock_app do
layout { %(h1\n | THIS. IS. \n == yield.upcase ) }
get('/') { slim 'em Sparta' }
end
get '/'
assert ok?
assert_equal "
THIS. IS. SPARTA
", body
end
it "renders with file layouts" do
slim_app { slim('| Hello World', :layout => :layout2) }
assert ok?
assert_equal "
Slim Layout!
Hello World
", body
end
it "raises error if template not found" do
mock_app { get('/') { slim(:no_such_template) } }
assert_raises(Errno::ENOENT) { get('/') }
end
HTML4_DOCTYPE = ""
it "passes slim options to the slim engine" do
mock_app { get('/') { slim("x foo='bar'", :attr_quote => "'") }}
get '/'
assert ok?
assert_body ""
end
it "passes default slim options to the slim engine" do
mock_app do
set :slim, :attr_quote => "'"
get('/') { slim("x foo='bar'") }
end
get '/'
assert ok?
assert_body ""
end
it "merges the default slim options with the overrides and passes them to the slim engine" do
mock_app do
set :slim, :attr_quote => "'"
get('/') { slim("x foo='bar'") }
get('/other') { slim("x foo='bar'", :attr_quote => '"') }
end
get '/'
assert ok?
assert_body ""
get '/other'
assert ok?
assert_body ''
end
it "can render truly nested layouts by accepting a layout and a block with the contents" do
mock_app do
template(:main_outer_layout) { "h1 Title\n== yield" }
template(:an_inner_layout) { "h2 Subtitle\n== yield" }
template(:a_page) { "p Contents." }
get('/') do
slim :main_outer_layout, :layout => false do
slim :an_inner_layout do
slim :a_page
end
end
end
end
get '/'
assert ok?
assert_body "
Title
\n
Subtitle
\n
Contents.
\n"
end
end
rescue LoadError
warn "#{$!}: skipping slim tests"
end
slim-4.0.1/test/sinatra/helper.rb 0000644 0000041 0000041 00000006422 13411312757 016744 0 ustar www-data www-data if ENV['COVERAGE']
require 'simplecov'
SimpleCov.start do
add_filter '/test/'
add_group 'sinatra-contrib', 'sinatra-contrib'
add_group 'rack-protection', 'rack-protection'
end
end
ENV['APP_ENV'] = 'test'
Encoding.default_external = "UTF-8" if defined? Encoding
RUBY_ENGINE = 'ruby' unless defined? RUBY_ENGINE
require 'rack'
testdir = File.dirname(__FILE__)
$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
require 'minitest'
require 'contest'
require 'rack/test'
require 'sinatra'
require 'sinatra/base'
class Sinatra::Base
include Minitest::Assertions
# Allow assertions in request context
def assertions
@assertions ||= 0
end
attr_writer :assertions
end
class Rack::Builder
def include?(middleware)
@ins.any? { |m| middleware === m }
end
end
Sinatra::Base.set :environment, :test
class Minitest::Test
include Rack::Test::Methods
class << self
alias_method :it, :test
alias_method :section, :context
end
def self.example(desc = nil, &block)
@example_count = 0 unless instance_variable_defined? :@example_count
@example_count += 1
it(desc || "Example #{@example_count}", &block)
end
alias_method :response, :last_response
setup do
Sinatra::Base.set :environment, :test
end
# Sets up a Sinatra::Base subclass defined with the block
# given. Used in setup or individual spec methods to establish
# the application.
def mock_app(base=Sinatra::Base, &block)
@app = Sinatra.new(base, &block)
end
def app
Rack::Lint.new(@app)
end
def slim_app(&block)
mock_app do
set :views, File.dirname(__FILE__) + '/views'
get('/', &block)
end
get '/'
end
def body
response.body.to_s
end
def assert_body(value)
if value.respond_to? :to_str
assert_equal value.lstrip.gsub(/\s*\n\s*/, ""), body.lstrip.gsub(/\s*\n\s*/, "")
else
assert_match value, body
end
end
def assert_status(expected)
assert_equal Integer(expected), Integer(status)
end
def assert_like(a,b)
pattern = /id=['"][^"']*["']|\s+/
assert_equal a.strip.gsub(pattern, ""), b.strip.gsub(pattern, "")
end
def assert_include(str, substr)
assert str.include?(substr), "expected #{str.inspect} to include #{substr.inspect}"
end
def options(uri, params = {}, env = {}, &block)
request(uri, env.merge(:method => "OPTIONS", :params => params), &block)
end
def patch(uri, params = {}, env = {}, &block)
request(uri, env.merge(:method => "PATCH", :params => params), &block)
end
def link(uri, params = {}, env = {}, &block)
request(uri, env.merge(:method => "LINK", :params => params), &block)
end
def unlink(uri, params = {}, env = {}, &block)
request(uri, env.merge(:method => "UNLINK", :params => params), &block)
end
# Delegate other missing methods to response.
def method_missing(name, *args, &block)
if response && response.respond_to?(name)
response.send(name, *args, &block)
else
super
end
rescue Rack::Test::Error
super
end
# Do not output warnings for the duration of the block.
def silence_warnings
$VERBOSE, v = nil, $VERBOSE
yield
ensure
$VERBOSE = v
end
end
slim-4.0.1/test/sinatra/contest.rb 0000644 0000041 0000041 00000006245 13411312757 017147 0 ustar www-data www-data # Copyright (c) 2009 Damian Janowski and Michel Martens for Citrusbyte
#
# 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.
require "rubygems"
require "minitest/autorun"
# Contest adds +teardown+, +test+ and +context+ as class methods, and the
# instance methods +setup+ and +teardown+ now iterate on the corresponding
# blocks. Note that all setup and teardown blocks must be defined with the
# block syntax. Adding setup or teardown instance methods defeats the purpose
# of this library.
class Minitest::Test
def self.setup(&block) setup_blocks << block end
def self.teardown(&block) teardown_blocks << block end
def self.setup_blocks() @setup_blocks ||= [] end
def self.teardown_blocks() @teardown_blocks ||= [] end
def setup_blocks(base = self.class)
setup_blocks base.superclass if base.superclass.respond_to? :setup_blocks
base.setup_blocks.each do |block|
instance_eval(&block)
end
end
def teardown_blocks(base = self.class)
teardown_blocks base.superclass if base.superclass.respond_to? :teardown_blocks
base.teardown_blocks.each do |block|
instance_eval(&block)
end
end
alias setup setup_blocks
alias teardown teardown_blocks
def self.context(*name, &block)
subclass = Class.new(self)
remove_tests(subclass)
subclass.class_eval(&block) if block_given?
const_set(context_name(name.join(" ")), subclass)
end
def self.test(name, &block)
define_method(test_name(name), &block)
end
class << self
alias_method :should, :test
alias_method :describe, :context
end
private
def self.context_name(name)
# "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
name = "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}"
name.tr(" ", "_").to_sym
end
def self.test_name(name)
name = "test_#{sanitize_name(name).gsub(/\s+/,'_')}_0"
name = name.succ while method_defined? name
name.to_sym
end
def self.sanitize_name(name)
# name.gsub(/\W+/, ' ').strip
name.gsub(/\W+/, ' ')
end
def self.remove_tests(subclass)
subclass.public_instance_methods.grep(/^test_/).each do |meth|
subclass.send(:undef_method, meth.to_sym)
end
end
end
slim-4.0.1/test/sinatra/test_include.rb 0000644 0000041 0000041 00000000727 13411312757 020151 0 ustar www-data www-data require 'slim/include'
require_relative 'helper.rb'
begin
class SlimTest < Minitest::Test
it 'renders .slim files includes with js embed' do
slim_app { slim :embed_include_js }
assert ok?
assert_equal "Slim Examples", body
end
end
rescue LoadError
warn "#{$!}: skipping slim tests"
end
slim-4.0.1/test/sinatra/views/ 0000755 0000041 0000041 00000000000 13411312757 016271 5 ustar www-data www-data slim-4.0.1/test/sinatra/views/hello.slim 0000644 0000041 0000041 00000000023 13411312757 020255 0 ustar www-data www-data h1 Hello From Slim
slim-4.0.1/test/sinatra/views/embed_include_js.slim 0000644 0000041 0000041 00000000222 13411312757 022426 0 ustar www-data www-data doctype html
html
head
title Slim Examples
javascript:
alert('Slim supports embedded javascript!')
body
include footer.slim
slim-4.0.1/test/sinatra/views/embed_js.slim 0000644 0000041 0000041 00000000333 13411312757 020726 0 ustar www-data www-data doctype html
html
head
title Slim Examples
javascript:
alert('Slim supports embedded javascript!')
body
h1 Markup examples
#content
p This example shows you how a basic Slim file looks.
slim-4.0.1/test/sinatra/views/footer.slim 0000644 0000041 0000041 00000000014 13411312757 020450 0 ustar www-data www-data footer Slim
slim-4.0.1/test/sinatra/views/layout2.slim 0000644 0000041 0000041 00000000035 13411312757 020554 0 ustar www-data www-data h1 Slim Layout!
p
== yield
slim-4.0.1/test/core/ 0000755 0000041 0000041 00000000000 13411312757 014423 5 ustar www-data www-data slim-4.0.1/test/core/test_html_attributes.rb 0000644 0000041 0000041 00000014451 13411312757 021226 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 '
', source
end
def test_weird_attribute
source = %q{
p
img(src='img.png' whatsthis?!)
img src='img.png' whatsthis?!="wtf"
}
assert_html '
', source
end
end
slim-4.0.1/test/core/test_html_structure.rb 0000644 0000041 0000041 00000033546 13411312757 021106 0 ustar www-data www-data require 'helper'
class TestSlimHtmlStructure < TestSlim
def test_simple_render
# Keep the trailing space behind "body "!
source = %q{
html
head
title Simple Test Title
body
p Hello World, meet Slim.
}
assert_html 'Simple Test Title
Hello World, meet Slim.
', source
end
def test_relaxed_indentation_of_first_line
source = %q{
p
.content
}
assert_html "", source
end
def test_html_tag_with_text_and_empty_line
source = %q{
p Hello
p World
}
assert_html "
Hello
World
", source
end
def test_html_namespaces
source = %q{
html:body
html:p html:id="test" Text
}
assert_html 'Text', source
end
def test_doctype
source = %q{
doctype 1.1
html
}
assert_html '', source, format: :xhtml
end
def test_doctype_new_syntax
source = %q{
doctype 5
html
}
assert_html '', source, format: :xhtml
end
def test_doctype_new_syntax_html5
source = %q{
doctype html
html
}
assert_html '', source, format: :xhtml
end
def test_render_with_shortcut_attributes
source = %q{
h1#title This is my title
#notice.hello.world
= hello_world
}
assert_html '
This is my title
Hello World from @env
', source
end
def test_render_with_overwritten_default_tag
source = %q{
#notice.hello.world
= hello_world
}
assert_html 'Hello World from @env', source, default_tag: 'section'
end
def test_render_with_custom_shortcut
source = %q{
#notice.hello.world@test
= hello_world
@abc
= hello_world
}
assert_html '
Hello World from @env
Hello World from @env', source, shortcut: {'#' => {attr: 'id'}, '.' => {attr: 'class'}, '@' => {tag: 'section', attr: 'role'}}
end
def test_render_with_custom_array_shortcut
source = %q{
#user@.admin Daniel
}
assert_html '
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
', source
end
def test_render_with_text_block_with_subsequent_markup
source = %q{
p
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
p Some more markup
}
assert_html '
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Some more markup
', source
end
def test_render_with_text_block_with_trailing_whitespace
source = %q{
' this is
a link to
a href="link" page
}
assert_html "this is\na link to page", source
end
def test_nested_text
source = %q{
p
|
This is line one.
This is line two.
This is line three.
This is line four.
p This is a new paragraph.
}
assert_html "
This is line one.\n This is line two.\n This is line three.\n This is line four.
This is a new paragraph.
", source
end
def test_nested_text_with_nested_html_one_same_line
source = %q{
p
| This is line one.
This is line two.
span.bold This is a bold line in the paragraph.
| This is more content.
}
assert_html "
This is line one.\n This is line two.This is a bold line in the paragraph. This is more content.
", source
end
def test_nested_text_with_nested_html_one_same_line2
source = %q{
p
|This is line one.
This is line two.
span.bold This is a bold line in the paragraph.
| This is more content.
}
assert_html "
This is line one.\n This is line two.This is a bold line in the paragraph. This is more content.
", source
end
def test_nested_text_with_nested_html
source = %q{
p
|
This is line one.
This is line two.
This is line three.
This is line four.
span.bold This is a bold line in the paragraph.
| This is more content.
}
assert_html "
This is line one.\n This is line two.\n This is line three.\n This is line four.This is a bold line in the paragraph. This is more content.
", source
end
def test_simple_paragraph_with_padding
source = %q{
p There will be 3 spaces in front of this line.
}
assert_html '
There will be 3 spaces in front of this line.
', source
end
def test_paragraph_with_nested_text
source = %q{
p This is line one.
This is line two.
}
assert_html "
This is line one.\n This is line two.
", source
end
def test_paragraph_with_padded_nested_text
source = %q{
p This is line one.
This is line two.
}
assert_html "
This is line one.\n This is line two.
", source
end
def test_paragraph_with_attributes_and_nested_text
source = %q{
p#test class="paragraph" This is line one.
This is line two.
}
assert_html "
This is line one.\nThis is line two.
", source
end
def test_relaxed_text_indentation
source = %q{
p
| text block
text
line3
}
assert_html "
text block\ntext\n line3
", source
end
def test_output_code_with_leading_spaces
source = %q{
p= hello_world
p = hello_world
p = hello_world
}
assert_html '
Hello World from @env
Hello World from @env
Hello World from @env
', source
end
def test_single_quoted_attributes
source = %q{
p class='underscored_class_name' = output_number
}
assert_html '
1337
', source
end
def test_nonstandard_attributes
source = %q{
p id="dashed-id" class="underscored_class_name" = output_number
}
assert_html '
', source, attr_list_delims: {'<' => '>'}, code_attr_delims: { '(' => ')' }
end
def test_attributs_with_parens_and_spaces
source = %q{label{ for='filter' }= hello_world}
assert_html '', source
end
def test_attributs_with_parens_and_spaces2
source = %q{label{ for='filter' } = hello_world}
assert_html '', source
end
def test_attributs_with_multiple_spaces
source = %q{label for='filter' class="test" = hello_world}
assert_html '', source
end
def test_closed_tag_with_attributes
source = %q{
closed id="test" /
}
assert_html '', source, format: :xhtml
end
def test_closed_tag_with_attributes_and_parens
source = %q{
closed(id="test")/
}
assert_html '', source, format: :xhtml
end
def test_render_with_html_comments
source = %q{
p Hello
/! This is a comment
Another comment
p World
}
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{
p = output_number
}
Slim::Parser.options[:attr_list_delims].each do |k,v|
str = source.sub('<',k).sub('>',v)
assert_html '
1337
', str
end
end
def test_multiline_attributes_with_text_on_same_line
source = %q{
p THE space modulator
}
Slim::Parser.options[:attr_list_delims].each do |k,v|
str = source.sub('<',k).sub('>',v)
assert_html '
THE space modulator
', str
end
end
def test_multiline_attributes_with_nested_text
source = %q{
p
| THE space modulator
}
Slim::Parser.options[:attr_list_delims].each do |k,v|
str = source.sub('<',k).sub('>',v)
assert_html '
THE space modulator
', str
end
end
def test_multiline_attributes_with_dynamic_attr
source = %q{
p
| THE space modulator
}
Slim::Parser.options[:attr_list_delims].each do |k,v|
str = source.sub('<',k).sub('>',v)
assert_html '
THE space modulator
', str
end
end
def test_multiline_attributes_with_nested_tag
source = %q{
p
span.emphasis THE
| space modulator
}
Slim::Parser.options[:attr_list_delims].each do |k,v|
str = source.sub('<',k).sub('>',v)
assert_html '
THE 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 '
', source
end
end
slim-4.0.1/test/core/test_code_escaping.rb 0000644 0000041 0000041 00000007434 13411312757 020602 0 ustar www-data www-data require 'helper'
class TestSlimCodeEscaping < TestSlim
def test_escaping_evil_method
source = %q{
p = evil_method
}
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_splat_injecting_evil_attr_name
source = %q{
p *{ ">
'test' }
}
with_html_safe do
assert_raises Slim::InvalidAttributeNameError do
render(source, use_html_safe: true)
end
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 "
", source, disable_escape: true, pretty: true
end
end
slim-4.0.1/test/core/test_thread_options.rb 0000644 0000041 0000041 00000001003 13411312757 021023 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-4.0.1/test/core/test_splat_prefix_option.rb 0000644 0000041 0000041 00000007302 13411312757 022101 0 ustar www-data www-data require 'helper'
class TestSplatPrefixOption < TestSlim
def prefixes
['*','**','*!','*%','*^','*$']
end
def options(prefix)
{ splat_prefix: prefix }
end
def test_splat_without_content
prefixes.each do |prefix|
source = %Q{
#{prefix}hash
p#{prefix}hash
}
assert_html '', source, options(prefix)
end
end
def test_shortcut_splat
prefixes.each do |prefix|
source = %Q{
#{prefix}hash This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_splat
prefixes.each do |prefix|
source = %Q{
h1 #{prefix}hash class=[] This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_closed_splat
prefixes.each do |prefix|
source = %Q{
#{prefix}hash /
}
assert_html '', source, options(prefix)
end
end
def test_splat_tag_name
prefixes.each do |prefix|
source = %Q{
#{prefix}{tag: 'h1', id: 'title'} This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_splat_empty_tag_name
prefixes.each do |prefix|
source = %Q{
#{prefix}{tag: '', id: 'test'} This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_closed_splat_tag
prefixes.each do |prefix|
source = %Q{
#{prefix}hash /
}
assert_html '', source, options(prefix)
end
end
def test_splat_with_id_shortcut
prefixes.each do |prefix|
source = %Q{
#myid#{prefix}hash This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_splat_with_class_shortcut
prefixes.each do |prefix|
source = %Q{
.myclass#{prefix}hash This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_splat_with_id_and_class_shortcuts
prefixes.each do |prefix|
source = %Q{
#myid.myclass#{prefix}hash This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_splat_with_class_merging
prefixes.each do |prefix|
source = %Q{
#myid.myclass #{prefix}{class: [:secondclass, %w(x y z)]} #{prefix}hash This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_splat_with_boolean_attribute
prefixes.each do |prefix|
source = %Q{
#{prefix}{disabled: true, empty1: false, nonempty: '', empty2: nil} This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_splat_merging_with_arrays
prefixes.each do |prefix|
source = %Q{
#{prefix}{a: 1, b: 2} #{prefix}[[:c, 3], [:d, 4]] #{prefix}[[:e, 5], [:f, 6]] This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
def test_splat_with_other_attributes
prefixes.each do |prefix|
source = %Q{
h1 data-id="123" #{prefix}hash This is my title
}
assert_html '
This is my title
', source, options(prefix)
end
end
end
slim-4.0.1/test/core/test_text_interpolation.rb 0000644 0000041 0000041 00000003201 13411312757 021736 0 ustar www-data www-data require 'helper'
class TestSlimTextInterpolation < TestSlim
def test_interpolation_in_attribute
source = %q{
p id="a#{id_helper}b" = hello_world
}
assert_html '
Hello World from @env
', source
end
def test_nested_interpolation_in_attribute
source = %q{
p id="#{"abc#{1+1}" + "("}" = hello_world
}
assert_html '
Hello World from @env
', source
end
def test_interpolation_in_text
source = %q{
p
| #{hello_world} with "quotes"
p
|
A message from the compiler: #{hello_world}
}
assert_html '
Hello World from @env with "quotes"
A message from the compiler: Hello World from @env
', source
end
def test_interpolation_in_tag
source = %q{
p #{hello_world}
}
assert_html '
Hello World from @env
', source
end
def test_escape_interpolation
source = %q{
p \\#{hello_world}
p text1 \\#{hello_world} text2
}
assert_html '
#{hello_world}
text1 #{hello_world} text2
', source
end
def test_complex_interpolation
source = %q{
p Message: #{message('hello', "user #{output_number}")}
}
assert_html '
Message: hello user 1337
', source
end
def test_interpolation_with_escaping
source = %q{
| #{evil_method}
}
assert_html '<script>do_something_evil();</script>', source
end
def test_interpolation_without_escaping
source = %q{
| #{{evil_method}}
}
assert_html '', source
end
def test_interpolation_with_escaping_and_delimiter
source = %q{
| #{(evil_method)}
}
assert_html '<script>do_something_evil();</script>', source
end
end
slim-4.0.1/test/core/test_pretty.rb 0000644 0000041 0000041 00000005664 13411312757 017351 0 ustar www-data www-data require 'helper'
class TestSlimPretty < TestSlim
def setup
super
Slim::Engine.set_options pretty: true
end
def teardown
Slim::Engine.set_options pretty: false
end
def test_pretty
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!
}
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-4.0.1/test/core/test_code_blocks.rb 0000644 0000041 0000041 00000007577 13411312757 020276 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_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
end
slim-4.0.1/test/core/test_code_structure.rb 0000644 0000041 0000041 00000005636 13411312757 021053 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
', source
end
def test_render_with_begin
source = %q{
- if true
- begin
p A
- if true
- begin
p B
- if true
- begin
p C
- rescue
p D
}
assert_html '
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
', source
end
def test_render_with_parameterized_conditional
source = %q{
div
- if show_first? false
p The first paragraph
- else
p The second paragraph
}
assert_html '
The second paragraph
', source
end
def test_render_with_when_string_in_condition
source = %q{
- if true
| Hello
- unless 'when' == nil
| world
}
assert_html 'Hello world', source
end
def test_render_with_conditional_and_following_nonconditonal
source = %q{
div
- if true
p The first paragraph
- var = 42
= var
}
assert_html '
The first paragraph
42
', source
end
def test_render_with_inline_condition
source = %q{
p = hello_world if true
}
assert_html '
Hello 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-4.0.1/test/core/test_erb_converter.rb 0000644 0000041 0000041 00000003074 13411312757 020652 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!
Hello
World!
<%= ::Temple::Utils.escape_html(("dynamic text with\nnewline")) %>
}
assert_equal result, Slim::ERBConverter.new.call(source)
end
end
slim-4.0.1/test/core/test_slim_template.rb 0000644 0000041 0000041 00000004163 13411312757 020652 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 "
", 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
template.render(Object.new, name: 'Joe', foo: 'bar')
fail 'should have raised an exception'
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-4.0.1/test/core/test_commands.rb 0000644 0000041 0000041 00000014434 13411312757 017616 0 ustar www-data www-data 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 %r{Show this message}, out
end
def test_option_version
out, err = exec_slimrb '--version'
assert err.empty?
assert_match %r{\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(("
"#{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\n
Hello 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 %r{NotImplementedError: NotImplementedError}, err
assert_match %r{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 %r{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-4.0.1/test/core/test_unicode.rb 0000644 0000041 0000041 00000000603 13411312757 017434 0 ustar www-data www-data 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-4.0.1/test/core/test_html_escaping.rb 0000644 0000041 0000041 00000002456 13411312757 020633 0 ustar www-data www-data require 'helper'
class TestSlimHtmlEscaping < TestSlim
def test_html_will_not_be_escaped
source = %q{
p World, meet "Slim".
}
assert_html '
World, meet "Slim".
', source
end
def test_html_with_newline_will_not_be_escaped
source = %q{
p
|
World,
meet "Slim".
}
assert_html "
World,\n meet \"Slim\".
", source
end
def test_html_with_escaped_interpolation
source = %q{
- x = '"'
- content = ''
p class="#{x}" test #{content}
}
assert_html '
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-4.0.1/test/rails/ 0000755 0000041 0000041 00000000000 13411312757 014605 5 ustar www-data www-data slim-4.0.1/test/rails/test/ 0000755 0000041 0000041 00000000000 13411312757 015564 5 ustar www-data www-data slim-4.0.1/test/rails/test/helper.rb 0000644 0000041 0000041 00000001750 13411312757 017373 0 ustar www-data www-data # Configure Rails Envinronment
ENV["RAILS_ENV"] = "test"
require File.expand_path("../../config/environment.rb", __FILE__)
require "rails/test_help"
require "nokogiri"
require 'rails-controller-testing'
Rails::Controller::Testing.install
Rails.backtrace_cleaner.remove_silencers!
class ActionDispatch::IntegrationTest
protected
def assert_xpath(xpath, message="Unable to find '#{xpath}' in response body.")
assert_response :success, "Response type is not :success (code 200..299)."
body = @response.body
assert !body.empty?, "No response body found."
doc = Nokogiri::HTML(body) rescue nil
assert_not_nil doc, "Cannot parse response body."
assert doc.xpath(xpath).size >= 1, message
end
def assert_html(expected, options = {})
expected = "Dummy#{options[:heading]}
#{expected}
" unless options[:skip_layout]
assert_equal expected, @response.body
end
end
slim-4.0.1/test/rails/test/test_slim.rb 0000644 0000041 0000041 00000005344 13411312757 020122 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\nDummy\r\nd\r\n\r\n17\r\nHeading set from a view\r\n15\r\n
\r\n53\r\n
Page content
Hello Streaming!
Hello Streaming!
\r\n14\r\n
\r\n0\r\n\r\n"
assert_equal output, @response.body
end
end
test "render integers" do
get "/slim/integers"
assert_html "
1337
"
end
test "render thread_options" do
get "/slim/thread_options", params: { attr: 'role'}
assert_html '
Test
'
get "/slim/thread_options", params: { 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 "
Hello
"
end
end
slim-4.0.1/test/rails/config.ru 0000644 0000041 0000041 00000000233 13411312757 016420 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-4.0.1/test/rails/script/ 0000755 0000041 0000041 00000000000 13411312757 016111 5 ustar www-data www-data slim-4.0.1/test/rails/script/rails 0000755 0000041 0000041 00000000447 13411312757 017156 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-4.0.1/test/rails/app/ 0000755 0000041 0000041 00000000000 13411312757 015365 5 ustar www-data www-data slim-4.0.1/test/rails/app/helpers/ 0000755 0000041 0000041 00000000000 13411312757 017027 5 ustar www-data www-data slim-4.0.1/test/rails/app/helpers/application_helper.rb 0000644 0000041 0000041 00000000146 13411312757 023217 0 ustar www-data www-data module ApplicationHelper
def headline(&block)
"
#{capture(&block)}
".html_safe
end
end
slim-4.0.1/test/rails/app/controllers/ 0000755 0000041 0000041 00000000000 13411312757 017733 5 ustar www-data www-data slim-4.0.1/test/rails/app/controllers/application_controller.rb 0000644 0000041 0000041 00000000071 13411312757 025024 0 ustar www-data www-data class ApplicationController < ActionController::Base
end
slim-4.0.1/test/rails/app/controllers/entries_controller.rb 0000644 0000041 0000041 00000000134 13411312757 024172 0 ustar www-data www-data class EntriesController < ApplicationController
def edit
@entry = Entry.new
end
end
slim-4.0.1/test/rails/app/controllers/slim_controller.rb 0000644 0000041 0000041 00000001050 13411312757 023463 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-4.0.1/test/rails/app/models/ 0000755 0000041 0000041 00000000000 13411312757 016650 5 ustar www-data www-data slim-4.0.1/test/rails/app/models/entry.rb 0000644 0000041 0000041 00000000374 13411312757 020342 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-4.0.1/test/rails/app/views/ 0000755 0000041 0000041 00000000000 13411312757 016522 5 ustar www-data www-data slim-4.0.1/test/rails/app/views/entries/ 0000755 0000041 0000041 00000000000 13411312757 020173 5 ustar www-data www-data slim-4.0.1/test/rails/app/views/entries/edit.html.slim 0000644 0000041 0000041 00000000100 13411312757 022740 0 ustar www-data www-data = form_for @entry do |f|
label: b Name
= f.text_field :name
slim-4.0.1/test/rails/app/views/layouts/ 0000755 0000041 0000041 00000000000 13411312757 020222 5 ustar www-data www-data slim-4.0.1/test/rails/app/views/layouts/application.html.slim 0000644 0000041 0000041 00000000164 13411312757 024357 0 ustar www-data www-data doctype html
html
head
title Dummy
= csrf_meta_tag
body
= yield :page_heading
.content= yield
slim-4.0.1/test/rails/app/views/slim/ 0000755 0000041 0000041 00000000000 13411312757 017466 5 ustar www-data www-data slim-4.0.1/test/rails/app/views/slim/no_layout.html.slim 0000644 0000041 0000041 00000000037 13411312757 023330 0 ustar www-data www-data h1 Hello Slim without a layout! slim-4.0.1/test/rails/app/views/slim/form_for.html.slim 0000644 0000041 0000041 00000000060 13411312757 023124 0 ustar www-data www-data = form_for @entry do |f|
= f.text_field :name
slim-4.0.1/test/rails/app/views/slim/thread_options.html.slim 0000644 0000041 0000041 00000000015 13411312757 024335 0 ustar www-data www-data p@empty Test
slim-4.0.1/test/rails/app/views/slim/variables.html.slim 0000644 0000041 0000041 00000000012 13411312757 023260 0 ustar www-data www-data h1= @hello slim-4.0.1/test/rails/app/views/slim/_partial.html.slim 0000644 0000041 0000041 00000000021 13411312757 023103 0 ustar www-data www-data p With a partial! slim-4.0.1/test/rails/app/views/slim/integers.html.slim 0000644 0000041 0000041 00000000013 13411312757 023131 0 ustar www-data www-data p= @integer slim-4.0.1/test/rails/app/views/slim/content_for.html.slim 0000644 0000041 0000041 00000000233 13411312757 023635 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-4.0.1/test/rails/app/views/slim/helper.html.slim 0000644 0000041 0000041 00000000053 13411312757 022574 0 ustar www-data www-data p
= headline do
' Hello
= 'User'
slim-4.0.1/test/rails/app/views/slim/normal.html.slim 0000644 0000041 0000041 00000000016 13411312757 022604 0 ustar www-data www-data h1 Hello Slim! slim-4.0.1/test/rails/app/views/slim/xml.slim 0000644 0000041 0000041 00000000016 13411312757 021151 0 ustar www-data www-data h1 Hello Slim! slim-4.0.1/test/rails/app/views/slim/splat.html.slim 0000644 0000041 0000041 00000000037 13411312757 022442 0 ustar www-data www-data #splat
*{tag: 'splat'} Hello
slim-4.0.1/test/rails/app/views/slim/erb.html.erb 0000644 0000041 0000041 00000000023 13411312757 021666 0 ustar www-data www-data
Hello Erb!
slim-4.0.1/test/rails/app/views/slim/partial.html.slim 0000644 0000041 0000041 00000000041 13411312757 022746 0 ustar www-data www-data h1 Hello Slim!
= render "partial" slim-4.0.1/test/rails/Rakefile 0000644 0000041 0000041 00000000411 13411312757 016246 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-4.0.1/test/rails/config/ 0000755 0000041 0000041 00000000000 13411312757 016052 5 ustar www-data www-data slim-4.0.1/test/rails/config/boot.rb 0000644 0000041 0000041 00000000417 13411312757 017344 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-4.0.1/test/rails/config/routes.rb 0000644 0000041 0000041 00000003402 13411312757 017717 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-4.0.1/test/rails/config/initializers/ 0000755 0000041 0000041 00000000000 13411312757 020560 5 ustar www-data www-data slim-4.0.1/test/rails/config/initializers/backtrace_silencers.rb 0000644 0000041 0000041 00000000624 13411312757 025075 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-4.0.1/test/rails/config/initializers/inflections.rb 0000644 0000041 0000041 00000000570 13411312757 023424 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-4.0.1/test/rails/config/initializers/session_store.rb 0000644 0000041 0000041 00000000627 13411312757 024011 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-4.0.1/test/rails/config/initializers/mime_types.rb 0000644 0000041 0000041 00000000315 13411312757 023257 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-4.0.1/test/rails/config/initializers/secret_token.rb 0000644 0000041 0000041 00000001034 13411312757 023570 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-4.0.1/test/rails/config/application.rb 0000644 0000041 0000041 00000005221 13411312757 020702 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 "sprockets/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]
# From slim-rails fix for "ActionView::Template::Error: Unknown line indicator"
# https://github.com/slim-template/slim-rails/blob/991589ea5648e5e896781e68912bc51beaf4102a/lib/slim-rails/register_engine.rb
if config.respond_to?(:assets)
config.assets.configure do |env|
if env.respond_to?(:register_transformer) && Sprockets::VERSION.to_i > 3
env.register_mime_type 'text/slim', extensions: ['.slim', '.slim.html']
env.register_transformer 'text/slim', 'text/html', RegisterEngine::Transformer
elsif env.respond_to?(:register_engine)
args = ['.slim', Slim::Template]
args << { silence_deprecation: true } if Sprockets::VERSION.start_with?('3')
env.register_engine(*args)
end
end
end
end
end
slim-4.0.1/test/rails/config/locales/ 0000755 0000041 0000041 00000000000 13411312757 017474 5 ustar www-data www-data slim-4.0.1/test/rails/config/locales/en.yml 0000644 0000041 0000041 00000000325 13411312757 020621 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-4.0.1/test/rails/config/environment.rb 0000644 0000041 0000041 00000000225 13411312757 020742 0 ustar www-data www-data # Load the rails application
require File.expand_path('../application', __FILE__)
# Initialize the rails application
Dummy::Application.initialize!
slim-4.0.1/test/rails/config/environments/ 0000755 0000041 0000041 00000000000 13411312757 020601 5 ustar www-data www-data slim-4.0.1/test/rails/config/environments/test.rb 0000644 0000041 0000041 00000002645 13411312757 022114 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-4.0.1/test/literate/ 0000755 0000041 0000041 00000000000 13411312757 015304 5 ustar www-data www-data slim-4.0.1/test/literate/run.rb 0000644 0000041 0000041 00000004624 13411312757 016443 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-4.0.1/test/literate/helper.rb 0000644 0000041 0000041 00000000704 13411312757 017111 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-4.0.1/test/literate/TESTS.md 0000644 0000041 0000041 00000045737 13411312757 016550 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
Example
yes
~~~
### Control code `-`
The dash `-` denotes arbitrary control code.
~~~ slim
- greeting = 'Hello, World!'
- if false
| Not true
- else
= greeting
~~~
renders as
~~~ html
Hello, World!
~~~
Complex code can be broken with backslash `\`.
~~~ slim
- greeting = 'Hello, '+\
\
'World!'
- if false
| Not true
- else
= greeting
~~~
renders as
~~~ html
Hello, World!
~~~
You can also write loops like this
~~~ slim
- items = [{name: 'table', price: 10}, {name: 'chair', price: 5}]
table#items
- for item in items do
tr
td.name = item[:name]
td.price = item[:price]
~~~
which renders as
~~~ html
table
10
chair
5
~~~
The `do` keyword can be omitted.
~~~ slim
- items = [{name: 'table', price: 10}, {name: 'chair', price: 5}]
table#items
- for item in items
tr
td.name = item[:name]
td.price = item[:price]
~~~
which renders as
~~~ html
table
10
chair
5
~~~
### Output `=`
The equal sign `=` produces dynamic output.
~~~ slim
= 7*7
~~~
renders as
~~~ html
49
~~~
Dynamic output is escaped by default.
~~~ slim
= ''
~~~
renders as
~~~ html
<script>evil();</script>
~~~
Long code lines can be broken with `\`.
~~~ slim
= (0..10).map do |i|\
2**i \
end.join(', ')
~~~
renders as
~~~ html
1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024
~~~
You don't need the explicit `\` if the line ends with a comma `,`.
~~~ slim
ruby:
def test(*args)
args.join('-')
end
= test('arg1',
'arg2',
'arg3')
~~~
renders as
~~~ html
arg1-arg2-arg3
~~~
You can also disable HTML escaping globally by setting the option
~~~ options
:disable_escape => true
~~~
~~~ slim
= ''
~~~
renders as
~~~ html
~~~
The equal sign with modifier `=>` produces dynamic output with a trailing white space.
~~~ slim
=> 7*7
~~~
renders as
~~~ html
49
~~~
~~~ slim
=< 7*7
~~~
renders as
~~~ html
49
~~~
The equal sign with modifier `=<` produces dynamic output with a leading white space.
~~~ slim
=< 7*7
~~~
renders as
~~~ html
49
~~~
The equal sign with modifiers `=<>` produces dynamic output with a leading and trailing white space.
~~~ slim
=<> 7*7
~~~
renders as
~~~ html
49
~~~
### Output without HTML escaping `==`
The double equal sign `==` produces dynamic output without HTML escaping.
~~~ slim
== ''
~~~
renders as
~~~ html
~~~
The option option
~~~ options
:disable_escape => true
~~~
doesn't affect the output of `==`.
~~~ slim
== ''
~~~
renders as
~~~ html
~~~
The double equal sign with modifier `==>` produces dynamic output without HTML escaping and trailing white space.
~~~ slim
==> ''
~~~
renders as
~~~ html
~~~
The option option
~~~ options
:disable_escape => true
~~~
doesn't affect the output of `==`.
~~~ slim
==> ''
~~~
renders as
~~~ html
~~~
### Code comment `/`
Code comments begin with `/` and produce no output.
~~~ slim
/ Comment
body
/ Another comment
with
multiple lines
p Hello!
~~~
renders as
~~~ html
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
~~~ html
Hello!
~~~
### 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 `>`.
~~~ slim
a#closed> class="test" /
a#closed> class="test"/
a> href='url1' Link1
a< href='url1' Link1
~~~
renders as
~~~ html
Link1Link1
~~~
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
Text1Text2Text3Text4Text5Text6Text7
~~~
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
Link1Link2
~~~
You can also combine both.
~~~ slim
a#closed<> class="test" /
a#closed>< class="test"/
a<> href='url1' Link1
a<> href='url2' Link2
~~~
~~~ html
Link1Link2
~~~
### 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
~~~
If you wrap the attributes, you can spread them across multiple lines:
~~~ slim
a(href="http://slim-lang.com"
class="important") Link
~~~
renders as
~~~ html
Link
~~~
~~~ slim
dl(
itemprop='address'
itemscope
itemtype='http://schema.org/PostalAddress'
)
~~~
renders as
~~~ html
~~~
You may use spaces around the wrappers and assignments:
~~~ slim
h1 id = "logo" Logo
h2 [ id = "tagline" ] Tagline
~~~
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
~~~
You can use newlines in quoted attributes
~~~ slim
a data-title="help" data-content="extremely long help text that goes on
and one and one and then starts over...." Link
~~~
renders as
~~~ html
Link
~~~
You can break quoted attributes with an backslash `\`
~~~ slim
a data-title="help" data-content="extremely long help text that goes on\
and one and one and then starts over...." Link
~~~
renders as
~~~ html
Link
~~~
#### Ruby attributes
Long ruby attributes can be broken with backslash `\`
~~~ slim
a href=1+\
1 Link
~~~
renders as
~~~ html
Link
~~~
You don't need the explicit `\` if the line ends with a comma `,`.
~~~ slim
ruby:
def test(*args)
args.join('-')
end
a href=test('arg1',
'arg2',
'arg3') Link
~~~
renders as
~~~ html
Link
~~~
#### Boolean attributes
The attribute values `true`, `false` and `nil` are interpreted as booleans.
If you use the attribut wrapper you can omit the attribute assigment.
~~~ slim
- true_value1 = ""
- true_value2 = true
input type="text" disabled=true_value1
input type="text" disabled=true_value2
input type="text" disabled="disabled"
input type="text" disabled=true
input(type="text" disabled)
~~~
renders as
~~~ html
~~~
~~~ slim
- false_value1 = false
- false_value2 = nil
input type="text" disabled=false_value1
input type="text" disabled=false_value2
input type="text"
input type="text" disabled=false
input type="text" disabled=nil
~~~
renders as
~~~ html
~~~
If html5 is activated the attributes are written as standalone.
~~~ options
:format => :html
~~~
~~~ slim
- true_value1 = ""
- true_value2 = true
input type="text" disabled=true_value1
input type="text" disabled=true_value2
input type="text" disabled="disabled"
input type="text" disabled=true
input(type="text" disabled)
~~~
renders as
~~~ html
~~~
#### Attribute merging
You can configure attributes to be merged if multiple are given (See option `:merge_attrs`). In the default configuration
this is done for class attributes with the white space as delimiter.
~~~ slim
a.menu class="highlight" href="http://slim-lang.com/" Slim-lang.com
~~~
renders as
~~~ html
Slim-lang.com
~~~
You can also use an `Array` as attribute value and the array elements will be merged using the delimiter.
~~~ slim
- classes = [:alpha, :beta]
span class=["first","highlight"] class=classes First
span class=:second,:highlight class=classes Second
~~~
renders as
~~~ html
FirstSecond
~~~
#### Splat attributes `*`
#### 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
~~~
renders as
~~~ html
LinkLink
~~~
### Shortcuts
#### Tag shortcuts
We add tag shortcuts by setting the option `:shortcut`.
~~~ options
:shortcut => {'c' => {tag: 'container'}, 'sec' => {tag:'section'}, '#' => {attr: 'id'}, '.' => {attr: 'class'} }
~~~
~~~ slim
sec: c.content Text
~~~
renders to
~~~ html
Text
~~~
#### Attribute shortcuts
We add `&` to create a shortcut for the input elements with type attribute by setting the option `:shortcut`.
~~~ options
:shortcut => {'&' => {tag: 'input', attr: 'type'}, '#' => {attr: 'id'}, '.' => {attr: 'class'} }
~~~
~~~ slim
&text name="user"
&password name="pw"
&submit.CLASS#ID
~~~
renders to
~~~ html
~~~
This is stupid, but you can also use multiple character shortcuts.
~~~ options
:shortcut => {'&' => {tag: 'input', attr: 'type'}, '#<' => {attr: 'id'}, '#>' => {attr: 'class'} }
~~~
~~~ slim
&text name="user"
&password name="pw"
&submit#>CLASS#
~~~
You can also set multiple attributes per shortcut.
~~~ options
:shortcut => {'.' => {attr: %w(id class)} }
~~~
~~~ slim
.test
~~~
renders to
~~~ html
~~~
Shortcuts can also have multiple characters.
~~~ options
:shortcut => {'.' => {attr: 'class'}, '#' => {attr: 'id'}, '.#' => {attr: %w(class id)} }
~~~
~~~ slim
.#test
.test
#test
~~~
renders to
~~~ html
~~~
#### ID shortcut and class shortcut `.`
ID and class shortcuts can contain dashes.
~~~ slim
.-test text
#test- text
.--a#b- text
.a--test-123#--b text
~~~
renders as
~~~ html
text
text
text
text
~~~
## Text interpolation
Use standard Ruby interpolation. The text will be html escaped by default.
~~~ slim
- user="John Doe "
h1 Welcome #{user}!
~~~
renders as
~~~ html
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
~~~
~~~ html
content
~~~
## Embedded engines
## Configuring Slim
## Plugins
slim-4.0.1/test/translator/ 0000755 0000041 0000041 00000000000 13411312757 015664 5 ustar www-data www-data slim-4.0.1/test/translator/test_translator.rb 0000644 0000041 0000041 00000005034 13411312757 021443 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\n
Hello from Markdown!
\n\n
3
\n\n
\n
one
\n
two
\n
\n", source, tr_mode: :dynamic
assert_html "
Header
\n\n
Hello from Markdown!
\n\n
3
\n\n
\n
one
\n
two
\n
\n", source, tr_mode: :static
when /rdiscount/
assert_html "
Header
\n\n
Hello from Markdown!
\n\n
3
\n\n
\n
one
\n
two
\n
\n\n", source, tr_mode: :dynamic
assert_html "
Header
\n\n
Hello from Markdown!
\n\n
3
\n\n
\n
one
\n
two
\n
\n\n", source, tr_mode: :static
when /kramdown/
assert_html "
Header
\n
Hello from Markdown!
\n\n
3
\n\n
\n
one
\n
two
\n
\n", source, tr_mode: :dynamic
assert_html "
Header
\n
Hello from Markdown!
\n\n
3
\n\n
\n
one
\n
two
\n
\n", source, tr_mode: :static
else
raise "Missing test for #{Tilt['md']}"
end
end
def test_no_translation_of_attrs
source = %q{
' this is
a link to
a href="link" page
}
assert_html "THIS IS\nA LINK TO PAGE", source, tr_mode: :dynamic
assert_html "THIS IS\nA LINK TO PAGE", source, tr_mode: :static
end
def test_translation_and_interpolation
source = %q{
p translate #{hello_world} this
second line
third #{1+2} line
}
assert_html "
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-4.0.1/test/include/ 0000755 0000041 0000041 00000000000 13411312757 015116 5 ustar www-data www-data slim-4.0.1/test/include/test_include.rb 0000644 0000041 0000041 00000001140 13411312757 020121 0 ustar www-data www-data require 'helper'
require 'slim/include'
class TestSlimInclude < TestSlim
def test_include
source = %q{
br/
a: include slimfile
b: include textfile
c: include slimfile.slim
d: include subdir/test
}
assert_html ' slim1recslim21+2=3slim1recslim2subdir', source, include_dirs: [File.expand_path('files', File.dirname(__FILE__))]
end
def test_include_with_newline
source = %q{
a: include slimfile
.content
}
assert_html 'slim1recslim2', source, include_dirs: [File.expand_path('files', File.dirname(__FILE__))]
end
end
slim-4.0.1/test/include/files/ 0000755 0000041 0000041 00000000000 13411312757 016220 5 ustar www-data www-data slim-4.0.1/test/include/files/recursive.slim 0000644 0000041 0000041 00000000005 13411312757 021110 0 ustar www-data www-data | rec slim-4.0.1/test/include/files/textfile 0000644 0000041 0000041 00000000012 13411312757 017760 0 ustar www-data www-data 1+2=#{1+2} slim-4.0.1/test/include/files/slimfile.slim 0000644 0000041 0000041 00000000041 13411312757 020705 0 ustar www-data www-data | slim1
include recursive
| slim2 slim-4.0.1/test/include/files/subdir/ 0000755 0000041 0000041 00000000000 13411312757 017510 5 ustar www-data www-data slim-4.0.1/test/include/files/subdir/test.slim 0000644 0000041 0000041 00000000010 13411312757 021344 0 ustar www-data www-data | subdir slim-4.0.1/test/smart/ 0000755 0000041 0000041 00000000000 13411312757 014621 5 ustar www-data www-data slim-4.0.1/test/smart/test_smart_text.rb 0000644 0000041 0000041 00000007766 13411312757 020417 0 ustar www-data www-data require 'helper'
require 'slim/smart'
class TestSlimSmartText < TestSlim
def test_explicit_smart_text_recognition
source = %q{
>
a
>
b
>
c
>
d
> e
f
> g
h
i
}
result = %q{a
b
c
d
e
g
h
}
assert_html result, source
end
def test_implicit_smart_text_recognition
source = %q{
p
A
p
B
p
C
p
D
p E
F
p G
H
I
}
result = %q{
A
B
C
D
E
F
G
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_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{
}
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
which stops
here. Right?}
assert_html result, source
end
# Without unicode support, we can't distinguish uppercase and lowercase
# unicode characters reliably. So we only test the basic text, not tag names.
def test_basic_unicode_smart_text
source = %q{
p
æ¯
Äip
Äip
Ŝůşo
Å¡Ãp
}
result = %q{
æ¯
Ä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-4.0.1/README.md 0000644 0000041 0000041 00000116546 13411312757 014010 0 ustar www-data www-data # Slim
[](http://rubygems.org/gems/slim) [](http://travis-ci.org/slim-template/slim) [](https://codeclimate.com/github/slim-template/slim) [](https://codeclimate.com/github/slim-template/slim/coverage)
[](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 `
~~~
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|
|
#{a.name}
#{a.description}
~~~
### Verbatim text with trailing white space `'`
The single quote tells Slim to copy the line (similar to `|`), but makes sure that a single trailing white space is appended.
### Inline html `<`
You can write html tags directly in Slim which allows you to write your templates in a more html like style with closing tags or mix html and Slim style.
The leading `<` works like an implicit `|`:
~~~ slim
head
title Example
- if articles.empty?
- else
table
- articles.each do |a|
#{a.name}
#{a.description}
~~~
### Control code `-`
The dash denotes control code. Examples of control code are loops and conditionals. `end` is forbidden behind `-`. Blocks are defined only by indentation.
If your ruby code needs to use multiple lines, append a backslash `\` at the end of the lines. If your line ends with comma `,` (e.g because of a method call) you don't need the additional backslash before the linebreak.
~~~ slim
body
- if articles.empty?
| No inventory
~~~
### Output `=`
The equals sign tells Slim it's a Ruby call that produces output to add to the buffer. If your ruby code needs to use multiple lines, append a backslash `\` at the end of the lines. For example:
~~~ slim
= javascript_include_tag \
"jquery",
"application"
~~~
If your line ends with comma `,` (e.g because of a method call) you don't need the additional backslash before the linebreak. For trailing or leading whitespace the modifiers `>` and `<` are supported.
* Output with trailing white space `=>`. Same as the single equals sign (`=`), except that it adds a trailing white space.
* Output with leading white space `=<`. Same as the single equals sign (`=`), except that it adds a leading white space.
### Output without HTML escaping `==`
Same as the single equals sign (`=`), but does not go through the `escape_html` method. For trailing or leading whitespace the modifiers `>` and `<` are supported.
* Output without HTML escaping and trailing white space `==>`. Same as the double equals sign (`==`), except that it adds a trailing white space.
* Output without HTML escaping and leading white space `==<`. Same as the double equals sign (`==`), except that it adds a leading white space.
### Code comment `/`
Use the forward slash for code comments - anything after it won't get displayed in the final render. Use `/` for code comments and `/!` for html comments
~~~ slim
body
p
/ This line won't get displayed.
Neither does this line.
/! This will get displayed as html comments.
~~~
The parsed result of the above:
~~~ html
~~~
### HTML comment `/!`
Use the forward slash immediately followed by an exclamation mark for html comments (``).
### IE conditional comment `/[...]`
~~~ slim
/[if IE]
p Get a better browser.
~~~
This renders as:
~~~ html
~~~
## HTML tags
### declaration
The doctype keyword can be used to generate the complex doctypes in a very simple manner.
XML VERSION
~~~ slim
doctype xml
doctype xml ISO-8859-1
~~~
XHTML DOCTYPES
~~~ slim
doctype html
doctype 5
doctype 1.1
doctype strict
doctype frameset
doctype mobile
doctype basic
doctype transitional
~~~
HTML 4 DOCTYPES
~~~ slim
doctype strict
doctype frameset
doctype transitional
~~~
### Closed tags (trailing `/`)
You can close tags explicitly by appending a trailing `/`.
~~~ slim
img src="image.png"/
~~~
Note, that this is usually not necessary since the standard html
tags (img, br, ...) are closed automatically.
### Trailing and leading whitespace (`<`, `>`)
You can force Slim to add a trailing whitespace after a tag by adding a `>`.
~~~ slim
a> href='url1' Link1
a> href='url2' Link2
~~~
You can add a leading whitespace by adding `<`.
~~~ slim
a< href='url1' Link1
a< href='url2' Link2
~~~
You can also combine both.
~~~ slim
a<> href='url1' Link1
~~~
### Inline tags
Sometimes you may want to be a little more compact and inline the tags.
~~~ slim
ul
li.first: a href="/a" A link
li: a href="/b" B link
~~~
For readability, don't forget you can wrap the attributes.
~~~ slim
ul
li.first: a[href="/a"] A link
li: a[href="/b"] B link
~~~
### Text content
Either start on the same line as the tag
~~~ slim
body
h1 id="headline" Welcome to my site.
~~~
Or nest it. You must use a pipe or an apostrophe to escape processing
~~~ slim
body
h1 id="headline"
| Welcome to my site.
~~~
Or enable and rely on smart text instead
~~~ slim
body
h1 id="headline"
Welcome to my site.
~~~
### Dynamic content (`=` and `==`)
Can make the call on the same line
~~~ slim
body
h1 id="headline" = page_headline
~~~
Or nest it.
~~~ slim
body
h1 id="headline"
= page_headline
~~~
### Attributes
You write attributes directly after the tag. For normal text attributes you must use double `"` or single quotes `'` (Quoted attributes).
~~~ slim
a href="http://slim-lang.com" title='Slim Homepage' Goto the Slim homepage
~~~
You can use text interpolation in the quoted attributes.
#### Attributes wrapper
If a delimiter makes the syntax more readable for you,
you can use the characters `{...}`, `(...)`, `[...]` to wrap the attributes.
You can configure these symbols (See option `:attr_list_delims`).
~~~ slim
body
h1(id="logo") = page_logo
h2[id="tagline" class="small tagline"] = page_tagline
~~~
If you wrap the attributes, you can spread them across multiple lines:
~~~ slim
h2[id="tagline"
class="small tagline"] = page_tagline
~~~
You may use spaces around the wrappers and assignments:
~~~ slim
h1 id = "logo" = page_logo
h2 [ id = "tagline" ] = page_tagline
~~~
#### Quoted attributes
Example:
~~~ slim
a href="http://slim-lang.com" title='Slim Homepage' Goto the Slim homepage
~~~
You can use text interpolation in the quoted attributes:
~~~ slim
a href="http://#{url}" Goto the #{url}
~~~
The attribute value will be escaped by default. Use == if you want to disable escaping in the attribute.
~~~ slim
a href=="&"
~~~
You can break quoted attributes with backslash `\`
~~~ slim
a data-title="help" data-content="extremely long help text that goes on\
and on and on and then starts over...."
~~~
#### Ruby attributes
Write the ruby code directly after the `=`. If the code contains spaces you have to wrap
the code into parentheses `(...)`. You can also directly write hashes `{...}` and arrays `[...]`.
~~~ slim
body
table
- for user in users
td id="user_#{user.id}" class=user.role
a href=user_action(user, :edit) Edit #{user.name}
a href=(path_to_user user) = user.name
~~~
The attribute value will be escaped by default. Use == if you want to disable escaping in the attribute.
~~~ slim
a href==action_path(:start)
~~~
You can also break ruby attributes with backslash `\` or trailing `,` as described for control sections.
#### Boolean attributes
The attribute values `true`, `false` and `nil` are interpreted
as booleans. If you use the attribute wrapper you can omit the attribute assigment.
~~~ slim
input type="text" disabled="disabled"
input type="text" disabled=true
input(type="text" disabled)
input type="text"
input type="text" disabled=false
input type="text" disabled=nil
~~~
#### Attribute merging
You can configure attributes to be merged if multiple are given (See option `:merge_attrs`). In the default configuration
this is done for class attributes with the white space as delimiter.
~~~ slim
a.menu class="highlight" href="http://slim-lang.com/" Slim-lang.com
~~~
This renders as:
~~~ html
Slim-lang.com
~~~
You can also use an `Array` as attribute value and the array elements will be merged using the delimiter.
~~~ slim
a class=["menu","highlight"]
a class=:menu,:highlight
~~~
#### Splat attributes `*`
The splat shortcut allows you to turn a hash into attribute/value pairs.
~~~ slim
.card*{'data-url'=>place_path(place), 'data-id'=>place.id} = place.name
~~~
This renders as:
~~~ html
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"
~~~
Splat attributes prefix may be configured via `splat_prefix` option. Default value is `'*'`
#### 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
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
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, but you can avoid escaping by using double braces.
~~~ 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 |
| coffee: | coffee-script | Compile time | Compile coffee script code and wrap in script tag |
| 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 |
| rdoc: | rdoc | Compile time + Interpolation | Compile rdoc code and interpolate #\{variables} in text |
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}
~~~
You can also specify HTML attributes for the following embedded engines:
* Javascript
* CSS
* CoffeeScript
* LESS
* SASS
* SCSS
Example:
~~~ scss
scss class="myClass":
$color: #f00;
body { color: $color; }
~~~
This will generate the following HTML:
~~~ html
~~~
## 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::StringBuffer/ RailsOutputBuffer | Temple code generator (default generator generates string buffer) |
| String | :buffer | '_buf' ('@output_buffer' in Rails) | Variable used for buffer |
| String | :splat_prefix | '*' | Prefix used for splat attributes |
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'`.
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
~~~
### Angular2
Slim now supports Angular2 syntax. But you need to set some configuration options:
#### `splat_prefix` option
This option tells parser what syntax to use for splat attributes.
Default value is asterisk: `splat_prefix: '*'`
Asterisk is also used in Angular2 for structural directives such as `*ngIf` and others, so default configuration causes a conflict between slim and angular2 syntax.
There are two ways to resolve it:
* Set `splat_prefix` to any custom value, double asterisk, for example: `splat_prefix: '**'`. Now structural directives should work as expected. Remember that now splat attributes should be written with new custom prefix before them.
* Use alternative directive syntax without asterisk.
#### Attribute delimeters
Angular and slim both uses brackets in their syntax. So there are also two ways:
* Use alternative syntax for binding (`bind-...` and so on)
* Limit attribute delimeters to curly braces only:
```
code_attr_delims: {
'{' => '}',
},
attr_list_delims: {
'{' => '}',
},
```
Now you can use something like this:
```
h1{ #var (bind1)="test" [bind2]="ok" [(bind3)]="works?" *ngIf="expr" *ngFor="expression" } {{it works}}
```
Will be compiled to:
```
{{it works}}
```
## 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 for debugging purposes
-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>
Enable the translator plugin with
require 'slim/translator'
# Options
| Type | Name | Default | Purpose |
| ---- | ---- | ------- | ------- |
| Boolean | :tr | true | Enable translator (Enabled if 'slim/translator' is required) |
| Symbol | :tr_mode | :dynamic | When to translate: :static = at compile time, :dynamic = at runtime |
| String | :tr_fn | Depending on installed translation library | Translation function, could be '_' for gettext |
slim-4.0.1/doc/logic_less.md 0000644 0000041 0000041 00000007404 13411312757 015733 0 ustar www-data www-data # Logic less mode
Logic less mode is inspired by [Mustache](https://github.com/defunkt/mustache). Logic less mode uses a dictionary object
e.g. a recursive hash tree which contains the dynamic content.
## Conditional
If the object is not false or empty?, the content will show
- article
h1 = title
## Inverted conditional
If the object is false or empty?, the content will show
-! article
p Sorry, article not found
## Iteration
If the object is an array, the section will iterate
- articles
tr: td = title
## Lambdas
Like mustache, Slim supports lambdas.
= person
= name
The lambda method could be defined like this
def lambda_method
"
#{yield(name: 'Andrew')}
"
end
You can optionally pass one or more hashes to `yield`. If you pass multiple hashes, the block will be iterated as described above.
## Dictionary access
Example code:
- article
h1 = title
The dictionary object is accessed in the order given by the `:dictionary_access`. Default order:
1. `:symbol` - If `article.respond_to?(:has_key?)` and `article.has_key?(:title)`, Slim will execute `article[:title]`
2. `:string` - If `article.respond_to?(:has_key?)` and `article.has_key?('title')`, Slim will execute `article['title']`
3. `:method` - If `article.respond_to?(:title)`, Slim will execute `article.send(:title)`
4. `:instance_variable` - If `article.instance_variable_defined?(@title)`, Slim will execute `article.instance_variable_get @title`
If all the above fails, Slim will try to resolve the title reference in the same order against the parent object. In this example, the parent would be the dictionary object you are rendering the template against.
As you might have guessed, the article reference goes through the same steps against the dictionary. Instance variables are not allowed in the view code, but Slim will find and use them. Essentially, you're just dropping the @ prefix in your template. Parameterized method calls are not allowed.
## Strings
The `self` keyword will return the `.to_s` value for the element under consideration.
Given
{
article: [
'Article 1',
'Article 2'
]
}
And
- article
tr: td = self
This will yield
Article 1
Article 2
## Logic less in Rails
Install:
$ gem install slim
Require:
gem 'slim', require: 'slim/logic_less'
You might want to activate logic less mode only for a few actions, you should disable logic-less mode globally at first in the configuration
Slim::Engine.set_options logic_less: false
and activate logic less mode per render call in your action
class Controller
def action
Slim::Engine.with_options(logic_less: true) do
render
end
end
end
## Logic less in Sinatra
Sinatra has built-in support for Slim. All you have to do is require the logic less Slim plugin. This can be done in your config.ru:
require 'slim/logic_less'
You are then ready to rock!
You might want to activate logic less mode only for a few actions, you should disable logic-less mode globally at first in the configuration
Slim::Engine.set_options logic_less: false
and activate logic less mode per render call in your application
get '/page'
slim :page, logic_less: true
end
## Options
| Type | Name | Default | Purpose |
| ---- | ---- | ------- | ------- |
| Boolean | :logic_less | true | Enable logic less mode (Enabled if 'slim/logic_less' is required) |
| String | :dictionary | "self" | Dictionary where variables are looked up |
| Symbol/Array<Symbol> | :dictionary_access | [:symbol, :string, :method, :instance_variable] | Dictionary access order (:symbol, :string, :method, :instance_variable) |
slim-4.0.1/doc/smart.md 0000644 0000041 0000041 00000010727 13411312757 014740 0 ustar www-data www-data # Smart text
The smart text plugin was created to simplify the typing and combining of text and markup in Slim templates.
Using the plugin gives you:
* More convenient ways to type text in Slim templates.
* Smarter and more consistent HTML escaping of typed text.
* Easier combining of the text with inline HTML tags with smart handling of whitespace on the boundaries.
To get started, enable the smart text plugin with
require 'slim/smart'
First of all, this automatically enables the `:implicit_text` option.
When enabled, Slim will treat any line which doesn't start
with a lowercase tag name or any of the special characters as an implicit text line.
If the text needs to span several lines, indent them as usual.
This allows you to easily type text like this, without any leading indicator:
This is an implicit text.
This is a text
which spans
several lines.
This is yet another text.
This works in addition to ways already available in stock Slim:
p This is an inline text.
p This is an inline text
which spans multiple lines.
| This is a verbatim text.
| This is a verbatim text
which spans multiple lines.
$ 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
~~~
### Trailing and leading whitespace
You can force a trailing whitespace behind a tag by adding `>`.
~~~ slim
a#closed> class="test" /
a#closed> class="test"/
a> href='url1' Link1
a< href='url1' Link1
~~~
renders as
~~~ html
Link1 Link1
~~~
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