Class: Roo::OpenOffice

Inherits:
Base
  • Object
show all
Defined in:
lib/roo/open_office.rb

Direct Known Subclasses

LibreOffice

Constant Summary

Constants inherited from Base

Base::MAX_ROW_COL, Base::MIN_ROW_COL, Base::TEMP_PREFIX

Instance Attribute Summary

Attributes inherited from Base

#header_line, #headers

Instance Method Summary collapse

Methods inherited from Base

#cell_type_by_value, #close, #collect_last_row_col_for_sheet, #column, #default_sheet, #default_sheet=, #each, #each_with_pagename, #empty?, #find, #first_column_as_letter, #first_last_row_col_for_sheet, #info, #inspect, #last_column_as_letter, #parse, #reload, #row, #row_with, #set, #sheet, #to_csv, #to_matrix, #to_xml, #to_yaml

Constructor Details

#initialize(filename, options = {}) ⇒ OpenOffice

initialization and opening of a spreadsheet file values for packed: :zip



10
11
12
13
14
15
16
17
18
19
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
 
# File 'lib/roo/open_office.rb', line 10

def initialize(filename, options={})
  packed = options[:packed]
  file_warning = options[:file_warning] || :error

  @only_visible_sheets = options[:only_visible_sheets]
  file_type_check(filename,'.ods','an Roo::OpenOffice', file_warning, packed)
  @tmpdir = make_tmpdir(File.basename(filename), options[:tmpdir_root])
  @filename = local_filename(filename, @tmpdir, packed)
  #TODO: @cells_read[:default] = false
  Zip::File.open(@filename) do |zip_file|
    if content_entry = zip_file.glob("content.xml").first
      roo_content_xml_path = File.join(@tmpdir, 'roo_content.xml')
      content_entry.extract(roo_content_xml_path)
      decrypt_if_necessary(
        zip_file,
        content_entry,
        roo_content_xml_path,
        options
      )
    else
      raise ArgumentError, 'file missing required content.xml'
    end
  end
  super(filename, options)
  @formula = Hash.new
  @style = Hash.new
  @style_defaults = Hash.new { |h,k| h[k] = [] }
  @table_display = Hash.new { |h,k| h[k] = true }
  @font_style_definitions = Hash.new
  @comment = Hash.new
  @comments_read = Hash.new
rescue => e # clean up any temp files, but only if an error was raised
  close
  raise e
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/roo/open_office.rb', line 46

def method_missing(m,*args)
  read_labels
  # is method name a label name
  if @label.has_key?(m.to_s)
    row,col = label(m.to_s)
    cell(row,col)
  else
    # call super for methods like #a1
    super
  end
end

Instance Method Details

#cell(row, col, sheet = nil) ⇒ Object

Returns the content of a spreadsheet-cell. (1,1) is the upper left corner. (1,1), (1,‘A’), (‘A’,1), (‘a’,1) all refers to the cell at the first line and first row.



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/roo/open_office.rb', line 62

def cell(row, col, sheet=nil)
  sheet ||= default_sheet
  read_cells(sheet)
  row,col = normalize(row,col)
  if celltype(row,col,sheet) == :date
    yyyy,mm,dd = @cell[sheet][[row,col]].to_s.split('-')
    return Date.new(yyyy.to_i,mm.to_i,dd.to_i)
  end
  @cell[sheet][[row,col]]
end

#celltype(row, col, sheet = nil) ⇒ Object

returns the type of a cell:

  • :float

  • :string

  • :date

  • :percentage

  • :formula

  • :time

  • :datetime



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/roo/open_office.rb', line 121

def celltype(row,col,sheet=nil)
  sheet ||= default_sheet
  read_cells(sheet)
  row,col = normalize(row,col)
  if @formula[sheet][[row,col]]
    return :formula
  else
    @cell_type[sheet][[row,col]]
  end
end

#comment(row, col, sheet = nil) ⇒ Object

returns the comment at (row/col) nil if there is no comment



191
192
193
194
195
196
197
 
# File 'lib/roo/open_office.rb', line 191

