write_xlsx 0.85.9 → 1.09.2

data/lib/write_xlsx/package/custom.rb

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    class Custom
+
+      include Writexlsx::Utility
+
+      def initialize
+        @writer     = Package::XMLWriterSimple.new
+        @properties = []
+        @pid        = 1
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration do
+          write_properties
+        end
+      end
+
+      #
+      # Set the document properties.
+      #
+      def set_properties(properties)
+        @properties = properties
+      end
+
+      private
+
+      def write_properties
+        schema   = 'http://schemas.openxmlformats.org/officeDocument/2006/'
+        xmlns    = "#{schema}custom-properties"
+        xmlns_vt = "#{schema}docPropsVTypes"
+
+        attributes = [
+          ['xmlns',    xmlns],
+          ['xmlns:vt', xmlns_vt]
+        ]
+
+        @writer.tag_elements('Properties', attributes ) do
+          @properties.each do |property|
+            # Write the property element.
+            write_property(property)
+          end
+        end
+      end
+
+      def write_property(property)
+        fmtid = '{D5CDD505-2E9C-101B-9397-08002B2CF9AE}'
+
+        @pid += 1
+        name, value, type  = property
+
+        attributes = [
+          ['fmtid', fmtid],
+          ['pid',   @pid],
+          ['name',  name]
+        ]
+
+        @writer.tag_elements('property', attributes) do
+          if type == 'date'
+            # Write the vt:filetime element.
+            write_vt_filetime(value)
+          elsif type == 'number'
+            # Write the vt:r8 element.
+            write_vt_r8(value)
+          elsif type == 'number_int'
+            # Write the vt:i4 element.
+            write_vt_i4(value)
+          elsif type == 'bool'
+            # Write the vt:bool element.
+            write_vt_bool(value)
+          else
+            # Write the vt:lpwstr element.
+            write_vt_lpwstr(value)
+          end
+        end
+      end
+
+      def write_vt_lpwstr(data)
+        @writer.data_element('vt:lpwstr', data)
+      end
+
+      #
+      # Write the <vt:i4> element.
+      #
+      def write_vt_i4(data)
+        @writer.data_element('vt:i4', data)
+      end
+
+      #
+      # Write the <vt:r8> element.
+      #
+      def write_vt_r8(data)
+        @writer.data_element('vt:r8', data)
+      end
+
+      #
+      # Write the <vt:bool> element.
+      #
+      def write_vt_bool(data)
+        if ptrue?(data)
+          data = 'true'
+        else
+          data = 'false'
+        end
+
+        @writer.data_element('vt:bool', data)
+      end
+
+      #
+      # Write the <vt:filetime> element.
+      #
+      def write_vt_filetime(data)
+        @writer.data_element('vt:filetime', data)
+      end
+    end
+  end
+end

