axlsx 1.3.6 → 2.0.0

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

@@ -136,7 +136,7 @@ module Axlsx
       def value_serialization(serialization_type, serialization_value, str = '')
         str << 't="' << serialization_type << '"' if serialization_type
         str << '><v>' << serialization_value << '</v>'
-      end 
+      end
 
 
     end

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

@@ -0,0 +1,35 @@
+module Axlsx
+
+  # A collection of Brake objects.
+  # Please do not use this class directly. Instead use 
+  # Worksheet#add_break
+  class ColBreaks < SimpleTypedList
+
+    # Instantiates a new list restricted to Break types
+    def initialize
+      super Break
+    end
+
+    # A column break specific helper for adding a break.
+    # @param [Hash] options A list of options to pass into the Break object
+    # The max and man options are fixed, however any other valid option for 
+    # Break will be passed to the created break object.
+    # @see Break
+    def add_break(options)
+      @list << Break.new(options.merge(:max => 1048575, :man => true))
+      last
+    end
+
+    # Serialize the collection to xml
+    # @param [String] str The string to append this lists xml to.
+    # <colBreaks count="1" manualBreakCount="1">
+    # <brk id="3" max="1048575" man="1"/>
+    # </colBreaks>
+    def to_xml_string(str='')
+      return if empty?
+      str << '<colBreaks count="' << @list.size.to_s << '" manualBreakCount="' << @list.size.to_s << '">'
+      each { |brk| brk.to_xml_string(str) }
+      str << '</colBreaks>'
+    end
+  end
+end

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

@@ -64,13 +64,14 @@ module Axlsx
     def to_xml_string(str = "")
       author = @comments.authors[author_index]
       str << '<comment ref="' << ref << '" authorId="' << author_index.to_s << '">'
-      str << '<text><r>'
-      str << '<rPr> <b/><color indexed="81"/></rPr>'
-      str << '<t>' << author.to_s << ':
-</t></r>'
+      str << '<text>'
+      unless author.to_s == ""
+        str << '<r><rPr><b/><color indexed="81"/></rPr>'
+        str << "<t>" << ::CGI.escapeHTML(author.to_s) << ":\n</t></r>"
+      end
       str << '<r>'
       str << '<rPr><color indexed="81"/></rPr>'
-      str << '<t>' << text << '</t></r></text>'
+      str << '<t>' << ::CGI.escapeHTML(text) << '</t></r></text>'
       str << '</comment>'
     end
 

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

@@ -56,9 +56,9 @@ module Axlsx
     # The relationships required by this object
     # @return [Array]
     def relationships
-      [Relationship.new(VML_DRAWING_R, "../#{vml_drawing.pn}"),
-       Relationship.new(COMMENT_R, "../#{pn}"),
-       Relationship.new(COMMENT_R_NULL, "NULL")]
+      [Relationship.new(self, VML_DRAWING_R, "../#{vml_drawing.pn}"),
+       Relationship.new(self, COMMENT_R, "../#{pn}"),
+       Relationship.new(self, COMMENT_R_NULL, "NULL")]
     end
 
     # serialize the object

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

@@ -182,7 +182,7 @@ module Axlsx
     # @see timePeriod
     def timePeriod=(v); Axlsx::validate_time_period_type(v); @timePeriod = v end
     # @see formula
-    def formula=(v); [*v].each {|x| Axlsx::validate_string(x) }; @formula = v end
+    def formula=(v); [*v].each {|x| Axlsx::validate_string(x) }; @formula = [*v].map { |form| ::CGI.escapeHTML(form) } end
 
     # @see color_scale
     def color_scale=(v)

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

@@ -10,7 +10,8 @@ module Axlsx
     # @return [Numeric]
     def self.date_to_serial(date)
       epoch = Axlsx::Workbook::date1904 ? Date.new(1904) : Date.new(1899, 12, 30)
-      (date - epoch).to_f
+      offset_date = date.respond_to?(:utc_offset) ? date + date.utc_offset.seconds : date
+      (offset_date - epoch).to_f
     end
 
     # The time_to_serial methond converts a Time object its excel serialized form.
@@ -19,11 +20,11 @@ module Axlsx
     def self.time_to_serial(time)
       # Using hardcoded offsets here as some operating systems will not except
       # a 'negative' offset from the ruby epoch.
