Class: RubyXL::Workbook

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

Overview

Constant Summary collapse

CONTENT_TYPE =
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml'.freeze
CONTENT_TYPE_TEMPLATE =
'application/vnd.openxmlformats-officedocument.spreadsheetml.template.main+xml'.freeze
CONTENT_TYPE_TEMPLATE_WITH_MACROS =
'application/vnd.ms-excel.template.macroEnabled.main+xml'.freeze
CONTENT_TYPE_WITH_MACROS =
'application/vnd.ms-excel.sheet.macroEnabled.main+xml'.freeze
REL_TYPE =
'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'.freeze
SHEET_NAME_FORBIDDEN_CHARS =
/[\/\\*\[\]:?]/
SHEET_NAME_FORBIDDEN_NAMES =
[ 'History' ]
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'
SHEET_NAME_TEMPLATE =
'Sheet%d'

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

Attributes included from OOXMLObjectInstanceMethods

#local_namespaces

Instance Method Summary collapse

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 = [], src_file_path = nil, creator = nil, modifier = nil, created_at = nil, company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0, is_template = false) ⇒ Workbook

Returns a new instance of Workbook.


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
# File 'lib/rubyXL/objects/workbook.rb', line 446

def initialize(worksheets = [], src_file_path = nil, creator = nil, modifier = nil, created_at = nil,
               company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0,
               is_template = false)
  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.source_file_path    = src_file_path

  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
  self.is_template = is_template
end

Instance Attribute Details

#is_templateObject

Returns the value of attribute is_template.


366
367
368
# File 'lib/rubyXL/objects/workbook.rb', line 366

def is_template
  @is_template
end

#worksheetsObject

Returns the value of attribute worksheets.


366
367
368
# File 'lib/rubyXL/objects/workbook.rb', line 366

def worksheets
  @worksheets
end

Instance Method Details

#[](ind) ⇒ Object

Finds worksheet by its name or numerical index


479
480
481
482
483
484
# File 'lib/rubyXL/objects/workbook.rb', line 479

def [](ind)
  case ind
  when Integer then worksheets[ind]
  when String  then worksheets.find { |ws| ws.sheet_name == ind }
  end
end

#add_worksheet(name = nil) ⇒ Object

Create new simple worksheet and add it to the workbook worksheets

Parameters:

  • The (String)

    name for the new worksheet


489
490
491
492
493
494
495
496
497
498
499
500
501
# File 'lib/rubyXL/objects/workbook.rb', line 489

def add_worksheet(name = nil)
  if name.nil? then
    n = 0

    begin
      name = SHEET_NAME_TEMPLATE % (n += 1)
    end until self[name].nil?
  end

  new_worksheet = Worksheet.new(:workbook => self, :sheet_name => name)
  worksheets << new_worksheet
  new_worksheet
end

#applicationObject


528
529
530
# File 'lib/rubyXL/objects/workbook.rb', line 528

def application
  root.document_properties.application && root.document_properties.application.value
end

#application=(v) ⇒ Object


532
533
534
535
# File 'lib/rubyXL/objects/workbook.rb', line 532

def application=(v)
  root.document_properties.application ||= StringNode.new
  root.document_properties.application.value = v
end

#appversionObject


537
538
539
# File 'lib/rubyXL/objects/workbook.rb', line 537

def appversion
  root.document_properties.app_version && root.document_properties.app_version.value
end

#appversion=(v) ⇒ Object


541
542
543
544
# File 'lib/rubyXL/objects/workbook.rb', line 541

def appversion=(v)
  root.document_properties.app_version ||= StringNode.new
  root.document_properties.app_version.value = v
end

#before_write_xmlObject


368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/rubyXL/objects/workbook.rb', line 368

def before_write_xml
  max_sheet_id = worksheets.collect(&:sheet_id).compact.max || 0

  self.sheets = RubyXL::Sheets.new

  worksheets.each { |sheet, i|
    rel = relationship_container.find_by_target(sheet.xlsx_path)

    raise "Worksheet name '#{sheet.sheet_name}' contains forbidden characters" if sheet.sheet_name =~ SHEET_NAME_FORBIDDEN_CHARS
    raise "Worksheet name '#{sheet.sheet_name}' is forbidden" if SHEET_NAME_FORBIDDEN_NAMES.include?(sheet.sheet_name)

    sheets << RubyXL::Sheet.new(:name     => sheet.sheet_name[0..30], # Max sheet name length is 31 char
                                :sheet_id => sheet.sheet_id || (max_sheet_id += 1),
                                :state    => sheet.state,
                                :r_id     => rel.id)
  }

  true
