write_xlsx 0.0.4 → 0.51.0

data/lib/write_xlsx/format.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+require 'write_xlsx/utility'
+
 module Writexlsx
   # ==CELL FORMATTING
   #
@@ -158,6 +160,8 @@ module Writexlsx
   #     format1.set_bold( 0 )    # Turns bold off
   #
   class Format
+    include Writexlsx::Utility
+
     attr_reader :xf_index, :dxf_index, :num_format   # :nodoc:
     attr_reader :underline, :font_script, :size, :theme, :font, :font_family, :hyperlink   # :nodoc:
     attr_reader :diag_type, :diag_color, :font_only, :color, :color_indexed   # :nodoc:
@@ -167,6 +171,9 @@ class Format
     attr_accessor :fill_index, :font_condense, :font_extend, :diag_border   # :nodoc:
     attr_accessor :bg_color, :fg_color, :pattern   # :nodoc:
 
+    attr_accessor :dxf_bg_color, :dxf_fg_color   # :nodoc:
+    attr_reader :rotation, :bold, :italic, :font_strikeout
+
     def initialize(xf_format_indices = {}, dxf_format_indices = {}, params = {})   # :nodoc:
       @xf_format_indices = xf_format_indices
       @dxf_format_indices = dxf_format_indices
@@ -236,6 +243,22 @@ def initialize(xf_format_indices = {}, dxf_format_indices = {}, params = {})   #
       set_format_properties(params) unless params.empty?
     end
 
+    #
+    # Copy the attributes of another Format object.
+    #
+    def copy(other)
+      reserve = [
+                 :xf_index,
+                 :dxf_index,
+                 :xf_format_indices,
+                 :xdf_format_indices,
+                 :palette
+                ]
+      (instance_variables - reserve).each do |v|
+        instance_variable_set(v, other.instance_variable_get(v))
+      end
+    end
+
     #
     # :call-seq:
     #    set_format_properties( :bold => 1 [, :color => 'red'..] )
@@ -339,14 +362,14 @@ def get_align_properties
     def get_protection_properties
       attributes = []
 
-      attributes << 'locked' << 0 if     @locked == 0
-      attributes << 'hidden' << 1 unless @hidden == 0
+      attributes << 'locked' << 0 unless ptrue?(@locked)
+      attributes << 'hidden' << 1 if     ptrue?(@hidden)
 
       attributes.empty? ? nil : attributes
     end
 
     def set_bold(bold = 1)
-      @bold = (bold && bold != 0) ? 1 : 0
+      @bold = ptrue?(bold) ? 1 : 0
     end
 
     def inspect
@@ -600,6 +623,36 @@ def set_hyperlink
       set_align('top')
     end
 
+    def set_font_info(fonts)
+      key = get_font_key
+
+      if fonts[key]
+        # Font has already been used.
+        @font_index = fonts[key]
+        @has_font   = false
+      else
+        # This is a new font.
+        @font_index = fonts.size
+        fonts[key]  = fonts.size
+        @has_font   = true
+      end
+    end
+
+    def set_border_info(borders)
+      key = get_border_key
+
+      if borders[key]
+        # Border has already been used.
+        @border_index = borders[key]
+        @has_border   = false
+      else
+        # This is a new border.
+        @border_index = borders.size
+        borders[key]  = borders.size
+        @has_border   = true
+      end
+    end
+
     def method_missing(name, *args)  # :nodoc:
       method = "#{name}"
 
@@ -616,42 +669,36 @@ def method_missing(name, *args)  # :nodoc:
       else                            # for "set_xxx" methods
         value = args[0].nil? ? 1 : args[0]
       end
-      if value.respond_to?(:to_str) || !value.respond_to?(:+)
-        s = %Q!#{attribute} = "#{value.to_s}"!
-      else
-        s = %Q!#{attribute} =   #{value.to_s}!
-      end
-      eval s
+
+      instance_variable_set(attribute, value)
+    end
+
+    def color?
+      ptrue?(@color)
     end
 
     def bold?
