write_xlsx 1.12.1 → 1.12.3

data/lib/write_xlsx/drawing.rb

@@ -6,8 +6,11 @@ require 'write_xlsx/utility'
 
 module Writexlsx
   class Drawing
+    include Writexlsx::Utility
+
     attr_accessor :type, :dimensions, :width, :height, :shape, :anchor, :rel_index, :url_rel_index, :name, :description
     attr_reader :tip, :decorative
+    attr_writer :writer, :embedded, :orientation
 
     def initialize(type, dimensions, width, height, shape, anchor, rel_index = nil, url_rel_index = nil, tip = nil, name = nil, description = nil, decorative = nil)
       @type = type
@@ -23,93 +26,11 @@ module Writexlsx
       @description = description
       @decorative = decorative
     end
-  end
-
-  class Drawings
-    include Writexlsx::Utility
-
-    attr_writer :embedded, :orientation
-
-    def initialize
-      @writer = Package::XMLWriterSimple.new
-      @drawings    = []
-      @embedded    = false
-      @orientation = false
-    end
-
-    def xml_str
-      @writer.string
-    end
-
-    def set_xml_writer(filename)
-      @writer.set_xml_writer(filename)
-    end
-
-    #
-    # Assemble and write the XML file.
-    #
-    def assemble_xml_file
-      write_xml_declaration do
-        # Write the xdr:wsDr element.
-        write_drawing_workspace do
-          if @embedded
-            index = 0
-            @drawings.each do |drawing|
-              # Write the xdr:twoCellAnchor element.
-              index += 1
-              write_two_cell_anchor(index, drawing)
-            end
-          else
-            # Write the xdr:absoluteAnchor element.
-            write_absolute_anchor(1)
-          end
-        end
-      end
-    end
-
-    #
-    # Add a chart, image or shape sub object to the drawing.
-    #
-    def add_drawing_object(drawing)
-      @drawings << drawing
-    end
-
-    private
-
-    #
-    # Write the <xdr:wsDr> element.
-    #
-    def write_drawing_workspace(&block)
-      schema = 'http://schemas.openxmlformats.org/drawingml/'
-      attributes = [
-        ['xmlns:xdr', "#{schema}2006/spreadsheetDrawing"],
-        ['xmlns:a',    "#{schema}2006/main"]
-      ]
-
-      @writer.tag_elements('xdr:wsDr', attributes, &block)
-    end
 
     #
     # Write the <xdr:twoCellAnchor> element.
     #
-    def write_two_cell_anchor(*args)
-      index, drawing = args
-
-      type          = drawing.type
-      width         = drawing.width
-      height        = drawing.height
-      shape         = drawing.shape
-      anchor        = drawing.anchor
-      rel_index     = drawing.rel_index
-      url_rel_index = drawing.url_rel_index
-      tip           = drawing.tip
-      name          = drawing.name
-      description   = drawing.description
-      decorative    = drawing.decorative
-
-      col_from, row_from, col_from_offset, row_from_offset,
-      col_to, row_to, col_to_offset, row_to_offset, col_absolute, row_absolute = drawing.dimensions
-
+    def write_two_cell_anchor(index)
       attributes      = []
 
       # Add attribute for images.
@@ -124,9 +45,9 @@ module Writexlsx
 
       @writer.tag_elements('xdr:twoCellAnchor', attributes) do
         # Write the xdr:from element.
-        write_from(col_from, row_from, col_from_offset, row_from_offset)
+        write_from
         # Write the xdr:to element.
-        write_to(col_to, row_to, col_to_offset, row_to_offset)
+        write_to
 
         if type == 1
           # Graphic frame.
@@ -135,14 +56,10 @@ module Writexlsx
           write_graphic_frame(index, rel_index, name, description, decorative)
         elsif type == 2
           # Write the xdr:pic element.
