Class: Schmersion::Formatter

Inherits:

Object

• Object
• Schmersion::Formatter

Defined in:

lib/schmersion/formatter.rb

Direct Known Subclasses

Schmersion::Formatters::Markdown, Schmersion::Formatters::YAML

Instance Attribute Summary

• #filename ⇒ Object readonly

  Returns the value of attribute filename.

Instance Method Summary

• #generate(repo, version) ⇒ Object

  Generate the output which should be included in the export.

• #initialize(filename, options = {}) ⇒ Formatter constructor

  A new instance of Formatter.

• #insert(part) ⇒ void

  Insert a given part into the given source file path.

Constructor Details

#initialize(filename, options = {}) ⇒ Formatter

Returns a new instance of Formatter.

# File 'lib/schmersion/formatter.rb', line 8

def initialize(filename, options = {})
  @filename = filename
  @options = options
end

Instance Attribute Details

#filename ⇒ Object (readonly)

Returns the value of attribute filename.

# File 'lib/schmersion/formatter.rb', line 6

def filename
  @filename
end

Instance Method Details

#generate(repo, version) ⇒ Object

Generate the output which should be included in the export. This should return a string which will also be displayed when doing dry-runs of a release. rubocop:disable Lint/UnusedMethodArgument

# File 'lib/schmersion/formatter.rb', line 17

def generate(repo, version)
  ''
end

#insert(part) ⇒ void

This method returns an undefined value.

Insert a given part into the given source file path

Parameters:

• part (String)

# File 'lib/schmersion/formatter.rb', line 26

def insert(part)
end