write_xlsx 1.11.1 → 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
@@ -715,7 +737,7 @@ module Writexlsx
 
       # Split the cell range into 2 cells or else use single cell for both.
       if cells =~ /:/
-        cell_1, cell_2 = cells.split(/:/)
+        cell_1, cell_2 = cells.split(":")
       else
         cell_1 = cells
         cell_2 = cells
@@ -724,7 +746,7 @@ module Writexlsx
       # Remove leading/trailing apostrophes and convert escaped quotes to single.
       sheetname.sub!(/^'/, '')
       sheetname.sub!(/'$/, '')
-      sheetname.gsub!(/''/, "'")
+      sheetname.gsub!("''", "'")
 
       row_start, col_start = xl_cell_to_rowcol(cell_1)
       row_end,   col_end   = xl_cell_to_rowcol(cell_2)
@@ -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

@@ -12,10 +12,10 @@ module Writexlsx
       # attributes for the <cell> element. This is the innermost loop so efficiency is
       # important where possible.
       #
-      def cell_attributes(worksheet, row, col) # :nodoc:
+      def cell_attributes(worksheet, row, row_name, col) # :nodoc:
         xf_index = xf ? xf.get_xf_index : 0
         attributes = [
-          ['r', xl_rowcol_to_cell(row, col)]
+          ['r', xl_rowcol_to_cell(row_name, col)]
         ]
 
         # Add the cell format index.
@@ -48,8 +48,8 @@ module Writexlsx
         @token
       end
 
-      def write_cell(worksheet, row, col)
-        worksheet.writer.tag_elements('c', cell_attributes(worksheet, row, col)) do
+      def write_cell(worksheet, row, row_name, col)
+        worksheet.writer.tag_elements('c', cell_attributes(worksheet, row, row_name, col)) do
           worksheet.write_cell_value(token)
         end
       end
@@ -69,8 +69,8 @@ module Writexlsx
       end
 
       TYPE_STR_ATTRS = %w[t s].freeze
-      def write_cell(worksheet, row, col)
-        attributes = cell_attributes(worksheet, row, col)
+      def write_cell(worksheet, row, row_name, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
         attributes << TYPE_STR_ATTRS
         worksheet.writer.tag_elements('c', attributes) do
           worksheet.write_cell_value(token)
@@ -101,11 +101,11 @@ module Writexlsx
         @result || 0
       end
 
-      def write_cell(worksheet, row, col)
+      def write_cell(worksheet, row, row_name, col)
         truefalse = { 'TRUE' => 1, 'FALSE' => 0 }
         error_code = ['#DIV/0!', '#N/A', '#NAME?', '#NULL!', '#NUM!', '#REF!', '#VALUE!']
 
-        attributes = cell_attributes(worksheet, row, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
         if @result && !(@result.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
           if truefalse[@result]
             attributes << %w[t b]
@@ -137,8 +137,8 @@ module Writexlsx
         @result || 0
       end
 
-      def write_cell(worksheet, row, col)
-        worksheet.writer.tag_elements('c', cell_attributes(worksheet, row, col)) do
+      def write_cell(worksheet, row, row_name, col)
+        worksheet.writer.tag_elements('c', cell_attributes(worksheet, row, row_name, col)) do
           worksheet.write_cell_array_formula(token, range)
           worksheet.write_cell_value(result)
         end
@@ -159,9 +159,9 @@ module Writexlsx
         @result || 0
       end
 
-      def write_cell(worksheet, row, col)
+      def write_cell(worksheet, row, row_name, col)
         # Add metadata linkage for dynamic array formulas.
-        attributes = cell_attributes(worksheet, row, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
         attributes << %w[cm 1]
 
         worksheet.writer.tag_elements('c', attributes) do
@@ -183,8 +183,8 @@ module Writexlsx
         @token
       end
 
-      def write_cell(worksheet, row, col)
-        attributes = cell_attributes(worksheet, row, col)
+      def write_cell(worksheet, row, row_name, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
 
         attributes << %w[t b]
         worksheet.writer.tag_elements('c', attributes) do
@@ -202,8 +202,27 @@ module Writexlsx
         ''
       end
 
-      def write_cell(worksheet, row, col)
-        worksheet.writer.empty_tag('c', cell_attributes(worksheet, row, col))
+      def write_cell(worksheet, row, row_name, col)
+        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

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -28,7 +28,7 @@ module Writexlsx
         normalized_str = str.sub(/^mailto:/, '')
 
         # Split url into the link and optional anchor/location.
-        url, @url_str = url.split(/#/, 2)
+        url, @url_str = url.split("#", 2)
 
         # Escape URL unless it looks already escaped.
         url = escape_url(url)
@@ -58,7 +58,8 @@ module Writexlsx
       end
 
       def display_on
-        @display = @url_str
+        # @display = @url_str
+        @display = @str
       end
     end
 
@@ -106,7 +107,7 @@ module Writexlsx
         str = str.sub(/^mailto:/, '')
 
         # Split url into the link and optional anchor/location.
-        url, url_str = url.split(/#/, 2)
+        url, url_str = url.split("#", 2)
 
         # Escape URL unless it looks already escaped.
         url = escape_url(url)