write_xlsx 1.08.2 → 1.09.0

data/lib/write_xlsx/package/comments.rb

@@ -177,8 +177,8 @@ module Writexlsx
       #
       def write_textbox
         attributes = [
-                      ['style', 'mso-direction-alt:auto']
-                     ]
+          ['style', 'mso-direction-alt:auto']
+        ]
 
         @writer.tag_elements('v:textbox', attributes) do
           # Write the div element.
@@ -191,8 +191,8 @@ module Writexlsx
       #
       def write_client_data
         attributes = [
-                      ['ObjectType', 'Note']
-                     ]
+          ['ObjectType', 'Note']
+        ]
 
         @writer.tag_elements('x:ClientData', attributes) do
           @writer.empty_tag('x:MoveWithCells')
@@ -225,10 +225,10 @@ module Writexlsx
         @author      = options[:author]
         @start_cell  = options[:start_cell]
         @start_row, @start_col = if @start_cell
-          substitute_cellref(@start_cell)
-        else
-          [ options[:start_row], options[:start_col] ]
-        end
+                                   substitute_cellref(@start_cell)
+                                 else
+                                   [ options[:start_row], options[:start_col] ]
+                                 end
         @visible     = options[:visible]
         @x_offset    = options[:x_offset]       || default_x_offset(col)
         @y_offset    = options[:y_offset]       || default_y_offset(row)

data/lib/write_xlsx/package/content_types.rb

@@ -165,9 +165,9 @@ module Writexlsx
       #
       def add_table_name(table_name)
         add_override(
-                     "/xl/tables/#{table_name}.xml",
-                     "#{App_document}spreadsheetml.table+xml"
-                     )
+          "/xl/tables/#{table_name}.xml",
+          "#{App_document}spreadsheetml.table+xml"
+        )
       end
 
       #
@@ -187,6 +187,15 @@ module Writexlsx
         add_override(custom, "#{App_document}custom-properties+xml")
       end
 
+      #
+      # Add the metadata file to the ContentTypes overrides.
+      #
+      def add_metadata
+        add_override(
+          "/xl/metadata.xml",
+          "#{App_document}spreadsheetml.sheetMetadata+xml"
+        )
+      end
 
       private
 
@@ -219,10 +228,10 @@ module Writexlsx
 
       def write_default_or_override(tag, param0, a)
         @writer.empty_tag(tag,
-          [
-            [param0, a[0]],
-            ['ContentType', a[1]]
-          ])
+                          [
+                            [param0, a[0]],
+                            ['ContentType', a[1]]
+                          ])
       end
 
       #
@@ -231,8 +240,8 @@ module Writexlsx
       def write_types
         xmlns = 'http://schemas.openxmlformats.org/package/2006/content-types'
         attributes = [
-                      ['xmlns', xmlns]
-                     ]
+          ['xmlns', xmlns]
+        ]
 
         @writer.tag_elements('Types', attributes) { yield }
       end

data/lib/write_xlsx/package/core.rb

@@ -68,11 +68,11 @@ module Writexlsx
         xmlns_xsi      = 'http://www.w3.org/2001/XMLSchema-instance'
 
         attributes = [
-            ['xmlns:cp',       xmlns_cp],
-            ['xmlns:dc',       xmlns_dc],
-            ['xmlns:dcterms',  xmlns_dcterms],
-            ['xmlns:dcmitype', xmlns_dcmitype],
-            ['xmlns:xsi',      xmlns_xsi]
+          ['xmlns:cp',       xmlns_cp],
+          ['xmlns:dc',       xmlns_dc],
+          ['xmlns:dcterms',  xmlns_dcterms],
+          ['xmlns:dcmitype', xmlns_dcmitype],
+          ['xmlns:xsi',      xmlns_xsi]
         ]
 
         @writer.tag_elements('cp:coreProperties', attributes) { yield }

data/lib/write_xlsx/package/custom.rb

@@ -47,7 +47,7 @@ module Writexlsx
           @properties.each do |property|
             # Write the property element.
             write_property(property)
-        end
+          end
         end
       end
 
@@ -112,7 +112,7 @@ module Writexlsx
         end
 
         @writer.data_element('vt:bool', data)
