write_xlsx 1.11.2 → 1.12.0

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

data/lib/write_xlsx/package/rich_value_types.rb

@@ -0,0 +1,103 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    #
+    # RichValueTypes - A class for writing the Excel XLSX rdRichValueTypes.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 RichValueTypes
+      include Writexlsx::Utility
+
+      def initialize
+        @writer          = Package::XMLWriterSimple.new
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration do
+          write_rv_types_info
+        end
+      end
+
+      private
+
+      #
+      # Write the <rvTypesInfo> element.
+      #
+      def write_rv_types_info
+        xmlns = 'http://schemas.microsoft.com/office/spreadsheetml/2017/richdata2'
+        xmlns_mc = 'http://schemas.openxmlformats.org/markup-compatibility/2006'
+        xmlns_x  = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
+
+        attributes = [
+          ['xmlns',        xmlns],
+          ['xmlns:mc',     xmlns_mc],
+          ['mc:Ignorable', 'x'],
+          ['xmlns:x',      xmlns_x]
+        ]
+
+        key_flags = [
+          ['_Self', %w[ExcludeFromFile ExcludeFromCalcComparison]],
+          ['_DisplayString',          ['ExcludeFromCalcComparison']],
+          ['_Flags',                  ['ExcludeFromCalcComparison']],
+          ['_Format',                 ['ExcludeFromCalcComparison']],
+          ['_SubLabel',               ['ExcludeFromCalcComparison']],
+          ['_Attribution',            ['ExcludeFromCalcComparison']],
+          ['_Icon',                   ['ExcludeFromCalcComparison']],
+          ['_Display',                ['ExcludeFromCalcComparison']],
+          ['_CanonicalPropertyNames', ['ExcludeFromCalcComparison']],
+          ['_ClassificationId',       ['ExcludeFromCalcComparison']]
+        ]
+
+        @writer.tag_elements('rvTypesInfo', attributes) do
+          @writer.tag_elements('global') do
+            @writer.tag_elements('keyFlags') do
+              # Write the keyFlags element.
+              key_flags.each do |key_flag|
+                write_key(key_flag[0], key_flag[1])
+              end
+            end
+          end
+        end
+      end
+
+      #
+      # Write the <key> element.
+      #
+      def write_key(name, flags = [])
+        attributes = [['name',  name]]
+
+        @writer.tag_elements('key', attributes) do
+          flags.each do |flag|
+            write_flag(flag)
+          end
+        end
+      end
+
+      #
+      # Write the <flag> element.
+      #
+      def write_flag(name)
+        attributes = [
+          ['name', name],
+          ['value', 1]
+        ]
+
+        @writer.empty_tag('flag', attributes)
+      end
+    end
+  end
+end

data/lib/write_xlsx/utility.rb

@@ -988,6 +988,178 @@ module Writexlsx
     def write_a_end_para_rpr # :nodoc:
       @writer.empty_tag('a:endParaRPr', [%w[lang en-US]])
     end
