Class: GenericSpreadsheet

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

Overview

Base class for all other types of spreadsheets

Direct Known Subclasses

Excel, Excel2003XML, Excelx, Google, Openoffice

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (GenericSpreadsheet) initialize

Returns a new instance of GenericSpreadsheet



12
13
# File 'lib/roo/generic_spreadsheet.rb', line 12

def initialize
end

Instance Attribute Details

- (Object) default_sheet

Returns the value of attribute default_sheet



7
8
9
# File 'lib/roo/generic_spreadsheet.rb', line 7

def default_sheet
  @default_sheet
end

- (Object) header_line

sets the line with attribute names (default: 1)



10
11
12
# File 'lib/roo/generic_spreadsheet.rb', line 10

def header_line
  @header_line
end

Instance Method Details

- (Object) column(columnnumber, sheet = nil)

returns all values in this column as an array column numbers are 1,2,3,… like in the spreadsheet



269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/roo/generic_spreadsheet.rb', line 269

def column(columnnumber,sheet=nil)
  if columnnumber.class == String
    columnnumber = Excel.letter_to_number(columnnumber)
  end
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  result = []
  first_row(sheet).upto(last_row(sheet)) do |row|
    result << cell(row,columnnumber,sheet)
  end
  result
end

- (Boolean) empty?(row, col, sheet = nil)

true if cell is empty

Returns:

  • (Boolean)


293
294
295
296
297
298
299
300
301
# File 'lib/roo/generic_spreadsheet.rb', line 293

def empty?(row, col, sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet] or self.class == Excel
  row,col = normalize(row,col)
  return true unless cell(row, col, sheet)
  return true if celltype(row, col, sheet) == :string && cell(row, col, sheet).empty?
  return true if row < first_row(sheet) || row > last_row(sheet) || col < first_column(sheet) || col > last_column(sheet)
  false
end

- (Object) find(*args)

find a row either by row number or a condition Caution: this works only within the default sheet -> set default_sheet before you call this method (experimental. see examples in the test_roo.rb file)



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/roo/generic_spreadsheet.rb', line 167

def find(*args) # :nodoc
  result_array = false
  args.each {|arg,val|
    if arg.class == Hash
      arg.each { |hkey,hval|
        if hkey == :array and hval == true
          result_array = true
        end
      }
    end
  }
  column_with = {}
  1.upto(last_column) do |col|
    column_with[cell(@header_line,col)] = col
  end
  result = Array.new
  #-- id
  if args[0].class == Fixnum
    rownum = args[0]
    if @header_line
      tmp = {}
    else
      tmp = []
    end
    1.upto(self.row(rownum).size) {|j|
      x = ''
      column_with.each { |key,val|
        if val == j
          x = key
        end
      }
      if @header_line
        tmp[x] = cell(rownum,j)
      else
        tmp[j-1] = cell(rownum,j)
      end

    }
    if @header_line
      result = [ tmp ]
    else
      result = tmp
    end
    #-- :all
  elsif args[0] == :all
    if args[1].class == Hash
      args[1].each {|key,val|
        if key == :conditions
          column_with = {}
          1.upto(last_column) do |col|
            column_with[cell(@header_line,col)] = col
          end
          conditions = val
          first_row.upto(last_row) do |i|
            # are all conditions met?
            found = 1
            conditions.each { |key,val|
              if cell(i,column_with[key]) == val
                found *= 1
              else
                found *= 0
              end
            }
            if found > 0
              tmp = {}
              1.upto(self.row(i).size) {|j|
                x = ''
                column_with.each { |key,val|
                  if val == j
                    x = key
                  end
                }
                tmp[x] = cell(i,j)
              }
              if result_array
                result << self.row(i)
              else
                result << tmp
              end
            end
          end
        end # :conditions
      }
    end
  end
  result
end

- (Object) first_column(sheet = nil)

returns the number of the first non-empty column



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/roo/generic_spreadsheet.rb', line 85

def first_column(sheet=nil)
  if sheet == nil
    sheet = @default_sheet
  end
  read_cells(sheet) unless @cells_read[sheet]
  if @first_column[sheet]
    return @first_column[sheet]
  end
  impossible_value = 999_999 # more than a spreadsheet can hold
  result = impossible_value
  @cell[sheet].each_pair {|key,value|
    y,x = key # _to_string(key).split(',')
    x = x # .to_i
    result = [result, x].min if value
  } if @cell[sheet]
  result = nil if result == impossible_value
  @first_column[sheet] = result
  result
end

- (Object) first_column_as_letter(sheet = nil)

first non-empty column as a letter



35
36
37
# File 'lib/roo/generic_spreadsheet.rb', line 35

def first_column_as_letter(sheet=nil)
  GenericSpreadsheet.number_to_letter(first_column(sheet))
end

- (Object) first_row(sheet = nil)

returns the number of the first non-empty row



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/roo/generic_spreadsheet.rb', line 45

def first_row(sheet=nil)
  if sheet == nil
    sheet = @default_sheet
  end
  read_cells(sheet) unless @cells_read[sheet]
  if @first_row[sheet]
    return @first_row[sheet]
  end
  impossible_value = 999_999 # more than a spreadsheet can hold
  result = impossible_value
  @cell[sheet].each_pair {|key,value|
    y,x = key # _to_string(key).split(',')
    y = y.to_i
    result = [result, y].min if value
  } if @cell[sheet]
  result = nil if result == impossible_value
  @first_row[sheet] = result
  result
end

- (Object) info

Returns information of the spreadsheet document and all sheets within this document.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/roo/generic_spreadsheet.rb', line 313

