write_xlsx 1.11.1 → 1.12.0

data/lib/write_xlsx/package/metadata.rb

@@ -12,9 +12,15 @@ module Writexlsx
     class Metadata
       include Writexlsx::Utility
 
+      attr_writer :has_dynamic_functions
+      attr_writer :num_embedded_images
+
       def initialize(workbook)
         @writer = Package::XMLWriterSimple.new
-        @workbook      = workbook
+        @workbook = workbook
+        @has_dynamic_functions = false
+        @has_embedded_images   = false
+        @num_embedded_images   = 0
       end
 
       def set_xml_writer(filename)
@@ -22,15 +28,23 @@ module Writexlsx
       end
 
       def assemble_xml_file
+        @has_embedded_images = true if @num_embedded_images > 0
+
         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_cell_future_metadata  if @has_dynamic_functions
+          write_value_future_metadata if @has_embedded_images
+
           # Write the cellMetadata element.
-          write_cell_metadata
+          write_cell_metadata  if @has_dynamic_functions
+          write_value_metadata if @has_embedded_images
+
           @writer.end_tag('metadata')
         end
       end
@@ -42,14 +56,23 @@ module Writexlsx
       #
       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]
+          ['xmlns',     xmlns]
         ]
 
+        if @has_embedded_images
+          attributes << [
+            'xmlns:xlrd',
+            'http://schemas.microsoft.com/office/spreadsheetml/2017/richdata'
+          ]
+        end
+        if @has_dynamic_functions
+          attributes << [
+            'xmlns:xda',
+            'http://schemas.microsoft.com/office/spreadsheetml/2017/dynamicarray'
+          ]
+        end
+
         @writer.start_tag('metadata', attributes)
       end
 
@@ -57,18 +80,23 @@ module Writexlsx
       # Write the <metadataTypes> element.
       #
       def write_metadata_types
-        attributes = [['count', 1]]
+        count =
+          (@has_dynamic_functions ? 1 : 0) +
+          (@has_embedded_images   ? 1 : 0)
+
+        attributes = [['count', count]]
 
         @writer.tag_elements('metadataTypes', attributes) do
           # Write the metadataType element.
-          write_metadata_type
+          write_cell_metadata_type  if @has_dynamic_functions
+          write_value_metadata_type if @has_embedded_images
         end
       end
 
       #
       # Write the <metadataType> element.
       #