data/lib/write_xlsx/package/metadata.rb

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    #
+    # Metadata - A class for writing the Excel XLSX metadata.xml file.
+    #
+    class Metadata
+      include Writexlsx::Utility
+
+      def initialize(workbook)
+        @writer = Package::XMLWriterSimple.new
+        @workbook      = workbook
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration do
+          # Write the metadata element.
+          write_metadata
+          # Write the metadataTypes element.
+          write_metadata_types
+          # Write the futureMetadata element.
+          write_future_metadata
+          # Write the cellMetadata element.
+          write_cell_metadata
+          @writer.end_tag('metadata')
+        end
+      end
+
+      private
+
+      #
+      # Write the <metadata> element.
+      #
+      def write_metadata
+        xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
+        xmlns_xda =
+          'http://schemas.microsoft.com/office/spreadsheetml/2017/dynamicarray'
+
+        attributes = [
+          ['xmlns',     xmlns],
+          ['xmlns:xda', xmlns_xda]
+        ]
+
+        @writer.start_tag('metadata', attributes)
+      end
+
+      #
+      # Write the <metadataTypes> element.
+      #
+      def write_metadata_types
+        attributes = [['count', 1 ]]
+
+        @writer.tag_elements('metadataTypes', attributes) do
+          # Write the metadataType element.
+          write_metadata_type
+        end
+      end
+
+      #
+      # Write the <metadataType> element.
+      #
+      def write_metadata_type
+        attributes = [
+          ['name',                'XLDAPR'],
+          ['minSupportedVersion', 120000],
+          ['copy',                1],
+          ['pasteAll',            1],
+          ['pasteValues',         1],
+          ['merge',               1],
+          ['splitFirst',          1],
+          ['rowColShift',         1],
+          ['clearFormats',        1],
+          ['clearComments',       1],
+          ['assign',              1],
+          ['coerce',              1],
+          ['cellMeta',            1]
+        ]
+
+        @writer.empty_tag('metadataType', attributes)
+      end
+
+      #
+      # Write the <futureMetadata> element.
+      #
+      def write_future_metadata
+        attributes = [
+          ['name',  'XLDAPR'],
+          ['count', 1]
+        ]
+
+        @writer.tag_elements('futureMetadata', attributes) do
+          @writer.tag_elements('bk') do
+            @writer.tag_elements('extLst') do
+              # Write the ext element.
+              write_ext();
+            end
+          end
+        end
+      end
+
+      #
+      # Write the <ext> element.
+      #
+      def write_ext
+        attributes = [[ 'uri', '{bdbb8cdc-fa1e-496e-a857-3c3f30c029c3}']]
+        @writer.tag_elements('ext', attributes) do
+          # Write the xda:dynamicArrayProperties element.
+          write_xda_dynamic_array_properties
+        end
+      end
+
+      #
+      # Write the <xda:dynamicArrayProperties> element.
+      #
+      def write_xda_dynamic_array_properties
+        attributes = [
+          ['fDynamic',   1],
+          ['fCollapsed', 0]
+        ]
+
+        @writer.empty_tag('xda:dynamicArrayProperties', attributes)
+      end
+
+      #
+      # Write the <cellMetadata> element.
+      #
+      def write_cell_metadata
+        count = 1
+
+        attributes = [['count', count]]
+
+        @writer.tag_elements('cellMetadata', attributes) do
+          @writer.tag_elements('bk') do
+            # Write the rc element.
+            write_rc
+          end
+        end
+      end
+
+      #
+      # Write the <rc> element.
+      #
+      def write_rc
+        attributes = [
+          ['t', 1],
+          ['v', 0]
+        ]
+        @writer.empty_tag('rc', attributes)
+      end
+    end
+  end
+end

data/lib/write_xlsx/package/packager.rb

@@ -5,6 +5,8 @@ require 'write_xlsx/package/app'
 require 'write_xlsx/package/comments'
 require 'write_xlsx/package/content_types'
 require 'write_xlsx/package/core'
+require 'write_xlsx/package/custom'
+require 'write_xlsx/package/metadata'
 require 'write_xlsx/package/relationships'
 require 'write_xlsx/package/shared_strings'
 require 'write_xlsx/package/styles'
@@ -44,6 +46,7 @@ module Writexlsx
         write_shared_strings_file
         write_app_file
         write_core_file
+        write_custom_file
         write_content_types_file
         write_styles_file
         write_theme_file
@@ -54,6 +57,7 @@ module Writexlsx
         write_drawing_rels_files
         add_image_files
         add_vba_project
+        write_metadata_file
       end
 
       private
@@ -153,6 +157,7 @@ module Writexlsx
         app.add_named_ranges_parts
 
         app.set_properties(@workbook.doc_properties)
+        app.doc_security = @workbook.read_only
 
         FileUtils.mkdir_p("#{@package_dir}/docProps")
         app.set_xml_writer("#{@package_dir}/docProps/app.xml")
@@ -172,6 +177,36 @@ module Writexlsx
         core.assemble_xml_file
       end
 