def info
  result = "File: #{File.basename(@filename)}\n"+
    "Number of sheets: #{sheets.size}\n"+
    "Sheets: #{sheets.map{|sheet| sheet+", "}.to_s[0..-3]}\n"
  n = 1
  sheets.each {|sheet|
    self.default_sheet = sheet
    result << "Sheet " + n.to_s + ":\n"
    unless first_row
      result << "  - empty -"
    else
      result << "  First row: #{first_row}\n"
      result << "  Last row: #{last_row}\n"
      result << "  First column: #{GenericSpreadsheet.number_to_letter(first_column)}\n"
      result << "  Last column: #{GenericSpreadsheet.number_to_letter(last_column)}"
    end
    result << "\n" if sheet != sheets.last
    n += 1
  }
  result
end

- (Object) last_column(sheet = nil)

returns the number of the last non-empty column



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/roo/generic_spreadsheet.rb', line 106

def last_column(sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  if @last_column[sheet]
    return @last_column[sheet]
  end
  impossible_value = 0
  result = impossible_value
  @cell[sheet].each_pair {|key,value|
    y,x = key # _to_string(key).split(',')
    x = x.to_i
    result = [result, x].max if value
  } if @cell[sheet]
  result = nil if result == impossible_value
  @last_column[sheet] = result
  result
end

- (Object) last_column_as_letter(sheet = nil)

last non-empty column as a letter



40
41
42
# File 'lib/roo/generic_spreadsheet.rb', line 40

def last_column_as_letter(sheet=nil)
  GenericSpreadsheet.number_to_letter(last_column(sheet))
end

- (Object) last_row(sheet = nil)

returns the number of the last non-empty row



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/roo/generic_spreadsheet.rb', line 66

def last_row(sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  if @last_row[sheet]
    return @last_row[sheet]
  end
  impossible_value = 0
  result = impossible_value
  @cell[sheet].each_pair {|key,value|
    y,x = key # _to_string(key).split(',')
    y = y.to_i
    result = [result, y].max if value
  } if @cell[sheet]
  result = nil if result == impossible_value
  @last_row[sheet] = result
  result
end

- (Object) reload

reopens and read a spreadsheet document



283
284
285
286
287
288
289
290
# File 'lib/roo/generic_spreadsheet.rb', line 283

def reload
  ds = @default_sheet
  initialize(@filename) if self.class == Openoffice or
    self.class == Excel
  initialize(@spreadsheetkey,@user,@password) if self.class == Google
  self.default_sheet = ds
  #@first_row = @last_row = @first_column = @last_column = nil
end

- (Object) remove_tmp

recursively removes the current temporary directory this is only needed if you work with zipped files or files via the web



305
306
307
308
309
# File 'lib/roo/generic_spreadsheet.rb', line 305

def remove_tmp
  if File.exists?(@tmpdir)
    FileUtils::rm_r(@tmpdir)
  end
end

- (Object) row(rownumber, sheet = nil)

returns all values in this row as an array row numbers are 1,2,3,… like in the spreadsheet



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

def row(rownumber,sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  result = []
  first_column(sheet).upto(last_column(sheet)) do |col|
    result << cell(rownumber,col,sheet)
  end
  result
end

- (Object) to_csv(filename = nil, sheet = nil)

write the current spreadsheet to stdout or into a file



152
153
154
155
156
157
158
159
160
161
162
# File 'lib/roo/generic_spreadsheet.rb', line 152

def to_csv(filename=nil,sheet=nil)
  sheet = @default_sheet unless sheet
  if filename
    file = File.open(filename,"w") # do |file|
    write_csv_content(file,sheet)
    file.close
  else
    write_csv_content(STDOUT,sheet)
  end
  true
end

- (Object) to_xml



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
# File 'lib/roo/generic_spreadsheet.rb', line 335

def to_xml
  xml_document = ''
  xml = Builder::XmlMarkup.new(:target => xml_document, :indent => 2)
  xml.instruct! :xml, :version =>"1.0", :encoding => "utf-8"
  xml.spreadsheet {
    self.sheets.each do |sheet|
      self.default_sheet = sheet
      xml.sheet(:name => sheet) { |x|
        if first_row and last_row and first_column and last_column
          # sonst gibt es Fehler bei leeren Blaettern
          first_row.upto(last_row) do |row|
            first_column.upto(last_column) do |col|
              unless empty?(row,col)
                x.cell(cell(row,col),
                  :row =>row,
                  :column => col,
                  :type => celltype(row,col))
              end
            end
          end
        end
      }
    end
  }
  xml_document
end

- (Object) to_yaml(prefix = {}, from_row = nil, from_column = nil, to_row = nil, to_column = nil, sheet = nil)

returns a rectangular area (default: all cells) as yaml-output you can add additional attributes with the prefix parameter like: oo.to_yaml(“sheet” => “1”)



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/roo/generic_spreadsheet.rb', line 127

def to_yaml(prefix={}, from_row=nil, from_column=nil, to_row=nil, to_column=nil,sheet=nil)
  sheet = @default_sheet unless sheet
  result = "--- \n"
  (from_row||first_row(sheet)).upto(to_row||last_row(sheet)) do |row|
    (from_column||first_column(sheet)).upto(to_column||last_column(sheet)) do |col|
      unless empty?(row,col,sheet)
        result << "cell_#{row}_#{col}: \n"
        prefix.each {|k,v|
          result << "  #{k}: #{v} \n"
        }
        result << "  row: #{row} \n"
        result << "  col: #{col} \n"
        result << "  celltype: #{self.celltype(row,col,sheet)} \n"
        if self.celltype(row,col,sheet) == :time
          result << "  value: #{GenericSpreadsheet.integer_to_timestring( self.cell(row,col,sheet))} \n"
        else
          result << "  value: #{self.cell(row,col,sheet)} \n"
        end
      end
    end
  end
  result
end