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 something falsy, no layout is rendered, otherwise the specified layout is used (Ignored for sass) :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

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



789
790
791
 
# File 'lib/sinatra/base.rb', line 789

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

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



771
772
773
774
 
# File 'lib/sinatra/base.rb', line 771

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

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



749
750
751
 
# File 'lib/sinatra/base.rb', line 749

def erb(template, options = {}, locals = {}, &block)
  render(:erb, template, options, locals, &block)
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}")) 


818
819
820
821
822
823
824
 
# File 'lib/sinatra/base.rb', line 818

def find_template(views, name, engine)
  yield ::File.join(views, "#{name}.#{@preferred_extension}")

  Tilt.default_mapping.extensions_for(engine).each do |ext|
    yield ::File.join(views, "#{name}.#{ext}") unless ext == @preferred_extension
  end
end

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



753
754
755
 
# File 'lib/sinatra/base.rb', line 753

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

#initialize ⇒ Object 



743
744
745
746
747
 
# File 'lib/sinatra/base.rb', line 743

def initialize
  super
  @default_layout = :layout
  @preferred_extension = nil
end

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



776
777
778
 
# File 'lib/sinatra/base.rb', line 776

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

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



793
794
795
 
# File 'lib/sinatra/base.rb', line 793

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

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



780
781
782
783
 
# File 'lib/sinatra/base.rb', line 780

def markdown(template, options = {}, locals = {})
  options[:exclude_outvar] = true
  render :markdown, template, options, locals
end

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



797
798
799
800
 
# File 'lib/sinatra/base.rb', line 797

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

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



811
812
813
814
 
# File 'lib/sinatra/base.rb', line 811

def rabl(template, options = {}, locals = {})
  Rabl.register!
  render :rabl, template, options, locals
end

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



785
786
787
 
# File 'lib/sinatra/base.rb', line 785

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

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



757
758
759
760
761
762
 
# File 'lib/sinatra/base.rb', line 757

def sass(template, options = {}, locals = {})
  options[:default_content_type] = :css
  options[:exclude_outvar] = true
  options[:layout] = nil
  render :sass, template, options, locals
end

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



764
765
766
767
768
769
 
# File 'lib/sinatra/base.rb', line 764

def scss(template, options = {}, locals = {})
  options[:default_content_type] = :css
  options[:exclude_outvar] = true
  options[:layout] = nil
  render :scss, template, options, locals
end

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



802
803
804
 
# File 'lib/sinatra/base.rb', line 802

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

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



806
807
808
809
 
# File 'lib/sinatra/base.rb', line 806

def yajl(template, options = {}, locals = {})
  options[:default_content_type] = :json
  render :yajl, template, options, locals
end