write_xlsx 0.81.1 → 0.83.0

data/lib/write_xlsx/package/table.rb

@@ -101,10 +101,8 @@ def overrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
             # Handle the function for the total row.
             if user_data[:total_function]
               handle_the_function_for_the_table_row(
-                                                    @row2, col_data, col_num,
-                                                    user_data[:total_function],
-                                                    user_data[:format]
-                                                    )
+                @row2, col_data, col_num, user_data
+              )
             elsif user_data[:total_string]
               total_label_only(
                                @row2, col_num, col_data, user_data[:total_string], user_data[:format]
@@ -212,8 +210,8 @@ def handle_the_column_formula(col_data, col_num, formula, format)
         end
       end
 
-      def handle_the_function_for_the_table_row(row2, col_data, col_num, total_function, format)
-        function = total_function.downcase.gsub(/[_\s]/, '')
+      def handle_the_function_for_the_table_row(row2, col_data, col_num, user_data)
+        function = user_data[:total_function].downcase.gsub(/[_\s]/, '')
 
         function = 'countNums' if function == 'countnums'
         function = 'stdDev'    if function == 'stddev'
@@ -221,7 +219,7 @@ def handle_the_function_for_the_table_row(row2, col_data, col_num, total_functio
         col_data.total_function = function
 
         formula = table_function_to_formula(function, col_data.name)
-        @worksheet.write_formula(row2, col_num, formula, format)
+        @worksheet.write_formula(row2, col_num, formula, user_data[:format], user_data[:total_value])
       end
 
       #

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -7,6 +7,8 @@
 module Writexlsx
   module Package
     class XMLWriterSimple
+      XMLNS = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
+
       def initialize
         @io = StringIO.new
       end

data/lib/write_xlsx/sheets.rb

@@ -197,8 +197,6 @@ def index_by_name(sheetname)
       self.collect { |sheet| sheet.name }.index(name)
     end
 
-    private
-
     def worksheets
       self.reject { |worksheet| worksheet.is_chartsheet? }
     end
@@ -207,6 +205,8 @@ def chartsheets
       self.select { |worksheet| worksheet.is_chartsheet? }
     end
 
+    private
+
     def sheet_chart_count(type)
       case type
       when :sheet

data/lib/write_xlsx/utility.rb

@@ -13,8 +13,6 @@ module Utility
     #
     def xl_rowcol_to_cell(row, col, row_absolute = false, col_absolute = false)
       row += 1      # Change from 0-indexed to 1 indexed.
-      row_abs = row_absolute ? '$' : ''
-      col_abs = col_absolute ? '$' : ''
       col_str = xl_col_to_name(col, col_absolute)
       "#{col_str}#{absolute_char(row_absolute)}#{row}"
     end
@@ -75,6 +73,23 @@ def xl_range_formula(sheetname, row_1, row_2, col_1, col_2)
       "=#{sheetname}!#{range1}:#{range2}"
     end
 
+    #
+    # Sheetnames used in references should be quoted if they contain any spaces,
+    # special characters or if the look like something that isn't a sheet name.
+    # 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
+    end
+
     def check_dimensions(row, col)
       if !row || row >= ROW_MAX || !col || col >= COL_MAX
         raise WriteXLSXDimensionError

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.81.1"
+WriteXLSX_VERSION = "0.83.0"

data/lib/write_xlsx/workbook.rb

@@ -833,6 +833,17 @@ def add_vba_project(vba_project)
       @vba_project = vba_project
     end
 
+    #
+    # Set the VBA name for the workbook.
+    #
+    def set_vba_name(vba_codename = nil)
+      if vba_codename
+        @vba_codename = vba_codename
+      else
+        @vba_codename = 'ThisWorkbook'
+      end
+    end
+
     #
     # set_calc_mode()
     #
@@ -971,6 +982,10 @@ def chartsheet_count
       @worksheets.chartsheet_count
     end
 
+    def non_chartsheet_count
+      @worksheets.worksheets.count
+    end
+
     def style_properties
       [
        @xf_formats,
@@ -992,6 +1007,14 @@ def num_comment_files
       @worksheets.select { |sheet| sheet.has_comments? }.count
     end
 
+    def chartsheets
+      @worksheets.chartsheets
+    end
+
+    def non_chartsheets
+      @worksheets.worksheets
+    end
+
     private
 
     def setup_filename(file) #:nodoc:
@@ -1537,6 +1560,7 @@ def prepare_vml_objects  #:nodoc:
       vml_header_id  = 0
       vml_shape_id   = 1024
       comment_files  = 0
+      has_button     = false
 
       @worksheets.each do |sheet|
         next if !sheet.has_vml? && !sheet.has_header_vml?
@@ -1560,9 +1584,24 @@ def prepare_vml_objects  #:nodoc:
           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
+          if @vba_project && !sheet.vba_codename
+            sheet.set_vba_name
+          end
+        end
       end
 
       add_font_format_for_cell_comments if num_comment_files > 0
+
+      # Set the workbook vba_codename if one of the sheets has a button and
+      # the workbook has a vbaProject binary.
+      if has_button && @vba_project && !@vba_codename
+        set_vba_name
+      end
     end
 
     #
@@ -1600,7 +1639,9 @@ def add_chart_data #:nodoc:
       # Map worksheet names to worksheet objects.
       @worksheets.each { |worksheet| worksheets[worksheet.name] = worksheet }
 
-      @charts.each do |chart|
+      # 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]
@@ -1811,7 +1852,8 @@ def prepare_drawings #:nodoc:
 
       # Sort the workbook charts references into the order that the were
       # written from the worksheets above.
-      @charts = @charts.sort_by { |chart| chart.id }
+      @charts = @charts.select { |chart| chart.id != -1 }.
+        sort_by { |chart| chart.id }
 
       @drawing_count = drawing_id
     end

data/lib/write_xlsx/worksheet.rb

@@ -2877,6 +2877,13 @@ def insert_chart(*args)
       raise "Not a Chart object in insert_chart()" unless chart.is_a?(Chart) || chart.is_a?(Chartsheet)
       raise "Not a embedded style Chart object in insert_chart()" if chart.respond_to?(:embedded) && chart.embedded == 0
 
+      if chart.already_inserted? || (chart.combined && chart.combined.already_inserted?)
+        raise "Chart cannot be inserted in a worksheet more than once"
+      else
+        chart.already_inserted          = true
+        chart.combined.already_inserted = true if chart.combined
+      end
+
       # Use the values set with chart.set_size, if any.
       x_scale  = chart.x_scale  if chart.x_scale  != 1
       y_scale  = chart.y_scale  if chart.y_scale  != 1
@@ -5871,6 +5878,25 @@ def tables_count
       @tables.size
     end
 
+    def horizontal_dpi=(val)
+      @page_setup.horizontal_dpi = val
+    end
+
+    def vertical_dpi=(val)
+      @page_setup.vertical_dpi = val
+    end
+
+    #
+    # set the vba name for the worksheet
+    #
+    def set_vba_name(vba_codename = nil)
+      if vba_codename
+        @vba_codename = vba_codename
+      else
+        @vba_codename = @name
+      end
+    end
+
     private
 
     def hyperlinks_count
@@ -7518,23 +7544,6 @@ def convert_name_area(row_num_1, col_num_1, row_num_2, col_num_2) #:nodoc:
       "#{quote_sheetname(@name)}!#{area}"
     end
 
-    #
-    # Sheetnames used in references should be quoted if they contain any spaces,
-    # special characters or if the look like something that isn't a sheet name.
-    # 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
-    end
-
     def fit_page? #:nodoc:
       @page_setup.fit_page
     end

data/lib/write_xlsx/worksheet/page_setup.rb

@@ -14,6 +14,7 @@ class PageSetup # :nodoc:
       attr_accessor :orientation, :print_options_changed  # :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
@@ -97,11 +98,12 @@ 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 << ['pageOrder',   "overThenDown"] if @across
+        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 << ['pageOrder',       "overThenDown"] if @across
+        attributes << ['firstPageNumber', @page_start]    if @page_start && @page_start > 1
         attributes << ['orientation',
                        if @orientation
                          'portrait'
@@ -109,7 +111,11 @@ def write_page_setup(writer) #:nodoc:
                          'landscape'
                        end
                       ]
-        attributes << ['useFirstPageNumber', @page_start] if ptrue?(@page_start)
+        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

data/test/chart/test_write_style.rb

@@ -31,9 +31,9 @@ def test_write_style_with_outside_range
     assert_equal(expected, result)
   end
 
-  def test_write_style_with_outside_range_43
+  def test_write_style_with_outside_range_49
     expected = ''
-    @chart.set_style(43)
+    @chart.set_style(49)
     @chart.__send__('write_style')
     result = @chart.instance_variable_get(:@writer).string
     assert_equal(expected, result)

data/test/helper.rb

@@ -133,6 +133,9 @@ def compare_xlsx(exp_filename, got_filename, ignore_members = nil, ignore_elemen
           sub(/verticalDpi="200" /, '').
           sub(/(<pageSetup[^>]* )r:id="rId1"/, '\1').
           sub(/ +\/>/, ' />')
+        got_xml_str = got_xml_str.
+          sub(/horizontalDpi="200" /, '').
+          sub(/verticalDpi="200" /, '')
       end
 
       # Remove Chart pageMargin dimensions which are almost always different.

data/test/package/app/test_app01.rb

@@ -4,7 +4,7 @@
 
 class TestApp01 < Test::Unit::TestCase
   def test_assemble_xml_file
-    @obj = Writexlsx::Package::App.new
+    @obj = Writexlsx::Package::App.new(nil)
     @obj.add_part_name('Sheet1')
     @obj.add_heading_pair(['Worksheets', 1])
     @obj.assemble_xml_file

data/test/package/app/test_app02.rb

@@ -4,7 +4,7 @@
 
 class TestApp02 < Test::Unit::TestCase
   def test_assemble_xml_file
-    @obj = Writexlsx::Package::App.new
+    @obj = Writexlsx::Package::App.new(nil)
     @obj.add_part_name('Sheet1')
     @obj.add_part_name('Sheet2')
     @obj.add_heading_pair(['Worksheets', 2])

data/test/package/app/test_app03.rb

@@ -4,7 +4,7 @@
 
 class TestApp03 < Test::Unit::TestCase
   def test_assemble_xml_file
-    @obj = Writexlsx::Package::App.new
+    @obj = Writexlsx::Package::App.new(nil)
     @obj.add_part_name('Sheet1')
     @obj.add_part_name('Sheet1!Print_Titles')
     @obj.add_heading_pair(['Worksheets', 1])

data/test/package/content_types/test_content_types.rb

@@ -4,7 +4,7 @@
 
 class TestContentTypes < Test::Unit::TestCase
   def test_assemble_xml_file
-    @obj = Writexlsx::Package::ContentTypes.new
+    @obj = Writexlsx::Package::ContentTypes.new(nil)
     @obj.add_worksheet_name('sheet1')
     @obj.add_default('jpeg', 'image/jpeg')
     @obj.add_shared_strings

data/test/package/content_types/test_write_default.rb

@@ -4,7 +4,7 @@
 
 class TestWriteDefault < Test::Unit::TestCase
   def test_assemble_xml_file
-    @obj = Writexlsx::Package::ContentTypes.new
+    @obj = Writexlsx::Package::ContentTypes.new(nil)
     @obj.__send__('write_default', 'xml', 'application/xml')
     result = @obj.xml_str
     expected = '<Default Extension="xml" ContentType="application/xml"/>'

data/test/package/content_types/test_write_override.rb

@@ -4,7 +4,7 @@
 
 class TestWriteOverride < Test::Unit::TestCase
   def test_assemble_xml_file
-    @obj = Writexlsx::Package::ContentTypes.new
+    @obj = Writexlsx::Package::ContentTypes.new(nil)
     @obj.__send__('write_override', '/docProps/core.xml', 'app...')
     result = @obj.xml_str
     expected = '<Override PartName="/docProps/core.xml" ContentType="app..."/>'

data/test/regression/test_button07.rb

@@ -15,8 +15,11 @@ def test_button07
     workbook  = WriteXLSX.new(@xlsx)
     worksheet = workbook.add_worksheet
 
-    workbook.instance_variable_set(:@vba_codename, 'ThisWorkbook')
-    worksheet.instance_variable_set(:@vba_codename, 'Sheet1')
+    workbook.set_vba_name('ThisWorkbook')
+    worksheet.set_vba_name('Sheet1')
+
+    workbook.set_vba_name
+    worksheet.set_vba_name
 
     worksheet.insert_button('C2', {
                               :macro   => 'say_hello',

data/test/regression/test_button13.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionButton13 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_button13
+    @xlsx = 'button07.xlsm'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+
+    workbook.set_vba_name
+    worksheet.set_vba_name
+
+    worksheet.insert_button(
+      'C2',
+      {
+        :macro   => 'say_hello',
+        :caption => 'Hello'
+      }
+    )
+
+    workbook.add_vba_project(File.join(@regression_output, 'vbaProject02.bin'))
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end

data/test/regression/test_button14.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionButton14 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_button14
+    @xlsx = 'button07.xlsm'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+
+    worksheet.insert_button(
+      'C2',
+      {
+        :macro   => 'say_hello',
+        :caption => 'Hello'
+      }
+    )
+
+    workbook.add_vba_project(File.join(@regression_output, 'vbaProject02.bin'))
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end