write_xlsx 1.12.3 → 1.15.0

data/lib/write_xlsx/workbook/format_preparation.rb

@@ -0,0 +1,199 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+module Writexlsx
+  class Workbook
+    module FormatPreparation
+      private
+
+      #
+      # Prepare all of the format properties prior to passing them to Styles.rb.
+      #
+      def prepare_format_properties # :nodoc:
+        # Separate format objects into XF and DXF formats.
+        prepare_formats
+
+        # Set the font index for the format objects.
+        prepare_fonts
+
+        # Set the number format index for the format objects.
+        prepare_num_formats
+
+        # Set the border index for the format objects.
+        prepare_borders
+
+        # Set the fill index for the format objects.
+        prepare_fills
+      end
+
+      #
+      # Iterate through the XF Format objects and separate them into XF and DXF
+      # formats.
+      #
+      def prepare_formats # :nodoc:
+        @formats.formats.each do |format|
+          xf_index  = format.xf_index
+          dxf_index = format.dxf_index
+
+          @xf_formats[xf_index] = format   if xf_index
+          @dxf_formats[dxf_index] = format if dxf_index
+        end
+      end
+
+      #
+      # Iterate through the XF Format objects and give them an index to non-default
+      # font elements.
+      #
+      def prepare_fonts # :nodoc:
+        fonts = {}
+
+        @xf_formats.each { |format| format.set_font_info(fonts) }
+
+        @font_count = fonts.size
+
+        # For the DXF formats we only need to check if the properties have changed.
+        @dxf_formats.each do |format|
+          # The only font properties that can change for a DXF format are: color,
+          # bold, italic, underline and strikethrough.
+          format.has_dxf_font(true) if format.color? || format.bold? || format.italic? || format.underline? || format.strikeout?
+        end
+      end
+
+      #
+      # Iterate through the XF Format objects and give them an index to non-default
+      # number format elements.
+      #
+      # User defined records start from index 0xA4.
+      #
+      def prepare_num_formats # :nodoc:
+        num_formats        = []
+        unique_num_formats = {}
+        index              = 164
+
+        (@xf_formats + @dxf_formats).each do |format|
+          num_format = format.num_format
+
+          # Check if num_format is an index to a built-in number format.
+          # Also check for a string of zeros, which is a valid number format
+          # string but would evaluate to zero.
+          #
+          if num_format.to_s =~ /^\d+$/ && num_format.to_s !~ /^0+\d/
+            # Number format '0' is indexed as 1 in Excel.
+            num_format = 1 if num_format == 0
+            # Index to a built-in number format.
+            format.num_format_index = num_format
+            next
+          elsif num_format.to_s == 'General'
+            # The 'General' format has an number format index of 0.
+            format.num_format_index = 0
+            next
+          end
+
+          if unique_num_formats[num_format]
+            # Number format has already been used.
+            format.num_format_index = unique_num_formats[num_format]
+          else
+            # Add a new number format.
+            unique_num_formats[num_format] = index
+            format.num_format_index = index
+            index += 1
+
+            # Only store/increase number format count for XF formats
+            # (not for DXF formats).
+            num_formats << num_format if ptrue?(format.xf_index)
+          end
+        end
+
+        @num_formats = num_formats
+      end
+
+      #
+      # Iterate through the XF Format objects and give them an index to non-default
+      # border elements.
+      #
+      def prepare_borders # :nodoc:
+        borders = {}
+
+        @xf_formats.each { |format| format.set_border_info(borders) }
+
+        @border_count = borders.size
+
+        # For the DXF formats we only need to check if the properties have changed.
+        @dxf_formats.each do |format|
+          key = format.get_border_key
+          format.has_dxf_border(true) if key =~ /[^0:]/
+        end
+      end
+
+      #
+      # Iterate through the XF Format objects and give them an index to non-default
+      # fill elements.
+      #
+      # The user defined fill properties start from 2 since there are 2 default
+      # fills: patternType="none" and patternType="gray125".
+      #
+      def prepare_fills # :nodoc:
+        fills = {}
+        index = 2    # Start from 2. See above.
+
+        # Add the default fills.
+        fills['0:0:0']  = 0
+        fills['17:0:0'] = 1
+
+        # Store the DXF colors separately since them may be reversed below.
+        @dxf_formats.each do |format|
+          next unless format.fill_style.pattern != 0 || format.fill_style.bg_color != 0 || format.fill_style.fg_color != 0
+
+          format.has_dxf_fill(true)
+          format.dxf_bg_color = format.fill_style.bg_color
+          format.dxf_fg_color = format.fill_style.fg_color
+        end
+
+        @xf_formats.each do |format|
+          # The following logical statements jointly take care of special cases
+          # in relation to cell colours and patterns:
+          # 1. For a solid fill (_pattern == 1) Excel reverses the role of
+          #    foreground and background colours, and
+          # 2. If the user specifies a foreground or background colour without
+          #    a pattern they probably wanted a solid fill, so we fill in the
+          #    defaults.
+          #
+          if format.fill_style.pattern == 1 && ne_0?(format.fill_style.bg_color) && ne_0?(format.fill_style.fg_color)
+            format.fill_style.fg_color, format.fill_style.bg_color = format.fill_style.bg_color, format.fill_style.fg_color
+          elsif format.fill_style.pattern <= 1 && ne_0?(format.fill_style.bg_color) && eq_0?(format.fill_style.fg_color)
+            format.fill_style.fg_color = format.fill_style.bg_color
+            format.fill_style.bg_color = 0
+            format.fill_style.pattern  = 1
+          elsif format.fill_style.pattern <= 1 && eq_0?(format.fill_style.bg_color) && ne_0?(format.fill_style.fg_color)
+            format.fill_style.bg_color = 0
+            format.fill_style.pattern  = 1
+          end
+
+          key = format.get_fill_key
+
+          if fills[key]
+            # Fill has already been used.
+            format.fill_index = fills[key]
+            format.has_fill(false)
+          else
+            # This is a new fill.
+            fills[key]        = index
+            format.fill_index = index
+            format.has_fill(true)
+            index += 1
+          end
+        end
+
+        @fill_count = index
+      end
+
+      def eq_0?(val)
+        !ptrue?(val)
+      end
+
+      def ne_0?(val)
+        !eq_0?(val)
+      end
+    end
+  end
+end

