Class: ERB

Inherits:
Object
  • Object
show all
Defined in:
lib/erb.rb,
lib/erb.rb,
lib/erb.rb,
lib/erb.rb,
lib/erb.rb

Overview

– ERB::DefMethod

Defined Under Namespace

Modules: DefMethod, Util Classes: Compiler

Constant Summary collapse

Revision =

:nodoc: #‘

'$Date:: 2014-12-12 19:48:57 +0900#$'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(str, safe_level = nil, trim_mode = nil, eoutvar = '_erbout') ⇒ ERB

Constructs a new ERB object with the template specified in str.

An ERB object works by building a chunk of Ruby code that will output the completed template when run. If safe_level is set to a non-nil value, ERB code will be run in a separate thread with $SAFE set to the provided level.

If trim_mode is passed a String containing one or more of the following modifiers, ERB will adjust its code generation as listed:

%  enables Ruby code processing for lines beginning with %
<> omit newline for lines starting with <% and ending in %>
>  omit newline for lines ending in %>
-  omit blank lines ending in -%>

eoutvar can be used to set the name of the variable ERB will build up its output in. This is useful when you need to run multiple ERB templates through the same binding and/or when you want to control where output ends up. Pass the name of the variable to be used inside a String.

Example

require "erb"

# build data class
class Listings
  PRODUCT = { :name => "Chicken Fried Steak",
              :desc => "A well messages pattie, breaded and fried.",
              :cost => 9.95 }

  attr_reader :product, :price

  def initialize( product = "", price = "" )
    @product = product
    @price = price
  end

  def build
    b = binding
    # create and run templates, filling member data variables
    ERB.new(<<-'END_PRODUCT'.gsub(/^\s+/, ""), 0, "", "@product").result b
      <%= PRODUCT[:name] %>
      <%= PRODUCT[:desc] %>
    END_PRODUCT
    ERB.new(<<-'END_PRICE'.gsub(/^\s+/, ""), 0, "", "@price").result b
      <%= PRODUCT[:name] %> -- <%= PRODUCT[:cost] %>
      <%= PRODUCT[:desc] %>
    END_PRICE
  end
end

# setup template data
listings = Listings.new
listings.build

puts listings.product + "\n" + listings.price

Generates

Chicken Fried Steak
A well messages pattie, breaded and fried.

Chicken Fried Steak -- 9.95
A well messages pattie, breaded and fried.



796
797
798
799
800
801
802
803
 
# File 'lib/erb.rb', line 796

def initialize(str, safe_level=nil, trim_mode=nil, eoutvar='_erbout')
  @safe_level = safe_level
  compiler = make_compiler(trim_mode)
  set_eoutvar(compiler, eoutvar)
  @src, @encoding = *compiler.compile(str)
  @filename = nil
  @lineno = 0
end

Instance Attribute Details

#encoding ⇒ Object (readonly)

The encoding to eval



816
817
818
 
# File 'lib/erb.rb', line 816

def encoding
  @encoding
end

#filename ⇒ Object

The optional filename argument passed to Kernel#eval when the ERB code is run



820
821
822
 
# File 'lib/erb.rb', line 820

def filename
  @filename
end

#lineno ⇒ Object

The optional lineno argument passed to Kernel#eval when the ERB code is run



824
825
826
 
# File 'lib/erb.rb', line 824

def lineno
  @lineno
end

#src ⇒ Object (readonly)

The Ruby code generated by ERB



813
814
815
 
# File 'lib/erb.rb', line 813

def src
  @src
end

Class Method Details

.version ⇒ Object

Returns revision information for the erb.rb module.



264
265
266
 
# File 'lib/erb.rb', line 264

def self.version
  "erb.rb [2.1.0 #{ERB::Revision.split[1]}]"
end

Instance Method Details

#def_class(superklass = Object, methodname = 'result') ⇒ Object

Define unnamed class which has methodname as instance method, and return it.

example:

