write_xlsx 0.89.0 → 1.01.0

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)
@@ -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

@@ -7,8 +7,8 @@ class ConditionalFormat
 
       def self.factory(worksheet, *args)
         range, param  =
-          Package::ConditionalFormat.new(worksheet, nil, nil).
-          range_param_for_conditional_formatting(*args)
+               Package::ConditionalFormat.new(worksheet, nil, nil).
+                 range_param_for_conditional_formatting(*args)
 
         case param[:type]
         when 'cellIs'
@@ -29,6 +29,8 @@ def self.factory(worksheet, *args)
           DataBarFormat.new(worksheet, range, param)
         when 'expression'
           ExpressionFormat.new(worksheet, range, param)
+        when 'iconSet'
+          IconSetFormat.new(worksheet, range, param)
         else # when 'duplicateValues', 'uniqueValues'
           ConditionalFormat.new(worksheet, range, param)
         end
@@ -59,11 +61,13 @@ def write_formula_tag(data) #:nodoc:
       #
       # Write the <cfvo> element.
       #
-      def write_cfvo(type, val)
-        @writer.empty_tag('cfvo', [
-                                   ['type', type],
-                                   ['val', val]
-                                  ])
+      def write_cfvo(type, value, criteria = nil)
+        attributes = [ ['type', type] ]
+        attributes << [ 'val', value] if value
+
+        attributes << ['gte', 0] if ptrue?(criteria)
+
+        @writer.empty_tag('cfvo', attributes)
       end
 
       def attributes
@@ -154,6 +158,54 @@ def bar_color
         @param[:bar_color]
       end
 
+      def bar_border_color
+        @param[:bar_border_color]
+      end
+
+      def bar_negative_color
+        @param[:bar_negative_color]
+      end
+
+      def bar_negative_color_same
+        @param[:bar_negative_color_same]
+      end
+
+      def bar_no_border
+        @param[:bar_no_border]
+      end
+
+      def bar_axis_position
+        @param[:bar_axis_position]
+      end
+
+      def bar_axis_color
+        @param[:bar_axis_color]
+      end
+
+      def icon_style
+        @param[:icon_style]
+      end
+
+      def total_icons
+        @param[:total_icons]
+      end
+
+      def icons
+        @param[:icons]
+      end
+
+      def icons_only
+        @param[:icons_only]
+      end
+
+      def reverse_icons
+        @param[:reverse_icons]
+      end
+
+      def bar_only
+        @param[:bar_only]
+      end
+
       def range_param_for_conditional_formatting(*args)  # :nodoc:
         range_start_cell_for_conditional_formatting(*args)
         param_for_conditional_formatting(*args)
@@ -274,17 +326,68 @@ def handling_of_blanks_error_types
           @param[:mid_color] = palette_color(@param[:mid_color])
           @param[:min_color] = palette_color(@param[:min_color])
         when 'dataBar'
-          # Color scales don't use any additional formatting.
+          # Excel 2007 data bars don't use any additional formatting.
           @param[:format] = nil
 
-          @param[:min_type]  ||= 'min'
-          @param[:max_type]  ||= 'max'
-          @param[:min_value] ||= 0
-          @param[:max_value] ||= 0
-          @param[:bar_color] ||= '#638EC6'
+          if !@param[:min_type]
+            @param[:min_type]     = 'min'
+            @param[:x14_min_type] = 'autoMin'
+          else
+            @param[:x14_min_type] = @param[:min_type]
+          end
+          if !@param[:max_type]
+            @param[:max_type]     = 'max'
+            @param[:x14_max_type] = 'autoMax'
+          else
+            @param[:x14_max_type] = @param[:max_type]
+          end
+
+          @param[:min_value]                      ||= 0
+          @param[:max_value]                      ||= 0
+          @param[:bar_color]                      ||= '#638EC6'
+          @param[:bar_border_color]               ||= @param[:bar_color]
+          @param[:bar_only]                       ||= 0
+          @param[:bar_no_border]                  ||= 0
+          @param[:bar_solid]                      ||= 0
+          @param[:bar_direction]                  ||= ''
+          @param[:bar_negative_color]             ||= '#FF0000'
+          @param[:bar_negative_border_color]      ||= '#FF0000'
+          @param[:bar_negative_color_same]        ||= 0
+          @param[:bar_negative_border_color_same] ||= 0
+          @param[:bar_axis_position]              ||= ''
+          @param[:bar_axis_color]                 ||= '#000000'
+
+          @param[:bar_color] =
+            palette_color(@param[:bar_color])
+          @param[:bar_border_color] =
+            palette_color(@param[:bar_border_color])
+          @param[:bar_negative_color] =
+            palette_color(@param[:bar_negative_color])
+          @param[:bar_negative_border_color] =
+            palette_color(@param[:bar_negative_border_color])
+          @param[:bar_axis_color] =
+            palette_color(@param[:bar_axis_color])
+        end
+
+        # Adjust for 2010 style data_bar parameters.
+        if ptrue?(@param[:is_data_bar_2010])
+          @worksheet.excel_version = 2010
 
