caxlsx 2.0.2 → 3.0.0

data/lib/axlsx/workbook/worksheet/dimension.rb

@@ -43,13 +43,13 @@ module Axlsx
     # The first cell in the dimension
     # @return [String]
     def first_cell_reference
-      dimension_reference(worksheet.rows.first.cells.first, Dimension.default_first)
+      dimension_reference(worksheet.rows.first.first, Dimension.default_first)
     end
 
     # the last cell in the dimension
     # @return [String]
     def last_cell_reference
-      dimension_reference(worksheet.rows.last.cells.last, Dimension.default_last)
+      dimension_reference(worksheet.rows.last.last, Dimension.default_last)
     end
 
     private

data/lib/axlsx/workbook/worksheet/header_footer.rb

@@ -19,8 +19,8 @@ module Axlsx
     # @option options [String] odd_footer The content for footers on odd numbered pages.
     # @option options [String] even_header The content for headers on even numbered pages.
     # @option options [String] even_footer The content for footers on even numbered pages.
-    # @option options [String] first_header The content for headers on even numbered pages.
-    # @option options [String] first_footer The content for footers on even numbered pages.
+    # @option options [String] first_header The content for headers on the first page.
+    # @option options [String] first_footer The content for footers on the first page.
     # @option options [Boolean] different_odd_even Setting this to true will show different headers/footers on odd and even pages. When false, the odd headers/footers are used on each page. (Default: false)
     # @option options [Boolean] different_first If true, will use the first header/footer on page 1. Otherwise, the odd header/footer is used.
     def initialize(options = {})
@@ -42,13 +42,11 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << "<headerFooter "
-      serialized_attributes str
-      str << ">"
-      serialized_element_attributes(str) do |value|
-        value = ::CGI.escapeHTML(value)
+      serialized_tag('headerFooter', str) do
+        serialized_element_attributes(str) do |value|
+          value = ::CGI.escapeHTML(value)
+        end
       end
-      str << "</headerFooter>"
     end
   end
 end

data/lib/axlsx/workbook/worksheet/icon_set.rb

@@ -63,11 +63,9 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str="")
-      str << '<iconSet '
-      serialized_attributes str
-      str << '>'
-      @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
-      str << '</iconSet>'
+      serialized_tag('iconSet', str) do
+        @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
+      end
     end
 
     private

data/lib/axlsx/workbook/worksheet/merged_cells.rb

@@ -15,10 +15,12 @@ module Axlsx
     # collection. This can be an array of actual cells or a string style
     # range like 'A1:C1'
     def add(cells)
-      @list << if cells.is_a?(String)
+      self << if cells.is_a?(String)
                  cells
                elsif cells.is_a?(Array)
                  Axlsx::cell_range(cells, false)
+               elsif cells.is_a?(Row)
+                 Axlsx::cell_range(cells, false)
                end
     end
 
@@ -26,7 +28,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      return if @list.empty?
+      return if empty?
       str << "<mergeCells count='#{size}'>"
       each { |merged_cell| str << "<mergeCell ref='#{merged_cell}'></mergeCell>" }
       str << '</mergeCells>'

data/lib/axlsx/workbook/worksheet/outline_pr.rb

@@ -0,0 +1,33 @@
+module Axlsx
+
+  # The OutlinePr class manages serialization of a worksheet's outlinePr element, which provides various
+  # options to control outlining.
+  class OutlinePr
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+    include Axlsx::SerializedAttributes
+
+    serializable_attributes :summary_below,
+                            :summary_right,
+                            :apply_styles
+
+    # These attributes are all boolean so I'm doing a bit of a hand
+    # waving magic show to set up the attriubte accessors
+    boolean_attr_accessor :summary_below,
+                          :summary_right,
+                          :apply_styles
+
+    # Creates a new OutlinePr object
+    # @param [Hash] options used to create the outline_pr
+    def initialize(options = {})
+      parse_options options
+    end
+
+    # Serialize the object
+    # @param [String] str serialized output will be appended to this object if provided.
+    # @return [String]
+    def to_xml_string(str = '')
+      str << "<outlinePr #{serialized_attributes} />"
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/page_margins.rb