-      bool_both_ruby_and_perl?(@bold)
+      ptrue?(@bold)
     end
 
     def italic?
-      bool_both_ruby_and_perl?(@italic)
+      ptrue?(@italic)
     end
 
     def strikeout?
-      bool_both_ruby_and_perl?(@font_strikeout)
+      ptrue?(@font_strikeout)
     end
 
     def outline?
-      bool_both_ruby_and_perl?(@font_outline)
+      ptrue?(@font_outline)
     end
 
     def shadow?
-      bool_both_ruby_and_perl?(@font_shadow)
+      ptrue?(@font_shadow)
     end
 
     def underline?
-      bool_both_ruby_and_perl?(@underline)
-    end
-
-    def bool_both_ruby_and_perl?(val)
-      return false unless val
-      return false if val == 0
-      true
+      ptrue?(@underline)
     end
 
     def has_border(flag)
@@ -701,5 +748,9 @@ def has_dxf_fill(flag)
     def has_dxf_fill?
       @has_dxf_fill
     end
+
+    def [](attr)
+      self.instance_variable_get("@#{attr}")
+    end
   end
 end

data/lib/write_xlsx/package/app.rb

@@ -67,12 +67,9 @@ def write_xml_declaration
       #
       def write_properties
         schema   = 'http://schemas.openxmlformats.org/officeDocument/2006/'
-        xmlns    = "#{schema}extended-properties"
-        xmlns_vt = "#{schema}docPropsVTypes"
-
         attributes = [
-            'xmlns',     xmlns,
-            'xmlns:vt',  xmlns_vt
+            'xmlns',     "#{schema}extended-properties",
+            'xmlns:vt',  "#{schema}docPropsVTypes"
         ]
 
         @writer.start_tag('Properties', attributes)

data/lib/write_xlsx/package/comments.rb

@@ -130,6 +130,10 @@ def initialize(worksheet)
         @comments = {}
       end
 
+      def [](row)
+        @comments[row]
+      end
+
       def add(comment)
         if @comments[comment.row]
           @comments[comment.row][comment.col] = comment
@@ -173,7 +177,7 @@ def sorted_comments
             @comments[row][col].visible ||= 1 if comments_visible?
 
             # Set comment author if not already user defined.
-            @comments[row][col].author ||= @comments_author
+            @comments[row][col].author ||= @worksheet.comments_author
             @sorted_comments << @comments[row][col]
           end
         end

data/lib/write_xlsx/package/content_types.rb

@@ -127,6 +127,16 @@ def add_image_types(types)
         types.each_key { |type| add_default(type, "image/#{type}") }
       end
 
+      #
+      # Add the name of a table to the ContentTypes overrides.
+      #
+      def add_table_name(table_name)
+        add_override(
+                     "/xl/tables/#{table_name}.xml",
+                     "#{App_document}spreadsheetml.table+xml"
+                     )
+      end
+
       private
 
       def write_xml_declaration

data/lib/write_xlsx/package/packager.rb

@@ -8,6 +8,7 @@
 require 'write_xlsx/package/relationships'
 require 'write_xlsx/package/shared_strings'
 require 'write_xlsx/package/styles'
+require 'write_xlsx/package/table'
 require 'write_xlsx/package/theme'
 require 'write_xlsx/package/vml'
 
@@ -25,6 +26,7 @@ def initialize
         @chartsheet_count = 0
         @chart_count      = 0
         @drawing_count    = 0
+        @table_count      = 0
         @named_ranges     = []
       end
 
@@ -63,6 +65,7 @@ def create_package
         write_drawing_files
         write_vml_files
         write_comment_files
+        write_table_files
         write_shared_strings_file
         write_app_file
         write_core_file
@@ -215,7 +218,7 @@ def write_app_file
         # Add the Chartsheet parts.
         @workbook.worksheets.each do |worksheet|
           next unless worksheet.is_chartsheet?
