rubyXL 3.3.29 → 3.4.33

data/lib/rubyXL/objects/text.rb

@@ -4,7 +4,6 @@ require 'rubyXL/objects/container_nodes'
 require 'rubyXL/objects/color'
 
 module RubyXL
-
   # http://www.datypic.com/sc/ooxml/e-ssml_t-1.html
   class Text < OOXMLObject
     define_attribute(:_,           :string, :accessor => :value)
@@ -19,12 +18,12 @@ module RubyXL
 
     def before_write_xml
       preserve_whitespace
-      self.value.gsub!(INVALID_XML10_CHARS) { |c| "_x%04x_" % c.ord }
+      self.value.gsub(INVALID_XML10_CHARS) { |bad_char| format('_x%04x_', bad_char.ord) }
       true
     end
 
     def to_s
-      value.to_s.gsub(ESCAPED_UNICODE) { |m| $1.hex.chr(::Encoding::UTF_8) }
+      value.to_s.gsub(ESCAPED_UNICODE) { Regexp.last_match(1).hex.chr(::Encoding::UTF_8) }
     end
   end
 
@@ -57,7 +56,6 @@ module RubyXL
     def to_s
       t.to_s
     end
-
   end
 
   # http://www.datypic.com/sc/ooxml/e-ssml_rPh-1.html
@@ -70,7 +68,7 @@ module RubyXL
 
   # http://www.datypic.com/sc/ooxml/e-ssml_phoneticPr-1.html
   class PhoneticProperties < OOXMLObject
-    define_attribute(:fontId,    :int,    :required => true)
+    define_attribute(:fontId,    :int, :required => true)
     define_attribute(:type,      RubyXL::ST_PhoneticType,      :default => 'fullwidthKatakana')
     define_attribute(:alignment, RubyXL::ST_PhoneticAlignment, :default => 'left')
     define_element_name 'phoneticPr'
@@ -85,10 +83,10 @@ module RubyXL
     define_element_name 'is'
 
     def to_s
-      str = t.to_s
-      r && r.each { |rtr| str << rtr.to_s if rtr }
+      # `dup` here unfreezes the string since it's not a constant but initial value
+      str = t.nil? ? ''.dup : t.to_s
+      r&.each { |rtr| str << rtr.to_s if rtr }
       str
     end
   end
-
 end

data/lib/rubyXL/objects/theme.rb

@@ -1,9 +1,7 @@
-# encoding: UTF-8  <-- magic comment, need this because of sime fancy fonts in the default scheme below. See http://stackoverflow.com/questions/6444826/ruby-utf-8-file-encoding
 require 'rubyXL/objects/ooxml_object'
 require 'rubyXL/objects/extensions'
 
 module RubyXL
-
   # http://www.datypic.com/sc/ooxml/e-a_ext-1.html
   class AExtension < OOXMLObject
     define_attribute(:uri, :string)
@@ -19,7 +17,6 @@ module RubyXL
     def write_xml(xml, node_name_override = nil)
       self.raw_xml
     end
-
   end
 
   class AExtensionStorageArea < OOXMLObject
@@ -1164,7 +1161,7 @@ module RubyXL
   class CT_Hyperlink < OOXMLObject
     define_child_node(RubyXL::CT_EmbeddedWAVAudioFile)
     define_child_node(RubyXL::AExtensionStorageArea)
-    define_attribute(:'r:id',         :string)
+    define_relationship
     define_attribute(:invalidUrl,     :string, :default => '')
     define_attribute(:action,         :string, :default => '')
     define_attribute(:tgtFrame,       :string, :default => '')
@@ -1183,7 +1180,7 @@ module RubyXL
     define_child_node(RubyXL::CT_GradientFillProperties)
     define_child_node(RubyXL::CT_BlipFillProperties)
     define_child_node(RubyXL::CT_PatternFillProperties)
