module TTY::Table::Renderer

def assert_border_class(border_class)

Other tags:
    Api: - public

Raises:
  • (NoImplementationError) -
  • (TypeError) -
def assert_border_class(border_class)
  return unless border_class
  unless border_class <= TTY::Table::Border
    raise TypeError,
          "#{border_class} should inherit from TTY::Table::Border"
  end
  unless border_class.characters
    raise NoImplementationError,
          "#{border_class} should implement def_border"
  end
end

def render(table, options = {}, &block)

Other tags:
    Api: - public

Returns:
  • (String) -

Options Hash: (**options)
  • :renderer (String) --

Parameters:
  • options (Hash) --
  • table (TTY::Table) --
def render(table, options = {}, &block)
  renderer = select(options[:renderer]).new(table, options)
  yield renderer if block_given?
  renderer.render
end

def render_with(border_class, table, options = {}, &block)

Other tags:
    Api: - public

Raises:
  • (NoImplemntationError) -
  • (TypeError) -

Parameters:
  • options (Hash) --
  • table (TTY::Table) --
  • border_class (TTY::Table::Border) --
def render_with(border_class, table, options = {}, &block)
  assert_border_class(border_class)
  options[:border_class] = border_class if border_class
  render(table, options, &block)
end

def select(type)

Other tags:
    Api: - private

Returns:
  • (TTY::Table::Renderer) -

Parameters:
  • type (Symbol) --
def select(type)
  RENDERER_MAPPER[type || :basic]
end