write_xlsx 1.12.1 → 1.12.3

data/lib/write_xlsx/inserted_chart.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+module Writexlsx
+  class InsertedChart
+    include Writexlsx::Utility
+
+    attr_reader :row, :col, :chart, :x_offset, :y_offset
+    attr_reader :x_scale, :y_scale
+    attr_reader :anchor, :description, :decorative
+
+    def initialize(
+          row, col, chart, x_offset, y_offset, x_scale, y_scale,
+          anchor, description, decorative
+        )
+      @row         = row
+      @col         = col
+      @chart       = chart
+      @x_offset    = x_offset
+      @y_offset    = y_offset
+      @x_scale     = x_scale || 0
+      @y_scale     = y_scale || 0
+      @anchor      = anchor
+      @description = description
+      @decorative  = decorative
+    end
+
+    def name
+      chart.name
+    end
+
+    def scaled_width
+      width = chart.width if ptrue?(chart.width)
+      (0.5 + (width * x_scale)).to_i
+    end
+
+    def scaled_height
+      height = chart.height if ptrue?(chart.height)
+      (0.5 + (height * y_scale)).to_i
+    end
+  end
+end

data/lib/write_xlsx/package/app.rb

@@ -8,6 +8,7 @@ module Writexlsx
   module Package
     class App
       include Writexlsx::Utility
+
       attr_writer :doc_security
 
       def initialize(workbook)

data/lib/write_xlsx/package/button.rb

@@ -8,13 +8,66 @@ module Writexlsx
     class Button
       include Writexlsx::Utility
 
-      attr_accessor :font, :macro, :vertices, :description
+      def initialize(worksheet, row, col, params, default_row_pixels, button_number)
+        @worksheet = worksheet
+        @default_row_pixels = default_row_pixels
+
+        # Set the button caption.
+        caption = params[:caption] || "Button #{button_number}"
+
+        @font = { _caption: caption }
+
+        # Set the macro name.
+        @macro = if params[:macro]
+                   "[0]!#{params[:macro]}"
+                 else
+                   "[0]!Button#{button_number}_Click"
+                 end
+
+        # Set the alt text for the button.
+        @description = params[:description]
+
+        # Ensure that a width and height have been set.
+        default_height = @default_row_pixels
+        width  = params[:width]  || DEFAULT_COL_PIXELS
+        height = params[:height] || default_row_pixels
+
+        # Scale the size of the button box if required.
+        width  *= params[:x_scale] if params[:x_scale]
+        height *= params[:y_scale] if params[:y_scale]
+
+        # Round the dimensions to the nearest pixel.
+        width  = (0.5 + width).to_i
+        height = (0.5 + height).to_i
+
+        # Set the x/y offsets.
+        x_offset = params[:x_offset] || 0
+        y_offset = params[:y_offset] || 0
+
+        start_row = row
+        start_col = col
+
+        # Calculate the positions of button object.
+        vertices = @worksheet.position_object_pixels(
+          start_col,
+          start_row,
+          x_offset,
+          y_offset,
+          width,
+          height
+        )
+
+        # Add the width and height for VML.
+        vertices << [width, height]
+
+        @vertices = vertices
+      end
 
       def v_shape_attributes(id, z_index)
         attributes = v_shape_attributes_base(id)
-        attributes << ['alt', description] if description
+        attributes << ['alt', @description] if @description
 
-        attributes << ['style', (v_shape_style_base(z_index, vertices) + style_addition).join]
+        attributes << ['style', (v_shape_style_base(z_index, @vertices) + style_addition).join]
         attributes << ['o:button',    't']
         attributes << ['fillcolor',   color]
         attributes << ['strokecolor', 'windowText [64]']
@@ -81,7 +134,7 @@ module Writexlsx
 
         @writer.tag_elements('v:textbox', attributes) do
           # Write the div element.
-          write_div('center', font)
+          write_div('center', @font)
         end
       end
 
@@ -118,7 +171,7 @@ module Writexlsx
       # Write the <x:FmlaMacro> element.
       #
       def write_fmla_macro
-        @writer.data_element('x:FmlaMacro', macro)
+        @writer.data_element('x:FmlaMacro', @macro)
       end
 
       #

data/lib/write_xlsx/package/conditional_format.rb