-          app.add_part_name(worksheet.get_name)
+          app.add_part_name(worksheet.name)
         end
 
         # Add the Named Range heading pairs.
@@ -271,6 +274,8 @@ def write_content_types_file
 
         content.add_vml_name if @num_comment_files > 0
 
+        (1 .. @table_count).each { |i| content.add_table_name("table#{i}") }
+
         (1 .. @num_comment_files).each { |i| content.add_comment_name("comments#{i}") }
 
         # Add the sharedString rel if there is string data in the workbook.
@@ -325,6 +330,32 @@ def write_theme_file
         rels.assemble_xml_file
       end
 
+      #
+      # Write the table files.
+      #
+      def write_table_files
+        dir = @package_dir
+
+        index = 1
+        @workbook.worksheets.each do |worksheet|
+          table_props = worksheet.tables
+
+          next if table_props.empty?
+
+          FileUtils.mkdir_p("#{dir}/xl/tables")
+
+          table_props.each do |table_prop|
+            table = Package::Table.new
+
+            table.set_xml_writer("#{dir}/xl/tables/table#{index}.xml")
+            table.set_properties(table_prop)
+            table.assemble_xml_file
+            index += 1
+            @table_count += 1
+          end
+        end
+      end
+
       #
       # Write the _rels/.rels xml file.
       #
@@ -387,6 +418,8 @@ def write_worksheet_rels_files
           external_links = [
             worksheet.external_hyper_links,
             worksheet.external_drawing_links,
+            worksheet.external_vml_links,
+            worksheet.external_table_links,
             worksheet.external_comment_links
           ].select {|a| a != []}
 
@@ -420,16 +453,17 @@ def write_worksheet_rels_files
       #
       def write_chartsheet_rels_files
         existing_rels_dir = false
-
+        index = 0
         @workbook.worksheets.each do |worksheet|
           next unless worksheet.is_chartsheet?
+          index += 1
 
           external_links = worksheet.external_drawing_links
 
           next if external_links.empty?
 
           # Create the chartsheet .rels dir if required.
-          if existing_rels_dir
+          if !existing_rels_dir
             FileUtils.mkdir_p("#{@package_dir}/xl/chartsheets/_rels")
             existing_rels_dir = true
           end
@@ -437,12 +471,12 @@ def write_chartsheet_rels_files
           rels = Package::Relationships.new
 
           external_links.each do |link_data|
-            rels.add_worksheet_relationship(link_data)
+            rels.add_worksheet_relationship(*link_data)
           end
 
           # Create the .rels file such as /xl/chartsheets/_rels/sheet1.xml.rels.
           rels.set_xml_writer(
-              "#{@package_dir}/xl/chartsheets/_rels/sheet#{worksheet.index}.xml.rels")
+              "#{@package_dir}/xl/chartsheets/_rels/sheet#{index}.xml.rels")
           rels.assemble_xml_file
         end
       end
@@ -467,7 +501,7 @@ def write_drawing_rels_files
 
           # Create the .rels file such as /xl/drawings/_rels/sheet1.xml.rels.
           rels.set_xml_writer(
-            "#{@package_dir}/xl/drawings/_rels/drawing#{index}.xml.rels")
+                              "#{@package_dir}/xl/drawings/_rels/drawing#{index}.xml.rels")
           rels.assemble_xml_file
         end
       end
@@ -487,7 +521,7 @@ def add_image_files
           filename  = image[0]
           extension = ".#{image[1]}"
 
-          copy( filename, "#{@package_dir}/xl/media/image#{index}#{extension}")
+          FileUtils.cp(filename, "#{@package_dir}/xl/media/image#{index}#{extension}")
           index += 1
         end
       end

data/lib/write_xlsx/package/relationships.rb

@@ -52,7 +52,7 @@ def add_package_relationship(type, target)
       #
       # Add worksheet relationship to sheet.rels xml files.
       #
-      def add_worksheet_relationship(type, target, target_mode)
+      def add_worksheet_relationship(type, target, target_mode = nil)
         type   = Document_schema + type
         target = target
 

