write_xlsx 0.90.0 → 0.97.0

data/lib/write_xlsx/package/content_types.rb

@@ -178,6 +178,16 @@ def add_vba_project
         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
+
+
       private
 
       def change_the_workbook_xml_content_type_from_xlsx_to_xlsm

data/lib/write_xlsx/package/custom.rb

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    class Custom
+
+      include Writexlsx::Utility
+
+      def initialize
+        @writer     = Package::XMLWriterSimple.new
+        @properties = []
+        @pid        = 1
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration do
+          write_properties
+        end
+      end
+
+      #
+      # Set the document properties.
+      #
+      def set_properties(properties)
+        @properties = properties
+      end
+
+      private
+
+      def write_properties
+        schema   = 'http://schemas.openxmlformats.org/officeDocument/2006/'
+        xmlns    = "#{schema}custom-properties"
+        xmlns_vt = "#{schema}docPropsVTypes"
+
+        attributes = [
+          ['xmlns',    xmlns],
+          ['xmlns:vt', xmlns_vt]
+        ]
+
+        @writer.tag_elements('Properties', attributes ) do
+          @properties.each do |property|
+            # Write the property element.
+            write_property(property)
+        end
+        end
+      end
+
+      def write_property(property)
+        fmtid = '{D5CDD505-2E9C-101B-9397-08002B2CF9AE}'
+
+        @pid += 1
+        name, value, type  = property
+
+        attributes = [
+          ['fmtid', fmtid],
+          ['pid',   @pid],
+          ['name',  name]
+        ]
+
+        @writer.tag_elements('property', attributes) do
+          if type == 'date'
+            # Write the vt:filetime element.
+            write_vt_filetime(value)
+          elsif type == 'number'
+            # Write the vt:r8 element.
+            write_vt_r8(value)
+          elsif type == 'number_int'
+            # Write the vt:i4 element.
+            write_vt_i4(value)
+          elsif type == 'bool'
+            # Write the vt:bool element.
+            write_vt_bool(value)
+          else
+            # Write the vt:lpwstr element.
+            write_vt_lpwstr(value)
+          end
+        end
+      end
+
+      def write_vt_lpwstr(data)
+        @writer.data_element('vt:lpwstr', data)
+      end
+
+      #
+      # Write the <vt:i4> element.
+      #
+      def write_vt_i4(data)
+        @writer.data_element('vt:i4', data)
+      end
+
+      #
+      # Write the <vt:r8> element.
+      #
+      def write_vt_r8(data)
+        @writer.data_element('vt:r8', data)
+      end
+
+      #
+      # Write the <vt:bool> element.
+      #
+      def write_vt_bool(data)
+        if ptrue?(data)
+          data = 'true'
+        else
+          data = 'false'
+        end
+
+        @writer.data_element('vt:bool', data)
+    end
+
+      #
+      # Write the <vt:filetime> element.
+      #
+      def write_vt_filetime(data)
+        @writer.data_element('vt:filetime', data)
+      end
+    end
+  end
+end

data/lib/write_xlsx/package/packager.rb

@@ -5,6 +5,7 @@
 require 'write_xlsx/package/comments'
 require 'write_xlsx/package/content_types'
 require 'write_xlsx/package/core'
+require 'write_xlsx/package/custom'
 require 'write_xlsx/package/relationships'
 require 'write_xlsx/package/shared_strings'
 require 'write_xlsx/package/styles'
@@ -44,6 +45,7 @@ def create_package
         write_shared_strings_file
         write_app_file
         write_core_file
+        write_custom_file
         write_content_types_file
         write_styles_file
         write_theme_file
@@ -172,6 +174,22 @@ def write_core_file
         core.assemble_xml_file
       end
 
+      #
+      # Write the custom.xml file.
+      #
+      def write_custom_file
+        properties = @workbook.custom_properties
+        custom     = Package::Custom.new
+
+        return if properties.empty?
+
+        FileUtils.mkdir_p("#{@package_dir}/docProps")
+
+        custom.set_properties(properties)
+        custom.set_xml_writer("#{@package_dir}/docProps/custom.xml")
+        custom.assemble_xml_file
+      end
+
       #
       # Write the ContentTypes.xml file.
       #
