rubyXL 3.3.22 → 3.4.25

data/lib/rubyXL/objects/workbook.rb

@@ -1,4 +1,3 @@
-#require 'tmpdir'
 require 'date'
 require 'rubyXL/objects/ooxml_object'
 require 'rubyXL/objects/shared_strings'
@@ -7,17 +6,16 @@ require 'rubyXL/objects/theme'
 require 'rubyXL/objects/calculation_chain'
 require 'rubyXL/objects/worksheet'
 require 'rubyXL/objects/chartsheet'
+require 'rubyXL/objects/connection'
 require 'rubyXL/objects/relationships'
 require 'rubyXL/objects/simple_types'
 require 'rubyXL/objects/extensions'
 require 'rubyXL/objects/external_links'
-require 'rubyXL/convenience_methods'
 
 module RubyXL
-
   # Eventually, the entire code for Workbook will be moved here.
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_fileVersion-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_fileVersion-1.html
   class FileVersion < OOXMLObject
     define_attribute(:appName,      :string)
     define_attribute(:lastEdited,   :string)
@@ -27,17 +25,17 @@ module RubyXL
     define_element_name 'fileVersion'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_fileSharing-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_fileSharing-1.html
   class FileSharing < OOXMLObject
     define_attribute(:readOnlyRecommended, :bool, :default => false)
     define_attribute(:userName,            :string)
-    define_attribute(:reservationPassword, :string)
+    define_attribute(:reservationPassword, RubyXL::ST_UnsignedShortHex)
     define_element_name 'fileSharing'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_workbookPr-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_workbookPr-1.html
   class WorkbookProperties < OOXMLObject
-    define_attribute(:date1904,                   :bool,   :default => false)
+    define_attribute(:date1904,                   :bool, :default => false)
     define_attribute(:showObjects,                RubyXL::ST_Objects, :default => 'all')
     define_attribute(:showBorderUnselectedTables, :bool,   :default => true)
     define_attribute(:filterPrivacy,              :bool,   :default => false)
@@ -58,17 +56,17 @@ module RubyXL
     define_element_name 'workbookPr'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_workbookProtection-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_workbookProtection-1.html
   class WorkbookProtection < OOXMLObject
-    define_attribute(:workbookPassword,  :string)
-    define_attribute(:revisionsPassword, :string)
+    define_attribute(:workbookPassword,  RubyXL::ST_UnsignedShortHex)
+    define_attribute(:revisionsPassword, RubyXL::ST_UnsignedShortHex)
     define_attribute(:lockStructure,     :bool,   :default => false)
     define_attribute(:lockWindows,       :bool,   :default => false)
     define_attribute(:lockRevision,      :bool,   :default => false)
     define_element_name 'workbookProtection'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_workbookView-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_workbookView-1.html
   class WorkbookView < OOXMLObject
     define_attribute(:visibility,             RubyXL::ST_Visibility, :default => 'visible')
     define_attribute(:minimized,              :bool,   :default => false)
@@ -87,40 +85,40 @@ module RubyXL
     define_element_name 'workbookView'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_bookViews-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_bookViews-1.html
   class WorkbookViews < OOXMLContainerObject
     define_child_node(RubyXL::WorkbookView, :collection => true)
     define_element_name 'bookViews'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_sheet-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheet-1.html
   class Sheet < OOXMLObject
     define_attribute(:name,            :string, :required => true)
     define_attribute(:sheetId,         :int,    :required => true)
     define_attribute(:state,           RubyXL::ST_Visibility, :default => 'visible')
-    define_attribute(:'r:id',          :string, :required => true)
+    define_relationship(:required => true)
     define_element_name 'sheet'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_sheets-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheets-1.html
   class Sheets < OOXMLContainerObject
     define_child_node(RubyXL::Sheet, :collection => true)
     define_element_name 'sheets'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_externalReference-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_externalReference-1.html
   class ExternalReference < OOXMLObject
-    define_attribute(:'r:id', :string, :required => true)
+    define_relationship(:required => true)
     define_element_name 'externalReference'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_externalReferences-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_externalReferences-1.html
   class ExternalReferences < OOXMLContainerObject
     define_child_node(RubyXL::ExternalReference, :collection => true)
     define_element_name 'externalReferences'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_definedName-2.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_definedName-2.html
   class DefinedName < OOXMLObject
     define_attribute(:name,              :string, :required => true)
     define_attribute(:comment,           :string)