-    end
+      end
 
       #
       # Write the <vt:filetime> element.

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

@@ -6,6 +6,7 @@ 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'
@@ -56,6 +57,7 @@ module Writexlsx
         write_drawing_rels_files
         add_image_files
         add_vba_project
+        write_metadata_file
       end
 
       private
@@ -175,6 +177,20 @@ 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.
       #
@@ -211,6 +227,8 @@ module Writexlsx
         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
@@ -305,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/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

@@ -56,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
 
       #
@@ -526,9 +526,9 @@ module Writexlsx
       #
       def write_cell_style(name, xf_id, builtin_id)
         attributes = [
-            ['name',      name],
-            ['xfId',      xf_id],
-            ['builtinId', builtin_id]
+          ['name',      name],
+          ['xfId',      xf_id],
+          ['builtinId', builtin_id]
         ]
 
         @writer.empty_tag('cellStyle', attributes)
@@ -570,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)

data/lib/write_xlsx/package/table.rb

@@ -117,8 +117,8 @@ module Writexlsx
               )
             elsif user_data[:total_string]
               total_label_only(
-                               @row2, col_num, col_data, user_data[:total_string], user_data[:format]
-                               )
+                @row2, col_num, col_data, user_data[:total_string], user_data[:format]
+              )
             end
 
             # Get the dxf format index.
@@ -181,7 +181,7 @@ module Writexlsx
         row1, row2 = row2, row1 if row1 > row2
         col1, col2 = col2, col1 if col1 > col2
 
-      # The final hash contains the validation parameters.
+        # The final hash contains the validation parameters.
         param ||= {}
 
         # Turn on Excel's defaults.
@@ -208,17 +208,17 @@ module Writexlsx
       # List of valid input parameters.
       def valid_table_parameter
         [
-         :autofilter,
-         :banded_columns,
-         :banded_rows,
-         :columns,
-         :data,
-         :first_column,
-         :header_row,
-         :last_column,
-         :name,
-         :style,
-         :total_row
+          :autofilter,
+          :banded_columns,
+          :banded_rows,
+          :columns,
+          :data,
+          :first_column,
+          :header_row,
+          :last_column,
+          :name,
+          :style,
+          :total_row
         ]
       end
 
@@ -331,12 +331,12 @@ module Writexlsx
         xmlns            = "#{schema}spreadsheetml/2006/main"
 
         attributes = [
-                      ['xmlns',       xmlns],
-                      ['id',          id],
-                      ['name',        @name],
-                      ['displayName', @name],
-                      ['ref',         @range]
-                     ]
+          ['xmlns',       xmlns],
+          ['id',          id],
+          ['name',        @name],
+          ['displayName', @name],
+          ['ref',         @range]
+        ]
 
         unless ptrue?(@header_row_count)
           attributes << ['headerRowCount', 0]
@@ -378,9 +378,9 @@ module Writexlsx
       #
       def write_table_column(col_data)
         attributes = [
-                      ['id',   col_data.id],
-                      ['name', col_data.name]
-                     ]
+          ['id',   col_data.id],
+          ['name', col_data.name]
+        ]
 
         if ptrue?(col_data.total_string)
           attributes << [:totalsRowLabel, col_data.total_string]

data/lib/write_xlsx/package/theme.rb

@@ -36,7 +36,7 @@ module Writexlsx
       #
       def write_theme_file
         theme  =
