axlsx 2.1.0.pre → 3.0.0.pre

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

@@ -19,6 +19,8 @@ module Axlsx
                  cells
                elsif cells.is_a?(Array)
                  Axlsx::cell_range(cells, false)
+               elsif cells.is_a?(Row)
+                 Axlsx::cell_range(cells, false)
                end
     end
 

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/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
@@ -160,12 +170,12 @@ module Axlsx
     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 << ('<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>'
@@ -200,12 +210,21 @@ module Axlsx
       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,24 +260,28 @@ 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

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

@@ -24,11 +24,14 @@ module Axlsx
      last
     end
 
+    # Serializes the protected ranges
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = '')
       return if empty?
       str << '<protectedRanges>'
       each { |range| range.to_xml_string(str) }
-      str << '</protectedRanges>' 
+      str << '</protectedRanges>'
     end
   end
 end

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

@@ -1,32 +1,52 @@
 module Axlsx
+
+  # A simple, self serializing class for storing TextRuns
   class RichText < SimpleTypedList
+
+    # creates a new RichText collection
+    # @param [String] text -optional The text to use in creating the first RichTextRun
+    # @param [Object] options -optional The options to use in creating the first RichTextRun
+    # @yield [RichText] self
     def initialize(text = nil, options={})
       super(RichTextRun)
       add_run(text, options) unless text.nil?
       yield self if block_given?
     end
 
+    # The cell that owns this RichText collection
     attr_reader :cell
-    
+
+    # Assign the cell for this RichText collection
+    # @param [Cell] cell The cell which all RichTextRuns in the collection will belong to
     def cell=(cell)
       @cell = cell
       each { |run| run.cell = cell }
     end
-    
+
+    # Calculates the longest autowidth of the RichTextRuns in this collection
+    # @return [Number]
     def autowidth
       widtharray = [0] # Are arrays the best way of solving this problem?
       each { |run| run.autowidth(widtharray) }
       widtharray.max
     end
 
+    # Creates and adds a RichTextRun to this collectino
+    # @param [String] text The text to use in creating a new RichTextRun
+    # @param [Object] options The options to use in creating the new RichTextRun
     def add_run(text, options={})
       self << RichTextRun.new(text, options)
     end
-    
+
+    # The RichTextRuns we own
+    # @return [RichText]
     def runs
       self
     end
 
+    # renders the RichTextRuns in this collection
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str='')
       each{ |run| run.to_xml_string(str) }
       str

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

@@ -1,26 +1,29 @@
 module Axlsx
+
+  # The RichTextRun class creates and self serializing text run.
   class RichTextRun
-    
+
     include Axlsx::OptionsParser
-    
+
     attr_reader :value
-    
+
+    # A list of allowed inline style attributes used for validation
     INLINE_STYLES = [:font_name, :charset,
                      :family, :b, :i, :strike, :outline,
                      :shadow, :condense, :extend, :u,
                      :vertAlign, :sz, :color, :scheme].freeze
-    
+
     def initialize(value, options={})
       self.value = value
-      parse_options(options) 
+      parse_options(options)
     end
-    
+
     def value=(value)
       @value = value
     end
-    
+
     attr_accessor :cell
-    
+
     # The inline font_name property for the cell
     # @return [String]
     attr_reader :font_name
@@ -154,19 +157,9 @@ module Axlsx
       set_run_style nil, :scheme, v
     end
 
-    # The Shared Strings Table index for this cell
-    # @return [Integer]
-    attr_reader :ssti
-    
-    # @return [Integer] The cellXfs item index applied to this cell.
-    # @raise [ArgumentError] Invalid cellXfs id if the value provided is not within cellXfs items range.
-    def style=(v)
-      Axlsx::validate_unsigned_int(v)
-      count = styles.cellXfs.size
-      raise ArgumentError, "Invalid cellXfs id" unless v < count
-      @style = v
-    end
-
+    # Tries to work out the width of the longest line in the run
+    # @param [Array] widtharray this array is populated with the widths of each line in the run.
+    # @return [Array]
     def autowidth(widtharray)
       return if value.nil?
       if styles.cellXfs[style].alignment && styles.cellXfs[style].alignment.wrap_text
@@ -184,19 +177,22 @@ module Axlsx
       end
       widtharray
     end
-    
+
     # Utility method for setting inline style attributes
     def set_run_style(validator, attr, value)
       return unless INLINE_STYLES.include?(attr.to_sym)
       Axlsx.send(validator, value) unless validator.nil?
       self.instance_variable_set :"@#{attr.to_s}", value
     end
-    
+
+    # Serializes the RichTextRun
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = '')
       valid = RichTextRun::INLINE_STYLES