@@ -144,32 +142,32 @@ module RubyXL
     define_element_name 'definedName'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_definedName-2.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_definedName-2.html
   class DefinedNames < OOXMLContainerObject
     define_child_node(RubyXL::DefinedName, :collection => true)
     define_element_name 'definedNames'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_pivotCache-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_pivotCache-1.html
   class PivotCache < OOXMLObject
-    define_attribute(:cacheId, :int,    :required => true)
-    define_attribute(:'r:id',  :string, :required => true)
+    define_attribute(:cacheId, :int, :required => true)
+    define_relationship(:required => true)
     define_element_name 'pivotCache'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_pivotCaches-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_pivotCaches-1.html
   class PivotCaches < OOXMLContainerObject
     define_child_node(RubyXL::PivotCache, :collection => true)
     define_element_name 'pivotCaches'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_oleSize-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_oleSize-1.html
   class OLESize < OOXMLObject
     define_attribute(:ref, :ref, :required => true)
     define_element_name 'oleSize'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_fileRecoveryPr-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_fileRecoveryPr-1.html
   class FileRecoveryProperties < OOXMLObject
     define_attribute(:autoRecover,     :bool, :default => true)
     define_attribute(:crashSave,       :bool, :default => false)
@@ -178,7 +176,7 @@ module RubyXL
     define_element_name 'fileRecoveryPr'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_webPublishing-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_webPublishing-1.html
   class WebPublishingProperties < OOXMLObject
     define_attribute(:css,              :bool,   :default => true)
     define_attribute(:thicket,          :bool,   :default => true)
@@ -186,16 +184,16 @@ module RubyXL
     define_attribute(:vml,              :bool,   :default => false)
     define_attribute(:allowPng,         :bool,   :default => false)
     define_attribute(:targetScreenSize, RubyXL::ST_TargetScreenSize, :default => '800x600')
-    define_attribute(:dpi,              :int,    :default => 96)
+    define_attribute(:dpi,              :int, :default => 96)
     define_attribute(:codePage,         :int)
     define_element_name 'webPublishing'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_calcPr-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_calcPr-1.html
   class CalculationProperties < OOXMLObject
     define_attribute(:calcId,                :int)
     define_attribute(:calcMode,              RubyXL::ST_CalcMode, :default => 'auto')
-    define_attribute(:fullCalcOnLoad,        :bool,   :default => false)
+    define_attribute(:fullCalcOnLoad,        :bool, :default => false)
     define_attribute(:refMode,               RubyXL::ST_RefMode, :default => 'A1')
     define_attribute(:iterate,               :bool,   :default => false)
     define_attribute(:iterateCount,          :int,    :default => 100)
@@ -209,31 +207,31 @@ module RubyXL
     define_element_name 'calcPr'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_webPublishObject-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_webPublishObject-1.html
   class WebPublishObject < OOXMLObject
     define_attribute(:id,              :int,    :required => true)
     define_attribute(:divId,           :string, :required => true)
     define_attribute(:sourceObject,    :string)
     define_attribute(:destinationFile, :string, :required => true)
     define_attribute(:title,           :string)
-    define_attribute(:autoRepublish,   :bool,   :default => false)
+    define_attribute(:autoRepublish,   :bool, :default => false)
     define_element_name 'webPublishObject'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_webPublishObjects-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_webPublishObjects-1.html
   class WebPublishObjects < OOXMLContainerObject
     define_child_node(RubyXL::WebPublishObject, :collection => :with_count)
     define_element_name 'webPublishObjects'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_smartTagPr-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_smartTagPr-1.html
   class SmartTagProperties < OOXMLObject
-    define_attribute(:embed, :bool,   :default => false)
+    define_attribute(:embed, :bool, :default => false)
     define_attribute(:show,  RubyXL::ST_SmartTagShow, :default => 'all')
     define_element_name 'smartTagPr'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_smartTagType-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_smartTagType-1.html
   class SmartTagType < OOXMLObject
     define_attribute(:namespaceUri, :string)
     define_attribute(:name,         :string)