-          write_pic(
-            index,        rel_index,      col_absolute,
-            row_absolute, width,          height,
-            description,  url_rel_index, tip, decorative
-          )
+          write_pic(index)
         else
           # Write the xdr:sp element for shapes.
-          write_sp(index, col_absolute, row_absolute, width, height, shape)
+          write_sp(index, shape)
         end
 
         # Write the xdr:clientData element.
@@ -182,7 +99,9 @@ module Writexlsx
     #
     # Write the <xdr:from> element.
     #
-    def write_from(col, row, col_offset, row_offset)
+    def write_from
+      col, row, col_offset, row_offset = dimensions
+
       @writer.tag_elements('xdr:from') do
         # Write the xdr:col element.
         write_col(col)
@@ -198,7 +117,9 @@ module Writexlsx
     #
     # Write the <xdr:to> element.
     #
-    def write_to(col, row, col_offset, row_offset)
+    def write_to
+      col, row, col_offset, row_offset = dimensions[4, 4]
+
       @writer.tag_elements('xdr:to') do
         # Write the xdr:col element.
         write_col(col)
@@ -290,7 +211,6 @@ module Writexlsx
     def write_nv_graphic_frame_pr(
           index, name = nil, description = nil, decorative = nil
         )
-
       name = "Chart #{index}" unless ptrue?(name)
 
       @writer.tag_elements('xdr:nvGraphicFramePr') do
@@ -522,7 +442,7 @@ module Writexlsx
     #
     # Write the <xdr:sp> element.
     #
