Class: Excelx

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

Constant Summary collapse

@@nr =

$log = Logger.new(“excelx.log”,5,100*1024) $log.level = Logger::DEBUG

0

Instance Attribute Summary

Attributes inherited from GenericSpreadsheet

#default_sheet, #header_line

Instance Method Summary collapse

Methods inherited from GenericSpreadsheet

#empty?, #find, #first_column, #first_column_as_letter, #first_row, #info, #last_column, #last_column_as_letter, #last_row, letter_to_number, #normalize, number_to_letter, #open_from_uri, #reload, #remove_tmp, #to_csv, #to_xml, #to_yaml

Constructor Details

#initialize(filename, packed = nil) ⇒ Excelx

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



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
68
69
70
71
72
73
74
75
 
# File 'lib/roo/excelx.rb', line 22

def initialize(filename, packed=nil) #, create = false)
  @tmpdir = "oo_"+$$.to_s
  unless File.exists?(@tmpdir)
    FileUtils::mkdir(@tmpdir)
  end
  filename = open_from_uri(filename) if filename[0,7] == "http://"
  filename = unzip(filename) if packed and packed == :zip
  if File.extname(filename) != ".xlsx"
    warn "are you sure, this is an Excel-xlsx file?"
  end
  @cells_read = Hash.new
  @filename = filename
  begin
    unless File.file?(@filename)
      raise IOError, "file #{@filename} does not exist"
    end
    @@nr += 1
    @file_nr = @@nr
    extract_content(@filename)
    file = File.new(File.join(@tmpdir, @file_nr.to_s+"_roo_workbook.xml"))
    @workbook_doc = REXML::Document.new file
    file.close
    @shared_table = []
    if File.exist?(File.join(@tmpdir, @file_nr.to_s+'_roo_sharedStrings.xml'))
      file = File.new(File.join(@tmpdir, @file_nr.to_s+'_roo_sharedStrings.xml'))
      @sharedstring_doc = REXML::Document.new file
      file.close
      read_shared_strings(@sharedstring_doc)
    end
    @sheet_doc = []
    @sheet_files.each_with_index do |item, i|
      file = File.new(item)
      @sheet_doc[i] = REXML::Document.new file
      file.close
    end
  ensure
    #if ENV["roo_local"] != "thomas-p"
    FileUtils::rm_r(@tmpdir)
    #end
  end
  @default_sheet = nil
  # no need to set default_sheet if there is only one sheet in the document
  if self.sheets.size == 1
    @default_sheet = self.sheets.first
  end
  @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
  @header_line = 1
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.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/roo/excelx.rb', line 81

def cell(row, col, sheet=nil)
  sheet = @default_sheet unless 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}"].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



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/roo/excelx.rb', line 137

def celltype(row,col,sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  if @formula and @formula[sheet] and @formula[sheet]["#{row},#{col}"]
    return :formula
  else
    @cell_type[sheet]["#{row},#{col}"]
  end
end

#column(columnnumber, sheet = nil) ⇒ Object

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



195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/roo/excelx.rb', line 195

def column(columnnumber,sheet=nil)
  if columnnumber.class == String
    columnnumber = GenericSpreadsheet.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

#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.



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/roo/excelx.rb', line 95

def formula(row,col,sheet=nil)
  sheet = @default_sheet unless 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}"]
  end
end

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

true, if there is a formula

Returns:

  • (Boolean) 


107
108
109
110
111
112
 
# File 'lib/roo/excelx.rb', line 107

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


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

def formulas(sheet=nil)
  theformulas = Array.new
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  first_row(sheet).upto(last_row(sheet)) {|row|
    first_column(sheet).upto(last_column(sheet)) {|col|
      if formula?(row,col,sheet)
        f = [row, col, formula(row,col,sheet)]
        theformulas << f
      end
    }
  }
  theformulas
end

#row(rownumber, sheet = nil) ⇒ Object

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/roo/excelx.rb', line 173

def row(rownumber,sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  result = []
  tmp_arr = []
  @cell[sheet].each_pair {|key,value|
    y,x = key.split(',')
    x = x.to_i
    y = y.to_i
    if y == rownumber
      tmp_arr[x] = value
    end
  }
  result = tmp_arr[1..-1]
  while result[-1] == nil
    result = result[0..-2]
  end
  result
end

#set(row, col, value, sheet = nil) ⇒ Object

set a cell to a certain value (this will not be saved back to the spreadsheet file!)



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/roo/excelx.rb', line 116

def set(row,col,value,sheet=nil) #:nodoc:
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  set_value(row,col,value,sheet)
  if value.class == Fixnum
    set_type(row,col,:float,sheet)
  elsif value.class == String
    set_type(row,col,:string,sheet)
  elsif value.class == Float
    set_type(row,col,:string,sheet)
  else
    raise ArgumentError, "Type for "+value.to_s+" not set"
  end
end

#sheets ⇒ Object

returns an array of sheet names in the spreadsheet



149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/roo/excelx.rb', line 149

def sheets
  return_sheets = []
  @workbook_doc.each_element do |workbook|
    workbook.each_element do |el|
      if el.name == "sheets"
        el.each_element do |sheet|
          return_sheets << sheet.attributes['name']
        end
      end
    end
  end
  return_sheets
end

#to_s(sheet = nil) ⇒ Object

shows the internal representation of all cells for debugging purposes



165
166
167
168
169
 
# File 'lib/roo/excelx.rb', line 165

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