write_xlsx 0.85.9 → 1.09.2

data/lib/write_xlsx/package/conditional_format.rb

@@ -7,8 +7,8 @@ module Writexlsx
 
       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 @@ module Writexlsx
           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 @@ module Writexlsx
       #
       # 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
@@ -71,6 +75,7 @@ module Writexlsx
         attr << ['type' , type]
         attr << ['dxfId',    format]   if format
         attr << ['priority', priority]
+        attr << ['stopIfTrue', 1] if stop_if_true
         attr
       end
 
@@ -86,6 +91,10 @@ module Writexlsx
         @param[:priority]
       end
 
+      def stop_if_true
+        @param[:stop_if_true]
+      end
+
       def criteria
         @param[:criteria]
       end
@@ -149,6 +158,54 @@ module Writexlsx
         @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)
@@ -269,17 +326,68 @@ module Writexlsx
           @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[:bar_color] = palette_color(@param[:bar_color])
+          @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
+
+          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)
@@ -288,15 +396,9 @@ module Writexlsx
 
       def range_start_cell_for_conditional_formatting(*args)  # :nodoc:
         row1, row2, col1, col2, user_range, param =
-          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)
-          @start_cell = range
-        else
-          range = xl_range(row1, row2, col1, col2)
-          @start_cell = xl_rowcol_to_cell(row1, col1)
-        end
+                                            row_col_param_for_conditional_formatting(*args)
+        range       = xl_range(row1, row2, col1, col2)
+        @start_cell = xl_rowcol_to_cell(row1, col1)
 
         # Override with user defined multiple range if provided.
         range = user_range if user_range
@@ -331,19 +433,32 @@ module Writexlsx
 
       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
 
@@ -364,6 +479,32 @@ module Writexlsx
           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)
@@ -395,22 +536,39 @@ module Writexlsx
       # List of valid input parameters for conditional_formatting.
       def valid_parameter_for_conditional_formatting
         [
-         :type,
-         :format,
-         :criteria,
-         :value,
-         :minimum,
-         :maximum,
-         :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
 
@@ -434,7 +592,8 @@ module Writexlsx
           '2_color_scale' => '2_color_scale',
           '3_color_scale' => '3_color_scale',
           'data_bar'      => 'dataBar',
-          'formula'       => 'expression'
+          'formula'       => 'expression',
+          'icon_set'      => 'iconSet'
         }
       end
 
@@ -473,6 +632,100 @@ module Writexlsx
         }
       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
@@ -490,7 +743,15 @@ module Writexlsx
             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
@@ -572,6 +833,9 @@ module Writexlsx
       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
 
@@ -579,13 +843,42 @@ module Writexlsx
       # 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
@@ -593,5 +886,33 @@ module Writexlsx
         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

data/lib/write_xlsx/package/content_types.rb

@@ -165,9 +165,9 @@ module Writexlsx
       #
       def add_table_name(table_name)
         add_override(
-                     "/xl/tables/#{table_name}.xml",
-                     "#{App_document}spreadsheetml.table+xml"
-                     )
+          "/xl/tables/#{table_name}.xml",
+          "#{App_document}spreadsheetml.table+xml"
+        )
       end
 
       #
@@ -178,6 +178,25 @@ module Writexlsx
         add_default('bin', 'application/vnd.ms-office.vbaProject')
       end
 
+      #
+      # Add the name of a table to the ContentTypes overrides.
+      #
+      def add_custom_properties
+        custom = "/docProps/custom.xml"
+
+        add_override(custom, "#{App_document}custom-properties+xml")
+      end
+
+      #
+      # Add the metadata file to the ContentTypes overrides.
+      #
+      def add_metadata
+        add_override(
+          "/xl/metadata.xml",
+          "#{App_document}spreadsheetml.sheetMetadata+xml"
+        )
+      end
+
       private
 
       def change_the_workbook_xml_content_type_from_xlsx_to_xlsm
@@ -209,10 +228,10 @@ module Writexlsx
 
       def write_default_or_override(tag, param0, a)
         @writer.empty_tag(tag,
-          [
-            [param0, a[0]],
-            ['ContentType', a[1]]
-          ])
+                          [
+                            [param0, a[0]],
+                            ['ContentType', a[1]]
+                          ])
       end
 
       #
@@ -221,8 +240,8 @@ module Writexlsx
       def write_types
         xmlns = 'http://schemas.openxmlformats.org/package/2006/content-types'
         attributes = [
-                      ['xmlns', xmlns]
-                     ]
+          ['xmlns', xmlns]
+        ]
 
         @writer.tag_elements('Types', attributes) { yield }
       end

data/lib/write_xlsx/package/core.rb

@@ -14,7 +14,7 @@ module Writexlsx
       def initialize
         @writer = Package::XMLWriterSimple.new
         @properties = {}
-        @localtime  = [Time.now]
+        @createtime  = [Time.now.gmtime]
       end
 
       def set_xml_writer(filename)
@@ -47,12 +47,14 @@ module Writexlsx
       end
 
       #
-      # Convert a localtime() date to a ISO 8601 style "2010-01-01T00:00:00Z" date.
+      # Convert a gmtime/localtime() date to a ISO 8601 style
+      # "2010-01-01T00:00:00Z" date. Excel always treats this as
+      # a utc date/time.
       #
-      def localtime_to_iso8601_date(local_time = nil)
-        local_time ||= Time.now
+      def datetime_to_iso8601_date(gm_time = nil)
+        gm_time ||= Time.now.gmtime
 
-        local_time.strftime('%Y-%m-%dT%H:%M:%SZ')
+        gm_time.strftime('%Y-%m-%dT%H:%M:%SZ')
       end
 
       #
@@ -66,11 +68,11 @@ module Writexlsx
         xmlns_xsi      = 'http://www.w3.org/2001/XMLSchema-instance'
 
         attributes = [
-            ['xmlns:cp',       xmlns_cp],
-            ['xmlns:dc',       xmlns_dc],
-            ['xmlns:dcterms',  xmlns_dcterms],
-            ['xmlns:dcmitype', xmlns_dcmitype],
-            ['xmlns:xsi',      xmlns_xsi]
+          ['xmlns:cp',       xmlns_cp],
+          ['xmlns:dc',       xmlns_dc],
+          ['xmlns:dcterms',  xmlns_dcterms],
+          ['xmlns:dcmitype', xmlns_dcmitype],
+          ['xmlns:xsi',      xmlns_xsi]
         ]
 
         @writer.tag_elements('cp:coreProperties', attributes) { yield }
@@ -109,7 +111,7 @@ module Writexlsx
       end
 
       def dcterms_date
-        localtime_to_iso8601_date(@properties[:created])
+        datetime_to_iso8601_date(@properties[:created])
       end
 
       #