write_xlsx 0.90.0 → 0.97.0

data/lib/write_xlsx/version.rb

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

data/lib/write_xlsx/workbook.rb

@@ -44,11 +44,14 @@ class Workbook
     attr_reader :worksheets, :charts, :drawings  # :nodoc:
     attr_reader :named_ranges   # :nodoc:
     attr_reader :doc_properties  # :nodoc:
+    attr_reader :custom_properties # :nodoc:
     attr_reader :image_types, :images  # :nodoc:
     attr_reader :shared_strings  # :nodoc:
     attr_reader :vba_project  # :nodoc:
     attr_reader :excel2003_style # :nodoc:
     attr_reader :strings_to_urls # :nodoc:
+    attr_reader :default_url_format # :nodoc:
+
     #
     # A new Excel workbook is created using the +new+ constructor
     # which accepts either a filename or an IO object as a parameter.
@@ -114,7 +117,7 @@ def initialize(file, *option_params)
       @named_ranges        = []
       @custom_colors       = []
       @doc_properties      = {}
-      @local_time          = Time.now
+      @custom_properties   = []
       @optimization        = options[:optimization] || 0
       @x_window            = 240
       @y_window            = 15
@@ -141,6 +144,10 @@ def initialize(file, *option_params)
       else
         add_format(default_formats.merge(:xf_index => 0))
       end
+
+      # Add a default URL format.
+      @default_url_format = add_format(:hyperlink => 1)
+
       set_color_palette
     end
 
@@ -758,6 +765,25 @@ def define_name(name, formula)
       @defined_names.push([ name, sheet_index, formula.sub(/^=/, '') ])
     end
 
+    #
+    # Set the workbook size.
+    #
+    def set_size(width = nil, height = nil)
+      if ptrue?(width)
+        # Convert to twips at 96 dpi.
+        @window_width = width.to_i * 1440 / 96
+      else
+        @window_width = 16095
+      end
+
+      if ptrue?(height)
+        # Convert to twips at 96 dpi.
+        @window_height = height.to_i * 1440 / 96
+      else
+        @window_height = 9660
+      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
@@ -819,6 +845,53 @@ def set_properties(params)
       @doc_properties = params.dup
     end
 
+    #
+    # Set a user defined custom document property.
+    #
+    def set_custom_property(name, value, type = nil)
+    # Valid types.
+      valid_type = {
+        'text'       => 1,
+        'date'       => 1,
+        'number'     => 1,
+        'number_int' => 1,
+        'bool'       => 1,
+      }
+
+      if !name || (type != 'bool' && !value)
+        raise "The name and value parameters must be defined in set_custom_property()"
+      end
+
+      # Determine the type for strings and numbers if it hasn't been specified.
+      if !ptrue?(type)
+        if value =~ /^\d+$/
+            type = 'number_int'
+        elsif value =~
+            /^([+-]?)(?=[0-9]|\.[0-9])[0-9]*(\.[0-9]*)?([Ee]([+-]?[0-9]+))?$/
+          type = 'number'
+        else
+          type = 'text'
+        end
+      end
+
+      # Check for valid validation types.
+      if !valid_type[type]
+        raise "Unknown custom type '$type' in set_custom_property()"
+      end
+
+      #  Check for strings longer than Excel's limit of 255 chars.
+      if type == 'text' && value.length > 255
+        raise "Length of text custom value '$value' exceeds Excel's limit of 255 in set_custom_property()"
+      end
+
+      if type == 'bool'
+        value = value ? 1 : 0
+      end
+
+      @custom_properties << [name, value, type]
+    end
+
+
     #
     # The add_vba_project method can be used to add macros or functions to an
     # WriteXLSX file using a binary VBA project file that has been extracted
@@ -877,6 +950,16 @@ def set_calc_mode(mode, calc_id = nil)
       @calc_id = calc_id if calc_id
     end
 