@@ -190,6 +208,8 @@ def write_content_types_file
         content.add_shared_strings unless @workbook.shared_strings_empty?
         # Add vbaProject if present.
         content.add_vba_project if @workbook.vba_project
+        # Add the custom properties if present.
+        content.add_custom_properties unless @workbook.custom_properties.empty?
 
         content.set_xml_writer("#{@package_dir}/[Content_Types].xml")
         content.assemble_xml_file
@@ -239,9 +259,15 @@ def write_root_rels_file
         FileUtils.mkdir_p("#{@package_dir}/_rels")
 
         rels.add_document_relationship('/officeDocument', 'xl/workbook.xml')
+
         rels.add_package_relationship('/metadata/core-properties',
             'docProps/core.xml')
+
         rels.add_document_relationship('/extended-properties', 'docProps/app.xml')
+
+        unless @workbook.custom_properties.empty?
+          rels.add_document_relationship('/custom-properties', 'docProps/custom.xml')
+        end
         rels.set_xml_writer("#{@package_dir}/_rels/.rels" )
         rels.assemble_xml_file
       end

data/lib/write_xlsx/package/styles.rb

@@ -10,14 +10,16 @@ class Styles
 
       def initialize
         @writer = Package::XMLWriterSimple.new
-        @xf_formats       = nil
-        @palette          = []
-        @font_count       = 0
-        @num_format_count = 0
-        @border_count     = 0
-        @fill_count       = 0
-        @custom_colors    = []
-        @dxf_formats      = []
+        @xf_formats        = nil
+        @palette           = []
+        @font_count        = 0
+        @num_format_count  = 0
+        @border_count      = 0
+        @fill_count        = 0
+        @custom_colors     = []
+        @dxf_formats       = []
+        @has_hyperlink     = 0
+        @hyperlink_font_id = 0
       end
 
       def set_xml_writer(filename)
@@ -33,7 +35,10 @@ def assemble_xml_file
       #
       # Pass in the Format objects and other properties used to set the styles.
       #
-      def set_style_properties(xf_formats, palette, font_count, num_format_count, border_count, fill_count, custom_colors, dxf_formats)
+      def set_style_properties(
+            xf_formats, palette, font_count, num_format_count, border_count,
+            fill_count, custom_colors, dxf_formats
+          )
         @xf_formats       = xf_formats
         @palette          = palette
         @font_count       = font_count
@@ -150,7 +155,11 @@ def write_fonts
 
       def write_font_base
         @xf_formats.each do |format|
-          format.write_font(@writer, self) if format.has_font?
+          if format.has_font?
+            format.write_font(@writer, self)
+            @has_hyperlink     = 1 if ptrue?(format.hyperlink)
+            @hyperlink_font_id = format.font_index unless ptrue?(@hyperlink_font_id)
+          end
         end
       end
 
@@ -365,11 +374,17 @@ def write_sub_border(type, style = 0, color = nil)
       # Write the <cellStyleXfs> element.
       #
       def write_cell_style_xfs
-        attributes = [ ['count', 1] ]
+        count = ptrue?(@has_hyperlink) ? 2 : 1
+
+        attributes = [ ['count', count] ]
 
         @writer.tag_elements('cellStyleXfs', attributes) do
           # Write the style_xf element.
-          write_style_xf
+          write_style_xf(0, 0)
+
+          if ptrue?(@has_hyperlink)
+            write_style_xf(1, @hyperlink_font_id)
+          end
         end
       end
 
@@ -396,15 +411,27 @@ def write_cell_xfs
       #
       # Write the style <xf> element.
       #
-      def write_style_xf
+      def write_style_xf(has_hyperlink, font_id)
         attributes = [
           ['numFmtId', 0],
-          ['fontId',   0],
+          ['fontId',   font_id],
           ['fillId',   0],
           ['borderId', 0]
         ]
 
-        @writer.empty_tag('xf', attributes)
+        if ptrue?(has_hyperlink)
+          attributes << ['applyNumberFormat', 0]
+          attributes << ['applyFill',         0]
+          attributes << ['applyBorder',       0]
+          attributes << ['applyAlignment',    0]
+          attributes << ['applyProtection',   0]
+          @writer.tag_elements('xf', attributes) do
+            @writer.empty_tag('alignment',  [ ['vertical', 'top'] ])
+            @writer.empty_tag('protection', [ ['locked',   0] ])
+          end
+        else
+          @writer.empty_tag('xf', attributes)
+        end
       end
 
       private
