write_xlsx 0.97.0 → 1.04.0

data/lib/write_xlsx/shape.rb

@@ -8,14 +8,14 @@ module Writexlsx
   # Used in conjunction with WriteXLSX.
   #
   # Copyright 2000-2012, John McNamara, jmcnamara@cpan.org
-  # Converted to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+  # Converted to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
   #
   class Shape
     include Writexlsx::Utility
 
     attr_reader :edit_as, :type, :drawing
     attr_reader :tx_box, :fill, :line, :format
-    attr_reader :align, :valign
+    attr_reader :align, :valign, :anchor
     attr_accessor :name, :connect, :type, :id, :start, :end, :rotation
     attr_accessor :flip_h, :flip_v, :adjustments, :palette, :text, :stencil
     attr_accessor :row_start, :row_end, :column_start, :column_end
@@ -183,11 +183,12 @@ def calc_position_emus(worksheet)
       @y_abs = (y_abslt * 9_525).to_i
     end
 
-    def set_position(row_start, column_start, x_offset, y_offset, x_scale, y_scale)
+    def set_position(row_start, column_start, x_offset, y_offset, x_scale, y_scale, anchor)
       @row_start    = row_start
       @column_start = column_start
       @x_offset     = x_offset || 0
       @y_offset     = y_offset || 0
+      @anchor       = anchor   || 1
 
       # Override shape scale if supplied as an argument. Otherwise, use the
       # existing shape scale factors.

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)
@@ -230,10 +227,15 @@ def check_valid_sheetname(name)
         raise 'Invalid character []:*?/\\ in worksheet name: ' + name
       end
 
+      # Check that sheetname doesn't start or end with an apostrophe.
+      if name =~ /^'/ || name =~ /'$/
+        raise "Worksheet name #{name} cannot start or end with an "
+      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)
-        raise "Worksheet name '#{name}', with case ignored, is already used."
+        raise "apostropheWorksheet name '#{name}', with case ignored, is already used."
       end
     end
 

data/lib/write_xlsx/sparkline.rb

@@ -9,7 +9,7 @@ module Writexlsx
   # Used in conjunction with WriteXLSX.
   #
   # Copyright 2000-2012, John McNamara, jmcnamara@cpan.org
-  # Converted to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+  # Converted to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
   #
   class Sparkline
     include Writexlsx::Utility

data/lib/write_xlsx/utility.rb

@@ -119,7 +119,7 @@ def check_dimensions(row, col)
     #            nil if the date is invalid.
     #
     def convert_date_time(date_time_string)       #:nodoc:
-      date_time = date_time_string.sub(/^\s+/, '').sub(/\s+$/, '').sub(/Z$/, '')
+      date_time = date_time_string.to_s.sub(/^\s+/, '').sub(/\s+$/, '').sub(/Z$/, '')
 
       # Check for invalid date char.
       return nil if date_time =~ /[^0-9T:\-\.Z]/
@@ -218,6 +218,25 @@ def convert_date_time(date_time_string)       #:nodoc:
       end
     end
 