+
+    #
+    # Extract information from the image file such as dimension, type, filename,
+    # and extension. Also keep track of previously seen images to optimise out
+    # any duplicates.
+    #
+    def get_image_properties(filename)
+      # Note the image_id, and previous_images mechanism isn't currently used.
+      x_dpi = 96
+      y_dpi = 96
+
+      workbook = @workbook || self
+
+      # Open the image file and import the data.
+      data = File.binread(filename)
+      md5  = Digest::MD5.hexdigest(data)
+      if data.unpack1('x A3') == 'PNG'
+        # Test for PNGs.
+        type, width, height, x_dpi, y_dpi = process_png(data)
+        workbook.image_types[:png] = 1
+      elsif data.unpack1('n') == 0xFFD8
+        # Test for JPEG files.
+        type, width, height, x_dpi, y_dpi = process_jpg(data, filename)
+        workbook.image_types[:jpeg] = 1
+      elsif data.unpack1('A4') == 'GIF8'
+        # Test for GIFs.
+        type, width, height, x_dpi, y_dpi = process_gif(data, filename)
+        workbook.image_types[:gif] = 1
+      elsif data.unpack1('A2') == 'BM'
+        # Test for BMPs.
+        type, width, height = process_bmp(data, filename)
+        workbook.image_types[:bmp] = 1
+      else
+        # TODO. Add Image::Size to support other types.
+        raise "Unsupported image format for file: #{filename}\n"
+      end
+
+      # Set a default dpi for images with 0 dpi.
+      x_dpi = 96 if x_dpi == 0
+      y_dpi = 96 if y_dpi == 0
+
+      [type, width, height, File.basename(filename), x_dpi, y_dpi, md5]
+    end
+
+    #
+    # Extract width and height information from a PNG file.
+    #
+    def process_png(data)
+      type   = 'png'
+      width  = 0
+      height = 0
+      x_dpi  = 96
+      y_dpi  = 96
+
+      offset = 8
+      data_length = data.size
+
+      # Search through the image data to read the height and width in th the
+      # IHDR element. Also read the DPI in the pHYs element.
+      while offset < data_length
+
+        length = data[offset + 0, 4].unpack1("N")
+        png_type   = data[offset + 4, 4].unpack1("A4")
+
+        case png_type
+        when "IHDR"
+          width  = data[offset + 8, 4].unpack1("N")
+          height = data[offset + 12, 4].unpack1("N")
+        when "pHYs"
+          x_ppu = data[offset +  8, 4].unpack1("N")
+          y_ppu = data[offset + 12, 4].unpack1("N")
+          units = data[offset + 16, 1].unpack1("C")
+
+          if units == 1
+            x_dpi = x_ppu * 0.0254
+            y_dpi = y_ppu * 0.0254
+          end
+        end
+
+        offset = offset + length + 12
+
+        break if png_type == "IEND"
+      end
+      raise "#{filename}: no size data found in png image.\n" unless height
+
+      [type, width, height, x_dpi, y_dpi]
+    end
+
+    def process_jpg(data, filename)
+      type     = 'jpeg'
+      x_dpi    = 96
+      y_dpi    = 96
+
+      offset = 2
+      data_length = data.bytesize
+
+      # Search through the image data to read the JPEG markers.
+      while offset < data_length
+        marker  = data[offset + 0, 2].unpack1("n")
+        length  = data[offset + 2, 2].unpack1("n")
+
+        # Read the height and width in the 0xFFCn elements
+        # (Except C4, C8 and CC which aren't SOF markers).
+        if (marker & 0xFFF0) == 0xFFC0 &&
+           marker != 0xFFC4 && marker != 0xFFCC
+          height = data[offset + 5, 2].unpack1("n")
+          width  = data[offset + 7, 2].unpack1("n")
+        end
+
+        # Read the DPI in the 0xFFE0 element.
+        if marker == 0xFFE0
+          units     = data[offset + 11, 1].unpack1("C")
+          x_density = data[offset + 12, 2].unpack1("n")
+          y_density = data[offset + 14, 2].unpack1("n")
+
+          if units == 1
+            x_dpi = x_density
+            y_dpi = y_density
+          elsif units == 2
+            x_dpi = x_density * 2.54
+            y_dpi = y_density * 2.54
+          end
+        end
+
+        offset += length + 2
+        break if marker == 0xFFDA
+      end
+
+      raise "#{filename}: no size data found in jpeg image.\n" unless height
+
+      [type, width, height, x_dpi, y_dpi]
+    end
+
+    #
+    # Extract width and height information from a GIF file.
+    #
+    def process_gif(data, filename)
+      type  = 'gif'
+      x_dpi = 96
+      y_dpi = 96
+
+      width  = data[6, 2].unpack1("v")
+      height = data[8, 2].unpack1("v")
+
+      raise "#{filename}: no size data found in gif image.\n" if height.nil?
+
+      [type, width, height, x_dpi, y_dpi]
+    end
+
+    # Extract width and height information from a BMP file.
+    def process_bmp(data, filename)       # :nodoc:
+      type     = 'bmp'
+
+      # Check that the file is big enough to be a bitmap.
+      raise "#{filename} doesn't contain enough data." if data.bytesize <= 0x36
+
+      # Read the bitmap width and height. Verify the sizes.
+      width, height = data.unpack("x18 V2")
+      raise "#{filename}: largest image width #{width} supported is 65k." if width > 0xFFFF
+      raise "#{filename}: largest image height supported is 65k." if height > 0xFFFF
+
+      # Read the bitmap planes and bpp data. Verify them.
+      planes, bitcount = data.unpack("x26 v2")
+      raise "#{filename} isn't a 24bit true color bitmap." unless bitcount == 24
+      raise "#{filename}: only 1 plane supported in bitmap image." unless planes == 1
+
+      # Read the bitmap compression. Verify compression.
+      compression = data.unpack1("x30 V")
+      raise "#{filename}: compression not supported in bitmap image." unless compression == 0
+
+      [type, width, height]
+    end
   end
 
   module WriteDPtPoint

data/lib/write_xlsx/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-WriteXLSX_VERSION = "1.11.2"
+WriteXLSX_VERSION = "1.12.0"

data/lib/write_xlsx/workbook.rb

@@ -35,6 +35,9 @@ module Writexlsx
     attr_reader :max_url_length                 # :nodoc:
     attr_reader :strings_to_urls                # :nodoc:
     attr_reader :read_only                      # :nodoc:
+    attr_reader :embedded_image_indexes         # :nodec:
+    attr_reader :embedded_images                # :nodoc:
+    attr_reader :embedded_descriptions          # :nodoc:
 
     def initialize(file, *option_params)
       options, default_formats = process_workbook_options(*option_params)
