write_xlsx 0.99.0 → 1.07.0

data/lib/write_xlsx/format.rb

@@ -248,11 +248,11 @@ def initialize(formats, params = {})   # :nodoc:
     #
     def copy(other)
       reserve = [
-                 :xf_index,
-                 :dxf_index,
-                 :xdf_format_indices,
-                 :palette
-                ]
+        :xf_index,
+        :dxf_index,
+        :xdf_format_indices,
+        :palette
+      ]
       (instance_variables - reserve).each do |v|
         instance_variable_set(v, other.instance_variable_get(v))
       end

data/lib/write_xlsx/package/comments.rb

@@ -155,7 +155,7 @@ def visibility
       #
       def fill_attributes
         [
-         ['color2', '#ffffe1']
+          ['color2', '#ffffe1']
         ]
       end
 
@@ -164,9 +164,9 @@ def fill_attributes
       #
       def write_shadow
         attributes = [
-            ['on',       't'],
-            ['color',    'black'],
-            ['obscured', 't']
+          ['on',       't'],
+          ['color',    'black'],
+          ['obscured', 't']
         ]
 
         @writer.empty_tag('v:shadow', attributes)
@@ -257,13 +257,9 @@ def [](row)
         @comments[row]
       end
 
-      def add(comment)
-        if @comments[comment.row]
-          @comments[comment.row][comment.col] = comment
-        else
-          @comments[comment.row] = {}
-          @comments[comment.row][comment.col] = comment
-        end
+      def add(workbook, worksheet, row, col, string, options)
+        @comments[row] ||= {}
+        @comments[row][col] = [workbook, worksheet, row, col, string, options]
       end
 
       def empty?
@@ -293,6 +289,10 @@ def sorted_comments
           # We sort the comments by row and column but that isn't strictly required.
           @comments.keys.sort.each do |row|
             @comments[row].keys.sort.each do |col|
+              user_options = @comments[row][col]
+              comment = Comment.new(*user_options)
+              @comments[row][col] = comment
+
               # Set comment visibility if required and not already user defined.
               @comments[row][col].visible ||= 1 if comments_visible?
 

data/lib/write_xlsx/package/relationships.rb

@@ -31,8 +31,8 @@ def assemble_xml_file
       #
       # Add container relationship to XLSX .rels xml files.
       #
-      def add_document_relationship(type, target)
-        @rels.push([Document_schema + type, target])
+      def add_document_relationship(type, target, target_mode = nil)
+        @rels.push([Document_schema + type, target, target_mode])
       end
 
       #
@@ -64,8 +64,8 @@ def add_worksheet_relationship(type, target, target_mode = nil)
       #
       def write_relationships
         attributes = [
-                      ['xmlns', Package_schema]
-                     ]
+          ['xmlns', Package_schema]
+        ]
 
         @writer.tag_elements('Relationships', attributes) do
           @rels.each { |rel| write_relationship(*rel) }

data/lib/write_xlsx/package/styles.rb

@@ -20,6 +20,7 @@ def initialize
         @dxf_formats       = []
         @has_hyperlink     = 0
         @hyperlink_font_id = 0
+        @has_comments      = false
       end
 
       def set_xml_writer(filename)
@@ -37,7 +38,7 @@ def assemble_xml_file
       #
       def set_style_properties(
             xf_formats, palette, font_count, num_format_count, border_count,
-            fill_count, custom_colors, dxf_formats
+            fill_count, custom_colors, dxf_formats, has_comments
           )
         @xf_formats       = xf_formats
         @palette          = palette
@@ -47,6 +48,7 @@ def set_style_properties(
         @fill_count       = fill_count
         @custom_colors    = custom_colors
         @dxf_formats      = dxf_formats
+        @has_comments     = has_comments
       end
 
       #
@@ -148,7 +150,14 @@ def write_num_fmt(num_fmt_id, format_code)
       # Write the <fonts> element.
       #
       def write_fonts
-        write_format_elements('fonts', @font_count) do
+        count = @font_count
+
+        if @has_comments
+          # Add an extra font for comments.
+          count += 1
+        end
+
+        write_format_elements('fonts', count) do
           write_font_base
         end
       end
@@ -161,6 +170,21 @@ def write_font_base
             @hyperlink_font_id = format.font_index unless ptrue?(@hyperlink_font_id)
           end
         end
+        if @has_comments
+          write_comment_font
+        end
+      end
+
+      #
+      # Write the <font> element used for comments.
+      #
+      def write_comment_font
+        @writer.tag_elements('font') do
+          @writer.empty_tag('sz', [['val', 8]])
+          write_color('indexed', 81)
+          @writer.empty_tag( 'name',   [['val', 'Tahoma']])
+          @writer.empty_tag( 'family', [['val', 2]])
+        end
       end
 
       #
@@ -394,12 +418,6 @@ def write_cell_style_xfs
       def write_cell_xfs
         formats = @xf_formats
 
-        # Workaround for when the last format is used for the comment font
-        # and shouldn't be used for cellXfs.
-        last_format =   formats[-1]
-
-        formats.pop if last_format && last_format.font_only != 0
-
         attributes = [ ['count', formats.size] ]
 
         @writer.tag_elements('cellXfs', attributes) do

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/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

@@ -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
@@ -785,14 +804,14 @@ def params_to_font(params)
     #
     # Write the <c:txPr> element.
     #
-    def write_tx_pr(horiz, font) # :nodoc:
+    def write_tx_pr(font, is_y_axis = nil) # :nodoc:
       rotation = nil
-      if font && font[:_rotation]
+      if font && font.respond_to?(:[]) && 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.
@@ -803,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
@@ -872,6 +903,7 @@ def write_def_rpr_r_pr_common(font, style_attributes, tag)  # :nodoc:
     #
     def get_font_latin_attributes(font)
       return [] unless font
+      return [] unless font.respond_to?(:[])
 
       attributes = []
       attributes << ['typeface', font[:_name]]            if ptrue?(font[:_name])
@@ -928,6 +960,7 @@ def color(color_code) # :nodoc:
     #
     def get_font_style_attributes(font)
       return [] unless font
+      return [] unless font.respond_to?(:[])
 
       attributes = []
       attributes << ['sz', font[:_size]]      if ptrue?(font[:_size])