class Jekyll::Regenerator
Attributes
Public Class Methods
# File lib/jekyll/regenerator.rb, line 9 def initialize(site) @site = site # Read metadata from file read_metadata # Initialize cache to an empty hash clear_cache end
Public Instance Methods
Add a path to the metadata
Returns true, also on failure.
# File lib/jekyll/regenerator.rb, line 40 def add(path) return true unless File.exist?(path) metadata[path] = { "mtime" => File.mtime(path), "deps" => [], } cache[path] = true end
Add a dependency of a path
Returns nothing.
# File lib/jekyll/regenerator.rb, line 106 def add_dependency(path, dependency) return if metadata[path].nil? || disabled unless metadata[path]["deps"].include? dependency metadata[path]["deps"] << dependency add(dependency) unless metadata.include?(dependency) end regenerate? dependency end
Clear the metadata and cache
Returns nothing
# File lib/jekyll/regenerator.rb, line 60 def clear @metadata = {} clear_cache end
Clear just the cache
Returns nothing
# File lib/jekyll/regenerator.rb, line 68 def clear_cache @cache = {} end
Check if metadata has been disabled
Returns a Boolean (true for disabled, false for enabled).
# File lib/jekyll/regenerator.rb, line 136 def disabled? self.disabled = !site.incremental? if disabled.nil? disabled end
Force a path to regenerate
Returns true.
# File lib/jekyll/regenerator.rb, line 53 def force(path) cache[path] = true end
Produce the absolute path of the metadata file
Returns the String path of the file.
# File lib/jekyll/regenerator.rb, line 129 def metadata_file @metadata_file ||= site.in_source_dir(".jekyll-metadata") end
Checks if a path’s (or one of its dependencies) mtime has changed
Returns a boolean.
# File lib/jekyll/regenerator.rb, line 84 def modified?(path) return true if disabled? # objects that don't have a path are always regenerated return true if path.nil? # Check for path in cache return cache[path] if cache.key? path if metadata[path] # If we have seen this file before, # check if it or one of its dependencies has been modified existing_file_modified?(path) else # If we have not seen this file before, add it to the metadata and regenerate it add(path) end end
Checks if a renderable object needs to be regenerated
Returns a boolean.
# File lib/jekyll/regenerator.rb, line 22 def regenerate?(document) return true if disabled case document when Page regenerate_page?(document) when Document regenerate_document?(document) else source_path = document.respond_to?(:path) ? document.path : nil dest_path = document.destination(@site.dest) if document.respond_to?(:destination) source_modified_or_dest_missing?(source_path, dest_path) end end
Checks if the source has been modified or the destination is missing
returns a boolean
# File lib/jekyll/regenerator.rb, line 76 def source_modified_or_dest_missing?(source_path, dest_path) modified?(source_path) || (dest_path && !File.exist?(dest_path)) end
Write the metadata to disk
Returns nothing.
# File lib/jekyll/regenerator.rb, line 119 def write_metadata unless disabled? Jekyll.logger.debug "Writing Metadata:", ".jekyll-metadata" File.binwrite(metadata_file, Marshal.dump(metadata)) end end
Private Instance Methods
# File lib/jekyll/regenerator.rb, line 179 def existing_file_modified?(path) # If one of this file dependencies have been modified, # set the regeneration bit for both the dependency and the file to true metadata[path]["deps"].each do |dependency| return cache[dependency] = cache[path] = true if modified?(dependency) end if File.exist?(path) && metadata[path]["mtime"].eql?(File.mtime(path)) # If this file has not been modified, set the regeneration bit to false cache[path] = false else # If it has been modified, set it to true add(path) end end
Read metadata from the metadata file, if no file is found, initialize with an empty hash
Returns the read metadata.
# File lib/jekyll/regenerator.rb, line 147 def read_metadata @metadata = if !disabled? && File.file?(metadata_file) content = File.binread(metadata_file) begin Marshal.load(content) rescue TypeError SafeYAML.load(content) rescue ArgumentError => e Jekyll.logger.warn("Failed to load #{metadata_file}: #{e}") {} end else {} end end
# File lib/jekyll/regenerator.rb, line 172 def regenerate_document?(document) !document.write? || document.data["regenerate"] || source_modified_or_dest_missing?( document.path, document.destination(@site.dest) ) end
# File lib/jekyll/regenerator.rb, line 165 def regenerate_page?(document) document.asset_file? || document.data["regenerate"] || source_modified_or_dest_missing?( site.in_source_dir(document.relative_path), document.destination(@site.dest) ) end