class Axlsx::CellSerializer

The Cell Serializer class contains the logic for serializing cells based on their type.

Public Class Methods

array_formula_serialization(cell, str='') click to toggle source

Serializes cells that are type array formula @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 97
def array_formula_serialization(cell, str='')
  str << ('t="str">' << '<f t="array" ref="' << cell.r << '">' << cell.clean_value.to_s.sub('{=', '').sub(/}$/, '') << '</f>')
  str << ('<v>' << cell.formula_value.to_s << '</v>') unless cell.formula_value.nil?
end
boolean(cell, str='') click to toggle source

Serializes cells that are type boolean @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 64
def boolean(cell, str='')
  value_serialization 'b', cell.value.to_s, str
end
date(cell, str='') click to toggle source

serializes cells that are type date @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 48
def date(cell, str='')
  value_serialization false, DateTimeConverter::date_to_serial(cell.value).to_s, str
end
float(cell, str='') click to toggle source

Serializes cells that are type float @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 72
def float(cell, str='')
  numeric cell, str
end
formula_serialization(cell, str='') click to toggle source

Serializes cells that are type formula @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 88
def formula_serialization(cell, str='')
  str << ('t="str"><f>' << cell.clean_value.to_s.sub('=', '') << '</f>')
  str << ('<v>' << cell.formula_value.to_s << '</v>') unless cell.formula_value.nil?
end
inline_string_serialization(cell, str = '') click to toggle source

Serializes cells that are type inline_string @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 106
def inline_string_serialization(cell, str = '')
  str << 't="inlineStr"><is>'
  run_xml_string cell, str
  str << '</is>'
end
integer(cell, str = '') click to toggle source

Serializes cells that are type integer @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 80
def integer(cell, str = '')
  numeric cell, str
end
iso_8601(cell, str='') click to toggle source

serializes cells that are type iso_8601 @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 40
def iso_8601(cell, str='')
  value_serialization 'd', cell.value, str
end
richtext(cell, str) click to toggle source

Serializes cells that are of the type richtext @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 132
def richtext(cell, str)
  if cell.ssti.nil?
    inline_string_serialization cell, str
  else
    value_serialization 's', cell.ssti, str
  end
end
run_xml_string(cell, str = '') click to toggle source

builds an xml text run based on this cells attributes. @param [String] str The string instance this run will be concated to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 22
def run_xml_string(cell, str = '')
  if cell.is_text_run?
    valid = RichTextRun::INLINE_STYLES - [:value, :type]
    data = Hash[cell.instance_values.map{ |k, v| [k.to_sym, v] }]
    data = data.select { |key, value| valid.include?(key) && !value.nil? }
    RichText.new(cell.value.to_s, data).to_xml_string(str)
  elsif cell.contains_rich_text?
    cell.value.to_xml_string(str)
  else
    str << ('<t>' << cell.clean_value << '</t>')
  end
  str
end
string(cell, str='') click to toggle source

Serializes cells that are type string @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 116
def string(cell, str='')
  if cell.is_array_formula?
    array_formula_serialization cell, str
  elsif cell.is_formula?
    formula_serialization cell, str
  elsif !cell.ssti.nil?
    value_serialization 's', cell.ssti, str
  else
    inline_string_serialization cell, str
  end
end
text(cell, str) click to toggle source

Serializes cells that are of the type text @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 144
def text(cell, str)
  if cell.ssti.nil?
    inline_string_serialization cell, str
  else
    value_serialization 's', cell.ssti, str
  end
end
time(cell, str='') click to toggle source

Serializes cells that are type time @param [Cell] cell The cell that is being serialized @param [String] str The string the serialized content will be appended to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 56
def time(cell, str='')
  value_serialization false, DateTimeConverter::time_to_serial(cell.value).to_s, str
end
to_xml_string(row_index, column_index, cell, str='') click to toggle source

Calls the proper serialization method based on type. @param [Integer] row_index The index of the cell's row @param [Integer] column_index The index of the cell's column @param [String] str The string to apend serialization to. @return [String]

# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 11
def to_xml_string(row_index, column_index, cell, str='')
  str << ('<c r="' << Axlsx::cell_r(column_index, row_index) << '" s="' << cell.style.to_s << '" ')
  return str << '/>' if cell.value.nil?
  method = cell.type
  self.send(method, cell, str)
  str << '</c>'
end

Private Class Methods

numeric(cell, str = '') click to toggle source
# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 154
def numeric(cell, str = '')
  value_serialization 'n', cell.value, str
end
value_serialization(serialization_type, serialization_value, str = '') click to toggle source
# File lib/axlsx/workbook/worksheet/cell_serializer.rb, line 158
def value_serialization(serialization_type, serialization_value, str = '')
  str << ('t="' << serialization_type.to_s << '"') if serialization_type
  str << ('><v>' << serialization_value.to_s << '</v>')
end