write_xlsx 1.12.3 → 1.15.0

data/lib/write_xlsx/page_setup.rb

@@ -0,0 +1,192 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/utility/common'
+
+module Writexlsx
+  class PageSetup # :nodoc:
+    include Writexlsx::Utility::Common
+
+    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/shape.rb

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
+require 'write_xlsx/utility/chart_formatting'
+
 module Writexlsx
   ###############################################################################
   #
@@ -12,7 +14,7 @@ module Writexlsx
   # Converted to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
   #
   class Shape
-    include Writexlsx::Utility
+    include Writexlsx::Utility::ChartFormatting
 
     attr_reader :edit_as, :drawing
     attr_reader :tx_box, :fill, :line, :format
@@ -27,106 +29,11 @@ module Writexlsx
 
     def initialize(properties = {})
       @writer = Package::XMLWriterSimple.new
-      @name   = nil
-      @type   = 'rect'
-
-      # Is a Connector shape. 1/0 Value is a hash lookup from type.
-      @connect = 0
-
-      # Is a Drawing. Always 0, since a single shape never fills an entire sheet.
-      @drawing = 0
-
-      # OneCell or Absolute: options to move and/or size with cells.
-      @edit_as = nil
-
-      # Auto-incremented, unless supplied by user.
-      @id = 0
-
-      # Shape text (usually centered on shape geometry).
-      @text = 0
-
-      # Shape stencil mode.  A copy (child) is created when inserted.
-      # The link to parent is broken.
-      @stencil = 1
-
-      # Index to _shapes array when inserted.
-      @element = -1
-
-      # Shape ID of starting connection, if any.
-      @start = nil
-
-      # Shape vertex, starts at 0, numbered clockwise from 12 o'clock.
-      @start_index = nil
-
-      @end       = nil
-      @end_index = nil
-
-      # Number and size of adjustments for shapes (usually connectors).
-      @adjustments = []
-
-      # Start and end sides. t)op, b)ottom, l)eft, or r)ight.
-      @start_side = ''
-      @end_side   = ''
-
-      # Flip shape Horizontally. eg. arrow left to arrow right.
-      @flip_h = 0
 
-      # Flip shape Vertically. eg. up arrow to down arrow.
-      @flip_v = 0
-
-      # shape rotation (in degrees 0-360).
-      @rotation = 0
-
-      # An alternate way to create a text box, because Excel allows it.
-      # It is just a rectangle with text.
-      @tx_box = false
-
-      # Shape outline colour, or 0 for noFill (default black).
-      @line = '000000'
-
-      # Line type: dash, sysDot, dashDot, lgDash, lgDashDot, lgDashDotDot.
-      @line_type = ''
-
-      # Line weight (integer).
-      @line_weight = 1
-
-      # Shape fill colour, or 0 for noFill (default noFill).
-      @fill = 0
-
-      # Formatting for shape text, if any.
-      @format = {}
-
-      # copy of colour palette table from Workbook.pm.
-      @palette = []
-
-      # Vertical alignment: t, ctr, b.
-      @valign = 'ctr'
-
-      # Alignment: l, ctr, r, just
-      @align = 'ctr'
-
-      @x_offset = 0
-      @y_offset = 0
-
-      # Scale factors, which also may be set when the shape is inserted.
-      @scale_x = 1
-      @scale_y = 1
-
-      # Default size, which can be modified and/or scaled.
-      @width  = 50
-      @height = 50
-
-      # Initial assignment. May be modified when prepared.
-      @column_start = 0
-      @row_start    = 0
-      @x1           = 0
-      @y1           = 0
-      @column_end   = 0
-      @row_end      = 0
-      @x2           = 0
-      @y2           = 0
-      @x_abs        = 0
-      @y_abs        = 0
+      init_basic_attributes
+      init_connection_attributes
+      init_appearance_attributes
+      init_position_attributes
 
       set_properties(properties)
     end
@@ -298,5 +205,95 @@ module Writexlsx
         @width_emu,    @height_emu
       ]
     end
