Module: Capitate::Plugins::Templates

Defined in:
lib/capitate/plugins/templates.rb

Instance Method Summary collapse

Instance Method Details

#load(path, override_binding = nil) ⇒ Object

Load template. If the extension is .erb will be evaluated with binding.

You can add to the list of places we search for templates by setting:

set :templates_dirs, [ "path/to/templates1", "/path/to/templates2" ]

It looks for the template from:

  • the :templates_dirs setting (if set)

  • the current directory

  • the :project_root setting (if set)

  • the gem templates path

Options

path

If starts with ‘/’, absolute path, otherwise relative path to templates dir

override_binding

Binding to override, otherwise uses current (task) binding

Examples

template.load("memcached/memcached.monitrc.erb") => "This is the text of eval'ed template found at ..."

put template.load("memcached/memcached.monitrc.erb"), "/tmp/memcached.monitrc" # Uploads eval'ed template to remote /tmp/ directory



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/capitate/plugins/templates.rb', line 24

def load(path, override_binding = nil)
  template_dirs_found = template_dirs.select { |dir| File.exist?("#{dir}/#{path}") }
  
  # Not found anywhere, throw error
  if template_dirs_found.empty?
    raise "\n\nTemplate not found: #{path}\n\n"
  end
  
  # Use first
  template_path = template_dirs_found.first + "/#{path}"
  
  logger.info "reading #{template_path}"
  template_data = IO.read(template_path)
  
  if File.extname(template_path) == ".erb"    
    template = ERB.new(template_data)
    logger.info "evaluating #{template_path}"
    template_data = template.result(override_binding || binding)
  end
  template_data
end

#write(template_path, dest_path, override_binding = nil, overwrite = false, verbose = true) ⇒ Object

Write template at (relative path) with binding to LOCAL destination path.

Options

template_path

Path to template relative to templates path

dest_path

Local destination path to write to

overwrite_binding

Binding

overwrite

Force overwrite

verbose

Verbose output

Examples

template.write("config/templates/sphinx.conf.erb", "config/sphinx.conf")



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/capitate/plugins/templates.rb', line 58

def write(template_path, dest_path, override_binding = nil, overwrite = false, verbose = true)    
  # This is gnarly!
  relative_dest_path = Pathname.new(File.expand_path(dest_path)).relative_path_from(Pathname.new(File.expand_path(".")))  
  
  if !overwrite && File.exist?(dest_path) 
    puts "%10s %-40s (skipped)" % [ "create", relative_dest_path ] if verbose
    return
  end
  
  puts "%10s %-40s" % [ "create", relative_dest_path ] if verbose
  template_data = load(template_path, override_binding)
  File.open(dest_path, "w") { |file| file.puts(load(template_path, override_binding)) }
end