write_xlsx 0.65.1 → 0.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2625f80bf9b7f0ba2835f94cd5dd5699a86d1cba
-  data.tar.gz: a33f1666db5bd2bad62b7f0e97bb9422f03337fd
+  metadata.gz: 0b64b508ff280aa34008fca70ef3554cfd2aae0f
+  data.tar.gz: e9ca4ef7d80c4bf39be76c842725fd08f71d22fa
 SHA512:
-  metadata.gz: f8fb864b91fffd56d02dab919dea687a9a66dd22ed2c2b2a5240e72e830ae835781aa59a873ceb76391d1b8a4624fee72c4be9a5cbf7c4eb95773fd756b11e98
-  data.tar.gz: 2913180a8541b9c17293e2d3bc1e4bae00d8b3964726b6c2a30cb7c51b7b52963b8f64d11f7ce4318a70438d740b7932b30944813c368a89947c3ef3c66a38e9
+  metadata.gz: 2b857dd675e58f9f2bc4e064ad133d4237c87d27809852688bd2e2f58ea70fb520b239a1924b92a4856c866fbcdb73ece933808f1aa5380d6a31c3b91e3fd8ff
+  data.tar.gz: 6ea66fc1fe51560bde230f42a5d6b119b59285a321f86f7c7d9776fcd83b24f4b21afcedd8be954df17a173d113a0dd765b830e704309219a365454be34ad5b2

data/README.rdoc

@@ -75,6 +75,13 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
   workbook.close
 
 == Recent change
+2013-06-30 v0.69.0
+   Added chart font rotation property. Mainly for use with data axes to make the display more compact.
+   Fix for issue where shapes on one worksheet corrupted charts on a subsequent worksheet.
+   Fix for issue where add_button invalidated cell comments in the same workbook.
+   Fix for set_selection with cell range.
+   Fix for issue with image scaling.
+
 2013-03-23 v0.65.1
    Bug fix for non-integer image scaling.
    Bug fix in Worksheet#set_first_sheet

data/lib/write_xlsx/chart.rb

@@ -1790,12 +1790,18 @@ def convert_font_args(params)
         :_underline    => params[:underline],
         :_pitch_family => params[:pitch_family],
         :_charset      => params[:charset],
-        :_baseline     => params[:baseline] || 0
+        :_baseline     => params[:baseline] || 0,
+        :_rotation     => params[:rotation]
       }
 
       # 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
 
@@ -3427,6 +3433,18 @@ def write_a_body_pr(horiz) # :nodoc:
       @writer.empty_tag('a:bodyPr', attributes)
     end
 
+    #
+    # Write the <a:bodyPr> element for axis fonts.
+    #
+    def write_axis_body_pr(rot = nil, vert = nil)
+      attributes = []
+
+      attributes << 'rot'  << rot  if rot
+      attributes << 'vert' << vert if vert
+
+      @writer.empty_tag('a:bodyPr', attributes)
+    end
+
     #
     # Write the <a:lstStyle> element.
     #
@@ -3989,7 +4007,7 @@ def write_axis_font(font) # :nodoc:
       return unless font
 
       @writer.tag_elements('c:txPr') do
-        @writer.empty_tag('a:bodyPr')
+        write_axis_body_pr(font[:_rotation])
         write_a_lst_style
         @writer.tag_elements('a:p') do
           write_a_p_pr_rich(font)

data/lib/write_xlsx/drawing.rb

@@ -367,24 +367,21 @@ def write_atag_graphic_data(index)
 
       @writer.tag_elements('a:graphicData', attributes) do
         # Write the c:chart element.
-        write_c_chart("rId#{index}")
+        write_c_chart(index)
       end
     end
 
     #
     # Write the <c:chart> element.
     #
-    def write_c_chart(r_id)
+    def write_c_chart(id)
       schema  = 'http://schemas.openxmlformats.org/'
       xmlns_c = "#{schema}drawingml/2006/chart"
       xmlns_r = "#{schema}officeDocument/2006/relationships"
 
 
-      attributes = [
-        'xmlns:c', xmlns_c,
-        'xmlns:r', xmlns_r,
-        'r:id',    r_id
-      ]
+      attributes = ['xmlns:c', xmlns_c, 'xmlns:r', xmlns_r]
+      attributes += r_id_attributes(id)
 
       @writer.empty_tag('c:chart', attributes)
     end

