Class: Jekyll::Site
- Inherits:
-
Object
- Object
- Jekyll::Site
- Defined in:
- lib/jekyll/site.rb
Instance Attribute Summary collapse
-
#baseurl ⇒ Object
Returns the value of attribute baseurl.
-
#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.
-
#keep_files ⇒ Object
Returns the value of attribute keep_files.
-
#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.
-
#pygments ⇒ Object
Returns the value of attribute pygments.
-
#safe ⇒ Object
Returns the value of attribute safe.
-
#show_drafts ⇒ Object
Returns the value of attribute show_drafts.
-
#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.
Instance Method Summary collapse
-
#aggregate_post_info(post) ⇒ Object
Aggregate post information.
-
#cleanup ⇒ Object
Remove orphaned files and empty directories in destination.
- #each_site_file ⇒ Object
-
#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.
-
#get_entries(dir, subfolder) ⇒ Object
Read the entries from a particular directory for processing.
-
#getConverterImpl(klass) ⇒ Object
Get the implementation class for the given Converter.
-
#initialize(config) ⇒ Site
constructor
Public: Initialize a new Site.
-
#instantiate_subclasses(klass) ⇒ Object
Create array of instances of the subclasses of the class or module passed in as argument.
-
#keep_file_regex ⇒ Object
Private: creates a regular expression from the keep_files array.
-
#plugins_path ⇒ Object
Internal: Setup the plugin search path.
-
#post_attr_hash(post_attr) ⇒ Object
Construct 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_drafts(dir) ⇒ Object
Read all the files in <source>/<dir>/_drafts and create a new Post object with each one.
-
#read_layouts ⇒ Object
Read all the files in <source>/<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.
- #relative_permalinks_deprecation_method ⇒ Object
-
#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.
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# File 'lib/jekyll/site.rb', line 15 def initialize(config) self.config = config.clone self.safe = config['safe'] self.source = File.(config['source']) self.dest = File.(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.reset self.setup end |
Instance Attribute Details
#baseurl ⇒ Object
Returns the value of attribute baseurl.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def baseurl @baseurl end |
#categories ⇒ Object
Returns the value of attribute categories.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def categories @categories end |
#config ⇒ Object
Returns the value of attribute config.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def config @config end |
#converters ⇒ Object
Returns the value of attribute converters.
10 11 12 |
# File 'lib/jekyll/site.rb', line 10 def converters @converters end |
#dest ⇒ Object
Returns the value of attribute dest.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def dest @dest end |
#exclude ⇒ Object
Returns the value of attribute exclude.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def exclude @exclude end |
#future ⇒ Object
Returns the value of attribute future.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def future @future end |
#generators ⇒ Object
Returns the value of attribute generators.
10 11 12 |
# File 'lib/jekyll/site.rb', line 10 def generators @generators end |
#include ⇒ Object
Returns the value of attribute include.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def include @include end |
#keep_files ⇒ Object
Returns the value of attribute keep_files.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def keep_files @keep_files end |
#layouts ⇒ Object
Returns the value of attribute layouts.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def layouts @layouts end |
#limit_posts ⇒ Object
Returns the value of attribute limit_posts.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def limit_posts @limit_posts end |
#lsi ⇒ Object
Returns the value of attribute lsi.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def lsi @lsi end |
#pages ⇒ Object
Returns the value of attribute pages.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def pages @pages end |
#permalink_style ⇒ Object
Returns the value of attribute permalink_style.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def permalink_style @permalink_style end |
#plugins ⇒ Object
Returns the value of attribute plugins.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def plugins @plugins end |
#posts ⇒ Object
Returns the value of attribute posts.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def posts @posts end |
#pygments ⇒ Object
Returns the value of attribute pygments.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def pygments @pygments end |
#safe ⇒ Object
Returns the value of attribute safe.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def safe @safe end |
#show_drafts ⇒ Object
Returns the value of attribute show_drafts.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def show_drafts @show_drafts end |
#source ⇒ Object
Returns the value of attribute source.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def source @source end |
#static_files ⇒ Object
Returns the value of attribute static_files.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def static_files @static_files end |
#tags ⇒ Object
Returns the value of attribute tags.
5 6 7 |
# File 'lib/jekyll/site.rb', line 5 def @tags end |
#time ⇒ Object
Returns the value of attribute time.
5 6 7 |
# File 'lib/jekyll/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
388 389 390 391 392 |
# File 'lib/jekyll/site.rb', line 388 def aggregate_post_info(post) self.posts << post post.categories.each { |c| self.categories[c] << post } post..each { |c| self.[c] << post } end |
#cleanup ⇒ Object
Remove orphaned files and empty directories in destination.
Returns nothing.
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 |
# File 'lib/jekyll/site.rb', line 230 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 each_site_file { |item| files << item.destination(self.dest) } # adding files' parent directories dirs = Set.new files.each { |file| dirs << File.dirname(file) } files.merge(dirs) # files that are replaced by dirs should be deleted files_to_delete = Set.new dirs.each { |dir| files_to_delete << dir if File.file?(dir) } obsolete_files = dest_files - files + files_to_delete FileUtils.rm_rf(obsolete_files.to_a) end |
#each_site_file ⇒ Object
407 408 409 410 411 412 413 |
# File 'lib/jekyll/site.rb', line 407 def each_site_file %w(posts pages static_files).each do |type| self.send(type).each do |item| yield item end end 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.
330 331 332 333 334 335 336 337 338 339 |
# File 'lib/jekyll/site.rb', line 330 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.
201 202 203 204 205 |
# File 'lib/jekyll/site.rb', line 201 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
376 377 378 379 380 381 |
# File 'lib/jekyll/site.rb', line 376 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.
346 347 348 349 350 351 352 353 |
# File 'lib/jekyll/site.rb', line 346 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
362 363 364 365 366 367 368 |
# File 'lib/jekyll/site.rb', line 362 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
264 265 266 267 268 |
# File 'lib/jekyll/site.rb', line 264 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
97 98 99 100 101 102 103 |
# File 'lib/jekyll/site.rb', line 97 def plugins_path if (config['plugins'] == Jekyll::Configuration::DEFAULTS['plugins']) [File.join(self.source, config['plugins'])] else Array(config['plugins']).map { |d| File.(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.
290 291 292 293 294 295 296 297 |
# File 'lib/jekyll/site.rb', line 290 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.
40 41 42 43 44 45 46 47 |
# File 'lib/jekyll/site.rb', line 40 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.
108 109 110 111 |
# File 'lib/jekyll/site.rb', line 108 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. Default: ”.
Returns nothing.
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/jekyll/site.rb', line 136 def read_directories(dir = '') base = File.join(self.source, dir) entries = Dir.chdir(base) { filter_entries(Dir.entries('.')) } self.read_posts(dir) self.read_drafts(dir) if self.show_drafts self.posts.sort! limit_posts! if limit_posts > 0 # limit the posts if :limit_posts option is set entries.each do |f| f_abs = File.join(base, f) if File.directory?(f_abs) f_rel = File.join(dir, f) read_directories(f_rel) unless self.dest.sub(/\/$/, '') == f_abs elsif has_yaml_header?(f_abs) pages << Page.new(self, self.source, dir, f) else static_files << StaticFile.new(self, self.source, dir, f) 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.
185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/jekyll/site.rb', line 185 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.
117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/jekyll/site.rb', line 117 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.
164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/jekyll/site.rb', line 164 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 |
#relative_permalinks_deprecation_method ⇒ Object
394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'lib/jekyll/site.rb', line 394 def relative_permalinks_deprecation_method if config['relative_permalinks'] && !@deprecated_relative_permalinks $stderr.puts # Places newline after "Generating..." Jekyll.logger.warn "Deprecation:", "Starting in 1.1, permalinks for pages" + " in subfolders must be relative to the" + " site source directory, not the parent" + " directory. Check http://jekyllrb.com/docs/upgrading/"+ " for more info." $stderr.print Jekyll.logger.formatted_topic("") + "..." # for "done." @deprecated_relative_permalinks = true end end |
#render ⇒ Object
Render the site to the destination.
Returns nothing.
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/jekyll/site.rb', line 210 def render payload = site_payload self.posts.each do |post| post.render(self.layouts, payload) end self.pages.each do |page| relative_permalinks_deprecation_method if page.uses_relative_permalinks 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
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/jekyll/site.rb', line 52 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. = Hash.new { |hash, key| hash[key] = [] } if self.limit_posts < 0 raise ArgumentError, "limit_posts must be a non-negative number" 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 |
# File 'lib/jekyll/site.rb', line 73 def setup # 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(Jekyll::Converter) self.generators = instantiate_subclasses(Jekyll::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.
312 313 314 315 316 317 318 319 320 |
# File 'lib/jekyll/site.rb', line 312 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.
273 274 275 |
# File 'lib/jekyll/site.rb', line 273 def write each_site_file { |item| item.write(self.dest) } end |