-      epoch1900 = -2209161600 # Time.utc(1899, 12, 30).to_i
-      epoch1904 = -2082844800 # Time.utc(1904, 1, 1).to_i
-      seconds_per_day = 86400 # 60*60*24
+      epoch1900 = -2209161600.0 # Time.utc(1899, 12, 30).to_i
+      epoch1904 = -2082844800.0 # Time.utc(1904, 1, 1).to_i
+      seconds_per_day = 86400.0 # 60*60*24
       epoch = Axlsx::Workbook::date1904 ? epoch1904 : epoch1900
-      (time.to_f - epoch)/seconds_per_day
+      (time.utc_offset + time.to_f - epoch)/seconds_per_day
     end
   end
 end

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

@@ -19,10 +19,12 @@ module Axlsx
       @sheet = sheet
       @sheet.workbook.pivot_tables << self
       @name = "PivotTable#{index+1}"
+      @data_sheet = nil
       @rows = []
       @columns = []
       @data = []
       @pages = []
+      @subtotal = nil
       parse_options options
       yield self if block_given?
     end
@@ -39,6 +41,15 @@ module Axlsx
     # @return [String]
     attr_reader :sheet
 
+    # The sheet used as data source for the pivot table
+    # @return [Worksheet]
+    attr_writer :data_sheet
+
+    # @see #data_sheet
+    def data_sheet
+      @data_sheet || @sheet
+    end
+
     # The range where the data for this pivot table lives.
     # @return [String]
     attr_reader :range
@@ -85,10 +96,17 @@ module Axlsx
     # (see #data)
     def data=(v)
       DataTypeValidator.validate "#{self.class}.data", [Array], v
-      v.each do |ref|
-        DataTypeValidator.validate "#{self.class}.data[]", [String], ref
+      @data = []
+      v.each do |data_field|
+        if data_field.is_a? String
+          data_field = {:ref => data_field}
+        end
+        data_field.values.each do |value|
+          DataTypeValidator.validate "#{self.class}.data[]", [String], value
+        end
+        @data << data_field
       end
-      @data = v
+      @data
     end
 
     # The pages
@@ -128,20 +146,14 @@ module Axlsx
       @cache_definition ||= PivotTableCacheDefinition.new(self)
     end
 
-    # The worksheet relationships. This is managed automatically by the worksheet
+    # The relationships for this pivot table.
     # @return [Relationships]
     def relationships
       r = Relationships.new
-      r << Relationship.new(PIVOT_TABLE_CACHE_DEFINITION_R, "../#{cache_definition.pn}")
+      r << Relationship.new(cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, "../#{cache_definition.pn}")
       r
     end
 
-    # The relation reference id for this table
-    # @return [String]
-    def rId
-      "rId#{index+1}"
-    end
-
     # Serializes the object
     # @param [String] str
     # @return [String]
@@ -186,11 +198,11 @@ module Axlsx
         str << '</pageFields>'
       end
       unless data.empty?
-        str << '<dataFields count="' << data.size.to_s << '">'
+        str << "<dataFields count=\"#{data.size}\">"
         data.each do |datum_value|
-          str << '<dataField name="Sum of ' << datum_value << '" ' <<
-                            'fld="' << header_index_of(datum_value).to_s << '" ' <<
-                            'baseField="0" baseItem="0"/>'
+          str << "<dataField name='#{@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
@@ -206,7 +218,7 @@ module Axlsx
     # The header cells for the pivot table
     # @return [Array]
     def header_cells
-      @sheet[header_range]
+      data_sheet[header_range]
     end
 
     # The values in the header cells collection
@@ -242,7 +254,7 @@ module Axlsx
         '<pivotField axis="axisCol" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
           '<items count="1"><item t="default"/></items>' <<
         '</pivotField>'
-      elsif data.include? cell_ref
+      elsif data_refs.include? cell_ref
         '<pivotField dataField="1" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
         '</pivotField>'
       else
@@ -250,7 +262,9 @@ module Axlsx
         '</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/pivot_table_cache_definition.rb

@@ -35,10 +35,11 @@ module Axlsx
       index + 1
     end
 
-    # The relation reference id for this table
+    # The relationship id for this pivot table cache definition.
+    # @see Relationship#Id
     # @return [String]
     def rId
-      "rId#{index + 1}"
+      pivot_table.relationships.for(self).Id
     end
 
     # Serializes the object
@@ -48,7 +49,7 @@ module Axlsx
       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 <<   '<cacheSource type="worksheet">'
