Class: Terminal::Table

Generates a ASCII table with the given options.

    # File lib/terminal-table/table.rb, line 11
11:     def initialize options = {}, &block
12:       @column_widths = []
13:       self.style = options.fetch :style, {}
14:       self.headings = options.fetch :headings, []
15:       self.rows = options.fetch :rows, []
16:       self.title = options.fetch :title, nil
17:       yield_or_eval(&block) if block
18:     end

new(options = {})

Generates a ASCII table with the given options.

[Source]

    # File lib/terminal-table/table.rb, line 11
11:     def initialize options = {}, &block
12:       @column_widths = []
13:       self.style = options.fetch :style, {}
14:       self.headings = options.fetch :headings, []
15:       self.rows = options.fetch :rows, []
16:       self.title = options.fetch :title, nil
17:       yield_or_eval(&block) if block
18:     end

<<(array)

Alias for add_row

<<(array)

Alias for add_row

==(other)

Check if other is equal to self. other is considered equal if it contains the same headings and rows.

[Source]

     # File lib/terminal-table/table.rb, line 153
153:     def == other
154:       if other.respond_to? :render and other.respond_to? :rows
155:         self.headings == other.headings and self.rows == other.rows
156:       end
157:     end

==(other)

Check if other is equal to self. other is considered equal if it contains the same headings and rows.

[Source]

     # File lib/terminal-table/table.rb, line 153
153:     def == other
154:       if other.respond_to? :render and other.respond_to? :rows
155:         self.headings == other.headings and self.rows == other.rows
156:       end
157:     end

add_row(array)

Add a row.

[Source]

    # File lib/terminal-table/table.rb, line 34
34:     def add_row array
35:       row = array == :separator ? Separator.new(self) : Row.new(self, array)
36:       @rows << row
37:       recalc_column_widths row
38:     end

add_row(array)

Add a row.

[Source]

    # File lib/terminal-table/table.rb, line 34
34:     def add_row array
35:       row = array == :separator ? Separator.new(self) : Row.new(self, array)
36:       @rows << row
37:       recalc_column_widths row
38:     end

add_separator()

Add a separator.

[Source]

    # File lib/terminal-table/table.rb, line 44
44:     def add_separator
45:       self << :separator
46:     end

add_separator()

Add a separator.

[Source]

    # File lib/terminal-table/table.rb, line 44
44:     def add_separator
45:       self << :separator
46:     end

align_column(n, alignment)

Align column n to the given alignment of :center, :left, or :right.

[Source]

    # File lib/terminal-table/table.rb, line 23
23:     def align_column n, alignment
24:       r = rows
25:       column(n).each_with_index do |col, i|
26:         cell = r[i][n]
27:         cell.alignment = alignment unless cell.alignment?
28:       end
29:     end

align_column(n, alignment)

Align column n to the given alignment of :center, :left, or :right.

[Source]

    # File lib/terminal-table/table.rb, line 23
23:     def align_column n, alignment
24:       r = rows
25:       column(n).each_with_index do |col, i|
26:         cell = r[i][n]
27:         cell.alignment = alignment unless cell.alignment?
28:       end
29:     end

cell_padding()

[Source]

    # File lib/terminal-table/table.rb, line 52
52:     def cell_padding
53:       style.padding_left + style.padding_right
54:     end

cell_padding()

[Source]

    # File lib/terminal-table/table.rb, line 52
52:     def cell_padding
53:       style.padding_left + style.padding_right
54:     end

cell_spacing()

[Source]

    # File lib/terminal-table/table.rb, line 48
48:     def cell_spacing
49:       cell_padding + style.border_y.length
50:     end

cell_spacing()

[Source]

    # File lib/terminal-table/table.rb, line 48
48:     def cell_spacing
49:       cell_padding + style.border_y.length
50:     end

column(n, method = :value, array = rows)

Return column n.

[Source]

    # File lib/terminal-table/table.rb, line 59
59:     def column n, method = :value, array = rows
60:       array.map { |row| 
61:         cell = row[n]
62:         cell && method ? cell.__send__(method) : cell
63:       }.compact 
64:     end

column(n, method = :value, array = rows)

Return column n.

[Source]

    # File lib/terminal-table/table.rb, line 59
59:     def column n, method = :value, array = rows
60:       array.map { |row| 
61:         cell = row[n]
62:         cell && method ? cell.__send__(method) : cell
63:       }.compact 
64:     end

column_width(n)

Return length of column n.

[Source]

    # File lib/terminal-table/table.rb, line 83
83:     def column_width n
84:       width = @column_widths[n] || 0
85:       width + additional_column_widths[n].to_i
86:     end

column_width(n)

Return length of column n.

[Source]

    # File lib/terminal-table/table.rb, line 83