-    define_child_node(RubyXL::BooleanValue,      :node_name => 'a:grpFill')
+    define_child_node(RubyXL::BooleanValue, :node_name => 'a:grpFill')
     # -- EG_EffectProperties
     define_child_node(RubyXL::CT_EffectList)
     define_child_node(RubyXL::CT_EffectContainer, :node_name => 'a:effectDag')
@@ -1373,8 +1370,8 @@ module RubyXL
 
   # http://www.datypic.com/sc/ooxml/e-a_theme.html
   class Theme < OOXMLTopLevelObject
-    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.theme+xml'
-    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme'
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.theme+xml'.freeze
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme'.freeze
 
     define_attribute(:name, :string, :default => '')
     define_child_node(RubyXL::ThemeElements)
@@ -1391,6 +1388,25 @@ module RubyXL
       ROOT.join('xl', 'theme', 'theme1.xml')
     end
 
+    def get_theme_color(idx)
+      color_scheme = a_theme_elements&.a_clr_scheme
+
+      return unless color_scheme
+
+      case idx
+      when 0 then color_scheme.a_lt1
+      when 1 then color_scheme.a_dk1
+      when 2 then color_scheme.a_lt2
+      when 3 then color_scheme.a_dk2
+      when 4 then color_scheme.a_accent1
+      when 5 then color_scheme.a_accent2
+      when 6 then color_scheme.a_accent3
+      when 7 then color_scheme.a_accent4
+      when 8 then color_scheme.a_accent5
+      when 9 then color_scheme.a_accent6
+      end
+    end
+
     def self.default
       default_theme = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <a:theme xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main" name="Office Theme">
@@ -1710,7 +1726,5 @@ module RubyXL
 </a:theme>'
       self.parse(default_theme)
     end
-
   end
-
 end

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,14 +6,13 @@ 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.datypic.com/sc/ooxml/e-ssml_fileVersion-1.html
@@ -37,7 +35,7 @@ module RubyXL
 
   # 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)
@@ -98,7 +96,7 @@ module RubyXL
     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
 
@@ -110,7 +108,7 @@ module RubyXL
 
   # 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
 
@@ -152,8 +150,8 @@ module RubyXL
 
   # 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
 
@@ -186,7 +184,7 @@ 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
@@ -195,7 +193,7 @@ module RubyXL
   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)
@@ -216,7 +214,7 @@ module RubyXL
     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
 
@@ -228,7 +226,7 @@ module RubyXL
 
   # 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
@@ -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)
@@ -298,18 +296,25 @@ module RubyXL
 
   # 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 = %r{[/\\*\[\]:?]}
+
+    # 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,12 +327,14 @@ 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_relationship(RubyXL::PersonMetadata)
 
     define_child_node(RubyXL::FileVersion)
     define_child_node(RubyXL::FileSharing)
@@ -352,12 +359,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
@@ -368,6 +375,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),
@@ -392,37 +400,43 @@ 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
     alias_method :write, :save
 
     DATE1904 = DateTime.new(1904, 1, 1)
-    # Subtracting one day to accomodate for erroneous 1900 leap year compatibility only for 1900 based dates
+    # Subtracting one day to accommodate for erroneous 1900 leap year compatibility only for 1900 based dates
     DATE1899 = DateTime.new(1899, 12, 31) - 1
     MARCH_1_1900 = 61
 
     def base_date
-      (workbook_properties && workbook_properties.date1904) ? DATE1904 : DATE1899
+      workbook_properties&.date1904 ? DATE1904 : DATE1899
     end
     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
-        num += 1 unless workbook_properties && workbook_properties.date1904
+      if num < MARCH_1_1900 then
+        num += 1 unless 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
@@ -431,7 +445,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.
@@ -456,9 +471,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&.value
+    end
 
+    def company=(v)
+      root.document_properties.company ||= StringNode.new
+      root.document_properties.company.value = v
+    end
+
+    def 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&.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&.date1904
+    end
+
+    def date1904=(v)
+      self.workbook_properties ||= RubyXL::WorkbookProperties.new
+      workbook_properties.date1904 = v
+    end
+  end
 end