-      str <<     '<worksheetSource ref="' << pivot_table.range << '" sheet="Data Sheet"/>'
+      str <<     '<worksheetSource ref="' << pivot_table.range << '" sheet="' << pivot_table.data_sheet.name << '"/>'
       str <<   '</cacheSource>'
       str <<   '<cacheFields count="' << pivot_table.header_cells_count.to_s << '">'
       pivot_table.header_cells.each do |cell|

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

@@ -17,7 +17,7 @@ module Axlsx
     # returns the relationships required by this collection
     def relationships
       return [] if empty?
-      map{ |pivot_table| Relationship.new(PIVOT_TABLE_R, "../#{pivot_table.pn}") }
+      map{ |pivot_table| Relationship.new(pivot_table, PIVOT_TABLE_R, "../#{pivot_table.pn}") }
     end
   end
 

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

@@ -97,7 +97,7 @@ module Axlsx
       str << '</row>'
     end
 
-    # Adds a singel sell to the row based on the data provided and updates the worksheet's autofit data.
+    # Adds a single sell to the row based on the data provided and updates the worksheet's autofit data.
     # @return [Cell]
     def add_cell(value="", options={})
       c = Cell.new(self, value, options)

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

@@ -0,0 +1,33 @@
+module Axlsx
+
+  # A collection of break objects that define row breaks (page breaks) for printing and preview
+
+  class RowBreaks < SimpleTypedList
+
+    def initialize
+      super Break
+    end
+
+    # Adds a row break
+    # @param [Hash] options The options for the break to be created.
+    # max and man values are fixed.
+    # @see Break
+    def add_break(options)
+      # force feed the excel default
+      @list << Break.new(options.merge(:max => 16383, :man => true))
+      last
+    end
+ 
+    # <rowBreaks count="3" manualBreakCount="3">
+    # <brk id="1" max="16383" man="1"/>
+    # <brk id="7" max="16383" man="1"/>
+    # <brk id="13" max="16383" man="1"/>
+    # </rowBreaks>
+    def to_xml_string(str='')
+      return if empty?
+      str << '<rowBreaks count="' << @list.size.to_s << '" manualBreakCount="' << @list.size.to_s << '">'
+      each { |brk| brk.to_xml_string(str) }
+      str << '</rowBreaks>'
+    end
+  end
+end

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

@@ -47,10 +47,11 @@ module Axlsx
       "#{TABLE_PN % (index+1)}"
     end
 
-    # The relation reference id for this table
+    # The relationship id for this table.
+    # @see Relationship#Id
     # @return [String]
     def rId
-      "rId#{index+1}"
+      @sheet.relationships.for(self).Id
     end
 
     # The name of the Table.

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

@@ -17,7 +17,7 @@ module Axlsx
     # returns the relationships required by this collection
     def relationships
       return [] if empty?
-      map{ |table| Relationship.new(TABLE_R, "../#{table.pn}") }
+      map{ |table| Relationship.new(table, TABLE_R, "../#{table.pn}") }
     end
 
     def to_xml_string(str = "")

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

@@ -37,6 +37,8 @@ module Axlsx
       @page_setup = PageSetup.new options[:page_setup]  if options[:page_setup]
       @print_options = PrintOptions.new options[:print_options] if options[:print_options]
       @header_footer = HeaderFooter.new options[:header_footer] if options[:header_footer]
+      @row_breaks = RowBreaks.new
+      @col_breaks = ColBreaks.new
     end
 
     # The name of the worksheet
@@ -94,6 +96,22 @@ module Axlsx
       @pivot_tables ||=  PivotTables.new self
     end
 
+    # A collection of column breaks added to this worksheet
+    # @note Please do not use this directly. Instead use
+    # add_page_break
+    # @see Worksheet#add_page_break
+    def col_breaks
+      @col_breaks ||= ColBreaks.new
+    end
+
+    # A collection of row breaks added to this worksheet
+    # @note Please do not use this directly. Instead use
+    # add_page_break
+    # @see Worksheet#add_page_break
+    def row_breaks
+      @row_breaks ||= RowBreaks.new
+    end
+
     # A typed collection of hyperlinks associated with this worksheet
     # @return [WorksheetHyperlinks]
     def hyperlinks
@@ -114,14 +132,19 @@ module Axlsx
       @rows ||=  SimpleTypedList.new Row
     end
 
