axlsx 1.1.7 → 1.2.0

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

@@ -102,6 +102,21 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end
+    
+    # updates the width for this col based on the cells autowidth and 
+    # an optionally specified fixed width
+    # @param [Cell] cell The cell to use in updating this col's width
+    # @param [Integer] fixed_width If this is specified the width is set
+    # to this value and the cell's attributes are ignored.
+    # @param [Boolean] use_autowidth If this is false, the cell's
+    # autowidth value will be ignored.
+    def update_width(cell, fixed_width=nil, use_autowidth=true)
+       if fixed_width.is_a? Numeric
+         self.width = fixed_width
+       elsif use_autowidth
+        self.width = [width || 0, cell.autowidth || 0].max
+       end 
+    end 
 
     # Serialize this columns data to an xml string
     # @param [String] str

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

@@ -0,0 +1,20 @@
+module Axlsx
+
+  # The cols class manages the col object used to manage column widths. 
+  # This is where the magic happens with autowidth
+  class Cols < SimpleTypedList
+
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super Col
+      @worksheet = worksheet
+    end
+
+    def to_xml_string(str = '')
+     return if empty?
+     str << '<cols>'
+     each { |item| item.to_xml_string(str) }
+     str << '</cols>' 
+    end
+  end
+end

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

@@ -53,6 +53,14 @@ module Axlsx
       @list.map { |comment| comment.author.to_s }.uniq.sort
     end
 
+    # 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")]
+    end
+
     # serialize the object
     # @param [String] str
     # @return [String]

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

@@ -0,0 +1,25 @@
+module Axlsx
+
+  # A simple, self serializing class for storing conditional formattings
+  class ConditionalFormattings < SimpleTypedList
+
+    # creates a new Tables object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super ConditionalFormatting
+      @worksheet = worksheet
+    end
+
+    # The worksheet that owns this collection of tables
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # serialize the conditional formattings
+    def to_xml_string(str = "")
+      return if empty?
+      each { |item| item.to_xml_string(str) }
+    end
+  end
+
+end
+

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

@@ -65,7 +65,7 @@ module Axlsx
     def showValue=(v); Axlsx.validate_boolean(v); @showValue = v end
 
     # Sets the color for the data bars.
-    # @param [Color|String] The color object, or rgb string value to apply
+    # @param [Color|String] v The color object, or rgb string value to apply
     def color=(v)
       @color = v if v.is_a? Color
       self.color.rgb = v if v.is_a? String

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

@@ -0,0 +1,28 @@
+module Axlsx
+
+  # A simple, self serializing class for storing conditional formattings
+  class DataValidations < SimpleTypedList
+
+    # creates a new Tables object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super DataValidation
+      @worksheet = worksheet
+    end
+
+    # The worksheet that owns this collection of tables
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # serialize the conditional formattings
+    def to_xml_string(str = "")
+      return if empty?
+      str << "<dataValidations count='#{size}'>"
+      each { |item| item.to_xml_string(str) }
+      str << '</dataValidations>'
+    end
+  end
+
+end
+
+

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

@@ -0,0 +1,65 @@
+module Axlsx
+
+  # This class manages the dimensions for a worksheet.
+  # While this node is optional in the specification some readers like 
+  # LibraOffice require this node to render the sheet
+  class Dimension
+
+    # the default value for the first cell in the dimension
+    # @return [String]
+    def self.default_first
+      @@default_first ||= 'A1'
+    end
+
+    # the default value for the last cell in the dimension
+    # @return [String]
+    def self.default_last
+      @@default_last ||= 'AA200'
+    end
+
+
+    # Creates a new dimension object
+    # @param[Worksheet] worksheet - the worksheet this dimension applies
+    # to.
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # the full refernece for this dimension
+    # @return [String]
+    def sqref
+      "#{first_cell_reference}:#{last_cell_reference}"
+    end 
+
+    # serialize the object
+    # @return [String]
+    def to_xml_string(str = '')
+      return if worksheet.rows.empty?
+      str << "<dimension ref=\"%s\"></dimension>" % sqref
+    end
+
+    # The first cell in the dimension
+    # @return [String]
+    def first_cell_reference
+      dimension_reference(worksheet.rows.first.cells.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)
+    end
+
+    private
+
+    # Returns the reference of a cell or the default specified
+    # @return [String]
+    def dimension_reference(cell, default)
+      return default unless cell.respond_to?(:r)
+      cell.r
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Axlsx
+
+  # A simple list of merged cells
+  class MergedCells < SimpleTypedList
+
+    # creates a new MergedCells object
+    # @param [Worksheet] worksheet
+    def initialize(worksheet)
+      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+      super String
+    end
+
+    # adds cells to the merged cells collection
+    # @param [Array||String] cells The cells to add to the merged cells
+    # 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)
+                 cells
+               elsif cells.is_a?(Array)
+                 Axlsx::cell_range(cells, false)
+               end
+    end
+
+    # serialize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return if @list.empty?
+      str << "<mergeCells count='#{size}'>"
+      each { |merged_cell| str << "<mergeCell ref='#{merged_cell}'></mergeCell>" }
+      str << '</mergeCells>'
+    end
+  end
+end

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

