module Luigi

Top-level Luigi namespace. See Luigi::Template for details.

Example:

# load luigi template
require 'luigi-template'

# create template
tmpl = Luigi::Template.new('hello %{name}')

# run template and print result
puts tmpl.run({
  name: 'Paul'
})

# prints "hello Paul"

You can also filter values in templates, using the pipe symbol:

# create template that converts name to upper-case
tmpl = Luigi::Template.new('hello %{name | uc}')

# run template and print result
puts tmpl.run({
  name: 'Paul'
})

# prints "hello PAUL"

Filters can be chained:

# create template that converts name to upper-case and then
# strips leading and trailing whitespace
tmpl = Luigi::Template.new('hello %{name | uc | trim}')

# run template and print result
puts tmpl.run({
  name: '   Paul    '
})

# prints "hello PAUL"

Filters can take arguments:

# create template that converts name to lowercase and then
# calculates the SHA-1 digest of the result
tmpl = Luigi::Template.new('hello %{name | lc | hash sha1}')

# run template and print result
puts tmpl.run({
  name: 'Paul',
})

# prints "hello a027184a55211cd23e3f3094f1fdc728df5e0500"

You can define custom global filters:

# create custom global filter named 'foobarify'
Luigi::FILTERS[:foobarify] = proc { |s| "foo-#{s}-bar" }

# create template which uses custom "foobarify" filter
tmpl = Luigi::Template.new('hello %{name | foobarify}')

# run template and print result
puts tmpl.run({
  name: 'Paul'
})

# prints "hello foo-Paul-bar"

Or define custom filters for a template:

# create template with custom filters rather than global filters
tmpl = Luigi::Template.new('hello %{name | reverse}', {
  reverse: proc { |s| s.reverse }
})

# run template and print result
puts tmpl.run({
  name: 'Paul',
})

# prints "hello luaP"

Your custom filters can accept arguments, too:

# create custom global filter named 'foobarify'
Luigi::FILTERS[:wrap] = proc { |s, args|
  case args.length
  when 2
    '(%s, %s, %s)' % [args[0], s, args[1]]
  when 1
    '(%s in %s)' % [s, args[0]]
  when 0
    s
  else
    raise 'invalid argument count'
  end
}

# create template that uses custom "wrap" filter
tmpl = Luigi::Template.new('sandwich: %{meat | wrap slice heel}, taco: %{meat | wrap shell}')

# run template and print result
puts tmpl.run({
  meat: 'chicken'
})

# prints "sandwich: (slice, chicken, heel), taco: (chicken in shell)"