Class: Roo::Openoffice

Inherits:
GenericSpreadsheet show all
Defined in:
lib/roo/openoffice.rb

Direct Known Subclasses

Libreoffice

Defined Under Namespace

Classes: Font

Constant Summary

Constants inherited from GenericSpreadsheet

GenericSpreadsheet::TEMP_PREFIX

Instance Attribute Summary

Attributes inherited from GenericSpreadsheet

#default_sheet, #header_line, #headers

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from GenericSpreadsheet

#column, #each, #each_with_pagename, #empty?, #find, #first_column, #first_column_as_letter, #first_row, #info, #last_column, #last_column_as_letter, #last_row, #longest_sheet, #parse, #reload, #row, #row_with, #set, #sheet, #to_csv, #to_matrix, #to_xml, #to_yaml

Constructor Details

#initialize(filename, packed = nil, file_warning = :error, tmpdir_root = nil) ⇒ Openoffice

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



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
 
# File 'lib/roo/openoffice.rb', line 37

def initialize(filename, packed=nil, file_warning=:error, tmpdir_root=nil)
  file_type_check(filename,'.ods','an Roo::Openoffice', file_warning, packed)
  make_tmpdir(tmpdir_root) do |tmpdir|
    filename = open_from_uri(filename, tmpdir) if uri?(filename)
    filename = unzip(filename, tmpdir) if packed == :zip
    @cells_read = Hash.new
    #TODO: @cells_read[:default] = false
    @filename = filename
    unless File.file?(@filename)
      raise IOError, "file #{@filename} does not exist"
    end
    self.class.extract_content(tmpdir, @filename)
    @doc = File.open(File.join(tmpdir, "roo_content.xml")) do |file|
      Nokogiri::XML(file)
    end
  end
  @default_sheet = self.sheets.first
  @cell = Hash.new
  @cell_type = Hash.new
  @formula = Hash.new
  @first_row = Hash.new
  @last_row = Hash.new
  @first_column = Hash.new
  @last_column = Hash.new
  @style = Hash.new
  @style_defaults = Hash.new { |h,k| h[k] = [] }
  @style_definitions = Hash.new
  @header_line = 1
  @comment = Hash.new
  @comments_read = Hash.new
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/roo/openoffice.rb', line 69

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

Class Method Details

.extract_content(tmpdir, filename) ⇒ Object 



11
12
13
14
15
 
# File 'lib/roo/openoffice.rb', line 11

def extract_content(tmpdir, filename)
  Zip::ZipFile.open(filename) do |zip|
    process_zipfile(tmpdir, zip)
  end
end

.process_zipfile(tmpdir, zip, path = '') ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/roo/openoffice.rb', line 17

def process_zipfile(tmpdir, zip, path='')
  if zip.file.file? path
    if path == "content.xml"
      open(File.join(tmpdir, 'roo_content.xml'),'wb') {|f|
        f << zip.read(path)
      }
    end
  else
    unless path.empty?
      path += '/'
    end
    zip.dir.foreach(path) do |filename|
      process_zipfile(tmpdir, zip, path+filename)
    end
  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.



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/roo/openoffice.rb', line 85

def cell(row, col, sheet=nil)
  sheet ||= @default_sheet
  read_cells(sheet) unless @cells_read[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



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/roo/openoffice.rb', line 173

def celltype(row,col,sheet=nil)
  sheet ||= @default_sheet
  read_cells(sheet) unless @cells_read[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



238
239
240
241
242
243
244
 
# File 'lib/roo/openoffice.rb', line 238

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

#comment?(row, col, sheet = nil) ⇒ Boolean

true, if there is a comment

Returns:

  • (Boolean) 


247
248
249
250
251
252
 
# File 'lib/roo/openoffice.rb', line 247

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

#comments(sheet = nil) ⇒ Object

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

row, col, comment 


257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/roo/openoffice.rb', line 257

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



157
158
159
160
161
162
163
 
# File 'lib/roo/openoffice.rb', line 157

def font(row, col, sheet=nil)
  sheet ||= @default_sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  style_name = @style[sheet][[row,col]] || @style_defaults[sheet][col - 1] || 'Default'
  @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.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/roo/openoffice.rb', line 99

def formula(row,col,sheet=nil)
  sheet ||= @default_sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  if @formula[sheet][[row,col]] == nil
    return nil
  else
    # return @formula[sheet][[row,col]]["oooc:".length..-1]
    # TODO:
    #str = @formula[sheet][[row,col]]
    #if str.include? ':'
     #return str[str.index(':')+1..-1]
    #else
     #return str
    #end
    @formula[sheet][[row,col]]
  end
end

#formula?(row, col, sheet = nil) ⇒ Boolean

true, if there is a formula

Returns:

  • (Boolean) 


119
120
121
122
123
124
 
# File 'lib/roo/openoffice.rb', line 119

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

#formulas(sheet = nil) ⇒ Object

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

row, col, formula 


128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/roo/openoffice.rb', line 128

def formulas(sheet=nil)
  sheet ||= @default_sheet
  read_cells(sheet) unless @cells_read[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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/roo/openoffice.rb', line 209

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::GenericSpreadsheet.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] 


225
226
227
228
229
230
231
232
233
234
 
# File 'lib/roo/openoffice.rb', line 225

def labels(sheet=nil)
  read_labels
  @label.map do |label|
    [ label[0], # name
      [ label[1][1].to_i, # row
        Roo::GenericSpreadsheet.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”



194
195
196
197
 
# File 'lib/roo/openoffice.rb', line 194

def officeversion
  oo_version
  @officeversion
end

#sheets ⇒ Object 



184
185
186
187
188
189
190
 
# File 'lib/roo/openoffice.rb', line 184

def sheets
  return_sheets = []
  @doc.xpath("//*[local-name()='table']").each do |sheet|
    return_sheets << sheet['name']
  end
  return_sheets
end

#to_s(sheet = nil) ⇒ Object

shows the internal representation of all cells mainly for debugging purposes



201
202
203
204
205
 
# File 'lib/roo/openoffice.rb', line 201

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