@@ -409,7 +409,7 @@ module Writexlsx
 
       def row_col_param_for_conditional_formatting(*args)
         # Check for a cell reference in A1 notation and substitute row and column
-        user_range = if args[0].to_s =~ (/^\D/) && (args[0] =~ /,/)
+        user_range = if args[0].to_s =~ /^\D/ && (args[0] =~ /,/)
                        # Check for a user defined multiple range like B3:K6,B8:K11.
                        args[0].sub(/^=/, '').gsub(/\s*,\s*/, ' ').gsub("$", '')
                      end
@@ -516,7 +516,7 @@ module Writexlsx
         end
 
         # 'Between' and 'Not between' criteria require 2 values.
-        if param[:criteria] == 'between' || param[:criteria] == 'notBetween'
+        if %w[between notBetween].include?(param[:criteria])
           raise WriteXLSXOptionParameterError, "Invalid criteria : #{param[:criteria]}" unless param.has_key?(:minimum) || param.has_key?(:maximum)
         else
           param[:minimum] = nil
@@ -524,7 +524,7 @@ module Writexlsx
         end
 
         # Convert date/times value if required.
-        raise WriteXLSXOptionParameterError if (param[:type] == 'date' || param[:type] == 'time') && !(convert_date_time_value(param, :value) || convert_date_time_value(param, :maximum))
+        raise WriteXLSXOptionParameterError if %w[date time].include?(param[:type]) && !(convert_date_time_value(param, :value) || convert_date_time_value(param, :maximum))
       end
 
       def convert_date_time_if_required(val)
@@ -697,7 +697,7 @@ module Writexlsx
           max_data = user_props.size
           max_data = total_icons - 1 if max_data >= total_icons
 
-          (0..max_data - 1).each do |i|
+          (0..(max_data - 1)).each do |i|
             # Set the user defined 'value' property.
             props[i][:value] = user_props[i][:value].to_s.sub(/^=/, '') if user_props[i][:value]
 

data/lib/write_xlsx/package/packager.rb

@@ -203,11 +203,9 @@ module Writexlsx
       # 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")
+        FileUtils.mkdir_p("#{@package_dir}/xl/richData")
 
         write_rich_value_file
         write_rich_value_structure_file
@@ -219,12 +217,11 @@ module Writexlsx
       # 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.set_xml_writer("#{@package_dir}/xl/richData/rdrichvalue.xml")
         rich_value.assemble_xml_file
       end
 
@@ -232,12 +229,11 @@ module Writexlsx
       # 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.set_xml_writer("#{@package_dir}/xl/richData/rdrichvaluestructure.xml")
         rich_value.assemble_xml_file
       end
 
@@ -246,9 +242,8 @@ module Writexlsx
       #
       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.set_xml_writer("#{@package_dir}/xl/richData/rdRichValueTypes.xml")
         rich_value.assemble_xml_file
       end
 
@@ -256,12 +251,11 @@ module Writexlsx
       # 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.set_xml_writer("#{@package_dir}/xl/richData/richValueRel.xml")
         rich_value.assemble_xml_file
       end
 
@@ -456,22 +450,21 @@ module Writexlsx
       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")
+        rich_value_rels_dir = "#{@package_dir}/xl/richData/_rels"
+        FileUtils.mkdir_p(rich_value_rels_dir)
 
         rels = Package::Relationships.new
 
         @workbook.embedded_images.each_with_index do |image_data, index|
-          file_type  = image_data[1]
+          file_type  = image_data.type
           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.set_xml_writer("#{rich_value_rels_dir}/richValueRel.xml.rels")
         rels.assemble_xml_file
       end
 
@@ -481,32 +474,34 @@ module Writexlsx
       def add_image_files
         index = 1
 
-        dir = "#{@package_dir}/xl/media"
-
         @workbook.embedded_images.each do |image|
-          FileUtils.mkdir_p(dir)
-          FileUtils.cp(image[0], "#{dir}/image#{index}.#{image[1]}")
-          index += 1
+          index = write_image_x_xml_files(image, index)
         end
 
         @workbook.images.each do |image|
-          FileUtils.mkdir_p(dir)
-          FileUtils.cp(image[0], "#{dir}/image#{index}.#{image[1]}")
-          index += 1
+          index = write_image_x_xml_files(image, index)
         end
       end
 