83:     def column_width n
84:       width = @column_widths[n] || 0
85:       width + additional_column_widths[n].to_i
86:     end

column_with_headings(n, method = :value)

Return n column including headings.

[Source]

    # File lib/terminal-table/table.rb, line 69
69:     def column_with_headings n, method = :value
70:       column n, method, headings_with_rows
71:     end

column_with_headings(n, method = :value)

Return n column including headings.

[Source]

    # File lib/terminal-table/table.rb, line 69
69:     def column_with_headings n, method = :value
70:       column n, method, headings_with_rows
71:     end

columns()

Return columns.

[Source]

    # File lib/terminal-table/table.rb, line 76
76:     def columns
77:       (0...number_of_columns).map { |n| column n } 
78:     end

columns()

Return columns.

[Source]

    # File lib/terminal-table/table.rb, line 76
76:     def columns
77:       (0...number_of_columns).map { |n| column n } 
78:     end

headings=(array)

Set the headings

[Source]

     # File lib/terminal-table/table.rb, line 99
 99:     def headings= array
100:       @headings = Row.new(self, array)
101:       recalc_column_widths @headings
102:     end

headings=(array)

Set the headings

[Source]

     # File lib/terminal-table/table.rb, line 99
 99:     def headings= array
100:       @headings = Row.new(self, array)
101:       recalc_column_widths @headings
102:     end

length_of_column(n)

Alias for column_width

length_of_column(n)

Alias for column_width

number_of_columns()

Return total number of columns available.

[Source]

    # File lib/terminal-table/table.rb, line 92
92:     def number_of_columns
93:       headings_with_rows.map { |r| r.cells.size }.max
94:     end

number_of_columns()

Return total number of columns available.

[Source]

    # File lib/terminal-table/table.rb, line 92
92:     def number_of_columns
93:       headings_with_rows.map { |r| r.cells.size }.max
94:     end

render()

Render the table.

[Source]

     # File lib/terminal-table/table.rb, line 107
107:     def render
108:       separator = Separator.new(self)
109:       buffer = [separator]
110:       unless @title.nil?
111:         buffer << Row.new(self, [title_cell_options])
112:         buffer << separator
113:       end
114:       unless @headings.cells.empty?
115:         buffer << @headings
116:         buffer << separator
117:       end
118:       buffer += @rows
119:       buffer << separator
120:       buffer.map { |r| r.render }.join("\n")
121:     end

render()

Render the table.

[Source]

     # File lib/terminal-table/table.rb, line 107
107:     def render
108:       separator = Separator.new(self)
109:       buffer = [separator]
110:       unless @title.nil?
111:         buffer << Row.new(self, [title_cell_options])
112:         buffer << separator
113:       end
114:       unless @headings.cells.empty?
115:         buffer << @headings
116:         buffer << separator
117:       end
118:       buffer += @rows
119:       buffer << separator
120:       buffer.map { |r| r.render }.join("\n")
121:     end

rows()

Return rows without separator rows.

[Source]

     # File lib/terminal-table/table.rb, line 127
127:     def rows
128:       @rows.reject { |row| row.is_a? Separator }
129:     end

rows()

Return rows without separator rows.

[Source]

     # File lib/terminal-table/table.rb, line 127
127:     def rows
128:       @rows.reject { |row| row.is_a? Separator }
129:     end

rows=(array)

[Source]

     # File lib/terminal-table/table.rb, line 131
131:     def rows= array
132:       @rows = []
133:       array.each { |arr| self << arr }
134:     end

rows=(array)

[Source]

     # File lib/terminal-table/table.rb, line 131
131:     def rows= array
132:       @rows = []
133:       array.each { |arr| self << arr }
134:     end

style()

[Source]

     # File lib/terminal-table/table.rb, line 140
140:     def style
141:       @style ||= Style.new
142:     end

style()

[Source]

     # File lib/terminal-table/table.rb, line 140
140:     def style
141:       @style ||= Style.new
142:     end

style=(options)

[Source]

     # File lib/terminal-table/table.rb, line 136
136:     def style=(options)
137:       style.apply options
138:     end

style=(options)

[Source]

     # File lib/terminal-table/table.rb, line 136
136:     def style=(options)
137:       style.apply options
138:     end

title=(title)

[Source]

     # File lib/terminal-table/table.rb, line 144
144:     def title=(title)
145:       @title = title
146:       recalc_column_widths Row.new(self, [title_cell_options])
147:     end

title=(title)

[Source]

     # File lib/terminal-table/table.rb, line 144
144:     def title=(title)
145:       @title = title
146:       recalc_column_widths Row.new(self, [title_cell_options])
147:     end

to_s()

Alias for render

to_s()

Alias for render

VERSION	=	'1.4.5'
VERSION	=	'1.4.5'

Methods

Classes and Modules

Constants

Attributes

Public Class methods

Public Instance methods