-%Q{<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+          %Q{<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <a:theme xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main" name="Office Theme"><a:themeElements><a:clrScheme name="Office"><a:dk1><a:sysClr val="windowText" lastClr="000000"/></a:dk1><a:lt1><a:sysClr val="window" lastClr="FFFFFF"/></a:lt1><a:dk2><a:srgbClr val="1F497D"/></a:dk2><a:lt2><a:srgbClr val="EEECE1"/></a:lt2><a:accent1><a:srgbClr val="4F81BD"/></a:accent1><a:accent2><a:srgbClr val="C0504D"/></a:accent2><a:accent3><a:srgbClr val="9BBB59"/></a:accent3><a:accent4><a:srgbClr val="8064A2"/></a:accent4><a:accent5><a:srgbClr val="4BACC6"/></a:accent5><a:accent6><a:srgbClr val="F79646"/></a:accent6><a:hlink><a:srgbClr val="0000FF"/></a:hlink><a:folHlink><a:srgbClr val="800080"/></a:folHlink></a:clrScheme><a:fontScheme name="Office"><a:majorFont><a:latin typeface="Cambria"/><a:ea typeface=""/><a:cs typeface=""/><a:font script="Jpan" typeface="ＭＳ Ｐゴシック"/><a:font script="Hang" typeface="맑은 고딕"/><a:font script="Hans" typeface="宋体"/><a:font script="Hant" typeface="新細明體"/><a:font script="Arab" typeface="Times New Roman"/><a:font script="Hebr" typeface="Times New Roman"/><a:font script="Thai" typeface="Tahoma"/><a:font script="Ethi" typeface="Nyala"/><a:font script="Beng" typeface="Vrinda"/><a:font script="Gujr" typeface="Shruti"/><a:font script="Khmr" typeface="MoolBoran"/><a:font script="Knda" typeface="Tunga"/><a:font script="Guru" typeface="Raavi"/><a:font script="Cans" typeface="Euphemia"/><a:font script="Cher" typeface="Plantagenet Cherokee"/><a:font script="Yiii" typeface="Microsoft Yi Baiti"/><a:font script="Tibt" typeface="Microsoft Himalaya"/><a:font script="Thaa" typeface="MV Boli"/><a:font script="Deva" typeface="Mangal"/><a:font script="Telu" typeface="Gautami"/><a:font script="Taml" typeface="Latha"/><a:font script="Syrc" typeface="Estrangelo Edessa"/><a:font script="Orya" typeface="Kalinga"/><a:font script="Mlym" typeface="Kartika"/><a:font script="Laoo" typeface="DokChampa"/><a:font script="Sinh" typeface="Iskoola Pota"/><a:font script="Mong" typeface="Mongolian Baiti"/><a:font script="Viet" typeface="Times New Roman"/><a:font script="Uigh" typeface="Microsoft Uighur"/></a:majorFont><a:minorFont><a:latin typeface="Calibri"/><a:ea typeface=""/><a:cs typeface=""/><a:font script="Jpan" typeface="ＭＳ Ｐゴシック"/><a:font script="Hang" typeface="맑은 고딕"/><a:font script="Hans" typeface="宋体"/><a:font script="Hant" typeface="新細明體"/><a:font script="Arab" typeface="Arial"/><a:font script="Hebr" typeface="Arial"/><a:font script="Thai" typeface="Tahoma"/><a:font script="Ethi" typeface="Nyala"/><a:font script="Beng" typeface="Vrinda"/><a:font script="Gujr" typeface="Shruti"/><a:font script="Khmr" typeface="DaunPenh"/><a:font script="Knda" typeface="Tunga"/><a:font script="Guru" typeface="Raavi"/><a:font script="Cans" typeface="Euphemia"/><a:font script="Cher" typeface="Plantagenet Cherokee"/><a:font script="Yiii" typeface="Microsoft Yi Baiti"/><a:font script="Tibt" typeface="Microsoft Himalaya"/><a:font script="Thaa" typeface="MV Boli"/><a:font script="Deva" typeface="Mangal"/><a:font script="Telu" typeface="Gautami"/><a:font script="Taml" typeface="Latha"/><a:font script="Syrc" typeface="Estrangelo Edessa"/><a:font script="Orya" typeface="Kalinga"/><a:font script="Mlym" typeface="Kartika"/><a:font script="Laoo" typeface="DokChampa"/><a:font script="Sinh" typeface="Iskoola Pota"/><a:font script="Mong" typeface="Mongolian Baiti"/><a:font script="Viet" typeface="Arial"/><a:font script="Uigh" typeface="Microsoft Uighur"/></a:minorFont></a:fontScheme><a:fmtScheme name="Office"><a:fillStyleLst><a:solidFill><a:schemeClr val="phClr"/></a:solidFill><a:gradFill rotWithShape="1"><a:gsLst><a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="50000"/><a:satMod val="300000"/></a:schemeClr></a:gs><a:gs pos="35000"><a:schemeClr val="phClr"><a:tint val="37000"/><a:satMod val="300000"/></a:schemeClr></a:gs><a:gs pos="100000"><a:schemeClr val="phClr"><a:tint val="15000"/><a:satMod val="350000"/></a:schemeClr></a:gs></a:gsLst><a:lin ang="16200000" scaled="1"/></a:gradFill><a:gradFill rotWithShape="1"><a:gsLst><a:gs pos="0"><a:schemeClr val="phClr"><a:shade val="51000"/><a:satMod val="130000"/></a:schemeClr></a:gs><a:gs pos="80000"><a:schemeClr val="phClr"><a:shade val="93000"/><a:satMod val="130000"/></a:schemeClr></a:gs><a:gs pos="100000"><a:schemeClr val="phClr"><a:shade val="94000"/><a:satMod val="135000"/></a:schemeClr></a:gs></a:gsLst><a:lin ang="16200000" scaled="0"/></a:gradFill></a:fillStyleLst><a:lnStyleLst><a:ln w="9525" cap="flat" cmpd="sng" algn="ctr"><a:solidFill><a:schemeClr val="phClr"><a:shade val="95000"/><a:satMod val="105000"/></a:schemeClr></a:solidFill><a:prstDash val="solid"/></a:ln><a:ln w="25400" cap="flat" cmpd="sng" algn="ctr"><a:solidFill><a:schemeClr val="phClr"/></a:solidFill><a:prstDash val="solid"/></a:ln><a:ln w="38100" cap="flat" cmpd="sng" algn="ctr"><a:solidFill><a:schemeClr val="phClr"/></a:solidFill><a:prstDash val="solid"/></a:ln></a:lnStyleLst><a:effectStyleLst><a:effectStyle><a:effectLst><a:outerShdw blurRad="40000" dist="20000" dir="5400000" rotWithShape="0"><a:srgbClr val="000000"><a:alpha val="38000"/></a:srgbClr></a:outerShdw></a:effectLst></a:effectStyle><a:effectStyle><a:effectLst><a:outerShdw blurRad="40000" dist="23000" dir="5400000" rotWithShape="0"><a:srgbClr val="000000"><a:alpha val="35000"/></a:srgbClr></a:outerShdw></a:effectLst></a:effectStyle><a:effectStyle><a:effectLst><a:outerShdw blurRad="40000" dist="23000" dir="5400000" rotWithShape="0"><a:srgbClr val="000000"><a:alpha val="35000"/></a:srgbClr></a:outerShdw></a:effectLst><a:scene3d><a:camera prst="orthographicFront"><a:rot lat="0" lon="0" rev="0"/></a:camera><a:lightRig rig="threePt" dir="t"><a:rot lat="0" lon="0" rev="1200000"/></a:lightRig></a:scene3d><a:sp3d><a:bevelT w="63500" h="25400"/></a:sp3d></a:effectStyle></a:effectStyleLst><a:bgFillStyleLst><a:solidFill><a:schemeClr val="phClr"/></a:solidFill><a:gradFill rotWithShape="1"><a:gsLst><a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="40000"/><a:satMod val="350000"/></a:schemeClr></a:gs><a:gs pos="40000"><a:schemeClr val="phClr"><a:tint val="45000"/><a:shade val="99000"/><a:satMod val="350000"/></a:schemeClr></a:gs><a:gs pos="100000"><a:schemeClr val="phClr"><a:shade val="20000"/><a:satMod val="255000"/></a:schemeClr></a:gs></a:gsLst><a:path path="circle"><a:fillToRect l="50000" t="-80000" r="50000" b="180000"/></a:path></a:gradFill><a:gradFill rotWithShape="1"><a:gsLst><a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="80000"/><a:satMod val="300000"/></a:schemeClr></a:gs><a:gs pos="100000"><a:schemeClr val="phClr"><a:shade val="30000"/><a:satMod val="200000"/></a:schemeClr></a:gs></a:gsLst><a:path path="circle"><a:fillToRect l="50000" t="50000" r="50000" b="50000"/></a:path></a:gradFill></a:bgFillStyleLst></a:fmtScheme></a:themeElements><a:objectDefaults/><a:extraClrSchemeLst/></a:theme>}
         @writer.write(theme)
       end