-      def write_metadata_type
+      def write_cell_metadata_type
         attributes = [
           %w[name XLDAPR],
           ['minSupportedVersion', 120000],
@@ -88,10 +116,32 @@ module Writexlsx
         @writer.empty_tag('metadataType', attributes)
       end
 
+      #
+      # Write the <metadataType> element.
+      #
+      def write_value_metadata_type
+        attributes = [
+          %w[name XLRICHVALUE],
+          ['minSupportedVersion', 120000],
+          ['copy',                1],
+          ['pasteAll',            1],
+          ['pasteValues',         1],
+          ['merge',               1],
+          ['splitFirst',          1],
+          ['rowColShift',         1],
+          ['clearFormats',        1],
+          ['clearComments',       1],
+          ['assign',              1],
+          ['coerce',              1]
+        ]
+
+        @writer.empty_tag('metadataType', attributes)
+      end
+
       #
       # Write the <futureMetadata> element.
       #
-      def write_future_metadata
+      def write_cell_future_metadata
         attributes = [
           %w[name XLDAPR],
           ['count', 1]
@@ -101,7 +151,34 @@ module Writexlsx
           @writer.tag_elements('bk') do
             @writer.tag_elements('extLst') do
               # Write the ext element.
-              write_ext
+              write_cell_ext
+
+              @writer.end_tag('ext')
+            end
+          end
+        end
+      end
+
+      #
+      # Write the <futureMetadata> element.
+      #
+      def write_value_future_metadata
+        num_images = @num_embedded_images
+
+        attributes = [
+          %w[name XLRICHVALUE],
+          ['count', num_images]
+        ]
+
+        @writer.tag_elements('futureMetadata', attributes) do
+          (0..(num_images - 1)).each do |i|
+            @writer.tag_elements('bk') do
+              @writer.tag_elements('extLst') do
+                # Write the ext element.
+                write_value_ext(i)
+
+                @writer.end_tag('ext')
+              end
             end
           end
         end
@@ -110,12 +187,23 @@ module Writexlsx
       #
       # Write the <ext> element.
       #
-      def write_ext
+      def write_cell_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
+        @writer.start_tag('ext', attributes)
+
+        # Write the xda:dynamicArrayProperties element.
+        write_xda_dynamic_array_properties
+      end
+
+      #
+      # Write the <ext> element.
+      #
+      def write_value_ext(num)
+        attributes = [['uri', '{3e2802c4-a4d2-4d8b-9148-e3be6c30e623}']]
+        @writer.start_tag('ext', attributes)
+
+        # Write the <xlrd:rvb> element.
+        write_xlrd_rvb(num)
       end
 
       #
@@ -141,7 +229,27 @@ module Writexlsx
         @writer.tag_elements('cellMetadata', attributes) do
           @writer.tag_elements('bk') do
             # Write the rc element.
-            write_rc
+            write_rc(1, 0)
+          end
+        end
+      end
+
+      #
+      # Write the <valueMetadata> element.
+      #
+      def write_value_metadata
+        count = @num_embedded_images
+        type  = 1
+        type  = 2 if @has_dynamic_functions
+
+        attributes = [['count', count]]
+
+        @writer.tag_elements('valueMetadata', attributes) do
+          (0..(count - 1)).each do |i|
+            @writer.tag_elements('bk') do
+              # Write the rc element.
+              write_rc(type, i)
+            end
           end
         end
       end
@@ -149,13 +257,22 @@ module Writexlsx
       #
       # Write the <rc> element.
       #
-      def write_rc
+      def write_rc(type, value)
         attributes = [
-          ['t', 1],
-          ['v', 0]
+          ['t', type],
+          ['v', value]
         ]
         @writer.empty_tag('rc', attributes)
       end
+
+      #
+      # Write the <xlrd:rvb> element.
+      #
+      def write_xlrd_rvb(value)
+        attributes = [['i', value]]
+
+        @writer.empty_tag('xlrd:rvb', attributes)
+      end
     end
   end
 end

data/lib/write_xlsx/package/packager.rb

@@ -10,6 +10,10 @@ require 'write_xlsx/package/core'
 require 'write_xlsx/package/custom'
 require 'write_xlsx/package/metadata'
 require 'write_xlsx/package/relationships'
+require 'write_xlsx/package/rich_value'
+require 'write_xlsx/package/rich_value_rel'
+require 'write_xlsx/package/rich_value_structure'
+require 'write_xlsx/package/rich_value_types'
 require 'write_xlsx/package/shared_strings'
 require 'write_xlsx/package/styles'
 require 'write_xlsx/package/table'
@@ -56,9 +60,11 @@ module Writexlsx
         write_worksheet_rels_files
         write_chartsheet_rels_files
         write_drawing_rels_files
+        write_rich_value_rels_files
         add_image_files
         add_vba_project
         write_metadata_file
+        write_rich_value_files
       end
 
       private
@@ -142,13 +148,12 @@ module Writexlsx
       def write_app_file
         app = Package::App.new(@workbook)
 
+        # Add the Worksheet parts.
+        app.add_worksheet_part_names
         # Add the Worksheet heading pairs.
         app.add_worksheet_heading_pairs
         # Add the Chartsheet heading pairs.
         app.add_chartsheet_heading_pairs
-
-        # Add the Worksheet parts.
-        app.add_worksheet_part_names
         # Add the Chartsheet parts.
         app.add_chartsheet_part_names
         # Add the Named Range heading pairs.
@@ -185,12 +190,81 @@ module Writexlsx
 
         return unless @workbook.has_metadata?
 
+        metadata.has_dynamic_functions = @workbook.has_dynamic_functions?
+        metadata.num_embedded_images   = @workbook.embedded_images.size
+
         FileUtils.mkdir_p("#{@package_dir}/xl")
 
         metadata.set_xml_writer("#{@package_dir}/xl/metadata.xml")
         metadata.assemble_xml_file
       end
 
+      #
+      # Write the rdrichvalue(*).xml file.
+      #
+      def write_rich_value_files
+        dir = @package_dir
+
+        return unless @workbook.has_embedded_images?
+
+        FileUtils.mkdir_p("#{dir}/xl/richData")
+
+        write_rich_value_file
+        write_rich_value_structure_file
+        write_rich_value_types_file
+        write_rich_value_rel
+      end
+
+      #
+      # Write the rdrichvalue.xml file.
+      #
+      def write_rich_value_file
+        dir        = @package_dir
+        rich_value = Package::RichValue.new
+
+        rich_value.embedded_images = @workbook.embedded_images
+
+        rich_value.set_xml_writer("#{dir}/xl/richData/rdrichvalue.xml")
+        rich_value.assemble_xml_file
+      end
+
+      #
+      # Write the rdrichvaluestructure.xml file.
+      #
+      def write_rich_value_structure_file
+        dir        = @package_dir
+        rich_value = Package::RichValueStructure.new
+
+        rich_value.has_embedded_descriptions = @workbook.has_embedded_descriptions?
+
+        rich_value.set_xml_writer("#{dir}/xl/richData/rdrichvaluestructure.xml")
+        rich_value.assemble_xml_file
+      end
+
+      #
+      # Write the rdRichValueTypes.xml file.
+      #
+      def write_rich_value_types_file
+        rich_value = Package::RichValueTypes.new
+        dir        = @package_dir
+
+        rich_value.set_xml_writer("#{dir}/xl/richData/rdRichValueTypes.xml")
+        rich_value.assemble_xml_file
+      end
+
+      #
+      # Write the rdrichvalue.xml file.
+      #
+      def write_rich_value_rel
+        dir        = @package_dir
+        rich_value = Package::RichValueRel.new
+
+        rich_value.value_count = @workbook.embedded_images.size
+
+        rich_value.set_xml_writer("#{dir}/xl/richData/richValueRel.xml")
+        rich_value.assemble_xml_file
+      end
+
       #
       # Write the custom.xml file.
       #
@@ -227,8 +301,10 @@ 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.
+        # Add the RichValue file if present.
         content.add_metadata if @workbook.has_metadata?
+        # Add the metadata file if present.
+        content.add_richvalue if @workbook.has_embedded_images?
 
         content.set_xml_writer("#{@package_dir}/[Content_Types].xml")
         content.assemble_xml_file
@@ -341,6 +417,11 @@ module Writexlsx
           )
         end
 
+        # Add the RichValue files if present.
+        if @workbook.has_embedded_images?
+          rels.add_rich_value_relationships
+        end
+
         rels.set_xml_writer("#{@package_dir}/xl/_rels/workbook.xml.rels")
         rels.assemble_xml_file
       end
@@ -368,15 +449,50 @@ module Writexlsx
         @workbook.worksheets.write_drawing_rels_files(@package_dir)
       end
 
+      #
+      # Write the richValueRel.xml.rels files for worksheets that contain embedded
+      # images.
+      #
+      def write_rich_value_rels_files
+        return if @workbook.embedded_images.empty?
+
+        dir  = @package_dir
+
+        # Create the .rels dirs.
+        FileUtils.mkdir_p("#{dir}/xl/richData/_rels")
+
+        rels = Package::Relationships.new
+
+        @workbook.embedded_images.each_with_index do |image_data, index|
+          file_type  = image_data[1]
+          image_file = "../media/image#{index + 1}.#{file_type}"
+
+          rels.add_worksheet_relationship('/image', image_file)
+        end
+
+        # Create the .rels file.
+        rels.set_xml_writer("#{dir}/xl/richData/_rels/richValueRel.xml.rels")
+        rels.assemble_xml_file
+      end
+
       #
       # Write the /xl/media/image?.xml files.
       #
       def add_image_files
+        index = 1
+
         dir = "#{@package_dir}/xl/media"
 
-        @workbook.images.each_with_index do |image, index|
+        @workbook.embedded_images.each do |image|
+          FileUtils.mkdir_p(dir)
+          FileUtils.cp(image[0], "#{dir}/image#{index}.#{image[1]}")
+          index += 1
+        end
+
+        @workbook.images.each do |image|
           FileUtils.mkdir_p(dir)
-          FileUtils.cp(image[0], "#{dir}/image#{index + 1}.#{image[1]}")
+          FileUtils.cp(image[0], "#{dir}/image#{index}.#{image[1]}")
+          index += 1
         end
       end
 

data/lib/write_xlsx/package/relationships.rb

@@ -58,6 +58,31 @@ module Writexlsx
         @rels.push([Document_schema + type, target, target_mode])
       end
 
+      #
+      # Add relationships for RichValue files.
+      #
+      def add_rich_value_relationships
+        @rels << [
+          'http://schemas.microsoft.com/office/2022/10/relationships/richValueRel',
+          'richData/richValueRel.xml'
+        ]
+
+        @rels << [
+          'http://schemas.microsoft.com/office/2017/06/relationships/rdRichValue',
+          'richData/rdrichvalue.xml'
+        ]
+
+        @rels << [
+          'http://schemas.microsoft.com/office/2017/06/relationships/rdRichValueStructure',
+          'richData/rdrichvaluestructure.xml'
+        ]
+
+        @rels << [
+          'http://schemas.microsoft.com/office/2017/06/relationships/rdRichValueTypes',
+          'richData/rdRichValueTypes.xml'
+        ]
+      end
+
       private
 
       #

data/lib/write_xlsx/package/rich_value.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    class RichValue
+      include Writexlsx::Utility
+
+      attr_accessor :embedded_images
+
+      def initialize
+        @writer          = Package::XMLWriterSimple.new
+        @embedded_images = []
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration do
+          write_rv_data
+        end
+      end
+
+      private
+
+      def write_rv_data
+        xmlns = 'http://schemas.microsoft.com/office/spreadsheetml/2017/richdata'
+
+        attributes = [
+          ['xmlns', xmlns],
+          ['count', @embedded_images.size]
+        ]
+
+        @writer.tag_elements('rvData', attributes) do
+          @embedded_images.each_with_index do |image, index|
+            write_rv(index, image[2], image[3])
+          end
+        end
+      end
+
+      #
+      # Write the <rv> element.
+      #
+      def write_rv(index, description, decorative)
+        value = 5
+        value = 6 if ptrue?(decorative)
+
+        attributes = [['s',  0]]
+
+        @writer.tag_elements('rv', attributes) do
+          write_v(index)
+          write_v(value)
+          write_v(description) if ptrue?(description)
+        end
+      end
+
+      #
+      # Write the <v> element.
+      #
+      def write_v(data)
+        @writer.data_element('v', data)
+      end
+    end
+  end
+end

data/lib/write_xlsx/package/rich_value_rel.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    #
+    # RichValueRel - A class for writing the Excel XLSX richValueRel.xml file.
+    #
+    # Used in conjunction with Excel::Writer::XLSX
+    #
+    # Copyright 2000-2024, John McNamara, jmcnamara@cpan.org
+    #
+    # Convert to Ruby by Hideo Nakamura, nakamura.hideo@gmail.com
+    #
+    class RichValueRel
+      include Writexlsx::Utility
+
+      attr_writer :value_count
+
+      def initialize
+        @writer = Package::XMLWriterSimple.new
+        @value_count = 0
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration do
+          write_rich_value_rels
+        end
+      end
+
+      private
+
+      #
+      # Write the <richValueRels> element.
+      #
+      def write_rich_value_rels
+        xmlns = 'http://schemas.microsoft.com/office/spreadsheetml/2022/richvaluerel'
+        xmlns_r = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'
+
+        attributes = [
+          ['xmlns',   xmlns],
+          ['xmlns:r', xmlns_r]
+        ]
+
+        @writer.tag_elements('richValueRels', attributes) do
+          (0..(@value_count - 1)).each do |index|
+            # Write the rel element.
+            write_rel(index + 1)
+          end
+        end
+      end
+
+      #
+      # Write the <rel> element.
+      #
+      def write_rel(id)
+        attributes = [['r:id',  "rId#{id}"]]
+
+        @writer.empty_tag('rel', attributes)
+      end
+    end
+  end
+end

data/lib/write_xlsx/package/rich_value_structure.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    #
+    # RichValueStructure - A class for writing the Excel XLSX rdrichvaluestructure.xml
+    # file.
+    #
+    # Used in conjunction with Excel::Writer::XLSX
+    #
+    # Copyright 2000-2024, John McNamara, jmcnamara@cpan.org
+    #
+    # Convert to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+    #
+    class RichValueStructure
+      include Writexlsx::Utility
+
+      attr_writer :has_embedded_descriptions
+
+      def initialize
+        @writer = Package::XMLWriterSimple.new
+        @has_embedded_descriptions = false
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration do
+          write_rv_structures
+        end
+      end
+
+      private
+
+      #
+      # Write the <rvStructures> element.
+      #
+      def write_rv_structures
+        xmlns = 'http://schemas.microsoft.com/office/spreadsheetml/2017/richdata'
+
+        attributes = [
+          ['xmlns', xmlns],
+          ['count', 1]
+        ]
+
+        @writer.tag_elements('rvStructures', attributes) do
+          write_s
+        end
+      end
+
+      #
+      # Write the <s> element.
+      #
+      def write_s
+        attributes = [%w[t _localImage]]
+
+        @writer.tag_elements('s', attributes) do
+          write_k('_rvRel:LocalImageIdentifier', 'i')
+          write_k('CalcOrigin',                  'i')
+          write_k('Text', 's') if @has_embedded_descriptions
+        end
+      end
+
+      #
+      # Write the <k> element.
+      #
+      def write_k(n, t)
+        attributes = [
+          ['n', n],
+          ['t', t]
+        ]
+
+        @writer.empty_tag('k', attributes)
+      end
+    end
+  end
+end