@@ -241,26 +239,26 @@ module RubyXL
     define_element_name 'smartTagType'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_smartTagTypes-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_smartTagTypes-1.html
   class SmartTagTypes < OOXMLContainerObject
     define_child_node(RubyXL::SmartTagType, :collection => true)
     define_element_name 'smartTagTypes'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_functionGroup-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_functionGroup-1.html
   class FunctionGroup < OOXMLObject
     define_attribute(:name, :string)
     define_element_name 'functionGroup'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_functionGroups-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_functionGroups-1.html
   class FunctionGroups < OOXMLContainerObject
     define_attribute(:builtInGroupCountpi, :int, :default => 16)
     define_child_node(RubyXL::FunctionGroup, :collection => true)
     define_element_name 'functionGroups'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_customWorkbookView-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_customWorkbookView-1.html
   class CustomWorkbookView < OOXMLObject
     define_attribute(:name,                 :string, :required => true)
     define_attribute(:guid,                 :string, :required => true)
@@ -280,7 +278,7 @@ module RubyXL
     define_attribute(:yWindow,              :int,    :default => 0)
     define_attribute(:windowWidth,          :int)
     define_attribute(:windowHeight,         :int)
-    define_attribute(:tabRatio,             :int,    :default => 600)
+    define_attribute(:tabRatio,             :int, :default => 600)
     define_attribute(:activeSheetId,        :int)
     define_attribute(:showFormulaBar,       :bool,   :default => true)
     define_attribute(:showStatusbar,        :bool,   :default => true)
@@ -290,26 +288,33 @@ module RubyXL
     define_element_name 'customWorkbookView'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_customWorkbookViews-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_customWorkbookViews-1.html
   class CustomWorkbookViews < OOXMLContainerObject
     define_child_node(RubyXL::CustomWorkbookView, :collection => true)
     define_element_name 'customWorkbookViews'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_workbook.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_workbook.html
   class Workbook < OOXMLTopLevelObject
-    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml'
-    CONTENT_TYPE_WITH_MACROS = 'application/vnd.ms-excel.sheet.macroEnabled.main+xml'
-    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
+    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
 
     # http://www.accountingweb.com/technology/excel/seven-characters-you-cant-use-in-worksheet-names
-    SHEET_NAME_FORBIDDEN_CHARS = /[\/\\\*\[\]\:\?]/
-    #SHEET_NAME_FORBIDDEN_NAMES = [ 'History' ]
+    SHEET_NAME_FORBIDDEN_CHARS = /[\/\\*\[\]:?]/
+
+    # https://answers.microsoft.com/en-us/msoffice/forum/all/excel-history-is-a-reserved-name-help/f8a398a4-b72c-48e3-82da-4f132c305e91
+    SHEET_NAME_FORBIDDEN_NAMES = [ 'History' ]
 
     include RubyXL::RelationshipSupport
 
     def content_type
-      if macros then CONTENT_TYPE_WITH_MACROS else CONTENT_TYPE end
+      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
 
     def related_objects
@@ -322,16 +327,18 @@ module RubyXL
     define_relationship(RubyXL::CalculationChain,   :calculation_chain)
     define_relationship(RubyXL::Worksheet,          false)
     define_relationship(RubyXL::Chartsheet,         false)
+    define_relationship(RubyXL::Connections)
     define_relationship(RubyXL::ExternalLinksFile)
     define_relationship(RubyXL::PivotCacheDefinitionFile)
     define_relationship(RubyXL::PivotCacheRecordsFile)
     define_relationship(RubyXL::CustomXMLFile)
-    define_relationship(RubyXL::MacrosFile,         :macros)
+    define_relationship(RubyXL::MacrosFile, :macros)
     define_relationship(RubyXL::SlicerCacheFile)
 
     define_child_node(RubyXL::FileVersion)
     define_child_node(RubyXL::FileSharing)
     define_child_node(RubyXL::WorkbookProperties, :accessor => :workbook_properties)
+    define_child_node(RubyXL::RevisionPointer)
     define_child_node(RubyXL::AlternateContent) # Somehow, order matters here
     define_child_node(RubyXL::WorkbookProtection)
     define_child_node(RubyXL::WorkbookViews)
@@ -351,12 +358,12 @@ module RubyXL
     define_child_node(RubyXL::ExtensionStorageArea)
 
     define_element_name 'workbook'
-    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => nil,
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main'           => nil,
                    'http://schemas.openxmlformats.org/officeDocument/2006/relationships' => 'r',
