write_xlsx 1.12.3 → 1.15.0

data/lib/write_xlsx/formats.rb

@@ -5,8 +5,6 @@ require 'write_xlsx/package/xml_writer_simple'
 
 module Writexlsx
   class Formats
-    include Writexlsx::Utility
-
     attr_reader :formats, :xf_format_indices, :dxf_format_indices
 
     def initialize

data/lib/write_xlsx/image_property.rb

@@ -2,9 +2,12 @@
 # frozen_string_literal: true
 
 require 'digest/md5'
+require 'write_xlsx/utility/common'
 
 module Writexlsx
   class ImageProperty
+    include Utility::Common
+
     attr_reader :type, :width, :height, :name, :x_dpi, :y_dpi, :md5
     attr_reader :filename, :description, :decorative
     attr_accessor :ref_id, :body, :position
@@ -66,7 +69,7 @@ module Writexlsx
           y_ppu = data[offset + 12, 4].unpack1("N")
           units = data[offset + 16, 1].unpack1("C")
 
-          if units == 1
+          if units == 1 && ptrue?(x_ppu) && ptrue?(y_ppu)
             @x_dpi = x_ppu * 0.0254
             @y_dpi = y_ppu * 0.0254
           end

data/lib/write_xlsx/inserted_chart.rb

@@ -3,7 +3,7 @@
 
 module Writexlsx
   class InsertedChart
-    include Writexlsx::Utility
+    include Writexlsx::Utility::Common
 
     attr_reader :row, :col, :chart, :x_offset, :y_offset
     attr_reader :x_scale, :y_scale

data/lib/write_xlsx/object_positioning.rb

@@ -0,0 +1,203 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/utility/cell_reference'
+require 'write_xlsx/utility/chart_formatting'
+require 'write_xlsx/utility/dimensions'
+require 'write_xlsx/utility/date_time'
+require 'write_xlsx/utility/url'
+require 'write_xlsx/utility/xml_primitives'
+require 'write_xlsx/utility/sheetname_quoting'
+
+module Writexlsx
+  module ObjectPositioning
+    include Writexlsx::Utility::CellReference
+    include Writexlsx::Utility::ChartFormatting
+    include Writexlsx::Utility::Dimensions
+    include Writexlsx::Utility::DateTime
+    include Writexlsx::Utility::Url
+    include Writexlsx::Utility::XmlPrimitives
+    include Writexlsx::Utility::SheetnameQuoting
+
+    #
+    # 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

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class App
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       attr_writer :doc_security
 
@@ -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/package/button.rb

@@ -1,12 +1,16 @@
 # -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/common'
+require 'write_xlsx/utility/string_width'
+require 'write_xlsx/utility/drawing'
 
 module Writexlsx
   module Package
     class Button
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::StringWidth
+      include Writexlsx::Utility::Drawing
 
       def initialize(worksheet, row, col, params, default_row_pixels, button_number)
         @worksheet = worksheet

data/lib/write_xlsx/package/comments.rb

@@ -1,14 +1,20 @@
 # -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
+require 'write_xlsx/constants'
 require 'write_xlsx/format'
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/common'
+require 'write_xlsx/utility/cell_reference'
+require 'write_xlsx/utility/drawing'
 
 module Writexlsx
   module Package
     class Comment
-      include Writexlsx::Utility
+      include Constants
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::CellReference
+      include Writexlsx::Utility::Drawing
 
       DEFAULT_COLOR  = 81  # what color ?
       DEFAULT_WIDTH  = 128
@@ -243,7 +249,9 @@ module Writexlsx
     end
 
     class Comments
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::CellReference
+      include Writexlsx::Utility::XmlPrimitives
 
       def initialize(worksheet)
         @worksheet = worksheet

data/lib/write_xlsx/package/conditional_format.rb

@@ -4,7 +4,11 @@
 module Writexlsx
   module Package
     class ConditionalFormat
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::CellReference
+      include Writexlsx::Utility::Dimensions
+      include Writexlsx::Utility::DateTime
+      include Writexlsx::Utility::XmlPrimitives
 
       def self.factory(worksheet, *args)
         range, param  =
@@ -481,7 +485,7 @@ module Writexlsx
         param[:criteria] = valid_criteria_type_for_conditional_formatting[param[:criteria].downcase] if param.has_key?(:criteria) && valid_criteria_type_for_conditional_formatting.has_key?(param[:criteria].downcase)
 
         # Convert date/times value if required.
-        if %w[date time cellIs].include?(param[:type])
+        if %w[date time].include?(param[:type])
           param[:type] = 'cellIs'
 
           param[:value]   = convert_date_time_if_required(param[:value])
@@ -744,7 +748,7 @@ module Writexlsx
           quoted_value = value.to_s
           numeric_regex = /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/
           # String "Cell" values must be quoted, apart from ranges.
-          if !(quoted_value =~ /(\$?)([A-Z]{1,3})(\$?)(\d+)/) &&
+          if !(quoted_value =~ /^(\$?)([A-Z]{1,3})(\$?)(\d+)/) &&
              !(quoted_value =~ numeric_regex) &&
              !(quoted_value =~ /^".*"$/)
             quoted_value = %("#{value}")

data/lib/write_xlsx/package/content_types.rb

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class ContentTypes
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       App_package  = 'application/vnd.openxmlformats-package.'
       App_document = 'application/vnd.openxmlformats-officedocument.'

data/lib/write_xlsx/package/core.rb

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class Core
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       App_package  = 'application/vnd.openxmlformats-package.'
       App_document = 'application/vnd.openxmlformats-officedocument.'