+    def escape_url(url)
+      unless url =~ /%[0-9a-fA-F]{2}/
+        # Escape the URL escape symbol.
+        url = url.gsub(/%/, "%25")
+
+        # Escape whitespae in URL.
+        url = url.gsub(/[\s\x00]/, '%20')
+
+        # Escape other special characters in URL.
+        re = /(["<>\[\]`^{}])/
+        while re =~ url
+          match = $~[1]
+          url = url.sub(re, sprintf("%%%x", match.ord))
+        end
+      end
+
+      url
+    end
+
     def absolute_char(absolute)
       absolute ? '$' : ''
     end
@@ -361,6 +380,64 @@ def float_to_str(float)
       end
     end
 
+    #
+    # Convert user defined legend properties to the structure required internally.
+    #
+    def legend_properties(params)
+      legend = Writexlsx::Chart::Legend.new
+
+      legend.position      = params[:position] || 'right'
+      legend.delete_series = params[:delete_series]
+      legend.font          = convert_font_args(params[:font])
+
+      # Set the legend layout.
+      legend.layout = layout_properties(params[:layout])
+
+      # Turn off the legend.
+      if params[:none]
+        legend.position = 'none'
+      end
+
+      # Set the line properties for the legend.
+      line = line_properties(params[:line])
+
+      # Allow 'border' as a synonym for 'line'.
+      if params[:border]
+        line = line_properties(params[:border])
+      end
+
+      # Set the fill properties for the legend.
+      fill = fill_properties(params[:fill])
+
+      # Set the pattern properties for the legend.
+      pattern = pattern_properties(params[:pattern])
+
+      # Set the gradient fill properties for the legend.
+      gradient = gradient_properties(params[:gradient])
+
+      # Pattern fill overrides solid fill.
+      if pattern
+        fill = nil
+      end
+
+      # Gradient fill overrides solid and pattern fills.
+      if gradient
+        pattern = nil
+        fill    = nil
+      end
+
+      # Set the legend layout.
+      layout = layout_properties(params[:layout])
+
+      legend.line     = line
+      legend.fill     = fill
+      legend.pattern  = pattern
+      legend.gradient = gradient
+      legend.layout   = layout
+
+      @legend = legend
+    end
+
     #
     # Convert user defined layout properties to the format required internally.
     #
@@ -727,14 +804,14 @@ def params_to_font(params)
     #
     # Write the <c:txPr> element.
     #
-    def write_tx_pr(horiz, font) # :nodoc:
+    def write_tx_pr(is_y_axis, font) # :nodoc:
       rotation = nil
       if font && font[:_rotation]
         rotation = font[:_rotation]
       end
       @writer.tag_elements('c:txPr') do
         # Write the a:bodyPr element.
-        write_a_body_pr(rotation, horiz)
+        write_a_body_pr(rotation, is_y_axis)
         # Write the a:lstStyle element.
         write_a_lst_style
         # Write the a:p element.
@@ -745,11 +822,23 @@ def write_tx_pr(horiz, font) # :nodoc:
     #
     # Write the <a:bodyPr> element.
     #
-    def write_a_body_pr(rot, horiz = nil) # :nodoc:
-      rot = -5400000 if !rot && ptrue?(horiz)
+    def write_a_body_pr(rot, is_y_axis = nil) # :nodoc:
+      rot = -5400000 if !rot && ptrue?(is_y_axis)
       attributes = []
-      attributes << ['rot',  rot]   if rot
-      attributes << ['vert', 'horz'] if ptrue?(horiz)
+      if rot
+        if rot == 16_200_000
+          # 270 deg/stacked angle.
+          attributes << ['rot',  0]
+          attributes << ['vert', 'wordArtVert']
+        elsif rot == 16_260_000
+          # 271 deg/stacked angle.
+          attributes << ['rot',  0]
+          attributes << ['vert', 'eaVert']
+        else
+          attributes << ['rot',  rot]
+          attributes << ['vert', 'horz']
+        end
+      end
 
       @writer.empty_tag('a:bodyPr', attributes)
     end

data/lib/write_xlsx/version.rb

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

data/lib/write_xlsx/workbook.rb

@@ -49,6 +49,7 @@ class Workbook
     attr_reader :shared_strings  # :nodoc:
     attr_reader :vba_project  # :nodoc:
     attr_reader :excel2003_style # :nodoc:
+    attr_reader :max_url_length # :nodoc:
     attr_reader :strings_to_urls # :nodoc:
     attr_reader :default_url_format # :nodoc:
 
@@ -123,13 +124,20 @@ def initialize(file, *option_params)
       @y_window            = 15
       @window_width        = 16095
       @window_height       = 9660
-      @tab_ratio           = 500
+      @tab_ratio           = 600
       @excel2003_style     = options[:excel2003_style] || false
       @table_count         = 0
       @image_types         = {}
       @images              = []
       @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]
+
+        @max_url_length = 2079 if @max_url_length < 250
+      end
       # Structures for the shared strings data.
       @shared_strings = Package::SharedStrings.new
 
@@ -784,6 +792,19 @@ def set_size(width = nil, height = nil)
       end
     end
 
+    #
+    # Set the ratio of space for worksheet tabs.
+    #
+    def set_tab_ratio(tab_ratio = nil)
+      return if !tab_ratio
+
+      if tab_ratio < 0 || tab_ratio > 100
+        raise "Tab ratio outside range: 0 <= zoom <= 100"
+      else
+        @tab_ratio = (tab_ratio * 10).to_i
+      end
+    end
+
     #
     # The set_properties method can be used to set the document properties
     # of the Excel file created by WriteXLSX. These properties are visible
@@ -1095,7 +1116,8 @@ def style_properties
        @border_count,
        @fill_count,
        @custom_colors,
-       @dxf_formats
+       @dxf_formats,
+       @has_comments
       ]
     end
 