-    # returns the sheet data as columnw
-    def cols
-      @rows.transpose
+    # returns the sheet data as columns
+    # If you pass a block, it will be evaluated whenever a row does not have a
+    # 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}
+    def cols(&block)
+      @rows.transpose(&block)
     end
 
-    # An range that excel will apply an autfilter to "A1:B3"
+    # An range that excel will apply an auto-filter to "A1:B3"
     # This will turn filtering on for the cells in the range.
-    # The first row is considered the header, while subsequent rows are considerd to be data.
+    # The first row is considered the header, while subsequent rows are considered to be data.
     # @return String
     def auto_filter
       @auto_filter ||= AutoFilter.new self
@@ -327,6 +350,10 @@ module Axlsx
       auto_filter.range = v
     end
 
+    # Accessor for controlling whether leading and trailing spaces in cells are
+    # preserved or ignored. The default is to preserve spaces.
+    attr_accessor :preserve_spaces
+
     # The part name of this worksheet
     # @return [String]
     def pn
@@ -339,10 +366,11 @@ module Axlsx
       "#{WORKSHEET_RELS_PN % (index+1)}"
     end
 
-    # The relationship Id of thiw worksheet
+    # The relationship id of this worksheet.
     # @return [String]
+    # @see Relationship#Id
     def rId
-      "rId#{index+1}"
+      @workbook.relationships.for(self).Id
     end
 
     # The index of this worksheet in the owning Workbook's worksheets list.
@@ -488,6 +516,24 @@ module Axlsx
       image
     end
 
+    # Adds a page break (row break) to the worksheet
+    # @param cell A Cell object or excel style string reference indicating where the break
+    # should be added to the sheet.
+    # @example
+    #   ws.add_page_break("A4")
+    def add_page_break(cell)
+      DataTypeValidator.validate "Worksheet#add_page_break cell", [String, Cell], cell
+      column_index, row_index = if cell.is_a?(String)
+          Axlsx.name_to_indices(cell)
+        else
+          cell.pos
+        end
+      if column_index > 0
+        col_breaks.add_break(:id => column_index)
+      end
+      row_breaks.add_break(:id => row_index)
+    end
+
     # This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go.
     # Axlsx is sparse, so if you have not set data for a column, you cannot set the width.
     # Setting a fixed column width to nil will revert the behaviour back to calculating the width for you on the next call to add_row.
@@ -542,15 +588,7 @@ module Axlsx
         item.to_xml_string(str) if item
       end
       str << '</worksheet>'
-      sanitize(str)
-    end
-
-    # returns the provided string with all invalid control charaters
-    # removed.
-    # @param [String] str The sting to process
-    # @return [String]
-    def sanitize(str)
-      str.gsub(CONTROL_CHAR_REGEX, '')
+      Axlsx::sanitize(str)
     end
 
     # The worksheet relationships. This is managed automatically by the worksheet
@@ -565,14 +603,6 @@ module Axlsx
       r
     end
 
-    # identifies the index of an object withing the collections used in generating relationships for the worksheet
-    # @param [Any] object the object to search for
-    # @return [Integer] The index of the object
-    def relationships_index_of(object)
-      objects = [tables.to_a, worksheet_comments.comments.to_a, hyperlinks.to_a, worksheet_drawing.drawing].flatten.compact || []
-      objects.index(object)
-    end
-
     # 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]
@@ -629,6 +659,11 @@ module Axlsx
     end
 
     private
+
+    def xml_space
+      workbook.xml_space
+    end
+
     def outline(collection, range, level = 1, collapsed = true)
        range.each do |index|
         unless (item = collection[index]).nil?
@@ -653,7 +688,7 @@ module Axlsx
        sheet_data, sheet_calc_pr, @sheet_protection, protected_ranges,
        auto_filter, merged_cells, conditional_formattings,
        data_validations, hyperlinks, print_options, page_margins,
-       page_setup, header_footer, worksheet_drawing, worksheet_comments,
+       page_setup, header_footer, row_breaks, col_breaks, worksheet_drawing, worksheet_comments,
        tables]
     end
 
@@ -699,7 +734,7 @@ module Axlsx
     # Helper method for parsingout the root node for worksheet
     # @return [String]
     def worksheet_node
-      "<worksheet xmlns=\"%s\" xmlns:r=\"%s\">" % [XML_NS, XML_NS_R]
+       "<worksheet xmlns=\"%s\" xmlns:r=\"%s\" xml:space=\"#{xml_space}\">" % [XML_NS, XML_NS_R]
     end
 
     def sheet_data