@@ -91,9 +91,7 @@ module Axlsx
     # @note For compatibility, this is a noop unless custom margins have been specified.
     # @see #custom_margins_specified?
     def to_xml_string(str = '')
-      str << '<pageMargins '
-      serialized_attributes str
-      str << '/>'
+      serialized_tag('pageMargins', str)
     end
   end
 end

data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb

@@ -38,7 +38,7 @@ module Axlsx
 
     # serialize to xml
     def to_xml_string(str='')
-      str << '<pageSetUpPr ' << serialized_attributes << '/>'
+      str << ('<pageSetUpPr ' << serialized_attributes << '/>')
     end
   end
 end

data/lib/axlsx/workbook/worksheet/page_setup.rb

@@ -44,13 +44,13 @@ module Axlsx
 
     # Number of horizontal pages to fit on.
     # @note PageSetup#fit_to is the recomended way to manage page fitting as only specifying one of width/height will result in the counterpart
-    # being set to 1. 
+    # being set to 1.
     # @return [Integer]
     attr_reader :fit_to_width
 
     # Orientation of the page (:default, :landscape, :portrait)
     # @return [Symbol]
-    attr_reader :orientation 
+    attr_reader :orientation
 
     # Height of paper (string containing a number followed by a unit identifier: "297mm", "11in")
     # @return [String]
@@ -74,18 +74,18 @@ module Axlsx
     #7 = Executive paper (7.25 in. by 10.5 in.)
     #8 = A3 paper (297 mm by 420 mm)
     #9 = A4 paper (210 mm by 297 mm)
-    #10 = A4 small paper (210 mm by 297 mm) 
+    #10 = A4 small paper (210 mm by 297 mm)
     #11 = A5 paper (148 mm by 210 mm)
     #12 = B4 paper (250 mm by 353 mm)
     #13 = B5 paper (176 mm by 250 mm)
     #14 = Folio paper (8.5 in. by 13 in.)
-    #15 = Quarto paper (215 mm by 275 mm) 
+    #15 = Quarto paper (215 mm by 275 mm)
     #16 = Standard paper (10 in. by 14 in.)
     #17 = Standard paper (11 in. by 17 in.)
     #18 = Note paper (8.5 in. by 11 in.)
-    #19 = #9 envelope (3.875 in. by 8.875 in.) 
-    #20 = #10 envelope (4.125 in. by 9.5 in.) 
-    #21 = #11 envelope (4.5 in. by 10.375 in.) 
+    #19 = #9 envelope (3.875 in. by 8.875 in.)
+    #20 = #10 envelope (4.125 in. by 9.5 in.)
+    #21 = #11 envelope (4.5 in. by 10.375 in.)
     #22 = #12 envelope (4.75 in. by 11 in.)
     #23 = #14 envelope (5 in. by 11.5 in.) 24 = C paper (17 in. by 22 in.)
     #25 = D paper (22 in. by 34 in.)
@@ -105,7 +105,7 @@ module Axlsx
     #40 = German standard fanfold (8.5 in. by 12 in.)
     #41 = German legal fanfold (8.5 in. by 13 in.)
     #42 = ISO B4 (250 mm by 353 mm)
-    #43 = Japanese double postcard (200 mm by 148 mm) 
+    #43 = Japanese double postcard (200 mm by 148 mm)
     #44 = Standard paper (9 in. by 11 in.)
     #45 = Standard paper (10 in. by 11 in.)
     #46 = Standard paper (15 in. by 11 in.)
@@ -116,9 +116,9 @@ module Axlsx
     #53 = A4 extra paper (236 mm by 322 mm)
     #54 = Letter transverse paper (8.275 in. by 11 in.)
     #55 = A4 transverse paper (210 mm by 297 mm)
