write_xlsx 1.11.2 → 1.12.1

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
 

data/lib/write_xlsx/worksheet.rb

@@ -113,7 +113,8 @@ module Writexlsx
       @drawing_rels_id        = 0
       @vml_drawing_rels       = {}
       @vml_drawing_rels_id    = 0
-      @has_dynamic_arrays     = false
+      @has_dynamic_functions  = false
+      @has_embedded_images    = false
 
       @use_future_functions  = false
 
@@ -160,6 +161,8 @@ module Writexlsx
         @page_setup.margin_footer = 0.5
         @page_setup.header_footer_aligns = false
       end
+
+      @embedded_image_indexes = @workbook.embedded_image_indexes
     end
 
     def set_xml_writer(filename) # :nodoc:
@@ -1446,6 +1449,7 @@ module Writexlsx
       formula = expand_formula(formula, 'HYPGEOM.DIST\(')
       formula = expand_formula(formula, 'IFNA\(')
       formula = expand_formula(formula, 'IFS\(')
+      formula = expand_formula(formula, 'IMAGE\(')
       formula = expand_formula(formula, 'IMCOSH\(')
       formula = expand_formula(formula, 'IMCOT\(')
       formula = expand_formula(formula, 'IMCSCH\(')
@@ -1536,7 +1540,7 @@ module Writexlsx
       raise WriteXLSXInsufficientArgumentError if [_row, _col, _formula].include?(nil)
 
       # Check for dynamic array functions.
