write_xlsx 0.97.0 → 1.04.0

data/lib/write_xlsx/format.rb

@@ -180,7 +180,7 @@ def initialize(formats, params = {})   # :nodoc:
       @xf_index       = nil
       @dxf_index      = nil
 
-      @num_format     = 0
+      @num_format     = 'General'
       @num_format_index = 0
       @font_index     = 0
       @font           = 'Calibri'
@@ -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
@@ -478,13 +478,13 @@ def self.color(color_code)
 
       colors = Colors::COLORS
 
+      # Return the default color if nil,
+      return 0x00 unless color_code
+
       if color_code.respond_to?(:to_str)
         # Return RGB style colors for processing later.
         return color_code if color_code =~ /^#[0-9A-F]{6}$/i
 
-        # Return the default color if undef,
-        return 0x00 unless color_code
-
         # or the color string converted to an integer,
         return colors[color_code.downcase.to_sym] if colors[color_code.downcase.to_sym]
 

data/lib/write_xlsx/package/comments.rb

@@ -14,28 +14,29 @@ class Comment
       DEFAULT_HEIGHT = 74
 
       attr_reader :row, :col, :string, :color, :vertices
+      attr_reader :font_size, :font_family
       attr_accessor :author, :visible
 
       def initialize(workbook, worksheet, row, col, string, options = {})
         options ||= {}
-        @workbook   = workbook
-        @worksheet  = worksheet
-        @row, @col  = row, col
+        @workbook    = workbook
+        @worksheet   = worksheet
+        @row, @col   = row, col
         options_parse(row, col, options)
-        @string     = string[0, STR_MAX]
-        @start_row  ||= default_start_row(row)
-        @start_col  ||= default_start_col(col)
-        @visible    = options[:visible]
-        @x_offset   = options[:x_offset] || default_x_offset(col)
-        @y_offset   = options[:y_offset] || default_y_offset(row)
-        @x_scale    = options[:x_scale]  || 1
-        @y_scale    = options[:y_scale]  || 1
-        @width      = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
-        @height     = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
-        @vertices   = @worksheet.position_object_pixels(
-                                             @start_col, @start_row, @x_offset, @y_offset,
-                                             @width, @height
-                                             ) << [@width, @height]
+        @string      = string[0, STR_MAX]
+        @start_row   ||= default_start_row(row)
+        @start_col   ||= default_start_col(col)
+        @visible     = options[:visible]
+        @x_offset    = options[:x_offset] || default_x_offset(col)
+        @y_offset    = options[:y_offset] || default_y_offset(row)
+        @x_scale     = options[:x_scale]  || 1
+        @y_scale     = options[:y_scale]  || 1
+        @width       = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
+        @height      = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
+        @vertices    = @worksheet.position_object_pixels(
+          @start_col, @start_row, @x_offset, @y_offset,
+          @width, @height
+        ) << [@width, @height]
       end
 
       def backgrount_color(color)
@@ -154,7 +155,7 @@ def visibility
       #
       def fill_attributes
         [
-         ['color2', '#ffffe1']
+          ['color2', '#ffffe1']
         ]
       end
 
@@ -163,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)
@@ -213,24 +214,31 @@ def writer=(w)
         @writer = w
       end
 
+      def font_name
+        @font
+      end
+
       private
 
       def options_parse(row, col, options)
-        @color      = backgrount_color(options[:color] || DEFAULT_COLOR)
-        @author     = options[:author]
-        @start_cell = options[:start_cell]
+        @color       = backgrount_color(options[:color] || DEFAULT_COLOR)
+        @author      = options[:author]
+        @start_cell  = options[:start_cell]
         @start_row, @start_col = if @start_cell
           substitute_cellref(@start_cell)
         else
           [ options[:start_row], options[:start_col] ]
         end