+    #
+    # Get the default url format used when a user defined format isn't specified
+    # with write_url(). The format is the hyperlink style defined by Excel for the
+    # default theme.
+    #
+    def default_url_format
+      @default_url_format
+    end
+    alias get_default_url_format default_url_format
+
     #
     # Change the RGB components of the elements in the colour palette.
     #
@@ -1922,6 +2005,10 @@ def get_image_properties(filename)
 
       @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]
     end
 

data/lib/write_xlsx/worksheet.rb

@@ -294,7 +294,7 @@ class Worksheet
     attr_reader :writer, :set_rows, :col_formats # :nodoc:
     attr_reader :vml_shape_id # :nodoc:
     attr_reader :comments, :comments_author # :nodoc:
-    attr_accessor :dxf_priority # :nodoc:
+    attr_accessor :data_bars_2010, :dxf_priority # :nodoc:
     attr_reader :vba_codename # :nodoc:
     attr_writer :excel_version
 
@@ -308,6 +308,7 @@ def initialize(workbook, index, name) #:nodoc:
       @cell_data_table = {}
       @excel_version = 2007
       @palette = workbook.palette
+      @default_url_format = workbook.default_url_format
 
       @page_setup = PageSetup.new
 
@@ -376,8 +377,9 @@ def initialize(workbook, index, name) #:nodoc:
 
       @validations = []
 
-      @cond_formats = {}
-      @dxf_priority = 1
+      @cond_formats   = {}
+      @data_bars_2010 = []
+      @dxf_priority   = 1
 
       if excel2003_style?
         @original_row_height      = 12.75
@@ -422,7 +424,7 @@ def assemble_xml_file #:nodoc:
           write_legacy_drawing
           write_legacy_drawing_hf
           write_table_parts
-          write_ext_sparklines
+          write_ext_list
         end
       end
     end
@@ -2781,6 +2783,9 @@ def write_url(*args)
         raise "URL '#{url}' added but number of URLS is over Excel's limit of 65,530 URLS per worksheet."
       end
 
+      # Add the default URL format.
+      xf = @default_url_format unless xf
+
       # Write the hyperlink string.
       write_string(row, col, hyperlink.str, xf)
     end
@@ -6037,6 +6042,26 @@ def set_vba_name(vba_codename = nil)
       end
     end
 
+    def write_ext(url)
+      attributes = [
+        ['xmlns:x14', "#{OFFICE_URL}spreadsheetml/2009/9/main"],
+        ['uri',       url]
+      ]
+      @writer.tag_elements('ext', attributes) do
+        yield
+      end
+    end
+
+    def write_sparkline_groups
+      # Write the x14:sparklineGroups element.
+      @writer.tag_elements('x14:sparklineGroups', sparkline_groups_attributes) do
+        # Write the sparkline elements.
+        @sparklines.reverse.each do |sparkline|
+          sparkline.write_sparkline_group(@writer)
+        end
+      end
+    end
+
     private
 
     def hyperlinks_count
@@ -6648,9 +6673,10 @@ def encode_password(password) #:nodoc:
     def write_worksheet_attributes #:nodoc:
       schema = 'http://schemas.openxmlformats.org/'
       attributes = [
-                    ['xmlns',    "#{schema}spreadsheetml/2006/main"],
-                    ['xmlns:r',  "#{schema}officeDocument/2006/relationships"]
-                   ]
+        ['xmlns',    "#{schema}spreadsheetml/2006/main"],
+        ['xmlns:r',  "#{schema}officeDocument/2006/relationships"]
+      ]
+
       if @excel_version == 2010
         attributes << ['xmlns:mc',     "#{schema}markup-compatibility/2006"]
         attributes << ['xmlns:x14ac',  "#{OFFICE_URL}spreadsheetml/2009/9/ac"]
@@ -7506,31 +7532,229 @@ def write_r_id(tag, id)
     end
 
     #
-    # Write the <extLst> element and sparkline subelements.
+    # Write the <extLst> element for data bars and sparklines.
     #
