write_xlsx 1.12.3 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73aab5eb08b0bd985cad2f77620ef0b9c44a383d0e98a598428c1385e544963a
-  data.tar.gz: 20bdb3eaab4895e2378659137e1eb84b62daee5563b2c7bd350e421a77dd1ff8
+  metadata.gz: 8da4e683796759c1d6cdee00aaba72671bb7ea86e7ece2a794628d04289c880a
+  data.tar.gz: dd59c677e92a15eb273d6290c093e90c2a560d4c087a937c2ee343f2cf5286f4
 SHA512:
-  metadata.gz: 21519073cbab6a3b3397afe389e055334b1b0f415a5d4c2e7196e13b6d31e98c47894dd59fc9646c4eb884a9882fb2ad05d4d50a97222a9a2f9a383197e0d75a
-  data.tar.gz: aec12c29800ed6c0054bb1c705a3ef40a615ef975ef0911978b56dfe051a3f44b4e8644186d9c2f13458f455cf3a25769a8651bd631ab121094fd4edcb0e0a86
+  metadata.gz: 33646d4746630950a08a4f29546682a2c52c04db52df9e201c37b42d31e1033ecd486904009b09b88d637a0d7074f65ac92025c9ea0755e427f3d7d7183da33c
+  data.tar.gz: a6f60317b950822df36b6cc3eacfd4922bcff4026f090714964d547eaa8227b9e5cb56c6f49ea33686601bf95d9c6788b8b9d70dc1d8f46f46ce1e16855420bb

data/.rubocop.yml

@@ -46,6 +46,10 @@ Lint/DuplicateBranch:
   IgnoreLiteralBranches: true
   Exclude:
     - 'lib/write_xlsx/worksheet.rb'
+    - 'lib/write_xlsx/worksheet/data_writing.rb'
+
+Lint/FloatComparison:
+  Enabled: false
 
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
@@ -94,6 +98,9 @@ Naming/MethodParameterName:
 Naming/PredicateMethod:
   Enabled: false
 
+Naming/PredicatePrefix:
+  Enabled: false
+
 Naming/VariableNumber:
   Enabled: false
 

data/Changes

@@ -1,5 +1,8 @@
 Change history of write_xlsx rubygem.
 
+2026-03-12 v1.13.0
+    fix sheet name quoting with upstream Perl implementation.
+
 2025-10-28 v1.12.3
     fix compatibility with rubyzip 3.x
 

data/README.md

@@ -85,7 +85,7 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
 Converted to ruby by Hideo NAKAMURA(nakamrua.hideo@gmail.com)
-Copyright (c) 2012-2024 Hideo NAKAMURA.
+Copyright (c) 2012-2026 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 

data/lib/write_xlsx/chartsheet.rb

@@ -24,11 +24,14 @@ module Writexlsx
       @drawings          = Drawings.new
       @is_chartsheet     = true
       @chart             = nil
-      @charts            = [1]
       @zoom_scale_normal = 0
       @page_setup.orientation = false
     end
 
+    def charts
+      [@chart].compact
+    end
+
     #
     # Assemble and write the XML file.
     #

data/lib/write_xlsx/object_positioning.rb