@@ -450,22 +477,27 @@ def write_xf(format)
       # Write the <cellStyles> element.
       #
       def write_cell_styles
-        attributes = [ ['count', 1] ]
+        count = ptrue?(@has_hyperlink) ? 2 : 1
+
+        attributes = [ ['count', count] ]
 
         @writer.tag_elements('cellStyles', attributes) do
           # Write the cellStyle element.
-          write_cell_style
+          if ptrue?(@has_hyperlink)
+            write_cell_style('Hyperlink', 1, 8)
+          end
+          write_cell_style('Normal', 0, 0)
         end
       end
 
       #
       # Write the <cellStyle> element.
       #
-      def write_cell_style
+      def write_cell_style(name, xf_id, builtin_id)
         attributes = [
-            ['name',      'Normal'],
-            ['xfId',      0],
-            ['builtinId', 0]
+            ['name',      name],
+            ['xfId',      xf_id],
+            ['builtinId', builtin_id]
         ]
 
         @writer.empty_tag('cellStyle', attributes)

data/lib/write_xlsx/package/table.rb

@@ -32,8 +32,9 @@ def initialize(worksheet, *args)
         @writer  = Package::XMLWriterSimple.new
 
         @row1, @row2, @col1, @col2, @param = handle_args(*args)
-        @columns = []
+        @columns     = []
         @col_formats = []
+        @seen_name   = {}
 
         # Set the data range rows (without the header and footer).
         @first_data_row = @row1
@@ -95,9 +96,15 @@ def overrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
               col_data.name = user_data[:header]
             end
 
+            # Excel requires unique case insensitive header names.
+            if @seen_name[col_data.name.downcase]
+              raise "add_table() contains duplicate name: '#{col_data.name}'"
+            else
+              @seen_name[col_data.name.downcase] = true
+            end
             # Get the header format if defined.
             col_data.name_format = user_data[:header_format]
-            
+
             # Handle the column formula.
             handle_the_column_formula(
               col_data, col_num, user_data[:formula], user_data[:format]
@@ -291,8 +298,8 @@ def set_the_table_name
           # Raise if the name looks like a R1C1.
           if name =~ /^[rcRC]$/ || name =~ /^[rcRC]\d+[rcRC]\d+$/
             raise "Invalid name '#{name}' like a RC cell ref in add_table()"
-          end          
-          
+          end
+
           @name = @param[:name]
         end
       end

data/lib/write_xlsx/utility.rb

@@ -320,7 +320,7 @@ def check_parameter(params, valid_keys, method)
       invalids = params.keys - valid_keys
       unless invalids.empty?
         raise WriteXLSXOptionParameterError,
-          "Unknown parameter '#{invalids.join(', ')}' in #{method}."
+              "Unknown parameter '#{invalids.join(', ')}' in #{method}."
       end
       true
     end
@@ -372,7 +372,7 @@ def layout_properties(args, is_text = false)
       # Check for valid properties.
       args.keys.each do |key|
         unless properties.include?(key.to_sym)
-            raise "Property '#{key}' not allowed in layout options\n"
+          raise "Property '#{key}' not allowed in layout options\n"
         end
       end
 
@@ -405,9 +405,9 @@ def pixels_to_points(vertices)
 
     def v_shape_attributes_base(id, z_index)
       [
-       ['id',          "_x0000_s#{id}"],
-       ['type',        type],
-       ['style',       (v_shape_style_base(z_index, vertices) + style_addition).join]
+        ['id',          "_x0000_s#{id}"],
+        ['type',        type],
+        ['style',       (v_shape_style_base(z_index, vertices) + style_addition).join]
       ]
     end
 
@@ -425,17 +425,17 @@ def v_shape_style_base(z_index, vertices)
 
     def shape_style_base(left_str, top_str, width_str, height_str, z_index_str)
       [
-       'position:absolute;',
-       'margin-left:',
-       left_str, 'pt;',
-       'margin-top:',
-       top_str, 'pt;',
-       'width:',
-       width_str, 'pt;',
-       'height:',
-       height_str, 'pt;',
-       'z-index:',
-       z_index_str, ';'
+        'position:absolute;',
+        'margin-left:',
+        left_str, 'pt;',
+        'margin-top:',
+        top_str, 'pt;',
+        'width:',
+        width_str, 'pt;',
+        'height:',
+        height_str, 'pt;',
+        'z-index:',
+        z_index_str, ';'
       ]
     end
 
@@ -500,10 +500,10 @@ def write_font(font)
       color   = '#000000'
 
       attributes = [
-                    ['face',  face],
-                    ['size',  size],
-                    ['color', color]
-                   ]
+        ['face',  face],
+        ['size',  size],
+        ['color', color]
+      ]
       @writer.data_element('font', caption, attributes)
     end
 
