module Webgen::Task::CreateWebsite

About ↑

Creates the website.

This task assumes that the website directory does not exist and populates it from a specified template. webgen extensions can provide additional website templates, see below.

For each created file a verbose log message is recorded in the format used when webgen generates a website (because, actually, webgen's website generating facilities are used to create the website structure).

Creating a website template ↑

A website template is just a directory holding all the files necessary for a webgen website and therefore looks very similar to an actual webgen website directory. However, the template is not just copied but processed ('generated') by webgen itself.

What this means is:

Thus one can use Erb or any other supported content processor to customize the generated files!

Once a website template has been created, it needs to be registered with a template name, like this:

website.ext.task.data(:create_website)[:templates][TEMPLATE_NAME] = ABSOLUTE_DIR_PATH

Public Class Methods

call(website, template = nil) click to toggle source

Create the website from the given template.

This actually uses webgen's file copying/generating facilities to populate the website directory. Kind of bootstrapping really.

Returns true if the website has been created.

# File lib/webgen/task/create_website.rb, line 56
def self.call(website, template = nil)
  if File.exist?(website.directory)
    raise Error.new("Directory <#{website.directory}> does already exist!")
  end
  if template && !website.ext.task.data(:create_website)[:templates].has_key?(template)
    raise Error.new("Unknown template '#{template}' specified!")
  end

  begin
    Dir.mktmpdir do |tmpdir|
      ws = Webgen::Website.new(tmpdir) do |iws|
        iws.config['sources'] = [['/', :file_system, File.join(Webgen::Utils.data_dir, 'basic_website_template')]]
        if template
          iws.config['sources'].unshift(['/', :file_system, website.ext.task.data(:create_website)[:templates][template]])
        end
        iws.config['destination'] = [:file_system, File.expand_path(website.directory)]
        iws.ext.path_handler.registered_extensions.each do |_name, data|
          data.patterns = []
        end
        iws.ext.path_handler.registered_extensions[:copy].patterns = ['**/*', '**/']
        iws.logger.level = ::Logger::INFO
        iws.logger.formatter = Proc.new do |_severity, _timestamp, _progname, msg|
          website.logger.vinfo(msg) if msg =~ /\[create\]/
        end
      end
      ws.execute_task(:generate_website)
    end
  rescue Webgen::Error => e
    raise Error.new("Could not create website from template: #{e.message}")
  end

  true
end