-    #56 = Letter extra transverse paper (9.275 in. by 12 in.) 
-    #57 = SuperA/SuperA/A4 paper (227 mm by 356 mm) 
-    #58 = SuperB/SuperB/A3 paper (305 mm by 487 mm) 
+    #56 = Letter extra transverse paper (9.275 in. by 12 in.)
+    #57 = SuperA/SuperA/A4 paper (227 mm by 356 mm)
+    #58 = SuperB/SuperB/A3 paper (305 mm by 487 mm)
     #59 = Letter plus paper (8.5 in. by 12.69 in.)
     #60 = A4 plus paper (210 mm by 330 mm)
     #61 = A5 transverse paper (148 mm by 210 mm)
@@ -128,8 +128,8 @@ module Axlsx
     #65 = ISO B5 extra paper (201 mm by 276 mm)
     #66 = A2 paper (420 mm by 594 mm)
     #67 = A3 transverse paper (297 mm by 420 mm)
-    #68 = A3 extra transverse paper (322 mm by 445 mm) 
-    #69 = Japanese Double Postcard (200 mm x 148 mm) 
+    #68 = A3 extra transverse paper (322 mm by 445 mm)
+    #69 = Japanese Double Postcard (200 mm x 148 mm)
     #70 = A6 (105 mm x 148 mm
     #71 = Japanese Envelope Kaku #2
     #72 = Japanese Envelope Kaku #3
@@ -142,7 +142,7 @@ module Axlsx
     #79 = B4 (JIS) Rotated (364 mm x 257 mm)
     #80 = B5 (JIS) Rotated (257 mm x 182 mm)
     #81 = Japanese Postcard Rotated (148 mm x 100 mm)
-    #82 = Double Japanese Postcard Rotated (148 mm x 200 mm) 
+    #82 = Double Japanese Postcard Rotated (148 mm x 200 mm)
     #83 = A6 Rotated (148 mm x 105 mm)
     #84 = Japanese Envelope Kaku #2 Rotated
     #85 = Japanese Envelope Kaku #3 Rotated
@@ -210,20 +210,20 @@ module Axlsx
     # @see scale
     def scale=(v); Axlsx::validate_scale_10_400(v); @scale = v; end
 
-    # convenience method to achieve sanity when setting fit_to_width and fit_to_height 
+    # convenience method to achieve sanity when setting fit_to_width and fit_to_height
     # as they both default to 1 if only their counterpart is specified.
     # @note This method will overwrite any value you explicitly set via the fit_to_height or fit_to_width methods.
-    # @option options [Integer] width The number of pages to fit this worksheet on horizontally. Default 9999
-    # @option options [Integer] height The number of pages to fit this worksheet on vertically. Default 9999
+    # @option options [Integer] width The number of pages to fit this worksheet on horizontally. Default 999
+    # @option options [Integer] height The number of pages to fit this worksheet on vertically. Default 999
     def fit_to(options={})
-      self.fit_to_width = options[:width] || 9999
-      self.fit_to_height = options[:height] || 9999
+      self.fit_to_width = options[:width] || 999
+      self.fit_to_height = options[:height] || 999
       [@fit_to_width, @fit_to_height]
     end
 
 
     # helper method for worksheet to determine if the page setup is configured for fit to page printing
-    # We treat any page set up that has a value set for fit_to_width or fit_to_height value as fit_to_page. 
+    # We treat any page set up that has a value set for fit_to_width or fit_to_height value as fit_to_page.
     # @return [Boolean]
     def fit_to_page?
       # is there some better what to express this?
@@ -234,9 +234,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << '<pageSetup '
-      serialized_attributes str
-      str << '/>'
+      serialized_tag('pageSetup', str)
     end
   end
 end

data/lib/axlsx/workbook/worksheet/pane.rb

@@ -124,9 +124,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       finalize
-      str << '<pane '
-      serialized_attributes str
-      str << '/>'
+      serialized_tag 'pane', str
     end
     private
 

data/lib/axlsx/workbook/worksheet/pivot_table.rb

@@ -25,10 +25,20 @@ module Axlsx
       @data = []
       @pages = []
       @subtotal = nil
+      @no_subtotals_on_headers = []
+      @style_info = {}
       parse_options options
       yield self if block_given?
     end
 
