Class: Jekyll::Site
- Inherits:
-
Object
- Object
- Jekyll::Site
- Defined in:
- lib/jekyll/site.rb
Instance Attribute Summary collapse
-
#categories ⇒ Object
Returns the value of attribute categories.
-
#config ⇒ Object
Returns the value of attribute config.
-
#converters ⇒ Object
Returns the value of attribute converters.
-
#dest ⇒ Object
Returns the value of attribute dest.
-
#exclude ⇒ Object
Returns the value of attribute exclude.
-
#future ⇒ Object
Returns the value of attribute future.
-
#generators ⇒ Object
Returns the value of attribute generators.
-
#include ⇒ Object
Returns the value of attribute include.
-
#layouts ⇒ Object
Returns the value of attribute layouts.
-
#limit_posts ⇒ Object
Returns the value of attribute limit_posts.
-
#lsi ⇒ Object
Returns the value of attribute lsi.
-
#pages ⇒ Object
Returns the value of attribute pages.
-
#permalink_style ⇒ Object
Returns the value of attribute permalink_style.
-
#plugins ⇒ Object
Returns the value of attribute plugins.
-
#posts ⇒ Object
Returns the value of attribute posts.
-
#preview ⇒ Object
Returns the value of attribute preview.
-
#pygments ⇒ Object
Returns the value of attribute pygments.
-
#safe ⇒ Object
Returns the value of attribute safe.
-
#source ⇒ Object
Returns the value of attribute source.
-
#static_files ⇒ Object
Returns the value of attribute static_files.
-
#tags ⇒ Object
Returns the value of attribute tags.
-
#time ⇒ Object
Returns the value of attribute time.
-
#unpublished_posts ⇒ Object
Returns the value of attribute unpublished_posts.
Instance Method Summary collapse
-
#cleanup ⇒ Object
Remove orphaned files and empty directories in destination.
-
#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’.
-
#generate ⇒ Object
Run each of the Generators.
-
#getConverterImpl(klass) ⇒ Object
Get the implementation class for the given Converter.
-
#initialize(config) ⇒ Site
constructor
Public: Initialize a new Site.
-
#post_attr_hash(post_attr) ⇒ Object
Constructs a Hash of Posts indexed by the specified Post attribute.
-
#process ⇒ Object
Public: Read, process, and write this Site to output.
-
#read ⇒ Object
Read Site data from disk and load it into internal data structures.
-
#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.
-
#read_layouts(dir = '') ⇒ Object
Read all the files in <source>/<dir>/_layouts and create a new Layout object with each one.
-
#read_posts(dir) ⇒ Object
Read all the files in <source>/<dir>/_posts and create a new Post object with each one.
-
#render ⇒ Object
Render the site to the destination.
-
#reset ⇒ Object
Reset Site details.
-
#setup ⇒ Object
Load necessary libraries, plugins, converters, and generators.
-
#site_payload ⇒ Object
The Hash payload containing site-wide data.
-
#write ⇒ Object
Write static files, pages, and posts.
Constructor Details
#initialize(config) ⇒ Site
Public: Initialize a new Site.
config - A Hash containing site configuration details.
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
# File 'lib/jekyll/site.rb', line 16 def initialize(config) self.config = config.clone self.safe = config['safe'] self.source = File.(config['source']) self.dest = File.(config['destination']) self.plugins = Array(config['plugins']).map { |d| File.(d) } self.lsi = config['lsi'] self.pygments = config['pygments'] self.permalink_style = config['permalink'].to_sym self.exclude = config['exclude'] || [] self.include = config['include'] || [] self.future = config['future'] self.limit_posts = config['limit_posts'] || nil self.preview = config['preview'] self.reset self.setup end |
Instance Attribute Details
#categories ⇒ Object
Returns the value of attribute categories.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def categories @categories end |
#config ⇒ Object
Returns the value of attribute config.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def config @config end |
#converters ⇒ Object
Returns the value of attribute converters.
11 12 13 |
# File 'lib/jekyll/site.rb', line 11 def converters @converters end |
#dest ⇒ Object
Returns the value of attribute dest.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def dest @dest end |
#exclude ⇒ Object
Returns the value of attribute exclude.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def exclude @exclude end |
#future ⇒ Object
Returns the value of attribute future.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def future @future end |
#generators ⇒ Object
Returns the value of attribute generators.
11 12 13 |
# File 'lib/jekyll/site.rb', line 11 def generators @generators end |
#include ⇒ Object
Returns the value of attribute include.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def include @include end |
#layouts ⇒ Object
Returns the value of attribute layouts.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def layouts @layouts end |
#limit_posts ⇒ Object
Returns the value of attribute limit_posts.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def limit_posts @limit_posts end |
#lsi ⇒ Object
Returns the value of attribute lsi.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def lsi @lsi end |
#pages ⇒ Object
Returns the value of attribute pages.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def pages @pages end |
#permalink_style ⇒ Object
Returns the value of attribute permalink_style.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def permalink_style @permalink_style end |
#plugins ⇒ Object
Returns the value of attribute plugins.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def plugins @plugins end |
#posts ⇒ Object
Returns the value of attribute posts.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def posts @posts end |
#preview ⇒ Object
Returns the value of attribute preview.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def preview @preview end |
#pygments ⇒ Object
Returns the value of attribute pygments.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def pygments @pygments end |
#safe ⇒ Object
Returns the value of attribute safe.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def safe @safe end |
#source ⇒ Object
Returns the value of attribute source.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def source @source end |
#static_files ⇒ Object
Returns the value of attribute static_files.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def static_files @static_files end |
#tags ⇒ Object
Returns the value of attribute tags.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def @tags end |
#time ⇒ Object
Returns the value of attribute time.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def time @time end |
#unpublished_posts ⇒ Object
Returns the value of attribute unpublished_posts.
6 7 8 |
# File 'lib/jekyll/site.rb', line 6 def unpublished_posts @unpublished_posts end |
Instance Method Details
#cleanup ⇒ Object
Remove orphaned files and empty directories in destination.
Returns nothing.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/jekyll/site.rb', line 227 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| dest_files << file unless file =~ /\/\.{1,2}$/ end # files to be written files = Set.new self.posts.each do |post| files << post.destination(self.dest) end if self.preview self.unpublished_posts.each do |post| files << post.destination(self.dest) end 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 file/directory entries to filter.
Returns the Array of filtered entries.
334 335 336 337 338 339 340 341 342 343 |
# File 'lib/jekyll/site.rb', line 334 def filter_entries(entries) entries = entries.reject do |e| unless self.include.include?(e) ['.', '_', '#'].include?(e[0..0]) || e[-1..-1] == '~' || self.exclude.include?(e) || File.symlink?(e) end end end |
#generate ⇒ Object
Run each of the Generators.
Returns nothing.
193 194 195 196 197 |
# File 'lib/jekyll/site.rb', line 193 def generate self.generators.each do |generator| generator.generate(self) end 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.
350 351 352 353 354 355 356 357 |
# File 'lib/jekyll/site.rb', line 350 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 |
#post_attr_hash(post_attr) ⇒ Object
Constructs 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.
294 295 296 297 298 299 300 301 |
# File 'lib/jekyll/site.rb', line 294 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.
39 40 41 42 43 44 45 46 |
# File 'lib/jekyll/site.rb', line 39 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.
102 103 104 105 |
# File 'lib/jekyll/site.rb', line 102 def read 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.
Returns nothing.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/jekyll/site.rb', line 130 def read_directories(dir = '') base = File.join(self.source, dir) entries = Dir.chdir(base) { filter_entries(Dir.entries('.')) } self.read_posts(dir) 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) elsif !File.symlink?(f_abs) 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_layouts(dir = '') ⇒ Object
Read all the files in <source>/<dir>/_layouts and create a new Layout object with each one.
Returns nothing.
111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/jekyll/site.rb', line 111 def read_layouts(dir = '') base = File.join(self.source, dir, "_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.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/jekyll/site.rb', line 161 def read_posts(dir) base = File.join(self.source, dir, '_posts') return unless File.exists?(base) entries = Dir.chdir(base) { filter_entries(Dir['**/*']) } # 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) self.posts << post post.categories.each { |c| self.categories[c] << post } post..each { |c| self.[c] << post } else self.unpublished_posts << post end end end self.posts.sort! # limit the posts if :limit_posts option is set if limit_posts limit = self.posts.length < limit_posts ? self.posts.length : limit_posts self.posts = self.posts[-limit, limit] end end |
#render ⇒ Object
Render the site to the destination.
Returns nothing.
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/jekyll/site.rb', line 202 def render payload = site_payload self.posts.each do |post| post.render(self.layouts, payload) end if self.preview self.unpublished_posts.sort.each do |post| post.render(self.layouts, payload) end end self.pages.each do |page| page.render(self.layouts, payload) end self.categories.values.map { |ps| ps.sort! { |a, b| b <=> a } } self..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
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/jekyll/site.rb', line 51 def reset self.time = if self.config['time'] Time.parse(self.config['time'].to_s) else Time.now end self.layouts = {} self.posts = [] self.unpublished_posts = [] self.pages = [] self.static_files = [] self.categories = Hash.new { |hash, key| hash[key] = [] } self. = Hash.new { |hash, key| hash[key] = [] } if !self.limit_posts.nil? && self.limit_posts < 1 raise ArgumentError, "Limit posts must be nil or >= 1" end end |
#setup ⇒ Object
Load necessary libraries, plugins, converters, and generators.
Returns nothing.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/jekyll/site.rb', line 73 def setup require 'classifier' if self.lsi # 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 = Jekyll::Converter.subclasses.select do |c| !self.safe || c.safe end.map do |c| c.new(self.config) end self.generators = Jekyll::Generator.subclasses.select do |c| !self.safe || c.safe end.map do |c| c.new(self.config) end 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.
316 317 318 319 320 321 322 323 324 |
# File 'lib/jekyll/site.rb', line 316 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.
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/jekyll/site.rb', line 264 def write self.posts.each do |post| post.write(self.dest) end if self.preview self.unpublished_posts.each do |post| post.write(self.dest) end end self.pages.each do |page| page.write(self.dest) end self.static_files.each do |sf| sf.write(self.dest) end end |