Class: RubyXL::Workbook

Inherits:
OOXMLTopLevelObject show all
Includes:
Enumerable, RelationshipSupport, WorkbookConvenienceMethods
Defined in:
lib/rubyXL/objects/workbook.rb

Overview

www.schemacentral.com/sc/ooxml/e-ssml_workbook.html

Constant Summary collapse

CONTENT_TYPE = 
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml'
CONTENT_TYPE_MACRO = 
'application/vnd.ms-excel.sheet.macroEnabled.main+xml'
REL_TYPE = 
'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
DATE1904 = 
DateTime.new(1904, 1, 1)
DATE1899 =

Subtracting one day to accomodate for erroneous 1900 leap year compatibility only for 1900 based dates

DateTime.new(1899, 12, 31) - 1
MARCH_1_1900 = 
61
APPLICATION = 
'Microsoft Macintosh Excel'
APPVERSION = 
'12.0000'
@@debug = 
nil

Constants included from WorkbookConvenienceMethods

RubyXL::WorkbookConvenienceMethods::SHEET_NAME_TEMPLATE

Constants inherited from OOXMLTopLevelObject

OOXMLTopLevelObject::ROOT, OOXMLTopLevelObject::SAVE_ORDER

Instance Attribute Summary collapse

Attributes included from RelationshipSupport

#generic_storage, #relationship_container

Attributes inherited from OOXMLTopLevelObject

#root

Instance Method Summary collapse

Methods included from WorkbookConvenienceMethods

#[], #add_worksheet, #application, #application=, #appversion, #appversion=, #borders, #cell_xfs, #company, #company=, #created_at, #created_at=, #creator, #creator=, #date1904, #date1904=, #each, #fills, #fonts, #get_fill_color, #modified_at, #modified_at=, #modifier, #modifier=, #modify_alignment, #modify_border, #modify_fill, #register_new_fill, #register_new_font, #register_new_xf

Methods included from RelationshipSupport

#attach_relationship, #collect_related_objects, included, #load_relationships, #store_relationship

Methods inherited from OOXMLTopLevelObject

#add_to_zip, #file_index, parse_file, set_namespaces

Methods included from OOXMLObjectInstanceMethods

#==, included, #index_in_collection, #write_xml

Constructor Details

#initialize(worksheets = [], filepath = nil, creator = nil, modifier = nil, created_at = nil, company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0) ⇒ Workbook

Returns a new instance of Workbook.



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/rubyXL/objects/workbook.rb', line 424

def initialize(worksheets = [], filepath = nil, creator = nil, modifier = nil, created_at = nil,
               company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0)
  super()

  # Order of sheets in the +worksheets+ array corresponds to the order of pages in Excel UI.
  # SheetId's, rId's, etc. are completely unrelated to ordering.
  @worksheets = worksheets
  add_worksheet if @worksheets.empty?

  @theme                    = RubyXL::Theme.default
  @shared_strings_container = RubyXL::SharedStringsTable.new
  @stylesheet               = RubyXL::Stylesheet.default
  @relationship_container   = RubyXL::OOXMLRelationshipsFile.new
  @root                     = RubyXL::WorkbookRoot.default
  @root.workbook            = self
  @root.filepath            = filepath

  creation_time = DateTime.parse(created_at) rescue DateTime.now
  self.created_at  = creation_time
  self.modified_at = creation_time
  self.company     = company
  self.application = application
  self.appversion  = appversion
  self.creator     = creator
  self.modifier    = modifier
  self.date1904    = date1904 > 0
end

Instance Attribute Details

#worksheets ⇒ Object

Returns the value of attribute worksheets.



356
357
358
 
# File 'lib/rubyXL/objects/workbook.rb', line 356

def worksheets
  @worksheets
end

Instance Method Details

#before_write_xml ⇒ Object 



358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/rubyXL/objects/workbook.rb', line 358

def before_write_xml
  self.sheets = RubyXL::Sheets.new

  worksheets.each_with_index { |sheet, i|
    rel = relationship_container.find_by_target(sheet.xlsx_path)
    sheets << RubyXL::Sheet.new(:name => sheet.sheet_name[0..30], # Max sheet name length is 31 char
                                :sheet_id => sheet.sheet_id || (i + 1),
                                :state => sheet.state, :r_id => rel.id)
  }
  true
end

#content_type ⇒ Object 



307
308
309
 
# File 'lib/rubyXL/objects/workbook.rb', line 307

def content_type
  if macros then CONTENT_TYPE_MACRO else CONTENT_TYPE end
end

#date_to_num(date) ⇒ Object 



404
405
406
 
# File 'lib/rubyXL/objects/workbook.rb', line 404

def date_to_num(date)
  date && (date.ajd - base_date().ajd).to_f
end

#num_to_date(num) ⇒ Object 



408
409
410
411
412
413
414
415
 
# File 'lib/rubyXL/objects/workbook.rb', line 408

def num_to_date(num)
  # Bug-for-bug Excel compatibility (https://support.microsoft.com/kb/214058/)
  if num && num < MARCH_1_1900 then
    num += 1 unless workbook_properties && workbook_properties.date1904
  end

  num && (base_date + num)
end

#related_objects ⇒ Object 



312
313
314
 
# File 'lib/rubyXL/objects/workbook.rb', line 312

def related_objects
  [ calculation_chain, stylesheet, theme, shared_strings_container, macros ] + @worksheets
end

#save(filepath = nil) ⇒ Object Also known as: write

Save the resulting XLSX file to the specified location



380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/rubyXL/objects/workbook.rb', line 380

def save(filepath = nil)
  filepath ||= root.filepath

  extension = File.extname(filepath)
  unless %w{.xlsx .xlsm}.include?(extension.downcase)
    raise "Unsupported extension: #{extension} (only .xlsx and .xlsm files are supported)."
  end

  File.open(filepath, "wb") { |output_file| FileUtils.copy_stream(root.stream, output_file) }

  return filepath
end

#stream ⇒ Object

Return the resulting XLSX file in a stream (useful for sending over HTTP)



375
376
377
 
# File 'lib/rubyXL/objects/workbook.rb', line 375

def stream
  root.stream
end

#xlsx_path ⇒ Object 



370
371
372
 
# File 'lib/rubyXL/objects/workbook.rb', line 370

def xlsx_path
  ROOT.join('xl', 'workbook.xml')
end