Class: Webby::Builder

Inherits:
Object
  • Object
show all
Defined in:
lib/webby/builder.rb

Overview

The Builder class performs the work of scanning the content folder, creating Resource objects, and converting / copying the contents to the output folder as needed.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Builder

call-seq:

Builder.new

Creates a new Builder object for creating pages from the content and layout directories.



97
98
99
 
# File 'lib/webby/builder.rb', line 97

def initialize
  @logger = Logging::Logger[self]
end

Class Method Details

.create(page, opts = {}) ⇒ Object

call-seq:

Builder.create( page, :from => template, :locals => {} )

This mehod is used to create a new page in the content folder based on the specified template. page is the relative path to the new page from the content/ folder. The template is the name of the template to use from the templates/ folder.

Raises:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/webby/builder.rb', line 34

def create( page, opts = {} )
  tmpl = opts[:from]
  raise Error, "template not given" unless tmpl

  name = ::Webby::Resources.basename(page)
  ext  = ::Webby::Resources.extname(page)
  dir  = ::File.dirname(page)
  dir  = '' if dir == '.'

  if tmpl.pathmap('%n') =~ %r/^_/
    page = ::File.join(::Webby.site.content_dir, dir, '_'+name)
    page << '.' << (ext.empty? ? Webby.site.default_ext : ext)
  elsif ::Webby.site.create_mode == 'directory' and name != 'index'
    page = ::File.join(::Webby.site.content_dir, dir, name, 'index')
    page << '.' << (ext.empty? ? Webby.site.default_ext : ext)
  else
    page = ::File.join(::Webby.site.content_dir, page)
    page << '.' << Webby.site.default_ext if ext.empty?
  end
  raise Error, "#{page} already exists" if test ?e, page

  Logging::Logger[self].info "creating #{page}"
  FileUtils.mkdir_p ::File.dirname(page)

  context = scope
  opts[:locals].each do |k,v|
    Thread.current[:value] = v
    definition = "#{k} = Thread.current[:value]"
    eval(definition, context)
  end if opts.has_key?(:locals)

  str = ERB.new(::File.read(tmpl), nil, '-').result(context)
  ::File.open(page, 'w') {|fd| fd.write str}

  page
end

.new_page_info ⇒ Object

call-seq:

Builder.new_page_info    => [page, title, directory]



74
75
76
77
78
79
80
81
 
# File 'lib/webby/builder.rb', line 74

def new_page_info
  args = Webby.site.args

  # TODO: maybe even get rid of this method altogether
  raise "Usage:  webby #{args.rake.first} 'path'" if args.raw.empty?

  [args.page, args.title, args.dir]
end

.run(opts = {}) ⇒ Object

call-seq:

Builder.run( :rebuild => false )

Create a new instance of the Builder class and invoke the run method. If the :rebuild option is given as true, then all pages will be recreated / copied.



22
23
24
 
# File 'lib/webby/builder.rb', line 22

def run( opts = {} )
  self.new.run opts
end

Instance Method Details

#load_files ⇒ Object 



158
159
160
161
 
# File 'lib/webby/builder.rb', line 158

def load_files
  ::Webby.deprecated "load_files", "it is being replaced by the Webby#load() method"
  ::Webby.load_files
end

#run(opts = {}) ⇒ Object

call-seq:

run( :rebuild => false, :load_files => true )

Runs the Webby builder by loading in the layout files from the layouts/ folder and the content from the contents/ folder. Content is analyzed, and those that need to be copied or compiled (filtered using ERB, Texttile, Markdown, etc.) are handled. The results are placed in the output/ folder.

If the :rebuild flag is set to true, then all content is copied and/or compiled to the output folder.

A content file can mark itself as dirty by setting the dirty flag to true in the meta-data of the file. This will cause the contenet to always be compiled when the builder is run. Conversely, setting the dirty flag to false will cause the content to never be compiled or copied to the output folder.

A content file needs to be built if the age of the file is less then the age of the output product – i.e. the content file has been modified more recently than the output file.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/webby/builder.rb', line 123

def run( opts = {} )
  opts[:load_files] = true unless opts.has_key?(:load_files)
  verbose = opts.getopt(:verbose, true)

  unless test(?d, output_dir)
    journal.create output_dir
    FileUtils.mkdir output_dir
  end

  ::Webby.load_files if opts[:load_files]

  Resources.pages.each do |page|
    unless page.dirty? or opts[:rebuild]
      journal.identical(page.destination) if verbose
      next
    end

    # copy the resource to the output directory if it is static
    if page.instance_of? Resources::Static
      FileUtils.mkdir_p ::File.dirname(page.destination)
      journal.create_or_update(page)
      FileUtils.cp page.path, page.destination
      FileUtils.chmod 0644, page.destination

    # otherwise, layout the resource and write the results to
    # the output directory
    else Renderer.write(page) end
  end

  # touch the cairn so we know when the website was last generated
  FileUtils.touch ::Webby.cairn

  nil
end