Method: FastExcel.open

Defined in:
lib/fast_excel.rb

.open(filename = nil, constant_memory: false, default_format: nil) ⇒ Object



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
# File 'lib/fast_excel.rb', line 25

def self.open(filename = nil, constant_memory: false, default_format: nil)
  tmp_file = false
  if filename
    if File.exist?(filename) && File.size(filename) > 0
      raise ArgumentError, "File '#{filename}' already exists. FastExcel can not open existing files, only create new files"
    end
  else
    require 'tmpdir'
    filename = "#{Dir.mktmpdir}/fast_excel.xlsx"
    tmp_file = true
  end

  filename = filename.to_s if defined?(Pathname) && filename.is_a?(Pathname)

  opt = Libxlsxwriter::WorkbookOptions.new
  opt[:constant_memory] = constant_memory ? 1 : 0
  workbook = Libxlsxwriter.workbook_new_opt(filename, opt)

  result = Libxlsxwriter::Workbook.new(workbook)

  if default_format
    raise "default_format argument must be a hash" unless default_format.is_a?(Hash)
    result.default_format.set(default_format)
  end

  result.tmp_file = tmp_file
  result.filename = filename
  result
end