write_xlsx 0.89.0 → 1.01.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/core.rb

@@ -14,7 +14,7 @@ class Core
       def initialize
         @writer = Package::XMLWriterSimple.new
         @properties = {}
-        @localtime  = [Time.now]
+        @createtime  = [Time.now.gmtime]
       end
 
       def set_xml_writer(filename)
@@ -47,12 +47,14 @@ def write_cp_core_properties_base
       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
 
       #
@@ -109,7 +111,7 @@ def write_dcterms(tag)
       end
 
       def dcterms_date
-        localtime_to_iso8601_date(@properties[:created])
+        datetime_to_iso8601_date(@properties[:created])
       end
 
       #

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]
@@ -233,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,
@@ -291,8 +303,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/shape.rb

@@ -8,14 +8,14 @@ module Writexlsx
   # Used in conjunction with WriteXLSX.
   #
   # Copyright 2000-2012, John McNamara, jmcnamara@cpan.org
-  # Converted to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+  # Converted to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
   #
   class Shape
     include Writexlsx::Utility
 
     attr_reader :edit_as, :type, :drawing
     attr_reader :tx_box, :fill, :line, :format
-    attr_reader :align, :valign
+    attr_reader :align, :valign, :anchor
     attr_accessor :name, :connect, :type, :id, :start, :end, :rotation
     attr_accessor :flip_h, :flip_v, :adjustments, :palette, :text, :stencil
     attr_accessor :row_start, :row_end, :column_start, :column_end
@@ -183,11 +183,12 @@ def calc_position_emus(worksheet)
       @y_abs = (y_abslt * 9_525).to_i
     end
 
-    def set_position(row_start, column_start, x_offset, y_offset, x_scale, y_scale)
+    def set_position(row_start, column_start, x_offset, y_offset, x_scale, y_scale, anchor)
       @row_start    = row_start
       @column_start = column_start
       @x_offset     = x_offset || 0
       @y_offset     = y_offset || 0
+      @anchor       = anchor   || 1
 
       # Override shape scale if supplied as an argument. Otherwise, use the
       # existing shape scale factors.