@@ -1308,7 +1330,7 @@ def write_workbook_view #:nodoc:
                     ['windowWidth',   @window_width],
                     ['windowHeight',  @window_height]
                    ]
-      if @tab_ratio != 500
+      if @tab_ratio != 600
         attributes << ['tabRatio', @tab_ratio]
       end
       if @firstsheet > 0
@@ -1512,9 +1534,17 @@ def prepare_num_formats #:nodoc:
         # 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.
+          if num_format == 0
+            num_format = 1
+          end
           # 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 num_formats[num_format]
@@ -1683,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 )
@@ -1710,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
@@ -1731,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.
@@ -1894,16 +1912,19 @@ 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
         shape_count = sheet.shapes.size
         header_image_count = sheet.header_images.size
         footer_image_count = sheet.footer_images.size
-        has_drawing = false
+        has_drawings = false
 
         # Check that some image or drawing needs to be processed.
         next if chart_count + image_count + shape_count + header_image_count + footer_image_count == 0
@@ -1911,7 +1932,24 @@ def prepare_drawings #:nodoc:
         # Don't increase the drawing_id header/footer images.
         if chart_count + image_count + shape_count > 0
           drawing_id += 1
-          has_drawing = true
+          has_drawings = true
+        end
+
+        # Prepare the worksheet images.
+        sheet.images.each_with_index do |image, index|
+          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.
@@ -1920,13 +1958,6 @@ def prepare_drawings #:nodoc:
           sheet.prepare_chart(index, chart_ref_id, drawing_id)
         end
 
-        # 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)
-        end
-
         # Prepare the worksheet shapes.
         sheet.shapes.each_with_index do |shape, index|
           sheet.prepare_shape(index, drawing_id)
@@ -1937,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.
@@ -1951,18 +1990,26 @@ 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_drawing
-          drawing = sheet.drawing
-          @drawings << drawing
+        if has_drawings
+          drawings = sheet.drawings
+          @drawings << drawings
         end
       end
 
@@ -1986,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)
@@ -2003,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
 
     #
@@ -2064,16 +2110,20 @@ def process_jpg(data, filename)
       offset = 2
       data_length = data.bytesize
 
-      # Search through the image data to read the height and width in the
-      # 0xFFC0/C2 element. Also read the DPI in the 0xFFE0 element.
+      # Search through the image data to read the JPEG markers.
       while offset < data_length
         marker  = data[offset+0, 2].unpack("n")[0]
         length  = data[offset+2, 2].unpack("n")[0]
 
-        if marker == 0xFFC0 || marker == 0xFFC2
+        # Read the height and width in the 0xFFCn elements
+        # (Except C4, C8 and CC which aren't SOF markers).
+        if (marker & 0xFFF0) == 0xFFC0 &&
+           marker != 0xFFC4 && marker != 0xFFCC
           height = data[offset+5, 2].unpack("n")[0]
           width  = data[offset+7, 2].unpack("n")[0]
         end
+
+        # Read the DPI in the 0xFFE0 element.
         if marker == 0xFFE0
           units     = data[offset + 11, 1].unpack("C")[0]
           x_density = data[offset + 12, 2].unpack("n")[0]