data/lib/write_xlsx/workbook/initialization.rb

@@ -0,0 +1,223 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+module Writexlsx
+  class Workbook
+    #
+    # Workbook initialization helpers extracted from Workbook to keep the main
+    # class focused on public API and orchestration.
+    #
+    module Initialization
+      private
+
+      def setup_core_state(file, options, default_formats)
+        @options = options.dup                 # for test
+        @default_formats = default_formats.dup # for test
+        @writer = Package::XMLWriterSimple.new
+
+        @file = file
+        @tempdir = options[:tempdir] ||
+                   File.join(
+                     Dir.tmpdir,
+                     Digest::MD5.hexdigest("#{Time.now.to_f}-#{Process.pid}")
+                   )
+
+        @date_1904       = options[:date_1904] || false
+        @activesheet     = 0
+        @firstsheet      = 0
+        @selected        = 0
+        @fileclosed      = false
+        @optimization    = options[:optimization] || 0
+        @excel2003_style = options[:excel2003_style] || false
+        @read_only       = 0
+
+        @strings_to_urls =
+          options[:strings_to_urls].nil? || options[:strings_to_urls] ? true : false
+
+        @max_url_length = if options[:max_url_length]
+                            [options[:max_url_length].to_i, 255].max
+                          else
+                            MAX_URL_LENGTH
+                          end
+      end
+
+      def setup_workbook_state(_options)
+        @worksheets        = Sheets.new
+        @charts            = []
+        @drawings          = []
+        @defined_names     = []
+        @named_ranges      = []
+        @custom_colors     = []
+        @doc_properties    = {}
+        @custom_properties = []
+        @image_types       = {}
+        @images            = []
+        @has_comments      = false
+        @has_metadata      = false
+        @has_embedded_images = false
+        @has_embedded_descriptions = false
+
+        @x_window      = 240
+        @y_window      = 15
+        @window_width  = 16_095
+        @window_height = 9_660
+        @tab_ratio     = 600
+      end
+
+      def setup_format_state(_default_formats)
+        @formats     = Formats.new
+        @xf_formats  = []
+        @dxf_formats = []
+        @num_formats = []
+      end
+
+      def setup_shared_strings
+        @shared_strings = Package::SharedStrings.new
+      end
+
+      def setup_embedded_assets
+        @embedded_image_indexes = {}
+        @embedded_images        = []
+      end
+
+      def setup_calculation_state
+        @calc_id      = 124519
+        @calc_mode    = 'auto'
+        @calc_on_load = true
+      end
+
+      def setup_default_formats
+        if @excel2003_style
+          add_format(
+            @default_formats.merge(
+              xf_index:    0,
+              font_family: 0,
+              font:        'Arial',
+              size:        10,
+              theme:       -1
+            )
+          )
+        else
+          add_format(@default_formats.merge(xf_index: 0))
+        end
+
+        # Add a default URL format.
+        @default_url_format = add_format(hyperlink: 1)
+      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 max_url_length]
+
+          hash = params.first
+          options = hash.select { |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
+
+      def filename
+        setup_filename unless @filename
+        @filename
+      end
+
+      def fileobj
+        setup_filename unless @fileobj
+        @fileobj
+      end
+
+      def setup_filename # :nodoc:
+        if @file.respond_to?(:to_str) && @file != ''
+          @filename = @file
+          @fileobj  = nil
+        elsif @file.respond_to?(:write)
+          @filename = File.join(tempdir, Digest::MD5.hexdigest(Time.now.to_s) + '.xlsx.tmp')
+          @fileobj  = @file
+        else
+          raise "'#{@file}' must be valid filename String of IO object."
+        end
+      end
+
+      attr_reader :tempdir
+
+      #
+      # Sets the colour palette to the Excel defaults.
+      #
+      def set_color_palette # :nodoc:
+        @palette = [
+          [0x00, 0x00, 0x00, 0x00],    # 8
+          [0xff, 0xff, 0xff, 0x00],    # 9
+          [0xff, 0x00, 0x00, 0x00],    # 10
+          [0x00, 0xff, 0x00, 0x00],    # 11
+          [0x00, 0x00, 0xff, 0x00],    # 12
+          [0xff, 0xff, 0x00, 0x00],    # 13
+          [0xff, 0x00, 0xff, 0x00],    # 14
+          [0x00, 0xff, 0xff, 0x00],    # 15
+          [0x80, 0x00, 0x00, 0x00],    # 16
+          [0x00, 0x80, 0x00, 0x00],    # 17
+          [0x00, 0x00, 0x80, 0x00],    # 18
+          [0x80, 0x80, 0x00, 0x00],    # 19
+          [0x80, 0x00, 0x80, 0x00],    # 20
+          [0x00, 0x80, 0x80, 0x00],    # 21
+          [0xc0, 0xc0, 0xc0, 0x00],    # 22
+          [0x80, 0x80, 0x80, 0x00],    # 23
+          [0x99, 0x99, 0xff, 0x00],    # 24
+          [0x99, 0x33, 0x66, 0x00],    # 25
+          [0xff, 0xff, 0xcc, 0x00],    # 26
+          [0xcc, 0xff, 0xff, 0x00],    # 27
+          [0x66, 0x00, 0x66, 0x00],    # 28
+          [0xff, 0x80, 0x80, 0x00],    # 29
+          [0x00, 0x66, 0xcc, 0x00],    # 30
+          [0xcc, 0xcc, 0xff, 0x00],    # 31
+          [0x00, 0x00, 0x80, 0x00],    # 32
+          [0xff, 0x00, 0xff, 0x00],    # 33
+          [0xff, 0xff, 0x00, 0x00],    # 34
+          [0x00, 0xff, 0xff, 0x00],    # 35
+          [0x80, 0x00, 0x80, 0x00],    # 36
+          [0x80, 0x00, 0x00, 0x00],    # 37
+          [0x00, 0x80, 0x80, 0x00],    # 38
+          [0x00, 0x00, 0xff, 0x00],    # 39
+          [0x00, 0xcc, 0xff, 0x00],    # 40
+          [0xcc, 0xff, 0xff, 0x00],    # 41
+          [0xcc, 0xff, 0xcc, 0x00],    # 42
+          [0xff, 0xff, 0x99, 0x00],    # 43
+          [0x99, 0xcc, 0xff, 0x00],    # 44
+          [0xff, 0x99, 0xcc, 0x00],    # 45
+          [0xcc, 0x99, 0xff, 0x00],    # 46
+          [0xff, 0xcc, 0x99, 0x00],    # 47
+          [0x33, 0x66, 0xff, 0x00],    # 48
+          [0x33, 0xcc, 0xcc, 0x00],    # 49
+          [0x99, 0xcc, 0x00, 0x00],    # 50
+          [0xff, 0xcc, 0x00, 0x00],    # 51
+          [0xff, 0x99, 0x00, 0x00],    # 52
+          [0xff, 0x66, 0x00, 0x00],    # 53
+          [0x66, 0x66, 0x99, 0x00],    # 54
+          [0x96, 0x96, 0x96, 0x00],    # 55
+          [0x00, 0x33, 0x66, 0x00],    # 56
+          [0x33, 0x99, 0x66, 0x00],    # 57
+          [0x00, 0x33, 0x00, 0x00],    # 58
+          [0x33, 0x33, 0x00, 0x00],    # 59
+          [0x99, 0x33, 0x00, 0x00],    # 60
+          [0x99, 0x33, 0x66, 0x00],    # 61
+          [0x33, 0x33, 0x99, 0x00],    # 62
+          [0x33, 0x33, 0x33, 0x00]    # 63
+        ]
+      end
+    end
+  end
+end

data/lib/write_xlsx/workbook/package_preparation.rb

@@ -0,0 +1,231 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+module Writexlsx
+  class Workbook
+    module PackagePreparation
+      private
+
+      #
+      # Assemble worksheets into a workbook.
+      #
+      def store_workbook # :nodoc:
+        # Add a default worksheet if non have been added.
+        add_worksheet if @worksheets.empty?
+
+        # Ensure that at least one worksheet has been selected.
+        @worksheets.visible_first.select if @activesheet == 0
+
+        # Set the active sheet.
+        @activesheet = @worksheets.visible_first.index if @activesheet == 0
+        @worksheets[@activesheet].activate
+
+        # Convert the SST strings data structure.
+        prepare_sst_string_data
+
+        # Prepare the worksheet VML elements such as comments and buttons.
+        prepare_vml_objects
+        # Set the defined names for the worksheets such as Print Titles.
+        prepare_defined_names
+        # Prepare the drawings, charts and images.
+        prepare_drawings
+        # Add cached data to charts.
+        add_chart_data
+
+        # Prepare the worksheet tables.
+        prepare_tables
+
+        # Prepare the metadata file links.
+        prepare_metadata
+
+        # Package the workbook.
+        packager = Package::Packager.new(self)
+        packager.set_package_dir(tempdir)
+        packager.create_package
+
+        # Free up the Packager object.
+        packager = nil
+
+        # Store the xlsx component files with the temp dir name removed.
+        ZipFileUtils.zip(tempdir.to_s, filename)
+
+        IO.copy_stream(filename, fileobj) if fileobj
+        delete_tempdir(tempdir)
+      end
+
+      #
+      # Iterate through the worksheets and store any defined names in addition to
+      # any user defined names. Stores the defined names for the Workbook.xml and
+      # the named ranges for App.xml.
+      #
+      def prepare_defined_names # :nodoc:
+        @worksheets.each do |sheet|
+          # Check for Print Area settings.
+          if sheet.autofilter_area
+            @defined_names << [
+              '_xlnm._FilterDatabase',
+              sheet.index,
+              sheet.autofilter_area,
+              1
+            ]
+          end
+
+          # Check for Print Area settings.
+          unless sheet.print_area.empty?
+            @defined_names << [
+              '_xlnm.Print_Area',
+              sheet.index,
+              sheet.print_area
+            ]
+          end
+
+          # Check for repeat rows/cols. aka, Print Titles.
+          next unless !sheet.print_repeat_cols.empty? || !sheet.print_repeat_rows.empty?
+
+          range = if !sheet.print_repeat_cols.empty? && !sheet.print_repeat_rows.empty?
+                    sheet.print_repeat_cols + ',' + sheet.print_repeat_rows
+                  else
+                    sheet.print_repeat_cols + sheet.print_repeat_rows
+                  end
+
+          # Store the defined names.
+          @defined_names << ['_xlnm.Print_Titles', sheet.index, range]
+        end
+
+        @defined_names = sort_defined_names(@defined_names)
+        @named_ranges  = extract_named_ranges(@defined_names)
+      end
+
+      #
+      # Iterate through the worksheets and set up the VML objects.
+      #
+      def prepare_vml_objects  # :nodoc:
+        comment_id     = 0
+        vml_drawing_id = 0
+        vml_data_id    = 1
+        vml_header_id  = 0
+        vml_shape_id   = 1024
+        has_button     = false
+
+        @worksheets.each do |sheet|
+          next if !sheet.has_vml? && !sheet.has_header_vml?
+
+          if sheet.has_vml?
+            if sheet.has_comments?
+              comment_id += 1
+              @has_comments = true
+            end
+            vml_drawing_id += 1
+
+            sheet.prepare_vml_objects(
+              vml_data_id, vml_shape_id,
+              vml_drawing_id, comment_id
+            )
+
+            # Each VML file should start with a shape id incremented by 1024.
+            vml_data_id += 1 * (1 + sheet.num_comments_block)
+            vml_shape_id += 1024 * (1 + sheet.num_comments_block)
+          end
+
+          if sheet.has_header_vml?
+            vml_header_id  += 1
+            vml_drawing_id += 1
+            sheet.prepare_header_vml_objects(vml_header_id, vml_drawing_id)
+          end
+
+          # Set the sheet vba_codename if it has a button and the workbook
+          # has a vbaProject binary.
+          unless sheet.buttons_data.empty?
+            has_button = true
+            sheet.set_vba_name if @vba_project && !sheet.vba_codename
+          end
+        end
+
+        # Set the workbook vba_codename if one of the sheets has a button and
+        # the workbook has a vbaProject binary.
+        set_vba_name if has_button && @vba_project && !@vba_codename
+      end
+
+      #
+      # Set the table ids for the worksheet tables.
+      #
+      def prepare_tables
+        table_id = 0
+        seen     = {}
+
+        sheets.each do |sheet|
+          table_id += sheet.prepare_tables(table_id + 1, seen)
+        end
+      end
+
+      #
+      # Set the metadata rel link.
+      #
+      def prepare_metadata
+        @worksheets.each do |sheet|
+          next unless sheet.has_dynamic_functions? || sheet.has_embedded_images?
+
+          @has_metadata = true
+          @has_dynamic_functions ||= sheet.has_dynamic_functions?
+          @has_embedded_images   ||= sheet.has_embedded_images?
+        end
+      end
+
+      #
+      # Iterate through the worksheets and set up any chart or image drawings.
+      #
+      def prepare_drawings # :nodoc:
+        # Store the image types for any embedded images.
+        @embedded_images.each do |image|
+          store_image_types(image.type)
+
+          @has_embedded_descriptions = true if ptrue?(image.description)
+        end
+
+        prepare_drawings_of_all_sheets
+
+        # Sort the workbook charts references into the order that the were
+        # written from the worksheets above.
+        @charts = @charts.reject { |chart| chart.id == -1 }
+                    .sort_by(&:id)
+      end
+
+      def prepare_drawings_of_all_sheets
+        drawing_id       = 0
+        chart_ref_id     = 0
+        image_ids        = {}
+        header_image_ids = {}
+        background_ids   = {}
+
+        # The image IDs start from after the embedded images.
+        image_ref_id = @embedded_images.size
+
+        @worksheets.each do |sheet|
+          drawing_id, chart_ref_id, image_ref_id =
+            sheet.prepare_drawings(
+              drawing_id, chart_ref_id, image_ref_id, image_ids,
+              header_image_ids, background_ids
+            )
+        end
+      end
+
+      #
+      # prepare_sst_string_data
+      #
+      def prepare_sst_string_data; end
+
+      def delete_tempdir(path)
+        if FileTest.file?(path)
+          File.delete(path)
+        elsif FileTest.directory?(path)
+          Dir.foreach(path) do |file|
+            next if file =~ /^\.\.?$/  # '.' or '..'
+
+            delete_tempdir(path.sub(%r{/+$}, "") + '/' + file)
+          end
+          Dir.rmdir(path)
+        end
+      end
+    end
+  end
+end