+    # Defines the headers in which subtotals are not to be included
+    # @return[Array]
+    attr_accessor :no_subtotals_on_headers
+
+    # Style info for the pivot table
+    # @return[Hash]
+    attr_accessor :style_info
+
     # The reference to the table data
     # @return [String]
     attr_reader :ref
@@ -159,23 +169,23 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << '<pivotTableDefinition xmlns="' << XML_NS << '" name="' << name << '" cacheId="' << cache_definition.cache_id.to_s << '"  dataOnRows="1" applyNumberFormats="0" applyBorderFormats="0" applyFontFormats="0" applyPatternFormats="0" applyAlignmentFormats="0" applyWidthHeightFormats="1" dataCaption="Data" showMultipleLabel="0" showMemberPropertyTips="0" useAutoFormatting="1" indent="0" compact="0" compactData="0" gridDropZones="1" multipleFieldFilters="0">'
-      str <<   '<location firstDataCol="1" firstDataRow="1" firstHeaderRow="1" ref="' << ref << '"/>'
-      str <<   '<pivotFields count="' << header_cells_count.to_s << '">'
+      str << ('<pivotTableDefinition xmlns="' << XML_NS << '" name="' << name << '" cacheId="' << cache_definition.cache_id.to_s << '"  dataOnRows="1" applyNumberFormats="0" applyBorderFormats="0" applyFontFormats="0" applyPatternFormats="0" applyAlignmentFormats="0" applyWidthHeightFormats="1" dataCaption="Data" showMultipleLabel="0" showMemberPropertyTips="0" useAutoFormatting="1" indent="0" compact="0" compactData="0" gridDropZones="1" multipleFieldFilters="0">')
+      str << ('<location firstDataCol="1" firstDataRow="1" firstHeaderRow="1" ref="' << ref << '"/>')
+      str << ('<pivotFields count="' << header_cells_count.to_s << '">')
       header_cell_values.each do |cell_value|
-        str <<   pivot_field_for(cell_value)
+        str << pivot_field_for(cell_value, !no_subtotals_on_headers.include?(cell_value))
       end
-      str <<   '</pivotFields>'
+      str << '</pivotFields>'
       if rows.empty?
         str << '<rowFields count="1"><field x="-2"/></rowFields>'
         str << '<rowItems count="2"><i><x/></i> <i i="1"><x v="1"/></i></rowItems>'
       else
-        str << '<rowFields count="' << rows.size.to_s << '">'
+        str << ('<rowFields count="' << rows.size.to_s << '">')
         rows.each do |row_value|
-          str << '<field x="' << header_index_of(row_value).to_s << '"/>'
+          str << ('<field x="' << header_index_of(row_value).to_s << '"/>')
         end
         str << '</rowFields>'
-        str << '<rowItems count="' << rows.size.to_s << '">'
+        str << ('<rowItems count="' << rows.size.to_s << '">')
         rows.size.times do |i|
           str << '<i/>'
         end
@@ -184,28 +194,37 @@ module Axlsx
       if columns.empty?
         str << '<colItems count="1"><i/></colItems>'
       else
-        str << '<colFields count="' << columns.size.to_s << '">'
+        str << ('<colFields count="' << columns.size.to_s << '">')
         columns.each do |column_value|
-          str << '<field x="' << header_index_of(column_value).to_s << '"/>'
+          str << ('<field x="' << header_index_of(column_value).to_s << '"/>')
         end
         str << '</colFields>'
       end
       unless pages.empty?
-        str << '<pageFields count="' << pages.size.to_s << '">'
+        str << ('<pageFields count="' << pages.size.to_s << '">')
         pages.each do |page_value|
-          str << '<pageField fld="' << header_index_of(page_value).to_s << '"/>'
+          str << ('<pageField fld="' << header_index_of(page_value).to_s << '"/>')
         end
         str << '</pageFields>'
       end
       unless data.empty?
         str << "<dataFields count=\"#{data.size}\">"
         data.each do |datum_value|