-      data = Hash[self.instance_values.map{ |k, v| [k.to_sym, v] }] 
+      data = Hash[self.instance_values.map{ |k, v| [k.to_sym, v] }]
       data = data.select { |key, value| valid.include?(key) && !value.nil? }
-      
+
       str << '<r><rPr>'
       data.keys.each do |key|
         case key
@@ -211,9 +207,9 @@ module Axlsx
       clean_value = Axlsx::trust_input ? @value.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@value.to_s))
       str << ('</rPr><t>' << clean_value << '</t></r>')
     end
-    
+
     private
-    
+
     # Returns the width of a string according to the current style
     # This is still not perfect...
     #  - scaling is not linear as font sizes increase
@@ -221,7 +217,7 @@ module Axlsx
       font_scale = font_size / 10.0
       string.count(Worksheet::THIN_CHARS) * font_scale
     end
-    
+
     # we scale the font size if bold style is applied to either the style font or
     # the cell itself. Yes, it is a bit of a hack, but it is much better than using
     # imagemagick and loading metrics for every character.
@@ -230,15 +226,15 @@ module Axlsx
       font = styles.fonts[styles.cellXfs[style].fontId] || styles.fonts[0]
       (font.b || (defined?(@b) && @b)) ? (font.sz * 1.5) : font.sz
     end
-    
+
     def style
       cell.style
     end
-    
+
     def styles
-      cell.row.worksheet.styles 
+      cell.row.worksheet.styles
     end
-    
+
     # Converts the value to the correct XML representation (fixes issues with
     # Numbers)
     def xml_value value

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

@@ -103,6 +103,13 @@ module Axlsx
       c
     end
 
+    # sets the color for every cell in this row
+    def color=(color)
+      each_with_index do | cell, index |
+        cell.color = color.is_a?(Array) ? color[index] : color
+      end
+    end
+
     # sets the style for every cell in this row
     def style=(style)
       each_with_index do | cell, index |

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

@@ -1,6 +1,6 @@
 module Axlsx
 
-  # The SheetPr class manages serialization fo a worksheet's sheetPr element.
+  # The SheetPr class manages serialization of a worksheet's sheetPr element.
   class SheetPr
     include Axlsx::OptionsParser
     include Axlsx::Accessors
@@ -8,7 +8,7 @@ module Axlsx
 
     serializable_attributes :sync_horizontal,
                             :sync_vertical,
-                            :transtion_evaluation,
+                            :transition_evaluation,
                             :transition_entry,
                             :published,
                             :filter_mode,
@@ -20,7 +20,7 @@ module Axlsx
     # waving magic show to set up the attriubte accessors
     boolean_attr_accessor :sync_horizontal,
                           :sync_vertical,
-                          :transtion_evaluation,
+                          :transition_evaluation,
                           :transition_entry,
                           :published,
                           :filter_mode,
@@ -33,6 +33,7 @@ module Axlsx
     def initialize(worksheet, options={})
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
       @worksheet = worksheet
+      @outline_pr = nil
       parse_options options
     end
 
@@ -40,12 +41,18 @@ module Axlsx
     # @return [Worksheet]
     attr_reader :worksheet
 
+    # The tab color of the sheet.
+    # @return [Color]
+    attr_reader :tab_color
+
     # Serialize the object
     # @param [String] str serialized output will be appended to this object if provided.
     # @return [String]
     def to_xml_string(str = '')
       update_properties
       str << "<sheetPr #{serialized_attributes}>"
+      tab_color.to_xml_string(str, 'tabColor') if tab_color
+      outline_pr.to_xml_string(str) if @outline_pr
       page_setup_pr.to_xml_string(str)
       str << "</sheetPr>"
     end
@@ -55,6 +62,17 @@ module Axlsx
     def page_setup_pr
       @page_setup_pr ||= PageSetUpPr.new
     end
+    
+    # The OutlinePr for this sheet pr object
+    # @return [OutlinePr]
+    def outline_pr
+      @outline_pr ||= OutlinePr.new
+    end
+
+    # @see tab_color
+    def tab_color=(v)
+      @tab_color ||= Color.new(:rgb => v)
+    end
 
     private
 

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

@@ -20,6 +20,9 @@ module Axlsx
       map{ |table| Relationship.new(table, TABLE_R, "../#{table.pn}") }
     end
 
+    # renders the tables xml
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = "")
       return if empty?
       str << "<tableParts count='#{size}'>"

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

@@ -8,7 +8,7 @@ module Axlsx
     # definition of characters which are less than the maximum width of 0-9 in the default font for use in String#count.
     # This is used for autowidth calculations
     THIN_CHARS = '^.acfijklrstxzFIJL()-'.freeze
