module Sinatra::Helpers::Stream::Templates

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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/sinatra/base.rb, line 516
def initialize
  super
  @default_layout = :layout
end

Public Instance Methods

builder(template=nil, options={}, locals={}, &block) click to toggle source
# File lib/sinatra/base.rb, line 550
def builder(template=nil, options={}, locals={}, &block)
  options[:default_content_type] = :xml
  render_ruby(:builder, template, options, locals, &block)
end
coffee(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 579
def coffee(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :js
  render :coffee, template, options, locals
end
creole(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 593
def creole(template, options={}, locals={})
  render :creole, template, options, locals
end
erb(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 521
def erb(template, options={}, locals={})
  render :erb, template, options, locals
end
erubis(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 525
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) { |join(views, "| ... } click to toggle source

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

# File lib/sinatra/base.rb, line 599
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={}) click to toggle source
# File lib/sinatra/base.rb, line 531
def haml(template, options={}, locals={})
  render :haml, template, options, locals
end
less(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 545
def less(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :css
  render :less, template, options, locals
end
liquid(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 555
def liquid(template, options={}, locals={})
  render :liquid, template, options, locals
end
markaby(template=nil, options={}, locals={}, &block) click to toggle source
# File lib/sinatra/base.rb, line 575
def markaby(template=nil, options={}, locals={}, &block)
  render_ruby(:mab, template, options, locals, &block)
end
markdown(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 559
def markdown(template, options={}, locals={})
  render :markdown, template, options, locals
end
nokogiri(template=nil, options={}, locals={}, &block) click to toggle source
# File lib/sinatra/base.rb, line 584
def nokogiri(template=nil, options={}, locals={}, &block)
  options[:default_content_type] = :xml
  render_ruby(:nokogiri, template, options, locals, &block)
end
radius(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 571
def radius(template, options={}, locals={})
  render :radius, template, options, locals
end
rdoc(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 567
def rdoc(template, options={}, locals={})
  render :rdoc, template, options, locals
end
sass(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 535
def sass(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :css
  render :sass, template, options, locals
end
scss(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 540
def scss(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :css
  render :scss, template, options, locals
end
slim(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 589
def slim(template, options={}, locals={})
  render :slim, template, options, locals
end
textile(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 563
def textile(template, options={}, locals={})
  render :textile, template, options, locals
end

Private Instance Methods

compile_template(engine, data, options, views) click to toggle source
# File lib/sinatra/base.rb, line 651
def compile_template(engine, data, options, views)
  eat_errors = options.delete :eat_errors
  template_cache.fetch engine, data, options do
    template = Tilt[engine]
    raise "Template engine not found: #{engine}" if template.nil?

    case data
    when Symbol
      body, path, line = settings.templates[data]
      if body
        body = body.call if body.respond_to?(:call)
        template.new(path, line.to_i, options) { body }
      else
        found = false
        @preferred_extension = engine.to_s
        find_template(views, data, template) do |file|
          path ||= file # keep the initial path rather than the last one
          if found = File.exists?(file)
            path = file
            break
          end
        end
        throw :layout_missing if eat_errors and not found
        template.new(path, 1, options)
      end
    when Proc, String
      body = data.is_a?(String) ? Proc.new { data } : data
      path, line = settings.caller_locations.first
      template.new(path, line.to_i, options, &body)
    else
      raise ArgumentError, "Sorry, don't know how to render #{data.inspect}."
    end
  end
end
render(engine, data, options={}, locals={}, &block) click to toggle source
# File lib/sinatra/base.rb, line 615
def render(engine, data, options={}, locals={}, &block)
  # merge app-level options
  options = settings.send(engine).merge(options) if settings.respond_to?(engine)
  options[:outvar]           ||= '@_out_buf'
  options[:default_encoding] ||= settings.default_encoding

  # extract generic options
  locals          = options.delete(:locals) || locals         || {}
  views           = options.delete(:views)  || settings.views || "./views"
  layout          = options.delete(:layout)
  eat_errors      = layout.nil?
  layout          = @default_layout if layout.nil? or layout == true
  content_type    = options.delete(:content_type)  || options.delete(:default_content_type)
  layout_engine   = options.delete(:layout_engine) || engine
  scope           = options.delete(:scope)         || self

  # compile and render template
  begin
    layout_was      = @default_layout
    @default_layout = false
    template        = compile_template(engine, data, options, views)
    output          = template.render(scope, locals, &block)
  ensure
    @default_layout = layout_was
  end

  # render layout
  if layout
    options = options.merge(:views => views, :layout => false, :eat_errors => eat_errors, :scope => scope)
    catch(:layout_missing) { return render(layout_engine, layout, options, locals) { output } }
  end

  output.extend(ContentTyped).content_type = content_type if content_type
  output
end
render_ruby(engine, template, options={}, locals={}, &block) click to toggle source

logic shared between builder and nokogiri

# File lib/sinatra/base.rb, line 609
def render_ruby(engine, template, options={}, locals={}, &block)
  options, template = template, nil if template.is_a?(Hash)
  template = Proc.new { block } if template.nil?
  render engine, template, options, locals
end