Class: TermUtils::Tab::Header

Inherits:
Object
  • Object
show all
Defined in:
lib/term_utils/tab.rb

Overview

Represents a column header.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ Header

Constructs a new Header.

Parameters:

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

Options Hash (opts):

  • :title (String)
  • :align (Symbol) 


354
355
356
357
 
# File 'lib/term_utils/tab.rb', line 354

def initialize(opts = {})
  @title = opts.fetch(:title)
  @align = opts.fetch(:align, :left)
end

Instance Attribute Details

#align ⇒ Symbol

Returns `:left`, `:right`.

Returns:

  • (Symbol) —

    `:left`, `:right`.



349
350
351
 
# File 'lib/term_utils/tab.rb', line 349

def align
  @align
end

#title ⇒ String

Returns:

  • (String) 


347
348
349
 
# File 'lib/term_utils/tab.rb', line 347

def title
  @title
end

Instance Method Details

#validate ⇒ nil

Validates the column represented by this one.

Returns:

  • (nil)

Raises:



361
362
363
364
 
# File 'lib/term_utils/tab.rb', line 361

def validate
  raise TermUtils::Tab::TableError, "missing header title (nil)" if @title.nil?
  raise TermUtils::Tab::TableError, "wrong header align (not :left or :right)" unless %i[left right].index(@align)
end