end

#companyObject


519
520
521
# File 'lib/rubyXL/objects/workbook.rb', line 519

def company
  root.document_properties.company && root.document_properties.company.value
end

#company=(v) ⇒ Object


523
524
525
526
# File 'lib/rubyXL/objects/workbook.rb', line 523

def company=(v)
  root.document_properties.company ||= StringNode.new
  root.document_properties.company.value = v
end

#content_typeObject


313
314
315
316
317
318
# File 'lib/rubyXL/objects/workbook.rb', line 313

def content_type
  content_type_name = 'CONTENT_TYPE'
  content_type_name << '_TEMPLATE' if is_template
  content_type_name << '_WITH_MACROS' if macros
  self.class.const_get(content_type_name)
end

#created_atObject


503
504
505
# File 'lib/rubyXL/objects/workbook.rb', line 503

def created_at
  root.core_properties.created_at
end

#created_at=(v) ⇒ Object


507
508
509
# File 'lib/rubyXL/objects/workbook.rb', line 507

def created_at=(v)
  root.core_properties.created_at = v
end

#creatorObject


546
547
548
# File 'lib/rubyXL/objects/workbook.rb', line 546

def creator
  root.core_properties.creator
end

#creator=(v) ⇒ Object


550
551
552
# File 'lib/rubyXL/objects/workbook.rb', line 550

def creator=(v)
  root.core_properties.creator = v
end

#date1904Object


562
563
564
# File 'lib/rubyXL/objects/workbook.rb', line 562

def date1904
  workbook_properties && workbook_properties.date1904
end

#date1904=(v) ⇒ Object


566
567
568
569
# File 'lib/rubyXL/objects/workbook.rb', line 566

def date1904=(v)
  self.workbook_properties ||= RubyXL::WorkbookProperties.new
  workbook_properties.date1904 = v
end

#date_to_num(date) ⇒ Object


422
423
424
425
426
427
# File 'lib/rubyXL/objects/workbook.rb', line 422

def date_to_num(date)
  case date
  when Date, DateTime then (date.ajd - base_date.ajd).to_f
  when Time then ((date.to_r - base_date.to_time.to_r) / 86400).to_f
  end
end

#modified_atObject


511
512
513
# File 'lib/rubyXL/objects/workbook.rb', line 511

def modified_at
  root.core_properties.modified_at
end

#modified_at=(v) ⇒ Object


515
516
517
# File 'lib/rubyXL/objects/workbook.rb', line 515

def modified_at=(v)
  root.core_properties.modified_at = v
end

#modifierObject


554
555
556
# File 'lib/rubyXL/objects/workbook.rb', line 554

def modifier
  root.core_properties.modifier
end

#modifier=(v) ⇒ Object


558
559
560
# File 'lib/rubyXL/objects/workbook.rb', line 558

def modifier=(v)
  root.core_properties.modifier = v
end

#num_to_date(num) ⇒ Object


429
430
431
432
433
434
435
436
437
438
439
# File 'lib/rubyXL/objects/workbook.rb', line 429

def num_to_date(num)
  return nil if num.nil?

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

  dateparts = num.divmod(1)
  base_date + (dateparts[0] + (dateparts[1] * 86400).round(6) / 86400)
end

320
321
322
# File 'lib/rubyXL/objects/workbook.rb', line 320

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

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

Save the resulting XLSX file to the specified location


398
399
400
401
402
403
404
405
406
407
408
409
# File 'lib/rubyXL/objects/workbook.rb', line 398

def save(dst_file_path = nil)
  dst_file_path ||= root.source_file_path

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

  File.open(dst_file_path, 'wb') { |output_file| FileUtils.copy_stream(root.stream, output_file) }

  return dst_file_path
end

#streamObject

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


393
394
395
# File 'lib/rubyXL/objects/workbook.rb', line 393

def stream
  root.stream
end

#xlsx_pathObject


388
389
390
# File 'lib/rubyXL/objects/workbook.rb', line 388

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