@@ -92,6 +92,15 @@ module Axlsx
       [@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. 
+    # @return [Boolean]
+    def fit_to_page?
+       # is there some better what to express this?
+       (fit_to_width != nil || fit_to_height != nil)
+    end
+
     # Serializes the page settings element.
     # @param [String] str
     # @return [String]

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

@@ -0,0 +1,46 @@
+module Axlsx
+  # The Protected Range class represents a set of cells in the worksheet
+  # @note the recommended way to manage protected ranges with via Worksheet#protect_range
+  # @see Worksheet#protect_range
+  class ProtectedRange
+
+    # The reference for the protected range
+    # @return [String]
+    attr_reader :sqref
+
+    # The name of the protected range
+    # @return [String]
+    attr_reader :name
+
+    # Initializes a new protected range object
+    # @option [String] sqref The cell range reference to protect. This can be an absolute or a relateve range however, it only applies to the current sheet.
+    # @option [String] name An optional name for the protected name.
+    def initialize(options={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      yield self if block_given?
+    end
+    
+    # @see sqref
+    def sqref=(v)
+      Axlsx.validate_string(v)
+      @sqref = v
+    end
+
+    # @see name
+    def name=(v)
+      Axlsx.validate_string(v)
+      @name = v
+    end
+   
+    # serializes the proteted range
+    # @param [String] str if this string object is provided we append
+    # our output to that object. Use this - it helps limit the number of
+    # objects created during serialization
+    def to_xml_string(str="")
+      attrs = self.instance_values.reject{ |key, value| value == nil }
+      str << '<protectedRange ' << attrs.map { |key, value| '' << key << '="' << value.to_s << '"' }.join(' ') << '/>'
+    end 
+  end
+end

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

@@ -0,0 +1,34 @@
+module Axlsx
+
+  # A self serializing collection of ranges that should be protected in
+  # the worksheet
+  class ProtectedRanges < SimpleTypedList
+
+    attr_reader :worksheet
+
+    def initialize(worksheet)
+      raise ArgumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
+      super ProtectedRange
+      @worksheet = worksheet
+    end
+
+    # Adds a protected range
+    # @param [Array|String] cells A string range reference or array of cells that will be protected
+    def add_range(cells)
+     sqref = if cells.is_a?(String)
+               cells
+             elsif cells.is_a?(SimpleTypedList) || cells.is_a?(Array)
+               Axlsx::cell_range(cells, false)
+             end
+     @list << ProtectedRange.new(:sqref => sqref, :name => "Range#{size}")
+     last
+    end
+
+    def to_xml_string(str = '')
+      return if empty?
+      str << '<protectedRanges>'
+      each { |range| range.to_xml_string(str) }
+      str << '</protectedRanges>' 
+    end
+  end
+end

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

@@ -134,7 +134,7 @@ module Axlsx
     # @return [Cell]
     def add_cell(value="", options={})
       c = Cell.new(self, value, options)
-      worksheet.send(:update_column_info, self.cells, [], self.cells.map(&:style))
+      worksheet.send(:update_column_info, self.cells, [])
       c
     end
 

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

@@ -0,0 +1,25 @@
+module Axlsx
+
+  # This class manages the serialization of rows for worksheets
+  class SheetData
+
+    # Creates a new SheetData object
+    # @param [Worksheet] worksheet The worksheet that owns this sheet data.
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      @worksheet = worksheet
+    end
+    
+    attr_reader :worksheet
+
+    # Serialize the sheet data
+    # @param [String] str the string this objects serializaton will be concacted to.
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<sheetData>'
+      worksheet.rows.each_with_index{ |row, index| row.to_xml_string(index, str) }
+      str << '</sheetData>'
+    end
+    
+  end
+end

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

@@ -0,0 +1,24 @@
+module Axlsx
+
+  # The SheetPr class manages serialization fo a worksheet's sheetPr element.
+  # Only fit_to_page is implemented
+  class SheetPr
+
+    # Creates a new SheetPr object
+    # @param [Worksheet] worksheet The worksheet that owns this SheetPr object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # Serialize the object
+    # @param [String] str serialized output will be appended to this object if provided.
+    # @return [String]
+    def to_xml_string(str = '')
+       return unless worksheet.fit_to_page?
+      str << "<sheetPr><pageSetUpPr fitToPage=\"%s\"></pageSetUpPr></sheetPr>" % worksheet.fit_to_page?
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Axlsx
+
+  # A simple, self serializing class for storing tables
+  class Tables < SimpleTypedList
+
+    # creates a new Tables object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super Table
+      @worksheet = worksheet
+    end
+
+    # The worksheet that owns this collection of tables
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # returns the relationships required by this collection
+    def relationships
+      return [] if empty?
+      map{ |table| Relationship.new(TABLE_R, "../#{table.pn}") }
+    end
+
+    def to_xml_string(str = "")
+      return if empty?
+      str << "<tableParts count='#{size}'>"
+      @list.each { |table| str << "<tablePart r:id='#{table.rId}'/>" }
+      str << '</tableParts>'
+    end
+  end
+
+end