+      #
+      # Write the metadata.xml file.
+      #
+      def write_metadata_file
+        metadata = Package::Metadata.new(@workbook)
+
+        return unless @workbook.has_metadata?
+
+        FileUtils.mkdir_p("#{@package_dir}/xl")
+
+        metadata.set_xml_writer( "#{@package_dir}/xl/metadata.xml")
+        metadata.assemble_xml_file
+      end
+
+      #
+      # Write the custom.xml file.
+      #
+      def write_custom_file
+        properties = @workbook.custom_properties
+        custom     = Package::Custom.new
+
+        return if properties.empty?
+
+        FileUtils.mkdir_p("#{@package_dir}/docProps")
+
+        custom.set_properties(properties)
+        custom.set_xml_writer("#{@package_dir}/docProps/custom.xml")
+        custom.assemble_xml_file
+      end
+
       #
       # Write the ContentTypes.xml file.
       #
@@ -190,6 +225,10 @@ module Writexlsx
         content.add_shared_strings unless @workbook.shared_strings_empty?
         # Add vbaProject if present.
         content.add_vba_project if @workbook.vba_project
+        # Add the custom properties if present.
+        content.add_custom_properties unless @workbook.custom_properties.empty?
+        # Add the metadata file if present.
+        content.add_metadata if @workbook.has_metadata?
 
         content.set_xml_writer("#{@package_dir}/[Content_Types].xml")
         content.assemble_xml_file
@@ -239,9 +278,15 @@ module Writexlsx
         FileUtils.mkdir_p("#{@package_dir}/_rels")
 
         rels.add_document_relationship('/officeDocument', 'xl/workbook.xml')
+
         rels.add_package_relationship('/metadata/core-properties',
             'docProps/core.xml')
+
         rels.add_document_relationship('/extended-properties', 'docProps/app.xml')
+
+        unless @workbook.custom_properties.empty?
+          rels.add_document_relationship('/custom-properties', 'docProps/custom.xml')
+        end
         rels.set_xml_writer("#{@package_dir}/_rels/.rels" )
         rels.assemble_xml_file
       end
@@ -278,6 +323,9 @@ module Writexlsx
           rels.add_ms_package_relationship('/vbaProject', 'vbaProject.bin')
         end
 
+        # Add the metadata file if required.
+        rels.add_document_relationship('/sheetMetadata', 'metadata.xml') if @workbook.has_metadata?
+
         rels.set_xml_writer("#{@package_dir}/xl/_rels/workbook.xml.rels")
         rels.assemble_xml_file
       end

data/lib/write_xlsx/package/relationships.rb

@@ -31,8 +31,8 @@ module Writexlsx
       #
       # Add container relationship to XLSX .rels xml files.
       #
-      def add_document_relationship(type, target)
-        @rels.push([Document_schema + type, target])
+      def add_document_relationship(type, target, target_mode = nil)
+        @rels.push([Document_schema + type, target, target_mode])
       end
 
       #
@@ -64,8 +64,8 @@ module Writexlsx
       #
       def write_relationships
         attributes = [
-                      ['xmlns', Package_schema]
-                     ]
+          ['xmlns', Package_schema]
+        ]
 
         @writer.tag_elements('Relationships', attributes) do
           @rels.each { |rel| write_relationship(*rel) }

data/lib/write_xlsx/package/shared_strings.rb

@@ -63,9 +63,9 @@ module Writexlsx
 
         attributes =
           [
-           ['xmlns',       schema + '/spreadsheetml/2006/main'],
-           ['count',       total_count],
-           ['uniqueCount', unique_count]
+            ['xmlns',       schema + '/spreadsheetml/2006/main'],
+            ['count',       total_count],
+            ['uniqueCount', unique_count]
           ]
 
         @writer.tag_elements('sst', attributes) { yield }
@@ -94,9 +94,9 @@ module Writexlsx
 
         # Convert control character to the _xHHHH_ escape.
         string = string.gsub(
-                             /([\x00-\x08\x0B-\x1F])/,
-                             sprintf("_x%04X_", $1.ord)
-                             ) if string =~ /([\x00-\x08\x0B-\x1F])/
+          /([\x00-\x08\x0B-\x1F])/,
+          sprintf("_x%04X_", $1.ord)
+        ) if string =~ /([\x00-\x08\x0B-\x1F])/
 
         # Convert character to \xC2\xxx or \xC3\xxx
         if string.bytesize == 1 && 0x80 <= string.ord && string.ord <= 0xFF

