Class: Bridgetown::FrontMatter::Loaders::Base

Inherits:

Object

• Object
• Bridgetown::FrontMatter::Loaders::Base

Defined in:

bridgetown-core/lib/bridgetown-core/front_matter/loaders/base.rb

Overview

An abstract base class for processing front matter

Direct Known Subclasses

Ruby, YAML

Instance Method Summary

• #initialize(origin_or_layout) ⇒ Base constructor

  A new instance of Base.

• #read(file_contents, file_path:) ⇒ Result^?

  Reads the contents of a file, returning a possible Result.

Constructor Details

#initialize(origin_or_layout) ⇒ Base

Returns a new instance of Base.

Parameters:

• origin_or_layout (Bridgetown::Model::RepoOrigin, Bridgetown::Layout)

# File 'bridgetown-core/lib/bridgetown-core/front_matter/loaders/base.rb', line 9

def initialize(origin_or_layout)
  @origin_or_layout = origin_or_layout
end

Instance Method Details

#read(file_contents, file_path:) ⇒ Result^?

Reads the contents of a file, returning a possible Result

Parameters:

• file_contents (String) —

  the contents of the file being processed

• file_path (String) —

  the path to the file being processed

Returns:

• (Result, nil)

# File 'bridgetown-core/lib/bridgetown-core/front_matter/loaders/base.rb', line 18

def read(file_contents, file_path:) # rubocop:disable Lint/UnusedMethodArgument
  raise "Implement #read in a subclass of Bridgetown::FrontMatter::Loaders::Base"
end