write_xlsx 1.02.0 → 1.08.1

data/lib/write_xlsx/workbook.rb

@@ -52,6 +52,7 @@ module Writexlsx
     attr_reader :max_url_length # :nodoc:
     attr_reader :strings_to_urls # :nodoc:
     attr_reader :default_url_format # :nodoc:
+    attr_reader :read_only # :nodoc:
 
     #
     # A new Excel workbook is created using the +new+ constructor
@@ -132,6 +133,8 @@ module Writexlsx
       @strings_to_urls     = (options[:strings_to_urls].nil? || options[:strings_to_urls]) ? true : false
 
       @max_url_length      = 2079
+      @has_comments        = false
+      @read_only           = 0
       if options[:max_url_length]
         @max_url_length = options[:max_url_length]
 
@@ -291,6 +294,9 @@ module Writexlsx
           # Write the XLSX file version.
           write_file_version
 
+          # Write the fileSharing element.
+          write_file_sharing
+
           # Write the workbook properties.
           write_workbook_pr
 
@@ -953,6 +959,13 @@ module Writexlsx
       end
     end
 
+    #
+    # Set the Excel "Read-only recommended" save option.
+    #
+    def read_only_recommended
+      @read_only = 2
+    end
+
     #
     # set_calc_mode()
     #
@@ -1115,7 +1128,8 @@ module Writexlsx
        @border_count,
        @fill_count,
        @custom_colors,
-       @dxf_formats
+       @dxf_formats,
+       @has_comments
       ]
     end
 
@@ -1309,6 +1323,17 @@ module Writexlsx
       @writer.empty_tag('fileVersion', attributes)
     end
 
+    #
+    # Write the <fileSharing> element.
+    #
+    def write_file_sharing
+      return if !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)
@@ -1711,11 +1736,14 @@ module Writexlsx
           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 +1766,6 @@ module Writexlsx
         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 +1785,6 @@ module Writexlsx
       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 +1935,12 @@ module Writexlsx
     # 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 +1960,19 @@ module Writexlsx
 
         # 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 +1991,21 @@ module Writexlsx
           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 +2013,21 @@ module Writexlsx
           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 +2056,7 @@ module Writexlsx
 
       # 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 +2074,11 @@ module Writexlsx
         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/data_validation.rb

@@ -138,12 +138,7 @@ module Writexlsx
           row_first, row_last = row_last, row_first if row_first > row_last
           col_first, col_last = col_last, col_first if col_first > col_last
 
-          # If the first and last cell are the same write a single cell.
-          if row_first == row_last && col_first == col_last
-            sqref += xl_rowcol_to_cell(row_first, col_first)
-          else
-            sqref += xl_range(row_first, row_last, col_first, col_last)
-          end
+          sqref += xl_range(row_first, row_last, col_first, col_last)
         end
 
         if @validate != 'none'