Class: Brainstem::ApiDocs::Formatters::AbstractFormatter

Inherits:

Object

• Object
• Brainstem::ApiDocs::Formatters::AbstractFormatter

Includes:

Concerns::Optional

Defined in:

lib/brainstem/api_docs/formatters/abstract_formatter.rb

Direct Known Subclasses

Markdown::ControllerFormatter, Markdown::EndpointCollectionFormatter, Markdown::EndpointFormatter, Markdown::PresenterFormatter, OpenApiSpecification::Version2::ControllerFormatter, OpenApiSpecification::Version2::Endpoint::ParamDefinitionsFormatter, OpenApiSpecification::Version2::Endpoint::ResponseDefinitionsFormatter, OpenApiSpecification::Version2::EndpointCollectionFormatter, OpenApiSpecification::Version2::EndpointFormatter, OpenApiSpecification::Version2::InfoFormatter, OpenApiSpecification::Version2::PresenterFormatter, OpenApiSpecification::Version2::SecurityDefinitionsFormatter, OpenApiSpecification::Version2::TagsFormatter

Class Method Summary

• .call(*args) ⇒ Object

  Convenience class method for instantiating and calling.

Instance Method Summary

• #call ⇒ Object

  Override to transform atlas data into serialized format.

• #initialize(*args) ⇒ AbstractFormatter constructor

  A new instance of AbstractFormatter.

Methods included from Concerns::Optional

#valid_options

Constructor Details

#initialize(*args) ⇒ AbstractFormatter

Returns a new instance of AbstractFormatter.

# File 'lib/brainstem/api_docs/formatters/abstract_formatter.rb', line 49

def initialize(*args)
  super args.last || {}
end

Class Method Details

.call(*args) ⇒ Object

Convenience class method for instantiating and calling.

# File 'lib/brainstem/api_docs/formatters/abstract_formatter.rb', line 45

def self.call(*args)
  new(*args).call
end

Instance Method Details

#call ⇒ Object

Override to transform atlas data into serialized format.

Raises:

• (NotImplementedError)

# File 'lib/brainstem/api_docs/formatters/abstract_formatter.rb', line 56

def call
  raise NotImplementedError
end