Class: Nanoc::Compiler
- Inherits:
-
Object
- Object
- Nanoc::Compiler
- Extended by:
- Memoization
- Defined in:
- lib/nanoc/base/compilation/compiler.rb
Overview
Responsible for compiling a site’s item representations.
The compilation process makes use of notifications (see NotificationCenter) to track dependencies between items, layouts, etc. The following notifications are used:
-
compilation_started
— indicates that the compiler has started compiling this item representation. Has one argument: the item representation itself. Only one item can be compiled at a given moment; therefore, it is not possible to get two consecutivecompilation_started
notifications without also getting acompilation_ended
notification in between them. -
compilation_ended
— indicates that the compiler has finished compiling this item representation (either successfully or with failure). Has one argument: the item representation itself. -
visit_started
— indicates that the compiler requires content or attributes from the item representation that will be visited. Has one argument: the visited item identifier. This notification is used to track dependencies of items on other items; avisit_started
event followed by anothervisit_started
event indicates that the item corresponding to the former event will depend on the item from the latter event. -
visit_ended
— indicates that the compiler has finished visiting the item representation and that the requested attributes or content have been fetched (either successfully or with failure) -
processing_started
— indicates that the compiler has started processing the specified object, which can be an item representation (when it is compiled) or a layout (when it is used to lay out an item representation or when it is used as a partial) -
processing_ended
— indicates that the compiler has finished processing the specified object.
Accessors (collapse)
-
- (Nanoc::Site) site
readonly
The site this compiler belongs to.
-
- (Array) stack
readonly
The compilation stack.
Public instance methods (collapse)
-
- (Compiler) initialize(site)
constructor
Creates a new compiler fo the given site.
-
- (void) run
Compiles the site and writes out the compiled item representations.
Private instance methods (collapse)
-
- (Hash) assigns_for(rep)
private
The assigns that should be used in the next filter/layout operation.
-
- (Object) build_reps
private
Creates the representations of all items as defined by the compilation rules.
-
- (Nanoc::DependencyTracker) dependency_tracker
private
Returns the dependency tracker for this site, creating it first if it does not yet exist.
-
- (void) load
private
Load the helper data that is used for compiling the site.
-
- (Object) objects
private
Returns all objects managed by the site (items, layouts, code snippets, site configuration and the rules).
-
- (Nanoc::OutdatednessChecker) outdatedness_checker
The outdatedness checker.
-
- (Object) preprocess
private
Runs the preprocessors.
-
- (Object) route_reps
private
Determines the paths of all item representations.
-
- (Nanoc::RulesCollection) rules_collection
The collection of rules to be used for compiling this site.
-
- (void) store
private
Store the modified helper data used for compiling the site.
-
- (void) unload
private
Undoes the effects of #load.
Methods included from Memoization
Constructor Details
- (Compiler) initialize(site)
Creates a new compiler fo the given site
60 61 62 63 64 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 60 def initialize(site) @site = site @stack = [] end |
Instance Attribute Details
- (Nanoc::Site) site (readonly)
Returns The site this compiler belongs to
46 47 48 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 46 def site @site end |
- (Array) stack (readonly)
The compilation stack. When the compiler begins compiling a rep or a layout, it will be placed on the stack; when it is done compiling the rep or layout, it will be removed from the stack.
53 54 55 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 53 def stack @stack end |
Instance Method Details
- (Hash) assigns_for(rep)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns The assigns that should be used in the next filter/layout operation
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 269 def assigns_for(rep) if rep.binary? content_or_filename_assigns = { filename: rep.temporary_filenames[:last] } else content_or_filename_assigns = { content: rep.content[:last] } end content_or_filename_assigns.merge({ item: rep.item, rep: rep, item_rep: rep, items: site.items, layouts: site.layouts, config: site.config, site: site }) end |
- (Object) build_reps
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Creates the representations of all items as defined by the compilation rules.
214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 214 def build_reps items.each do |item| # Find matching rules matching_rules = rules_collection.item_compilation_rules_for(item) raise Nanoc::Errors::NoMatchingCompilationRuleFound.new(item) if matching_rules.empty? # Create reps rep_names = matching_rules.map(&:rep_name).uniq rep_names.each do |rep_name| item.reps << ItemRep.new(item, rep_name) end end end |
- (Nanoc::DependencyTracker) dependency_tracker
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns the dependency tracker for this site, creating it first if it does not yet exist.
185 186 187 188 189 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 185 def dependency_tracker dt = Nanoc::DependencyTracker.new(@site.items + @site.layouts) dt.compiler = self dt end |
- (void) load
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Load the helper data that is used for compiling the site.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 111 def load return if @loaded || @loading @loading = true # Load site if necessary site.load # Preprocess rules_collection.load preprocess site.setup_child_parent_links build_reps route_reps # Load auxiliary stores stores.each(&:load) @loaded = true rescue => e unload raise e ensure @loading = false end |
- (Object) objects
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns all objects managed by the site (items, layouts, code snippets, site configuration and the rules).
205 206 207 208 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 205 def objects site.items + site.layouts + site.code_snippets + [site.config, rules_collection] end |
- (Nanoc::OutdatednessChecker) outdatedness_checker
Returns The outdatedness checker
288 289 290 291 292 293 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 288 def outdatedness_checker Nanoc::OutdatednessChecker.new( site: @site, checksum_store: checksum_store, dependency_tracker: dependency_tracker) end |
- (Object) preprocess
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Runs the preprocessors.
195 196 197 198 199 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 195 def preprocess rules_collection.preprocessors.each_value do |preprocessor| preprocessor_context.instance_eval(&preprocessor) end end |
- (Object) route_reps
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Determines the paths of all item representations.
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 260 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 231 def route_reps reps.each do |rep| # Find matching rules rules = rules_collection.routing_rules_for(rep) raise Nanoc::Errors::NoMatchingRoutingRuleFound.new(rep) if rules[:last].nil? rules.each_pair do |snapshot, rule| # Get basic path by applying matching rule basic_path = rule.apply_to(rep, compiler: self) next if basic_path.nil? if basic_path !~ %r{^/} raise "The path returned for the #{rep.inspect} item representation, “#{basic_path}”, does not start with a slash. Please ensure that all routing rules return a path that starts with a slash." end # Get raw path by prepending output directory rep.raw_paths[snapshot] = @site.config[:output_dir] + basic_path # Get normal path by stripping index filename rep.paths[snapshot] = basic_path @site.config[:index_filenames].each do |index_filename| rep_path_ending = rep.paths[snapshot][-index_filename.length..-1] next unless rep_path_ending == index_filename # Strip and stop rep.paths[snapshot] = rep.paths[snapshot][0..-index_filename.length - 1] break end end end end |
- (Nanoc::RulesCollection) rules_collection
Returns The collection of rules to be used for compiling this site
101 102 103 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 101 def rules_collection Nanoc::RulesCollection.new(self) end |
- (void) run
Compiles the site and writes out the compiled item representations.
Previous versions of nanoc (< 3.2) allowed passing items to compile, and had a “force” option to make the compiler recompile all pages, even when not outdated. These arguments and options are, as of nanoc 3.2, no longer used, and will simply be ignored when passed to #run.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 75 def run(*_args) # Create output directory if necessary FileUtils.mkdir_p(@site.config[:output_dir]) # Compile reps load @site.freeze # Determine which reps need to be recompiled forget_dependencies_if_outdated(items) dependency_tracker.start compile_reps(reps) dependency_tracker.stop store ensure Nanoc::TempFilenameFactory.instance.cleanup( Nanoc::Filter::TMP_BINARY_ITEMS_DIR) Nanoc::TempFilenameFactory.instance.cleanup( Nanoc::ItemRep::TMP_TEXT_ITEMS_DIR) end |
- (void) store
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Store the modified helper data used for compiling the site.
164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 164 def store # Calculate rule memory (reps + layouts).each do |obj| rule_memory_store[obj] = rule_memory_calculator[obj] end # Calculate checksums objects.each do |obj| checksum_store[obj] = obj.checksum end # Store stores.each(&:store) end |
- (void) unload
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/nanoc/base/compilation/compiler.rb', line 141 def unload return if @unloading @unloading = true stores.each(&:unload) @stack = [] items.each { |item| item.reps.clear } site.teardown_child_parent_links rules_collection.unload site.unload @loaded = false @unloading = false end |