-          @param[:bar_color] = palette_color(@param[:bar_color])
+          if @param[:min_type] == 'min' && @param[:min_value] == 0
+            @param[:min_value] = nil
+          end
+          if @param[:max_type] == 'max' && @param[:max_value] == 0
+            @param[:max_value] = nil
+          end
+
+          # Store range for Excel 2010 data bars.
+          @param[:range] = range
         end
+
+        # Strip the leading = from formulas.
+        @param[:min_value] = @param[:min_value].to_s.sub(/^=/, '') if @param[:min_value]
+        @param[:mid_value] = @param[:mid_value].to_s.sub(/^=/, '') if @param[:mid_value]
+        @param[:max_value] = @param[:max_value].to_s.sub(/^=/, '') if @param[:max_value]
       end
 
       def palette_color(index)
@@ -293,7 +396,7 @@ def palette_color(index)
 
       def range_start_cell_for_conditional_formatting(*args)  # :nodoc:
         row1, row2, col1, col2, user_range, param =
-          row_col_param_for_conditional_formatting(*args)
+                                            row_col_param_for_conditional_formatting(*args)
         # If the first and last cell are the same write a single cell.
         if row1 == row2 && col1 == col2
           range = xl_rowcol_to_cell(row1, col1)
@@ -336,19 +439,32 @@ def row_col_param_for_conditional_formatting(*args)
 
       def param_for_conditional_formatting(*args)  # :nodoc:
         dummy, dummy, dummy, dummy, dummy, @param =
-          row_col_param_for_conditional_formatting(*args)
+                                           row_col_param_for_conditional_formatting(*args)
         check_conditional_formatting_parameters(@param)
 
         @param[:format] = @param[:format].get_dxf_index if @param[:format]
         @param[:priority] = @worksheet.dxf_priority
+
+        # Check for 2010 style data_bar parameters.
+        %i(data_bar_2010 bar_solid bar_border_color bar_negative_color
+           bar_negative_color_same bar_negative_border_color
+           bar_negative_border_color_same bar_no_border
+           bar_axis_position bar_axis_color bar_direction
+        ).each do |key|
+          if @param[key]
+            @param[:is_data_bar_2010] = 1
+            break
+          end
+        end
+
         @worksheet.dxf_priority += 1
       end
 
       def check_conditional_formatting_parameters(param)  # :nodoc:
         # Check for valid input parameters.
-        unless (param.keys.uniq - valid_parameter_for_conditional_formatting).empty? &&
-            param.has_key?(:type)                                   &&
-            valid_type_for_conditional_formatting.has_key?(param[:type].downcase)
+        if !(param.keys.uniq - valid_parameter_for_conditional_formatting).empty? ||
+           !param.has_key?(:type) ||
+           !valid_type_for_conditional_formatting.has_key?(param[:type].downcase)
           raise WriteXLSXOptionParameterError, "Invalid type : #{param[:type]}"
         end
 
@@ -369,6 +485,32 @@ def check_conditional_formatting_parameters(param)  # :nodoc:
           param[:maximum] = convert_date_time_if_required(param[:maximum])
         end
 
