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 something falsy, 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 Instance Methods

asciidoc(template, options = {}, locals = {}) click to toggle source
# File lib/sinatra/base.rb, line 721
def asciidoc(template, options = {}, locals = {})
  render :asciidoc, template, options, locals
end
builder(template = nil, options = {}, locals = {}, &block) click to toggle source
# File lib/sinatra/base.rb, line 700
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 733
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 747
def creole(template, options = {}, locals = {})
  render :creole, template, options, locals
end
erb(template, options = {}, locals = {}, &block) click to toggle source
# File lib/sinatra/base.rb, line 666
def erb(template, options = {}, locals = {}, &block)
  render(:erb, template, options, locals, &block)
end
erubis(template, options = {}, locals = {}) click to toggle source
# File lib/sinatra/base.rb, line 670
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 771
def find_template(views, name, engine)
  yield ::File.join(views, "#{name}.#{@preferred_extension}")

  if Tilt.respond_to?(:mappings)
    Tilt.mappings.each do |ext, engines|
      next unless ext != @preferred_extension and engines.include? engine
      yield ::File.join(views, "#{name}.#{ext}")
    end
  else
    Tilt.default_mapping.extensions_for(engine).each do |ext|
      yield ::File.join(views, "#{name}.#{ext}") unless ext == @preferred_extension
    end
  end
end
haml(template, options = {}, locals = {}, &block) click to toggle source
# File lib/sinatra/base.rb, line 676
def haml(template, options = {}, locals = {}, &block)
  render(:haml, template, options, locals, &block)
end
less(template, options = {}, locals = {}) click to toggle source
# File lib/sinatra/base.rb, line 690
def less(template, options = {}, locals = {})
  options.merge! :layout => false, :default_content_type => :css
  render :less, template, options, locals
end
liquid(template, options = {}, locals = {}, &block) click to toggle source
# File lib/sinatra/base.rb, line 705
def liquid(template, options = {}, locals = {}, &block)
  render(:liquid, template, options, locals, &block)
end
markaby(template = nil, options = {}, locals = {}, &block) click to toggle source
# File lib/sinatra/base.rb, line 729
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 709
def markdown(template, options = {}, locals = {})
  render :markdown, template, options, locals
end
mediawiki(template, options = {}, locals = {}) click to toggle source
# File lib/sinatra/base.rb, line 751
def mediawiki(template, options = {}, locals = {})
  render :mediawiki, template, options, locals
end
nokogiri(template = nil, options = {}, locals = {}, &block) click to toggle source
# File lib/sinatra/base.rb, line 738
def nokogiri(template = nil, options = {}, locals = {}, &block)
  options[:default_content_type] = :xml
  render_ruby(:nokogiri, template, options, locals, &block)
end
rabl(template, options = {}, locals = {}) click to toggle source
# File lib/sinatra/base.rb, line 764
def rabl(template, options = {}, locals = {})
  Rabl.register!
  render :rabl, template, options, locals
end
radius(template, options = {}, locals = {}) click to toggle source
# File lib/sinatra/base.rb, line 725
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 717
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 680
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 685
def scss(template, options = {}, locals = {})
  options.merge! :layout => false, :default_content_type => :css
  render :scss, template, options, locals
end
slim(template, options = {}, locals = {}, &block) click to toggle source
# File lib/sinatra/base.rb, line 743
def slim(template, options = {}, locals = {}, &block)
  render(:slim, template, options, locals, &block)
end
stylus(template, options={}, locals={}) click to toggle source
# File lib/sinatra/base.rb, line 695
def stylus(template, options={}, locals={})
  options.merge! :layout => false, :default_content_type => :css
  render :styl, template, options, locals
end
textile(template, options = {}, locals = {}) click to toggle source
# File lib/sinatra/base.rb, line 713
def textile(template, options = {}, locals = {})
  render :textile, template, options, locals
end
wlang(template, options = {}, locals = {}, &block) click to toggle source
# File lib/sinatra/base.rb, line 755
def wlang(template, options = {}, locals = {}, &block)
  render(:wlang, template, options, locals, &block)
end
yajl(template, options = {}, locals = {}) click to toggle source
# File lib/sinatra/base.rb, line 759
def yajl(template, options = {}, locals = {})
  options[:default_content_type] = :json
  render :yajl, template, options, locals
end

Public Class Methods

new() click to toggle source
# File lib/sinatra/base.rb, line 660
def initialize
  super
  @default_layout = :layout
  @preferred_extension = nil
end