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 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

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


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

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

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


737
738
739
740
# File 'lib/sinatra/base.rb', line 737

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


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

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

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


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

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

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


703
704
705
# File 'lib/sinatra/base.rb', line 703

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

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


707
708
709
710
711
# File 'lib/sinatra/base.rb', line 707

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}"))

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

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


713
714
715
# File 'lib/sinatra/base.rb', line 713

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

#initializeObject


697
698
699
700
701
# File 'lib/sinatra/base.rb', line 697

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

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


727
728
729
730
# File 'lib/sinatra/base.rb', line 727

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

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


742
743
744
# File 'lib/sinatra/base.rb', line 742

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

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


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

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

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


746
747
748
749
# File 'lib/sinatra/base.rb', line 746

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

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


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

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

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


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

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


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

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

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


763
764
765
# File 'lib/sinatra/base.rb', line 763

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

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


755
756
757
# File 'lib/sinatra/base.rb', line 755

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

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


717
718
719
720
# File 'lib/sinatra/base.rb', line 717

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

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


722
723
724
725
# File 'lib/sinatra/base.rb', line 722

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

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


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

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

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


732
733
734
735
# File 'lib/sinatra/base.rb', line 732

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

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


751
752
753
# File 'lib/sinatra/base.rb', line 751

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

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


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

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

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


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

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