@@ -612,7 +612,7 @@ def pattern_properties(args) # :nodoc:
         'small_check'               => 'smCheck',
         'large_check'               => 'lgCheck',
         'outlined_diamond'          => 'openDmnd',
-        'solid_diamond'             => 'solidDmnd'        
+        'solid_diamond'             => 'solidDmnd'
       }
 
       # Check for valid types.
@@ -627,7 +627,7 @@ def pattern_properties(args) # :nodoc:
 
       pattern
     end
-    
+
     def line_fill_properties(params)
       return { :_defined => 0 } unless params
       ret = params.dup
@@ -690,22 +690,222 @@ def process_workbook_options(*params)
         [options.dup, default_format_properties.dup]
       end
     end
+
+    #
+    # Convert user defined font values into private hash values.
+    #
+    def convert_font_args(params)
+      return unless params
+      font = params_to_font(params)
+
+      # Convert font size units.
+      font[:_size] *= 100 if font[:_size] && font[:_size] != 0
+
+      # Convert rotation into 60,000ths of a degree.
+      if ptrue?(font[:_rotation])
+        font[:_rotation] = 60_000 * font[:_rotation].to_i
+      end
+
+      font
+    end
+
+    def params_to_font(params)
+      {
+        :_name         => params[:name],
+        :_color        => params[:color],
+        :_size         => params[:size],
+        :_bold         => params[:bold],
+        :_italic       => params[:italic],
+        :_underline    => params[:underline],
+        :_pitch_family => params[:pitch_family],
+        :_charset      => params[:charset],
+        :_baseline     => params[:baseline] || 0,
+        :_rotation     => params[:rotation]
+      }
+    end
+
+    #
+    # Write the <c:txPr> element.
+    #
+    def write_tx_pr(horiz, font) # :nodoc:
+      rotation = nil
+      if font && font[:_rotation]
+        rotation = font[:_rotation]
+      end
+      @writer.tag_elements('c:txPr') do
+        # Write the a:bodyPr element.
+        write_a_body_pr(rotation, horiz)
+        # Write the a:lstStyle element.
+        write_a_lst_style
+        # Write the a:p element.
+        write_a_p_formula(font)
+      end
+    end
+
+    #
+    # Write the <a:bodyPr> element.
+    #
+    def write_a_body_pr(rot, horiz = nil) # :nodoc:
+      rot = -5400000 if !rot && ptrue?(horiz)
+      attributes = []
+      attributes << ['rot',  rot]   if rot
+      attributes << ['vert', 'horz'] if ptrue?(horiz)
+
+      @writer.empty_tag('a:bodyPr', attributes)
+    end
+
+    #
+    # Write the <a:lstStyle> element.
+    #
+    def write_a_lst_style # :nodoc:
+      @writer.empty_tag('a:lstStyle')
+    end
+
+    #
+    # Write the <a:p> element for formula titles.
+    #
+    def write_a_p_formula(font = nil) # :nodoc:
+      @writer.tag_elements('a:p') do
+        # Write the a:pPr element.
+        write_a_p_pr_formula(font)
+        # Write the a:endParaRPr element.
+        write_a_end_para_rpr
+      end
+    end
+
+    #
+    # Write the <a:pPr> element for formula titles.
+    #
+    def write_a_p_pr_formula(font) # :nodoc:
+      @writer.tag_elements('a:pPr') { write_a_def_rpr(font) }
+    end
+
+    #
+    # Write the <a:defRPr> element.
+    #
+    def write_a_def_rpr(font = nil) # :nodoc:
+      write_def_rpr_r_pr_common(
+        font,
+        get_font_style_attributes(font),
+        'a:defRPr'
+      )
+    end
+
+    def write_def_rpr_r_pr_common(font, style_attributes, tag)  # :nodoc:
+      latin_attributes = get_font_latin_attributes(font)
+      has_color = ptrue?(font) && ptrue?(font[:_color])
+
+      if !latin_attributes.empty? || has_color
+        @writer.tag_elements(tag, style_attributes) do
+          if has_color
+            write_a_solid_fill(:color => font[:_color])
+          end
+          if !latin_attributes.empty?
+            write_a_latin(latin_attributes)
+          end
+        end
+      else
+        @writer.empty_tag(tag, style_attributes)
+      end
+    end
+
+    #
+    # Get the font latin attributes from a font hash.
+    #
+    def get_font_latin_attributes(font)
+      return [] unless font
+
+      attributes = []
+      attributes << ['typeface', font[:_name]]            if ptrue?(font[:_name])
+      attributes << ['pitchFamily', font[:_pitch_family]] if font[:_pitch_family]
+      attributes << ['charset', font[:_charset]]          if font[:_charset]
+
+      attributes
+    end
+
+    #
+    # Write the <a:solidFill> element.
+    #
+    def write_a_solid_fill(fill) # :nodoc:
+      @writer.tag_elements('a:solidFill') do
+        if fill[:color]
+          # Write the a:srgbClr element.
+          write_a_srgb_clr(color(fill[:color]), fill[:transparency])
+        end
+      end
+    end
+
+    #
+    # Write the <a:srgbClr> element.
+    #
+    def write_a_srgb_clr(color, transparency = nil) # :nodoc:
+      tag        = 'a:srgbClr'
+      attributes = [ ['val', color] ]
+
+      if ptrue?(transparency)
+        @writer.tag_elements(tag, attributes) do
+          write_a_alpha(transparency)
+        end
+      else
+        @writer.empty_tag(tag, attributes)
+      end
+     end
+
+    #
+    # Convert the user specified colour index or string to a rgb colour.
+    #
+    def color(color_code) # :nodoc:
+      if color_code and color_code =~ /^#[0-9a-fA-F]{6}$/
+        # Convert a HTML style #RRGGBB color.
+        color_code.sub(/^#/, '').upcase
+      else
+        index = Format.color(color_code)
+        raise "Unknown color '#{color_code}' used in chart formatting." unless index
+        palette_color(index)
+      end
+    end
+
+    #
+    # Get the font style attributes from a font hash.
+    #
+    def get_font_style_attributes(font)
+      return [] unless font
+
+      attributes = []
+      attributes << ['sz', font[:_size]]      if ptrue?(font[:_size])
+      attributes << ['b',  font[:_bold]]      if font[:_bold]
+      attributes << ['i',  font[:_italic]]    if font[:_italic]
+      attributes << ['u',  'sng']             if font[:_underline]
+
+      # Turn off baseline when testing fonts that don't have it.
+      if font[:_baseline] != -1
+        attributes << ['baseline', font[:_baseline]]
+      end
+      attributes
+    end
+
+    #
+    # Write the <a:endParaRPr> element.
+    #
+    def write_a_end_para_rpr # :nodoc:
+      @writer.empty_tag('a:endParaRPr', [ ['lang', 'en-US'] ])
+    end
   end
 
   module WriteDPtPoint
-      #
-      # Write an individual <c:dPt> element. Override the parent method to add
-      # markers.
-      #
-      def write_d_pt_point(index, point)
-        @writer.tag_elements('c:dPt') do
-          # Write the c:idx element.
-          write_idx(index)
-          @writer.tag_elements('c:marker') do
-            # Write the c:spPr element.
-            write_sp_pr(point)
-          end
+    #
+    # Write an individual <c:dPt> element. Override the parent method to add
+    # markers.
+    #
+    def write_d_pt_point(index, point)
+      @writer.tag_elements('c:dPt') do
+        # Write the c:idx element.
+        write_idx(index)
+        @writer.tag_elements('c:marker') do
+          # Write the c:spPr element.
+          write_sp_pr(point)
         end
       end
+    end
   end
 end