Module: Bridgetown::Transformable

Included in:

GeneratedPage, Resource::Transformer, Slot

Defined in:

bridgetown-core/lib/bridgetown-core/concerns/transformable.rb

Instance Method Summary

• #transform_content(document, alternate_content: nil) {|converter, index, output| ... } ⇒ Object

  Transforms an input document by running it through available converters (requires a converter method to be present on the including class).

• #transform_with_layout(layout, output, document) {|converter, layout_output| ... } ⇒ Object

  Transforms an input document by placing it within the specified layout.

Instance Method Details

#transform_content(document, alternate_content: nil) {|converter, index, output| ... } ⇒ Object

Transforms an input document by running it through available converters (requires a converter method to be present on the including class)

Parameters:

• document (Bridgetown::GeneratedPage, Bridgetown::Resource::Base)
• alternate_content (String, nil) (defaults to: nil) —

  Pass in content if you don’t want to use document’s

Yield Parameters:

• converter (Bridgetown::Converter)
• index (Integer) —

  index of the conversion step

• output (String)

Returns:

• String

# File 'bridgetown-core/lib/bridgetown-core/concerns/transformable.rb', line 14

def transform_content(document, alternate_content: nil)
  converters.each_with_index.inject(
    (alternate_content || document.content).to_s
  ) do |content, (converter, index)|
    output = converter.method(:convert).arity == 1 ?
               converter.convert(content) :
               converter.convert(content, document)

    yield converter, index, output if block_given?

    output.html_safe
  rescue StandardError => e
    Bridgetown.logger.error "Conversion error:",
                            "#{converter.class} encountered an error while " \
                            "converting `#{document.relative_path}'"
    raise e
  end
end

#transform_with_layout(layout, output, document) {|converter, layout_output| ... } ⇒ Object

Transforms an input document by placing it within the specified layout

Parameters:

• layout (Bridgetown::Layout)
• output (String) —

  the output from document content conversions

• document (Bridgetown::GeneratedPage, Bridgetown::Resource::Base)

Yield Parameters:

• converter (Bridgetown::Converter)
• layout_output (String)

Returns:

• String

# File 'bridgetown-core/lib/bridgetown-core/concerns/transformable.rb', line 41

def transform_with_layout(layout, output, document)
  layout_converters = site.matched_converters_for_convertible(layout)
  layout_input = layout.content.dup

  layout_converters.inject(layout_input) do |content, converter|
    next(content) unless [2, -2].include?(converter.method(:convert).arity) # rubocop:disable Performance/CollectionLiteralInLoop

    layout.current_document = document
    layout.current_document_output = output
    layout_output = converter.convert content, layout

    yield converter, layout_output if block_given?

    layout_output
  rescue StandardError => e
    Bridgetown.logger.error "Conversion error:",
                            "#{converter.class} encountered an error while " \
                            "converting `#{document.relative_path}'"
    raise e
  end
end