@@ -0,0 +1,189 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+module Writexlsx
+  module ObjectPositioning
+    include Writexlsx::Utility
+
+    #
+    # Calculate the vertices that define the position of a graphical object
+    # within the worksheet in pixels.
+    #
+    def position_object_pixels(col_start, row_start, x1, y1, width, height, anchor = nil) # :nodoc:
+      context = object_positioning_context(anchor)
+
+      position_object_pixels_with_context(
+        col_start, row_start, x1, y1, width, height, context
+      )
+    end
+    # def position_object_pixels(col_start, row_start, x1, y1, width, height, anchor = nil) # :nodoc:
+    #   col_start, row_start, x1, y1 =
+    #     adjust_start_position_for_negative_offsets(col_start, row_start, x1, y1)
+
+    #   x_abs, y_abs =
+    #     calculate_absolute_position(col_start, row_start, x1, y1, anchor)
+
+    #   col_start, row_start, x1, y1 =
+    #     adjust_start_position_for_cell_offsets(col_start, row_start, x1, y1, anchor)
+
+    #   col_end, row_end, x2, y2 =
+    #     calculate_object_end_position(col_start, row_start, x1, y1, width, height, anchor)
+
+    #   [col_start, row_start, x1, y1, col_end, row_end, x2, y2, x_abs, y_abs]
+    # end
+
+    #
+    # Calculate the vertices that define the position of a graphical object
+    # within the worksheet in EMUs.
+    #
+    def position_object_emus(graphical_object) # :nodoc:
+      object = graphical_object
+      col_start, row_start, x1, y1, col_end, row_end, x2, y2, x_abs, y_abs =
+        position_object_pixels(
+          object.col, object.row, object.x_offset, object.y_offset,
+          object.scaled_width, object.scaled_height, object.anchor
+        )
+
+      # Convert the pixel values to EMUs. See above.
+      x1    = (0.5 + (9_525 * x1)).to_i
+      y1    = (0.5 + (9_525 * y1)).to_i
+      x2    = (0.5 + (9_525 * x2)).to_i
+      y2    = (0.5 + (9_525 * y2)).to_i
+      x_abs = (0.5 + (9_525 * x_abs)).to_i
+      y_abs = (0.5 + (9_525 * y_abs)).to_i
+
+      [col_start, row_start, x1, y1, col_end, row_end, x2, y2, x_abs, y_abs]
+    end
+
+    #
+    # Convert the width of a cell from pixels to character units.
+    #
+    def pixels_to_width(pixels)
+      max_digit_width = 7.0
+      padding         = 5.0
+
+      if pixels <= 12
+        pixels / (max_digit_width + padding)
+      else
+        (pixels - padding) / max_digit_width
+      end
+    end
+
+    #
+    # Convert the height of a cell from pixels to character units.
+    #
+    def pixels_to_height(pixels)
+      height = 0.75 * pixels
+      height = height.to_i if (height - height.to_i).abs < 0.1
+      height
+    end
+
+    private
+
+    def position_object_pixels_with_context(col_start, row_start, x1, y1, width, height, context)
+      col_start, row_start, x1, y1 =
+        adjust_start_position_for_negative_offsets(col_start, row_start, x1, y1, context)
+
+      x_abs, y_abs =
+        calculate_absolute_position(col_start, row_start, x1, y1, context)
+
+      col_start, row_start, x1, y1 =
+        adjust_start_position_for_cell_offsets(col_start, row_start, x1, y1, context)
+
+      col_end, row_end, x2, y2 =
+        calculate_object_end_position(col_start, row_start, x1, y1, width, height, context)
+
+      [col_start, row_start, x1, y1, col_end, row_end, x2, y2, x_abs, y_abs]
+    end
+
+    def adjust_start_position_for_negative_offsets(col_start, row_start, x1, y1, context)
+      # Adjust start column for negative offsets.
+      while x1 < 0 && col_start > 0
+        x1 += context[:size_col].call(col_start - 1, 0)
+        col_start -= 1
+      end
+
+      # Adjust start row for negative offsets.
+      while y1 < 0 && row_start > 0
+        y1 += context[:size_row].call(row_start - 1, 0)
+        row_start -= 1
+      end
+
+      # Ensure that the image isn't shifted off the page at top left.
+      x1 = 0 if x1 < 0
+      y1 = 0 if y1 < 0
+
+      [col_start, row_start, x1, y1]
+    end
+
+    def calculate_absolute_position(col_start, row_start, x1, y1, context)
+      # Calculate the absolute x offset of the top-left vertex.
+      x_abs = if context[:col_size_changed]
+                (0..(col_start - 1)).inject(0) do |sum, col|
+                  sum + context[:size_col].call(col, context[:anchor])
+                end
+              else
+                # Optimisation for when the column widths haven't changed.
+                context[:default_col_pixels] * col_start
+              end
+      x_abs += x1
+
+      # Calculate the absolute y offset of the top-left vertex.
+      y_abs = if context[:row_size_changed]
+                (0..(row_start - 1)).inject(0) do |sum, row|
+                  sum + context[:size_row].call(row, context[:anchor])
+                end
+              else
+                # Optimisation for when the row heights haven't changed.
+                context[:default_row_pixels] * row_start
+              end
+      y_abs += y1
+
+      [x_abs, y_abs]
+    end
+
+    def adjust_start_position_for_cell_offsets(col_start, row_start, x1, y1, context)
+      # Adjust start column for offsets that are greater than the col width.
+      while x1 >= context[:size_col].call(col_start, context[:anchor])
+        x1 -= context[:size_col].call(col_start, 0)
+        col_start += 1
+      end
+
+      # Adjust start row for offsets that are greater than the row height.
+      while y1 >= context[:size_row].call(row_start, context[:anchor])
+        y1 -= context[:size_row].call(row_start, 0)
+        row_start += 1
+      end
+
+      [col_start, row_start, x1, y1]
+    end
+
+    def calculate_object_end_position(col_start, row_start, x1, y1, width, height, context)
+      # Initialise end cell to the same as the start cell.
+      col_end = col_start
+      row_end = row_start
+
+      # Only offset the image in the cell if the row/col isn't hidden.
+      width  += x1 if context[:size_col].call(col_start, context[:anchor]) > 0
+      height += y1 if context[:size_row].call(row_start, context[:anchor]) > 0
+
+      # Subtract the underlying cell widths to find the end cell of the object.
+      while width >= context[:size_col].call(col_end, context[:anchor])
+        width -= context[:size_col].call(col_end, context[:anchor])
+        col_end += 1
+      end
+
+      # Subtract the underlying cell heights to find the end cell of the object.
+      while height >= context[:size_row].call(row_end, context[:anchor])
+        height -= context[:size_row].call(row_end, context[:anchor])
+        row_end += 1
+      end
+
+      # The end vertices are whatever is left from the width and height.
+      x2 = width
+      y2 = height
+
+      [col_end, row_end, x2, y2]
+    end
+  end
+end