-          str << "<dataField name='#{@subtotal} of #{datum_value[:ref]}' fld='#{header_index_of(datum_value[:ref])}' baseField='0' baseItem='0'"
+          # The correct name prefix in ["Sum","Average", etc...]
+          str << "<dataField name='#{(datum_value[:subtotal]||'')} of #{datum_value[:ref]}' fld='#{header_index_of(datum_value[:ref])}' baseField='0' baseItem='0'"
           str << " subtotal='#{datum_value[:subtotal]}' " if datum_value[:subtotal]
           str << "/>"
         end
         str << '</dataFields>'
       end
+      # custom pivot table style
+      unless style_info.empty?
+        str << '<pivotTableStyleInfo'
+        style_info.each do |k,v|
+          str << ' ' << k.to_s << '="' << v.to_s << '"'
+        end
+        str << ' />'
+      end
       str << '</pivotTableDefinition>'
     end
 
@@ -241,33 +260,30 @@ module Axlsx
 
     private
 
-    def pivot_field_for(cell_ref)
+    def pivot_field_for(cell_ref, subtotal=true)
       if rows.include? cell_ref
-        '<pivotField axis="axisRow" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
-          '<items count="1"><item t="default"/></items>' <<
-        '</pivotField>'
+        if subtotal
+          '<pivotField axis="axisRow" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"><items count="1"><item t="default"/></items></pivotField>'
+        else
+          '<pivotField axis="axisRow" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1" defaultSubtotal="0"></pivotField>'
+        end
       elsif columns.include? cell_ref
-        '<pivotField axis="axisCol" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
-          '<items count="1"><item t="default"/></items>' <<
-        '</pivotField>'
+        '<pivotField axis="axisCol" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"><items count="1"><item t="default"/></items></pivotField>'
       elsif pages.include? cell_ref
-        '<pivotField axis="axisCol" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
-          '<items count="1"><item t="default"/></items>' <<
-        '</pivotField>'
+        '<pivotField axis="axisPage" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"><items count="1"><item t="default"/></items></pivotField>'
       elsif data_refs.include? cell_ref
-        '<pivotField dataField="1" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
-        '</pivotField>'
+        '<pivotField dataField="1" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"></pivotField>'
       else
-        '<pivotField compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
-        '</pivotField>'
+        '<pivotField compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"></pivotField>'
       end
     end
+
     def data_refs
       data.map { |hash| hash[:ref] }
     end
+
     def header_range
       range.gsub(/^(\w+?)(\d+)\:(\w+?)\d+$/, '\1\2:\3\2')
     end
-
   end
 end

data/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb

@@ -47,13 +47,13 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << '<pivotCacheDefinition xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '" invalid="1" refreshOnLoad="1" recordCount="0">'
+      str << ('<pivotCacheDefinition xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '" invalid="1" refreshOnLoad="1" recordCount="0">')
       str <<   '<cacheSource type="worksheet">'
-      str <<     '<worksheetSource ref="' << pivot_table.range << '" sheet="' << pivot_table.data_sheet.name << '"/>'
+      str << (    '<worksheetSource ref="' << pivot_table.range << '" sheet="' << pivot_table.data_sheet.name << '"/>')
       str <<   '</cacheSource>'
-      str <<   '<cacheFields count="' << pivot_table.header_cells_count.to_s << '">'
+      str << (  '<cacheFields count="' << pivot_table.header_cells_count.to_s << '">')
       pivot_table.header_cells.each do |cell|
-        str <<   '<cacheField name="' << cell.value << '" numFmtId="0">'
+        str << (  '<cacheField name="' << cell.value << '" numFmtId="0">')
         str <<     '<sharedItems count="0">'
         str <<     '</sharedItems>'
         str <<   '</cacheField>'

data/lib/axlsx/workbook/worksheet/print_options.rb

@@ -33,9 +33,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << '<printOptions '
-      serialized_attributes str
-      str << '/>'
+      serialized_tag 'printOptions', str
     end
   end
 end

data/lib/axlsx/workbook/worksheet/protected_range.rb

@@ -41,9 +41,7 @@ module Axlsx
     # our output to that object. Use this - it helps limit the number of
     # objects created during serialization
     def to_xml_string(str="")
-      str << '<protectedRange '
-      serialized_attributes str
-      str << '/>'
+      serialized_tag 'protectedRange', str
     end 
   end
 end