def comment(row,col,sheet=nil)
  sheet ||= default_sheet
  read_cells(sheet)
  row,col = normalize(row,col)
  return nil unless @comment[sheet]
  @comment[sheet][[row,col]]
end

#comments(sheet = nil) ⇒ Object

returns each comment in the selected sheet as an array of elements

row, col, comment 


201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/roo/open_office.rb', line 201

def comments(sheet=nil)
  sheet ||= default_sheet
  read_comments(sheet) unless @comments_read[sheet]
  if @comment[sheet]
    @comment[sheet].each.collect do |elem|
      [elem[0][0],elem[0][1],elem[1]]
    end
  else
    []
  end
end

#font(row, col, sheet = nil) ⇒ Object

Given a cell, return the cell’s style



105
106
107
108
109
110
111
 
# File 'lib/roo/open_office.rb', line 105

def font(row, col, sheet=nil)
  sheet ||= default_sheet
  read_cells(sheet)
  row,col = normalize(row,col)
  style_name = @style[sheet][[row,col]] || @style_defaults[sheet][col - 1] || 'Default'
  @font_style_definitions[style_name]
end

#formula(row, col, sheet = nil) ⇒ Object

Returns the formula at (row,col). Returns nil if there is no formula. The method #formula? checks if there is a formula.



76
77
78
79
80
81
 
# File 'lib/roo/open_office.rb', line 76

def formula(row,col,sheet=nil)
  sheet ||= default_sheet
  read_cells(sheet)
  row,col = normalize(row,col)
  @formula[sheet][[row,col]]
end

#formula?(*args) ⇒ Boolean

Predicate methods really should return a boolean value. Hopefully no one was relying on the fact that this previously returned either nil/formula

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/roo/open_office.rb', line 86

def formula?(*args)
  !!formula(*args)
end

#formulas(sheet = nil) ⇒ Object

returns each formula in the selected sheet as an array of elements

row, col, formula 


92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/roo/open_office.rb', line 92

def formulas(sheet=nil)
  sheet ||= default_sheet
  read_cells(sheet)
  if @formula[sheet]
    @formula[sheet].each.collect do |elem|
      [elem[0][0], elem[0][1], elem[1]]
    end
  else
    []
  end
end

#label(labelname) ⇒ Object

returns the row,col values of the labelled cell (nil,nil) if label is not defined



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/roo/open_office.rb', line 162

def label(labelname)
  read_labels
  unless @label.size > 0
    return nil,nil,nil
  end
  if @label.has_key? labelname
    return @label[labelname][1].to_i,
      ::Roo::Utils.letter_to_number(@label[labelname][2]),
      @label[labelname][0]
  else
    return nil,nil,nil
  end
end

#labels(sheet = nil) ⇒ Object

Returns an array which all labels. Each element is an array with

labelname, [row,col,sheetname] 


178
179
180
181
182
183
184
185
186
187
 
# File 'lib/roo/open_office.rb', line 178

def labels(sheet=nil)
  read_labels
  @label.map do |label|
    [ label[0], # name
      [ label[1][1].to_i, # row
        ::Roo::Utils.letter_to_number(label[1][2]), # column
        label[1][0], # sheet
      ] ]
  end
end

#officeversion ⇒ Object

version of the Roo::OpenOffice document at 2007 this is always “1.0”



147
148
149
150
 
# File 'lib/roo/open_office.rb', line 147

def officeversion
  oo_version
  @officeversion
end

#sheets ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/roo/open_office.rb', line 132

def sheets
  unless @table_display.any?
    doc.xpath("//*[local-name()='automatic-styles']").each do |style|
      read_table_styles(style)
    end
  end
  doc.xpath("//*[local-name()='table']").map do |sheet|
    if !@only_visible_sheets || @table_display[attr(sheet,'style-name')]
      sheet.attributes["name"].value
    end
  end.compact
end

#to_s(sheet = nil) ⇒ Object

shows the internal representation of all cells mainly for debugging purposes



154
155
156
157
158
 
# File 'lib/roo/open_office.rb', line 154

def to_s(sheet=nil)
  sheet ||= default_sheet
  read_cells(sheet)
  @cell[sheet].inspect
end