Class: Moft::Site

Inherits:
Object
  • Object
show all
Defined in:
lib/moft/site.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Site

Public: Initialize a new Site.

config - A Hash containing site configuration details.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/moft/site.rb', line 15

def initialize(config)
  self.config          = config.clone

  self.safe            = config['safe']
  self.source          = File.expand_path(config['source'])
  self.dest            = File.expand_path(config['destination'])
  self.plugins         = plugins_path
  self.lsi             = config['lsi']
  self.pygments        = config['pygments']
  self.baseurl         = config['baseurl']
  self.permalink_style = config['permalink'].to_sym
  self.exclude         = config['exclude']
  self.include         = config['include']
  self.future          = config['future']
  self.show_drafts     = config['show_drafts']
  self.limit_posts     = config['limit_posts']
  self.keep_files      = config['keep_files']
  self.static_includes = config['static_includes']

  self.reset
  self.setup
end

Instance Attribute Details

#baseurl ⇒ Object

Returns the value of attribute baseurl.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def baseurl
  @baseurl
end

#categories ⇒ Object

Returns the value of attribute categories.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def categories
  @categories
end

#config ⇒ Object

Returns the value of attribute config.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def config
  @config
end

#converters ⇒ Object

Returns the value of attribute converters.



10
11
12
 
# File 'lib/moft/site.rb', line 10

def converters
  @converters
end

#dest ⇒ Object

Returns the value of attribute dest.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def dest
  @dest
end

#exclude ⇒ Object

Returns the value of attribute exclude.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def exclude
  @exclude
end

#future ⇒ Object

Returns the value of attribute future.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def future
  @future
end

#generators ⇒ Object

Returns the value of attribute generators.



10
11
12
 
# File 'lib/moft/site.rb', line 10

def generators
  @generators
end

#include ⇒ Object

Returns the value of attribute include.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def include
  @include
end

#keep_files ⇒ Object

Returns the value of attribute keep_files.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def keep_files
  @keep_files
end

#layouts ⇒ Object

Returns the value of attribute layouts.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def layouts
  @layouts
end

#limit_posts ⇒ Object

Returns the value of attribute limit_posts.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def limit_posts
  @limit_posts
end

#lsi ⇒ Object

Returns the value of attribute lsi.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def lsi
  @lsi
end

#pages ⇒ Object

Returns the value of attribute pages.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def pages
  @pages
end

#permalink_style ⇒ Object

Returns the value of attribute permalink_style.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def permalink_style
  @permalink_style
end

#plugins ⇒ Object

Returns the value of attribute plugins.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def plugins
  @plugins
end

#posts ⇒ Object

Returns the value of attribute posts.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def posts
  @posts
end

#pygments ⇒ Object

Returns the value of attribute pygments.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def pygments
  @pygments
end

#safe ⇒ Object

Returns the value of attribute safe.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def safe
  @safe
end

#show_drafts ⇒ Object

Returns the value of attribute show_drafts.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def show_drafts
  @show_drafts
end

#source ⇒ Object

Returns the value of attribute source.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def source
  @source
end

#static_files ⇒ Object

Returns the value of attribute static_files.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def static_files
  @static_files
end

#static_includes ⇒ Object

Returns the value of attribute static_includes.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def static_includes
  @static_includes
end

#tags ⇒ Object

Returns the value of attribute tags.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def tags
  @tags
end

#time ⇒ Object

Returns the value of attribute time.



5
6
7
 
# File 'lib/moft/site.rb', line 5

def time
  @time
end

Instance Method Details

#aggregate_post_info(post) ⇒ Object

Aggregate post information

post - The Post object to aggregate information for

Returns nothing



424
425
426
427
428
 
# File 'lib/moft/site.rb', line 424

def aggregate_post_info(post)
  self.posts << post
  post.categories.each { |c| self.categories[c] << post }
  post.tags.each { |c| self.tags[c] << post }
end

#cleanup ⇒ Object

Remove orphaned files and empty directories in destination.

Returns nothing.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/moft/site.rb', line 254

