class Roo::Excelx::Sheet

Public Class Methods

new(name, rels_path, sheet_path, comments_path, styles, shared_strings, workbook, options = {}) click to toggle source
# File lib/roo/excelx.rb, line 149
def initialize(name, rels_path, sheet_path, comments_path, styles, shared_strings, workbook, options = {})
  @name = name
  @rels = Relationships.new(rels_path)
  @comments = Comments.new(comments_path)
  @styles = styles
  @sheet = SheetDoc.new(sheet_path, @rels, @styles, shared_strings, workbook, options)
end

Public Instance Methods

cells() click to toggle source
# File lib/roo/excelx.rb, line 157
def cells
  @cells ||= @sheet.cells(@rels)
end
column(col_number) click to toggle source
# File lib/roo/excelx.rb, line 186
def column(col_number)
  first_row.upto(last_row).map do |row|
    cells[[row,col_number]]
  end.map {|cell| cell && cell.value }
end
comments() click to toggle source
# File lib/roo/excelx.rb, line 220
def comments
  @comments.comments
end
dimensions() click to toggle source
# File lib/roo/excelx.rb, line 224
def dimensions
  @sheet.dimensions
end
each_row(options = {}, &block) click to toggle source

Yield each row as array of Excelx::Cell objects accepts options max_rows (int) (offset by 1 for header), pad_cells (boolean) and offset (int)

# File lib/roo/excelx.rb, line 168
def each_row(options = {}, &block)
  row_count = 0
  options[:offset] ||= 0
  @sheet.each_row_streaming do |row|
    break if options[:max_rows] && row_count == options[:max_rows] + options[:offset] + 1
    if block_given? && !(options[:offset] && row_count < options[:offset])
      block.call(cells_for_row_element(row, options))
    end
    row_count += 1
  end
end
excelx_format(key) click to toggle source
# File lib/roo/excelx.rb, line 211
def excelx_format(key)
  cell = cells[key]
  @styles.style_format(cell.style).to_s if cell
end
first_column() click to toggle source

returns the number of the first non-empty column

# File lib/roo/excelx.rb, line 202
def first_column
  @first_column ||= present_cells.keys.map {|_, col| col }.min
end
first_row() click to toggle source

returns the number of the first non-empty row

# File lib/roo/excelx.rb, line 193
def first_row
  @first_row ||= present_cells.keys.map {|row, _| row }.min
end
last_column() click to toggle source

returns the number of the last non-empty column

# File lib/roo/excelx.rb, line 207
def last_column
  @last_column ||= present_cells.keys.map {|_, col| col }.max
end
last_row() click to toggle source
# File lib/roo/excelx.rb, line 197
def last_row
  @last_row ||= present_cells.keys.map {|row, _| row }.max
end
present_cells() click to toggle source
# File lib/roo/excelx.rb, line 161
def present_cells
  @present_cells ||= cells.select {|key, cell| cell && cell.value }
end
row(row_number) click to toggle source
# File lib/roo/excelx.rb, line 180
def row(row_number)
  first_column.upto(last_column).map do |col|
    cells[[row_number,col]]
  end.map {|cell| cell && cell.value }
end

Private Instance Methods

cells_for_row_element(row_element, options = {}) click to toggle source

Take an xml row and return an array of Excelx::Cell objects optionally pad array to header width(assumed 1st row). takes option pad_cells (boolean) defaults false

# File lib/roo/excelx.rb, line 233
def cells_for_row_element(row_element, options = {})
  return [] unless row_element
  cell_col = 0
  cells = []
  @sheet.each_cell(row_element) do |cell|
    cells.concat(pad_cells(cell, cell_col)) if options[:pad_cells]
    cells << cell
    cell_col = cell.coordinate.column
  end
  cells
end
pad_cells(cell, last_column) click to toggle source
# File lib/roo/excelx.rb, line 245
def pad_cells(cell, last_column)
  pad = []
  (cell.coordinate.column - 1 - last_column).times { pad << nil }
  pad
end