-    def write_sp(index, col_absolute, row_absolute, width, height, shape)
+    def write_sp(index, shape)
       if shape.connect == 0
         # Add attribute for shapes.
         attributes = [
@@ -534,7 +454,7 @@ module Writexlsx
           write_nv_sp_pr(index, shape)
 
           # Write the xdr:spPr element.
-          write_xdr_sp_pr(col_absolute, row_absolute, width, height, shape)
+          write_xdr_sp_pr(shape)
 
           # Write the xdr:txBody element.
           write_tx_body(shape) if shape.text != 0
@@ -546,7 +466,7 @@ module Writexlsx
           write_nv_cxn_sp_pr(index, shape)
 
           # Write the xdr:spPr element.
-          write_xdr_sp_pr(col_absolute, row_absolute, width, height, shape)
+          write_xdr_sp_pr(shape)
         end
       end
     end
@@ -601,26 +521,29 @@ module Writexlsx
     #
     # Write the <xdr:pic> element.
     #
-    def write_pic(index, rel_index, col_absolute, row_absolute, width, height, description, url_rel_index, tip, decorative)
+    def write_pic(index)
+      col_absolute, row_absolute = dimensions[8, 2]
+
       @writer.tag_elements('xdr:pic') do
         # Write the xdr:nvPicPr element.
-        write_nv_pic_pr(index, rel_index, description, url_rel_index, tip, decorative)
+        write_nv_pic_pr(index)
         # Write the xdr:blipFill element.
-        write_blip_fill(rel_index)
+        write_blip_fill
 
         # Pictures are rectangle shapes by default.
-        shape = Shape.new
-        shape.type = 'rect'
+        pic_shape = Shape.new
+        pic_shape.type = 'rect'
 
         # Write the xdr:spPr element.
-        write_sp_pr(col_absolute, row_absolute, width, height, shape)
+        write_sp_pr(pic_shape)
       end
     end
 
     #
     # Write the <xdr:nvPicPr> element.
     #
-    def write_nv_pic_pr(index, _rel_index, description, url_rel_index, tip, decorative)
+    # def write_nv_pic_pr(index, _rel_index, description, url_rel_index, tip, decorative)
+    def write_nv_pic_pr(index)
       @writer.tag_elements('xdr:nvPicPr') do
         # Write the xdr:cNvPr element.
         write_c_nv_pr(
@@ -656,10 +579,10 @@ module Writexlsx
     #
     # Write the <xdr:blipFill> element.
     #
-    def write_blip_fill(index)
+    def write_blip_fill
       @writer.tag_elements('xdr:blipFill') do
         # Write the a:blip element.
-        write_a_blip(index)
+        write_a_blip(rel_index)
         # Write the a:stretch element.
         write_a_stretch
       end
@@ -701,10 +624,10 @@ module Writexlsx
     #
     # Write the <xdr:spPr> element, for charts.
     #
-    def write_sp_pr(col_absolute, row_absolute, width, height, shape = {})
+    def write_sp_pr(shape)
       @writer.tag_elements('xdr:spPr') do
         # Write the a:xfrm element.
-        write_a_xfrm(col_absolute, row_absolute, width, height)
+        write_a_xfrm
         # Write the a:prstGeom element.
         write_a_prst_geom(shape)
       end
@@ -713,12 +636,12 @@ module Writexlsx
     #
     # Write the <xdr:spPr> element for shapes.
     #
-    def write_xdr_sp_pr(col_absolute, row_absolute, width, height, shape)
+    def write_xdr_sp_pr(shape)
       attributes = [%w[bwMode auto]]
 
       @writer.tag_elements('xdr:spPr', attributes) do
         # Write the a:xfrm element.
-        write_a_xfrm(col_absolute, row_absolute, width, height, shape)
+        write_a_xfrm(shape)
 
         # Write the a:prstGeom element.
         write_a_prst_geom(shape)
@@ -738,7 +661,7 @@ module Writexlsx
     #
     # Write the <a:xfrm> element.
     #
-    def write_a_xfrm(col_absolute, row_absolute, width, height, shape = nil)
+    def write_a_xfrm(shape = nil)
       attributes = []
 
       rotation = shape ? shape.rotation : 0
@@ -750,7 +673,7 @@ module Writexlsx
 
       @writer.tag_elements('a:xfrm', attributes) do
         # Write the a:off element.
-        write_a_off(col_absolute, row_absolute)
+        write_a_off
         # Write the a:ext element.
         write_a_ext(width, height)
       end
@@ -759,7 +682,9 @@ module Writexlsx
     #
     # Write the <a:off> element.
     #
-    def write_a_off(x, y)
+    def write_a_off
+      x, y = dimensions[8, 2]
+
       attributes = [
         ['x', x],
         ['y', y]
@@ -923,7 +848,7 @@ module Writexlsx
             @writer.tag_elements('a:rPr', attributes) do
               color = shape.format[:color]
               if color
-                color = shape.palette_color(color)
+                color = shape.palette_color_from_index(color)
                 color = color.sub(/^FF/, '')  # Remove leading FF from rgb for shape color.
               else
                 color = '000000'
@@ -944,4 +869,73 @@ module Writexlsx
       end
     end
   end
+
+  class Drawings
+    include Writexlsx::Utility
+
+    attr_writer :embedded, :orientation
+
+    def initialize
+      @writer = Package::XMLWriterSimple.new
+      @drawings    = []
+      @embedded    = false
+      @orientation = false
+    end
+
+    def xml_str
+      @writer.string
+    end
+
+    def set_xml_writer(filename)
+      @writer.set_xml_writer(filename)
+    end
+
+    #
+    # Assemble and write the XML file.
+    #
+    def assemble_xml_file
+      write_xml_declaration do
+        # Write the xdr:wsDr element.
+        write_drawing_workspace do
+          if @embedded
+            @drawings.each_with_index do |drawing, index|
+              # Write the xdr:twoCellAnchor element.
+              drawing.writer = @writer
+              drawing.embedded = @embedded
+              drawing.write_two_cell_anchor(index + 1)
+            end
+          else
+            # Write the xdr:absoluteAnchor element.
+            drawing = Drawing.new(nil, nil, nil, nil, nil, nil)
+            drawing.writer = @writer
+            drawing.embedded = @embedded
+            drawing.orientation = @orientation
+            drawing.write_absolute_anchor(1)
+          end
+        end
+      end
+    end
+
+    #
+    # Add a chart, image or shape sub object to the drawing.
+    #
+    def add_drawing_object(drawing)
+      @drawings << drawing
+    end
+
+    private
+
+    #
+    # Write the <xdr:wsDr> element.
+    #
+    def write_drawing_workspace(&block)
+      schema = 'http://schemas.openxmlformats.org/drawingml/'
+      attributes = [
+        ['xmlns:xdr', "#{schema}2006/spreadsheetDrawing"],
+        ['xmlns:a',    "#{schema}2006/main"]
+      ]
+
+      @writer.tag_elements('xdr:wsDr', attributes, &block)
+    end
+  end
 end

data/lib/write_xlsx/format.rb

@@ -9,10 +9,10 @@ module Writexlsx
 
     attr_reader :xf_index, :dxf_index, :num_format                                                 # :nodoc:
     attr_reader :underline, :font_script, :size, :theme, :font, :font_family, :hyperlink, :xf_id   # :nodoc:
-    attr_reader :diag_type, :diag_color, :font_only, :color_indexed                        # :nodoc:
+    attr_reader :diag_type, :diag_color, :font_only, :color_indexed                                # :nodoc:
     attr_reader :left, :left_color, :right, :right_color, :top, :top_color, :bottom, :bottom_color # :nodoc:
     attr_reader :font_scheme                                                                       # :nodoc:
-    attr_accessor :quote_prefix, :num_format_index, :border_index, :font_index                                    # :nodoc:
+    attr_accessor :quote_prefix, :num_format_index, :border_index, :font_index                     # :nodoc:
     attr_accessor :fill_index, :font_condense, :font_extend, :diag_border                          # :nodoc:
     attr_accessor :bg_color, :fg_color, :pattern                                                   # :nodoc:
 
@@ -166,7 +166,7 @@ module Writexlsx
       align << %w[horizontal right]       if @text_h_align == 3
       align << %w[horizontal fill]        if @text_h_align == 4
       align << %w[horizontal justify]     if @text_h_align == 5
-      align << ['horizontal', continuous]    if @text_h_align == 6
+      align << ['horizontal', continuous] if @text_h_align == 6
       align << %w[horizontal distributed] if @text_h_align == 7
 
       align << ['justifyLastLine', 1] if @just_distrib != 0
@@ -345,28 +345,24 @@ module Writexlsx
 
       location = location.downcase
 
-      set_text_h_align(1) if location == 'left'
-      set_text_h_align(2) if location == 'centre'
-      set_text_h_align(2) if location == 'center'
-      set_text_h_align(3) if location == 'right'
-      set_text_h_align(4) if location == 'fill'
-      set_text_h_align(5) if location == 'justify'
-      set_text_h_align(6) if location == 'center_across'
-      set_text_h_align(6) if location == 'centre_across'
-      set_text_h_align(6) if location == 'merge'              # Legacy.
-      set_text_h_align(7) if location == 'distributed'
-      set_text_h_align(7) if location == 'equal_space'        # S::PE.
-      set_text_h_align(7) if location == 'justify_distributed'
+      case location
+      when 'left'                         then set_text_h_align(1)
+      when 'centre', 'center'             then set_text_h_align(2)
+      when 'right'                        then set_text_h_align(3)
+      when 'fill'                         then set_text_h_align(4)
+      when 'justify'                      then set_text_h_align(5)
+      when 'center_across', 'centre_across', 'merge'
+        set_text_h_align(6)
+      when 'distributed', 'equal_space', 'justify_distributed'
+        set_text_h_align(7)
+      when 'top'                          then set_text_v_align(1)
+      when 'vcentre', 'vcenter'           then set_text_v_align(2)
+      when 'bottom'                       then set_text_v_align(3)
+      when 'vjustify'                     then set_text_v_align(4)
+      when 'vdistributed', 'vequal_space' then set_text_v_align(5)
+      end
 
       @just_distrib = 1 if location == 'justify_distributed'
-
-      set_text_v_align(1) if location == 'top'
-      set_text_v_align(2) if location == 'vcentre'
-      set_text_v_align(2) if location == 'vcenter'
-      set_text_v_align(3) if location == 'bottom'
-      set_text_v_align(4) if location == 'vjustify'
-      set_text_v_align(5) if location == 'vdistributed'
-      set_text_v_align(5) if location == 'vequal_space'    # S::PE.
     end
 
     #
@@ -419,7 +415,7 @@ module Writexlsx
     def set_rotation(rotation)
       if rotation == 270
         rotation = 255
-      elsif rotation >= -90 && rotation <= 90
+      elsif rotation.between?(-90, 90)
         rotation = -rotation + 90 if rotation < 0
       else
         raise "Rotation #{rotation} outside range: -90 <= angle <= 90"

data/lib/write_xlsx/image.rb

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/image_property'
+
+module Writexlsx
+  class Image
+    attr_reader :row, :col, :x_offset, :y_offset, :x_scale, :y_scale
+    attr_reader :url, :tip, :anchor, :description, :decorative
+
+    def initialize(
+          row, col, image, x_offset, y_offset, x_scale, y_scale,
+          url, tip, anchor, description, decorative
+        )
+      @row         = row
+      @col         = col
+      @image       = ImageProperty.new(image)
+      @x_offset    = x_offset
+      @y_offset    = y_offset
+      @x_scale     = x_scale
+      @y_scale     = y_scale
+      @url         = url
+      @tip         = tip
+      @anchor      = anchor
+      @description = description
+      @decorative  = decorative
+    end
+
+    def scaled_width
+      width * x_scale * 96.0 / x_dpi
+    end
+
+    def scaled_height
+      height * y_scale * 96.0 / y_dpi
+    end
+
+    def width_emus
+      (0.5 + (scaled_width * 9_525)).to_i
+    end
+
+    def height_emus
+      (0.5 + (scaled_height * 9_525)).to_i
+    end
+
+    def image
+      @image.filename
+    end
+
+    def type
+      @image.type
+    end
+
+    def width
+      @image.width
+    end
+
+    def height
+      @image.height
+    end
+
+    def name
+      @image.name
+    end
+
+    def x_dpi
+      @image.x_dpi
+    end
+
+    def y_dpi
+      @image.y_dpi
+    end
+
+    def md5
+      @image.md5
+    end
+
+    def filename
+      @image.filename
+    end
+
+    def position
+      @image.position
+    end
+
+    def ref_id
+      @image.ref_id
+    end
+  end
+end

data/lib/write_xlsx/image_property.rb

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'digest/md5'
+
+module Writexlsx
+  class ImageProperty
+    attr_reader :type, :width, :height, :name, :x_dpi, :y_dpi, :md5
+    attr_reader :filename, :description, :decorative
+    attr_accessor :ref_id, :body, :position
+
+    def initialize(filename, options = {})
+      @filename    = filename
+      @description = options[:description]
+      @decorative  = options[:decorative]
+      @position    = options[:position]
+      @name        = File.basename(filename)
+
+      # Open the image file and import the data.
+      data = File.binread(filename)
+      @md5  = Digest::MD5.hexdigest(data)
+      if data.unpack1('x A3') == 'PNG'
+        process_png(data)
+      elsif data.unpack1('n') == 0xFFD8
+        process_jpg(data)
+      elsif data.unpack1('A4') == 'GIF8'
+        process_gif(data)
+      elsif data.unpack1('A2') == 'BM'
+        process_bmp(data)
+      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
+    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
+    end
+
+    def process_jpg(data)
+      @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
+    end
+
+    #
+    # Extract width and height information from a GIF file.
+    #
+    def process_gif(data)
+      @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?
+    end
+
+    # Extract width and height information from a BMP file.
+    def process_bmp(data)       # :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
+
+      @x_dpi = @y_dpi = 96
+    end
+  end
+end