data/lib/write_xlsx/package/custom.rb

@@ -2,12 +2,13 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class Custom
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::XmlPrimitives
 
       def initialize
         @writer     = Package::XMLWriterSimple.new

data/lib/write_xlsx/package/metadata.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
@@ -10,7 +10,7 @@ module Writexlsx
     # Metadata - A class for writing the Excel XLSX metadata.xml file.
     #
     class Metadata
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       attr_writer :has_dynamic_functions
       attr_writer :num_embedded_images

data/lib/write_xlsx/package/packager.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
 require 'write_xlsx/package/app'
 require 'write_xlsx/package/comments'
 require 'write_xlsx/package/content_types'
@@ -23,8 +22,6 @@ require 'write_xlsx/package/vml'
 module Writexlsx
   module Package
     class Packager
-      include Writexlsx::Utility
-
       def initialize(workbook)
         @workbook     = workbook
         @package_dir  = ''

data/lib/write_xlsx/package/relationships.rb

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class Relationships
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       Schema_root     = 'http://schemas.openxmlformats.org'
       Package_schema  = Schema_root + '/package/2006/relationships'

data/lib/write_xlsx/package/rich_value.rb

@@ -2,12 +2,14 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/common'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class RichValue
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::XmlPrimitives
 
       attr_accessor :embedded_images
 

data/lib/write_xlsx/package/rich_value_rel.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
@@ -16,7 +16,7 @@ module Writexlsx
     # Convert to Ruby by Hideo Nakamura, nakamura.hideo@gmail.com
     #
     class RichValueRel
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       attr_writer :value_count
 

data/lib/write_xlsx/package/rich_value_structure.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
@@ -17,7 +17,7 @@ module Writexlsx
     # Convert to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
     #
     class RichValueStructure
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       attr_writer :has_embedded_descriptions
 

data/lib/write_xlsx/package/rich_value_types.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
@@ -16,10 +16,10 @@ module Writexlsx
     # Convert to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
     #
     class RichValueTypes
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       def initialize
-        @writer          = Package::XMLWriterSimple.new
+        @writer = Package::XMLWriterSimple.new
       end
 
       def set_xml_writer(filename)

data/lib/write_xlsx/package/shared_strings.rb

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class SharedStrings
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       PRESERVE_SPACE_ATTRIBUTES = ['xml:space', 'preserve'].freeze
 

data/lib/write_xlsx/package/styles.rb

@@ -2,12 +2,16 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/common'
+require 'write_xlsx/utility/chart_formatting'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class Styles
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::ChartFormatting
+      include Writexlsx::Utility::XmlPrimitives
 
       def initialize
         @writer = Package::XMLWriterSimple.new
@@ -247,7 +251,7 @@ module Writexlsx
       def write_fill(format, dxf_format = nil)
         # Special handling for pattern only case.
         if pattern_only_case?(format, dxf_format)
-          write_default_fill(PATTERNS[format.pattern])
+          write_default_fill(PATTERNS[format.fill_style.pattern])
         else
           @writer.tag_elements('fill') do
             write_fill_base(format, dxf_format)
@@ -258,15 +262,15 @@ module Writexlsx
       def pattern_only_case?(format, dxf_format)
         bg_color, fg_color = bg_and_fg_color(format, dxf_format)
 
-        !ptrue?(fg_color) && !ptrue?(bg_color) && ptrue?(format.pattern)
+        !ptrue?(fg_color) && !ptrue?(bg_color) && ptrue?(format.fill_style.pattern)
       end
 
       def write_fill_base(format, dxf_format)
         # The "none" pattern is handled differently for dxf formats.
-        attributes = if dxf_format && format.pattern <= 1
+        attributes = if dxf_format && format.fill_style.pattern <= 1
                        []
                      else
-                       [['patternType', PATTERNS[format.pattern]]]
+                       [['patternType', PATTERNS[format.fill_style.pattern]]]
                      end
 
         @writer.tag_elements('patternFill', attributes) do
@@ -285,14 +289,14 @@ module Writexlsx
           if bg_color != 0x40 # 'Automatic'
             @writer.empty_tag('bgColor', [['rgb', palette_color(bg_color)]])
           end
-        elsif !dxf_format && format.pattern <= 1
+        elsif !dxf_format && format.fill_style.pattern <= 1
           @writer.empty_tag('bgColor', [['indexed', 64]])
         end
       end
 
       def bg_and_fg_color(format, dxf_format)
-        bg_color   = format.bg_color
-        fg_color   = format.fg_color
+        bg_color   = format.fill_style.bg_color
+        fg_color   = format.fill_style.fg_color
 
         # Colors for dxf formats are handled differently from normal formats since
         # the normal format reverses the meaning of BG and FG for solid fills.

data/lib/write_xlsx/package/table.rb

@@ -2,12 +2,18 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/common'
+require 'write_xlsx/utility/cell_reference'
+require 'write_xlsx/utility/dimensions'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   module Package
     class Table
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::CellReference
+      include Writexlsx::Utility::Dimensions
+      include Writexlsx::Utility::XmlPrimitives
 
       class ColumnData
         attr_reader :id

data/lib/write_xlsx/package/theme.rb

@@ -2,13 +2,10 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
     class Theme
-      include Writexlsx::Utility
-
       def initialize
         @writer = nil
       end

data/lib/write_xlsx/package/vml.rb

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/drawing'
 
 module Writexlsx
   module Package
     class Vml
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Drawing
 
       def initialize
         @writer = Package::XMLWriterSimple.new