Module: Sinatra::Templates

Included in:
Base
Defined in:
lib/sinatra/base.rb

Overview

Template rendering methods. Each method takes the name of a template to render as a Symbol and returns a String with the rendered output, as well as an optional hash with additional options.

‘template` is either the name or path of the template as symbol (Use `:’subdir/myview’‘ for views in subdirectories), or a string that will be rendered.

Possible options are:

:content_type   The content type to use, same arguments as content_type.
:layout         If set to false, no layout is rendered, otherwise
                the specified layout is used (Ignored for `sass` and `less`)
:layout_engine  Engine to use for rendering the layout.
:locals         A hash with local variables that should be available
                in the template
:scope          If set, template is evaluate with the binding of the given
                object rather than the application instance.
:views          Views directory to use.

Defined Under Namespace

Modules: ContentTyped

Instance Method Summary collapse

Instance Method Details

#builder(template = nil, options = {}, locals = {}, &block) ⇒ Object 



458
459
460
461
 
# File 'lib/sinatra/base.rb', line 458

def builder(template=nil, options={}, locals={}, &block)
  options[:default_content_type] = :xml
  render_ruby(:builder, template, options, locals, &block)
end

#coffee(template, options = {}, locals = {}) ⇒ Object 



487
488
489
490
 
# File 'lib/sinatra/base.rb', line 487

def coffee(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :js
  render :coffee, template, options, locals
end

#erb(template, options = {}, locals = {}) ⇒ Object 



431
432
433
 
# File 'lib/sinatra/base.rb', line 431

def erb(template, options={}, locals={})
  render :erb, template, options, locals
end

#erubis(template, options = {}, locals = {}) ⇒ Object 



435
436
437
 
# File 'lib/sinatra/base.rb', line 435

def erubis(template, options={}, locals={})
  render :erubis, template, options, locals
end

#find_template(views, name, engine) ⇒ Object

Calls the given block for every possible template file in views, named name.ext, where ext is registered on engine.



503
504
505
506
507
508
 
# File 'lib/sinatra/base.rb', line 503

def find_template(views, name, engine)
  Tilt.mappings.each do |ext, klass|
    next unless klass == engine
    yield ::File.join(views, "#{name}.#{ext}")
  end
end

#haml(template, options = {}, locals = {}) ⇒ Object 



439
440
441
 
# File 'lib/sinatra/base.rb', line 439

def haml(template, options={}, locals={})
  render :haml, template, options, locals
end

#less(template, options = {}, locals = {}) ⇒ Object 



453
454
455
456
 
# File 'lib/sinatra/base.rb', line 453

def less(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :css
  render :less, template, options, locals
end

#liquid(template, options = {}, locals = {}) ⇒ Object 



463
464
465
 
# File 'lib/sinatra/base.rb', line 463

def liquid(template, options={}, locals={})
  render :liquid, template, options, locals
end

#markaby(template = nil, options = {}, locals = {}, &block) ⇒ Object 



483
484
485
 
# File 'lib/sinatra/base.rb', line 483

def markaby(template=nil, options={}, locals={}, &block)
  render_ruby(:mab, template, options, locals, &block)
end

#markdown(template, options = {}, locals = {}) ⇒ Object 



467
468
469
 
# File 'lib/sinatra/base.rb', line 467

def markdown(template, options={}, locals={})
  render :markdown, template, options, locals
end

#nokogiri(template = nil, options = {}, locals = {}, &block) ⇒ Object 



492
493
494
495
 
# File 'lib/sinatra/base.rb', line 492

def nokogiri(template=nil, options={}, locals={}, &block)
  options[:default_content_type] = :xml
  render_ruby(:nokogiri, template, options, locals, &block)
end

#radius(template, options = {}, locals = {}) ⇒ Object 



479
480
481
 
# File 'lib/sinatra/base.rb', line 479

def radius(template, options={}, locals={})
  render :radius, template, options, locals
end

#rdoc(template, options = {}, locals = {}) ⇒ Object 



475
476
477
 
# File 'lib/sinatra/base.rb', line 475

def rdoc(template, options={}, locals={})
  render :rdoc, template, options, locals
end

#sass(template, options = {}, locals = {}) ⇒ Object 



443
444
445
446
 
# File 'lib/sinatra/base.rb', line 443

def sass(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :css
  render :sass, template, options, locals
end

#scss(template, options = {}, locals = {}) ⇒ Object 



448
449
450
451
 
# File 'lib/sinatra/base.rb', line 448

def scss(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :css
  render :scss, template, options, locals
end

#slim(template, options = {}, locals = {}) ⇒ Object 



497
498
499
 
# File 'lib/sinatra/base.rb', line 497

def slim(template, options={}, locals={})
  render :slim, template, options, locals
end

#textile(template, options = {}, locals = {}) ⇒ Object 



471
472
473
 
# File 'lib/sinatra/base.rb', line 471

def textile(template, options={}, locals={})
  render :textile, template, options, locals
end