Class: Jekyll::Site

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll/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.



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

def initialize(config)
  # Source and destination may not be changed after the site has been created.
  @source          = File.expand_path(config["source"]).freeze
  @dest            = File.expand_path(config["destination"]).freeze

  self.config = config

  @reader          = Reader.new(self)
  @regenerator     = Regenerator.new(self)
  @liquid_renderer = LiquidRenderer.new(self)

  Jekyll.sites << self

  reset
  setup

  Jekyll::Hooks.trigger :site, :after_init, self
end

Instance Attribute Details

#baseurl ⇒ Object

Returns the value of attribute baseurl.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def baseurl
  @baseurl
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.



12
13
14
 
# File 'lib/jekyll/site.rb', line 12

def converters
  @converters
end

#data ⇒ Object

Returns the value of attribute data.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def data
  @data
end

#dest ⇒ Object (readonly)

Returns the value of attribute dest.



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

def dest
  @dest
end

#drafts ⇒ Object

Returns the value of attribute drafts.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def drafts
  @drafts
end

#exclude ⇒ Object

Returns the value of attribute exclude.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def exclude
  @exclude
end

#file_read_opts ⇒ Object

Returns the value of attribute file_read_opts.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def file_read_opts
  @file_read_opts
end

#future ⇒ Object

Returns the value of attribute future.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def future
  @future
end

#gems ⇒ Object

Returns the value of attribute gems.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def gems
  @gems
end

#generators ⇒ Object

Returns the value of attribute generators.



12
13
14
 
# File 'lib/jekyll/site.rb', line 12

def generators
  @generators
end

#highlighter ⇒ Object

Returns the value of attribute highlighter.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def highlighter
  @highlighter
end

#include ⇒ Object

Returns the value of attribute include.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def include
  @include
end

#includes_load_paths ⇒ Object (readonly)

Returns the value of attribute includes_load_paths.



13
14
15
 
# File 'lib/jekyll/site.rb', line 13

def includes_load_paths
  @includes_load_paths
end

#keep_files ⇒ Object

Returns the value of attribute keep_files.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def keep_files
  @keep_files
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

#liquid_renderer ⇒ Object (readonly)

Returns the value of attribute liquid_renderer.



13
14
15
 
# File 'lib/jekyll/site.rb', line 13

def liquid_renderer
  @liquid_renderer
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

#plugin_manager ⇒ Object

Returns the value of attribute plugin_manager.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def plugin_manager
  @plugin_manager
end

#plugins ⇒ Object

Returns the value of attribute plugins.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def plugins
  @plugins
end

#reader ⇒ Object

Returns the value of attribute reader.



12
13
14
 
# File 'lib/jekyll/site.rb', line 12

def reader
  @reader
end

#regenerator ⇒ Object (readonly)

Returns the value of attribute regenerator.



13
14
15
 
# File 'lib/jekyll/site.rb', line 13

def regenerator
  @regenerator
end

#safe ⇒ Object

Returns the value of attribute safe.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def safe
  @safe
end

#show_drafts ⇒ Object

Returns the value of attribute show_drafts.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def show_drafts
  @show_drafts
end

#source ⇒ Object (readonly)

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.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def static_files
  @static_files
end

#theme ⇒ Object

Returns the value of attribute theme.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def theme
  @theme
end

#time ⇒ Object

Returns the value of attribute time.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def time
  @time
end

#unpublished ⇒ Object

Returns the value of attribute unpublished.



6
7
8
 
# File 'lib/jekyll/site.rb', line 6

def unpublished
  @unpublished
end

Instance Method Details

#categories ⇒ Object 



247
248
249
 
# File 'lib/jekyll/site.rb', line 247

def categories
  post_attr_hash("categories")
end

#cleanup ⇒ Object

Remove orphaned files and empty directories in destination.

Returns nothing.



200
201
202
 
# File 'lib/jekyll/site.rb', line 200

def cleanup
  site_cleaner.cleanup!
end

#collection_names ⇒ Object

The list of collection names.

Returns an array of collection names from the configuration,

or an empty array if the `collections` key is not set.



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/jekyll/site.rb', line 147

def collection_names
  case config["collections"]
  when Hash
    config["collections"].keys
  when Array
    config["collections"]
  when nil
    []
  else
    raise ArgumentError, "Your `collections` key must be a hash or an array."
  end
end

#collections ⇒ Object

The list of collections and their corresponding Jekyll::Collection instances. If config is set, a new instance is created for each item in the collection, a new hash is returned otherwise.

Returns a Hash containing collection name-to-instance pairs.



137
138
139
140
141
 
# File 'lib/jekyll/site.rb', line 137

