Module: Sinatra::Templates

Included in:
Base
Defined in:
lib/vendor/sinatra-1.4.4/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

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



697
698
699
700
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 697

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 



726
727
728
729
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 726

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

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



740
741
742
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 740

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

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



663
664
665
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 663

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

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



667
668
669
670
671
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 667

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


760
761
762
763
764
765
766
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 760

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 = {}, &block) ⇒ Object 



673
674
675
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 673

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

#initialize ⇒ Object 



658
659
660
661
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 658

def initialize
  super
  @default_layout = :layout
end

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



687
688
689
690
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 687

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 



702
703
704
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 702

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

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



722
723
724
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 722

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

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



706
707
708
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 706

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

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



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

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 



753
754
755
756
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 753

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

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



718
719
720
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 718

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

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



714
715
716
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 714

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

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



677
678
679
680
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 677

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

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



682
683
684
685
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 682

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 



736
737
738
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 736

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

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



692
693
694
695
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 692

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

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



710
711
712
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 710

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

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



744
745
746
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 744

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

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



748
749
750
751
 
# File 'lib/vendor/sinatra-1.4.4/lib/sinatra/base.rb', line 748

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