Puppet Function: format::table

Defined in:
lib/puppet/functions/format/table.rb
Function type:
Ruby 4.x API

Summary

Turns arrays into a table formatted string for human consumption

Overview

Useful when dumping text to the console in a nice table format. Normally this would only be used for puppet types like plans and other scenarios where text can be displayed directory on the console.

Note:

For a list of style options that can be supplied please see the tablestyle datatype.

Examples:

Calling the function

$t = format::table([['one', 1], ['two', 2]])

Calling the function with more parameters

$rows = [['one', 1], ['two', 2]]
$t_style = {width => 80}
$t = format::table({'title' => 'Some title', 'rows' => rows, 'style' => $t_style })

Signatures:

  • format::table(Format::TableRows $rows) ⇒ String
    Note:

    This function wraps the terminal-table gem and has almost the same API. For more information about how to create tables, please see the gem documention github.com/tj/terminal-table

    Returns A formatted table in string form.

    Examples:

    Calling the function

    $t = format::table([['one', 1], ['two', 2]])
=> "+-----+---+\n| One | 1 |\n| Two | 2 |\n+-----+---+"

    Parameters:

    • rows (Format::TableRows) —

      That data you wish to transform into a table.

    Returns:

    • (String) —

      A formatted table in string form.

  • format::table(Format::TerminalTable $data) ⇒ String
    Note:

    This function wraps the terminal-table gem and has almost the same API. For more information about how to create tables, please see the gem documention github.com/tj/terminal-table

    Returns A formatted table in string form.

    Examples:

    Calling the function

    $rows = [['one', 1], ['two', 2]]
$t = format::table({'title' => 'Some title', 'rows' => rows, 'style' => {width => 80}})
=> "+-----+---+\n|  title  |\n+-----+---+\n| One | 1 |\n| Two | 2 |\n+-----+---+"

    Parameters:

    • data (Format::TerminalTable) —

      That data and other settings you wish to produce a table with.

    Returns:

    • (String) —

      A formatted table in string form.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/puppet/functions/format/table.rb', line 20

Puppet::Functions.create_function(:'format::table') do
  # @param rows That data you wish to transform into a table.
  # @return [String] A formatted table in string form.
  # @example Calling the function
  #   $t = format::table([['one', 1], ['two', 2]])
  #   => "+-----+---+\n| One | 1 |\n| Two | 2 |\n+-----+---+"
  # @note This function wraps the terminal-table gem and has almost the same API.
  #       For more information about how to create tables, please see the gem documention
  #       https://github.com/tj/terminal-table
  dispatch :print_table do
    param 'Format::TableRows', :rows
  end

  # @param data That data and other settings you wish to produce a table with.
  # @return [String] A formatted table in string form.
  # @example Calling the function
  #   $rows = [['one', 1], ['two', 2]]
  #   $t = format::table({'title' => 'Some title', 'rows' => rows, 'style' => {width => 80}})
  #   => "+-----+---+\n|  title  |\n+-----+---+\n| One | 1 |\n| Two | 2 |\n+-----+---+"
  # @note This function wraps the terminal-table gem and has almost the same API.
  #       For more information about how to create tables, please see the gem documention
  #       https://github.com/tj/terminal-table
  dispatch :print_table_hash do
    param 'Format::TerminalTable', :data
  end

  def print_table(rows)
    print_table_hash('rows' => rows)
  end

  def print_table_hash(data)
    require 'terminal-table'
    tdata = data.transform_keys(&:to_sym)
    table = Terminal::Table.new do |t|
      t.rows = tdata[:rows].empty? ? [tdata[:rows]] : tdata[:rows]
      t.title = tdata[:title]
      t.headings = tdata[:head] if tdata[:head]

      unless tdata[:style].nil?
        style = tdata[:style].transform_keys(&:to_sym)
        style[:border] &&= style[:border].to_sym # This value is required to be a symbol
        t.style = style
      end
    end
    table.to_s
  rescue LoadError
    message = 'Terminal-table gem not found, please install: gem install terminal-table'
    raise LoadError, message
  end
end