data/lib/write_xlsx/package/shared_strings.rb

@@ -89,17 +89,45 @@ def write_sst_strings
       # Write the <si> element.
       #
       def write_si(string)
+        string = string.dup
         attributes = []
 
-        attributes << 'xml:space' << 'preserve' if string =~ /^[ \t]/ || string =~ /[ \t]$/
+        # Excel escapes control characters with _xHHHH_ and also escapes any
+        # literal strings of that type by encoding the leading underscore. So
+        # "\0" -> _x0000_ and "_x0000_" -> _x005F_x0000_.
+        # The following substitutions deal with those cases.
 
-        @writer.tag_elements('si') do
-          # Write any rich strings without further tags.
-          if string =~ %r{^<r>} && string =~ %r{</r>$}
-            @writer.io_write(string)
-          else
-            @writer.data_element('t', string, attributes)
-          end
+        # Escape the escape.
+        string = string.gsub(/(_x[0-9a-fA-F]{4}_)/, '_x005F\1')
+
+        # Convert control character to the _xHHHH_ escape.
+        string = string.gsub(
+                             /([\x00-\x08\x0B-\x1F])/,
+                             sprintf("_x%04X_", $1.ord)
+                             ) if string =~ /([\x00-\x08\x0B-\x1F])/
+
+        # Convert character to \xC2\xxx or \xC3\xxx
+        unless string.empty?
+          string = add_c2_c3(string) if 0x80 <= string.ord && string.ord <= 0xFF
+        end
+
+        # Add attribute to preserve leading or trailing whitespace.
+        attributes << 'xml:space' << 'preserve' if string =~ /\A\s|\s\Z/
+
+        # Write any rich strings without further tags.
+        if string =~ %r{^<r>} && string =~ %r{</r>$}
+          @writer.si_rich_element(string)
+        else
+          @writer.si_element(string, attributes)
+        end
+      end
+
+      def add_c2_c3(string)
+        num = string.ord
+        if 0x80 <= num && num < 0xC0
+          0xC2.chr + num.chr
+        else
+          0xC3.chr + (num - 0x40).chr
         end
       end
 

data/lib/write_xlsx/package/styles.rb

@@ -279,6 +279,13 @@ def write_fill(format, dxf_format = nil)
         bg_color   = format.bg_color
         fg_color   = format.fg_color
 
+        # Colors for dxf formats are handled differently from normal formats since
+        # the normal format reverses the meaning of BG and FG for solid fills.
+        if dxf_format && dxf_format != 0
+          bg_color = format.dxf_bg_color
+          fg_color = format.dxf_fg_color
+        end
+
         patterns = %w(
           none
           solid
@@ -308,14 +315,14 @@ def write_fill(format, dxf_format = nil)
           else
             attributes = ['patternType', patterns[format.pattern]]
           end
-          
+
           @writer.tag_elements('patternFill', attributes) do
-            unless fg_color == 0
+            if fg_color && fg_color != 0
               fg_color = get_palette_color(fg_color)
               @writer.empty_tag('fgColor', ['rgb', fg_color])
             end
 
-            if bg_color != 0
+            if bg_color && bg_color != 0
               bg_color = get_palette_color(bg_color)
               @writer.empty_tag('bgColor', ['rgb', bg_color])
             else
@@ -426,9 +433,7 @@ def write_sub_border(type, style = 0, color = nil)
       # Write the <cellStyleXfs> element.
       #
       def write_cell_style_xfs
-        count = 1
-
-        attributes = ['count', count]
+        attributes = ['count', 1]
 
         @writer.tag_elements('cellStyleXfs', attributes) do
           # Write the style_xf element.
@@ -535,9 +540,7 @@ def write_xf(format)
       # Write the <cellStyles> element.
       #
       def write_cell_styles
-        count = 1
-
-        attributes = ['count', count]
+        attributes = ['count', 1]
 
         @writer.tag_elements('cellStyles', attributes) do
           # Write the cellStyle element.