+
+    private
+
+    def init_basic_attributes
+      @name    = nil
+      @type    = 'rect'
+
+      # Is a Connector shape. 1/0 Value is a hash lookup from type.
+      @connect = 0
+      # Is a Drawing. Always 0, since a single shape never fills an entire sheet.
+      @drawing = 0
+      # OneCell or Absolute: options to move and/or size with cells.
+      @edit_as = nil
+      # Auto-incremented, unless supplied by user.
+      @id      = 0
+      # Shape text (usually centered on shape geometry).
+      @text    = 0
+      # Shape stencil mode.  A copy (child) is created when inserted.
+      # The link to parent is broken.
+      @stencil = 1
+      # Index to _shapes array when inserted.
+      @element = -1
+      # An alternate way to create a text box, because Excel allows it.
+      # It is just a rectangle with text.
+      @tx_box  = false
+      # copy of colour palette table from Workbook.pm.
+      @palette = []
+    end
+
+    def init_connection_attributes
+      # Shape ID of starting connection, if any.
+      @start       = nil
+      # Shape vertex, starts at 0, numbered clockwise from 12 o'clock.
+      @start_index = nil
+      @end         = nil
+      @end_index   = nil
+      # Number and size of adjustments for shapes (usually connectors).
+      @adjustments = []
+      # Start and end sides. t)op, b)ottom, l)eft, or r)ight.
+      @start_side  = ''
+      @end_side    = ''
+    end
+
+    def init_appearance_attributes
+      # Flip shape Horizontally. eg. arrow left to arrow right.
+      @flip_h      = 0
+      # Flip shape Vertically. eg. up arrow to down arrow.
+      @flip_v      = 0
+      # shape rotation (in degrees 0-360).
+      @rotation    = 0
+      # Shape outline colour, or 0 for noFill (default black).
+      @line        = '000000'
+      # Line type: dash, sysDot, dashDot, lgDash, lgDashDot, lgDashDotDot.
+      @line_type   = ''
+      # Line weight (integer).
+      @line_weight = 1
+      # Shape fill colour, or 0 for noFill (default noFill).
+      @fill        = 0
+      # Formatting for shape text, if any.
+      @format      = {}
+      # Vertical alignment: t, ctr, b.
+      @valign      = 'ctr'
+      # Alignment: l, ctr, r, just
+      @align       = 'ctr'
+    end
+
+    def init_position_attributes
+      @x_offset     = 0
+      @y_offset     = 0
+
+      # Scale factors, which also may be set when the shape is inserted.
+      @scale_x      = 1
+      @scale_y      = 1
+
+      # Default size, which can be modified and/or scaled.
+      @width        = 50
+      @height       = 50
+
+      # Initial assignment. May be modified when prepared.
+      @column_start = 0
+      @row_start    = 0
+      @x1           = 0
+      @y1           = 0
+      @column_end   = 0
+      @row_end      = 0
+      @x2           = 0
+      @y2           = 0
+      @x_abs        = 0
+      @y_abs        = 0
+    end
   end
 end

data/lib/write_xlsx/sheets.rb

@@ -2,11 +2,16 @@
 # frozen_string_literal: true
 
 require 'delegate'
+require 'write_xlsx/constants'
+require 'write_xlsx/utility/common'
+require 'write_xlsx/utility/xml_primitives'
 require 'write_xlsx/package/xml_writer_simple'
 
 module Writexlsx
   class Sheets < DelegateClass(Array)
-    include Writexlsx::Utility
+    include Constants
+    include Writexlsx::Utility::Common
+    include Writexlsx::Utility::XmlPrimitives
 
     BASE_NAME = { sheet: 'Sheet', chart: 'Chart' }  # :nodoc:
 
@@ -91,9 +96,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/sparkline.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/common'
 
 module Writexlsx
   ###############################################################################
@@ -14,7 +14,7 @@ module Writexlsx
   # Converted to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
   #
   class Sparkline
-    include Writexlsx::Utility
+    include Writexlsx::Utility::Common
 
     def initialize(ws, param, sheetname)
       @color = {}

data/lib/write_xlsx/utility/cell_reference.rb

