Class: Nanoc::Int::Executor
- Inherits:
-
Object
- Object
- Nanoc::Int::Executor
- Defined in:
- lib/nanoc/base/services/executor.rb
Defined Under Namespace
Classes: OutputNotWrittenError
Instance Method Summary collapse
-
#assigns_for(rep) ⇒ Object
-
#filter(rep, filter_name, filter_args = {}) ⇒ Object
-
#find_layout(arg) ⇒ Object
-
#initialize(compiler) ⇒ Executor
constructor
A new instance of Executor.
-
#layout(rep, layout_identifier, extra_filter_args = nil) ⇒ Object
-
#layouts ⇒ Object
-
#snapshot(rep, snapshot_name, final: true, path: nil) ⇒ Object
rubocop:disable Lint/UnusedMethodArgument.
-
#use_globs? ⇒ Boolean
Constructor Details
#initialize(compiler) ⇒ Executor
Returns a new instance of Executor
10 11 12 |
# File 'lib/nanoc/base/services/executor.rb', line 10 def initialize(compiler) @compiler = compiler end |
Instance Method Details
#assigns_for(rep) ⇒ Object
122 123 124 |
# File 'lib/nanoc/base/services/executor.rb', line 122 def assigns_for(rep) @compiler.assigns_for(rep) end |
#filter(rep, filter_name, filter_args = {}) ⇒ Object
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/nanoc/base/services/executor.rb', line 14 def filter(rep, filter_name, filter_args = {}) # Get filter class klass = Nanoc::Filter.named(filter_name) raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil? # Check whether filter can be applied if klass.from_binary? && !rep.binary? raise Nanoc::Int::Errors::CannotUseBinaryFilter.new(rep, klass) elsif !klass.from_binary? && rep.binary? raise Nanoc::Int::Errors::CannotUseTextualFilter.new(rep, klass) end begin # Notify start Nanoc::Int::NotificationCenter.post(:filtering_started, rep, filter_name) # Create filter filter = klass.new(assigns_for(rep)) # Run filter last = rep.snapshot_contents[:last] source = rep.binary? ? last.filename : last.string result = filter.setup_and_run(source, filter_args) rep.snapshot_contents[:last] = if klass.to_binary? Nanoc::Int::BinaryContent.new(filter.output_filename).tap(&:freeze) else Nanoc::Int::TextualContent.new(result).tap(&:freeze) end # Check whether file was written if klass.to_binary? && !File.file?(filter.output_filename) raise OutputNotWrittenError.new(filter_name, filter.output_filename) end # Create snapshot snapshot(rep, rep.snapshot_contents[:post] ? :post : :pre, final: false) unless rep.binary? ensure # Notify end Nanoc::Int::NotificationCenter.post(:filtering_ended, rep, filter_name) end end |
#find_layout(arg) ⇒ Object
130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/nanoc/base/services/executor.rb', line 130 def find_layout(arg) req_id = arg.__nanoc_cleaned_identifier layout = layouts.find { |l| l.identifier == req_id } return layout if layout if use_globs? pat = Nanoc::Int::Pattern.from(arg) layout = layouts.find { |l| pat.match?(l.identifier) } return layout if layout end raise Nanoc::Int::Errors::UnknownLayout.new(arg) end |
#layout(rep, layout_identifier, extra_filter_args = nil) ⇒ Object
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/nanoc/base/services/executor.rb', line 57 def layout(rep, layout_identifier, extra_filter_args = nil) layout = find_layout(layout_identifier) filter_name, filter_args = *@compiler.filter_name_and_args_for_layout(layout) if filter_name.nil? raise Nanoc::Int::Errors::Generic, "Cannot find rule for layout matching #{layout_identifier}" end filter_args = filter_args.merge(extra_filter_args || {}) # Check whether item can be laid out raise Nanoc::Int::Errors::CannotLayoutBinaryItem.new(rep) if rep.binary? # Create "pre" snapshot if rep.snapshot_contents[:post].nil? snapshot(rep, :pre, final: true) end # Create filter klass = Nanoc::Filter.named(filter_name) raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil? layout_view = Nanoc::LayoutView.new(layout, nil) filter = klass.new(assigns_for(rep).merge({ layout: layout_view })) # Visit Nanoc::Int::NotificationCenter.post(:visit_started, layout) Nanoc::Int::NotificationCenter.post(:visit_ended, layout) begin # Notify start Nanoc::Int::NotificationCenter.post(:processing_started, layout) Nanoc::Int::NotificationCenter.post(:filtering_started, rep, filter_name) # Layout content = layout.content arg = content.binary? ? content.filename : content.string res = filter.setup_and_run(arg, filter_args) rep.snapshot_contents[:last] = Nanoc::Int::TextualContent.new(res).tap(&:freeze) # Create "post" snapshot snapshot(rep, :post, final: false) ensure # Notify end Nanoc::Int::NotificationCenter.post(:filtering_ended, rep, filter_name) Nanoc::Int::NotificationCenter.post(:processing_ended, layout) end end |
#layouts ⇒ Object
126 127 128 |
# File 'lib/nanoc/base/services/executor.rb', line 126 def layouts @compiler.site.layouts end |
#snapshot(rep, snapshot_name, final: true, path: nil) ⇒ Object
rubocop:disable Lint/UnusedMethodArgument
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/nanoc/base/services/executor.rb', line 103 def snapshot(rep, snapshot_name, final: true, path: nil) # rubocop:disable Lint/UnusedMethodArgument # NOTE: :path is irrelevant unless rep.binary? rep.snapshot_contents[snapshot_name] = rep.snapshot_contents[:last] end if snapshot_name == :pre && final rep.snapshot_defs << Nanoc::Int::SnapshotDef.new(:pre, true) end if final raw_path = rep.raw_path(snapshot: snapshot_name) if raw_path ItemRepWriter.new.write(rep, raw_path) end end end |
#use_globs? ⇒ Boolean
144 145 146 |
# File 'lib/nanoc/base/services/executor.rb', line 144 def use_globs? @compiler.site.config[:string_pattern_type] == 'glob' end |