+        # Set properties for icon sets.
+        if param[:type] == 'iconSet'
+          if !param[:icon_style]
+            raise "The 'icon_style' parameter must be specified when " +
+                  "'type' == 'icon_set' in conditional_formatting()"
+          end
+
+          # Check for valid icon styles.
+          if !icon_set_styles[param[:icon_style]]
+            raise "Unknown icon style '$param->{icon_style}' for parameter " +
+                  "'icon_style' in conditional_formatting()"
+          else
+            param[:icon_style] = icon_set_styles[param[:icon_style]]
+          end
+
+          # Set the number of icons for the icon style.
+          param[:total_icons] = 3
+          if param[:icon_style] =~ /^4/
+            param[:total_icons] = 4
+          elsif param[:icon_style] =~ /^5/
+            param[:total_icons] = 5
+          end
+
+          param[:icons] = set_icon_properties(param[:total_icons], param[:icons])
+        end
+
         # 'Between' and 'Not between' criteria require 2 values.
         if param[:criteria] == 'between' || param[:criteria] == 'notBetween'
           unless param.has_key?(:minimum) || param.has_key?(:maximum)
@@ -400,23 +542,39 @@ def convert_date_time_if_required(val)
       # List of valid input parameters for conditional_formatting.
       def valid_parameter_for_conditional_formatting
         [
-         :type,
-         :format,
-         :criteria,
-         :value,
-         :minimum,
-         :maximum,
-         :stop_if_true,
-         :min_type,
-         :mid_type,
-         :max_type,
-         :min_value,
-         :mid_value,
-         :max_value,
-         :min_color,
-         :mid_color,
-         :max_color,
-         :bar_color
+          :type,
+          :format,
+          :criteria,
+          :value,
+          :minimum,
+          :maximum,
+          :stop_if_true,
+          :min_type,
+          :mid_type,
+          :max_type,
+          :min_value,
+          :mid_value,
+          :max_value,
+          :min_color,
+          :mid_color,
+          :max_color,
+          :bar_color,
+          :bar_negative_color,
+          :bar_negative_color_same,
+          :bar_solid,
+          :bar_border_color,
+          :bar_negative_border_color,
+          :bar_negative_border_color_same,
+          :bar_no_border,
+          :bar_direction,
+          :bar_axis_position,
+          :bar_axis_color,
+          :bar_only,
+          :icon_style,
+          :reverse_icons,
+          :icons_only,
+          :icons,
+          :data_bar_2010
         ]
       end
 
@@ -440,7 +598,8 @@ def valid_type_for_conditional_formatting
           '2_color_scale' => '2_color_scale',
           '3_color_scale' => '3_color_scale',
           'data_bar'      => 'dataBar',
-          'formula'       => 'expression'
+          'formula'       => 'expression',
+          'icon_set'      => 'iconSet'
         }
       end
 
@@ -479,6 +638,100 @@ def valid_criteria_type_for_conditional_formatting
         }
       end
 
+      # List of valid icon styles.
+      def icon_set_styles
+        {
+          "3_arrows"                => "3Arrows",            # 1
+          "3_flags"                 => "3Flags",             # 2
+          "3_traffic_lights_rimmed" => "3TrafficLights2",    # 3
+          "3_symbols_circled"       => "3Symbols",           # 4
+          "4_arrows"                => "4Arrows",            # 5
+          "4_red_to_black"          => "4RedToBlack",        # 6
+          "4_traffic_lights"        => "4TrafficLights",     # 7
+          "5_arrows_gray"           => "5ArrowsGray",        # 8
+          "5_quarters"              => "5Quarters",          # 9
+          "3_arrows_gray"           => "3ArrowsGray",        # 10
+          "3_traffic_lights"        => "3TrafficLights",     # 11
+          "3_signs"                 => "3Signs",             # 12
+          "3_symbols"               => "3Symbols2",          # 13
+          "4_arrows_gray"           => "4ArrowsGray",        # 14
+          "4_ratings"               => "4Rating",            # 15
+          "5_arrows"                => "5Arrows",            # 16
+          "5_ratings"               => "5Rating",            # 17
+        }
+      end
+
+      #
+      # Set the sub-properites for icons.
+      #
+      def set_icon_properties(total_icons, user_props)
+        props       = []
+
+        # Set the default icon properties.
+        total_icons.times do
+          props << {
+            :criteria => 0,
+            :value    => 0,
+            :type     => 'percent'
+          }
+        end
+
+        # Set the default icon values based on the number of icons.
+        if total_icons == 3
+          props[0][:value] = 67
+          props[1][:value] = 33
+        elsif total_icons == 4
+          props[0][:value] = 75
+          props[1][:value] = 50
+          props[2][:value] = 25
+        elsif total_icons == 5
+          props[0][:value] = 80
+          props[1][:value] = 60
+          props[2][:value] = 40
+          props[3][:value] = 20
+        end
+
+        # Overwrite default properties with user defined properties.
+        if user_props
+
+          # Ensure we don't set user properties for lowest icon.
+          max_data = user_props.size
+          max_data = total_icons -1 if max_data >= total_icons
+
+          (0..max_data - 1).each do |i|
+            # Set the user defined 'value' property.
+            if user_props[i][:value]
+              props[i][:value] = user_props[i][:value].to_s.sub(/^=/, '')
+            end
+
+            # Set the user defined 'type' property.
+            if user_props[i][:type]
+
+              type = user_props[i][:type]
+
+              if type != 'percent' && type != 'percentile' &&
+                 type != 'number'  && type != 'formula'
+                raise "Unknown icon property type '$props->{type}' for sub-" +
+                      "property 'type' in conditional_formatting()"
+              else
+                props[i][:type] = type
+
+                if props[i][:type] == 'number'
+                  props[i][:type] = 'num'
+                end
+              end
+            end
+
+            # Set the user defined 'criteria' property.
+            if user_props[i][:criteria] && user_props[i][:criteria] == '>'
+              props[i][:criteria] = 1
+            end
+
+          end
+        end
+        props
+      end
+
       def date_1904?
         @worksheet.date_1904?
       end