data/lib/write_xlsx/package/styles.rb

@@ -10,14 +10,17 @@ module Writexlsx
 
       def initialize
         @writer = Package::XMLWriterSimple.new
-        @xf_formats       = nil
-        @palette          = []
-        @font_count       = 0
-        @num_format_count = 0
-        @border_count     = 0
-        @fill_count       = 0
-        @custom_colors    = []
-        @dxf_formats      = []
+        @xf_formats        = nil
+        @palette           = []
+        @font_count        = 0
+        @num_format_count  = 0
+        @border_count      = 0
+        @fill_count        = 0
+        @custom_colors     = []
+        @dxf_formats       = []
+        @has_hyperlink     = 0
+        @hyperlink_font_id = 0
+        @has_comments      = false
       end
 
       def set_xml_writer(filename)
@@ -33,7 +36,10 @@ module Writexlsx
       #
       # Pass in the Format objects and other properties used to set the styles.
       #
-      def set_style_properties(xf_formats, palette, font_count, num_format_count, border_count, fill_count, custom_colors, dxf_formats)
+      def set_style_properties(
+            xf_formats, palette, font_count, num_format_count, border_count,
+            fill_count, custom_colors, dxf_formats, has_comments
+          )
         @xf_formats       = xf_formats
         @palette          = palette
         @font_count       = font_count
@@ -42,6 +48,7 @@ module Writexlsx
         @fill_count       = fill_count
         @custom_colors    = custom_colors
         @dxf_formats      = dxf_formats
+        @has_comments     = has_comments
       end
 
       #
@@ -49,11 +56,11 @@ module Writexlsx
       # based on the default or user defined values in the Workbook palette.
       #
       def palette_color(index)
-      if index.to_s =~ /^#([0-9A-F]{6})$/i
-        "FF#{$1.upcase}"
-      else
-        "FF#{super(index)}"
-      end
+        if index.to_s =~ /^#([0-9A-F]{6})$/i
+          "FF#{$1.upcase}"
+        else
+          "FF#{super(index)}"
+        end
       end
 
       #
@@ -143,14 +150,40 @@ module Writexlsx
       # Write the <fonts> element.
       #
       def write_fonts
-        write_format_elements('fonts', @font_count) do
+        count = @font_count
+
+        if @has_comments
+          # Add an extra font for comments.
+          count += 1
+        end
+
+        write_format_elements('fonts', count) do
           write_font_base
         end
       end
 
       def write_font_base
         @xf_formats.each do |format|
-          format.write_font(@writer, self) if format.has_font?
+          if format.has_font?
+            format.write_font(@writer, self)
+            @has_hyperlink     = 1 if ptrue?(format.hyperlink)
+            @hyperlink_font_id = format.font_index unless ptrue?(@hyperlink_font_id)
+          end
+        end
+        if @has_comments
+          write_comment_font
+        end
+      end
+
+      #
+      # Write the <font> element used for comments.
+      #
+      def write_comment_font
+        @writer.tag_elements('font') do
+          @writer.empty_tag('sz', [['val', 8]])
+          write_color('indexed', 81)
+          @writer.empty_tag( 'name',   [['val', 'Tahoma']])
+          @writer.empty_tag( 'family', [['val', 2]])
         end
       end
 
@@ -220,11 +253,22 @@ module Writexlsx
       # Write the <fill> element.
       #
       def write_fill(format, dxf_format = nil)
-        @writer.tag_elements('fill' ) do
-          write_fill_base(format, dxf_format)
+        # Special handling for pattern only case.
+        if pattern_only_case?(format, dxf_format)
+          write_default_fill(PATTERNS[format.pattern])
+        else
+          @writer.tag_elements('fill' ) do
+            write_fill_base(format, dxf_format)
+          end
         end
       end
 
+      def pattern_only_case?(format, dxf_format)
+        bg_color, fg_color = bg_and_fg_color(format, dxf_format)
+
+        !ptrue?(fg_color) && !ptrue?(bg_color) && ptrue?(format.pattern)
+      end
+
       def write_fill_base(format, dxf_format)
         # The "none" pattern is handled differently for dxf formats.
         if dxf_format && format.pattern <= 1
