Module: TermUtils::Tab

Defined in:

lib/term_utils/tab.rb

Overview

The tab module provides a way to print formatted tables.

Defined Under Namespace

Classes: Column, Holder, Printer, Table

Constant Summary

@@default_holder =

Holder.new

Class Method Summary

• .define_table(id, opts = {}, &block) ⇒ Tab::Table

  Defines a table.

• .find_table(id) ⇒ Tab::Table^?

  Finds a table.

• .printer(id, io, opts = {}, &block) ⇒ Tab::Printer

  Creates a new table printer.

Class Method Details

.define_table(id, opts = {}, &block) ⇒ Tab::Table

Defines a table.

Parameters:

• id (Symbol)
• opts (Hash) (defaults to: {})

Returns:

• (Tab::Table)

# File 'lib/term_utils/tab.rb', line 330

def self.define_table(id, opts = {}, &block)
  @@default_holder.define_table(id, opts = {}, &block)
end

.find_table(id) ⇒ Tab::Table^?

Finds a table.

Parameters:

• id (Symbol)

Returns:

• (Tab::Table, nil)

# File 'lib/term_utils/tab.rb', line 336

def self.find_table(id)
  @@default_holder.find_table(id)
end

.printer(id, io, opts = {}, &block) ⇒ Tab::Printer

Creates a new table printer.

Parameters:

• id (Symbol)
• io (IO)
• opts (Hash) (defaults to: {})

Options Hash (opts):

• :offset (Integer)
• :column_separator_width (Integer)

Returns:

• (Tab::Printer)

# File 'lib/term_utils/tab.rb', line 346

def self.printer(id, io, opts = {}, &block)
  @@default_holder.find_table(id).printer(io, opts, &block)
end