-    def write_ext_sparklines  # :nodoc:
-      @writer.tag_elements('extLst') { write_ext } unless @sparklines.empty?
+    def write_ext_list  # :nodoc:
+      return if @data_bars_2010.empty? && @sparklines.empty?
+
+      @writer.tag_elements('extLst') do
+        write_ext_list_data_bars  if @data_bars_2010.size > 0
+        write_ext_list_sparklines if @sparklines.size > 0
+      end
     end
 
-    def write_ext
-      @writer.tag_elements('ext', write_ext_attributes) do
-        write_sparkline_groups
+    #
+    # Write the Excel 2010 data_bar subelements.
+    #
+    def write_ext_list_data_bars
+      # Write the ext element.
+      write_ext('{78C0D931-6437-407d-A8EE-F0AAD7539E65}') do
+
+        @writer.tag_elements('x14:conditionalFormattings') do
+          # Write each of the Excel 2010 conditional formatting data bar elements.
+          @data_bars_2010.each do |data_bar|
+            # Write the x14:conditionalFormatting element.
+            write_conditional_formatting_2010(data_bar)
+          end
+        end
       end
     end
+    #
+    # Write the <x14:conditionalFormatting> element.
+    #
+    def write_conditional_formatting_2010(data_bar)
+      xmlns_xm = 'http://schemas.microsoft.com/office/excel/2006/main'
 