@@ -496,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
@@ -578,6 +839,9 @@ class DataBarFormat < ConditionalFormat
       def write_cf_rule
         @writer.tag_elements('cfRule', attributes) do
           write_data_bar
+          if ptrue?(@param[:is_data_bar_2010])
+            write_data_bar_ext(@param)
+          end
         end
       end
 
@@ -585,13 +849,42 @@ def write_cf_rule
       # Write the <dataBar> element.
       #
       def write_data_bar
-        @writer.tag_elements('dataBar') do
+        attributes = []
+
+        if ptrue?(bar_only)
+          attributes << ['showValue', 0]
+        end
+        @writer.tag_elements('dataBar',attributes) do
           write_cfvo(min_type, min_value)
           write_cfvo(max_type, max_value)
 
           write_color(@writer, 'rgb', bar_color)
         end
       end
+
+      #
+      # Write the <extLst> dataBar extension element.
+      #
+      def write_data_bar_ext(param)
+        # Create a pseudo GUID for each unique Excel 2010 data bar.
+        worksheet_count = @worksheet.index + 1
+        data_bar_count  = @worksheet.data_bars_2010.size + 1
+
+        guid = sprintf(
+          "{DA7ABA51-AAAA-BBBB-%04X-%012X}",
+          worksheet_count, data_bar_count
+        )
+
+        # Store the 2010 data bar parameters to write the extLst elements.
+        param[:guid] = guid
+        @worksheet.data_bars_2010 << param
+
+        @writer.tag_elements('extLst') do
+          @worksheet.write_ext('{B025F937-C7B1-47D3-B67F-A62EFF666E3E}') do
+            @writer.data_element('x14:id', guid)
+          end
+        end
+      end
     end
 
     class ExpressionFormat < ConditionalFormat
@@ -599,5 +892,33 @@ def write_cf_rule
         write_cf_rule_formula_tag(criteria)
       end
     end
+
+    class IconSetFormat < ConditionalFormat
+      def write_cf_rule
+        @writer.tag_elements('cfRule', attributes) do
+          write_icon_set
+        end
+      end
+
+      #
+      # Write the <iconSet> element.
+      #
+      def write_icon_set
+        attributes = []
+        # Don't set attribute for default style.
+        attributes = [ ['iconSet', icon_style] ] if icon_style != '3TrafficLights'
+        attributes << ['showValue', 0]           if icons_only
+        attributes << ['reverse', 1]             if reverse_icons
+
+        @writer.tag_elements('iconSet', attributes) do
+          # Write the properties for different icon styles.
+          if icons
+            icons.reverse.each do |icon|
+              write_cfvo(icon[:type], icon[:value], icon[:criteria])
+            end
+          end
+        end
+      end
+    end
   end
 end