data/lib/write_xlsx/package/comments.rb

@@ -263,18 +263,21 @@ def assemble_xml_file
       end
 
       def sorted_comments
-        @sorted_comments = []
-        # We sort the comments by row and column but that isn't strictly required.
-        @comments.keys.sort.each do |row|
-          @comments[row].keys.sort.each do |col|
-            # Set comment visibility if required and not already user defined.
-            @comments[row][col].visible ||= 1 if comments_visible?
-
-            # Set comment author if not already user defined.
-            @comments[row][col].author ||= @worksheet.comments_author
-            @sorted_comments << @comments[row][col]
+        unless @sorted_comments
+          @sorted_comments = []
+          # We sort the comments by row and column but that isn't strictly required.
+          @comments.keys.sort.each do |row|
+            @comments[row].keys.sort.each do |col|
+              # Set comment visibility if required and not already user defined.
+              @comments[row][col].visible ||= 1 if comments_visible?
+
+              # Set comment author if not already user defined.
+              @comments[row][col].author ||= @worksheet.comments_author
+              @sorted_comments << @comments[row][col]
+            end
           end
         end
+
         @sorted_comments
       end
 

data/lib/write_xlsx/package/conditional_format.rb

@@ -304,7 +304,7 @@ def row_col_param_for_conditional_formatting(*args)
         # Check for a cell reference in A1 notation and substitute row and column
         if args[0] =~ /^\D/
           # Check for a user defined multiple range like B3:K6,B8:K11.
-          user_range = args[0].gsub(/\s*,\s*/, ' ').gsub(/\$/, '') if args[0] =~ /,/
+          user_range = args[0].sub(/^=/, '').gsub(/\s*,\s*/, ' ').gsub(/\$/, '') if args[0] =~ /,/
         end
 
         row1, col1, row2, col2, param = row_col_notation(args)

data/lib/write_xlsx/package/table.rb

@@ -24,8 +24,6 @@ def initialize(id, param = {})
         end
       end
 
-#      attr_reader :id
-
       def initialize(worksheet, id, *args)
         @worksheet = worksheet
         @writer  = Package::XMLWriterSimple.new
@@ -204,25 +202,15 @@ def valid_table_parameter
       def handle_the_column_formula(col_data, col_num, formula, format)
         return unless formula
 
-        # Remove the leading = from formula.
-        formula.sub!(/^=/, '')
-        # Covert Excel 2010 "@" ref to 2007 "#This Row".
-        formula.gsub!(/@/,'[#This Row],')
-
-        col_data.formula = formula
+        col_data.formula = formula.sub(/^=/, '').gsub(/@/,'[#This Row],')
 
         (@first_data_row..@last_data_row).each do |row|
-          @worksheet.write_formula(row, col_num, formula, format)
+          @worksheet.write_formula(row, col_num, col_data.formula, format)
         end
       end
 
       def handle_the_function_for_the_table_row(row2, col_data, col_num, total_function, format)
-        function = total_function
-
-        # Massage the function name.
-        function = function.downcase
-        function.gsub!(/_/, '')
-        function.gsub!(/\s/,'')
+        function = total_function.downcase.gsub(/[_\s]/, '')
 
         function = 'countNums' if function == 'countnums'
         function = 'stdDev'    if function == 'stddev'
@@ -272,9 +260,7 @@ def set_the_table_options
 
       def set_the_table_style
         if @param[:style]
-          @style = @param[:style]
-          # Remove whitespace from style name.
-          @style.gsub!(/\s/, '')
+          @style = @param[:style].gsub(/\s/, '')
         else
           @style = "TableStyleMedium9"
         end

data/lib/write_xlsx/package/vml.rb

@@ -33,9 +33,9 @@ def assemble_xml_file(worksheet)
               write_button_shapetype
             end
           end
-          unless worksheet.comments_array.empty?
+          unless worksheet.sorted_comments.empty?
             write_shape_type_and_shape(
-                                       worksheet.comments_array,
+                                       worksheet.sorted_comments,
                                        vml_shape_id, z_index) do
               write_comment_shapetype
             end

data/lib/write_xlsx/sheets.rb

@@ -100,8 +100,14 @@ def write_drawing_rels_files(package_dir)
 
       #                       )
       dir = "#{package_dir}/xl/drawings/_rels"