def collections
  @collections ||= Hash[collection_names.map do |coll|
    [coll, Jekyll::Collection.new(self, coll)]
  end]
end

#collections_path ⇒ Object

Public: The full path to the directory that houses all the collections registered with the current site.

Returns the source directory or the absolute path to the custom collections_dir



401
402
403
404
 
# File 'lib/jekyll/site.rb', line 401

def collections_path
  dir_str = config["collections_dir"]
  @collections_path ||= dir_str.empty? ? source : in_source_dir(dir_str)
end

#docs_to_write ⇒ Object

Get the to be written documents

Returns an Array of Documents which should be written



316
317
318
 
# File 'lib/jekyll/site.rb', line 316

def docs_to_write
  @docs_to_write ||= documents.select(&:write?)
end

#documents ⇒ Object

Get all the documents

Returns an Array of all Documents



323
324
325
326
327
 
# File 'lib/jekyll/site.rb', line 323

def documents
  collections.reduce(Set.new) do |docs, (_, collection)|
    docs + collection.docs + collection.files
  end.to_a
end

#each_site_file ⇒ Object 



329
330
331
332
333
334
335
 
# File 'lib/jekyll/site.rb', line 329

def each_site_file
  %w(pages static_files docs_to_write).each do |type|
    send(type).each do |item|
      yield item
    end
  end
end

#ensure_not_in_dest ⇒ Object

Check that the destination dir isn’t the source dir or a directory parent to the source dir.



122
123
124
125
126
127
128
129
130
 
# File 'lib/jekyll/site.rb', line 122

def ensure_not_in_dest
  dest_pathname = Pathname.new(dest)
  Pathname.new(source).ascend do |path|
    if path == dest_pathname
      raise Errors::FatalException,
        "Destination directory cannot be or contain the Source directory."
    end
  end
end

#find_converter_instance(klass) ⇒ Object

Get the implementation class for the given Converter. Returns the Converter instance implementing the given Converter. klass - The Class of the Converter to fetch.



280
281
282
283
284
285
286
 
# File 'lib/jekyll/site.rb', line 280

def find_converter_instance(klass)
  @find_converter_instance ||= {}
  @find_converter_instance[klass] ||= begin
    converters.find { |converter| converter.instance_of?(klass) } || \
      raise("No Converters found for #{klass}")
  end
end

#frontmatter_defaults ⇒ Object

Returns the FrontmatterDefaults or creates a new FrontmatterDefaults if it doesn’t already exist.

Returns The FrontmatterDefaults



341
342
343
 
# File 'lib/jekyll/site.rb', line 341

def frontmatter_defaults
  @frontmatter_defaults ||= FrontmatterDefaults.new(self)
end

#generate ⇒ Object

Run each of the Generators.

Returns nothing.



172
173
174
175
176
177
178
179
 
# File 'lib/jekyll/site.rb', line 172

def generate
  generators.each do |generator|
    start = Time.now
    generator.generate(self)
    Jekyll.logger.debug "Generating:",
      "#{generator.class} finished in #{Time.now - start} seconds."
  end
end

#in_dest_dir(*paths) ⇒ Object

Public: Prefix a given path with the destination directory.

paths - (optional) path elements to a file or directory within the

destination directory

Returns a path which is prefixed with the destination directory.



391
392
393
394
395
 
# File 'lib/jekyll/site.rb', line 391

def in_dest_dir(*paths)
  paths.reduce(dest) do |base, path|
    Jekyll.sanitized_path(base, path)
  end
end

#in_source_dir(*paths) ⇒ Object

Public: Prefix a given path with the source directory.

paths - (optional) path elements to a file or directory within the

source directory

Returns a path which is prefixed with the source directory.



366
367
368
369
370
 
# File 'lib/jekyll/site.rb', line 366

def in_source_dir(*paths)
  paths.reduce(source) do |base, path|
    Jekyll.sanitized_path(base, path)
  end
end

#in_theme_dir(*paths) ⇒ Object

Public: Prefix a given path with the theme directory.

paths - (optional) path elements to a file or directory within the

theme directory

Returns a path which is prefixed with the theme root directory.



378
379
380
381
382
383
 
# File 'lib/jekyll/site.rb', line 378

def in_theme_dir(*paths)
  return nil unless theme
  paths.reduce(theme.root) do |base, path|
    Jekyll.sanitized_path(base, path)
  end
end

#incremental?(override = {}) ⇒ Boolean

Whether to perform a full rebuild without incremental regeneration

Returns a Boolean: true for a full rebuild, false for normal build

Returns:

  • (Boolean) 


348
349
350
 
# File 'lib/jekyll/site.rb', line 348

def incremental?(override = {})
  override["incremental"] || config["incremental"]
end

#instantiate_subclasses(klass) ⇒ Object