class MyClass_
  def initialize(arg1, arg2)
    @arg1 = arg1;  @arg2 = arg2
  end
end
filename = 'example.rhtml'  # @arg1 and @arg2 are used in example.rhtml
erb = ERB.new(File.read(filename))
erb.filename = filename
MyClass = erb.def_class(MyClass_, 'render()')
print MyClass.new('foo', 123).render()



920
921
922
923
924
 
# File 'lib/erb.rb', line 920

def def_class(superklass=Object, methodname='result')
  cls = Class.new(superklass)
  def_method(cls, methodname, @filename || '(ERB)')
  cls
end

#def_method(mod, methodname, fname = '(ERB)') ⇒ Object

Define methodname as instance method of mod from compiled Ruby source.

example:

filename = 'example.rhtml'   # 'arg1' and 'arg2' are used in example.rhtml
erb = ERB.new(File.read(filename))
erb.def_method(MyClass, 'render(arg1, arg2)', filename)
print MyClass.new.render('foo', 123)



883
884
885
886
887
888
889
 
# File 'lib/erb.rb', line 883

def def_method(mod, methodname, fname='(ERB)')
  src = self.src
  magic_comment = "#coding:#{@encoding}\n"
  mod.module_eval do
    eval(magic_comment + "def #{methodname}\n" + src + "\nend\n", binding, fname, -2)
  end
end

#def_module(methodname = 'erb') ⇒ Object

Create unnamed module, define methodname as instance method of it, and return it.

example:

filename = 'example.rhtml'   # 'arg1' and 'arg2' are used in example.rhtml
erb = ERB.new(File.read(filename))
erb.filename = filename
MyModule = erb.def_module('render(arg1, arg2)')
class MyClass
  include MyModule
end



901
902
903
904
905
 
# File 'lib/erb.rb', line 901

def def_module(methodname='erb')
  mod = Module.new
  def_method(mod, methodname, @filename || '(ERB)')
  mod
end

#location=(filename, lineno) ⇒ Object 



826
827
828
829
 
# File 'lib/erb.rb', line 826

def location=((filename, lineno))
  @filename = filename
  @lineno = lineno if lineno
end

#make_compiler(trim_mode) ⇒ Object

Creates a new compiler for ERB. See ERB::Compiler.new for details



808
809
810
 
# File 'lib/erb.rb', line 808

def make_compiler(trim_mode)
  ERB::Compiler.new(trim_mode)
end

#result(b = new_toplevel) ⇒ Object

Executes the generated ERB code to produce a completed template, returning the results of that code. (See ERB::new for details on how this process can be affected by safe_level.)

b accepts a Binding object which is used to set the context of code evaluation.



856
857
858
859
860
861
862
863
864
865
 
# File 'lib/erb.rb', line 856

def result(b=new_toplevel)
  if @safe_level
    proc {
      $SAFE = @safe_level
      eval(@src, b, (@filename || '(erb)'), @lineno)
    }.call
  else
    eval(@src, b, (@filename || '(erb)'), @lineno)
  end
end

#run(b = new_toplevel) ⇒ Object

Generate results and print them. (see ERB#result)



844
845
846
 
# File 'lib/erb.rb', line 844

def run(b=new_toplevel)
  print self.result(b)
end

#set_eoutvar(compiler, eoutvar = '_erbout') ⇒ Object

Can be used to set eoutvar as described in ERB::new. It’s probably easier to just use the constructor though, since calling this method requires the setup of an ERB compiler object.



836
837
838
839
840
841
 
# File 'lib/erb.rb', line 836

def set_eoutvar(compiler, eoutvar = '_erbout')
  compiler.put_cmd = "#{eoutvar}.concat"
  compiler.insert_cmd = "#{eoutvar}.concat"
  compiler.pre_cmd = ["#{eoutvar} = ''"]
  compiler.post_cmd = ["#{eoutvar}.force_encoding(__ENCODING__)"]
end