write_xlsx 1.02.0 → 1.04.0

data/lib/write_xlsx/package/table.rb

@@ -398,13 +398,14 @@ def write_table_column(col_data)
       # Write the <tableStyleInfo> element.
       #
       def write_table_style_info
-        attributes = [
-                      ['name',              @style],
-                      ['showFirstColumn',   @show_first_col],
-                      ['showLastColumn',    @show_last_col],
-                      ['showRowStripes',    @show_row_stripes],
-                      ['showColumnStripes', @show_col_stripes]
-                     ]
+        attributes = []
+        if @style && @style != '' && @style != 'None'
+          attributes << ['name', @style]
+        end
+        attributes << ['showFirstColumn',   @show_first_col]
+        attributes << ['showLastColumn',    @show_last_col]
+        attributes << ['showRowStripes',    @show_row_stripes]
+        attributes << ['showColumnStripes', @show_col_stripes]
 
         @writer.empty_tag('tableStyleInfo', attributes)
       end

data/lib/write_xlsx/package/vml.rb

@@ -17,9 +17,9 @@ def set_xml_writer(filename)
       end
 
       def assemble_xml_file(
-                            data_id, vml_shape_id, comments_data,
-                            buttons_data, header_images_data = []
-                            )
+            data_id, vml_shape_id, comments_data,
+            buttons_data, header_images_data = []
+          )
         return unless @writer
 
         write_xml_namespace do
@@ -29,9 +29,9 @@ def assemble_xml_file(
           z_index = 1
           unless buttons_data.empty?
             vml_shape_id, z_index =
-              write_shape_type_and_shape(
-                                         buttons_data,
-                                         vml_shape_id, z_index) do
+                          write_shape_type_and_shape(
+                            buttons_data,
+                            vml_shape_id, z_index) do
               write_button_shapetype
             end
           end
@@ -277,6 +277,7 @@ def write_image_shape(id, index, image_data)
         position = image_data[3]
         x_dpi    = image_data[4]
         y_dpi    = image_data[5]
+        ref_id   = image_data[6]
 
         # Scale the height/width by the resolution, relative to 72dpi.
         width  = width  * 72.0 / x_dpi
@@ -294,20 +295,20 @@ def write_image_shape(id, index, image_data)
         end
 
         style = [
-                 "position:absolute", "margin-left:0", "margin-top:0",
-                 "width:#{width}pt", "height:#{height}pt",
-                 "z-index:#{index}"
-                ].join(';')
+          "position:absolute", "margin-left:0", "margin-top:0",
+          "width:#{width}pt", "height:#{height}pt",
+          "z-index:#{index}"
+        ].join(';')
         attributes = [
-                      ['id',     position],
-                      ['o:spid', "_x0000_s#{id}"],
-                      ['type',   type],
-                      ['style',  style]
-                     ]
+          ['id',     position],
+          ['o:spid', "_x0000_s#{id}"],
+          ['type',   type],
+          ['style',  style]
+        ]
 
         @writer.tag_elements('v:shape', attributes) do
           # Write the v:imagedata element.
-          write_imagedata(index, name)
+          write_imagedata(ref_id, name)
 
           # Write the o:lock element.
           write_rotation_lock
@@ -319,9 +320,9 @@ def write_image_shape(id, index, image_data)
       #
       def write_imagedata(index, o_title)
         attributes = [
-                      ['o:relid', "rId#{index}"],
-                      ['o:title', o_title]
-                     ]
+          ['o:relid', "rId#{index}"],
+          ['o:title', o_title]
+        ]
 
         @writer.empty_tag('v:imagedata', attributes)
       end

data/lib/write_xlsx/sheets.rb