def cleanup
  # all files and directories in destination, including hidden ones
  dest_files = Set.new
  Dir.glob(File.join(self.dest, "**", "*"), File::FNM_DOTMATCH) do |file|
    if self.keep_files.length > 0
      dest_files << file unless file =~ /\/\.{1,2}$/ || file =~ keep_file_regex
    else
      dest_files << file unless file =~ /\/\.{1,2}$/
    end
  end

  # files to be written
  files = Set.new
  self.posts.each do |post|
    files << post.destination(self.dest)
  end
  self.pages.each do |page|
    files << page.destination(self.dest)
  end
  self.static_files.each do |sf|
    files << sf.destination(self.dest)
  end

  # adding files' parent directories
  dirs = Set.new
  files.each { |file| dirs << File.dirname(file) }
  files.merge(dirs)

  obsolete_files = dest_files - files
  FileUtils.rm_rf(obsolete_files.to_a)
end

#filter_entries(entries) ⇒ Object

Filter out any files/directories that are hidden or backup files (start with “.” or “#” or end with “~”), or contain site content (start with “_”), or are excluded in the site configuration, unless they are web server files such as ‘.htaccess’.

entries - The Array of String file/directory entries to filter.

Returns the Array of filtered entries.



366
367
368
369
370
371
372
373
374
375
 
# File 'lib/moft/site.rb', line 366

def filter_entries(entries)
  entries.reject do |e|
    unless self.include.glob_include?(e)
      ['.','_', '#'].include?(e[0..0]) ||
      e[-1..-1] == '~' ||
      self.exclude.glob_include?(e) ||
      (File.symlink?(e) && self.safe)
    end
  end
end

#generate ⇒ Object

Run each of the Generators.

Returns nothing.



226
227
228
229
230
 
# File 'lib/moft/site.rb', line 226

def generate
  self.generators.each do |generator|
    generator.generate(self)
  end
end

#get_entries(dir, subfolder) ⇒ Object

Read the entries from a particular directory for processing

dir - The String relative path of the directory to read subfolder - The String directory to read

Returns the list of entries to process



412
413
414
415
416
417
 
# File 'lib/moft/site.rb', line 412

def get_entries(dir, subfolder)
  base = File.join(self.source, dir, subfolder)
  return [] unless File.exists?(base)
  entries = Dir.chdir(base) { filter_entries(Dir['**/*']) }
  entries.delete_if { |e| File.directory?(File.join(base, e)) }
end

#getConverterImpl(klass) ⇒ Object

Get the implementation class for the given Converter.

klass - The Class of the Converter to fetch.

Returns the Converter instance implementing the given Converter.



382
383
384
385
386
387
388
389
 
# File 'lib/moft/site.rb', line 382

def getConverterImpl(klass)
  matches = self.converters.select { |c| c.class == klass }
  if impl = matches.first
    impl
  else
    raise "Converter implementation not found for #{klass}"
  end
end

#instantiate_subclasses(klass) ⇒ Object

Create array of instances of the subclasses of the class or module

passed in as argument.

klass - class or module containing the subclasses which should be

instantiated

Returns array of instances of subclasses of parameter



398
399
400
401
402
403
404
 
# File 'lib/moft/site.rb', line 398

def instantiate_subclasses(klass)
  klass.subclasses.select do |c|
    !self.safe || c.safe
  end.sort.map do |c|
    c.new(self.config)
  end
end

#keep_file_regex ⇒ Object

Private: creates a regular expression from the keep_files array

Examples

['.git','.svn'] creates the following regex: /\/(\.git|\/.svn)/

Returns the regular expression



292
293
294
295
296
 
# File 'lib/moft/site.rb', line 292

def keep_file_regex
  or_list = self.keep_files.join("|")
  pattern = "\/(#{or_list.gsub(".", "\.")})"
  Regexp.new pattern
end

#plugins_path ⇒ Object

Internal: Setup the plugin search path

Returns an Array of plugin search paths



100
101
102
103
104
105
106
 
# File 'lib/moft/site.rb', line 100

def plugins_path
  if (config['plugins'] == Moft::Configuration::DEFAULTS['plugins'])
    [File.join(self.source, config['plugins'])]
  else
    Array(config['plugins']).map { |d| File.expand_path(d) }
  end
end

#post_attr_hash(post_attr) ⇒ Object

Construct a Hash of Posts indexed by the specified Post attribute.

post_attr - The String name of the Post attribute.

Examples

post_attr_hash('categories')
# => { 'tech' => [<Post A>, <Post B>],
#      'ruby' => [<Post B>] }

Returns the Hash: { attr => posts } where

attr  - One of the values for the requested attribute.
posts - The Array of Posts with the given attr value.



326
327
328
329
330
331
332
333
 
# File 'lib/moft/site.rb', line 326

def post_attr_hash(post_attr)
  # Build a hash map based on the specified post attribute ( post attr =>
  # array of posts ) then sort each array in reverse order.
  hash = Hash.new { |hsh, key| hsh[key] = Array.new }
  self.posts.each { |p| p.send(post_attr.to_sym).each { |t| hash[t] << p } }
  hash.values.map { |sortme| sortme.sort! { |a, b| b <=> a } }
  hash
end

#process ⇒ Object

Public: Read, process, and write this Site to output.

Returns nothing.



41
42
43
44
45
46
47
48
 
# File 'lib/moft/site.rb', line 41

def process
  self.reset
  self.read
  self.generate
  self.render
  self.cleanup
  self.write
end

#read ⇒ Object

Read Site data from disk and load it into internal data structures.

Returns nothing.



111
112
113
114
115
 
# File 'lib/moft/site.rb', line 111

def read
  self.read_static_includes
  self.read_layouts
  self.read_directories
end

#read_directories(dir = '') ⇒ Object

Recursively traverse directories to find posts, pages and static files that will become part of the site according to the rules in filter_entries.

dir - The String relative path of the directory to read. Default: ”.

Returns nothing.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/moft/site.rb', line 146

def read_directories(dir = '')
  base = File.join(self.source, dir)
  entries = Dir.chdir(base) { filter_entries(Dir.entries('.')) }

  self.read_posts(dir)

  if self.show_drafts
    self.read_drafts(dir)
  end

  self.posts.sort!

  # limit the posts if :limit_posts option is set
  if limit_posts > 0
    limit = self.posts.length < limit_posts ? self.posts.length : limit_posts
    self.posts = self.posts[-limit, limit]
  end
  
  entries.each do |f|
    f_abs = File.join(base, f)
    f_rel = File.join(dir, f)
    if File.directory?(f_abs)
      next if self.dest.sub(/\/$/, '') == f_abs
      read_directories(f_rel)
    else
      first3 = File.open(f_abs) { |fd| fd.read(3) }
      if first3 == "---"
        # file appears to have a YAML header so process it as a page
        pages << Page.new(self, self.source, dir, f)
      else
        # otherwise treat it as a static file
        static_files << StaticFile.new(self, self.source, dir, f)
      end
    end
  end
end

#read_drafts(dir) ⇒ Object

Read all the files in <source>/<dir>/_drafts and create a new Post object with each one.

dir - The String relative path of the directory to read.

Returns nothing.



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/moft/site.rb', line 210

def read_drafts(dir)
  entries = get_entries(dir, '_drafts')

  # first pass processes, but does not yet render draft content
  entries.each do |f|
    if Draft.valid?(f)
      draft = Draft.new(self, self.source, dir, f)

      aggregate_post_info(draft)
    end
  end
end

#read_layouts ⇒ Object

Read all the files in <source>/<layouts> and create a new Layout object with each one.

Returns nothing.



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/moft/site.rb', line 127

def read_layouts
  base = File.join(self.source, self.config['layouts'])
  return unless File.exists?(base)
  entries = []
  Dir.chdir(base) { entries = filter_entries(Dir['*.*']) }

  entries.each do |f|
    name = f.split(".")[0..-2].join(".")
    self.layouts[name] = Layout.new(self, base, f)
  end
end

#read_posts(dir) ⇒ Object

Read all the files in <source>/<dir>/_posts and create a new Post object with each one.

dir - The String relative path of the directory to read.

Returns nothing.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/moft/site.rb', line 189

def read_posts(dir)
  entries = get_entries(dir, '_posts')

  # first pass processes, but does not yet render post content
  entries.each do |f|
    if Post.valid?(f)
      post = Post.new(self, self.source, dir, f)

      if post.published && (self.future || post.date <= self.time)
        aggregate_post_info(post)
      end
    end
  end
end

#read_static_includes ⇒ Object 



117
118
119
120
121
 
# File 'lib/moft/site.rb', line 117

def read_static_includes
  self.static_includes.each do |s|
    self.read_directories(s)
  end
end

#render ⇒ Object

Render the site to the destination.

Returns nothing.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/moft/site.rb', line 235

def render
  payload = site_payload
  self.posts.each do |post|
    post.render(self.layouts, payload)
  end

  self.pages.each do |page|
    page.render(self.layouts, payload)
  end

  self.categories.values.map { |ps| ps.sort! { |a, b| b <=> a } }
  self.tags.values.map { |ps| ps.sort! { |a, b| b <=> a } }
rescue Errno::ENOENT => e
  # ignore missing layout dir
end

#reset ⇒ Object

Reset Site details.

Returns nothing



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/moft/site.rb', line 53

def reset
  self.time            = if self.config['time']
                           Time.parse(self.config['time'].to_s)
                         else
                           Time.now
                         end
  self.layouts         = {}
  self.posts           = []
  self.pages           = []
  self.static_files    = []
  self.categories      = Hash.new { |hash, key| hash[key] = [] }
  self.tags            = Hash.new { |hash, key| hash[key] = [] }

  if self.limit_posts < 0
    raise ArgumentError, "limit_posts must not be a negative number"
  end
end

#setup ⇒ Object

Load necessary libraries, plugins, converters, and generators.

Returns nothing.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/moft/site.rb', line 74

def setup
  # require 'classifier' if self.lsi

  # Check that the destination dir isn't the source dir or a directory
  # parent to the source dir.
  if self.source =~ /^#{self.dest}/
    raise FatalException.new "Destination directory cannot be or contain the Source directory."
  end

  # If safe mode is off, load in any Ruby files under the plugins
  # directory.
  unless self.safe
    self.plugins.each do |plugins|
        Dir[File.join(plugins, "**/*.rb")].each do |f|
          require f
        end
    end
  end

  self.converters = instantiate_subclasses(Moft::Converter)
  self.generators = instantiate_subclasses(Moft::Generator)
end

#site_payload ⇒ Object

The Hash payload containing site-wide data.

Returns the Hash: { “site” => data } where data is a Hash with keys:

"time"       - The Time as specified in the configuration or the
               current time if none was specified.
"posts"      - The Array of Posts, sorted chronologically by post date
               and then title.
"pages"      - The Array of all Pages.
"html_pages" - The Array of HTML Pages.
"categories" - The Hash of category values and Posts.
               See Site#post_attr_hash for type info.
"tags"       - The Hash of tag values and Posts.
               See Site#post_attr_hash for type info.



348
349
350
351
352
353
354
355
356
 
# File 'lib/moft/site.rb', line 348

def site_payload
  {"site" => self.config.merge({
      "time"       => self.time,
      "posts"      => self.posts.sort { |a, b| b <=> a },
      "pages"      => self.pages,
      "html_pages" => self.pages.reject { |page| !page.html? },
      "categories" => post_attr_hash('categories'),
      "tags"       => post_attr_hash('tags')})}
end

#write ⇒ Object

Write static files, pages, and posts.

Returns nothing.



301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/moft/site.rb', line 301

def write
  self.posts.each do |post|
    post.write(self.dest)
  end
  self.pages.each do |page|
    page.write(self.dest)
  end
  self.static_files.each do |sf|
    sf.write(self.dest)
  end
end