data/lib/write_xlsx/package/app.rb

@@ -62,7 +62,7 @@ module Writexlsx
         @workbook.worksheets
           .reject { |sheet| sheet.is_chartsheet? || sheet.very_hidden? }
           .each  do |sheet|
-          add_part_name(sheet.name)
+            add_part_name(sheet.name)
         end
       end
 

data/lib/write_xlsx/page_setup.rb

@@ -0,0 +1,190 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+module Writexlsx
+  class PageSetup # :nodoc:
+    include Writexlsx::Utility
+
+    attr_accessor :margin_left, :margin_right, :margin_top, :margin_bottom  # :nodoc:
+    attr_accessor :margin_header, :margin_footer                            # :nodoc:
+    attr_accessor :repeat_rows, :repeat_cols, :print_area                   # :nodoc:
+    attr_accessor :hbreaks, :vbreaks, :scale                                # :nodoc:
+    attr_accessor :fit_page, :fit_width, :fit_height, :page_setup_changed   # :nodoc:
+    attr_writer :across                                                   # :nodoc:
+    attr_accessor :orientation, :print_options_changed, :black_white  # :nodoc:
+    attr_accessor :header, :footer, :header_footer_changed, :header_footer_aligns, :header_footer_scales
+    attr_writer :page_start
+    attr_writer :horizontal_dpi, :vertical_dpi
+
+    def initialize # :nodoc:
+      @margin_left = 0.7
+      @margin_right = 0.7
+      @margin_top = 0.75
+      @margin_bottom = 0.75
+      @margin_header = 0.3
+      @margin_footer = 0.3
+      @repeat_rows   = ''
+      @repeat_cols   = ''
+      @print_area    = ''
+      @hbreaks = []
+      @vbreaks = []
+      @scale = 100
+      @fit_page = false
+      @fit_width  = nil
+      @fit_height = nil
+      @page_setup_changed = false
+      @across = false
+      @orientation = true
+      @header_footer_aligns = true
+      @header_footer_scales = true
+    end
+
+    def paper=(paper_size)
+      if paper_size
+        @paper_size = paper_size
+        @page_setup_changed = true
+      end
+    end
+
+    def center_horizontally
+      @print_options_changed = true
+      @hcenter               = true
+    end
+
+    def center_vertically
+      @print_options_changed = true
+      @vcenter               = true
+    end
+
+    def print_row_col_headers(headers)
+      if headers
+        @print_headers         = true
+        @print_options_changed = true
+      else
+        @print_headers         = false
+      end
+    end
+
+    def hide_gridlines(option)
+      if option == 0 || !option
+        @print_gridlines = true
+        @print_options_changed = true
+      else
+        @print_gridlines  = false
+      end
+    end
+
+    #
+    # Write the <pageSetup> element.
+    #
+    # The following is an example taken from Excel.
+    #
+    # <pageSetup
+    #     paperSize="9"
+    #     scale="110"
+    #     fitToWidth="2"
+    #     fitToHeight="2"
+    #     pageOrder="overThenDown"
+    #     orientation="portrait"
+    #     useFirstPageNumber="1"
+    #     blackAndWhite="1"
+    #     draft="1"
+    #     horizontalDpi="200"
+    #     verticalDpi="200"
+    #     r:id="rId1"
+    # />
+    #
+    def write_page_setup(writer) # :nodoc:
+      return unless @page_setup_changed
+
+      attributes = []
+      attributes << ['paperSize',       @paper_size]    if @paper_size
+      attributes << ['scale',           @scale]         if @scale != 100
+      attributes << ['fitToWidth',      @fit_width]     if @fit_page && @fit_width != 1
+      attributes << ['fitToHeight',     @fit_height]    if @fit_page && @fit_height != 1
+      attributes << %w[pageOrder overThenDown] if @across
+      attributes << ['firstPageNumber', @page_start]    if @page_start && @page_start > 1
+      attributes << ['orientation',
+                     if @orientation
+                       'portrait'
+                     else
+                       'landscape'
+                     end]
+      attributes << ['blackAndWhite', 1]      if @black_white
+      attributes << ['useFirstPageNumber', 1] if ptrue?(@page_start)
+
+      # Set the DPI. Mainly only for testing.
+      attributes << ['horizontalDpi',  @horizontal_dpi] if @horizontal_dpi
+      attributes << ['verticalDpi',    @vertical_dpi]   if @vertical_dpi
+
+      writer.empty_tag('pageSetup', attributes)
+    end
+
+    #
+    # Write the <pageMargins> element.
+    #
+    def write_page_margins(writer) # :nodoc:
+      writer.empty_tag('pageMargins', margin_attributes)
+    end
+
+    #
+    # Write the <printOptions> element.
+    #
+    def write_print_options(writer) # :nodoc:
+      return unless @print_options_changed
+
+      attributes = []
+      attributes << ['horizontalCentered', 1] if @hcenter
+      attributes << ['verticalCentered',   1] if @vcenter
+      attributes << ['headings',           1] if @print_headers
+      attributes << ['gridLines',          1] if @print_gridlines
+      writer.empty_tag('printOptions', attributes)
+    end
+
+    #
+    # Write the <headerFooter> element.
+    #
+    def write_header_footer(writer, excel2003_style) # :nodoc:
+      tag = 'headerFooter'
+      attributes = []
+      attributes << ['scaleWithDoc', 0]     unless ptrue?(@header_footer_scales)
+      attributes << ['alignWithMargins', 0] unless ptrue?(@header_footer_aligns)
+
+      if @header_footer_changed
+        writer.tag_elements(tag, attributes) do
+          write_odd_header(writer) if @header && @header != ''
+          write_odd_footer(writer) if @footer && @footer != ''
+        end
+      elsif excel2003_style
+        writer.empty_tag(tag, attributes)
+      end
+    end
+
+    private
+
+    #
+    # Write the <oddHeader> element.
+    #
+    def write_odd_header(writer) # :nodoc:
+      writer.data_element('oddHeader', @header)
+    end
+
+    #
+    # Write the <oddFooter> element.
+    #
+    def write_odd_footer(writer) # :nodoc:
+      writer.data_element('oddFooter', @footer)
+    end
+
+    def margin_attributes    # :nodoc:
+      [
+        ['left',   @margin_left],
+        ['right',  @margin_right],
+        ['top',    @margin_top],
+        ['bottom', @margin_bottom],
+        ['header', @margin_header],
+        ['footer', @margin_footer]
+      ]
+    end
+  end
+end