@@ -67,18 +67,18 @@ def write_vml_files(package_dir)
           vml = Package::Vml.new
           vml.set_xml_writer("#{dir}/vmlDrawing#{index}.vml")
           vml.assemble_xml_file(
-                                sheet.vml_data_id, sheet.vml_shape_id,
-                                sheet.sorted_comments, sheet.buttons_data
-                                )
+            sheet.vml_data_id, sheet.vml_shape_id,
+            sheet.sorted_comments, sheet.buttons_data
+          )
           index += 1
         end
         if sheet.has_header_vml?
           vml = Package::Vml.new
           vml.set_xml_writer("#{dir}/vmlDrawing#{index}.vml")
           vml.assemble_xml_file(
-                                sheet.vml_header_id, sheet.vml_header_id * 1024,
-                                [], [], sheet.header_images_data
-                                )
+            sheet.vml_header_id, sheet.vml_header_id * 1024,
+            [], [], sheet.header_images_data
+          )
           write_vml_drawing_rels_files(package_dir, sheet, index)
           index += 1
         end
@@ -106,16 +106,12 @@ def write_table_files(package_dir)
     end
 
     def write_chartsheet_rels_files(package_dir)
-      write_sheet_rels_files_base(chartsheets, "#{package_dir}/xl/chartsheets/_rels",
-                            'sheet')
+      write_sheet_rels_files_base(
+        chartsheets, "#{package_dir}/xl/chartsheets/_rels", 'sheet'
+      )
     end
 
     def write_drawing_rels_files(package_dir)
-      # write_rels_files_base(
-      #                       self.reject { |sheet| sheet.drawing_links[0].empty? },
-      #                       "#{package_dir}/xl/drawings/_rels",
-
-      #                       )
       dir = "#{package_dir}/xl/drawings/_rels"
 
       index = 0
@@ -159,8 +155,9 @@ def write_vml_drawing_rels_files(package_dir, worksheet, index)
     end
 
     def write_worksheet_rels_files(package_dir)
-      write_sheet_rels_files_base(worksheets, "#{package_dir}/xl/worksheets/_rels",
-                            'sheet')
+      write_sheet_rels_files_base(
+        worksheets, "#{package_dir}/xl/worksheets/_rels", 'sheet'
+      )
     end
 
     def write_sheet_rels_files_base(sheets, dir, body)
@@ -235,11 +232,6 @@ def check_valid_sheetname(name)
         raise "Worksheet name #{name} cannot start or end with an "
       end
 
-      # Check that sheetname isn't a reserved word.
-      if name =~ /history/i
-        raise "Worksheet name cannot be Excel reserved word 'History'"
-      end
-
       # Check that the worksheet name doesn't already exist since this is a fatal
       # error in Excel 97. The check must also exclude case insensitive matches.
       unless is_sheetname_uniq?(name)

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "1.02.0"
+WriteXLSX_VERSION = "1.04.0"

data/lib/write_xlsx/workbook.rb

@@ -132,6 +132,7 @@ def initialize(file, *option_params)
       @strings_to_urls     = (options[:strings_to_urls].nil? || options[:strings_to_urls]) ? true : false
 
       @max_url_length      = 2079
+      @has_comments        = false
       if options[:max_url_length]
         @max_url_length = options[:max_url_length]
 
@@ -1115,7 +1116,8 @@ def style_properties
        @border_count,
        @fill_count,
        @custom_colors,
-       @dxf_formats
+       @dxf_formats,
+       @has_comments
       ]
     end
 
@@ -1711,11 +1713,14 @@ def prepare_vml_objects  #:nodoc:
           if sheet.has_comments?
             comment_files += 1
             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)
+          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 )
@@ -1738,8 +1743,6 @@ def prepare_vml_objects  #:nodoc:
         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
@@ -1759,19 +1762,6 @@ def prepare_tables
       end
     end
 
-    def add_font_format_for_cell_comments
-      format = Format.new(
-                          @formats,
-                          :font          => 'Tahoma',
-                          :size          => 8,
-                          :color_indexed => 81,
-                          :font_only     => 1
-                          )
-
-      format.get_xf_index
-      @formats.formats << format
-    end
-
     #
     # Add "cached" data to charts to provide the numCache and strCache data for
     # series and title/axis ranges.
@@ -1922,9 +1912,12 @@ def extract_named_ranges(defined_names) #:nodoc:
     # Iterate through the worksheets and set up any chart or image drawings.
     #
     def prepare_drawings #:nodoc:
-      chart_ref_id = 0
-      image_ref_id = 0
-      drawing_id   = 0
+      chart_ref_id     = 0
+      image_ref_id     = 0
+      drawing_id       = 0
+      ref_id           = 0
+      image_ids        = {}
+      header_image_ids = {}
       @worksheets.each do |sheet|
         chart_count = sheet.charts.size
         image_count = sheet.images.size
@@ -1944,9 +1937,19 @@ def prepare_drawings #:nodoc:
 
         # Prepare the worksheet images.
         sheet.images.each_with_index do |image, index|
-          type, width, height, name, x_dpi, y_dpi = get_image_properties(image[2])
-          image_ref_id += 1
-          sheet.prepare_image(index, image_ref_id, drawing_id, width, height, name, type, x_dpi, y_dpi)
+          filename = image[2]
+          type, width, height, name, x_dpi, y_dpi, md5 = get_image_properties(image[2])
+          if image_ids[md5]
+            ref_id = image_ids[md5]
+          else
+            image_ref_id += 1
+            image_ids[md5] = ref_id = image_ref_id
+            @images << [filename, type]
+          end
+          sheet.prepare_image(
+            index, ref_id, drawing_id, width, height,
+            name,  type,   x_dpi,      y_dpi, md5
+          )
         end
 
         # Prepare the worksheet charts.
@@ -1965,13 +1968,21 @@ def prepare_drawings #:nodoc:
           filename = sheet.header_images[index][0]
           position = sheet.header_images[index][1]
 
-          type, width, height, name, x_dpi, y_dpi =
+          type, width, height, name, x_dpi, y_dpi, md5 =
             get_image_properties(filename)
 
-          image_ref_id += 1
+          if header_image_ids[md5]
+            ref_id = header_image_ids[md5]
+          else
+            image_ref_id += 1
+            header_image_ids[md5] = ref_id = image_ref_id
+            @images << [filename, type]
+          end
 
-          sheet.prepare_header_image(image_ref_id, width, height,
-                                     name, type, position, x_dpi, y_dpi)
+          sheet.prepare_header_image(
+            ref_id,   width, height, name, type,
+            position, x_dpi, y_dpi,  md5
+          )
         end
 
         # Prepare the footer images.
@@ -1979,13 +1990,21 @@ def prepare_drawings #:nodoc:
           filename = sheet.footer_images[index][0]
           position = sheet.footer_images[index][1]
 
-          type, width, height, name, x_dpi, y_dpi =
+          type, width, height, name, x_dpi, y_dpi, md5 =
             get_image_properties(filename)
 
-          image_ref_id += 1
+          if header_image_ids[md5]
+            ref_id = header_image_ids[md5]
+          else
+            image_ref_id += 1
+            header_image_ids[md5] = ref_id = image_ref_id
+            @images << [filename, type]
+          end
 
-          sheet.prepare_header_image(image_ref_id, width, height,
-                                     name, type, position, x_dpi, y_dpi)
+          sheet.prepare_header_image(
+            ref_id,   width, height, name, type,
+            position, x_dpi, y_dpi,  md5
+          )
         end
 
         if has_drawings
@@ -2014,6 +2033,7 @@ def get_image_properties(filename)
 
       # Open the image file and import the data.
       data = File.binread(filename)
+      md5  = Digest::MD5.hexdigest(data)
       if data.unpack('x A3')[0] == 'PNG'
         # Test for PNGs.
         type, width, height, x_dpi, y_dpi = process_png(data)
@@ -2031,13 +2051,11 @@ def get_image_properties(filename)
         raise "Unsupported image format for file: #{filename}\n"
       end
 
-      @images << [filename, type]
-
       # Set a default dpi for images with 0 dpi.
       x_dpi = 96 if x_dpi == 0
       y_dpi = 96 if y_dpi == 0
 
-      [type, width, height, File.basename(filename), x_dpi, y_dpi]
+      [type, width, height, File.basename(filename), x_dpi, y_dpi, md5]
     end
 
     #

data/lib/write_xlsx/worksheet.rb

@@ -359,6 +359,8 @@ def initialize(workbook, index, name) #:nodoc:
       @shape_hash             = {}
       @drawing_rels           = {}
       @drawing_rels_id        = 0
+      @vml_drawing_rels       = {}
+      @vml_drawing_rels_id    = 0
       @header_images          = []
       @footer_images          = []
 