-        @visible    = options[:visible]
-        @x_offset   = options[:x_offset] || default_x_offset(col)
-        @y_offset   = options[:y_offset] || default_y_offset(row)
-        @x_scale    = options[:x_scale]  || 1
-        @y_scale    = options[:y_scale]  || 1
-        @width      = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
-        @height     = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
+        @visible     = options[:visible]
+        @x_offset    = options[:x_offset]       || default_x_offset(col)
+        @y_offset    = options[:y_offset]       || default_y_offset(row)
+        @x_scale     = options[:x_scale]        || 1
+        @y_scale     = options[:y_scale]        || 1
+        @font        = options[:font]           || 'Tahoma'
+        @font_size   = options[:font_size]      || 8
+        @font_family = options[:font_family]    || 2
+        @width       = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
+        @height      = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
       end
     end
 
@@ -249,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?
@@ -285,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?
 
@@ -366,36 +374,37 @@ def write_comment(comment)
         attributes << ['authorId', author_id]
 
         @writer.tag_elements('comment', attributes) do
-          write_text(comment.string)
+          write_text(comment)
         end
       end
 
       #
       # Write the <text> element.
       #
-      def write_text(text)
+      def write_text(comment)
         @writer.tag_elements('text') do
           # Write the text r element.
-          write_text_r(text)
+          write_text_r(comment)
         end
       end
 
       #
       # Write the <r> element.
       #
-      def write_text_r(text)
+      def write_text_r(comment)
         @writer.tag_elements('r') do
           # Write the rPr element.
-          write_r_pr
+          write_r_pr(comment)
           # Write the text r element.
-          write_text_t(text)
+          write_text_t(comment)
         end
       end
 
       #
       # Write the text <t> element.
       #
-      def write_text_t(text)
+      def write_text_t(comment)
+        text = comment.string
         attributes = []
 
         attributes << ['xml:space', 'preserve'] if text =~ /^\s/ || text =~ /\s$/
@@ -406,25 +415,23 @@ def write_text_t(text)
       #
       # Write the <rPr> element.
       #
-      def write_r_pr
+      def write_r_pr(comment)
         @writer.tag_elements('rPr') do
           # Write the sz element.
-          write_sz
+          write_sz(comment.font_size)
           # Write the color element.
           write_color
           # Write the rFont element.
-          write_r_font
+          write_r_font(comment.font_name)
           # Write the family element.
-          write_family
+          write_family(comment.font_family)
         end
       end
 
       #
       # Write the <sz> element.
       #
-      def write_sz
-        val  = 8
-
+      def write_sz(val)
         attributes = [ ['val', val] ]
 
         @writer.empty_tag('sz', attributes)
@@ -440,9 +447,7 @@ def write_color
       #
       # Write the <rFont> element.
       #
-      def write_r_font
-        val  = 'Tahoma'
-
+      def write_r_font(val)
         attributes = [ ['val', val] ]
 
         @writer.empty_tag('rFont', attributes)
@@ -451,9 +456,7 @@ def write_r_font
       #
       # Write the <family> element.
       #
-      def write_family
-        val  = 2
-
+      def write_family(val)
         attributes = [ ['val', val] ]
 
         @writer.empty_tag('family', attributes)

data/lib/write_xlsx/package/conditional_format.rb

@@ -749,7 +749,15 @@ def write_cf_rule
             write_formula_tag(maximum)
           end
         else
-          write_cf_rule_formula_tag(value)
+          quoted_value = value.to_s
+          numeric_regex = /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/
+          # String "Cell" values must be quoted, apart from ranges.
+          if !(quoted_value =~ /(\$?)([A-Z]{1,3})(\$?)(\d+)/) &&
+             !(quoted_value =~ numeric_regex) &&
+             !(quoted_value =~ /^".*"$/)
+            quoted_value = (%Q!"#{value}"!)
+          end
+          write_cf_rule_formula_tag(quoted_value)
         end
       end
     end

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

@@ -240,6 +240,11 @@ def handle_the_function_for_the_table_row(row2, col_data, col_num, user_data)
       # Convert a table total function to a worksheet formula.
       #
       def table_function_to_formula(function, col_name)
+        col_name = col_name.gsub(/'/, "''").
+                     gsub(/#/, "'#").
+                     gsub(/\[/, "'[").
+                     gsub(/\]/, "']")
+
         subtotals = {
           :average   => 101,
           :countNums => 102,
@@ -393,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