-                   'http://schemas.openxmlformats.org/markup-compatibility/2006' => 'mc',
-                   'http://schemas.microsoft.com/office/spreadsheetml/2010/11/main' => 'x15')
+                   'http://schemas.openxmlformats.org/markup-compatibility/2006'         => 'mc',
+                   'http://schemas.microsoft.com/office/spreadsheetml/2010/11/main'      => 'x15')
 
-    attr_accessor :worksheets
+    attr_accessor :worksheets, :is_template
 
     def before_write_xml
       max_sheet_id = worksheets.collect(&:sheet_id).compact.max || 0
@@ -367,6 +374,7 @@ module RubyXL
         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),
@@ -391,11 +399,11 @@ module RubyXL
       dst_file_path ||= root.source_file_path
 
       extension = File.extname(dst_file_path)
-      unless %w{.xlsx .xlsm}.include?(extension.downcase)
-        raise "Unsupported extension: #{extension} (only .xlsx and .xlsm files are supported)."
+      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) }
+      File.open(dst_file_path, 'wb') { |output_file| FileUtils.copy_stream(root.stream, output_file) }
 
       return dst_file_path
     end
@@ -412,16 +420,22 @@ module RubyXL
     private :base_date
 
     def date_to_num(date)
-      date && (date.ajd - base_date().ajd).to_f
+      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
 
     def num_to_date(num)
+      return nil if num.nil?
+
       # Bug-for-bug Excel compatibility (https://support.microsoft.com/kb/214058/)
-      if num && num < MARCH_1_1900 then
+      if num < MARCH_1_1900 then
         num += 1 unless workbook_properties && workbook_properties.date1904
       end
 
-      num && (base_date + num)
+      dateparts = num.divmod(1)
+      base_date + (dateparts[0] + (dateparts[1] * 86400).round(6) / 86400)
     end
 
     include Enumerable
@@ -430,7 +444,8 @@ module RubyXL
     APPVERSION  = '12.0000'
 
     def initialize(worksheets = [], src_file_path = nil, creator = nil, modifier = nil, created_at = nil,
-                   company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0)
+                   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.
@@ -455,9 +470,102 @@ module RubyXL
       self.creator     = creator
       self.modifier    = modifier
       self.date1904    = date1904 > 0
+      self.is_template = is_template
     end
 
-    include WorkbookConvenienceMethods
-  end
+    SHEET_NAME_TEMPLATE = 'Sheet%d'
+
+    # Finds worksheet by its name or numerical index
+    def [](ind)
+      case ind
+      when Integer then worksheets[ind]
+      when String  then worksheets.find { |ws| ws.sheet_name == ind }
+      end
+    end
+
+    # Create new simple worksheet and add it to the workbook worksheets
+    #
+    # @param [String] The name for the new worksheet
+    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
+
+    def created_at
+      root.core_properties.created_at
+    end
+
+    def created_at=(v)
+      root.core_properties.created_at = v
+    end
+
+    def modified_at
+      root.core_properties.modified_at
+    end
+
+    def modified_at=(v)
+      root.core_properties.modified_at = v
+    end
+
+    def company
+      root.document_properties.company && root.document_properties.company.value
+    end
 
+    def company=(v)
+      root.document_properties.company ||= StringNode.new
+      root.document_properties.company.value = v
+    end
+
+    def application
+      root.document_properties.application && root.document_properties.application.value
+    end
+
+    def application=(v)
+      root.document_properties.application ||= StringNode.new
+      root.document_properties.application.value = v
+    end
+
+    def appversion
+      root.document_properties.app_version && root.document_properties.app_version.value
+    end
+
+    def appversion=(v)
+      root.document_properties.app_version ||= StringNode.new
+      root.document_properties.app_version.value = v
+    end
+
+    def creator
+      root.core_properties.creator
+    end
+
+    def creator=(v)
+      root.core_properties.creator = v
+    end
+
+    def modifier
+      root.core_properties.modifier
+    end
+
+    def modifier=(v)
+      root.core_properties.modifier = v
+    end
+
+    def date1904
+      workbook_properties && workbook_properties.date1904
+    end
+
+    def date1904=(v)
+      self.workbook_properties ||= RubyXL::WorkbookProperties.new
+      workbook_properties.date1904 = v
+    end
+  end
 end