@@ -5868,27 +5870,24 @@ def position_object_pixels(col_start, row_start, x1, y1, width, height, anchor =
       y_abs += y1
 
       # Adjust start column for offsets that are greater than the col width.
-      if size_col(col_start) > 0
-        while x1 >= size_col(col_start)
-          x1 -= size_col(col_start)
-          col_start += 1
-        end
+      while x1 >= size_col(col_start, anchor)
+        x1 -= size_col(col_start)
+        col_start += 1
       end
 
       # Adjust start row for offsets that are greater than the row height.
-      if size_row(row_start) > 0
-        while y1 >= size_row(row_start)
-          y1 -= size_row(row_start)
-          row_start += 1
-        end
+      while y1 >= size_row(row_start, anchor)
+        y1 -= size_row(row_start)
+        row_start += 1
       end
 
       # Initialise end cell to the same as the start cell.
       col_end = col_start
       row_end = row_start
 
-      width  += x1 if size_col(col_start) > 0
-      height += y1 if size_row(row_start) > 0
+      # Only offset the image in the cell if the row/col isn't hidden.
+      width  += x1 if size_col(col_start, anchor) > 0
+      height += y1 if size_row(row_start, anchor) > 0
 
       # Subtract the underlying cell widths to find the end cell of the object.
       while width >= size_col(col_end, anchor)
@@ -6100,6 +6099,18 @@ def drawing_rel_index(target = nil)
       end
     end
 
+    #
+    # Get the index used to address a vml_drawing rel link.
+    #
+    def get_vml_drawing_rel_index(target)
+      if @vml_drawing_rels[target]
+        @vml_drawing_rels[target]
+      else
+        @vml_drawing_rels_id += 1
+        @vml_drawing_rels[target] = @vml_drawing_rels_id
+      end
+    end
+
     def hyperlinks_count
       @hyperlinks.keys.inject(0) { |s, n| s += @hyperlinks[n].keys.size }
     end
@@ -6447,7 +6458,7 @@ def size_row(row, anchor = 0) #:nodoc:
     #
     # Set up image/drawings.
     #
-    def prepare_image(index, image_id, drawing_id, width, height, name, image_type, x_dpi = 96, y_dpi = 96) #:nodoc:
+    def prepare_image(index, image_id, drawing_id, width, height, name, image_type, x_dpi = 96, y_dpi = 96, md5 = nil) #:nodoc:
       x_dpi ||= 96
       y_dpi ||= 96
       drawing_type = 2
@@ -6503,24 +6514,30 @@ def prepare_image(index, image_id, drawing_id, width, height, name, image_type,
 EOS
         end
 
-        if target
+        if target && !@drawing_rels[url]
           @drawing_links << [rel_type, target, target_mode]
         end
-        drawing.url_rel_index = drawing_rel_index
+        drawing.url_rel_index = drawing_rel_index(url)
       end
 
-      drawing.rel_index = drawing_rel_index
-      @drawing_links << ['/image', "../media/image#{image_id}.#{image_type}"]
+      if !@drawing_rels[md5]
+        @drawing_links << ['/image', "../media/image#{image_id}.#{image_type}"]
+      end
+      drawing.rel_index = drawing_rel_index(md5)
     end
     public :prepare_image
 
-    def prepare_header_image(image_id, width, height, name, image_type, position, x_dpi, y_dpi)
+    def prepare_header_image(image_id, width, height, name, image_type, position, x_dpi, y_dpi, md5)
       # Strip the extension from the filename.
       body = name.dup
       body[/\.[^\.]+$/, 0] = ''
 
-      @header_images_array << [width, height, body, position, x_dpi, y_dpi]
-      @vml_drawing_links   << ['/image', "../media/image#{image_id}.#{image_type}" ]
+      if !@vml_drawing_rels[md5]
+        @vml_drawing_links   << ['/image', "../media/image#{image_id}.#{image_type}" ]
+      end
+
+      ref_id = get_vml_drawing_rel_index(md5)
+      @header_images_array << [width, height, body, position, x_dpi, y_dpi, ref_id]
     end
     public :prepare_header_image