@@ -0,0 +1,124 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/col_name'
+require 'write_xlsx/constants'
+
+module Writexlsx
+  module Utility
+    module CellReference
+      include Constants
+
+      #
+      # xl_rowcol_to_cell($row, col, row_absolute, col_absolute)
+      #
+      def xl_rowcol_to_cell(row_or_name, col, row_absolute = false, col_absolute = false)
+        if row_or_name.is_a?(Integer)
+          row_or_name += 1      # Change from 0-indexed to 1 indexed.
+        end
+        col_str = xl_col_to_name(col, col_absolute)
+        "#{col_str}#{absolute_char(row_absolute)}#{row_or_name}"
+      end
+
+      #
+      # Returns: [row, col, row_absolute, col_absolute]
+      #
+      # The row_absolute and col_absolute parameters aren't documented because they
+      # mainly used internally and aren't very useful to the user.
+      #
+      def xl_cell_to_rowcol(cell)
+        cell =~ /(\$?)([A-Z]{1,3})(\$?)(\d+)/
+
+        col_abs = ::Regexp.last_match(1) != ""
+        col     = ::Regexp.last_match(2)
+        row_abs = ::Regexp.last_match(3) != ""
+        row     = ::Regexp.last_match(4).to_i
+
+        # Convert base26 column string to number
+        # All your Base are belong to us.
+        chars = col.chars
+        expn = 0
+        col = 0
+
+        chars.reverse.each do |char|
+          col += (char.ord - 'A'.ord + 1) * (26**expn)
+          expn += 1
+        end
+
+        # Convert 1-index to zero-index
+        row -= 1
+        col -= 1
+
+        [row, col, row_abs, col_abs]
+      end
+
+      def xl_col_to_name(col, col_absolute)
+        col_str = ColName.instance.col_str(col)
+        if col_absolute
+          "#{absolute_char(col_absolute)}#{col_str}"
+        else
+          # Do not allocate new string
+          col_str
+        end
+      end
+
+      def xl_range(row_1, row_2, col_1, col_2,
+                   row_abs_1 = false, row_abs_2 = false, col_abs_1 = false, col_abs_2 = false)
+        range1 = xl_rowcol_to_cell(row_1, col_1, row_abs_1, col_abs_1)
+        range2 = xl_rowcol_to_cell(row_2, col_2, row_abs_2, col_abs_2)
+
+        if range1 == range2
+          range1
+        else
+          "#{range1}:#{range2}"
+        end
+      end
+
+      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 = 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)
+
+        "=#{sheetname}!#{range1}:#{range2}"
+      end
+
+      # Check for a cell reference in A1 notation and substitute row and column
+      def row_col_notation(row_or_a1)   # :nodoc:
+        substitute_cellref(row_or_a1) if row_or_a1.respond_to?(:match) && row_or_a1.to_s =~ /^\D/
+      end
+
+      #
+      # Substitute an Excel cell reference in A1 notation for  zero based row and
+      # column values in an argument list.
+      #
+      # Ex: ("A4", "Hello") is converted to (3, 0, "Hello").
+      #
+      def substitute_cellref(cell, *args)       # :nodoc:
+        normalized_cell = cell.upcase
+
+        case normalized_cell
+        # Convert a column range: 'A:A' or 'B:G'.
+        # A range such as A:A is equivalent to A1:65536, so add rows as required
+        when /\$?([A-Z]{1,3}):\$?([A-Z]{1,3})/
+          row1, col1 =  xl_cell_to_rowcol(::Regexp.last_match(1) + '1')
+          row2, col2 =  xl_cell_to_rowcol(::Regexp.last_match(2) + ROW_MAX.to_s)
+          [row1, col1, row2, col2, *args]
+        # Convert a cell range: 'A1:B7'
+        when /\$?([A-Z]{1,3}\$?\d+):\$?([A-Z]{1,3}\$?\d+)/
+          row1, col1 =  xl_cell_to_rowcol(::Regexp.last_match(1))
+          row2, col2 =  xl_cell_to_rowcol(::Regexp.last_match(2))
+          [row1, col1, row2, col2, *args]
+        # Convert a cell reference: 'A1' or 'AD2000'
+        when /\$?([A-Z]{1,3}\$?\d+)/
+          row1, col1 = xl_cell_to_rowcol(::Regexp.last_match(1))
+          [row1, col1, *args]
+        else
+          raise("Unknown cell reference #{normalized_cell}")
+        end
+      end
+    end
+  end
+end