-      regex = /\bLET\(|\bSORT\(|\bLAMBDA\(|\bSINGLE\(|\bSORTBY\(|\bUNIQUE\(|\bXMATCH\(|\bFILTER\(|\bXLOOKUP\(|\bSEQUENCE\(|\bRANDARRAY\(|\bANCHORARRAY\(/
+      regex = /\bANCHORARRAY\(|\bBYCOL\(|\bBYROW\(|\bCHOOSECOLS\(|\bCHOOSEROWS\(|\bDROP\(|\bEXPAND\(|\bFILTER\(|\bHSTACK\(|\bLAMBDA\(|\bMAKEARRAY\(|\bMAP\(|\bRANDARRAY\(|\bREDUCE\(|\bSCAN\(|\bSEQUENCE\(|\bSINGLE\(|\bSORT\(|\bSORTBY\(|\bSWITCH\(|\bTAKE\(|\bTEXTSPLIT\(|\bTOCOL\(|\bTOROW\(|\bUNIQUE\(|\bVSTACK\(|\bWRAPCOLS\(|\bWRAPROWS\(|\bXLOOKUP\(/
       if _formula =~ regex
         return write_dynamic_array_formula(
           _row, _col, _row, _col, _formula, _format, _value
@@ -1549,7 +1553,7 @@ module Writexlsx
       else
         check_dimensions(_row, _col)
         store_row_col_max_min_values(_row, _col)
-        _formula = _formula.sub(/^=/, '')
+        _formula = prepare_formula(_formula)
 
         store_data_to_table(FormulaCellData.new(_formula, _format, _value), _row, _col)
       end
@@ -1634,7 +1638,7 @@ module Writexlsx
     #
     def write_dynamic_array_formula(row1, col1, row2 = nil, col2 = nil, formula = nil, format = nil, value = nil)
       write_array_formula_base('d', row1, col1, row2, col2, formula, format, value)
-      @has_dynamic_arrays = true
+      @has_dynamic_functions = true
     end
 
     #
@@ -1782,21 +1786,23 @@ module Writexlsx
     # The label is written using the {#write()}[#method-i-write] method. Therefore it is
     # possible to write strings, numbers or formulas as labels.
     #
-    def write_url(row, col, url = nil, format = nil, str = nil, tip = nil)
+    def write_url(row, col, url = nil, format = nil, str = nil, tip = nil, ignore_write_string = false)
       # Check for a cell reference in A1 notation and substitute row and column
       if (row_col_array = row_col_notation(row))
-        _row, _col = row_col_array
-        _url       = col
-        _format    = url
-        _str       = format
-        _tip       = str
+        _row, _col           = row_col_array
+        _url                 = col
+        _format              = url
+        _str                 = format
+        _tip                 = str
+        _ignore_write_string = tip
       else
-        _row = row
-        _col = col
-        _url = url
-        _format = format
-        _str = str
-        _tip = tip
+        _row                 = row
+        _col                 = col
+        _url                 = url
+        _format              = format
+        _str                 = str
+        _tip                 = tip
+        _ignore_write_string = ignore_write_string
       end
       _format, _str = _str, _format if _str.respond_to?(:xf_index) || !_format.respond_to?(:xf_index)
       raise WriteXLSXInsufficientArgumentError if [_row, _col, _url].include?(nil)
@@ -1814,7 +1820,7 @@ module Writexlsx
       _format ||= @default_url_format
 
       # Write the hyperlink string.
-      write_string(_row, _col, hyperlink.str, _format)
+      write_string(_row, _col, hyperlink.str, _format) unless _ignore_write_string
     end
 
     #
@@ -1959,6 +1965,65 @@ module Writexlsx
       ]
     end
 
+    #
+    # Embed an image into the worksheet.
+    #
+    def embed_image(row, col, filename, options = nil)
+      # Check for a cell reference in A1 notation and substitute row and column.
+      if (row_col_array = row_col_notation(row))
+        _row, _col = row_col_array
+        image      = col
+        _options   = filename
+      else
+        _row     = row
+        _col     = col
+        image    = filename
+        _options = options
+      end
+      xf, url, tip, description, decorative = []
+
+      raise WriteXLSXInsufficientArgumentError if [_row, _col, image].include?(nil)
+      raise "Couldn't locate #{image}" unless File.exist?(image)
+
+      # Check that row and col are valid and store max and min values
+      check_dimensions(_row, _col)
+      store_row_col_max_min_values(_row, _col)
+
+      if options
+        xf          = options[:cell_format]
+        url         = options[:url]
+        tip         = options[:tip]
+        description = options[:description]
+        decorative  = options[:decorative]
+      end
+
+      # Write the url without writing a string.
+      if url
+        xf ||= @default_url_format
+
+        write_url(row, col, url, xf, nil, tip, true)
+      end
+
+      # Get the image properties, mainly for the type and checksum.
+      image_properties = get_image_properties(image)
+      type = image_properties[0]
+      md5  = image_properties[6]
+
+      # Check for duplicate images.
+      image_index = @embedded_image_indexes[md5]
+
+      unless ptrue?(image_index)
+        @workbook.embedded_images << [image, type, description, decorative]
+
+        image_index = @workbook.embedded_images.size
+        @embedded_image_indexes[md5] = image_index
+      end
+
+      # Write the cell placeholder.
+      store_data_to_table(EmbedImageCellData.new(image_index, xf), _row, _col)
+      @has_embedded_images = true
+    end
+
     #
     # :call-seq:
     #   repeat_formula(row, column, formula [ , format ])
@@ -2799,8 +2864,12 @@ module Writexlsx
       end
     end
 
-    def has_dynamic_arrays?
-      @has_dynamic_arrays
+    def has_dynamic_functions?
+      @has_dynamic_functions
+    end
+
+    def has_embedded_images?
+      @has_embedded_images
     end
 
     private
@@ -3278,6 +3347,7 @@ EOS
       end
 
       @drawing_links << ['/image', "../media/image#{image_id}.#{image_type}"] unless @drawing_rels[md5]
+
       drawing.rel_index = drawing_rel_index(md5)
     end
     public :prepare_image
@@ -4256,9 +4326,10 @@ EOS
 
           # If the cell isn't a string then we have to add the url as
           # the string to display
-          if ptrue?(@cell_data_table)          &&
-             ptrue?(@cell_data_table[row_num]) &&
-             ptrue?(@cell_data_table[row_num][col_num]) && @cell_data_table[row_num][col_num].display_url_string?
+          if ptrue?(@cell_data_table)                   &&
+             ptrue?(@cell_data_table[row_num])          &&
+             ptrue?(@cell_data_table[row_num][col_num]) &&
+             @cell_data_table[row_num][col_num].display_url_string?
             link.display_on
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 1.11.2
+  version: 1.12.1
 platform: ruby
 authors:
 - Hideo NAKAMURA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nkf
@@ -266,6 +266,10 @@ files:
 - lib/write_xlsx/package/metadata.rb
 - lib/write_xlsx/package/packager.rb
 - lib/write_xlsx/package/relationships.rb
+- lib/write_xlsx/package/rich_value.rb
+- lib/write_xlsx/package/rich_value_rel.rb
+- lib/write_xlsx/package/rich_value_structure.rb
+- lib/write_xlsx/package/rich_value_types.rb
 - lib/write_xlsx/package/shared_strings.rb
 - lib/write_xlsx/package/styles.rb
 - lib/write_xlsx/package/table.rb
@@ -304,7 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: write_xlsx is a gem to create a new file in the Excel 2007+ XLSX format.