+      def write_image_x_xml_files(image, index)
+        FileUtils.mkdir_p("#{@package_dir}/xl/media")
+        FileUtils.cp(
+          image.filename,
+          "#{@package_dir}/xl/media/image#{index}.#{image.type}"
+        )
+        index + 1
+      end
+
       #
       # Write the vbaProject.bin file.
       #
       def add_vba_project
-        dir = @package_dir
         vba_project = @workbook.vba_project
 
         return unless vba_project
 
-        FileUtils.mkdir_p("#{dir}/xl")
-        FileUtils.copy(vba_project, "#{dir}/xl/vbaProject.bin")
+        FileUtils.mkdir_p("#{@package_dir}/xl")
+        FileUtils.copy(vba_project, "#{@package_dir}/xl/vbaProject.bin")
       end
     end
   end

data/lib/write_xlsx/package/rich_value.rb

@@ -38,7 +38,7 @@ module Writexlsx
 
         @writer.tag_elements('rvData', attributes) do
           @embedded_images.each_with_index do |image, index|
-            write_rv(index, image[2], image[3])
+            write_rv(index, image.description, image.decorative)
           end
         end
       end

data/lib/write_xlsx/package/styles.rb

@@ -62,7 +62,7 @@ module Writexlsx
         elsif index == 0x40
           "Automatic"
         else
-          "FF#{super(index)}"
+          "FF#{palette_color_from_index(index)}"
         end
       end
 

data/lib/write_xlsx/package/vml.rb

@@ -265,21 +265,10 @@ module Writexlsx
       #
       # Write the <v:shape> element.
       #
-      def write_image_shape(id, index, image_data)
-        type       = '#_x0000_t75'
-
-        # Get the image parameters
-        width    = image_data[0]
-        height   = image_data[1]
-        name     = image_data[2]
-        position = image_data[3]
-        x_dpi    = image_data[4]
-        y_dpi    = image_data[5]
-        ref_id   = image_data[6]
-
+      def write_image_shape(id, index, image_property)
         # Scale the height/width by the resolution, relative to 72dpi.
-        width  = width  * 72.0 / x_dpi
-        height = height * 72.0 / y_dpi
+        width  = image_property.width  * 72.0 / image_property.x_dpi
+        height = image_property.height * 72.0 / image_property.y_dpi
 
         # Excel uses a rounding based around 72 and 96 dpi.
         width  = 72 / 96.0 * ((width  * 96 / 72.0) + 0.25).to_i
@@ -288,13 +277,15 @@ module Writexlsx
         width = width.to_i if (width - width.to_i).abs < 0.1
         height = height.to_i if (height - height.to_i).abs < 0.1
 
+        type = '#_x0000_t75'
+
         style = [
           "position:absolute", "margin-left:0", "margin-top:0",
           "width:#{width}pt", "height:#{height}pt",
           "z-index:#{index}"
         ].join(';')
         attributes = [
-          ['id',     position],
+          ['id',     image_property.position],
           ['o:spid', "_x0000_s#{id}"],
           ['type',   type],
           ['style',  style]
@@ -302,7 +293,7 @@ module Writexlsx
 
         @writer.tag_elements('v:shape', attributes) do
           # Write the v:imagedata element.
-          write_imagedata(ref_id, name)
+          write_imagedata(image_property)
 
           # Write the o:lock element.
           write_rotation_lock
@@ -312,10 +303,10 @@ module Writexlsx
       #
       # Write the <v:imagedata> element.
       #
-      def write_imagedata(index, o_title)
+      def write_imagedata(image_property)
         attributes = [
-          ['o:relid', "rId#{index}"],
-          ['o:title', o_title]
+          ['o:relid', "rId#{image_property.ref_id}"],
+          ['o:title', image_property.body]
         ]
 
         @writer.empty_tag('v:imagedata', attributes)

data/lib/write_xlsx/shape.rb

@@ -150,8 +150,9 @@ module Writexlsx
     # Calculate the vertices that define the position of a shape object within
     # the worksheet in EMUs.  Save the vertices with the object.
     #
-    # The vertices are expressed as English Metric Units (EMUs). There are 12,700
-    # EMUs per point. Therefore, 12,700 * 3 /4 = 9,525 EMUs per pixel.
+    # The vertices are expressed as English Metric Units (EMUs).
+    # There are 12,700 EMUs per point. Therefore, 12,700 * 3 /4 = 9,525
+    # EMUs per pixel.
     #
     def calc_position_emus(worksheet)
       c_start, r_start,

data/lib/write_xlsx/sparkline.rb

@@ -246,7 +246,7 @@ module Writexlsx
     def write_sparklines  # :nodoc:
       # Write the sparkline elements.
       @writer.tag_elements('x14:sparklines') do
-        (0..count - 1).each do |i|
+        (0..(count - 1)).each do |i|
           range    = @ranges[i]
           location = @locations[i]
 

data/lib/write_xlsx/utility.rb

@@ -27,6 +27,9 @@ module Writexlsx
       't'  =>  5, 'u' =>  8, 'v' =>  7, 'w' => 11, 'x' =>  7, 'y' =>  7,
       'z'  =>  6, '{' =>  5, '|' =>  7, '}' =>  5, '~' =>  7
     }.freeze
