Class: Licensure::Formatters::Base

Inherits:

Object

• Object
• Licensure::Formatters::Base

Defined in:

lib/licensure/formatters/base.rb

Overview

Base formatter abstraction.

Direct Known Subclasses

Csv, Json, Markdown, Table

Instance Method Summary

• #initialize(output: $stdout) ⇒ Base constructor

  A new instance of Base.

• #render(_gem_license_infos) ⇒ String
• #render_check_result(_check_result) ⇒ String

Constructor Details

#initialize(output: $stdout) ⇒ Base

Returns a new instance of Base.

Parameters:

• output (IO) (defaults to: $stdout)

# File 'lib/licensure/formatters/base.rb', line 8

def initialize(output: $stdout)
  @output = output
end

Instance Method Details

#render(_gem_license_infos) ⇒ String

Parameters:

• _gem_license_infos (Array<Licensure::GemLicenseInfo>)

Returns:

• (String)

Raises:

• (NotImplementedError)

# File 'lib/licensure/formatters/base.rb', line 14

def render(_gem_license_infos)
  raise NotImplementedError, "Implement #render in formatter subclasses"
end

#render_check_result(_check_result) ⇒ String

Parameters:

• _check_result (Licensure::CheckResult)

Returns:

• (String)

Raises:

• (NotImplementedError)

# File 'lib/licensure/formatters/base.rb', line 20

def render_check_result(_check_result)
  raise NotImplementedError, "Implement #render_check_result in formatter subclasses"
end