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

- (Object) asciidoc(template, options = {}, locals = {})



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

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

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



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

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

- (Object) coffee(template, options = {}, locals = {})



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

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

- (Object) creole(template, options = {}, locals = {})



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

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

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



664
665
666
# File 'lib/sinatra/base.rb', line 664

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

- (Object) erubis(template, options = {}, locals = {})



668
669
670
671
672
# File 'lib/sinatra/base.rb', line 668

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

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

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


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

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

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



674
675
676
# File 'lib/sinatra/base.rb', line 674

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

- (Object) initialize



658
659
660
661
662
# File 'lib/sinatra/base.rb', line 658

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

- (Object) less(template, options = {}, locals = {})



688
689
690
691
# File 'lib/sinatra/base.rb', line 688

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

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



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

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

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



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

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

- (Object) markdown(template, options = {}, locals = {})



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

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

- (Object) mediawiki(template, options = {}, locals = {})



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

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

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



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

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

- (Object) rabl(template, options = {}, locals = {})



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

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

- (Object) radius(template, options = {}, locals = {})



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

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

- (Object) rdoc(template, options = {}, locals = {})



715
716
717
# File 'lib/sinatra/base.rb', line 715

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

- (Object) sass(template, options = {}, locals = {})



678
679
680
681
# File 'lib/sinatra/base.rb', line 678

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

- (Object) scss(template, options = {}, locals = {})



683
684
685
686
# File 'lib/sinatra/base.rb', line 683

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

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



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

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

- (Object) stylus(template, options = {}, locals = {})



693
694
695
696
# File 'lib/sinatra/base.rb', line 693

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

- (Object) textile(template, options = {}, locals = {})



711
712
713
# File 'lib/sinatra/base.rb', line 711

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

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



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

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

- (Object) yajl(template, options = {}, locals = {})



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

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