-    def write_ext_attributes
-      [
-       ['xmlns:x14', "#{OFFICE_URL}spreadsheetml/2009/9/main"],
-       ['uri',       '{05C60535-1F16-4fd2-B633-F4F36F0B64E0}']
+      attributes = [ ['xmlns:xm', xmlns_xm] ]
+
+      @writer.tag_elements('x14:conditionalFormatting', attributes) do
+
+        # Write the '<x14:cfRule element.
+        write_x14_cf_rule(data_bar)
+
+        # Write the x14:dataBar element.
+        write_x14_data_bar(data_bar)
+
+        # Write the x14 max and min data bars.
+        write_x14_cfvo(data_bar[:x14_min_type], data_bar[:min_value])
+        write_x14_cfvo(data_bar[:x14_max_type], data_bar[:max_value])
+
+        # Write the x14:borderColor element.
+        if !ptrue?(data_bar[:bar_no_border])
+          write_x14_border_color(data_bar[:bar_border_color])
+        end
+
+        # Write the x14:negativeFillColor element.
+        if !ptrue?(data_bar[:bar_negative_color_same])
+          write_x14_negative_fill_color(data_bar[:bar_negative_color])
+        end
+
+        # Write the x14:negativeBorderColor element.
+        if !ptrue?(data_bar[:bar_no_border]) &&
+           !ptrue?(data_bar[:bar_negative_border_color_same])
+          write_x14_negative_border_color(
+            data_bar[:bar_negative_border_color])
+        end
+
+        # Write the x14:axisColor element.
+        if data_bar[:bar_axis_position] != 'none'
+          write_x14_axis_color(data_bar[:bar_axis_color])
+        end
+
+        # Write closing elements.
+        @writer.end_tag('x14:dataBar')
+        @writer.end_tag('x14:cfRule')
+
+        # Add the conditional format range.
+        @writer.data_element('xm:sqref', data_bar[:range])
+      end
+    end
+
+    #
+    # Write the <cfvo> element.
+    #
+    def write_x14_cfvo(type, value)
+      attributes = [ ['type', type ] ]
+
+      if %w(min max autoMin autoMax).include?(type)
+        @writer.empty_tag('x14:cfvo', attributes)
+      else
+        @writer.tag_elements('x14:cfvo', attributes) do
+          @writer.data_element('xm:f', value)
+        end
+      end
+    end
+
+    #
+    # Write the <'<x14:cfRule> element.
+    #
+    def write_x14_cf_rule(data_bar)
+      type = 'dataBar'
+      id   = data_bar[:guid]
+
+      attributes = [
+        ['type', type],
+        ['id',   id]
+      ]
+
+      @writer.start_tag('x14:cfRule', attributes)
+
+    end
+
+    #
+    # Write the <x14:dataBar> element.
+    #
+    def write_x14_data_bar(data_bar)
+      min_length = 0
+      max_length = 100
+
+      attributes = [
+        ['minLength', min_length],
+        ['maxLength', max_length]
       ]
+
+      attributes << ['border',   1] if !ptrue?(data_bar[:bar_no_border])
+      attributes << ['gradient', 0] if ptrue?(data_bar[:bar_solid])
+
+      if data_bar[:bar_direction] == 'left'
+        attributes << ['direction', 'leftToRight']
+      end
+      if data_bar[:bar_direction] == 'right'
+        attributes << ['direction', 'rightToLeft']
+      end
+
+      if ptrue?(data_bar[:bar_negative_color_same])
+        attributes << ['negativeBarColorSameAsPositive', 1]
+      end
+
+      if !ptrue?(data_bar[:bar_no_border]) &&
+         !ptrue?(data_bar[:bar_negative_border_color_same])
+        attributes << ['negativeBarBorderColorSameAsPositive', 0]
+      end
+
+      if data_bar[:bar_axis_position] == 'middle'
+        attributes << ['axisPosition', 'middle']
+      end
+
+      if data_bar[:bar_axis_position] == 'none'
+        attributes << ['axisPosition', 'none']
+      end
+
+      @writer.start_tag('x14:dataBar', attributes)
     end
 
-    def write_sparkline_groups
-      # Write the x14:sparklineGroups element.
-      @writer.tag_elements('x14:sparklineGroups', sparkline_groups_attributes) do
-        # Write the sparkline elements.
-        @sparklines.reverse.each do |sparkline|
-          sparkline.write_sparkline_group(@writer)
+    #
+    # Write the <x14:borderColor> element.
+    #
+    def write_x14_border_color(rgb)
+      attributes = [ ['rgb', rgb]  ]
+
+      @writer.empty_tag('x14:borderColor', attributes)
+    end
+
+    #
+    # Write the <x14:negativeFillColor> element.
+    #
+    def write_x14_negative_fill_color(rgb)
+      attributes = [ ['rgb', rgb] ]
+
+      @writer.empty_tag('x14:negativeFillColor', attributes)
+    end
+
+    #
+    # Write the <x14:negativeBorderColor> element.
+    #
+    def write_x14_negative_border_color(rgb)
+      attributes = [ ['rgb', rgb] ]
+
+      @writer.empty_tag('x14:negativeBorderColor', attributes)
+    end
+
+    #
+    # Write the <x14:axisColor> element.
+    #
+    def write_x14_axis_color(rgb)
+      attributes = [ ['rgb', rgb] ]
+
+      @writer.empty_tag('x14:axisColor', attributes)
+    end
+
+    #
+    # Write the sparkline subelements.
+    #
+    def write_ext_list_sparklines
+      # Write the ext element.
+      write_ext('{05C60535-1F16-4fd2-B633-F4F36F0B64E0}') do
+
+        # Write the x14:sparklineGroups element.
+        write_sparkline_groups
+
+        #      # Write the sparkline elements.
+        #       @sparklines.reverse.each do |sparkline|
+        #         # Write the x14:sparklineGroup element.
+        # #        sparkline.write_sparkline_group(@writer)
+
+        #         @writer.end_tag('x14:sparklineGroup')
+        #       end
+
+        #       @writer.end_tag('x14:sparklineGroups')
+      end
+    end
+
+    #
+    # Write the <x14:sparklines> element and <x14:sparkline> subelements.
+    #
+    def write_sparklines(sparkline)
+      # Write the sparkline elements.
+      @writer.tag_elements('x14:sparklines') do
+        (0..sparkline[:count]-1).each do |i|
+          range    = sparkline[:ranges][i]
+          location = sparkline[:locations][i]
+
+          @writer.tag_elements('x14:sparkline') do
+            @writer.data_element('xm:f', range)
+            @writer.data_element('xm:sqref', location)
+          end
         end
       end
     end