Class: TTY::Table::Operation::Truncation

Inherits:

Object

• Object
• TTY::Table::Operation::Truncation

Defined in:

lib/tty/table/operation/truncation.rb

Overview

A class responsible for shortening text.

Instance Attribute Summary

• #widths ⇒ Object readonly

  Returns the value of attribute widths.

Instance Method Summary

• #call(field, row, col) ⇒ TTY::Table::Field

  Apply truncation to a field.

• #initialize(widths) ⇒ Truncation constructor

  Initialize a Truncation.

• #truncate(string, width) ⇒ String

  Shorten given string with traling character.

Constructor Details

#initialize(widths) ⇒ Truncation

Initialize a Truncation

# File 'lib/tty/table/operation/truncation.rb', line 15

def initialize(widths)
  @widths = widths
end

Instance Attribute Details

#widths ⇒ Object (readonly)

Returns the value of attribute widths.

# File 'lib/tty/table/operation/truncation.rb', line 10

def widths
  @widths
end

Instance Method Details

#call(field, row, col) ⇒ TTY::Table::Field

Apply truncation to a field

Parameters:

• field (TTY::Table::Field) —

  the table field

• row (Integer) —

  the field row index

• col (Integer) —

  the field column index

Returns:

• (TTY::Table::Field)

# File 'lib/tty/table/operation/truncation.rb', line 33

def call(field, row, col)
  width       = widths[col] || field.width
  field.value = truncate(field.value, width)
end

#truncate(string, width) ⇒ String

Shorten given string with traling character.

Parameters:

• string (String) —

  the string to truncate

• width (Integer) —

  the maximum width

Returns:

• (String)

# File 'lib/tty/table/operation/truncation.rb', line 48

def truncate(string, width)
  TTY::Text.truncate(string, width)
end