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
36
37
38
39
# 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

  @cache_dir       = in_source_dir(config["cache_dir"])
  @filter_cache    = {}

  @reader          = Reader.new(self)
  @profiler        = Profiler.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

#baseurlObject

Returns the value of attribute baseurl


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

def baseurl
  @baseurl
end

#cache_dirObject (readonly)

Returns the value of attribute cache_dir


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

def cache_dir
  @cache_dir
end

#configObject

Returns the value of attribute config


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

def config
  @config
end

#convertersObject

Returns the value of attribute converters


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

def converters
  @converters
end

#dataObject

Returns the value of attribute data


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

def data
  @data
end

#destObject (readonly)

Returns the value of attribute dest


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

def dest
  @dest
end

#draftsObject

Returns the value of attribute drafts


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

def drafts
  @drafts
end

#excludeObject

Returns the value of attribute exclude


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

def exclude
  @exclude
end

#file_read_optsObject

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

#filter_cacheObject (readonly)

Returns the value of attribute filter_cache


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

def filter_cache
  @filter_cache
end

#futureObject

Returns the value of attribute future


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

def future
  @future
end

#gemsObject

Returns the value of attribute gems


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

def gems
  @gems
end

#generatorsObject

Returns the value of attribute generators


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

def generators
  @generators
end

#highlighterObject

Returns the value of attribute highlighter


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

def highlighter
  @highlighter
end

#includeObject

Returns the value of attribute include


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

def include
  @include
end

#includes_load_pathsObject (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

#inclusionsObject

Returns the value of attribute inclusions


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

def inclusions
  @inclusions
end

#keep_filesObject

Returns the value of attribute keep_files


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

def keep_files
  @keep_files
end

#layoutsObject

Returns the value of attribute layouts


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

def layouts
  @layouts
end

#limit_postsObject

Returns the value of attribute limit_posts


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

def limit_posts
  @limit_posts
end

#liquid_rendererObject (readonly)

Returns the value of attribute liquid_renderer


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

def liquid_renderer
  @liquid_renderer
end

#lsiObject

Returns the value of attribute lsi


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

def lsi
  @lsi
end

#pagesObject

Returns the value of attribute pages


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

def pages
  @pages
end

Returns the value of attribute permalink_style


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

def permalink_style
  @permalink_style
end

#plugin_managerObject

Returns the value of attribute plugin_manager


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

def plugin_manager
  @plugin_manager
end

#pluginsObject

Returns the value of attribute plugins


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

def plugins
  @plugins
end

#profilerObject (readonly)

Returns the value of attribute profiler


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

def profiler
  @profiler
end

#readerObject

Returns the value of attribute reader


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

def reader
  @reader
end

#regeneratorObject (readonly)

Returns the value of attribute regenerator


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

def regenerator
  @regenerator
end

#safeObject

Returns the value of attribute safe


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

def safe
  @safe
end

#show_draftsObject

Returns the value of attribute show_drafts


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

def show_drafts
  @show_drafts
end

#sourceObject (readonly)

Returns the value of attribute source


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

def source
  @source
end

#static_filesObject

Returns the value of attribute static_files


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

def static_files
  @static_files
end

#themeObject

Returns the value of attribute theme


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

def theme
  @theme
end

#timeObject

Returns the value of attribute time


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

def time
  @time
end

#unpublishedObject

Returns the value of attribute unpublished


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

def unpublished
  @unpublished
end

Instance Method Details

#categoriesObject


266
267
268
# File 'lib/jekyll/site.rb', line 266

def categories
  post_attr_hash("categories")
end

#cleanupObject

Remove orphaned files and empty directories in destination.

Returns nothing.


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

def cleanup
  site_cleaner.cleanup!
end

#collection_namesObject

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.

163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/jekyll/site.rb', line 163

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

#collectionsObject

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.


153
154
155
156
157
# File 'lib/jekyll/site.rb', line 153

def collections
  @collections ||= collection_names.each_with_object({}) do |name, hsh|
    hsh[name] = Jekyll::Collection.new(self, name)
  end
end

#collections_pathObject

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