@@ -80,6 +83,9 @@ module Writexlsx
       @has_comments        = false
       @read_only           = 0
       @has_metadata        = false
+      @has_embedded_images = false
+      @has_embedded_descriptions = false
+
       if options[:max_url_length]
         @max_url_length = options[:max_url_length]
 
@@ -88,6 +94,10 @@ module Writexlsx
       # Structures for the shared strings data.
       @shared_strings = Package::SharedStrings.new
 
+      # Structures for embedded images.
+      @embedded_image_indexes = {}
+      @embedded_images        = []
+
       # Formula calculation default settings.
       @calc_id             = 124519
       @calc_mode           = 'auto'
@@ -530,6 +540,10 @@ module Writexlsx
       !!@date_1904
     end
 
+    def has_dynamic_functions?
+      @has_dynamic_functions
+    end
+
     #
     # Add a string to the shared string table, if it isn't already there, and
     # return the string index.
@@ -597,6 +611,14 @@ module Writexlsx
       @has_metadata
     end
 
+    def has_embedded_images?
+      @has_embedded_images
+    end
+
+    def has_embedded_descriptions?
+      @has_embedded_descriptions
+    end
+
     private
 
     def filename
@@ -1226,10 +1248,11 @@ module Writexlsx
     #
     def prepare_metadata
       @worksheets.each do |sheet|
-        if sheet.has_dynamic_arrays?
-          @has_metadata = true
-          break
-        end
+        next unless sheet.has_dynamic_functions? || sheet.has_embedded_images?
+
+        @has_metadata = true
+        @has_dynamic_functions ||= sheet.has_dynamic_functions?
+        @has_embedded_images   ||= sheet.has_embedded_images?
       end
     end
 
@@ -1380,12 +1403,22 @@ module Writexlsx
     #
     def prepare_drawings # :nodoc:
       chart_ref_id     = 0
-      image_ref_id     = 0
       drawing_id       = 0
       ref_id           = 0
       image_ids        = {}
       header_image_ids = {}
       background_ids   = {}
+
+      # Store the image types for any embedded images.
+      @embedded_images.each do |image_data|
+        store_image_types(image_data[1])
+
+        @has_embedded_descriptions = true if ptrue?(image_data[2])
+      end
+
+      # The image IDs start from after the embedded images.
+      image_ref_id = @embedded_images.size
+
       @worksheets.each do |sheet|
         chart_count = sheet.charts.size
         image_count = sheet.images.size
@@ -1508,173 +1541,20 @@ module Writexlsx
     end
 
     #
-    # Extract information from the image file such as dimension, type, filename,
-    # and extension. Also keep track of previously seen images to optimise out
-    # any duplicates.
+    # Store the image types (PNG/JPEG/etc) used in the workbook to use in these
+    # Content_Types file.
     #
-    def get_image_properties(filename)
-      # Note the image_id, and previous_images mechanism isn't currently used.
-      x_dpi = 96
-      y_dpi = 96
-
-      # Open the image file and import the data.
-      data = File.binread(filename)
-      md5  = Digest::MD5.hexdigest(data)
-      if data.unpack1('x A3') == 'PNG'
-        # Test for PNGs.
-        type, width, height, x_dpi, y_dpi = process_png(data)
+    def store_image_types(type)
+      case type
+      when 'png'
         @image_types[:png] = 1
-      elsif data.unpack1('n') == 0xFFD8
-        # Test for JPEG files.
-        type, width, height, x_dpi, y_dpi = process_jpg(data, filename)
+      when 'jpeg'
         @image_types[:jpeg] = 1
-      elsif data.unpack1('A4') == 'GIF8'
-        # Test for GIFs.
-        type, width, height, x_dpi, y_dpi = process_gif(data, filename)
+      when 'gif'
         @image_types[:gif] = 1
-      elsif data.unpack1('A2') == 'BM'
-        # Test for BMPs.
-        type, width, height = process_bmp(data, filename)
+      when 'bmp'
         @image_types[:bmp] = 1
-      else
-        # TODO. Add Image::Size to support other types.
-        raise "Unsupported image format for file: #{filename}\n"
       end