+    MAX_DIGIT_WIDTH    = 7    # For Calabri 11.  # :nodoc:
+    PADDING            = 5                       # :nodoc:
+    DEFAULT_COL_PIXELS = 64
 
     #
     # xl_rowcol_to_cell($row, col, row_absolute, col_absolute)
@@ -169,7 +172,7 @@ module Writexlsx
         if time =~ /^(\d\d):(\d\d)(:(\d\d(\.\d+)?))?/
           hour   = ::Regexp.last_match(1).to_i
           min    = ::Regexp.last_match(2).to_i
-          sec    = ::Regexp.last_match(4).to_f || 0
+          sec    = ::Regexp.last_match(4).to_f
         else
           return nil # Not a valid time format.
         end
@@ -226,7 +229,7 @@ module Writexlsx
 
       # Accumulate the number of days since the epoch.
       days = day                               # Add days for current month
-      (0..month - 2).each do |m|
+      (0..(month - 2)).each do |m|
         days += mdays[m]                      # Add days for past months
       end
       days += range * 365                      # Add days for past years
@@ -552,7 +555,7 @@ module Writexlsx
     # Write the <x:Anchor> element.
     #
     def write_anchor
-      col_start, row_start, x1, y1, col_end, row_end, x2, y2 = vertices
+      col_start, row_start, x1, y1, col_end, row_end, x2, y2 = @vertices
       data = [col_start, x1, row_start, y1, col_end, x2, row_end, y2].join(', ')
 
       @writer.data_element('x:Anchor', data)
@@ -749,7 +752,7 @@ module Writexlsx
       hash[key.to_sym]
     end
 
-    def palette_color(index)
+    def palette_color_from_index(index)
       # Adjust the colour index.
       idx = index - 8
 
@@ -757,32 +760,6 @@ module Writexlsx
       sprintf("%02X%02X%02X", r, g, b)
     end
 
-    #
-    # Workbook の生成時のオプションハッシュを解析する
-    #
-    def process_workbook_options(*params)
-      case params.size
-      when 0
-        [{}, {}]
-      when 1 # one hash
-        options_keys = %i[tempdir date_1904 optimization excel2003_style strings_to_urls]
-
-        hash = params.first
-        options = hash.reject { |k, _v| !options_keys.include?(k) }
-
-        default_format_properties =
-          hash[:default_format_properties] ||
-          hash.reject { |k, _v| options_keys.include?(k) }
-
-        [options, default_format_properties.dup]
-      when 2 # array which includes options and default_format_properties
-        options, default_format_properties = params
-        default_format_properties ||= {}
-
-        [options.dup, default_format_properties.dup]
-      end
-    end
-
     #
     # Convert user defined font values into private hash values.
     #
@@ -960,7 +937,7 @@ module Writexlsx
         index = Format.color(color_code)
         raise "Unknown color '#{color_code}' used in chart formatting." unless index
 
-        palette_color(index)
+        palette_color_from_index(index)
       end
     end
 
@@ -988,178 +965,6 @@ 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.12.1"
+WriteXLSX_VERSION = "1.12.3"