433
434
435
436
# File 'lib/jekyll/site.rb', line 433

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

#docs_to_writeObject

Get the to be written documents

Returns an Array of Documents which should be written


335
336
337
# File 'lib/jekyll/site.rb', line 335

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

#documentsObject

Get all the documents

Returns an Array of all Documents


342
343
344
345
346
# File 'lib/jekyll/site.rb', line 342

def documents
  collections.each_with_object(Set.new) do |(_, collection), set|
    set.merge(collection.docs).merge(collection.files)
  end.to_a
end

#each_site_fileObject


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

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_destObject

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


138
139
140
141
142
143
144
145
146
# File 'lib/jekyll/site.rb', line 138

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.


299
300
301
302
303
304
305
# File 'lib/jekyll/site.rb', line 299

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_defaultsObject

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

Returns The FrontmatterDefaults


360
361
362
# File 'lib/jekyll/site.rb', line 360

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

#generateObject

Run each of the Generators.

Returns nothing.


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

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_cache_dir(*paths) ⇒ Object

Public: Prefix a given path with the cache directory.

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

cache directory

Returns a path which is prefixed with the cache directory.


423
424
425
426
427
# File 'lib/jekyll/site.rb', line 423

def in_cache_dir(*paths)
  paths.reduce(cache_dir) do |base, path|
    Jekyll.sanitized_path(base, path)
  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.


411
412
413
414
415
# File 'lib/jekyll/site.rb', line 411

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.


385
386
387
388
389
# File 'lib/jekyll/site.rb', line 385

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.


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

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)

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

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.


312
313
314
315
316
# File 'lib/jekyll/site.rb', line 312

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.

249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/jekyll/site.rb', line 249

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

#postsObject


232
233
234
# File 'lib/jekyll/site.rb', line 232

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

85
86
87
# File 'lib/jekyll/site.rb', line 85

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

#processObject

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

Returns nothing.


74
75
76
77
78
79
80
81
82
83
# File 'lib/jekyll/site.rb', line 74

def process
  return profiler.profile_process if config["profile"]

  reset
  read
  generate
  render
  cleanup
  write
end

#publisherObject

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

Returns The Publisher


375
376
377
# File 'lib/jekyll/site.rb', line 375

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

#readObject

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

Returns nothing.


179
180
181
182
183
# File 'lib/jekyll/site.rb', line 179

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

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

Returns


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

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

#renderObject

Render the site to the destination.

Returns nothing.


200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/jekyll/site.rb', line 200

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

#resetObject

rubocop:disable Metrics/AbcSize rubocop:disable Metrics/MethodLength

Reset Site details.

Returns nothing

Raises:

  • (ArgumentError)

95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/jekyll/site.rb', line 95

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.inclusions = {}
  self.pages = []
  self.static_files = []
  self.data = {}
  @post_attr_hash = {}
  @site_data = nil
  @collections = nil
  @documents = nil
  @docs_to_write = nil
  @regenerator.clear_cache
  @liquid_renderer.reset
  @site_cleaner = nil
  frontmatter_defaults.reset

  raise ArgumentError, "limit_posts must be a non-negative number" if limit_posts.negative?

  Jekyll::Cache.clear_if_config_changed config
  Jekyll::Hooks.trigger :site, :after_reset, self
end

#setupObject

Load necessary libraries, plugins, converters, and generators.

Returns nothing.


127
128
129
130
131
132
133
134
# File 'lib/jekyll/site.rb', line 127

def setup
  ensure_not_in_dest

  plugin_manager.conscientious_require

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

#site_dataObject

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.


274
275
276
# File 'lib/jekyll/site.rb', line 274

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

#site_payloadObject 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.

291
292
293
# File 'lib/jekyll/site.rb', line 291

def site_payload
  Drops::UnifiedPayloadDrop.new self
end

#tagsObject


262
263
264
# File 'lib/jekyll/site.rb', line 262

def tags
  post_attr_hash("tags")
end

#writeObject

Write static files, pages, and posts.

Returns nothing.


223
224
225
226
227
228
229
230
# File 'lib/jekyll/site.rb', line 223

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