write_xlsx 1.13.0 → 1.15.1

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

data/lib/write_xlsx/workbook/workbook_writer.rb

@@ -0,0 +1,164 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+module Writexlsx
+  class Workbook
+    module Initialization
+      #
+      # user must not use. it is internal method.
+      #
+      def assemble_xml_file  # :nodoc:
+        return unless @writer
+
+        # Prepare format object for passing to Style.rb.
+        prepare_format_properties
+
+        write_xml_declaration do
+          # Write the root workbook element.
+          write_workbook do
+            # Write the XLSX file version.
+            write_file_version
+
+            # Write the fileSharing element.
+            write_file_sharing
+
+            # Write the workbook properties.
+            write_workbook_pr
+
+            # Write the workbook view properties.
+            write_book_views
+
+            # Write the worksheet names and ids.
+            @worksheets.write_sheets(@writer)
+
+            # Write the workbook defined names.
+            write_defined_names
+
+            # Write the workbook calculation properties.
+            write_calc_pr
+
+            # Write the workbook extension storage.
+            # write_ext_lst
+          end
+        end
+      end
+
+      private
+
+      def write_workbook(&block) # :nodoc:
+        schema = 'http://schemas.openxmlformats.org'
+        attributes = [
+          ['xmlns',
+           schema + '/spreadsheetml/2006/main'],
+          ['xmlns:r',
+           schema + '/officeDocument/2006/relationships']
+        ]
+        @writer.tag_elements('workbook', attributes, &block)
+      end
+
+      def write_file_version # :nodoc:
+        attributes = [
+          %w[appName xl],
+          ['lastEdited', 4],
+          ['lowestEdited', 4],
+          ['rupBuild', 4505]
+        ]
+
+        attributes << [:codeName, '{37E998C4-C9E5-D4B9-71C8-EB1FF731991C}'] if @vba_project
+
+        @writer.empty_tag('fileVersion', attributes)
+      end
+
+      #
+      # Write the <fileSharing> element.
+      #
+      def write_file_sharing
+        return unless ptrue?(@read_only)
+
+        attributes = []
+        attributes << ['readOnlyRecommended', 1]
+        @writer.empty_tag('fileSharing', attributes)
+      end
+
+      def write_workbook_pr # :nodoc:
+        attributes = []
+        attributes << ['codeName', @vba_codename]  if ptrue?(@vba_codename)
+        attributes << ['date1904', 1]              if date_1904?
+        attributes << ['defaultThemeVersion', 124226]
+        @writer.empty_tag('workbookPr', attributes)
+      end
+
+      def write_book_views # :nodoc:
+        @writer.tag_elements('bookViews') { write_workbook_view }
+      end
+
+      def write_workbook_view # :nodoc:
+        attributes = [
+          ['xWindow',       @x_window],
+          ['yWindow',       @y_window],
+          ['windowWidth',   @window_width],
+          ['windowHeight',  @window_height]
+        ]
+        attributes << ['tabRatio', @tab_ratio] if @tab_ratio != 600
+        attributes << ['firstSheet', @firstsheet + 1] if @firstsheet > 0
+        attributes << ['activeTab', @activesheet] if @activesheet > 0
+        @writer.empty_tag('workbookView', attributes)
+      end
+
+      def write_calc_pr # :nodoc:
+        attributes = [['calcId', @calc_id]]
+
+        case @calc_mode
+        when 'manual'
+          attributes << %w[calcMode manual]
+          attributes << ['calcOnSave', 0]
+        when 'autoNoTable'
+          attributes << %w[calcMode autoNoTable]
+        end
+
+        attributes << ['fullCalcOnLoad', 1] if @calc_on_load
+
+        @writer.empty_tag('calcPr', attributes)
+      end
+
+      def write_ext_lst # :nodoc:
+        @writer.tag_elements('extLst') { write_ext }
+      end
+
+      def write_ext # :nodoc:
+        attributes = [
+          ['xmlns:mx', "#{OFFICE_URL}mac/excel/2008/main"],
+          ['uri', uri]
+        ]
+        @writer.tag_elements('ext', attributes) { write_mx_arch_id }
+      end
+
+      def write_mx_arch_id # :nodoc:
+        @writer.empty_tag('mx:ArchID', ['Flags', 2])
+      end
+
+      def write_defined_names # :nodoc:
+        return unless ptrue?(@defined_names)
+
+        @writer.tag_elements('definedNames') do
+          @defined_names.each { |defined_name| write_defined_name(defined_name) }
+        end
+      end
+
+      def write_defined_name(defined_name) # :nodoc:
+        name, id, range, hidden = defined_name
+
+        attributes = [['name', name]]
+        attributes << ['localSheetId', id.to_s] unless id == -1
+        attributes << %w[hidden 1]     if hidden
+
+        @writer.data_element('definedName', range, attributes)
+      end
+
+      def write_io(str) # :nodoc:
+        @writer << str
+        str
+      end
+    end
+  end
+end