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 



600
601
602
603
 
# File 'lib/sinatra/base.rb', line 600

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 



629
630
631
632
 
# File 'lib/sinatra/base.rb', line 629

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

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



643
644
645
 
# File 'lib/sinatra/base.rb', line 643

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

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



571
572
573
 
# File 'lib/sinatra/base.rb', line 571

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

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



575
576
577
578
579
 
# File 'lib/sinatra/base.rb', line 575

def erubis(template, options={}, locals={})
  warn "Sinatra::Templates#erubis is deprecated and will be removed, use #erb instead.\n" \
    "If you have Erubis installed, it will be used automatically."
  render :erubis, template, options, locals
end

#find_template(views, name, engine) {|::File.join(views, "#{name}.#{@preferred_extension}")| ... } ⇒ Object

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

Yields:

  • (::File.join(views, "#{name}.#{@preferred_extension}")) 


649
650
651
652
653
654
655
 
# File 'lib/sinatra/base.rb', line 649

def find_template(views, name, engine)
  yield ::File.join(views, "#{name}.#{@preferred_extension}")
  Tilt.mappings.each do |ext, engines|
    next unless ext != @preferred_extension and engines.include? engine
    yield ::File.join(views, "#{name}.#{ext}")
  end
end

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



581
582
583
 
# File 'lib/sinatra/base.rb', line 581

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

#initialize ⇒ Object 



566
567
568
569
 
# File 'lib/sinatra/base.rb', line 566

def initialize
  super
  @default_layout = :layout
end

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



595
596
597
598
 
# File 'lib/sinatra/base.rb', line 595

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

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



605
606
607
 
# File 'lib/sinatra/base.rb', line 605

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

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



625
626
627
 
# File 'lib/sinatra/base.rb', line 625

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

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



609
610
611
 
# File 'lib/sinatra/base.rb', line 609

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

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



634
635
636
637
 
# File 'lib/sinatra/base.rb', line 634

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 



621
622
623
 
# File 'lib/sinatra/base.rb', line 621

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

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



617
618
619
 
# File 'lib/sinatra/base.rb', line 617

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

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



585
586
587
588
 
# File 'lib/sinatra/base.rb', line 585

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

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



590
591
592
593
 
# File 'lib/sinatra/base.rb', line 590

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

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



639
640
641
 
# File 'lib/sinatra/base.rb', line 639

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

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



613
614
615
 
# File 'lib/sinatra/base.rb', line 613

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