-      self.reject { |sheet| sheet.drawing_links[0].empty? }.
-        each_with_index do |sheet, index|
+
+      index = 0
+      self.each do |sheet|
+        if !sheet.drawing_links[0].empty? || sheet.has_shapes?
+          index += 1
+        end
+
+        next if sheet.drawing_links[0].empty?
 
         FileUtils.mkdir_p(dir)
 
@@ -114,7 +120,7 @@ def write_drawing_rels_files(package_dir)
         end
 
         # Create the .rels file such as /xl/drawings/_rels/sheet1.xml.rels.
-        rels.set_xml_writer("#{dir}/drawing#{index+1}.xml.rels")
+        rels.set_xml_writer("#{dir}/drawing#{index}.xml.rels")
         rels.assemble_xml_file
       end
     end
@@ -216,7 +222,7 @@ def write_sheet(writer, sheet, sheet_id) #:nodoc:
       if sheet.hidden?
         attributes << 'state' << 'hidden'
       end
-      attributes << 'r:id' << "rId#{sheet_id}"
+      attributes += r_id_attributes(sheet_id)
       writer.empty_tag_encoded('sheet', attributes)
     end
   end

data/lib/write_xlsx/utility.rb

@@ -119,14 +119,7 @@ def check_dimensions(row, col)
     #            nil if the date is invalid.
     #
     def convert_date_time(date_time_string)       #:nodoc:
-      date_time = date_time_string
-
-      days      = 0 # Number of days since epoch
-      seconds   = 0 # Time expressed as fraction of 24h hours in seconds
-
-      # Strip leading and trailing whitespace.
-      date_time.sub!(/^\s+/, '')
-      date_time.sub!(/\s+$/, '')
+      date_time = date_time_string.sub(/^\s+/, '').sub(/\s+$/, '').sub(/Z$/, '')
 
       # Check for invalid date char.
       return nil if date_time =~ /[^0-9T:\-\.Z]/
@@ -134,8 +127,8 @@ def convert_date_time(date_time_string)       #:nodoc:
       # Check for "T" after date or before time.
       return nil unless date_time =~ /\dT|T\d/
 
-      # Strip trailing Z in ISO8601 date.
-      date_time.sub!(/Z$/, '')
+      days      = 0 # Number of days since epoch
+      seconds   = 0 # Time expressed as fraction of 24h hours in seconds
 
       # Split into date and time.
       date, time = date_time.split(/T/)
@@ -495,5 +488,9 @@ def write_stroke
 
       @writer.empty_tag('v:stroke', attributes)
     end
+
+    def r_id_attributes(id)
+      ['r:id', "rId#{id}"]
+    end
   end
 end

data/lib/write_xlsx/version.rb

@@ -1,5 +1,5 @@
 require 'write_xlsx/workbook'
 
 class WriteXLSX < Writexlsx::Workbook
-  VERSION = "0.65.1"
+  VERSION = "0.69.0"
 end

data/lib/write_xlsx/workbook.rb

@@ -41,7 +41,7 @@ class Workbook
     attr_writer :firstsheet  # :nodoc:
     attr_reader :palette  # :nodoc:
     attr_reader :worksheets, :charts, :drawings  # :nodoc:
-    attr_reader :num_comment_files, :num_vml_files, :named_ranges  # :nodoc:
+    attr_reader :named_ranges   # :nodoc:
     attr_reader :doc_properties  # :nodoc:
     attr_reader :image_types, :images  # :nodoc:
     attr_reader :shared_strings  # :nodoc:
@@ -111,8 +111,6 @@ def initialize(file, default_formats = {})
       @custom_colors       = []
       @doc_properties      = {}
       @local_time          = Time.now
-      @num_vml_files       = 0
-      @num_comment_files   = 0
       @optimization        = 0
       @x_window            = 240
       @y_window            = 15
@@ -247,31 +245,29 @@ def assemble_xml_file  #:nodoc:
       write_xml_declaration
 
       # Write the root workbook element.
-      write_workbook
+      write_workbook do
 
-      # Write the XLSX file version.
-      write_file_version
+        # Write the XLSX file version.
+        write_file_version
 
-      # Write the workbook properties.
-      write_workbook_pr
+        # Write the workbook properties.
+        write_workbook_pr
 
