Module: Middleman::CoreExtensions::Rendering::InstanceMethods
- Defined in:
- lib/middleman-core/core_extensions/rendering.rb
Overview
Rendering instance methods
Instance Method Summary collapse
-
#current_engine ⇒ Symbol?
The currently rendering engine.
-
#current_engine=(v) ⇒ Symbol?
The currently rendering engine rubocop:disable TrivialAccessors.
-
#fetch_layout(engine, opts) ⇒ String
Find a layout for a given engine.
-
#locate_layout(name, preferred_engine = nil) ⇒ String
Find a layout on-disk, optionally using a specific engine.
-
#locate_partial(partial_name, try_static = true) ⇒ String
Partial locator.
-
#options_for_ext(ext) ⇒ Hash
Get a hash of configuration options for a given file extension, from config.rb.
-
#render(_, data, options = {}, &block) ⇒ String
Sinatra/Padrino compatible render method signature referenced by some view helpers.
-
#render_individual_file(path, locs = {}, opts = {}, context = self, &block) ⇒ String
Render an on-disk file.
-
#render_template(path, locs = {}, opts = {}, blocks = []) ⇒ String
Render a template, with layout, given a path.
-
#resolve_template(request_path, options = {}) ⇒ Array<String, Symbol>, Boolean
Find a template on disk given a output path.
-
#template_data_for_file(path) ⇒ String
Get the template data from a path.
-
#template_extensions(extension_map = nil) ⇒ Hash
Add or overwrite a default template extension.
-
#wrap_layout(layout_name, &block)
Allow layouts to be wrapped in the contents of other layouts.
Instance Method Details
#current_engine ⇒ Symbol?
The currently rendering engine
428 429 430 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 428 def current_engine @_current_engine ||= nil end |
#current_engine=(v) ⇒ Symbol?
The currently rendering engine rubocop:disable TrivialAccessors
435 436 437 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 435 def current_engine=(v) @_current_engine = v end |
#fetch_layout(engine, opts) ⇒ String
Find a layout for a given engine
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 343 def fetch_layout(engine, opts) # The layout name comes from either the system default or the options local_layout = opts.key?(:layout) ? opts[:layout] : config[:layout] return false unless local_layout # Look for engine-specific options = respond_to?(engine) ? send(engine) : {} # The engine for the layout can be set in options, engine_options or passed # into this method layout_engine = if opts.key?(:layout_engine) opts[:layout_engine] elsif .key?(:layout_engine) [:layout_engine] else engine end # Automatic mode if local_layout == :_auto_layout # Look for :layout of any extension # If found, use it. If not, continue locate_layout(:layout, layout_engine) || false else # Look for specific layout # If found, use it. If not, error. if layout_path = locate_layout(local_layout, layout_engine) layout_path else raise ::Middleman::CoreExtensions::Rendering::TemplateNotFound, "Could not locate layout: #{local_layout}" end end end |
#locate_layout(name, preferred_engine = nil) ⇒ String
Find a layout on-disk, optionally using a specific engine
381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 381 def locate_layout(name, preferred_engine=nil) resolve_opts = {} resolve_opts[:preferred_engine] = preferred_engine unless preferred_engine.nil? # Check layouts folder layout_path = resolve_template(File.join(config[:layouts_dir], name.to_s), resolve_opts) # If we didn't find it, check root layout_path = resolve_template(name, resolve_opts) unless layout_path # Return the path layout_path end |
#locate_partial(partial_name, try_static = true) ⇒ String
Partial locator.
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 211 def locate_partial(partial_name, try_static=true) resolve_opts = { try_without_underscore: true, try_static: try_static } # If the path is known to the sitemap if resource = sitemap.find_resource_by_path(current_path) current_dir = File.dirname(resource.source_file) resolve_opts[:preferred_engine] = File.extname(resource.source_file)[1..-1].to_sym # Look for partials relative to the current path relative_dir = File.join(current_dir.sub(%r{^#{Regexp.escape(source_dir)}/?}, ''), partial_name) resolve_template(relative_dir, resolve_opts) || resolve_template(partial_name, resolve_opts) else resolve_template(partial_name, resolve_opts) end end |
#options_for_ext(ext) ⇒ Hash
Get a hash of configuration options for a given file extension, from config.rb
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 320 def (ext) # Read options for extension from config/Tilt or cache cache.fetch(:options_for_ext, ext) do = {} # Find all the engines which handle this extension in tilt. Look for # config variables of that name and merge it extension_class = ::Tilt[ext] ::Tilt.mappings.each do |mapping_ext, engines| next unless engines.include? extension_class = config[mapping_ext.to_sym] || {} .merge!() end end end |
#render(_, data, options = {}, &block) ⇒ String
Sinatra/Padrino compatible render method signature referenced by some view helpers. Especially partials.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 185 def render(_, data, ={}, &block) partial_name = data.to_s found_partial = locate_partial(partial_name, false) || locate_partial(partial_name, true) # Look in the partials_dir for the partial with the current engine unless found_partial partials_path = File.join(config[:partials_dir], partial_name) found_partial = locate_partial(partials_path, false) || locate_partial(partials_path, true) end raise ::Middleman::CoreExtensions::Rendering::TemplateNotFound, "Could not locate partial: #{data}" unless found_partial locals = [:locals] if ::Tilt[found_partial] # Render the partial if found, otherwide throw exception render_individual_file(found_partial, locals, , self, &block) else File.read(found_partial) end end |
#render_individual_file(path, locs = {}, opts = {}, context = self, &block) ⇒ String
Render an on-disk file. Used for everything, including layouts.
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 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 235 def render_individual_file(path, locs={}, opts={}, context=self, &block) path = path.to_s # Mutability is FUN! # Try to work around: https://github.com/middleman/middleman/issues/501 locs = locs.dup # Detect the remdering engine from the extension extension = File.extname(path) engine = extension[1..-1].to_sym # Store last engine for later (could be inside nested renders) context.current_engine, engine_was = engine, context.current_engine # Save current buffer for later @_out_buf, _buf_was = '', @_out_buf # Read from disk or cache the contents of the file body = if opts[:template_body] opts.delete(:template_body) else template_data_for_file(path) end # Merge per-extension options from config extension = File.extname(path) = opts.dup.merge((extension)) [:outvar] ||= '@_out_buf' .delete(:layout) # Overwrite with frontmatter options = .deep_merge([:renderer_options]) if [:renderer_options] template_class = ::Tilt[path] # Allow hooks to manipulate the template before render self.class.callbacks_for_hook(:before_render).each do |callback| # Uber::Options::Value doesn't respond to call newbody = if callback.respond_to?(:call) callback.call(body, path, locs, template_class) elsif callback.respond_to?(:evaluate) callback.evaluate(self, body, path, locs, template_class) end body = newbody if newbody # Allow the callback to return nil to skip it end # Read compiled template from disk or cache template = cache.fetch(:compiled_template, extension, , body) do ::Tilt.new(path, 1, ) { body } end # Render using Tilt content = template.render(context, locs, &block) # Allow hooks to manipulate the result after render self.class.callbacks_for_hook(:after_render).each do |callback| # Uber::Options::Value doesn't respond to call newcontent = if callback.respond_to?(:call) content = callback.call(content, path, locs, template_class) elsif callback.respond_to?(:evaluate) content = callback.evaluate(self, content, path, locs, template_class) end content = newcontent if newcontent # Allow the callback to return nil to skip it end output = ::ActiveSupport::SafeBuffer.new '' output.safe_concat content output ensure # Reset stored buffer @_out_buf = _buf_was context.current_engine = engine_was end |
#render_template(path, locs = {}, opts = {}, blocks = []) ⇒ String
Render a template, with layout, given a path
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 129 def render_template(path, locs={}, opts={}, blocks=[]) extension = File.extname(path) engine = extension[1..-1].to_sym if defined?(::I18n) old_locale = ::I18n.locale ::I18n.locale = opts[:lang] if opts[:lang] end # Use a dup of self as a context so that instance variables set within # the template don't persist for other templates. context = dup blocks.each do |block| context.instance_eval(&block) end # Store current locs/opts for later @current_locs = locs @current_opts = opts # Keep rendering template until we've used up all extensions. This # handles cases like `style.css.sass.erb` content = nil while ::Tilt[path] begin opts[:template_body] = content if content content = render_individual_file(path, locs, opts, context) path = File.basename(path, File.extname(path)) rescue LocalJumpError raise "Tried to render a layout (calls yield) at #{path} like it was a template. Non-default layouts need to be in #{source}/#{config[:layouts_dir]}." end end # If we need a layout and have a layout, use it if layout_path = fetch_layout(engine, opts) content = render_individual_file(layout_path, locs, opts, context) { content } end # Return result content ensure # Pop all the saved variables from earlier as we may be returning to a # previous render (layouts, partials, nested layouts). ::I18n.locale = old_locale if defined?(::I18n) @content_blocks = nil @current_locs = nil @current_opts = nil end |
#resolve_template(request_path, options = {}) ⇒ Array<String, Symbol>, Boolean
Find a template on disk given a output path
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 445 def resolve_template(request_path, ={}) # Find the path by searching or using the cache request_path = request_path.to_s cache.fetch(:resolve_template, request_path, ) do relative_path = Util.strip_leading_slash(request_path) on_disk_path = File.(relative_path, source_dir) preferred_engines = if [:try_static] [nil] else possible_engines = ['*'] # By default, any engine will do # If we're specifically looking for a preferred engine if .key?(:preferred_engine) extension_class = ::Tilt[[:preferred_engine]] # Get a list of extensions for a preferred engine matched_exts = ::Tilt.mappings.select do |_, engines| engines.include? extension_class end.keys # Prefer to look for the matched extensions unless matched_exts.empty? possible_engines.unshift('{' + matched_exts.join(',') + '}') end end possible_engines end search_paths = preferred_engines.flat_map do |preferred_engine| path_with_ext = on_disk_path.dup path_with_ext << ('.' + preferred_engine) unless preferred_engine.nil? paths = [path_with_ext] if [:try_without_underscore] paths << path_with_ext.sub(relative_path, relative_path.sub(/^_/, '').sub(/\/_/, '/')) end paths end found_path = nil search_paths.each do |path_with_ext| found_path = Dir[path_with_ext].find do |path| ::Tilt[path] end unless found_path found_path = path_with_ext if File.exist?(path_with_ext) end break if found_path end # If we found one, return it if found_path found_path elsif File.exist?(on_disk_path) on_disk_path else false end end end |
#template_data_for_file(path) ⇒ String
Get the template data from a path
311 312 313 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 311 def template_data_for_file(path) File.read(File.(path, source_dir)) end |
#template_extensions(extension_map = nil) ⇒ Hash
Add or overwrite a default template extension
117 118 119 120 121 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 117 def template_extensions(extension_map=nil) @_template_extensions ||= {} @_template_extensions.merge!(extension_map) if extension_map @_template_extensions end |
#wrap_layout(layout_name, &block)
This method returns an undefined value.
Allow layouts to be wrapped in the contents of other layouts
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 |
# File 'lib/middleman-core/core_extensions/rendering.rb', line 398 def wrap_layout(layout_name, &block) # Save current buffer for later @_out_buf, _buf_was = '', @_out_buf layout_path = locate_layout(layout_name, current_engine) extension = File.extname(layout_path) engine = extension[1..-1].to_sym # Store last engine for later (could be inside nested renders) self.current_engine, engine_was = engine, current_engine begin content = if block_given? capture_html(&block) else '' end ensure # Reset stored buffer @_out_buf = _buf_was end concat_safe_content render_individual_file(layout_path, @current_locs || {}, @current_opts || {}, self) { content } ensure self.current_engine = engine_was end |