data/lib/write_xlsx/sheets.rb

@@ -91,9 +91,9 @@ module Writexlsx
     def write_comment_files(package_dir)
       self.select { |sheet| sheet.has_comments? }
           .each_with_index do |sheet, index|
-        FileUtils.mkdir_p("#{package_dir}/xl/drawings")
-        sheet.comments.set_xml_writer("#{package_dir}/xl/comments#{index + 1}.xml")
-        sheet.comments.assemble_xml_file
+            FileUtils.mkdir_p("#{package_dir}/xl/drawings")
+            sheet.comments.set_xml_writer("#{package_dir}/xl/comments#{index + 1}.xml")
+            sheet.comments.assemble_xml_file
       end
     end
 

data/lib/write_xlsx/utility.rb

@@ -99,7 +99,7 @@ module Writexlsx
     def xl_range_formula(sheetname, row_1, row_2, col_1, col_2)
       # Use Excel's conventions and quote the sheet name if it contains any
       # non-word character or if it isn't already quoted.
-      sheetname = "'#{sheetname}'" if sheetname =~ /\W/ && !(sheetname =~ /^'/)
+      sheetname = quote_sheetname(sheetname)
 
       range1 = xl_rowcol_to_cell(row_1, col_1, 1, 1)
       range2 = xl_rowcol_to_cell(row_2, col_2, 1, 1)
@@ -128,15 +128,11 @@ module Writexlsx
     # TODO. We need to handle more special cases.
     #
     def quote_sheetname(sheetname) # :nodoc:
-      # Use Excel's conventions and quote the sheet name if it comtains any
-      # non-word character or if it isn't already quoted.
       name = sheetname.dup
-      if name =~ /\W/ && !(name =~ /^'/)
-        # Double quote and single quoted strings.
-        name = name.gsub("'", "''")
-        name = "'#{name}'"
-      end
-      name
+      return name if already_quoted_sheetname?(name)
+      return name unless sheetname_needs_quoting?(name)
+
+      "'#{escape_sheetname(name)}'"
     end
 
     def check_dimensions(row, col)
@@ -965,6 +961,58 @@ module Writexlsx
     def write_a_end_para_rpr # :nodoc:
       @writer.empty_tag('a:endParaRPr', [%w[lang en-US]])
     end
+
+    private
+
+    def already_quoted_sheetname?(name)
+      name.start_with?("'")
+    end
+
+    def escape_sheetname(name)
+      name.gsub("'", "''")
+    end
+
+    def sheetname_needs_quoting?(name)
+      contains_non_identifier_chars?(name) ||
+        starts_with_digit_or_dot?(name) ||
+        valid_a1_reference_name?(name) ||
+        starts_with_rc_reference?(name) ||
+        single_rc_reference?(name)
+    end
+
+    def contains_non_identifier_chars?(name)
+      name.match?(/[^\p{L}\p{N}_.]/)
+    end
+
+    def starts_with_digit_or_dot?(name)
+      name.match?(/^[\p{N}.]/)
+    end
+
+    def valid_a1_reference_name?(name)
+      upcased = name.upcase
+      return false unless upcased.match?(/^[A-Z]{1,3}\d+$/)
+
+      row, col = xl_cell_to_rowcol(upcased)
+      row.between?(0, 1_048_575) && col.between?(0, 16_383)
+    end
+
+    def starts_with_rc_reference?(name)
+      upcased = name.upcase
+
+      if (match = upcased.match(/^R(\d+)/))
+        return match[1].to_i.between?(1, 1_048_576)
+      end
+
+      if (match = upcased.match(/^R?C(\d+)/))
+        return match[1].to_i.between?(1, 16_384)
+      end
+
+      false
+    end
+
+    def single_rc_reference?(name)
+      %w[R C RC].include?(name.upcase)
+    end
   end
 
   module WriteDPtPoint

data/lib/write_xlsx/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-WriteXLSX_VERSION = "1.12.3"
+WriteXLSX_VERSION = "1.13.0"

data/lib/write_xlsx/workbook.rb

@@ -1303,40 +1303,40 @@ module Writexlsx
       # Build an array of the worksheet charts including any combined charts.
       @charts.collect { |chart| [chart, chart.combined] }.flatten.compact
              .each do |chart|
-        chart.formula_ids.each do |range, id|
-          # Skip if the series has user defined data.
-          if chart.formula_data[id]
-            seen_ranges[range] = chart.formula_data[id] unless seen_ranges[range]
-            next
-          # Check to see if the data is already cached locally.
-          elsif seen_ranges[range]
-            chart.formula_data[id] = seen_ranges[range]
-            next
-          end
-
-          # Convert the range formula to a sheet name and cell range.
-          sheetname, *cells = get_chart_range(range)
-
-          # Skip if we couldn't parse the formula.
-          next unless sheetname
-
-          # Handle non-contiguous ranges: (Sheet1!$A$1:$A$2,Sheet1!$A$4:$A$5).
-          # We don't try to parse the ranges. We just return an empty list.
-          if sheetname =~ /^\([^,]+,/
-            chart.formula_data[id] = []
-            seen_ranges[range] = []
-            next
-          end
-
-          # Raise if the name is unknown since it indicates a user error in
-          # a chart series formula.
-          raise "Unknown worksheet reference '#{sheetname} in range '#{range}' passed to add_series()\n" unless worksheets[sheetname]
-
-          # Add the data to the chart.
-          # And store range data locally to avoid lookup if seen agein.
-          chart.formula_data[id] =
-            seen_ranges[range] = chart_data(worksheets[sheetname], cells)
-        end
+               chart.formula_ids.each do |range, id|
+                 # Skip if the series has user defined data.
+                 if chart.formula_data[id]
+                   seen_ranges[range] = chart.formula_data[id] unless seen_ranges[range]
+                   next
+                 # Check to see if the data is already cached locally.
+                 elsif seen_ranges[range]
+                   chart.formula_data[id] = seen_ranges[range]
+                   next
+                 end
+
+                 # Convert the range formula to a sheet name and cell range.
+                 sheetname, *cells = get_chart_range(range)
+
+                 # Skip if we couldn't parse the formula.
+                 next unless sheetname
+
+                 # Handle non-contiguous ranges: (Sheet1!$A$1:$A$2,Sheet1!$A$4:$A$5).
+                 # We don't try to parse the ranges. We just return an empty list.
+                 if sheetname =~ /^\([^,]+,/
+                   chart.formula_data[id] = []
+                   seen_ranges[range] = []
+                   next
+                 end
+
+                 # Raise if the name is unknown since it indicates a user error in
+                 # a chart series formula.
+                 raise "Unknown worksheet reference '#{sheetname}' in range '#{range}' passed to add_series()\n" unless worksheets[sheetname]
+
+                 # Add the data to the chart.
+                 # And store range data locally to avoid lookup if seen agein.
+                 chart.formula_data[id] =
+                   seen_ranges[range] = chart_data(worksheets[sheetname], cells)
+               end
       end
     end