-
-      # Set a default dpi for images with 0 dpi.
-      x_dpi = 96 if x_dpi == 0
-      y_dpi = 96 if y_dpi == 0
-
-      [type, width, height, File.basename(filename), x_dpi, y_dpi, md5]
-    end
-
-    #
-    # Extract width and height information from a PNG file.
-    #
-    def process_png(data)
-      type   = 'png'
-      width  = 0
-      height = 0
-      x_dpi  = 96
-      y_dpi  = 96
-
-      offset = 8
-      data_length = data.size
-
-      # Search through the image data to read the height and width in th the
-      # IHDR element. Also read the DPI in the pHYs element.
-      while offset < data_length
-
-        length = data[offset + 0, 4].unpack1("N")
-        png_type   = data[offset + 4, 4].unpack1("A4")
-
-        case png_type
-        when "IHDR"
-          width  = data[offset + 8, 4].unpack1("N")
-          height = data[offset + 12, 4].unpack1("N")
-        when "pHYs"
-          x_ppu = data[offset +  8, 4].unpack1("N")
-          y_ppu = data[offset + 12, 4].unpack1("N")
-          units = data[offset + 16, 1].unpack1("C")
-
-          if units == 1
-            x_dpi = x_ppu * 0.0254
-            y_dpi = y_ppu * 0.0254
-          end
-        end
-
-        offset = offset + length + 12
-
-        break if png_type == "IEND"
-      end
-      raise "#{filename}: no size data found in png image.\n" unless height
-
-      [type, width, height, x_dpi, y_dpi]
-    end
-
-    def process_jpg(data, filename)
-      type     = 'jpeg'
-      x_dpi    = 96
-      y_dpi    = 96
-
-      offset = 2
-      data_length = data.bytesize
-
-      # Search through the image data to read the JPEG markers.
-      while offset < data_length
-        marker  = data[offset + 0, 2].unpack1("n")
-        length  = data[offset + 2, 2].unpack1("n")
-
-        # Read the height and width in the 0xFFCn elements
-        # (Except C4, C8 and CC which aren't SOF markers).
-        if (marker & 0xFFF0) == 0xFFC0 &&
-           marker != 0xFFC4 && marker != 0xFFCC
-          height = data[offset + 5, 2].unpack1("n")
-          width  = data[offset + 7, 2].unpack1("n")
-        end
-
-        # Read the DPI in the 0xFFE0 element.
-        if marker == 0xFFE0
-          units     = data[offset + 11, 1].unpack1("C")
-          x_density = data[offset + 12, 2].unpack1("n")
-          y_density = data[offset + 14, 2].unpack1("n")
-
-          if units == 1
-            x_dpi = x_density
-            y_dpi = y_density
-          elsif units == 2
-            x_dpi = x_density * 2.54
-            y_dpi = y_density * 2.54
-          end
-        end
-
-        offset += length + 2
-        break if marker == 0xFFDA
-      end
-
-      raise "#{filename}: no size data found in jpeg image.\n" unless height
-
-      [type, width, height, x_dpi, y_dpi]
-    end
-
-    #
-    # Extract width and height information from a GIF file.
-    #
-    def process_gif(data, filename)
-      type  = 'gif'
-      x_dpi = 96
-      y_dpi = 96
-
-      width  = data[6, 2].unpack1("v")
-      height = data[8, 2].unpack1("v")
-
-      raise "#{filename}: no size data found in gif image.\n" if height.nil?
-
-      [type, width, height, x_dpi, y_dpi]
-    end
-
-    # Extract width and height information from a BMP file.
-    def process_bmp(data, filename)       # :nodoc:
-      type     = 'bmp'
-
-      # Check that the file is big enough to be a bitmap.
-      raise "#{filename} doesn't contain enough data." if data.bytesize <= 0x36
-
-      # Read the bitmap width and height. Verify the sizes.
-      width, height = data.unpack("x18 V2")
-      raise "#{filename}: largest image width #{width} supported is 65k." if width > 0xFFFF
-      raise "#{filename}: largest image height supported is 65k." if height > 0xFFFF
-
-      # Read the bitmap planes and bpp data. Verify them.
-      planes, bitcount = data.unpack("x26 v2")
-      raise "#{filename} isn't a 24bit true color bitmap." unless bitcount == 24
-      raise "#{filename}: only 1 plane supported in bitmap image." unless planes == 1
-
-      # Read the bitmap compression. Verify compression.
-      compression = data.unpack1("x30 V")
-      raise "#{filename}: compression not supported in bitmap image." unless compression == 0
-
-      [type, width, height]
     end
   end
 end

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -206,5 +206,24 @@ module Writexlsx
         worksheet.writer.empty_tag('c', cell_attributes(worksheet, row, row_name, col))
       end
     end
+
+    class EmbedImageCellData < CellData # :nodoc:
+      def initialize(image_index, xf)
+        @image_index = image_index
+        @xf          = xf
+      end
+
+      def write_cell(worksheet, row, row_name, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
+
+        # Write a error value (mainly for embedded images).
+        attributes << %w[t e]
+        attributes << ['vm', @image_index]
+
+        worksheet.writer.tag_elements('c', attributes) do
+          worksheet.write_cell_value('#VALUE!')
+        end
+      end
+    end
   end
 end

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -58,7 +58,8 @@ module Writexlsx
       end
 
       def display_on
-        @display = @url_str
+        # @display = @url_str
+        @display = @str
       end
     end