-      # Write the workbook view properties.
-      write_book_views
+        # Write the workbook view properties.
+        write_book_views
 
-      # Write the worksheet names and ids.
-      @worksheets.write_sheets(@writer)
+        # Write the worksheet names and ids.
+        @worksheets.write_sheets(@writer)
 
-      # Write the workbook defined names.
-      write_defined_names
+        # Write the workbook defined names.
+        write_defined_names
 
-      # Write the workbook calculation properties.
-      write_calc_pr
+        # Write the workbook calculation properties.
+        write_calc_pr
 
-      # Write the workbook extension storage.
-      #write_ext_lst
-
-      # Close the workbook tag.
-      write_workbook_end
+        # Write the workbook extension storage.
+        #write_ext_lst
+      end
 
       # Close the XML writer object and filehandle.
       @writer.crlf
@@ -655,7 +651,7 @@ def add_format(properties = {})
     # This is not very useful for inserting multiple shapes,
     # since the x/y coordinates also gets modified.
     #
-    def add_shape(properties)
+    def add_shape(properties = {})
       shape = Shape.new(properties)
       shape.palette = @palette
 
@@ -693,10 +689,6 @@ def add_shape(properties)
     def define_name(name, formula)
       sheet_index = nil
       sheetname   = ''
-      full_name   = name
-
-      # Remove the = sign from the formula if it exists.
-      formula.sub!(/^=/, '')
 
       # Local defined names are formatted like "Sheet1!name".
       if name =~ /^(.*)!(.*)$/
@@ -722,7 +714,7 @@ def define_name(name, formula)
         raise "Invalid name '#{name}' looks like a cell name in defined_name()\n"
       end
 
-      @defined_names.push([ name, sheet_index, formula])
+      @defined_names.push([ name, sheet_index, formula.sub(/^=/, '') ])
     end
 
     #
@@ -949,6 +941,14 @@ def style_properties
       ]
     end
 
+    def num_vml_files
+      @worksheets.select { |sheet| sheet.has_vml? }.count
+    end
+
+    def num_comment_files
+      @worksheets.select { |sheet| sheet.has_comments? }.count
+    end
+
     private
 
     def setup_filename(file) #:nodoc:
@@ -1085,11 +1085,9 @@ def write_workbook #:nodoc:
         'xmlns:r',
         schema + '/officeDocument/2006/relationships'
       ]
-      @writer.start_tag('workbook', attributes)
-    end
-
-    def write_workbook_end #:nodoc:
-      @writer.end_tag('workbook')
+      @writer.tag_elements('workbook', attributes) do
+        yield
+      end
     end
 
     def write_file_version #:nodoc:
@@ -1144,18 +1142,15 @@ def write_calc_pr #:nodoc:
     end
 
     def write_ext_lst #:nodoc:
-      tag = 'extLst'
-      @writer.tag_elements(tag) { write_ext }
+      @writer.tag_elements('extLst') { write_ext }
     end
 
     def write_ext #:nodoc:
-      tag = 'ext'
-      uri = "#{OFFICE_URL}mac/excel/2008/main"
       attributes = [
-        'xmlns:mx', uri,
+        'xmlns:mx', "#{OFFICE_URL}mac/excel/2008/main",
         'uri', uri
       ]
-      @writer.tag_elements(tag, attributes) { write_mx_arch_id }
+      @writer.tag_elements('ext', attributes) { write_mx_arch_id }
     end
 
     def write_mx_arch_id #:nodoc:
@@ -1164,14 +1159,13 @@ def write_mx_arch_id #:nodoc:
 
     def write_defined_names #:nodoc:
       return if @defined_names.nil? || @defined_names.empty?
-      tag = 'definedNames'
-      @writer.tag_elements(tag) do
+      @writer.tag_elements('definedNames') do
         @defined_names.each { |defined_name| write_defined_name(defined_name) }
       end
     end
 
-    def write_defined_name(data) #:nodoc:
-      name, id, range, hidden = data
+    def write_defined_name(defined_name) #:nodoc:
+      name, id, range, hidden = defined_name
 
       attributes = ['name', name]
       attributes << 'localSheetId' << "#{id}" unless id == -1
@@ -1424,30 +1418,28 @@ def ne_0?(val)
     # the named ranges for App.xml.
     #
     def prepare_defined_names #:nodoc:
-      defined_names =  @defined_names
-
       @worksheets.each do |sheet|
         # Check for Print Area settings.
         if sheet.autofilter_area
-          range  = sheet.autofilter_area
-          hidden = 1
-
-          # Store the defined names.
-          defined_names << ['_xlnm._FilterDatabase', sheet.index, range, hidden]
+          @defined_names << [
+                             '_xlnm._FilterDatabase',
+                             sheet.index,
+                             sheet.autofilter_area,
+                             1
+                            ]
         end
 
         # Check for Print Area settings.
         if !sheet.print_area.empty?
-          range = sheet.print_area
-
-          # Store the defined names.
-          defined_names << ['_xlnm.Print_Area', sheet.index, range]
+          @defined_names << [
+                             '_xlnm.Print_Area',
+                             sheet.index,
+                             sheet.print_area
+                            ]
         end
 
         # Check for repeat rows/cols. aka, Print Titles.
         if !sheet.print_repeat_cols.empty? || !sheet.print_repeat_rows.empty?
-          range = ''
-
           if !sheet.print_repeat_cols.empty? && !sheet.print_repeat_rows.empty?
             range = sheet.print_repeat_cols + ',' + sheet.print_repeat_rows
           else
@@ -1455,55 +1447,49 @@ def prepare_defined_names #:nodoc:
           end
 
           # Store the defined names.
-          defined_names << ['_xlnm.Print_Titles', sheet.index, range]
+          @defined_names << ['_xlnm.Print_Titles', sheet.index, range]
         end
       end
 
-      defined_names  = sort_defined_names(defined_names)
-      @defined_names = defined_names
-      @named_ranges  = extract_named_ranges(defined_names)
+      @defined_names  = sort_defined_names(@defined_names)
+      @named_ranges  = extract_named_ranges(@defined_names)
     end
 
     #
     # Iterate through the worksheets and set up the VML objects.
     #
     def prepare_vml_objects  #:nodoc:
-      comment_id    = 0
-      vml_data_id   = 1
-      vml_shape_id  = 1024
-      vml_files     = 0
-      comment_files = 0
+      comment_id     = 0
+      vml_drawing_id = 0
+      vml_data_id    = 1
+      vml_shape_id   = 1024
 
-      @worksheets.each do |sheet|
-        next unless sheet.has_vml?
-        vml_files += 1
-        comment_files += 1 if sheet.has_comments?
+      @worksheets.select { |sheet| sheet.has_vml? }.each do |sheet|
+        comment_id += 1 if sheet.has_comments?
+        vml_drawing_id += 1
 
-        comment_id += 1
-        count = sheet.prepare_vml_objects(vml_data_id, vml_shape_id, comment_id)
+        sheet.prepare_vml_objects(vml_data_id, vml_shape_id,
+                                  vml_drawing_id, comment_id)
 
         # Each VML file should start with a shape id incremented by 1024.
-        vml_data_id  +=    1 * ( ( 1024 + sheet.comments_count ) / 1024.0 ).to_i
-        vml_shape_id += 1024 * ( ( 1024 + sheet.comments_count ) / 1024.0 ).to_i
+        vml_data_id  +=    1 * ( 1 + sheet.num_comments_block )
+        vml_shape_id += 1024 * ( 1 + sheet.num_comments_block )
       end
 
-      @num_vml_files     = vml_files
-      @num_comment_files = comment_files
-
-      # Add a font format for cell comments.
-      if comment_files > 0
-        format = Format.new(
-            @formats,
-            :font          => 'Tahoma',
-            :size          => 8,
-            :color_indexed => 81,
-            :font_only     => 1
-        )
+      add_font_format_for_cell_comments if num_comment_files > 0
+    end
 
-        format.get_xf_index
+    def add_font_format_for_cell_comments
+      format = Format.new(
+                          @formats,
+                          :font          => 'Tahoma',
+                          :size          => 8,
+                          :color_indexed => 81,
+                          :font_only     => 1
+                          )
 
-        @formats.formats << format
-      end
+      format.get_xf_index
+      @formats.formats << format
     end
 
     #
@@ -1569,7 +1555,6 @@ def chart_data(worksheet, cells)
         end
       end
     end
-    private :chart_data
 
     #
     # Sort internal and user defined names in the same order as used by Excel.