klass - class or module containing the subclasses. Returns array of instances of subclasses of parameter. Create array of instances of the subclasses of the class or module passed in as argument.



293
294
295
296
297
 
# File 'lib/jekyll/site.rb', line 293

def instantiate_subclasses(klass)
  klass.descendants.select { |c| !safe || c.safe }.sort.map do |c|
    c.new(config)
  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.



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/jekyll/site.rb', line 232

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 { |h, key| h[key] = [] }
  posts.docs.each do |p|
    p.data[post_attr].each { |t| hash[t] << p } if p.data[post_attr]
  end
  hash.each_value { |posts| posts.sort!.reverse! }
  hash
end

#posts ⇒ Object 



215
216
217
 
# File 'lib/jekyll/site.rb', line 215

def posts
  collections["posts"] ||= Collection.new(self, "posts")
end

#print_stats ⇒ Object 



77
78
79
 
# File 'lib/jekyll/site.rb', line 77

def print_stats
  Jekyll.logger.info @liquid_renderer.stats_table
end

#process ⇒ Object

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

Returns nothing.



67
68
69
70
71
72
73
74
75
 
# File 'lib/jekyll/site.rb', line 67

def process
  reset
  read
  generate
  render
  cleanup
  write
  print_stats if config["profile"]
end

#publisher ⇒ Object

Returns the publisher or creates a new publisher if it doesn’t already exist.

Returns The Publisher



356
357
358
 
# File 'lib/jekyll/site.rb', line 356

def publisher
  @publisher ||= Publisher.new(self)
end

#read ⇒ Object

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

Returns nothing.



163
164
165
166
167
 
# File 'lib/jekyll/site.rb', line 163

def read
  reader.read
  limit_posts!
  Jekyll::Hooks.trigger :site, :post_read, self
end

#relative_permalinks_are_deprecated ⇒ Object

Warns the user if permanent links are relative to the parent directory. As this is a deprecated function of Jekyll.

Returns



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

def relative_permalinks_are_deprecated
  if config["relative_permalinks"]
    Jekyll.logger.abort_with "Since v3.0, permalinks for pages" \
                            " in subfolders must be relative to the" \
                            " site source directory, not the parent" \
                            " directory. Check https://jekyllrb.com/docs/upgrading/"\
                            " for more info."
  end
end

#render ⇒ Object

Render the site to the destination.

Returns nothing.



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/jekyll/site.rb', line 184

def render
  relative_permalinks_are_deprecated

  payload = site_payload

  Jekyll::Hooks.trigger :site, :pre_render, self, payload

  render_docs(payload)
  render_pages(payload)

  Jekyll::Hooks.trigger :site, :post_render, self, payload
end

#reset ⇒ Object

Reset Site details.

Returns nothing



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/jekyll/site.rb', line 84

def reset
  self.time = if config["time"]
                Utils.parse_date(config["time"].to_s, "Invalid time in _config.yml.")
              else
                Time.now
              end
  self.layouts = {}
  self.pages = []
  self.static_files = []
  self.data = {}
  @site_data = nil
  @collections = nil
  @docs_to_write = nil
  @regenerator.clear_cache
  @liquid_renderer.reset
  @site_cleaner = nil

  if limit_posts < 0
    raise ArgumentError, "limit_posts must be a non-negative number"
  end

  Jekyll::Hooks.trigger :site, :after_reset, self
end

#setup ⇒ Object

Load necessary libraries, plugins, converters, and generators.

Returns nothing.



111
112
113
114
115
116
117
118
 
# File 'lib/jekyll/site.rb', line 111

def setup
  ensure_not_in_dest

  plugin_manager.conscientious_require

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

#site_data ⇒ Object

Prepare site data for site payload. The method maintains backward compatibility if the key ‘data’ is already used in _config.yml.

Returns the Hash to be hooked to site.data.



255
256
257
 
# File 'lib/jekyll/site.rb', line 255

def site_data
  @site_data ||= (config["data"] || data)
end

#site_payload ⇒ Object Also known as: to_liquid

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.



272
273
274
 
# File 'lib/jekyll/site.rb', line 272

def site_payload
  Drops::UnifiedPayloadDrop.new self
end

#tags ⇒ Object 



243
244
245
 
# File 'lib/jekyll/site.rb', line 243

def tags
  post_attr_hash("tags")
end

#write ⇒ Object

Write static files, pages, and posts.

Returns nothing.



207
208
209
210
211
212
213
 
# File 'lib/jekyll/site.rb', line 207

def write
  each_site_file do |item|
    item.write(dest) if regenerator.regenerate?(item)
  end
  regenerator.write_metadata
  Jekyll::Hooks.trigger :site, :post_write, self
end