-    
+
     # Creates a new worksheet.
     # @note the recommended way to manage worksheets is Workbook#add_worksheet
     # @see Workbook#add_worksheet
@@ -27,7 +27,7 @@ module Axlsx
       yield self if block_given?
     end
 
-    serializable_attributes :sheet_id, :name, :state
+    serializable_attributes :sheet_id, :state
 
     # Initalizes page margin, setup and print options
     # @param [Hash] options Options passed in from the initializer
@@ -91,7 +91,7 @@ module Axlsx
     # @see [SheetFormatPr]
     def sheet_format_pr
       @sheet_format_pr ||= SheetFormatPr.new
-      yeild @sheet_format_pr if block_given?
+      yield @sheet_format_pr if block_given?
       @sheet_format_pr
     end
 
@@ -152,7 +152,7 @@ module Axlsx
     # cell at a specific index. The block will be called with the row and column
     # index in the missing cell was found.
     # @example
-    #     cols { |row_index, column_index| p "warn - row #{row_index} is does not have a cell at #{column_index}
+    #     cols { |row_index, column_index| puts "warn - row #{row_index} does not have a cell at #{column_index}" }
     def cols(&block)
       @rows.transpose(&block)
     end
@@ -264,7 +264,7 @@ module Axlsx
       @header_footer
     end
 
-    # convinience method to access all cells in this worksheet
+    # convenience method to access all cells in this worksheet
     # @return [Array] cells
     def cells
       rows.flatten
@@ -305,50 +305,6 @@ module Axlsx
       @sheet_pr ||= SheetPr.new self
     end
 
-    # Indicates if gridlines should be shown in the sheet.
-    # This is true by default.
-    # @return [Boolean]
-    # @deprecated Use SheetView#show_grid_lines= instead.
-    def show_gridlines=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#show_gridlines= has been depreciated. This value can be set over SheetView#show_grid_lines=.')
-      Axlsx::validate_boolean v
-      sheet_view.show_grid_lines = v
-    end
-
-    # @see selected
-    # @return [Boolean]
-    # @deprecated Use SheetView#tab_selected= instead.
-    def selected=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#selected= has been depreciated. This value can be set over SheetView#tab_selected=.')
-      Axlsx::validate_boolean v
-      sheet_view.tab_selected = v
-    end
-
-    # Indicates if the worksheet should show gridlines or not
-    # @return Boolean
-    # @deprecated Use SheetView#show_grid_lines instead.
-    def show_gridlines
-      warn('axlsx::DEPRECIATED: Worksheet#show_gridlines has been depreciated. This value can get over SheetView#show_grid_lines.')
-      sheet_view.show_grid_lines
-    end
-
-    # Indicates if the worksheet is selected in the workbook
-    # It is possible to have more than one worksheet selected, however it might cause issues
-    # in some older versions of excel when using copy and paste.
-    # @return Boolean
-    # @deprecated Use SheetView#tab_selected instead.
-    def selected
-      warn('axlsx::DEPRECIATED: Worksheet#selected has been depreciated. This value can get over SheetView#tab_selected.')
-      sheet_view.tab_selected
-    end
-
-    # (see #fit_to_page)
-    # @return [Boolean]
-    def fit_to_page=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#fit_to_page has been depreciated. This value will automatically be set for you when you use PageSetup#fit_to.')
-      fit_to_page?
-    end
-
     # The name of the worksheet
     # The name of a worksheet must be unique in the workbook, and must not exceed 31 characters
     # @param [String] name
@@ -555,7 +511,7 @@ module Axlsx
     # @example This would set the first and third column widhts but leave the second column in autofit state.
     #      ws.column_widths 7.2, nil, 3
     # @note For updating only a single column it is probably easier to just set the width of the ws.column_info[col_index].width directly
-    # @param [Integer|Float|Fixnum|nil] widths
+    # @param [Integer|Float|nil] widths
     def column_widths(*widths)
       widths.each_with_index do |value, index|
         next if value == nil
@@ -597,6 +553,7 @@ module Axlsx
       add_autofilter_defined_name_to_workbook
       str << '<sheet '
       serialized_attributes str
+      str << ('name="' << name << '" ')
       str << ('r:id="' << rId << '"></sheet>')
     end
 
@@ -629,7 +586,7 @@ module Axlsx
     # Returns the cell or cells defined using excel style A1:B3 references.
     # @param [String|Integer] cell_def the string defining the cell or range of cells, or the rownumber
     # @return [Cell, Array]
-    def [] (cell_def)
+    def [](cell_def)
       return rows[cell_def] if cell_def.is_a?(Integer)
       parts = cell_def.split(':').map{ |part| name_to_cell part }
       if parts.size == 1