Module: Middleman::CoreExtensions::Rendering::InstanceMethods

Defined in:
lib/middleman-core/core_extensions/rendering.rb

Overview

Rendering instance methods

Instance Method Summary collapse

Instance Method Details

#current_engine ⇒ Symbol?

The currently rendering engine

Returns:



445
446
447
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 445

def current_engine
  @_current_engine ||= nil
end

#current_engine=(v) ⇒ Symbol?

The currently rendering engine rubocop:disable TrivialAccessors

Returns:



452
453
454
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 452

def current_engine=(v)
  @_current_engine = v
end

#fetch_layout(engine, opts) ⇒ String

Find a layout for a given engine

Parameters:

Returns:

  • (String) 


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 360

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
  engine_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 engine_options.key?(:layout_engine)
    engine_options[: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

Parameters:

  • name (String)
  • preferred_engine (Symbol) (defaults to: nil)

Returns:

  • (String) 


398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 398

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.

Parameters:

  • partial_name (String)

Returns:

  • (String) 


228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 228

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

Parameters:

  • ext (String)

Returns:

  • (Hash) 


337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 337

def options_for_ext(ext)
  # Read options for extension from config/Tilt or cache
  cache.fetch(:options_for_ext, ext) do
    options = {}

    # 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
      engine_options = config[mapping_ext.to_sym] || {}
      options.merge!(engine_options)
    end

    options
  end
end

#render(_, data, options = {}, &block) ⇒ String

Sinatra/Padrino compatible render method signature referenced by some view helpers. Especially partials.

Parameters:

  • engine (String, Symbol)
  • data (String, Symbol)
  • options (Hash) (defaults to: {})

Returns:

  • (String)

Raises:



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 202

def render(_, data, options={}, &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 = options[:locals]

  if ::Tilt[found_partial]
    # Render the partial if found, otherwide throw exception
    _render_with_all_renderers(found_partial, locals, self, options, &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.

Parameters:

  • path (String, Symbol)
  • locs (Hash) (defaults to: {})
  • opts (Hash) (defaults to: {})
  • context (Class) (defaults to: self)

Returns:

  • (String) 


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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 252

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)
  options = opts.dup.merge(options_for_ext(extension))
  options[:outvar] ||= '@_out_buf'
  options.delete(:layout)

  # Overwrite with frontmatter options
  options = options.deep_merge(options[:renderer_options]) if options[: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, options, body) do
    ::Tilt.new(path, 1, options) { 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

Parameters:

  • path (String)
  • locs (Hash) (defaults to: {})
  • opts (Hash) (defaults to: {})

Returns:

  • (String) 


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

  content = _render_with_all_renderers(path, locs, context, opts)

  # 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

Parameters:

  • request_path (String)
  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :preferred_engine (Boolean) —

    If set, try this engine first, then fall back to any engine.

  • :try_without_underscore (Boolean)
  • :try_static (Boolean)

Returns:

  • (Array<String, Symbol>, Boolean) 


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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 462

def resolve_template(request_path, options={})
  # Find the path by searching or using the cache
  request_path = request_path.to_s
  cache.fetch(:resolve_template, request_path, options) do
    relative_path = Util.strip_leading_slash(request_path)
    on_disk_path  = File.expand_path(relative_path, source_dir)

    preferred_engines = if options[:try_static]
      [nil]
    else
      possible_engines = ['*'] # By default, any engine will do

      # If we're specifically looking for a preferred engine
      if options.key?(:preferred_engine)
        extension_class = ::Tilt[options[: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 options[: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

Parameters:

  • path (String)

Returns:

  • (String) 


328
329
330
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 328

def template_data_for_file(path)
  File.read(File.expand_path(path, source_dir))
end

#template_extensions(extension_map = nil) ⇒ Hash

Add or overwrite a default template extension

Parameters:

  • extension_map (Hash) (defaults to: nil)

Returns:

  • (Hash) 


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

Parameters:

  • layout_name (String, Symbol) 


415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/middleman-core/core_extensions/rendering.rb', line 415

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