@@ -248,7 +292,9 @@ module Writexlsx
         if bg_color && bg_color != 0
           @writer.empty_tag('bgColor', [ ['rgb', palette_color(bg_color)] ])
         else
-          @writer.empty_tag('bgColor', [ ['indexed', 64] ]) if !dxf_format
+          if !dxf_format && format.pattern <= 1
+            @writer.empty_tag('bgColor', [ ['indexed', 64] ])
+          end
         end
       end
 
@@ -365,11 +411,17 @@ module Writexlsx
       # Write the <cellStyleXfs> element.
       #
       def write_cell_style_xfs
-        attributes = [ ['count', 1] ]
+        count = ptrue?(@has_hyperlink) ? 2 : 1
+
+        attributes = [ ['count', count] ]
 
         @writer.tag_elements('cellStyleXfs', attributes) do
           # Write the style_xf element.
-          write_style_xf
+          write_style_xf(0, 0)
+
+          if ptrue?(@has_hyperlink)
+            write_style_xf(1, @hyperlink_font_id)
+          end
         end
       end
 
@@ -379,12 +431,6 @@ module Writexlsx
       def write_cell_xfs
         formats = @xf_formats
 
-        # Workaround for when the last format is used for the comment font
-        # and shouldn't be used for cellXfs.
-        last_format =   formats[-1]
-
-        formats.pop if last_format && last_format.font_only != 0
-
         attributes = [ ['count', formats.size] ]
 
         @writer.tag_elements('cellXfs', attributes) do
@@ -396,15 +442,27 @@ module Writexlsx
       #
       # Write the style <xf> element.
       #
-      def write_style_xf
+      def write_style_xf(has_hyperlink, font_id)
         attributes = [
           ['numFmtId', 0],
-          ['fontId',   0],
+          ['fontId',   font_id],
           ['fillId',   0],
           ['borderId', 0]
         ]
 
-        @writer.empty_tag('xf', attributes)
+        if ptrue?(has_hyperlink)
+          attributes << ['applyNumberFormat', 0]
+          attributes << ['applyFill',         0]
+          attributes << ['applyBorder',       0]
+          attributes << ['applyAlignment',    0]
+          attributes << ['applyProtection',   0]
+          @writer.tag_elements('xf', attributes) do
+            @writer.empty_tag('alignment',  [ ['vertical', 'top'] ])
+            @writer.empty_tag('protection', [ ['locked',   0] ])
+          end
+        else
+          @writer.empty_tag('xf', attributes)
+        end
       end
 
       private
@@ -450,22 +508,27 @@ module Writexlsx
       # Write the <cellStyles> element.
       #
       def write_cell_styles
-        attributes = [ ['count', 1] ]
+        count = ptrue?(@has_hyperlink) ? 2 : 1
+
+        attributes = [ ['count', count] ]
 
         @writer.tag_elements('cellStyles', attributes) do
           # Write the cellStyle element.
-          write_cell_style
+          if ptrue?(@has_hyperlink)
+            write_cell_style('Hyperlink', 1, 8)
+          end
+          write_cell_style('Normal', 0, 0)
         end
       end
 
       #
       # Write the <cellStyle> element.
       #
-      def write_cell_style
+      def write_cell_style(name, xf_id, builtin_id)
         attributes = [
-            ['name',      'Normal'],
-            ['xfId',      0],
-            ['builtinId', 0]
+          ['name',      name],
+          ['xfId',      xf_id],
+          ['builtinId', builtin_id]
         ]
 
         @writer.empty_tag('cellStyle', attributes)
@@ -507,9 +570,9 @@ module Writexlsx
       #
       def write_table_styles
         attributes = [
-            ['count',             0],
-            ['defaultTableStyle', 'TableStyleMedium9'],
-            ['defaultPivotStyle', 'PivotStyleLight16']
+          ['count',             0],
+          ['defaultTableStyle', 'TableStyleMedium9'],
+          ['defaultPivotStyle', 'PivotStyleLight16']
         ]
 
         @writer.empty_tag('tableStyles', attributes)